+10 Jul 2004 Kevin Rosenberg <kevin@rosenberg.net>
+ * doc/*.xml: Midway through docbook schema fixes
+
9 Jul 2004 Kevin Rosenberg <kevin@rosenberg.net>
* Version 2.11.13
* sql/fdml.lisp: Apply patch from Kim Minh Kaplan
<!ENTITY lw "<application>Lispworks</application>">
<!ENTITY acl "<application>AllegroCL</application>">
<!ENTITY cl "<application>ANSI Common Lisp</application>">
-<!ENTITY t "<symbol>T</symbol>">
-<!ENTITY nil "<symbol>NIL</symbol>">
+<!ENTITY t "<constant>T</constant>">
+<!ENTITY nil "<constant>NIL</constant>">
<!ENTITY null "<constant>NULL</constant>">
-<!ENTITY c "<symbol>C</symbol>">
-<!ENTITY unix "UNIX">
-<!ENTITY mswindows "Microsoft Windows">
+<!ENTITY c "<application>C</application>">
+<!ENTITY unix "<application>UNIX</application>">
+<!ENTITY mswindows "<application>Microsoft Windows</application>">
<refentrytitle>DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Class</emphasis> <emphasis role="bold">DATABASE</emphasis></refname>
+ <refname>DATABASE</refname>
<refpurpose>The super-type of all &clsql; databases</refpurpose>
<refclass>Class</refclass>
</refnamediv>
<refentrytitle>*CONNECT-IF-EXISTS*</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Variable</emphasis> <emphasis role="bold">*CONNECT-IF-EXISTS*</emphasis></refname>
+ <refname>*CONNECT-IF-EXISTS*</refname>
<refpurpose>Default value for the
<parameter>if-exists</parameter> parameter of <link
linkend="connect"><function>connect</function></link>.</refpurpose>
<refsect1>
<title>Value Type</title>
<para>A valid argument to the <parameter>if-exists</parameter>
- parameter of <function>connect</function>, i.e. one of
+ parameter of <function>connect</function>, that is, one of
<simplelist type="inline">
<member><symbol>:new</symbol></member>
<member><symbol>:warn-new</symbol></member>
<refentrytitle>*DEFAULT-DATABASE*</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Variable</emphasis> <emphasis role="bold">*DEFAULT-DATABASE*</emphasis></refname>
+ <refname>*DEFAULT-DATABASE*</refname>
<refpurpose>The default database object to use.</refpurpose>
<refclass>Variable</refclass>
</refnamediv>
<refentrytitle>*DEFAULT-DATABASE-TYPE*</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Variable</emphasis> <emphasis role="bold">*DEFAULT-DATABASE-TYPE*</emphasis></refname>
+ <refname>*DEFAULT-DATABASE-TYPE*</refname>
<refpurpose>The default database type to use</refpurpose>
<refclass>Variable</refclass>
</refnamediv>
<refentrytitle>*INITIALIZED-DATABASE-TYPES*</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Variable</emphasis> <emphasis role="bold">*INITIALIZED-DATABASE-TYPES*</emphasis></refname>
+ <refname>*INITIALIZED-DATABASE-TYPES*</refname>
<refpurpose>List of all initialized database types</refpurpose>
<refclass>Variable</refclass>
</refnamediv>
<refentrytitle>CONNECT</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CONNECT</emphasis></refname>
+ <refname>CONNECT</refname>
<refpurpose>create a connection to a database.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>CONNECTED-DATABASES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CONNECTED-DATABASES</emphasis></refname>
+ <refname>CONNECTED-DATABASES</refname>
<refpurpose>Return the list of active database objects.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DATABASE-NAME</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Generic Function</emphasis> <emphasis role="bold">DATABASE-NAME</emphasis></refname>
+ <refname>DATABASE-NAME</refname>
<refpurpose>Get the name of a database object</refpurpose>
<refclass>Generic Function</refclass>
</refnamediv>
<refentrytitle>DATABASE-NAME-FROM-SPEC</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Generic Function</emphasis> <emphasis role="bold">DATABASE-NAME-FROM-SPEC</emphasis></refname>
+ <refname>DATABASE-NAME-FROM-SPEC</refname>
<refpurpose>Return the database name string corresponding to
the given connection specification.</refpurpose>
<refclass>Generic Function</refclass>
<refentrytitle>DATABASE-TYPE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Generic Function</emphasis> <emphasis role="bold">DATABASE-TYPE</emphasis></refname>
+ <refname>DATABASE-TYPE</refname>
<refpurpose>Get the type of a database object.</refpurpose>
<refclass>Generic Function</refclass>
</refnamediv>
<refentrytitle>DISCONNECT</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DISCONNECT</emphasis></refname>
+ <refname>DISCONNECT</refname>
<refpurpose>close a database connection</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DISCONNECT-POOLED</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DISCONNECT-POOLED</emphasis></refname>
+ <refname>DISCONNECT-POOLED</refname>
<refpurpose>closes all pooled database connections</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>FIND-DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">FIND-DATABASE</emphasis></refname>
+ <refname>FIND-DATABASE</refname>
<refpurpose>>Locate a database object through it's
name.</refpurpose>
<refclass>Function</refclass>
<refentrytitle>INITIALIZE-DATABASE-TYPE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">INITIALIZE-DATABASE-TYPE</emphasis></refname>
+ <refname>INITIALIZE-DATABASE-TYPE</refname>
<refpurpose>Initializes a database type</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>RECONNECT</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">RECONNECT</emphasis></refname>
+ <refname>RECONNECT</refname>
<refpurpose>Re-establishes the connection between a database object and its RDBMS.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>STATUS</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">STATUS</emphasis></refname>
+ <refname>STATUS</refname>
<refpurpose>Print information about connected databases.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>CREATE-DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CREATE-DATABASE</emphasis></refname>
+ <refname>CREATE-DATABASE</refname>
<refpurpose>create a database</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DESTROY-DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DESTROY-DATABASE</emphasis></refname>
+ <refname>DESTROY-DATABASE</refname>
<refpurpose>destroys a database</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>PROBE-DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">PROBE-DATABASE</emphasis></refname>
+ <refname>PROBE-DATABASE</refname>
<refpurpose>tests for existence of a database</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-DATABASES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-DATABASES</emphasis></refname>
+ <refname>LIST-DATABASES</refname>
<refpurpose>List databases matching the supplied connection spec
and database type.</refpurpose>
<refclass>Function</refclass>
<refentrytitle>WITH-DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">WITH-DATABASE</emphasis></refname>
+ <refname>WITH-DATABASE</refname>
<refpurpose>Execute a body of code with a variable bound to a
specified database object.</refpurpose>
<refclass>Macro</refclass>
<refentrytitle>WITH-DEFAULT-DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">WITH-DEFAULT-DATABASE</emphasis></refname>
+ <refname>WITH-DEFAULT-DATABASE</refname>
<refpurpose>Execute a body of code with <symbol>*default-database*</symbol> bound to a specified database.</refpurpose>
<refclass>Macro</refclass>
</refnamediv>
<refentrytitle>CREATE-TABLE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CREATE-TABLE</emphasis></refname>
+ <refname>CREATE-TABLE</refname>
<refpurpose>Create a database table.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DROP-TABLE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DROP-TABLE</emphasis></refname>
+ <refname>DROP-TABLE</refname>
<refpurpose>Drop a database table.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-TABLES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-TABLES</emphasis></refname>
+ <refname>LIST-TABLES</refname>
<refpurpose>Returns a list of database tables.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>TABLE-EXISTS-P</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">TABLE-EXISTS-P</emphasis></refname>
+ <refname>TABLE-EXISTS-P</refname>
<refpurpose>Tests for the existence of a database table.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>CREATE-VIEW</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CREATE-VIEW</emphasis></refname>
+ <refname>CREATE-VIEW</refname>
<refpurpose>Create a database view.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DROP-VIEW</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DROP-VIEW</emphasis></refname>
+ <refname>DROP-VIEW</refname>
<refpurpose>Drops a database view.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-VIEWS</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-VIEWS</emphasis></refname>
+ <refname>LIST-VIEWS</refname>
<refpurpose>Returns a list of database views.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>VIEW-EXISTS-P</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">VIEW-EXISTS-P</emphasis></refname>
+ <refname>VIEW-EXISTS-P</refname>
<refpurpose>Tests for the existence of a database view.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>CREATE-INDEX</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CREATE-INDEX</emphasis></refname>
+ <refname>CREATE-INDEX</refname>
<refpurpose>Create a database index.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DROP-INDEX</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DROP-INDEX</emphasis></refname>
+ <refname>DROP-INDEX</refname>
<refpurpose>Drop a database index.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-INDEXES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-INDEXES</emphasis></refname>
+ <refname>LIST-INDEXES</refname>
<refpurpose>Returns a list of database indexes.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>INDEX-EXISTS-P</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">INDEX-EXISTS-P</emphasis></refname>
+ <refname>INDEX-EXISTS-</refname>
<refpurpose>Tests for the existence of a database index.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>ATTRIBUTE-TYPE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">ATTRIBUTE-TYPE</emphasis></refname>
+ <refname>ATTRIBUTE-TYPE</refname>
<refpurpose>Returns the type of the supplied attribute.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-ATTRIBUTE-TYPES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-ATTRIBUTE-TYPES</emphasis></refname>
+ <refname>LIST-ATTRIBUTE-TYPES</refname>
<refpurpose>Returns information about the attribute types of a table.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-ATTRIBUTES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-ATTRIBUTES</emphasis></refname>
+ <refname>LIST-ATTRIBUTES</refname>
<refpurpose>Returns the attributes of a table as a list.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>CREATE-SEQUENCE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CREATE-SEQUENCE</emphasis></refname>
+ <refname>CREATE-SEQUENCE</refname>
<refpurpose>Create a database sequence.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DROP-SEQUENCE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DROP-SEQUENCE</emphasis></refname>
+ <refname>DROP-SEQUENCE</refname>
<refpurpose>Drop a database sequence.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-SEQUENCES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-SEQUENCES</emphasis></refname>
+ <refname>LIST-SEQUENCES</refname>
<refpurpose>Returns a list of database sequences.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SEQUENCE-EXISTS-P</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SEQUENCE-EXISTS-P</emphasis></refname>
+ <refname>SEQUENCE-EXISTS-P</refname>
<refpurpose>Tests for the existence of a database sequence.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SEQUENCE-LAST</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SEQUENCE-LAST</emphasis></refname>
+ <refname>SEQUENCE-LAST</refname>
<refpurpose>Return the last element in a database sequence.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SEQUENCE-NEXT</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SEQUENCE-NEXT</emphasis></refname>
+ <refname>SEQUENCE-NEXT</refname>
<refpurpose>Increment the value of a database sequence.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SET-SEQUENCE-POSITION</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SET-SEQUENCE-POSITION</emphasis></refname>
+ <refname>SET-SEQUENCE-POSITION</refname>
<refpurpose>Sets the position of a database sequence.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>TRUNCATE-DATABASE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">TRUNCATE-DATABASE</emphasis></refname>
+ <refname>TRUNCATE-DATABASE</refname>
<refpurpose>Drop all tables, views, indexes and sequences in a database.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>*CACHE-TABLE-QUERIES-DEFAULT*</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Variable</emphasis> <emphasis role="bold">*CACHE-TABLE-QUERIES-DEFAULT*</emphasis></refname>
+ <refname>*CACHE-TABLE-QUERIES-DEFAULT*</refname>
<refpurpose>Specifies the default behaviour for caching of
attribute types.</refpurpose>
<refclass>Variable</refclass>
<refentrytitle>CACHE-TABLE-QUERIES</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">CACHE-TABLE-QUERIES</emphasis></refname>
- <refpurpose>Controls the caching of attribute type information for a database table.</refpurpose>
- <refclass>Function</refclass>
+ <refname>CACHE-TABLE-QUERIES</refname>
+ <refpurpose>Control the caching of table attribute types.</refpurpose>
</refnamediv>
- <refsect1>
- <title>Syntax</title>
- <synopsis>
- <function>cache-table-queries</function> <replaceable>table</replaceable> &key <replaceable>action</replaceable> <replaceable>database</replaceable>) => <returnvalue></returnvalue></synopsis>
- </refsect1>
- <refsect1>
- <title>Arguments and Values</title>
- <variablelist>
- <varlistentry>
- <term><parameter>table</parameter></term>
- <listitem>
- <para>
- A string representing a database table, &t; or
- <symbol>:default</symbol>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter></term>
- <listitem>
- <para>
- &t;, &nil; or <symbol>:flush</symbol>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>database</parameter></term>
- <listitem>
- <para>A
- <glossterm linkend="gloss-database-object">database
- object</glossterm>. This will default to the value
- of <symbol>*default-database*</symbol>.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Controls the caching of attribute type information on the
- table specified by <parameter>table</parameter> in
- <parameter>database</parameter> which defaults to
- <symbol>*default-database*</symbol>. <parameter>action</parameter>
- specifies the caching behaviour to adopt. If its value is &t;
- then attribute type information is cached whereas if its value
- is &nil; then attribute type information is not cached. If
- <parameter>action</parameter> is <symbol>:flush</symbol> then
- all existing type information in the cache for
- <parameter>table</parameter> is removed, but caching is still
- enabled. <parameter>table</parameter> may be a string
- representing a table for which the caching action is to be taken
- while the caching action is applied to all tables if
- <parameter>table</parameter> is &t;. Alternatively, when
- <parameter>table</parameter> is <symbol>:default</symbol>, the
- default caching action specified by
- <symbol>*cache-table-queries-default*</symbol> is applied to all
- tables for which a caching action has not been explicitly set.
- </para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <screen>
-(setf *cache-table-queries-default* t)
-=> T
-(create-table [foo]
- '(([id] integer)
- ([height] float)
- ([name] (string 24))
- ([comments] varchar)))
-=>
-(cache-table-queries "foo")
-=>
-(list-attribute-types "foo")
-=> (("id" :INT4 4 NIL 1) ("height" :FLOAT8 8 NIL 1) ("name" :BPCHAR 24 NIL 1)
- ("comments" :VARCHAR 255 NIL 1))
-(drop-table "foo")
-=>
-(create-table [foo]
- '(([id] integer)
- ([height] float)
- ([name] (string 36))
- ([comments] (string 100))))
-=>
-(cache-table-queries "foo" :action :flush)
-=>
-(list-attribute-types "foo")
-=> (("id" :INT4 4 NIL 1) ("height" :FLOAT8 8 NIL 1) ("name" :BPCHAR 36 NIL 1)
- ("comments" :BPCHAR 100 NIL 1))
- </screen>
- </refsect1>
- <refsect1>
- <title>Side Effects</title>
- <para>
- The internal attribute cache for
- <parameter>database</parameter> is modified.
- </para>
- </refsect1>
- <refsect1>
- <title>Affected by</title>
- <simplelist>
- <member><link linkend="cache-table-queries-default"><symbol>*cache-table-queries-default*</symbol></link></member>
- </simplelist>
- </refsect1>
- <refsect1>
- <title>Exceptional Situations</title>
- <para>
- None.
- </para>
- </refsect1>
- <refsect1>
- <title>See Also</title>
- <simplelist>
- <member><link linkend="cache-table-queries-default"><symbol>*cache-table-queries-default*</symbol></link></member>
- </simplelist>
- </refsect1>
- <refsect1>
- <title>Notes</title>
- <para>
- None.
- </para>
- </refsect1>
</refentry>
-
- <!-- insert/update/delete records -->
-
<refentry id="insert-records">
<refmeta>
<refentrytitle>INSERT-RECORDS</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">INSERT-RECORDS</emphasis></refname>
+ <refname>INSERT-RECORDS</refname>
<refpurpose>Insert tuples of data into a database table.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>UPDATE-RECORDS</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">UPDATE-RECORDS</emphasis></refname>
+ <refname>UPDATE-RECORDS</refname>
<refpurpose>Updates the values of existing records.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DELETE-RECORDS</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DELETE-RECORDS</emphasis></refname>
+ <refname>DELETE-RECORDS</refname>
<refpurpose>Delete records from a database table.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>EXECUTE-COMMAND</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Generic Function</emphasis> <emphasis role="bold">EXECUTE-COMMAND</emphasis></refname>
+ <refname>EXECUTE-COMMAND</refname>
<refpurpose>Execute an SQL command which returns no values.</refpurpose>
<refclass>Generic Function</refclass>
</refnamediv>
<refentrytitle>QUERY</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Generic Function</emphasis> <emphasis role="bold">QUERY</emphasis></refname>
+ <refname>QUERY</refname>
<refpurpose>Execute an SQL query and return the tuples as a
list.</refpurpose>
<refclass>Generic Function</refclass>
<refentrytitle>PRINT-QUERY</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">PRINT-QUERY</emphasis></refname>
+ <refname>PRINT-QUERY</refname>
<refpurpose>Prints a tabular report of query results.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SELECT</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SELECT</emphasis></refname>
+ <refname>SELECT</refname>
<refpurpose>Executes a query given the supplied constraints.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DO-QUERY</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">DO-QUERY</emphasis></refname>
+ <refname>DO-QUERY</refname>
<refpurpose>Iterate over all the tuples of a query.</refpurpose>
<refclass>Macro</refclass>
</refnamediv>
<refentrytitle>LOOP</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Additional clause</emphasis> for <emphasis role="bold">LOOP</emphasis></refname>
- <refpurpose>Iterate over all the tuples of a
- query via a loop clause.</refpurpose>
+ <refname>LOOP</refname>
+ <refpurpose>Extension to Common Lisp
+ <computeroutput>Loop</computeroutput> to iterate over all the
+ tuples of a query via a loop clause.</refpurpose>
<refclass>Loop Clause</refclass>
</refnamediv>
<!-- refsect1>
<refentrytitle>MAP-QUERY</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">MAP-QUERY</emphasis></refname>
+ <refname>MAP-QUERY</refname>
<refpurpose>Map a function over all the tuples from a
query</refpurpose>
<refclass>Function</refclass>
written with the OODML.
</para>
<para>
- The main function for reading data with the OODML is the
- <link linkend="select"><function>select</function></link> function. The
- <function>select</function> is also used in the FDML. However, when <function>select</function>
- is given a view class name, it returns a list of instances of view classes.
+ The main function for reading data with the OODML is the <link
+ linkend="select"><function>select</function></link>
+ function. The <function>select</function> is also used in the
+ FDML. However, when <function>select</function> is given a view
+ class name, it returns a list of instances of view classes.
+ </para>
+ <para>
+ View class instances can be updated to reflect any changes in
+ the database with the functions <link
+ linkend="update-slot-from-record"><function>update-slot-from-record</function></link>
+ and <link
+ linkend="update-instance-from-records"><function>update-instance-from-records</function></link>.
+ </para>
+ <para>To update the database to reflect changes made to instances of view classes, use the functions <link
+ linkend="update-records-from-instance"><function>update-records-from-instance</function></link>,
+ <link
+ linkend="update-record-from-slot"><function>update-record-from-slot</function></link>, and
+ <link
+ linkend="update-record-from-slots"><function>update-record-from-slots</function></link>.
+ </para>
+ <para>
+ The function <link
+ linkend="delete-instance-records"><function>delete-instance-records</function></link>
+ deletes the records corresponding to an instance of a view
+ class.
</para>
</partintro>
<para>&nil;</para>
</refsect1>
<refsect1>
- <title>Description</title>
- When this variable is &t; an instance is stored in the SQL database when the instance is created
- by <function>make-instance</function>. When this variable is &nil;, which is the default value, &clsql;
- behaves like &commonsql;: instances of view classes are stored to the SQL database only when
- <link linkend="update-record-from-slots"><function>update-record-from-slots</function></link>
- is called.
+ <title>Description</title>
+ <para>
+ When this variable is &t; an instance is stored in the SQL
+ database when the instance is created by
+ <function>make-instance</function>. When this variable is
+ &nil;, which is the default value, &clsql; behaves like
+ &commonsql;: instances of view classes are stored to the SQL
+ database only when <link
+ linkend="update-record-from-slots"><function>update-record-from-slots</function></link>
+ is called.
+ </para>
</refsect1>
<refsect1>
<title>Examples</title>
</refsect1>
<refsect1>
<title>See Also</title>
- <para>None.</para>
+ <simplelist>
+ <member><link linkend="update-object-joins"><function>update-object-joins</function></link></member>
+ </simplelist>
</refsect1>
<refsect1>
<title>Notes</title>
<refentry id="delete-instance-records">
<refnamediv>
<refname>DELETE-INSTANCE-RECORDS</refname>
- <refpurpose>Delete SQL records represented by a view class object.</refpurpose>
+ <refpurpose>Delete SQL records represented by a view class
+ object.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refsect1>
<title>Affected by</title>
<para>
<simplelist>
- <!-- affected by -->
+ <simplelist>
+ <member><link
+ linkend="default-update-objects-max-len"><variable>*default-update-objects-max-len*</variable></link></member>
+ </simplelist>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Exceptional Situations</title>
<para>
- <!-- execeptional situations -->
+ Database errors.
</para>
</refsect1>
<refsect1>
<refsect1>
<title>Arguments and Values</title>
<variablelist>
- <!-- arguments and values -->
+ <varlistentry>
+ <term><parameter>object</parameter></term>
+ <listitem>
+ <para>
+ An instance of a view class.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>slot</parameter></term>
+ <listitem>
+ <para>
+ The name of a slot in <parameter>object</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>database</parameter></term>
+ <listitem>
+ <para>
+ A database connection.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>
</para>
</refsect1>
<refsect1>
- <title>examples</title>
+ <title>Examples</title>
<screen>
<!-- examples -->
</screen>
</refsect1>
<refsect1>
- <title>side effects</title>
+ <title>Side Effects</title>
<para>
- modifies sql database.
+ Modifies database.
</para>
</refsect1>
<refsect1>
- <title>affected by</title>
+ <title>Affected By</title>
<para>
- <simplelist>
- <!-- affected by -->
- </simplelist>
+ Nothing.
</para>
</refsect1>
<refsect1>
- <title>exceptional situations</title>
+ <title>Exceptional Situations</title>
<para>
- if a database error occurs.
+ Database errors.
</para>
</refsect1>
<refsect1>
- <title>see also</title>
+ <title>See Also</title>
<para>
<simplelist>
- <!-- see also -->
+ <member><link linkend="update-record-from-slots"><function>update-record-from-slots</function></link></member>
+ <member><link linkend="update-records-from-instance"><function>update-records-from-instance</function></link></member>
</simplelist>
</para>
</refsect1>
<function>(update-record-from-slots object slots &key (database *default-database*))</function> => <returnvalue><!-- result --></returnvalue></synopsis>
</refsect1>
<refsect1>
- <title>arguments and values</title>
+ <title>Arguments and Values</title>
<variablelist>
- <!-- arguments and values -->
+ <varlistentry>
+ <term><parameter>object</parameter></term>
+ <listitem>
+ <para>
+ An instance of a view class.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>slots</parameter></term>
+ <listitem>
+ <para>
+ A list of slot names in <parameter>object</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>database</parameter></term>
+ <listitem>
+ <para>
+ A database connection.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>
- <title>description</title>
- <para>updates the values stored in the columns represented by
+ <title>Description</title>
+ <para>Updates the values stored in the columns represented by
the slots, specified by the clos slot names
<parameter>slots</parameter>, of view class instance
<parameter>object</parameter>. <parameter>database</parameter>
<refsect1>
<title>Affected by</title>
<para>
- <simplelist>
- <!-- affected by -->
- </simplelist>
+ Nothing.
</para>
</refsect1>
<refsect1>
<title>Exceptional Situations</title>
<para>
- <!-- execeptional situations -->
+ Database errors.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<simplelist>
- <!-- see also -->
+ <member><link linkend="update-record-from-slot"><function>update-record-from-slot</function></link></member>
+ <member><link linkend="update-records-from-instance"><function>update-records-from-instance</function></link></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
<variablelist>
- <!-- arguments and values -->
+ <varlistentry>
+ <term><parameter>object</parameter></term>
+ <listitem>
+ <para>
+ An instance of a view class.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>database</parameter></term>
+ <listitem>
+ <para>
+ A database connection.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>
<refsect1>
<title>Side Effects</title>
<para>
- <!-- side effects -->
+ Modifies the database.
</para>
</refsect1>
<refsect1>
<title>Affected by</title>
<para>
- <simplelist>
- <!-- affected by -->
- </simplelist>
+ Nothing.
</para>
</refsect1>
<refsect1>
<title>Exceptional Situations</title>
<para>
- <!-- execeptional situations -->
+ Database errors.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<simplelist>
- <!-- see also -->
+ <member><link linkend="update-record-from-slot"><function>update-record-from-slot</function></link></member>
+ <member><link linkend="update-record-from-slots"><function>update-record-from-slots</function></link></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
<variablelist>
- <!-- arguments and values -->
+ <varlistentry>
+ <term><parameter>object</parameter></term>
+ <listitem>
+ <para>
+ An instance of a view class.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>slot</parameter></term>
+ <listitem>
+ <para>
+ The name of a slot in <parameter>object</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>database</parameter></term>
+ <listitem>
+ <para>
+ A database connection.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>
<refsect1>
<title>Exceptional Situations</title>
<para>
- SQL access errors.
+ Database errors.
</para>
</refsect1>
<refsect1>
<refentrytitle>START-SQL-RECORDING</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">START-SQL-RECORDING</emphasis></refname>
+ <refname>START-SQL-RECORDING</refname>
<refpurpose>Start recording SQL commands or results.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>STOP-SQL-RECORDING</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">STOP-SQL-RECORDING</emphasis></refname>
+ <refname>STOP-SQL-RECORDING</refname>
<refpurpose>Stop recording SQL commands or results.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SQL-RECORDING-P</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-RECORDING-P</emphasis></refname>
+ <refname>SQL-RECORDING-P</refname>
<refpurpose>Tests whether SQL commands or results are being recorded.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SQL-STREAM</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-STREAM</emphasis></refname>
+ <refname>SQL-STREAM</refname>
<refpurpose>Returns the broadcast stream used for recording SQL commands or results.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>ADD-SQL-STREAM</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">ADD-SQL-STREAM</emphasis></refname>
+ <refname>ADD-SQL-STREAM</refname>
<refpurpose>Add a component to the broadcast streams used for recording SQL commands or results.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>DELETE-SQL-STREAM</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">DELETE-SQL-STREAM</emphasis></refname>
+ <refname>DELETE-SQL-STREAM</refname>
<refpurpose>Remove a component from the broadcast streams used for recording SQL commands or results.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>LIST-SQL-STREAMS</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">LIST-SQL-STREAMS</emphasis></refname>
+ <refname>LIST-SQL-STREAMS</refname>
<refpurpose>List the components of the broadcast streams used for recording SQL commands or results.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>ENABLE-SQL-READER-SYNTAX</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">ENABLE-SQL-READER-SYNTAX</emphasis></refname>
+ <refname>ENABLE-SQL-READER-SYNTAX</refname>
<refpurpose>Globally enable square bracket reader syntax.</refpurpose>
<refclass>Macro</refclass>
</refnamediv>
<refentrytitle>DISABLE-SQL-READER-SYNTAX</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">DISABLE-SQL-READER-SYNTAX</emphasis></refname>
+ <refname>DISABLE-SQL-READER-SYNTAX</refname>
<refpurpose>Globally disable square bracket reader syntax.</refpurpose>
<refclass>Macro</refclass>
</refnamediv>
<refentrytitle>LOCALLY-ENABLE-SQL-READER-SYNTAX</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">LOCALLY-ENABLE-SQL-READER-SYNTAX</emphasis></refname>
+ <refname>LOCALLY-ENABLE-SQL-READER-SYNTAX</refname>
<refpurpose>Globally enable square bracket reader syntax.</refpurpose>
<refclass>Macro</refclass>
</refnamediv>
<refentrytitle>LOCALLY-DISABLE-SQL-READER-SYNTAX</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">LOCALLY-DISABLE-SQL-READER-SYNTAX</emphasis></refname>
+ <refname>LOCALLY-DISABLE-SQL-READER-SYNTAX</refname>
<refpurpose>Locally disable square bracket reader syntax.</refpurpose>
<refclass>Macro</refclass>
</refnamediv>
<refentrytitle>RESTORE-SQL-READER-SYNTAX-STATE</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">RESTORE-SQL-READER-SYNTAX-STATE</emphasis></refname>
+ <refname>RESTORE-SQL-READER-SYNTAX-STATE</refname>
<refpurpose>
Restore square bracket reader syntax to its previous state.
</refpurpose>
<refentrytitle>SQL</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL</emphasis></refname>
+ <refname>SQL</refname>
<refpurpose>Construct an SQL string from supplied expressions.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SQL-EXPRESSION</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-EXPRESSION</emphasis></refname>
+ <refname>SQL-EXPRESSION</refname>
<refpurpose>Constructs an SQL expression from supplied keyword arguments.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SQL-OPERATION</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-OPERATION</emphasis></refname>
+ <refname>SQL-OPERATION</refname>
<refpurpose>Constructs an SQL expression from a supplied operator and arguments.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SQL-OPERATOR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-OPERATOR</emphasis></refname>
+ <refname>SQL-OPERATOR</refname>
<refpurpose>Returns the symbol for the supplied SQL operator.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>START-TRANSACTION</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">START-TRANSACTION</emphasis></refname>
+ <refname>START-TRANSACTION</refname>
<refpurpose>Open a transaction block.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>COMMIT</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">COMMIT</emphasis></refname>
+ <refname>COMMIT</refname>
<refpurpose>Commit modifications made in the current transaction.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>ROLLBACK</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">ROLLBACK</emphasis></refname>
+ <refname>ROLLBACK</refname>
<refpurpose>Roll back modifications made in the current transaction.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>IN-TRANSACTION-P</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">IN-TRANSACTION-P</emphasis></refname>
+ <refname>IN-TRANSACTION-P</refname>
<refpurpose>A predicate for testing whether a transaction is currently in progress.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>ADD-TRANSACTION-COMMIT-HOOK</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">ADD-TRANSACTION-COMMIT-HOOK</emphasis></refname>
+ <refname>ADD-TRANSACTION-COMMIT-HOOK</refname>
<refpurpose>Specify hooks to be run when committing changes.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>ADD-TRANSACTION-ROLLBACK-HOOK</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">ADD-TRANSACTION-ROLLBACK-HOOK</emphasis></refname>
+ <refname>ADD-TRANSACTION-ROLLBACK-HOOK</refname>
<refpurpose>Specify hooks to be run when rolling back changes.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>SET-AUTOCOMMIT</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">SET-AUTOCOMMIT</emphasis></refname>
+ <refname>SET-AUTOCOMMIT</refname>
<refpurpose>Turn on or off autocommit for a database.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>WITH-TRANSACTION</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Macro</emphasis> <emphasis role="bold">WITH-TRANSACTION</emphasis></refname>
+ <refname>WITH-TRANSACTION</refname>
<refpurpose>Execute a body of code within a transaction.</refpurpose>
<refclass>Macro</refclass>
</refnamediv>