doc/intro.sgml

   1 <!-- -*- DocBook -*- -->
   2
   3 <chapter>
   4   <title>Introduction</title>
   5
   6   <sect1>
   7     <title>Purpose</title>
   8     <para>&clsql; is a Common Lisp interface to <glossterm
   9 linkend="gloss-sql">SQL</glossterm> databases.  A number of Common
  10 Lisp implementations and SQL databases are supported.The general
  11 structure of &clsql; is based on the
  12 <application>CommonSQL</application> package by Xanalys.</para>
  13   </sect1>
  14
  15   <sect1>
  16     <title>History</title>
  17     <para>
  18       &clsql; is written by Kevin M. Rosenberg and based substantially
  19 on Pierre R. Mai's excellent &maisql; package. The main changes from &maisql;
  20 are:
  21 <itemizedlist>
  22 <listitem>
  23 <para>port from the &cmucl; FFI to &uffi;.</para>
  24 </listitem>
  25 <listitem>
  26 <para>new &acl; ODBC interface back-end.</para>
  27 </listitem>
  28 <listitem>
  29 <para>compatibility layer for &cmucl; specific code.</para>
  30 </listitem>
  31 <listitem>
  32 <para>much improved robustness for the &mysql; back-end.</para>
  33 </listitem>
  34 <listitem>
  35 <para>improved system loading.</para>
  36 </listitem>
  37 <listitem>
  38 <para>improved packages and symbol export.</para>
  39 </listitem>
  40 <listitem>
  41 <para>transaction support.</para>
  42 </listitem>
  43 </itemizedlist>
  44     </para>
  45   </sect1>
  46
  47   <sect1>
  48     <title>Prerequisites</title>
  49
  50     <sect2>
  51       <title>&defsystem;</title>
  52       <para> &clsql; uses &asdf; to compile and load its
  53 components.  &asdf; is included in the <ulink
  54 url="http://cclan.sourceforge.net"><citetitle>&cclan;</citetitle></ulink> collection.
  55       </para>
  56     </sect2>
  57
  58     <sect2>
  59       <title>&uffi;</title>
  60       <para>&clsql; uses <ulink
  61 url="http://uffi.med-info.com/"><citetitle>&uffi;</citetitle></ulink>
  62 as a <emphasis>Foreign Function Interface</emphasis> (<glossterm
  63 linkend="gloss-ffi">FFI</glossterm>) to support multiple &cl;
  64 implementations.</para>
  65
  66 <para>You can download &uffi; from its FTP <ulink
  67 url="ftp://ftp.med-info.com/pub/uffi/"><citetitle>site</citetitle></ulink>. There
  68 are zip files for Microsoft Windows systems and gzipped tar files for
  69 other systems.</para>
  70     </sect2>
  71
  72     <sect2>
  73       <title>Supported Common Lisp Implementation</title>
  74       <para>
  75 The implementations that support &clsql; is governed by the supported
  76 implementations of &uffi;. The following implementations are supported:
  77       </para>
  78       <itemizedlist mark="opencircle">
  79         <listitem><para>&acl; v6.2 on Debian Linux, FreeBSD 4.5, and Microsoft Windows XP.</para></listitem>
  80         <listitem><para>&lw; v4.2 on Debian Linux and Microsoft Windows XP.</para></listitem>
  81         <listitem><para>&cmucl; 18d on Debian Linux, FreeBSD 4.5, and Solaris 2.8.</para></listitem>
  82         <listitem><para>&sbcl; 0.7.8 on Debian Linux.</para></listitem>
  83         <listitem><para>&scl; 1.1 on Debian Linux.</para></listitem>
  84         <listitem><para>&openmcl; 0.13 on Debian Linux PowerPC.</para></listitem>
  85       </itemizedlist>
  86     </sect2>
  87
  88     <sect2>
  89       <title>Supported &sql; Implementation</title>
  90       <para>
  91         Currently, &clsql; supports the following databases:
  92       </para>
  93       <itemizedlist mark="opencircle">
  94         <listitem><para>&mysql; v3.23.51.</para></listitem>
  95         <listitem><para>&postgresql; v7.2 with both direct API and TCP socket connections.</para></listitem>
  96         <listitem><para>Allegro's ODBC interface (&aodbc;) using iODBC ODBC manager.</para></listitem>
  97       </itemizedlist>
  98     </sect2>
  99
 100   </sect1>
 101
 102   <sect1>
 103     <title>Installation</title>
 104
 105     <sect2>
 106       <title>Ensure &defsystem; is loaded</title>
 107       <para>
 108         Simply load the file <filename>defsystem.lisp</filename>.
 109         <programlisting>
 110 (load "defsystem.lisp")
 111         </programlisting>
 112       </para>
 113     </sect2>
 114
 115     <sect2>
 116       <title>Build &c; helper libraries</title>
 117       <para>&clsql; uses functions that require 64-bit integer
 118 parameters and return values. The &ffi; in most &clsql;
 119 implementations do not support 64-bit integers. Thus, C helper
 120 libraries are required to break these 64-bit integers into two compatible
 121 32-bit integers.</para>
 122
 123 <para>Makefiles for Microsoft Windows and GNU/Solaris systems
 124 are supplied to build the libraries. Since many Microsoft Windows
 125 users don't have access to a compiler, the <type>DLL</type> and <type>LIB</type>
 126 files for Microsoft Windows are supplied with the distribution.</para>
 127
 128 <para>To build the libraries on a GNU or Solaris, use the shell and
 129 change to the root directory of &clsql;. You may need to edit the file
 130 <filename>interfaces/mysql/Makefile</filename> to specify the location of your
 131 MySQL installation. The default Makefiles are setup for shared library
 132 linking on Linux. If you are using FreeBSD or Solaris, you will need
 133 to change the linker setting as instructed in the Makefile.
 134 Then, you can give the command
 135 <programlisting>
 136 make libs
 137 </programlisting>
 138 in the root directory of &clsql; to build the libraries
 139 <filename>interfaces/mysql/clsql-mysql.so</filename> and
 140 <filename>interfaces/clsql-uffi/clsql-uffi.so</filename>.
 141 </para>
 142       </sect2>
 143
 144     <sect2>
 145       <title>Load &uffi;</title>
 146       <para>
 147         Unzip or untar the &uffi; distribution which creates a directory
 148 for the &uffi; files. Add that directory to Defsystem's <varname>asdf:*central-registry*</varname>.
 149 You can do that by pushing the pathname of the directory onto this variable.
 150  The following example code assumes the &uffi; files reside in the
 151 <filename>/usr/share/lisp/uffi/</filename> directory.
 152         <programlisting>
 153 (push #P"/usr/share/lisp/uffi/" asdf:*central-repository*)
 154 (asdf:oos 'asdf:load-op :uffi)
 155         </programlisting>
 156       </para>
 157     </sect2>
 158
 159     <sect2>
 160       <title>Load &clsql; modules</title>
 161       <para>
 162         Unzip or untar the &clsql; distribution which creates a directory
 163 for the &clsql; files. Add that directory to Defsystem's <varname>asdf:*central-registry*</varname>.
 164 You can do that by pushing the pathname of the directory onto this variable.
 165  The following example code assumes the &clsql; files reside in the
 166 <filename>/usr/share/lisp/clsql/</filename> directory. You need to load, at a minimum,
 167 the main <symbol>:clsql</symbol> system and at least one interface system.
 168         <programlisting>
 169 (push #P"/usr/share/lisp/clsql/" asdf:*central-repository*)
 170 (asdf:oos 'asdf:load-op :clsql-base)        ; base clsql package
 171 (asdf:oos 'asdf:load-op :clsql-mysql)       ; MySQL interface
 172 (asdf:oos 'asdf:load-op :clsql-postgresql)  ; PostgreSQL interface
 173 (asdf:oos 'asdf:load-op :clsql-postgresql-socket) ; Socket PGSQL interface
 174 (asdf:oos 'asdf:load-op :clsql-aodbc)       ; Allegro ODBC interface
 175 (asdf:oos 'asdf:load-op :clsql)             ; main clsql package
 176         </programlisting>
 177       </para>
 178     </sect2>
 179
 180     <sect2>
 181       <title>Run test suite</title>
 182       <para>
 183         After loading &clsql;, you can execute the test program in
 184 the directory <filename>./test-suite</filename>. The test file,
 185 <filename>tester-clsql</filename>
 186 has instructions for creating a <filename>test.config</filename>.
 187 After creating that file, simple load the test file with Lisp
 188 and the tests should automatically execute.
 189       </para>
 190     </sect2>
 191
 192   </sect1>
 193
 194 </chapter>