X-Git-Url: http://git.kpe.io/?p=clsql.git;a=blobdiff_plain;f=doc%2Fintro.xml;h=936cf59e9acd8d5c14cf7d91f690b32d0ee7996b;hp=044ec082b437f7082be964cd5289d3cec91552ad;hb=f67c4e2a4e5b8371a1b7c1629828999ff909f538;hpb=7ff510f86da4e60a8bde51d9874729bb518f3ae0 diff --git a/doc/intro.xml b/doc/intro.xml index 044ec08..936cf59 100644 --- a/doc/intro.xml +++ b/doc/intro.xml @@ -14,7 +14,7 @@ linkend="gloss-sql">SQL databases. A number of Common Lisp implementations and SQL databases are supported. The general structure of &clsql; is based on the &commonsql; package by - Xanalys. + LispWorks Ltd. @@ -42,7 +42,8 @@ Optimized loading of integer and floating-point fields. - Additional database backends: &odbc;, &aodbc;, and &sqlite;. + Additional database backends: &odbc;, &aodbc;, &sqlite; + and &sqlite3;. A compatibility layer for &cmucl; specific code. @@ -85,7 +86,7 @@ &uffi; &clsql; uses &uffi; + url="http://uffi.kpe.io/">&uffi; as a Foreign Function Interface (FFI) to support multiple &cl; implementations. @@ -95,7 +96,7 @@ &md5; &clsql;'s postgresql-socket interface uses Pierre Mai's - md5 + md5 module. @@ -106,26 +107,33 @@ implementations of &uffi;. The following implementations are supported: - &acl; v6.2 on Debian Linux, FreeBSD 4.5, and Microsoft Windows XP. - &lw; v4.3 on Debian Linux and Microsoft Windows XP. - &cmucl; 18e on Debian Linux, FreeBSD 4.5, and Solaris 2.8. - &sbcl; 0.8.5 on Debian Linux. + &acl; v6.2 through 8.0 on Debian Linux x86 & + x86_64 & PowerPC, FreeBSD 4.5, and Microsoft Windows + XP. + &lw; v4.3 and v4.4 on Debian Linux and Microsoft + Windows XP. + &cmucl; 18e on Debian Linux, FreeBSD 4.5, and + Solaris 2.8. 19c on Debian Linux. + &sbcl; 0.8.4 through 0.9.16 on Debian + Linux. &scl; 1.1.1 on Debian Linux. - &openmcl; 0.14 on Debian Linux PowerPC. + &openmcl; 0.14 PowerPC and 1.0pre AMD64 on Debian Linux . Supported &sql; Implementation - Currently, &clsql; supports the following databases: + &clsql; supports the following databases: - &mysql; v3.23.51 and v4.0.15. - &postgresql; v7.2 with both direct API and TCP + &mysql; (tested v3.23.51, v4.0.18, 5.0.24). + &postgresql; (tested with v7.4 and 8.0 with both direct API and TCP socket connections. &sqlite;. + &sqlite3;. Direct &odbc; interface. + &oracle; OCI. Allegro's DB interface (&aodbc;). @@ -184,7 +192,7 @@ - Load &uffi; + Add &uffi; path Unzip or untar the &uffi; distribution which creates a directory for the &uffi; files. Add that directory to &asdf;'s asdf:*central-registry*. @@ -194,12 +202,11 @@ directory. (push #P"/usr/share/lisp/uffi/" asdf:*central-registry*) -(asdf:operate 'asdf:load-op :uffi) - Load &md5; module + Add &md5; path If you plan to use the clsql-postgresql-socket interface, you must load the md5 module. Unzip or untar the cl-md5 @@ -211,13 +218,12 @@ /usr/share/lisp/cl-md5/ directory. (push #P"/usr/share/lisp/cl-md5/" asdf:*central-registry*) -(asdf:operate 'asdf:load-op :md5) - Load &clsql; modules + Add &clsql; path and load module Unzip or untar the &clsql; distribution which creates a directory for the &clsql; files. Add that directory to &asdf;'s @@ -225,34 +231,28 @@ pushing the pathname of the directory onto this variable. The following example code assumes the &clsql; files reside in the /usr/share/lisp/clsql/ directory. You need - to load, at a minimum, the main clsql system - and at least one interface system. The below example show loading - all &clsql; systems. + to load the clsql system. (push #P"/usr/share/lisp/clsql/" asdf:*central-registry*) -(asdf:operate 'asdf:load-op 'clsql-base) ; base CLSQL package -(asdf:operate 'asdf:load-op 'clsql-mysql) ; MySQL interface -(asdf:operate 'asdf:load-op 'clsql-postgresql) ; PostgreSQL interface -(asdf:operate 'asdf:load-op 'clsql-postgresql-socket) ; Socket PGSQL interface -(asdf:operate 'asdf:load-op 'clsql-odbc) ; ODBC interface -(asdf:operate 'asdf:load-op 'clsql-sqlite) ; SQLite interface -(asdf:operate 'asdf:load-op 'clsql-aodbc) ; Allegro ODBC interface (asdf:operate 'asdf:load-op 'clsql) ; main CLSQL package - Run test suite + Run test suite (optional) - After loading &clsql;, you can execute the test suite. A - configuration file named + The test suite can be executed using the &asdf; + test-op operator. If &clsql; has not been + loaded with asdf:load-op, the + asdf:test-op operator will automatically load + &clsql;. A configuration file named .clsql-test.config must be created in your home directory. There are instructures on the format of - that file in the tests/tests.lisp file in - the &clsql; source directory. After creating that file, you - can run the test suite with &asdf;: + that file in the tests/README. After + creating .clsql-test.config, you can run + the test suite with &asdf;: (asdf:operate 'asdf:test-op 'clsql)