2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % myents SYSTEM "entities.inc">
8 <!-- SQL I/0 Recording -->
9 <reference id="ref-recording">
10 <title>SQL I/O Recording</title>
17 <refentry id="add-sql-stream">
19 <refname>ADD-SQL-STREAM</refname>
20 <refpurpose><!-- purpose --></refpurpose>
21 <refclass>Function</refclass>
26 <function> (ADD-SQL-STREAM STREAM &KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
29 <title>Arguments and Values</title>
31 <!-- arguments and values -->
35 <title>Description</title>
36 <para>Adds the supplied stream STREAM (or T for
37 *standard-output*) as a component of the recording broadcast
38 stream for the SQL recording type specified by TYPE on
39 DATABASE which defaults to *DEFAULT-DATABASE*. TYPE must be
40 one of :commands, :results, or :both, defaulting to :commands,
41 depending on whether the stream is to be added for recording
42 SQL commands, results or both.
46 <title>Examples</title>
52 <title>Side Effects</title>
58 <title>Affected by</title>
66 <title>Exceptional Situations</title>
68 <!-- execeptional situations -->
72 <title>See Also</title>
87 <refentry id="delete-sql-stream">
89 <refname>DELETE-SQL-STREAM</refname>
90 <refpurpose><!-- purpose --></refpurpose>
91 <refclass>Function</refclass>
96 <function> (DELETE-SQL-STREAM STREAM &KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
99 <title>Arguments and Values</title>
101 <!-- arguments and values -->
105 <title>Description</title>
106 <para>Removes the supplied stream STREAM from the
107 recording broadcast stream for the SQL recording type
108 specified by TYPE on DATABASE which defaults to
109 *DEFAULT-DATABASE*. TYPE must be one of :commands,
110 :results, or :both, defaulting to :commands, depending
111 on whether the stream is to be added for recording SQL
112 commands, results or both.
116 <title>Examples</title>
122 <title>Side Effects</title>
124 <!-- side effects -->
128 <title>Affected by</title>
136 <title>Exceptional Situations</title>
138 <!-- execeptional situations -->
142 <title>See Also</title>
157 <refentry id="list-sql-streams">
159 <refname>LIST-SQL-STREAMS</refname>
160 <refpurpose><!-- purpose --></refpurpose>
161 <refclass>Function</refclass>
164 <title>Syntax</title>
166 <function> (LIST-SQL-STREAMS &KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
169 <title>Arguments and Values</title>
171 <!-- arguments and values -->
175 <title>Description</title>
176 <para>Returns the list of component streams for the
177 broadcast stream recording SQL commands sent to and/or
178 results returned from DATABASE which defaults to
179 *DEFAULT-DATABASE*. TYPE must be one of :commands,
180 :results, or :both, defaulting to :commands, and
181 determines whether the listed streams contain those
182 recording SQL commands, results or both.
186 <title>Examples</title>
192 <title>Side Effects</title>
194 <!-- side effects -->
198 <title>Affected by</title>
206 <title>Exceptional Situations</title>
208 <!-- execeptional situations -->
212 <title>See Also</title>
228 <refentry id="sql-recording-p">
230 <refname>SQL-RECORDING-P</refname>
231 <refpurpose><!-- purpose --></refpurpose>
232 <refclass>Function</refclass>
235 <title>Syntax</title>
237 <function> (SQL-RECORDING-P &KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
240 <title>Arguments and Values</title>
242 <!-- arguments and values -->
246 <title>Description</title>
247 <para>Predicate to test whether the SQL recording
248 specified by TYPE is currently enabled for DATABASE
249 which defaults to *DEFAULT-DATABASE*. TYPE may be one
250 of :commands, :results, :both or :either, defaulting
251 to :commands, otherwise nil is returned.
255 <title>Examples</title>
261 <title>Side Effects</title>
263 <!-- side effects -->
267 <title>Affected by</title>
275 <title>Exceptional Situations</title>
277 <!-- execeptional situations -->
281 <title>See Also</title>
296 <refentry id="sql-stream">
298 <refname>SQL-STREAM</refname>
299 <refpurpose><!-- purpose --></refpurpose>
300 <refclass>Function</refclass>
303 <title>Syntax</title>
305 <function> (SQL-STREAM &KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
308 <title>Arguments and Values</title>
310 <!-- arguments and values -->
314 <title>Description</title>
315 <para>Returns the broadcast stream used for recording SQL commands
316 sent to or results returned from DATABASE which defaults to
317 *DEFAULT-DATABASE*. TYPE must be one of :commands or :results,
318 defaulting to :commands, and determines whether the stream
319 returned is that used for recording SQL commands or results.
323 <title>Examples</title>
329 <title>Side Effects</title>
331 <!-- side effects -->
335 <title>Affected by</title>
343 <title>Exceptional Situations</title>
345 <!-- execeptional situations -->
349 <title>See Also</title>
364 <refentry id="start-sql-recording">
366 <refname>START-SQL-RECORDING</refname>
367 <refpurpose><!-- purpose --></refpurpose>
368 <refclass>Function</refclass>
371 <title>Syntax</title>
373 <function> (START-SQL-RECORDING &KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
376 <title>Arguments and Values</title>
378 <!-- arguments and values -->
382 <title>Description</title>
383 <para>Starts recording of SQL commands sent to and/or results
384 returned from DATABASE which defaults to *DEFAULT-DATABASE*. The
385 SQL is output on one or more broadcast streams, initially just
386 *STANDARD-OUTPUT*, and the functions ADD-SQL-STREAM and
387 DELETE-SQL-STREAM may be used to add or delete command or result
388 recording streams. The default value of TYPE is :commands which
389 means that SQL commands sent to DATABASE are recorded. If TYPE
390 is :results then SQL results returned from DATABASE are
391 recorded. Both commands and results may be recorded by passing
396 <title>Examples</title>
402 <title>Side Effects</title>
404 <!-- side effects -->
408 <title>Affected by</title>
416 <title>Exceptional Situations</title>
418 <!-- execeptional situations -->
422 <title>See Also</title>
438 <refentry id="stop-sql-recording">
440 <refname>STOP-SQL-RECORDING</refname>
441 <refpurpose><!-- purpose --></refpurpose>
442 <refclass>Function</refclass>
445 <title>Syntax</title>
447 <function> (STOP-SQL-RECORDING &KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
450 <title>Arguments and Values</title>
452 <!-- arguments and values -->
456 <title>Description</title>
457 <para>Stops recording of SQL commands sent to and/or results
458 returned from DATABASE which defaults to *DEFAULT-DATABASE*. The
459 default value of TYPE is :commands which means that SQL commands
460 sent to DATABASE will no longer be recorded. If TYPE is :results
461 then SQL results returned from DATABASE will no longer be
462 recorded. Recording may be stopped for both commands and results
463 by passing TYPE value of :both.
467 <title>Examples</title>
473 <title>Side Effects</title>
475 <!-- side effects -->
479 <title>Affected by</title>
487 <title>Exceptional Situations</title>
489 <!-- execeptional situations -->
493 <title>See Also</title>