sql/README

   1 INTRODUCTIION
   2
   3 CLSQL-USQL is a high level SQL interface for Common Lisp which is
   4 based on the CommonSQL package from Xanalys. It was originally
   5 developed at Onshore Development, Inc. based on Pierre Mai's MaiSQL
   6 package. It now incorporates some of the code developed for CLSQL. See
   7 the files CONTRIBUTORS and COPYING for more details.
   8
   9 CLSQL-USQL depends on the low-level database interfaces provided by
  10 CLSQL and includes both a functional and an object oriented
  11 interface to SQL RDBMS.
  12
  13 DOCUMENTATION
  14
  15 A CLSQL-USQL tutorial can be found in the directory doc/
  16
  17 Also see the CommonSQL documentation avaialble on the Lispworks website:
  18
  19 Xanalys LispWorks User Guide  - The CommonSQL Package
  20 http://www.lispworks.com/reference/lw43/LWUG/html/lwuser-167.htm
  21
  22 Xanalys LispWorks Reference Manual -- The SQL Package
  23 http://www.lispworks.com/reference/lw43/LWRM/html/lwref-383.htm
  24
  25 CommonSQL Tutorial by Nick Levine
  26 http://www.ravenbrook.com/doc/2002/09/13/common-sql/
  27
  28
  29 PREREQUISITES
  30
  31   o COMMON LISP: currently CMUCL, SBCL, Lispworks
  32   o RDBMS: currently Postgresql, Mysql, Sqlite
  33   o ASDF (from http://cvs.sourceforge.net/viewcvs.py/cclan/asdf/)
  34   o CLSQL-2.0.0 or later (from http://clsql.b9.com)
  35   o RT for running the test suite (from http://files.b9.com/rt/rt.tar.gz)
  36
  37
  38 INSTALLATION
  39
  40 Just load clsql-usql.asd or put it somewhere where ASDF can find it
  41 and call:
  42
  43 (asdf:oos 'asdf:load-op :clsql-usql)
  44
  45 You'll then need to load a CLSQL backend before you can do anything.
  46
  47 To run the regression tests load clsql-usql-tests.asd or put it
  48 somewhere where ASDF can find it, edit the file tests/test-init.lisp
  49 and set the following variables to appropriate values:
  50
  51     *test-database-server*
  52     *test-database-name*
  53     *test-database-user*
  54     *test-database-password*
  55
  56 And then call:
  57
  58 (asdf:oos 'asdf:load-op :clsql-usql-tests)
  59 (usql-tests:test-usql BACKEND)
  60
  61 where BACKEND is the CLSQL database interface to use (currently one of
  62 :postgresql, :postgresql-socket, :sqlite or :mysql).
  63
  64