doc/ref-recording.xml

   1 <?xml version='1.0' ?>
   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">
   5 %myents;
   6 ]>
   7
   8 <!-- SQL I/0 Recording -->
   9 <reference id="ref-recording">
  10   <title>SQL I/O Recording</title>
  11     <partintro>
  12     <para>
  13       <!-- introduction -->
  14     </para>
  15   </partintro>
  16
  17   <refentry id="add-sql-stream">
  18     <refnamediv>
  19       <refname>ADD-SQL-STREAM</refname>
  20       <refpurpose><!-- purpose --></refpurpose>
  21       <refclass>Function</refclass>
  22     </refnamediv>
  23     <refsect1>
  24       <title>Syntax</title>
  25       <synopsis>
  26       <function> (ADD-SQL-STREAM STREAM &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
  27     </refsect1>
  28     <refsect1>
  29       <title>Arguments and Values</title>
  30       <variablelist>
  31         <!-- arguments and values -->
  32       </variablelist>
  33     </refsect1>
  34     <refsect1>
  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.
  43       </para>
  44     </refsect1>
  45     <refsect1>
  46       <title>Examples</title>
  47       <screen>
  48         <!-- examples -->
  49       </screen>
  50     </refsect1>
  51     <refsect1>
  52       <title>Side Effects</title>
  53       <para>
  54         <!-- side effects -->
  55       </para>
  56     </refsect1>
  57     <refsect1>
  58       <title>Affected by</title>
  59       <para>
  60         <simplelist>
  61           <!-- affected by -->
  62         </simplelist>
  63       </para>
  64     </refsect1>
  65     <refsect1>
  66       <title>Exceptional Situations</title>
  67       <para>
  68         <!-- execeptional situations -->
  69       </para>
  70     </refsect1>
  71     <refsect1>
  72       <title>See Also</title>
  73       <para>
  74         <simplelist>
  75           <!-- see also -->
  76         </simplelist>
  77       </para>
  78     </refsect1>
  79     <refsect1>
  80       <title>Notes</title>
  81       <para>
  82         <!-- notes -->
  83       </para>
  84     </refsect1>
  85   </refentry>
  86
  87   <refentry id="delete-sql-stream">
  88     <refnamediv>
  89       <refname>DELETE-SQL-STREAM</refname>
  90       <refpurpose><!-- purpose --></refpurpose>
  91       <refclass>Function</refclass>
  92     </refnamediv>
  93     <refsect1>
  94       <title>Syntax</title>
  95       <synopsis>
  96       <function> (DELETE-SQL-STREAM STREAM &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
  97     </refsect1>
  98     <refsect1>
  99       <title>Arguments and Values</title>
 100       <variablelist>
 101         <!-- arguments and values -->
 102       </variablelist>
 103     </refsect1>
 104     <refsect1>
 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.
 113       </para>
 114     </refsect1>
 115     <refsect1>
 116       <title>Examples</title>
 117       <screen>
 118         <!-- examples -->
 119       </screen>
 120     </refsect1>
 121     <refsect1>
 122       <title>Side Effects</title>
 123       <para>
 124         <!-- side effects -->
 125       </para>
 126     </refsect1>
 127     <refsect1>
 128       <title>Affected by</title>
 129       <para>
 130         <simplelist>
 131           <!-- affected by -->
 132         </simplelist>
 133       </para>
 134     </refsect1>
 135     <refsect1>
 136       <title>Exceptional Situations</title>
 137       <para>
 138         <!-- execeptional situations -->
 139       </para>
 140     </refsect1>
 141     <refsect1>
 142       <title>See Also</title>
 143       <para>
 144         <simplelist>
 145           <!-- see also -->
 146         </simplelist>
 147       </para>
 148     </refsect1>
 149     <refsect1>
 150       <title>Notes</title>
 151       <para>
 152         <!-- notes -->
 153       </para>
 154     </refsect1>
 155   </refentry>
 156
 157   <refentry id="list-sql-streams">
 158     <refnamediv>
 159       <refname>LIST-SQL-STREAMS</refname>
 160       <refpurpose><!-- purpose --></refpurpose>
 161       <refclass>Function</refclass>
 162     </refnamediv>
 163     <refsect1>
 164       <title>Syntax</title>
 165       <synopsis>
 166       <function> (LIST-SQL-STREAMS &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 167     </refsect1>
 168     <refsect1>
 169       <title>Arguments and Values</title>
 170       <variablelist>
 171         <!-- arguments and values -->
 172       </variablelist>
 173     </refsect1>
 174     <refsect1>
 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.
 183       </para>
 184     </refsect1>
 185     <refsect1>
 186       <title>Examples</title>
 187       <screen>
 188         <!-- examples -->
 189       </screen>
 190     </refsect1>
 191     <refsect1>
 192       <title>Side Effects</title>
 193       <para>
 194         <!-- side effects -->
 195       </para>
 196     </refsect1>
 197     <refsect1>
 198       <title>Affected by</title>
 199       <para>
 200         <simplelist>
 201           <!-- affected by -->
 202         </simplelist>
 203       </para>
 204     </refsect1>
 205     <refsect1>
 206       <title>Exceptional Situations</title>
 207       <para>
 208         <!-- execeptional situations -->
 209       </para>
 210     </refsect1>
 211     <refsect1>
 212       <title>See Also</title>
 213       <para>
 214         <simplelist>
 215           <!-- see also -->
 216         </simplelist>
 217       </para>
 218     </refsect1>
 219     <refsect1>
 220       <title>Notes</title>
 221       <para>
 222         <!-- notes -->
 223       </para>
 224     </refsect1>
 225   </refentry>
 226
 227
 228   <refentry id="sql-recording-p">
 229     <refnamediv>
 230       <refname>SQL-RECORDING-P</refname>
 231       <refpurpose><!-- purpose --></refpurpose>
 232       <refclass>Function</refclass>
 233     </refnamediv>
 234     <refsect1>
 235       <title>Syntax</title>
 236       <synopsis>
 237       <function> (SQL-RECORDING-P &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 238     </refsect1>
 239     <refsect1>
 240       <title>Arguments and Values</title>
 241       <variablelist>
 242         <!-- arguments and values -->
 243       </variablelist>
 244     </refsect1>
 245     <refsect1>
 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.
 252       </para>
 253     </refsect1>
 254     <refsect1>
 255       <title>Examples</title>
 256       <screen>
 257         <!-- examples -->
 258       </screen>
 259     </refsect1>
 260     <refsect1>
 261       <title>Side Effects</title>
 262       <para>
 263         <!-- side effects -->
 264       </para>
 265     </refsect1>
 266     <refsect1>
 267       <title>Affected by</title>
 268       <para>
 269         <simplelist>
 270           <!-- affected by -->
 271         </simplelist>
 272       </para>
 273     </refsect1>
 274     <refsect1>
 275       <title>Exceptional Situations</title>
 276       <para>
 277         <!-- execeptional situations -->
 278       </para>
 279     </refsect1>
 280     <refsect1>
 281       <title>See Also</title>
 282       <para>
 283         <simplelist>
 284           <!-- see also -->
 285         </simplelist>
 286       </para>
 287     </refsect1>
 288     <refsect1>
 289       <title>Notes</title>
 290       <para>
 291         <!-- notes -->
 292       </para>
 293     </refsect1>
 294   </refentry>
 295
 296   <refentry id="sql-stream">
 297     <refnamediv>
 298       <refname>SQL-STREAM</refname>
 299       <refpurpose><!-- purpose --></refpurpose>
 300       <refclass>Function</refclass>
 301     </refnamediv>
 302     <refsect1>
 303       <title>Syntax</title>
 304       <synopsis>
 305       <function> (SQL-STREAM &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 306     </refsect1>
 307     <refsect1>
 308       <title>Arguments and Values</title>
 309       <variablelist>
 310         <!-- arguments and values -->
 311       </variablelist>
 312     </refsect1>
 313     <refsect1>
 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.
 320       </para>
 321     </refsect1>
 322     <refsect1>
 323       <title>Examples</title>
 324       <screen>
 325         <!-- examples -->
 326       </screen>
 327     </refsect1>
 328     <refsect1>
 329       <title>Side Effects</title>
 330       <para>
 331         <!-- side effects -->
 332       </para>
 333     </refsect1>
 334     <refsect1>
 335       <title>Affected by</title>
 336       <para>
 337         <simplelist>
 338           <!-- affected by -->
 339         </simplelist>
 340       </para>
 341     </refsect1>
 342     <refsect1>
 343       <title>Exceptional Situations</title>
 344       <para>
 345         <!-- execeptional situations -->
 346       </para>
 347     </refsect1>
 348     <refsect1>
 349       <title>See Also</title>
 350       <para>
 351         <simplelist>
 352           <!-- see also -->
 353         </simplelist>
 354       </para>
 355     </refsect1>
 356     <refsect1>
 357       <title>Notes</title>
 358       <para>
 359         <!-- notes -->
 360       </para>
 361     </refsect1>
 362   </refentry>
 363
 364   <refentry id="start-sql-recording">
 365     <refnamediv>
 366       <refname>START-SQL-RECORDING</refname>
 367       <refpurpose><!-- purpose --></refpurpose>
 368       <refclass>Function</refclass>
 369     </refnamediv>
 370     <refsect1>
 371       <title>Syntax</title>
 372       <synopsis>
 373       <function> (START-SQL-RECORDING &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 374     </refsect1>
 375     <refsect1>
 376       <title>Arguments and Values</title>
 377       <variablelist>
 378         <!-- arguments and values -->
 379       </variablelist>
 380     </refsect1>
 381     <refsect1>
 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
 392       TYPE value of :both.
 393       </para>
 394     </refsect1>
 395     <refsect1>
 396       <title>Examples</title>
 397       <screen>
 398         <!-- examples -->
 399       </screen>
 400     </refsect1>
 401     <refsect1>
 402       <title>Side Effects</title>
 403       <para>
 404         <!-- side effects -->
 405       </para>
 406     </refsect1>
 407     <refsect1>
 408       <title>Affected by</title>
 409       <para>
 410         <simplelist>
 411           <!-- affected by -->
 412         </simplelist>
 413       </para>
 414     </refsect1>
 415     <refsect1>
 416       <title>Exceptional Situations</title>
 417       <para>
 418         <!-- execeptional situations -->
 419       </para>
 420     </refsect1>
 421     <refsect1>
 422       <title>See Also</title>
 423       <para>
 424         <simplelist>
 425           <!-- see also -->
 426         </simplelist>
 427       </para>
 428     </refsect1>
 429     <refsect1>
 430       <title>Notes</title>
 431       <para>
 432         <!-- notes -->
 433       </para>
 434     </refsect1>
 435   </refentry>
 436
 437
 438   <refentry id="stop-sql-recording">
 439     <refnamediv>
 440       <refname>STOP-SQL-RECORDING</refname>
 441       <refpurpose><!-- purpose --></refpurpose>
 442       <refclass>Function</refclass>
 443     </refnamediv>
 444     <refsect1>
 445       <title>Syntax</title>
 446       <synopsis>
 447       <function> (STOP-SQL-RECORDING &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 448     </refsect1>
 449     <refsect1>
 450       <title>Arguments and Values</title>
 451       <variablelist>
 452         <!-- arguments and values -->
 453       </variablelist>
 454     </refsect1>
 455     <refsect1>
 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.
 464       </para>
 465     </refsect1>
 466     <refsect1>
 467       <title>Examples</title>
 468       <screen>
 469         <!-- examples -->
 470       </screen>
 471     </refsect1>
 472     <refsect1>
 473       <title>Side Effects</title>
 474       <para>
 475         <!-- side effects -->
 476       </para>
 477     </refsect1>
 478     <refsect1>
 479       <title>Affected by</title>
 480       <para>
 481         <simplelist>
 482           <!-- affected by -->
 483         </simplelist>
 484       </para>
 485     </refsect1>
 486     <refsect1>
 487       <title>Exceptional Situations</title>
 488       <para>
 489         <!-- execeptional situations -->
 490       </para>
 491     </refsect1>
 492     <refsect1>
 493       <title>See Also</title>
 494       <para>
 495         <simplelist>
 496           <!-- see also -->
 497         </simplelist>
 498       </para>
 499     </refsect1>
 500     <refsect1>
 501       <title>Notes</title>
 502       <para>
 503         <!-- notes -->
 504       </para>
 505     </refsect1>
 506   </refentry>
 507
 508 </reference>