| Allegro CL version 8.2 The object described on this page has been modified in the 8.2 release; see the Release Notes. 8.1 version |
Arguments: &key host port user file password database external-format client-flags
The client-flags keyword argument was added to 8.2 in a patch but was not documented in either the 8.2 or 9.0 documentation until now.
The arguments are:
nil
value. If a non-nil
value which is not a pathname designator, the system connects to
"/var/lib/mysql/mysql.sock" which is the default Unix-domain socket
used by mysql on Linux (and perhaps other architectures as well).
This argument can only be used if both the client and server are
running the same Unix machine.
nil
, a symbol or string naming an external
format, or an external format object. This argument sets the
external-format used to process strings for this connection. If
external-format is nil
then no external format processing is done (nil
is equivalent to the :octets
external format except that nil
is faster
since the external-format processing code is bypassed). External
formats are described in iacl.htm.
dbi.mysql
package for ease of use
(e.g. dbi.mysql:CLIENT_FOUND_ROWS
).
Connects to the mysql database, authenticates the user and optionally sets the current database.
The instance of mysql to which to connect is specified by either the file argument or the host and port arguments. If both the client and server are running the same Unix machine then the file argument can be used to specify the Unix-domain socket on which mysql is listening for a connection. Typically that socket is named "/var/lib/mysql/mysql.sock".
If a file argument isn't given to connect then the host and port arguments specify the location of the mysql server. By default the host argument has value "localhost" (meaning the same machine as the client) and the port argument has the value 3306 (which is the normal port on which mysql listens).
Once connected to the mysql server the connect function will then pass the user and password to the mysql server so that it can authenticate the client. The rules for authentication are described in great detail in the MySQL reference manual (available on the http://www.mysql.com website, whose main page refers to it as the MySQL Manual). The default value for the user argument is the user's login name (the value returned by user-name). The password for an account is given in the mysql.user table of the mysql database. This password is unrelated to the password used to log onto the machine. If the database argument is given then once authentication succeeds, the connect makes the given database the current database.
connect returns a mysql
object which can be used as the value of the db
argument in calls to other functions in this library. connect also sets the value of
the symbol *mysql*
to the mysql object being
returned. Since *mysql*
is the default value for the
db argument in other functions in this library,
this means that if you're just experimenting with mysql interactively,
you can call connect
and then other functions in this library without saving the mysql
object returned by connect and then passing it back in
subsequent calls.
See mysql.htm for information on the Allegro MySQL facility.
Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.
| Allegro CL version 8.2 The object described on this page has been modified in the 8.2 release; see the Release Notes. 8.1 version |