CLSQL Users' Guide

Kevin M. Rosenberg

Maintainer of CLSQL

Pierre R. Mai

Author of Original MaiSQL Code

$Date: 2002/03/23 15:17:43 $

$Id: bookinfo.sgml,v 1.3 2002/03/23 15:17:43 kevin Exp $

CLSQL is Copyright © 2002 by Kevin M. Rosenberg and Copyright © 1999-2001 by Pierre R. Mai.
Allegro CL® is a registered trademark of Franz Inc.
Common SQL, LispWorks and Xanalys are trademarks or registered trademarks of Xanalys Inc.
Microsoft Windows® is a registered trademark of Microsoft Inc.
Other brand or product names are the registered trademarks or trademarks of their respective holders.

Table of Contents

Defsystem
UFFI
Supported Common Lisp Implementation
Supported SQL Implementation

Installation

Ensure Defsystem is loaded
Build C helper libraries
Load UFFI
Load CLSQL modules
Run test suite

I. CLSQL

CLSQL-CONDITION -- the super-type of all CLSQL-specific conditions
CLSQL-ERROR -- the super-type of all CLSQL-specific errors
CLSQL-SIMPLE-ERROR -- Unspecific simple CLSQL errors
CLSQL-WARNING -- the super-type of all CLSQL-specific warnings
CLSQL-SIMPLE-WARNING -- Unspecific simple CLSQL warnings
CLSQL-INVALID-SPEC-ERROR -- condition representing errors because of invalid connection specifications
CLSQL-CONNECT-ERROR -- condition representing errors during connection
CLSQL-SQL-ERROR -- condition representing errors during query or command execution
CLSQL-EXISTS-CONDITION -- condition indicating situations arising because of existing connections
CLSQL-EXISTS-WARNING -- condition representing warnings arising because of existing connections
CLSQL-EXISTS-ERROR -- condition representing errors arising because of existing connections
CLSQL-CLOSED-ERROR -- condition representing errors because the database has already been closed
*DEFAULT-DATABASE-TYPE* -- The default database type to use
*INITIALIZED-DATABASE-TYPES* -- List of all initialized database types
INITIALIZE-DATABASE-TYPE -- Initializes a database type
*CONNECT-IF-EXISTS* -- Default value for the if-exists parameter of connect.
CONNECTED-DATABASES -- Return the list of active database objects.
*DEFAULT-DATABASE* -- The default database object to use
DATABASE -- The super-type of all CLSQL databases
CLOSED-DATABASE -- The class representing all closed CLSQL databases
DATABASE-NAME -- Get the name of a database object
FIND-DATABASE -- Locate a database object through it's name.
CONNECT -- create a connection to a database
DISCONNECT -- close a database connection
DISCONNECT-POOLED -- closes all pooled database connections
DATABASE-NAME-FROM-SPEC -- Return the database name string corresponding to the given connection specification.
EXECUTE-COMMAND -- Execute an SQL command which returns no values.
QUERY -- Execute an SQL query and return the tuples as a list
MAP-QUERY -- Map a function over all the tuples from a query
DO-QUERY -- Iterate over all the tuples of a query
LOOP-FOR-AS-TUPLES -- Iterate over all the tuples of a query via a loop clause

II. CLSQL-SYS

DATABASE-INITIALIZE-DATABASE-TYPE -- Back-end part of initialize-database-type.

A. Database Back-ends

MySQL

Libraries
Initialization
Connection Specification

AODBC

Libraries
Initialization
Connection Specification

PostgreSQL

Libraries
Initialization
Connection Specification

PostgreSQL Socket

Libraries
Initialization
Connection Specification

Glossary

		Next
		Preface