+<?xml version='1.0' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % myents SYSTEM "entities.inc">
+%myents;
+]>
+
<reference id="indexes">
<title>Index</title>
</refnamediv>
<refsect1>
+ <title>
+ </title>
<simplelist columns="2">
<!-- VARIABLES -->
</varlistentry>
<varlistentry>
<term><parameter>field-names</parameter></term>
- <para>
- A boolean with a default value of &t;. When &t;, this
- function results a second value of a list of field
- names. When &nil;, this function only returns one value
- - the list of rows.
- </para>
+ <listitem>
+ <para>
+ A boolean with a default value of &t;. When &t;, this
+ function results a second value of a list of field
+ names. When &nil;, this function only returns one value
+ - the list of rows.
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><returnvalue>result</returnvalue></term>
<refentrytitle>*BACKEND-WARNING-BEHAVIOR*</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Variable</emphasis> <emphasis role="bold">*BACKEND-WARNING-BEHAVIOR*</emphasis></refname>
+ <refname>*BACKEND-WARNING-BEHAVIOR*</refname>
<refpurpose>Controls behaviour on warnings from underlying RDBMS.</refpurpose>
<refclass>Variable</refclass>
</refnamediv>
<para><symbol>:warn</symbol></para>
</refsect1>
<refsect1>
- <title>Description</title> Action to perform on warning messages
- from backend. Default is to <symbol>:warn</symbol>. May also be
- set to <symbol>:error</symbol> to signal an error or
- <symbol>:ignore</symbol> or &nil; to silently ignore the
- warning.
+ <title>Description</title>
+ <para>
+ Action to perform on warning messages
+ from backend. Default is to <symbol>:warn</symbol>. May also be
+ set to <symbol>:error</symbol> to signal an error or
+ <symbol>:ignore</symbol> or &nil; to silently ignore the
+ warning.
+ </para>
</refsect1>
<refsect1>
<title>Examples</title>
<refentrytitle>SQL-CONDITION</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold"><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-CONDITION</emphasis></emphasis></refname>
+ <refname>SQL-CONDITION</refname>
<refpurpose>the super-type of all
&clsql;-specific
conditions</refpurpose>
<refentrytitle>SQL-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-ERROR</emphasis></refname>
+ <refname>SQL-ERROR</refname>
<refpurpose>the super-type of all
&clsql;-specific
errors</refpurpose>
<refentrytitle>SQL-WARNING</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-WARNING</emphasis></refname>
+ <refname>SQL-WARNING</refname>
<refpurpose>the super-type of all
&clsql;-specific
warnings</refpurpose>
<refentrytitle>SQL-DATABASE-WARNING</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-DATABASE-WARNING</emphasis></refname>
+ <refname>SQL-DATABASE-WARNING</refname>
<refpurpose>Used to warn while accessing a
&clsql; database.</refpurpose>
<refclass>Condition Type</refclass>
<refentrytitle>SQL-USER-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-USER-ERROR</emphasis></refname>
+ <refname>SQL-USER-ERROR</refname>
<refpurpose>condition representing errors because of invalid
parameters from the library user.</refpurpose>
<refclass>Condition Type</refclass>
<refentrytitle>SQL-DATABASE-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-DATABASE-ERROR</emphasis></refname>
+ <refname>SQL-DATABASE-ERROR</refname>
<refpurpose>condition representing errors during query or
command execution</refpurpose>
<refclass>Condition Type</refclass>
<refentrytitle>SQL-CONNECTION-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-CONNECTION-ERROR</emphasis></refname>
+ <refname>SQL-CONNECTION-ERROR</refname>
<refpurpose>condition representing errors during
connection</refpurpose>
<refclass>Condition Type</refclass>
<refentrytitle>SQL-DATABASE-DATA-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-DATABASE-DATA-ERROR</emphasis></refname>
+ <refname>SQL-DATABASE-DATA-ERROR</refname>
<refpurpose>Used to signal an error with the SQL data passed
to a database.</refpurpose>
<refclass>Condition Type</refclass>
<refentrytitle>SQL-TEMPORARY-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-TEMPORARY-ERROR</emphasis></refname>
+ <refname>SQL-TEMPORARY-ERROR</refname>
<refpurpose>Used to signal a temporary error in the database
backend.</refpurpose>
<refclass>Condition Type</refclass>
<refentrytitle>SQL-TIMEOUT-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-TIMEOUT-ERROR</emphasis></refname>
+ <refname>SQL-TIMEOUT-ERROR</refname>
<refpurpose>condition representing errors when a connection
times out.</refpurpose>
<refclass>Condition Type</refclass>
<refentrytitle>SQL-FATAL-ERROR</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-FATAL-ERROR</emphasis></refname>
+ <refname>SQL-FATAL-ERROR</refname>
<refpurpose>condition representing a fatal error in a database
connection</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
- <title>Syntax</title>
- <synopsis><function>connect</function> <replaceable>connection-spec</replaceable> &key <replaceable>if-exists</replaceable> <replaceable>database-type</replaceable> <replaceable>pool</replaceable> <replaceable>make-default</replaceable> => <returnvalue>database</returnvalue></synopsis>
+ <synopsis><function>connect</function> <replaceable>connection-spec</replaceable> &key <replaceable>if-exists</replaceable> <replaceable>database-type</replaceable> <replaceable>pool</replaceable> <replaceable>make-default</replaceable> => <returnvalue>database</returnvalue></synopsis>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
<refname>CACHE-TABLE-QUERIES</refname>
<refpurpose>Control the caching of table attribute types.</refpurpose>
</refnamediv>
+ <refsect1>
+ <title>Syntax</title>
+ <para>
+ </para>
+ </refsect1>
</refentry>
<refentry id="insert-records">
</refsect1>
<refsect1>
<title>Side Effects</title>
- <para>
<para>Whatever effects the execution of the SQL query has on
the underlying database, if any.</para>
- </para>
</refsect1>
<refsect1>
<title>Affected by</title>
and SQL tables can be deleted with <link
linkend="drop-view-from-class"><function>drop-view-from-class</function></link>.
</para>
- <note>The above functions refer to the Lisp <emphasis>view</emphasis> of the SQL
- table. This Lisp view should not be confused with SQL <function>VIEW</function> statement.
+ <note>
+ <para>The above functions refer to the Lisp <emphasis>view</emphasis> of the SQL
+ table. This Lisp view should not be confused with SQL <function>VIEW</function> statement.</para>
</note>
</partintro>
of all &clsql; View Classes.</para>
</refsect1>
<refsect1>
- <title class="contenttitle">Class details</title>
+ <title>Class details</title>
<programlisting>(defclass STANDARD-DB-OBJECT ()(...))</programlisting>
</refsect1>
<refsect1>
- <title class="contenttitle">Slots</title>
+ <title>Slots</title>
<para>
<simplelist>
- <property>slot VIEW-DATABASE is of type (OR NULL DATABASE)
+ <member>slot VIEW-DATABASE is of type (OR NULL DATABASE)
which stores the associated database for the
- instance.</property>
+ instance.</member>
</simplelist>
</para>
</refsect1>
<title>Affected by</title>
<para>
<simplelist>
- Which view classes have been defined in the Lisp session.
+ <member>Which view classes have been defined in the Lisp session.</member>
</simplelist>
</para>
</refsect1>
<para>
This special variable provides the default value for the
<parameter>max-len</parameter> argument of the function <link
- linkend="update-object-joins"><function>update-object-joins</function></link>.
+ linkend="update-objects-joins"><function>update-object-joins</function></link>.
</para>
</refsect1>
<refsect1>
<refsect1>
<title>See Also</title>
<simplelist>
- <member><link linkend="update-object-joins"><function>update-object-joins</function></link></member>
+ <member><link linkend="update-objects-joins"><function>update-object-joins</function></link></member>
</simplelist>
</refsect1>
<refsect1>
appropriate table of <parameter>database</parameter> which
defaults to the database associated with
<parameter>object</parameter> or, if <parameter>object</parameter> is not associated
- with a database, <variable>*default-database*</variable>. Join slots are updated but
+ with a database, <varname>*default-database*</varname>. Join slots are updated but
instances of the class on which the join is made are not
updated.
</para>
<title>Affected by</title>
<para>
<simplelist>
- Data in SQL database.
+ <member>Data in SQL database.</member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
- <simplelist>
- <!-- see also -->
- </simplelist>
</para>
</refsect1>
<refsect1>
<title>Affected by</title>
<para>
<simplelist>
- <simplelist>
- <member><link
- linkend="default-update-objects-max-len"><variable>*default-update-objects-max-len*</variable></link></member>
- </simplelist>
- </simplelist>
+ <member><link
+ linkend="default-update-objects-max-len"><varname>*default-update-objects-max-len*</varname></link></member>
+ </simplelist>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<simplelist>
- <!-- see also -->
+ <member><link
+ linkend="default-update-objects-max-len"><varname>*default-update-objects-max-len*</varname></link></member>
</simplelist>
</para>
</refsect1>
defaults to the database associated with
<parameter>object</parameter> or, if
<parameter>object</parameter> is not associated with a database,
- <variable>*default-database*</variable>. Join slots are updated
+ <varname>*default-database*</varname>. Join slots are updated
but instances of the class on which the join is made are not
updated.
</para>
<refsect1>
<title>See Also</title>
<para>
- <simplelist>
- <!-- see also -->
- </simplelist>
</para>
</refsect1>
<refsect1>
<refentrytitle>PREPARE-SQL</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">PREPARE-SQL</emphasis></refname>
+ <refname>>PREPARE-SQL</refname>
<refpurpose>Create a prepared statement.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>RUN-PREPARED-SQL</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">RUN-PREPARED-SQL</emphasis></refname>
+ <refname>RUN-PREPARED-SQL</refname>
<refpurpose>Execute a prepared statement.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>FREE-PREPARED-SQL</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">FREE-PREPARED-SQL</emphasis></refname>
+ <refname>FREE-PREPARED-SQL</refname>
<refpurpose>Delete a prepared statement object.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
<refentrytitle>BIND-PARAMETER</refentrytitle>
</refmeta>
<refnamediv>
- <refname><emphasis>Function</emphasis> <emphasis role="bold">BIND-PARAMETER</emphasis></refname>
+ <refname>BIND-PARAMETER</refname>
<refpurpose>Bind a parameter in a prepared statement.</refpurpose>
<refclass>Function</refclass>
</refnamediv>
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><parameter>type</parameter></term>
- <varlistentry>
- <term><parameter>stream</parameter></term>
- <listitem>
- <para>
- A stream or &t;.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><parameter>stream</parameter></term>
+ <listitem>
+ <para>
+ A stream or &t;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>type</parameter></term>
<listitem>
<para>
One of the following keyword symbols:
</para>
<simplelist>
<!-- CommonSQL Compatible -->
- <member><function>any
- </function></member>,
- <member><function>some
- </function></member>,
- <member><function>all
- </function></member>,
- <member><function>not
- </function></member>,
- <member><function>union
- </function></member>,
- <member><function>intersect
- </function></member>,
- <member><function>minus
- </function></member>,
+ <member><function>any</function></member>
+ <member><function>some</function></member>
+ <member><function>all</function></member>
+ <member><function>not</function></member>
+ <member><function>union</function></member>
+ <member><function>intersect</function></member>
+ <member><function>minus</function></member>
<member><function>except
- </function></member>,
+ </function></member>
<member><function>order-by
- </function></member>,
+ </function></member>
<member><function>null
- </function></member>,
+ </function></member>
<member><function>*
- </function></member>,
+ </function></member>
<member><function>+
- </function></member>,
+ </function></member>
<member><function>/
- </function></member>,
+ </function></member>
<member><function>-
- </function></member>,
+ </function></member>
<member><function>like
- </function></member>,
+ </function></member>
<member><function>and
- </function></member>,
+ </function></member>
<member><function>or
- </function></member>,
+ </function></member>
<member><function>in
- </function></member>,
+ </function></member>
<member><function>substr
- </function></member>,
+ </function></member>
<member><function>||
- </function></member>,
+ </function></member>
<member><function>=
- </function></member>,
+ </function></member>
<member><function><
- </function></member>,
+ </function></member>
<member><function>>
- </function></member>,
+ </function></member>
<member><function>>=
- </function></member>,
+ </function></member>
<member><function><=
- </function></member>,
+ </function></member>
<member><function><>
- </function></member>,
+ </function></member>
<member><function>count
- </function></member>,
+ </function></member>
<member><function>max
- </function></member>,
+ </function></member>
<member><function>min
- </function></member>,
+ </function></member>
<member><function>avg
- </function></member>,
+ </function></member>
<member><function>sum
- </function></member>,
+ </function></member>
<member><function>function
- </function></member>,
+ </function></member>
<member><function>between
- </function></member>,
+ </function></member>
<member><function>distinct
- </function></member>,
+ </function></member>
<member><function>nvl
- </function></member>,
+ </function></member>
<member><function>slot-value
- </function></member>,
+ </function></member>
<member><function>userenv
- </function></member>,
+ </function></member>
</simplelist>
<para>
as well as the pseudo-operator <function>function</function>.
<simplelist>
<!-- CLSQL Extensions -->
<member><function>concat
- </function></member>,
+ </function></member>
<member><function>substring
- </function></member>,
+ </function></member>
<member><function>limit
- </function></member>,
+ </function></member>
<member><function>group-by
- </function></member>,
+ </function></member>
<member><function>having
- </function></member>,
+ </function></member>
<member><function>not-null
- </function></member>,
+ </function></member>
<member><function>exists
- </function></member>,
+ </function></member>
<member><function>uplike
- </function></member>,
+ </function></member>
<member><function>is
- </function></member>,
+ </function></member>
<member><function>==
- </function></member>,
+ </function></member>
<member><function>the
- </function></member>,
+ </function></member>
<member><function>coalesce
- </function></member>,
- <member><function>view-class.
+ </function></member>
+ <member><function>view-class
</function></member>
</simplelist>
</para>
transaction blocks, committing or rolling back changes made and
controlling autocommit behaviour.
</para>
- <note>
+ <note>
+ <para>
In contrast to &commonsql;, &clsql;, by default, starts in
transaction AUTOCOMMIT mode (see <link
linkend="set-autocommit"><function>set-autocommit</function></link>).
To begin a transaction in autocommit mode, <link
linkend="start-transaction"><function>start-transaction</function></link>
has to be called explicitly.
+ </para>
</note>
</partintro>
object</glossterm>. This will default to the value
of <symbol>*default-database*</symbol>.</para>
</listitem>
-<varlistentry>
- <term><parameter>body</parameter></term>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>body</parameter></term>
<listitem>
<para>
A body of Lisp code.
<para>The result of executing <parameter>body</parameter>.</para>
</listitem>
</varlistentry>
- </varlistentry>
</variablelist>
</refsect1>
<refsect1>
<?xml version="1.0"?>
<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
+ <uri resource="ref-fddl.xml" uri="/usr/share/emacs/site-lisp/nxml-mode/schema/docbook.rnc"/>
<uri resource="appendix.xml" typeId="DocBook"/>
<uri resource="bookinfo.xml" typeId="DocBook"/>
<uri resource="clsql.xml" typeId="DocBook"/>
<uri resource="glossary.xml" typeId="DocBook"/>
<uri resource="intro.xml" typeId="DocBook"/>
<uri resource="preface.xml" typeId="DocBook"/>
- <uri resource="ref_clsql_sys.xml" typeId="DocBook"/>
- <uri resource="ref_clsql.xml" typeId="DocBook"/>
+ <uri resource="ref-clsql-sys.xml" typeId="DocBook"/>
+ <uri resource="ref-clsql.xml" typeId="DocBook"/>
+ <uri resource="ref-fddl.xml" typeId="DocBook"/>
+ <uri resource="ref-fdml.xml" typeId="DocBook"/>
+ <uri resource="ref-ooddl.xml" typeId="DocBook"/>
+ <uri resource="ref-oodml.xml" typeId="DocBook"/>
+ <uri resource="ref-connect.xml" typeId="DocBook"/>
+ <uri resource="ref-lob.xml" typeId="DocBook"/>
+ <uri resource="ref-prepared.xml" typeId="DocBook"/>
+ <uri resource="ref-conditions.xml" typeId="DocBook"/>
+ <uri resource="ref-transaction.xml" typeId="DocBook"/>
+ <uri resource="ref-syntax.xml" typeId="DocBook"/>
+ <uri resource="ref-recording.xml" typeId="DocBook"/>
+ <uri resource="global-index.xml" typeId="DocBook"/>
</locatingRules>