X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fappendix.xml;fp=doc%2Fappendix.xml;h=c9c7086c79589fa865f47f802c2e8a5de9afebec;hb=a35619ce17c910796b4f6f58c5916f8f513073e1;hp=0000000000000000000000000000000000000000;hpb=fff83fbba112503ad015db50038c5628c88d4c99;p=clsql.git diff --git a/doc/appendix.xml b/doc/appendix.xml new file mode 100644 index 0000000..c9c7086 --- /dev/null +++ b/doc/appendix.xml @@ -0,0 +1,311 @@ + + +%myents; +]> + + + Database Back-ends + + + MySQL + + Libraries + The MySQL back-end needs access to the MySQL C + client library (libmysqlclient.so). + The location of this library is specified + via *mysql-so-load-path*, which defaults + to /usr/lib/libmysqlclient.so. + Additional flags to ld needed for + linking are specified via *mysql-so-libraries*, + which defaults to ("-lc"). + + + + Initialization + Use + (mk:load-system :clsql-mysql) + to load the MySQL back-end. The database type for the MySQL + back-end is :mysql. + + + Connection Specification + + Syntax of connection-spec + (host db user password) + + + Description of connection-spec + + + host + + String representing the hostname or IP address + the MySQL server resides on, or nil + to indicate the localhost. + + + + db + + String representing the name of the database on + the server to connect to. + + + + user + + String representing the user name to use for + authentication, or nil to use the + current Unix user ID. + + + + password + + String representing the unencrypted password to + use for authentication, or nil if + the authentication record has an empty password + field. + + + + + + + + + PostgreSQL + + Libraries + The PostgreSQL back-end needs access to the PostgreSQL C + client library (libpq.so). The + location of this library is specified via + *postgresql-so-load-path*, which defaults + to /usr/lib/libpq.so. Additional flags + to ld needed for linking are + specified via *postgresql-so-libraries*, + which defaults to ("-lcrypt" "-lc"). + + + Initialization + Use + (mk:load-system :clsql-postgresql) + to load the PostgreSQL back-end. The database type for the + PostgreSQL back-end is :postgresql. + + + Connection Specification + + Syntax of connection-spec + (host db user password &optional port options tty) + + + Description of connection-spec + For every parameter in the connection-spec, + nil indicates that the PostgreSQL default + environment variables (see PostgreSQL documentation) will + be used, or if those are unset, the compiled-in defaults + of the C client library are used. + + + host + + String representing the hostname or IP address + the PostgreSQL server resides on. Use the empty + string to indicate a connection to localhost via + Unix-Domain sockets instead of TCP/IP. + + + + db + + String representing the name of the database on + the server to connect to. + + + + user + + String representing the user name to use for + authentication. + + + + password + + String representing the unencrypted password to + use for authentication. + + + + port + + String representing the port to use for + communication with the PostgreSQL server. + + + + options + + String representing further runtime options for + the PostgreSQL server. + + + + tty + + String representing the tty or file to use for + debugging messages from the PostgreSQL server. + + + + + + + + + PostgreSQL Socket + + Libraries + The PostgreSQL Socket back-end needs + no access to the PostgreSQL C + client library, since it communicates directly with the + PostgreSQL server using the published frontend/backend + protocol, version 2.0. This eases installation and makes it + possible to dump CMU CL images containing CLSQL and this + backend, contrary to backends which require FFI code. + + + Initialization + Use + (mk:load-system :clsql-postgresql-socket) + to load the PostgreSQL Socket back-end. The database type for the + PostgreSQL Socket back-end is + :postgresql-socket. + + + Connection Specification + + Syntax of connection-spec + (host db user password &optional port options tty) + + + Description of connection-spec + + + host + + If this is a string, it represents the hostname or + IP address the PostgreSQL server resides on. In + this case communication with the server proceeds via + a TCP connection to the given host and port. + + If this is a pathname, then it is assumed to name the + directory that contains the server's Unix-Domain + sockets. The full name to the socket is then + constructed from this and the port number passed, + and communication will proceed via a connection to + this unix-domain socket. + + + + db + + String representing the name of the database on + the server to connect to. + + + + user + + String representing the user name to use for + authentication. + + + + password + + String representing the unencrypted password to + use for authentication. This can be the empty + string if no password is required for + authentication. + + + + port + + Integer representing the port to use for + communication with the PostgreSQL server. This + defaults to 5432. + + + + options + + String representing further runtime options for + the PostgreSQL server. + + + + tty + + String representing the tty or file to use for + debugging messages from the PostgreSQL server. + + + + + + + + + AODBC + + Libraries + The AODBC back-end requires access to the ODBC interface + of &acl;. + + + Initialization + Use + (mk:load-system :clsql-aodbc) + to load the MySQL back-end. The database type for the AODBC + back-end is :aodbc. + + + Connection Specification + + Syntax of connection-spec + (dsn user password) + + + Description of connection-spec + + + dsn + + String representing the ODBC data source name. + + + + user + + String representing the user name to use for + authentication. + + + + password + + String representing the unencrypted password to + use for authentication. + + + + + + + +