2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % myents SYSTEM "entities.inc">
8 <reference id="clsql-sys">
9 <title><symbol>CLSQL-SYS</symbol></title>
11 <para>This part gives a reference to all the symbols exported
12 from the package <symbol>CLSQL-SYS</symbol>, which are not also
13 exported from <symbol>CLSQL</symbol>. These symbols are part of
14 the interface for database back-ends, but not part of the normal
15 user-interface of &clsql;.</para>
17 <refentry id="database-initialize-database-type">
19 <refname>DATABASE-INITIALIZE-DATABASE-TYPE</refname>
20 <refpurpose>Back-end part of <link
21 linkend="initialize-database-type"><function>initialize-database-type</function></link>.</refpurpose>
22 <refclass>Generic Function</refclass>
26 <synopsis><function>database-initialize-database-type</function> <replaceable>database-type</replaceable> => <returnvalue>result</returnvalue></synopsis>
29 <title>Arguments and Values</title>
32 <term><parameter>database-type</parameter></term>
34 <para>A keyword indicating the database type to
39 <term><returnvalue>result</returnvalue></term>
41 <para>Either <symbol>t</symbol> if the initialization
42 succeeds or <symbol>nil</symbol> if it fails.</para>
48 <title>Description</title>
49 <para>This generic function implements the main part of the
50 database type initialization performed by
51 <function>initialize-database-type</function>. After
52 <function>initialize-database-type</function> has checked
53 that the given database type has not been initialized
54 before, as indicated by
55 <symbol>*initialized-database-types*</symbol>, it will call
56 this function with the database type as it's sole
57 parameter. Database back-ends are required to define a
58 method on this generic function which is specialized via an
59 eql-specializer to the keyword representing their database
61 <para>Database back-ends shall indicate successful
62 initialization by returning <symbol>t</symbol> from their
63 method, and <symbol>nil</symbol> otherwise. Methods for
64 this generic function are allowed to signal errors of type
65 <errortype>clsql-error</errortype> or subtypes thereof.
66 They may also signal other types of conditions, if
67 appropriate, but have to document this.</para>
70 <title>Examples</title>
74 <title>Side Effects</title>
75 <para>All necessary side effects to initialize the database
79 <title>Affected By</title>
83 <title>Exceptional Situations</title>
84 <para>Conditions of type <errortype>clsql-error</errortype>
85 or other conditions may be signalled, depending on the
86 database back-end.</para>
89 <title>See Also</title>
93 linkend="initialize-database-type"><function>initialize-database-type</function></link></member>
94 <member><link linkend="initialized-database-types"><symbol>*initialized-database-types*</symbol></link></member>