Name

SQL-STREAM — Returns the broadcast stream used for recording SQL commands or results.Function

Syntax

      sql-stream &key type database => result

Arguments and Values

type

One of the following keyword symbols: :commands or :results, defaulting to :commands.

database

A database object. This will default to *default-database*.

result

A broadcast stream or NIL.

Description

Returns the broadcast stream used for recording SQL commands sent to or results returned from database which defaults to *default-database*. type must be one of :commands or :results, defaulting to :commands, and determines whether the stream returned is that used for recording SQL commands or results.

Examples

(start-sql-recording :type :commands)
=> 
(sql-stream :type :commands)
=> #<Broadcast Stream>
(sql-stream :type :results)
=> NIL
      

Side Effects

None.

Affected by

None.

Exceptional Situations

An error is signalled if type is not one of :commands or :results.

See Also

start-sql-recording
add-sql-stream
delete-sql-stream
list-sql-streams

Notes

None.