doc/ref-fddl.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 <!-- Functional Data Definition Language -->
   9 <reference id="ref-fddl">
  10   <title>Functional Data Definition Language (FDDL)</title>
  11     <partintro>
  12     <para>
  13       <!-- introduction -->
  14     </para>
  15   </partintro>
  16
  17   <refentry id="create-table">
  18     <refnamediv>
  19       <refname>CREATE-TABLE</refname>
  20       <refpurpose><!-- purpose --></refpurpose>
  21       <refclass>Function</refclass>
  22     </refnamediv>
  23     <refsect1>
  24       <title>Syntax</title>
  25       <synopsis>
  26       <function> (CREATE-TABLE NAME DESCRIPTION &amp;KEY (DATABASE *DEFAULT-DATABASE*) (CONSTRAINTS NIL) (TRANSACTIONS T)) [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>Creates a table called NAME, which may be a string,
  37       symbol or SQL table identifier, in DATABASE which defaults to
  38       *DEFAULT-DATABASE*. DESCRIPTION is a list whose elements are
  39       lists containing the attribute names, types, and other
  40       constraints such as not-null or primary-key for each column in
  41       the table.  CONSTRAINTS is a string representing an SQL table
  42       constraint expression or a list of such strings. With MySQL
  43       databases, if TRANSACTIONS is t an InnoDB table is created
  44       which supports transactions.
  45       </para>
  46     </refsect1>
  47     <refsect1>
  48       <title>Examples</title>
  49       <screen>
  50         <!-- examples -->
  51       </screen>
  52     </refsect1>
  53     <refsect1>
  54       <title>Side Effects</title>
  55       <para>
  56         <!-- side effects -->
  57       </para>
  58     </refsect1>
  59     <refsect1>
  60       <title>Affected by</title>
  61       <para>
  62         <simplelist>
  63           <!-- affected by -->
  64         </simplelist>
  65       </para>
  66     </refsect1>
  67     <refsect1>
  68       <title>Exceptional Situations</title>
  69       <para>
  70         <!-- execeptional situations -->
  71       </para>
  72     </refsect1>
  73     <refsect1>
  74       <title>See Also</title>
  75       <para>
  76         <simplelist>
  77           <!-- see also -->
  78         </simplelist>
  79       </para>
  80     </refsect1>
  81     <refsect1>
  82       <title>Notes</title>
  83       <para>
  84         <!-- notes -->
  85       </para>
  86     </refsect1>
  87   </refentry>
  88
  89   <refentry id="describe-table">
  90     <refnamediv>
  91       <refname>DESCRIBE-TABLE</refname>
  92       <refpurpose><!-- purpose --></refpurpose>
  93       <refclass>Function</refclass>
  94     </refnamediv>
  95     <refsect1>
  96       <title>Syntax</title>
  97       <synopsis>
  98       <function> (DESCRIBE-TABLE TABLE &amp;KEY DATABASE) [generic]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
  99     </refsect1>
 100     <refsect1>
 101       <title>Arguments and Values</title>
 102       <variablelist>
 103         <!-- arguments and values -->
 104       </variablelist>
 105     </refsect1>
 106     <refsect1>
 107       <title>Description</title>
 108       <para>Describes a table, returns a list of
 109       name/type for columns in table
 110       </para>
 111     </refsect1>
 112     <refsect1>
 113       <title>Examples</title>
 114       <screen>
 115         <!-- examples -->
 116       </screen>
 117     </refsect1>
 118     <refsect1>
 119       <title>Side Effects</title>
 120       <para>
 121         <!-- side effects -->
 122       </para>
 123     </refsect1>
 124     <refsect1>
 125       <title>Affected by</title>
 126       <para>
 127         <simplelist>
 128           <!-- affected by -->
 129         </simplelist>
 130       </para>
 131     </refsect1>
 132     <refsect1>
 133       <title>Exceptional Situations</title>
 134       <para>
 135         <!-- execeptional situations -->
 136       </para>
 137     </refsect1>
 138     <refsect1>
 139       <title>See Also</title>
 140       <para>
 141         <simplelist>
 142           <!-- see also -->
 143         </simplelist>
 144       </para>
 145     </refsect1>
 146     <refsect1>
 147       <title>Notes</title>
 148       <para>
 149         <!-- notes -->
 150       </para>
 151     </refsect1>
 152   </refentry>
 153
 154   <refentry id="drop-table">
 155     <refnamediv>
 156       <refname>DROP-TABLE</refname>
 157       <refpurpose><!-- purpose --></refpurpose>
 158       <refclass>Function</refclass>
 159     </refnamediv>
 160     <refsect1>
 161       <title>Syntax</title>
 162       <synopsis>
 163       <function> (DROP-TABLE NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 164     </refsect1>
 165     <refsect1>
 166       <title>Arguments and Values</title>
 167       <variablelist>
 168         <!-- arguments and values -->
 169       </variablelist>
 170     </refsect1>
 171     <refsect1>
 172       <title>Description</title>
 173       <para>Drops the table called NAME from DATABASE which defaults
 174       to *DEFAULT-DATABASE*. If the table does not exist and
 175       IF-DOES-NOT-EXIST is :ignore then DROP-TABLE returns nil whereas
 176       an error is signalled if IF-DOES-NOT-EXIST is :error.
 177       </para>
 178     </refsect1>
 179     <refsect1>
 180       <title>Examples</title>
 181       <screen>
 182         <!-- examples -->
 183       </screen>
 184     </refsect1>
 185     <refsect1>
 186       <title>Side Effects</title>
 187       <para>
 188         <!-- side effects -->
 189       </para>
 190     </refsect1>
 191     <refsect1>
 192       <title>Affected by</title>
 193       <para>
 194         <simplelist>
 195           <!-- affected by -->
 196         </simplelist>
 197       </para>
 198     </refsect1>
 199     <refsect1>
 200       <title>Exceptional Situations</title>
 201       <para>
 202         <!-- execeptional situations -->
 203       </para>
 204     </refsect1>
 205     <refsect1>
 206       <title>See Also</title>
 207       <para>
 208         <simplelist>
 209           <!-- see also -->
 210         </simplelist>
 211       </para>
 212     </refsect1>
 213     <refsect1>
 214       <title>Notes</title>
 215       <para>
 216         <!-- notes -->
 217       </para>
 218     </refsect1>
 219   </refentry>
 220
 221   <refentry id="list-tables">
 222     <refnamediv>
 223       <refname>LIST-TABLES</refname>
 224       <refpurpose><!-- purpose --></refpurpose>
 225       <refclass>Function</refclass>
 226     </refnamediv>
 227     <refsect1>
 228       <title>Syntax</title>
 229       <synopsis>
 230       <function> (LIST-TABLES &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 231     </refsect1>
 232     <refsect1>
 233       <title>Arguments and Values</title>
 234       <variablelist>
 235         <!-- arguments and values -->
 236       </variablelist>
 237     </refsect1>
 238     <refsect1>
 239       <title>Description</title>
 240       <para>Returns a list of strings representing table names in DATABASE
 241       which defaults to *DEFAULT-DATABASE*. OWNER is nil by default
 242       which means that only tables owned by users are listed. If OWNER
 243       is a string denoting a user name, only tables owned by OWNER are
 244       listed. If OWNER is :all then all tables are listed.
 245       </para>
 246     </refsect1>
 247     <refsect1>
 248       <title>Examples</title>
 249       <screen>
 250         <!-- examples -->
 251       </screen>
 252     </refsect1>
 253     <refsect1>
 254       <title>Side Effects</title>
 255       <para>
 256         <!-- side effects -->
 257       </para>
 258     </refsect1>
 259     <refsect1>
 260       <title>Affected by</title>
 261       <para>
 262         <simplelist>
 263           <!-- affected by -->
 264         </simplelist>
 265       </para>
 266     </refsect1>
 267     <refsect1>
 268       <title>Exceptional Situations</title>
 269       <para>
 270         <!-- execeptional situations -->
 271       </para>
 272     </refsect1>
 273     <refsect1>
 274       <title>See Also</title>
 275       <para>
 276         <simplelist>
 277           <!-- see also -->
 278         </simplelist>
 279       </para>
 280     </refsect1>
 281     <refsect1>
 282       <title>Notes</title>
 283       <para>
 284         <!-- notes -->
 285       </para>
 286     </refsect1>
 287   </refentry>
 288
 289   <refentry id="table-exists-p">
 290     <refnamediv>
 291       <refname>TABLE-EXISTS-P</refname>
 292       <refpurpose><!-- purpose --></refpurpose>
 293       <refclass>Function</refclass>
 294     </refnamediv>
 295     <refsect1>
 296       <title>Syntax</title>
 297       <synopsis>
 298       <function> (TABLE-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 299     </refsect1>
 300     <refsect1>
 301       <title>Arguments and Values</title>
 302       <variablelist>
 303         <!-- arguments and values -->
 304       </variablelist>
 305     </refsect1>
 306     <refsect1>
 307       <title>Description</title>
 308       <para>Tests for the existence of an SQL table called NAME in
 309       DATABASE which defaults to *DEFAULT-DATABASE*. OWNER is nil by
 310       default which means that only tables owned by users are
 311       examined. If OWNER is a string denoting a user name, only
 312       tables owned by OWNER are examined. If OWNER is :all then all
 313       tables are examined.
 314       </para>
 315     </refsect1>
 316     <refsect1>
 317       <title>Examples</title>
 318       <screen>
 319         <!-- examples -->
 320       </screen>
 321     </refsect1>
 322     <refsect1>
 323       <title>Side Effects</title>
 324       <para>
 325         <!-- side effects -->
 326       </para>
 327     </refsect1>
 328     <refsect1>
 329       <title>Affected by</title>
 330       <para>
 331         <simplelist>
 332           <!-- affected by -->
 333         </simplelist>
 334       </para>
 335     </refsect1>
 336     <refsect1>
 337       <title>Exceptional Situations</title>
 338       <para>
 339         <!-- execeptional situations -->
 340       </para>
 341     </refsect1>
 342     <refsect1>
 343       <title>See Also</title>
 344       <para>
 345         <simplelist>
 346           <!-- see also -->
 347         </simplelist>
 348       </para>
 349     </refsect1>
 350     <refsect1>
 351       <title>Notes</title>
 352       <para>
 353         <!-- notes -->
 354       </para>
 355     </refsect1>
 356   </refentry>
 357
 358   <refentry id="create-view">
 359     <refnamediv>
 360       <refname>CREATE-VIEW</refname>
 361       <refpurpose><!-- purpose --></refpurpose>
 362       <refclass>Function</refclass>
 363     </refnamediv>
 364     <refsect1>
 365       <title>Syntax</title>
 366       <synopsis>
 367       <function> (CREATE-VIEW NAME &amp;KEY AS COLUMN-LIST (WITH-CHECK-OPTION NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 368     </refsect1>
 369     <refsect1>
 370       <title>Arguments and Values</title>
 371       <variablelist>
 372         <!-- arguments and values -->
 373       </variablelist>
 374     </refsect1>
 375     <refsect1>
 376       <title>Description</title>
 377       <para>Creates a view called NAME in DATABASE which defaults to
 378       *DEFAULT-DATABASE*. The view is created using the query AS and
 379       the columns of the view may be specified using the COLUMN-LIST
 380       parameter. The WITH-CHECK-OPTION is nil by default but if it
 381       has a non-nil value, then all insert/update commands on the
 382       view are checked to ensure that the new data satisfy the query
 383       AS.
 384       </para>
 385     </refsect1>
 386     <refsect1>
 387       <title>Examples</title>
 388       <screen>
 389         <!-- examples -->
 390       </screen>
 391     </refsect1>
 392     <refsect1>
 393       <title>Side Effects</title>
 394       <para>
 395         <!-- side effects -->
 396       </para>
 397     </refsect1>
 398     <refsect1>
 399       <title>Affected by</title>
 400       <para>
 401         <simplelist>
 402           <!-- affected by -->
 403         </simplelist>
 404       </para>
 405     </refsect1>
 406     <refsect1>
 407       <title>Exceptional Situations</title>
 408       <para>
 409         <!-- execeptional situations -->
 410       </para>
 411     </refsect1>
 412     <refsect1>
 413       <title>See Also</title>
 414       <para>
 415         <simplelist>
 416           <!-- see also -->
 417         </simplelist>
 418       </para>
 419     </refsect1>
 420     <refsect1>
 421       <title>Notes</title>
 422       <para>
 423         <!-- notes -->
 424       </para>
 425     </refsect1>
 426   </refentry>
 427
 428   <refentry id="drop-view">
 429     <refnamediv>
 430       <refname>DROP-VIEW</refname>
 431       <refpurpose><!-- purpose --></refpurpose>
 432       <refclass>Function</refclass>
 433     </refnamediv>
 434     <refsect1>
 435       <title>Syntax</title>
 436       <synopsis>
 437       <function> (DROP-VIEW NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 438     </refsect1>
 439     <refsect1>
 440       <title>Arguments and Values</title>
 441       <variablelist>
 442         <!-- arguments and values -->
 443       </variablelist>
 444     </refsect1>
 445     <refsect1>
 446       <title>Description</title>
 447       <para>Drops the view called NAME from DATABASE
 448       which defaults to *DEFAULT-DATABASE*. If the view does
 449       not exist and IF-DOES-NOT-EXIST is :ignore then
 450       DROP-VIEW returns nil whereas an error is signalled if
 451       IF-DOES-NOT-EXIST is :error.
 452       </para>
 453     </refsect1>
 454     <refsect1>
 455       <title>Examples</title>
 456       <screen>
 457         <!-- examples -->
 458       </screen>
 459     </refsect1>
 460     <refsect1>
 461       <title>Side Effects</title>
 462       <para>
 463         <!-- side effects -->
 464       </para>
 465     </refsect1>
 466     <refsect1>
 467       <title>Affected by</title>
 468       <para>
 469         <simplelist>
 470           <!-- affected by -->
 471         </simplelist>
 472       </para>
 473     </refsect1>
 474     <refsect1>
 475       <title>Exceptional Situations</title>
 476       <para>
 477         <!-- execeptional situations -->
 478       </para>
 479     </refsect1>
 480     <refsect1>
 481       <title>See Also</title>
 482       <para>
 483         <simplelist>
 484           <!-- see also -->
 485         </simplelist>
 486       </para>
 487     </refsect1>
 488     <refsect1>
 489       <title>Notes</title>
 490       <para>
 491         <!-- notes -->
 492       </para>
 493     </refsect1>
 494   </refentry>
 495
 496   <refentry id="list-views">
 497     <refnamediv>
 498       <refname>LIST-VIEWS</refname>
 499       <refpurpose><!-- purpose --></refpurpose>
 500       <refclass>Function</refclass>
 501     </refnamediv>
 502     <refsect1>
 503       <title>Syntax</title>
 504       <synopsis>
 505       <function> (LIST-VIEWS &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 506     </refsect1>
 507     <refsect1>
 508       <title>Arguments and Values</title>
 509       <variablelist>
 510         <!-- arguments and values -->
 511       </variablelist>
 512     </refsect1>
 513     <refsect1>
 514       <title>Description</title>
 515       <para>Returns a list of strings representing view
 516       names in DATABASE which defaults to
 517       *DEFAULT-DATABASE*. OWNER is nil by default which
 518       means that only views owned by users are listed. If
 519       OWNER is a string denoting a user name, only views
 520       owned by OWNER are listed. If OWNER is :all then all
 521       views are listed.
 522       </para>
 523     </refsect1>
 524     <refsect1>
 525       <title>Examples</title>
 526       <screen>
 527         <!-- examples -->
 528       </screen>
 529     </refsect1>
 530     <refsect1>
 531       <title>Side Effects</title>
 532       <para>
 533         <!-- side effects -->
 534       </para>
 535     </refsect1>
 536     <refsect1>
 537       <title>Affected by</title>
 538       <para>
 539         <simplelist>
 540           <!-- affected by -->
 541         </simplelist>
 542       </para>
 543     </refsect1>
 544     <refsect1>
 545       <title>Exceptional Situations</title>
 546       <para>
 547         <!-- execeptional situations -->
 548       </para>
 549     </refsect1>
 550     <refsect1>
 551       <title>See Also</title>
 552       <para>
 553         <simplelist>
 554           <!-- see also -->
 555         </simplelist>
 556       </para>
 557     </refsect1>
 558     <refsect1>
 559       <title>Notes</title>
 560       <para>
 561         <!-- notes -->
 562       </para>
 563     </refsect1>
 564   </refentry>
 565
 566   <refentry id="view-exists-p">
 567     <refnamediv>
 568       <refname>VIEW-EXISTS-P</refname>
 569       <refpurpose><!-- purpose --></refpurpose>
 570       <refclass>Function</refclass>
 571     </refnamediv>
 572     <refsect1>
 573       <title>Syntax</title>
 574       <synopsis>
 575       <function> (VIEW-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 576     </refsect1>
 577     <refsect1>
 578       <title>Arguments and Values</title>
 579       <variablelist>
 580         <!-- arguments and values -->
 581       </variablelist>
 582     </refsect1>
 583     <refsect1>
 584       <title>Description</title>
 585       <para>Tests for the existence of an SQL view called NAME in
 586       DATABASE which defaults to *DEFAULT-DATABASE*. OWNER is nil by
 587       default which means that only views owned by users are
 588       examined. If OWNER is a string denoting a user name, only
 589       views owned by OWNER are examined. If OWNER is :all then all
 590       views are examined.
 591       </para>
 592     </refsect1>
 593     <refsect1>
 594       <title>Examples</title>
 595       <screen>
 596         <!-- examples -->
 597       </screen>
 598     </refsect1>
 599     <refsect1>
 600       <title>Side Effects</title>
 601       <para>
 602         <!-- side effects -->
 603       </para>
 604     </refsect1>
 605     <refsect1>
 606       <title>Affected by</title>
 607       <para>
 608         <simplelist>
 609           <!-- affected by -->
 610         </simplelist>
 611       </para>
 612     </refsect1>
 613     <refsect1>
 614       <title>Exceptional Situations</title>
 615       <para>
 616         <!-- execeptional situations -->
 617       </para>
 618     </refsect1>
 619     <refsect1>
 620       <title>See Also</title>
 621       <para>
 622         <simplelist>
 623           <!-- see also -->
 624         </simplelist>
 625       </para>
 626     </refsect1>
 627     <refsect1>
 628       <title>Notes</title>
 629       <para>
 630         <!-- notes -->
 631       </para>
 632     </refsect1>
 633   </refentry>
 634
 635   <refentry id="create-index">
 636     <refnamediv>
 637       <refname>CREATE-INDEX</refname>
 638       <refpurpose><!-- purpose --></refpurpose>
 639       <refclass>Function</refclass>
 640     </refnamediv>
 641     <refsect1>
 642       <title>Syntax</title>
 643       <synopsis>
 644       <function> (CREATE-INDEX NAME &amp;KEY ON (UNIQUE NIL) ATTRIBUTES (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 645     </refsect1>
 646     <refsect1>
 647       <title>Arguments and Values</title>
 648       <variablelist>
 649         <!-- arguments and values -->
 650       </variablelist>
 651     </refsect1>
 652     <refsect1>
 653       <title>Description</title>
 654       <para>Creates an index called NAME on the table specified by
 655       ON in DATABASE which default to *DEFAULT-DATABASE*. The table
 656       attributes to use in constructing the index NAME are specified
 657       by ATTRIBUTES. The UNIQUE argument is nil by default but if it
 658       has a non-nil value then the indexed attributes must have
 659       unique values.
 660       </para>
 661     </refsect1>
 662     <refsect1>
 663       <title>Examples</title>
 664       <screen>
 665         <!-- examples -->
 666       </screen>
 667     </refsect1>
 668     <refsect1>
 669       <title>Side Effects</title>
 670       <para>
 671         <!-- side effects -->
 672       </para>
 673     </refsect1>
 674     <refsect1>
 675       <title>Affected by</title>
 676       <para>
 677         <simplelist>
 678           <!-- affected by -->
 679         </simplelist>
 680       </para>
 681     </refsect1>
 682     <refsect1>
 683       <title>Exceptional Situations</title>
 684       <para>
 685         <!-- execeptional situations -->
 686       </para>
 687     </refsect1>
 688     <refsect1>
 689       <title>See Also</title>
 690       <para>
 691         <simplelist>
 692           <!-- see also -->
 693         </simplelist>
 694       </para>
 695     </refsect1>
 696     <refsect1>
 697       <title>Notes</title>
 698       <para>
 699         <!-- notes -->
 700       </para>
 701     </refsect1>
 702   </refentry>
 703
 704   <refentry id="drop-index">
 705     <refnamediv>
 706       <refname>DROP-INDEX</refname>
 707       <refpurpose><!-- purpose --></refpurpose>
 708       <refclass>Function</refclass>
 709     </refnamediv>
 710     <refsect1>
 711       <title>Syntax</title>
 712       <synopsis>
 713       <function> (DROP-INDEX NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (ON NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 714     </refsect1>
 715     <refsect1>
 716       <title>Arguments and Values</title>
 717       <variablelist>
 718         <!-- arguments and values -->
 719       </variablelist>
 720     </refsect1>
 721     <refsect1>
 722       <title>Description</title>
 723       <para>Drops the index called NAME in DATABASE which
 724       defaults to *DEFAULT-DATABASE*. If the index does not
 725       exist and IF-DOES-NOT-EXIST is :ignore then DROP-INDEX
 726       returns nil whereas an error is signalled if
 727       IF-DOES-NOT-EXIST is :error. The argument ON allows
 728       the optional specification of a table to drop the
 729       index from.
 730       </para>
 731     </refsect1>
 732     <refsect1>
 733       <title>Examples</title>
 734       <screen>
 735         <!-- examples -->
 736       </screen>
 737     </refsect1>
 738     <refsect1>
 739       <title>Side Effects</title>
 740       <para>
 741         <!-- side effects -->
 742       </para>
 743     </refsect1>
 744     <refsect1>
 745       <title>Affected by</title>
 746       <para>
 747         <simplelist>
 748           <!-- affected by -->
 749         </simplelist>
 750       </para>
 751     </refsect1>
 752     <refsect1>
 753       <title>Exceptional Situations</title>
 754       <para>
 755         <!-- execeptional situations -->
 756       </para>
 757     </refsect1>
 758     <refsect1>
 759       <title>See Also</title>
 760       <para>
 761         <simplelist>
 762           <!-- see also -->
 763         </simplelist>
 764       </para>
 765     </refsect1>
 766     <refsect1>
 767       <title>Notes</title>
 768       <para>
 769         <!-- notes -->
 770       </para>
 771     </refsect1>
 772   </refentry>
 773
 774   <refentry id="index-exists-p">
 775     <refnamediv>
 776       <refname>INDEX-EXISTS-P</refname>
 777       <refpurpose><!-- purpose --></refpurpose>
 778       <refclass>Function</refclass>
 779     </refnamediv>
 780     <refsect1>
 781       <title>Syntax</title>
 782       <synopsis>
 783       <function> (INDEX-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 784     </refsect1>
 785     <refsect1>
 786       <title>Arguments and Values</title>
 787       <variablelist>
 788         <!-- arguments and values -->
 789       </variablelist>
 790     </refsect1>
 791     <refsect1>
 792       <title>Description</title>
 793       <para>Tests for the existence of an SQL index
 794       called NAME in DATABASE which defaults to
 795       *DEFAULT-DATABASE*. OWNER is nil by default which
 796       means that only indexes owned by users are
 797       examined. If OWNER is a string denoting a user name,
 798       only indexes owned by OWNER are examined. If OWNER is
 799       :all then all indexes are examined.
 800       </para>
 801     </refsect1>
 802     <refsect1>
 803       <title>Examples</title>
 804       <screen>
 805         <!-- examples -->
 806       </screen>
 807     </refsect1>
 808     <refsect1>
 809       <title>Side Effects</title>
 810       <para>
 811         <!-- side effects -->
 812       </para>
 813     </refsect1>
 814     <refsect1>
 815       <title>Affected by</title>
 816       <para>
 817         <simplelist>
 818           <!-- affected by -->
 819         </simplelist>
 820       </para>
 821     </refsect1>
 822     <refsect1>
 823       <title>Exceptional Situations</title>
 824       <para>
 825         <!-- execeptional situations -->
 826       </para>
 827     </refsect1>
 828     <refsect1>
 829       <title>See Also</title>
 830       <para>
 831         <simplelist>
 832           <!-- see also -->
 833         </simplelist>
 834       </para>
 835     </refsect1>
 836     <refsect1>
 837       <title>Notes</title>
 838       <para>
 839         <!-- notes -->
 840       </para>
 841     </refsect1>
 842   </refentry>
 843
 844   <refentry id="list-indexes">
 845     <refnamediv>
 846       <refname>LIST-INDEXES</refname>
 847       <refpurpose><!-- purpose --></refpurpose>
 848       <refclass>Function</refclass>
 849     </refnamediv>
 850     <refsect1>
 851       <title>Syntax</title>
 852       <synopsis>
 853       <function> (LIST-INDEXES &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 854     </refsect1>
 855     <refsect1>
 856       <title>Arguments and Values</title>
 857       <variablelist>
 858         <!-- arguments and values -->
 859       </variablelist>
 860     </refsect1>
 861     <refsect1>
 862       <title>Description</title>
 863       <para>Returns a list of strings representing index
 864       names in DATABASE which defaults to
 865       *DEFAULT-DATABASE*. OWNER is nil by default which
 866       means that only indexes owned by users are listed. If
 867       OWNER is a string denoting a user name, only indexes
 868       owned by OWNER are listed. If OWNER is :all then all
 869       indexes are listed.
 870       </para>
 871     </refsect1>
 872     <refsect1>
 873       <title>Examples</title>
 874       <screen>
 875         <!-- examples -->
 876       </screen>
 877     </refsect1>
 878     <refsect1>
 879       <title>Side Effects</title>
 880       <para>
 881         <!-- side effects -->
 882       </para>
 883     </refsect1>
 884     <refsect1>
 885       <title>Affected by</title>
 886       <para>
 887         <simplelist>
 888           <!-- affected by -->
 889         </simplelist>
 890       </para>
 891     </refsect1>
 892     <refsect1>
 893       <title>Exceptional Situations</title>
 894       <para>
 895         <!-- execeptional situations -->
 896       </para>
 897     </refsect1>
 898     <refsect1>
 899       <title>See Also</title>
 900       <para>
 901         <simplelist>
 902           <!-- see also -->
 903         </simplelist>
 904       </para>
 905     </refsect1>
 906     <refsect1>
 907       <title>Notes</title>
 908       <para>
 909         <!-- notes -->
 910       </para>
 911     </refsect1>
 912   </refentry>
 913
 914   <refentry id="list-table-indexes">
 915     <refnamediv>
 916       <refname>LIST-TABLE-INDEXES</refname>
 917       <refpurpose><!-- purpose --></refpurpose>
 918       <refclass>Function</refclass>
 919     </refnamediv>
 920     <refsect1>
 921       <title>Syntax</title>
 922       <synopsis>
 923       <function> (LIST-TABLE-INDEXES TABLE &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 924     </refsect1>
 925     <refsect1>
 926       <title>Arguments and Values</title>
 927       <variablelist>
 928         <!-- arguments and values -->
 929       </variablelist>
 930     </refsect1>
 931     <refsect1>
 932       <title>Description</title>
 933       <para>Returns a list of strings representing index
 934       names on the table specified by TABLE in DATABASE
 935       which defaults to *DEFAULT-DATABASE*. OWNER is nil by
 936       default which means that only indexes owned by users
 937       are listed. If OWNER is a string denoting a user name,
 938       only indexes owned by OWNER are listed. If OWNER is
 939       :all then all indexes are listed.
 940       </para>
 941     </refsect1>
 942     <refsect1>
 943       <title>Examples</title>
 944       <screen>
 945         <!-- examples -->
 946       </screen>
 947     </refsect1>
 948     <refsect1>
 949       <title>Side Effects</title>
 950       <para>
 951         <!-- side effects -->
 952       </para>
 953     </refsect1>
 954     <refsect1>
 955       <title>Affected by</title>
 956       <para>
 957         <simplelist>
 958           <!-- affected by -->
 959         </simplelist>
 960       </para>
 961     </refsect1>
 962     <refsect1>
 963       <title>Exceptional Situations</title>
 964       <para>
 965         <!-- execeptional situations -->
 966       </para>
 967     </refsect1>
 968     <refsect1>
 969       <title>See Also</title>
 970       <para>
 971         <simplelist>
 972           <!-- see also -->
 973         </simplelist>
 974       </para>
 975     </refsect1>
 976     <refsect1>
 977       <title>Notes</title>
 978       <para>
 979         <!-- notes -->
 980       </para>
 981     </refsect1>
 982   </refentry>
 983
 984
 985   <refentry id="attribute-type">
 986     <refnamediv>
 987       <refname>ATTRIBUTE-TYPE</refname>
 988       <refpurpose><!-- purpose --></refpurpose>
 989       <refclass>Function</refclass>
 990     </refnamediv>
 991     <refsect1>
 992       <title>Syntax</title>
 993       <synopsis>
 994       <function> (ATTRIBUTE-TYPE ATTRIBUTE TABLE &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 995     </refsect1>
 996     <refsect1>
 997       <title>Arguments and Values</title>
 998       <variablelist>
 999         <!-- arguments and values -->
1000       </variablelist>
1001     </refsect1>
1002     <refsect1>
1003       <title>Description</title>
1004       <para>Returns a string representing the field type of the
1005       supplied attribute ATTRIBUTE in the table specified by TABLE
1006       in DATABASE which defaults to *DEFAULT-DATABASE*. OWNER is nil
1007       by default which means that the attribute specified by
1008       ATTRIBUTE, if it exists, must be user owned else nil is
1009       returned. If OWNER is a string denoting a user name, the
1010       attribute, if it exists, must be owned by OWNER else nil is
1011       returned, whereas if OWNER is :all then the attribute, if it
1012       exists, will be returned regardless of its owner.
1013       </para>
1014     </refsect1>
1015     <refsect1>
1016       <title>Examples</title>
1017       <screen>
1018         <!-- examples -->
1019       </screen>
1020     </refsect1>
1021     <refsect1>
1022       <title>Side Effects</title>
1023       <para>
1024         <!-- side effects -->
1025       </para>
1026     </refsect1>
1027     <refsect1>
1028       <title>Affected by</title>
1029       <para>
1030         <simplelist>
1031           <!-- affected by -->
1032         </simplelist>
1033       </para>
1034     </refsect1>
1035     <refsect1>
1036       <title>Exceptional Situations</title>
1037       <para>
1038         <!-- execeptional situations -->
1039       </para>
1040     </refsect1>
1041     <refsect1>
1042       <title>See Also</title>
1043       <para>
1044         <simplelist>
1045           <!-- see also -->
1046         </simplelist>
1047       </para>
1048     </refsect1>
1049     <refsect1>
1050       <title>Notes</title>
1051       <para>
1052         <!-- notes -->
1053       </para>
1054     </refsect1>
1055   </refentry>
1056
1057   <refentry id="list-attribute-types">
1058     <refnamediv>
1059       <refname>LIST-ATTRIBUTE-TYPES</refname>
1060       <refpurpose><!-- purpose --></refpurpose>
1061       <refclass>Function</refclass>
1062     </refnamediv>
1063     <refsect1>
1064       <title>Syntax</title>
1065       <synopsis>
1066       <function> (LIST-ATTRIBUTE-TYPES TABLE &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1067     </refsect1>
1068     <refsect1>
1069       <title>Arguments and Values</title>
1070       <variablelist>
1071         <!-- arguments and values -->
1072       </variablelist>
1073     </refsect1>
1074     <refsect1>
1075       <title>Description</title>
1076       <para>Returns a list containing information about
1077       the SQL types of each of the attributes in the table
1078       specified by TABLE in DATABASE which has a default
1079       value of *DEFAULT-DATABASE*. OWNER is nil by default
1080       which means that only attributes owned by users are
1081       listed. If OWNER is a string denoting a user name,
1082       only attributes owned by OWNER are listed. If OWNER is
1083       :all then all attributes are listed. The elements of
1084       the returned list are lists where the first element is
1085       the name of the attribute, the second element is its
1086       SQL type, the third is the type precision, the fourth
1087       is the scale of the attribute and the fifth is 1 if
1088       the attribute accepts null values and otherwise
1089       0.
1090       </para>
1091     </refsect1>
1092     <refsect1>
1093       <title>Examples</title>
1094       <screen>
1095         <!-- examples -->
1096       </screen>
1097     </refsect1>
1098     <refsect1>
1099       <title>Side Effects</title>
1100       <para>
1101         <!-- side effects -->
1102       </para>
1103     </refsect1>
1104     <refsect1>
1105       <title>Affected by</title>
1106       <para>
1107         <simplelist>
1108           <!-- affected by -->
1109         </simplelist>
1110       </para>
1111     </refsect1>
1112     <refsect1>
1113       <title>Exceptional Situations</title>
1114       <para>
1115         <!-- execeptional situations -->
1116       </para>
1117     </refsect1>
1118     <refsect1>
1119       <title>See Also</title>
1120       <para>
1121         <simplelist>
1122           <!-- see also -->
1123         </simplelist>
1124       </para>
1125     </refsect1>
1126     <refsect1>
1127       <title>Notes</title>
1128       <para>
1129         <!-- notes -->
1130       </para>
1131     </refsect1>
1132   </refentry>
1133
1134   <refentry id="list-attributes">
1135     <refnamediv>
1136       <refname>LIST-ATTRIBUTES</refname>
1137       <refpurpose><!-- purpose --></refpurpose>
1138       <refclass>Function</refclass>
1139     </refnamediv>
1140     <refsect1>
1141       <title>Syntax</title>
1142       <synopsis>
1143       <function> (LIST-ATTRIBUTES NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1144     </refsect1>
1145     <refsect1>
1146       <title>Arguments and Values</title>
1147       <variablelist>
1148         <!-- arguments and values -->
1149       </variablelist>
1150     </refsect1>
1151     <refsect1>
1152       <title>Description</title>
1153       <para>Returns a list of strings representing the
1154       attributes of table NAME in DATABASE which defaults to
1155       *DEFAULT-DATABASE*. OWNER is nil by default which
1156       means that only attributes owned by users are
1157       listed. If OWNER is a string denoting a user name,
1158       only attributes owned by OWNER are listed. If OWNER is
1159       :all then all attributes are listed.
1160       </para>
1161     </refsect1>
1162     <refsect1>
1163       <title>Examples</title>
1164       <screen>
1165         <!-- examples -->
1166       </screen>
1167     </refsect1>
1168     <refsect1>
1169       <title>Side Effects</title>
1170       <para>
1171         <!-- side effects -->
1172       </para>
1173     </refsect1>
1174     <refsect1>
1175       <title>Affected by</title>
1176       <para>
1177         <simplelist>
1178           <!-- affected by -->
1179         </simplelist>
1180       </para>
1181     </refsect1>
1182     <refsect1>
1183       <title>Exceptional Situations</title>
1184       <para>
1185         <!-- execeptional situations -->
1186       </para>
1187     </refsect1>
1188     <refsect1>
1189       <title>See Also</title>
1190       <para>
1191         <simplelist>
1192           <!-- see also -->
1193         </simplelist>
1194       </para>
1195     </refsect1>
1196     <refsect1>
1197       <title>Notes</title>
1198       <para>
1199         <!-- notes -->
1200       </para>
1201     </refsect1>
1202   </refentry>
1203
1204
1205   <refentry id="create-sequence">
1206     <refnamediv>
1207       <refname>CREATE-SEQUENCE</refname>
1208       <refpurpose><!-- purpose --></refpurpose>
1209       <refclass>Function</refclass>
1210     </refnamediv>
1211     <refsect1>
1212       <title>Syntax</title>
1213       <synopsis>
1214       <function> (CREATE-SEQUENCE NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1215     </refsect1>
1216     <refsect1>
1217       <title>Arguments and Values</title>
1218       <variablelist>
1219         <!-- arguments and values -->
1220       </variablelist>
1221     </refsect1>
1222     <refsect1>
1223       <title>Description</title>
1224       <para>Creates a sequence called NAME in DATABASE which
1225       defaults to *DEFAULT-DATABASE*.
1226       </para>
1227     </refsect1>
1228     <refsect1>
1229       <title>Examples</title>
1230       <screen>
1231         <!-- examples -->
1232       </screen>
1233     </refsect1>
1234     <refsect1>
1235       <title>Side Effects</title>
1236       <para>
1237         <!-- side effects -->
1238       </para>
1239     </refsect1>
1240     <refsect1>
1241       <title>Affected by</title>
1242       <para>
1243         <simplelist>
1244           <!-- affected by -->
1245         </simplelist>
1246       </para>
1247     </refsect1>
1248     <refsect1>
1249       <title>Exceptional Situations</title>
1250       <para>
1251         <!-- execeptional situations -->
1252       </para>
1253     </refsect1>
1254     <refsect1>
1255       <title>See Also</title>
1256       <para>
1257         <simplelist>
1258           <!-- see also -->
1259         </simplelist>
1260       </para>
1261     </refsect1>
1262     <refsect1>
1263       <title>Notes</title>
1264       <para>
1265         <!-- notes -->
1266       </para>
1267     </refsect1>
1268   </refentry>
1269
1270   <refentry id="drop-sequence">
1271     <refnamediv>
1272       <refname>DROP-SEQUENCE</refname>
1273       <refpurpose><!-- purpose --></refpurpose>
1274       <refclass>Function</refclass>
1275     </refnamediv>
1276     <refsect1>
1277       <title>Syntax</title>
1278       <synopsis>
1279       <function> (DROP-SEQUENCE NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1280     </refsect1>
1281     <refsect1>
1282       <title>Arguments and Values</title>
1283       <variablelist>
1284         <!-- arguments and values -->
1285       </variablelist>
1286     </refsect1>
1287     <refsect1>
1288       <title>Description</title>
1289       <para>Drops the sequence called NAME from DATABASE
1290       which defaults to *DEFAULT-DATABASE*. If the sequence
1291       does not exist and IF-DOES-NOT-EXIST is :ignore then
1292       DROP-SEQUENCE returns nil whereas an error is
1293       signalled if IF-DOES-NOT-EXIST is :error.
1294       </para>
1295     </refsect1>
1296     <refsect1>
1297       <title>Examples</title>
1298       <screen>
1299         <!-- examples -->
1300       </screen>
1301     </refsect1>
1302     <refsect1>
1303       <title>Side Effects</title>
1304       <para>
1305         <!-- side effects -->
1306       </para>
1307     </refsect1>
1308     <refsect1>
1309       <title>Affected by</title>
1310       <para>
1311         <simplelist>
1312           <!-- affected by -->
1313         </simplelist>
1314       </para>
1315     </refsect1>
1316     <refsect1>
1317       <title>Exceptional Situations</title>
1318       <para>
1319         <!-- execeptional situations -->
1320       </para>
1321     </refsect1>
1322     <refsect1>
1323       <title>See Also</title>
1324       <para>
1325         <simplelist>
1326           <!-- see also -->
1327         </simplelist>
1328       </para>
1329     </refsect1>
1330     <refsect1>
1331       <title>Notes</title>
1332       <para>
1333         <!-- notes -->
1334       </para>
1335     </refsect1>
1336   </refentry>
1337
1338   <refentry id="list-sequences">
1339     <refnamediv>
1340       <refname>LIST-SEQUENCES</refname>
1341       <refpurpose><!-- purpose --></refpurpose>
1342       <refclass>Function</refclass>
1343     </refnamediv>
1344     <refsect1>
1345       <title>Syntax</title>
1346       <synopsis>
1347       <function> (LIST-SEQUENCES &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1348     </refsect1>
1349     <refsect1>
1350       <title>Arguments and Values</title>
1351       <variablelist>
1352         <!-- arguments and values -->
1353       </variablelist>
1354     </refsect1>
1355     <refsect1>
1356       <title>Description</title>
1357       <para>Returns a list of strings representing
1358       sequence names in DATABASE which defaults to
1359       *DEFAULT-DATABASE*. OWNER is nil by default which
1360       means that only sequences owned by users are
1361       listed. If OWNER is a string denoting a user name,
1362       only sequences owned by OWNER are listed. If OWNER is
1363       :all then all sequences are listed.
1364       </para>
1365     </refsect1>
1366     <refsect1>
1367       <title>Examples</title>
1368       <screen>
1369         <!-- examples -->
1370       </screen>
1371     </refsect1>
1372     <refsect1>
1373       <title>Side Effects</title>
1374       <para>
1375         <!-- side effects -->
1376       </para>
1377     </refsect1>
1378     <refsect1>
1379       <title>Affected by</title>
1380       <para>
1381         <simplelist>
1382           <!-- affected by -->
1383         </simplelist>
1384       </para>
1385     </refsect1>
1386     <refsect1>
1387       <title>Exceptional Situations</title>
1388       <para>
1389         <!-- execeptional situations -->
1390       </para>
1391     </refsect1>
1392     <refsect1>
1393       <title>See Also</title>
1394       <para>
1395         <simplelist>
1396           <!-- see also -->
1397         </simplelist>
1398       </para>
1399     </refsect1>
1400     <refsect1>
1401       <title>Notes</title>
1402       <para>
1403         <!-- notes -->
1404       </para>
1405     </refsect1>
1406   </refentry>
1407
1408   <refentry id="sequence-exists-p">
1409     <refnamediv>
1410       <refname>SEQUENCE-EXISTS-P</refname>
1411       <refpurpose><!-- purpose --></refpurpose>
1412       <refclass>Function</refclass>
1413     </refnamediv>
1414     <refsect1>
1415       <title>Syntax</title>
1416       <synopsis>
1417       <function> (SEQUENCE-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1418     </refsect1>
1419     <refsect1>
1420       <title>Arguments and Values</title>
1421       <variablelist>
1422         <!-- arguments and values -->
1423       </variablelist>
1424     </refsect1>
1425     <refsect1>
1426       <title>Description</title>
1427       <para>Tests for the existence of an SQL sequence called NAME in
1428       DATABASE which defaults to *DEFAULT-DATABASE*. OWNER is nil by
1429       default which means that only sequences owned by users are
1430       examined. If OWNER is a string denoting a user name, only
1431       sequences owned by OWNER are examined. If OWNER is :all then all
1432       sequences are examined.
1433       </para>
1434     </refsect1>
1435     <refsect1>
1436       <title>Examples</title>
1437       <screen>
1438         <!-- examples -->
1439       </screen>
1440     </refsect1>
1441     <refsect1>
1442       <title>Side Effects</title>
1443       <para>
1444         <!-- side effects -->
1445       </para>
1446     </refsect1>
1447     <refsect1>
1448       <title>Affected by</title>
1449       <para>
1450         <simplelist>
1451           <!-- affected by -->
1452         </simplelist>
1453       </para>
1454     </refsect1>
1455     <refsect1>
1456       <title>Exceptional Situations</title>
1457       <para>
1458         <!-- execeptional situations -->
1459       </para>
1460     </refsect1>
1461     <refsect1>
1462       <title>See Also</title>
1463       <para>
1464         <simplelist>
1465           <!-- see also -->
1466         </simplelist>
1467       </para>
1468     </refsect1>
1469     <refsect1>
1470       <title>Notes</title>
1471       <para>
1472         <!-- notes -->
1473       </para>
1474     </refsect1>
1475   </refentry>
1476
1477   <refentry id="sequence-last">
1478     <refnamediv>
1479       <refname>SEQUENCE-LAST</refname>
1480       <refpurpose><!-- purpose --></refpurpose>
1481       <refclass>Function</refclass>
1482     </refnamediv>
1483     <refsect1>
1484       <title>Syntax</title>
1485       <synopsis>
1486       <function> (SEQUENCE-LAST NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1487     </refsect1>
1488     <refsect1>
1489       <title>Arguments and Values</title>
1490       <variablelist>
1491         <!-- arguments and values -->
1492       </variablelist>
1493     </refsect1>
1494     <refsect1>
1495       <title>Description</title>
1496       <para>Return the last value of the sequence called NAME in DATABASE
1497       which defaults to *DEFAULT-DATABASE*.
1498       </para>
1499     </refsect1>
1500     <refsect1>
1501       <title>Examples</title>
1502       <screen>
1503         <!-- examples -->
1504       </screen>
1505     </refsect1>
1506     <refsect1>
1507       <title>Side Effects</title>
1508       <para>
1509         <!-- side effects -->
1510       </para>
1511     </refsect1>
1512     <refsect1>
1513       <title>Affected by</title>
1514       <para>
1515         <simplelist>
1516           <!-- affected by -->
1517         </simplelist>
1518       </para>
1519     </refsect1>
1520     <refsect1>
1521       <title>Exceptional Situations</title>
1522       <para>
1523         <!-- execeptional situations -->
1524       </para>
1525     </refsect1>
1526     <refsect1>
1527       <title>See Also</title>
1528       <para>
1529         <simplelist>
1530           <!-- see also -->
1531         </simplelist>
1532       </para>
1533     </refsect1>
1534     <refsect1>
1535       <title>Notes</title>
1536       <para>
1537         <!-- notes -->
1538       </para>
1539     </refsect1>
1540   </refentry>
1541
1542   <refentry id="sequence-next">
1543     <refnamediv>
1544       <refname>SEQUENCE-NEXT</refname>
1545       <refpurpose><!-- purpose --></refpurpose>
1546       <refclass>Function</refclass>
1547     </refnamediv>
1548     <refsect1>
1549       <title>Syntax</title>
1550       <synopsis>
1551       <function> (SEQUENCE-NEXT NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1552     </refsect1>
1553     <refsect1>
1554       <title>Arguments and Values</title>
1555       <variablelist>
1556         <!-- arguments and values -->
1557       </variablelist>
1558     </refsect1>
1559     <refsect1>
1560       <title>Description</title>
1561       <para>Return the next value in the sequence called NAME in DATABASE
1562       which defaults to *DEFAULT-DATABASE*.
1563       </para>
1564     </refsect1>
1565     <refsect1>
1566       <title>Examples</title>
1567       <screen>
1568         <!-- examples -->
1569       </screen>
1570     </refsect1>
1571     <refsect1>
1572       <title>Side Effects</title>
1573       <para>
1574         <!-- side effects -->
1575       </para>
1576     </refsect1>
1577     <refsect1>
1578       <title>Affected by</title>
1579       <para>
1580         <simplelist>
1581           <!-- affected by -->
1582         </simplelist>
1583       </para>
1584     </refsect1>
1585     <refsect1>
1586       <title>Exceptional Situations</title>
1587       <para>
1588         <!-- execeptional situations -->
1589       </para>
1590     </refsect1>
1591     <refsect1>
1592       <title>See Also</title>
1593       <para>
1594         <simplelist>
1595           <!-- see also -->
1596         </simplelist>
1597       </para>
1598     </refsect1>
1599     <refsect1>
1600       <title>Notes</title>
1601       <para>
1602         <!-- notes -->
1603       </para>
1604     </refsect1>
1605   </refentry>
1606
1607   <refentry id="set-sequence-position">
1608     <refnamediv>
1609       <refname>SET-SEQUENCE-POSITION</refname>
1610       <refpurpose><!-- purpose --></refpurpose>
1611       <refclass>Function</refclass>
1612     </refnamediv>
1613     <refsect1>
1614       <title>Syntax</title>
1615       <synopsis>
1616       <function> (SET-SEQUENCE-POSITION NAME POSITION &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
1617     </refsect1>
1618     <refsect1>
1619       <title>Arguments and Values</title>
1620       <variablelist>
1621         <!-- arguments and values -->
1622       </variablelist>
1623     </refsect1>
1624     <refsect1>
1625       <title>Description</title>
1626       <para>Explicitly set the the position of the sequence called NAME in
1627       DATABASE, which defaults to *DEFAULT-DATABSE*, to POSITION.
1628       </para>
1629     </refsect1>
1630     <refsect1>
1631       <title>Examples</title>
1632       <screen>
1633         <!-- examples -->
1634       </screen>
1635     </refsect1>
1636     <refsect1>
1637       <title>Side Effects</title>
1638       <para>
1639         <!-- side effects -->
1640       </para>
1641     </refsect1>
1642     <refsect1>
1643       <title>Affected by</title>
1644       <para>
1645         <simplelist>
1646           <!-- affected by -->
1647         </simplelist>
1648       </para>
1649     </refsect1>
1650     <refsect1>
1651       <title>Exceptional Situations</title>
1652       <para>
1653         <!-- execeptional situations -->
1654       </para>
1655     </refsect1>
1656     <refsect1>
1657       <title>See Also</title>
1658       <para>
1659         <simplelist>
1660           <!-- see also -->
1661         </simplelist>
1662       </para>
1663     </refsect1>
1664     <refsect1>
1665       <title>Notes</title>
1666       <para>
1667         <!-- notes -->
1668       </para>
1669     </refsect1>
1670   </refentry>
1671
1672 </reference>