The cl-mysql Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-mysql Reference Manual

This is the cl-mysql Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:16:07 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

1.1 cl-mysql

Maintainer

Steve Knight <stkni@yahoo.com>

Author

Steve Knight <stkni@yahoo.com>

License

MIT

Description

Common Lisp MySQL library bindings

Version

0.1

Dependency

cffi

Source

cl-mysql.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 cl-mysql.asd

Location

cl-mysql.asd

Systems

cl-mysql (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 cl-mysql/system.lisp

Parent

cl-mysql (system)

Location

system.lisp

Packages

com.hackinghat.cl-mysql-system

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.3 cl-mysql/thread.lisp

Dependency

system.lisp (file)

Parent

cl-mysql (system)

Location

thread.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.4 cl-mysql/connection.lisp

Dependency

thread.lisp (file)

Parent

cl-mysql (system)

Location

connection.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.5 cl-mysql/pool.lisp

Dependency

connection.lisp (file)

Parent

cl-mysql (system)

Location

pool.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.6 cl-mysql/mysql.lisp

Dependency

pool.lisp (file)

Parent

cl-mysql (system)

Location

mysql.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.7 cl-mysql/prepare.lisp

Dependency

mysql.lisp (file)

Parent

cl-mysql (system)

Location

prepare.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

2.1.8 cl-mysql/package.lisp

Dependency

prepare.lisp (file)

Parent

cl-mysql (system)

Location

package.lisp

Packages

com.hackinghat.cl-mysql


Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Nickname

cl-mysql-system

Use List
Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

3.2 com.hackinghat.cl-mysql

Source

package.lisp (file)

Nickname

cl-mysql

Use List

common-lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Constants

Constant: +client-compress+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-found-rows+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-ignore-sigpipe+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-ignore-space+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-interactive+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-local-files+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-multi-results+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-multi-statements+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-no-schema+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-remember-options+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +client-ssl+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Special variables

Special Variable: *last-database*

The last allocated connection-pool. Note that this special is a default argument to a lot of the higher level API functions.

Package

com.hackinghat.cl-mysql-system

Source

pool.lisp (file)

Special Variable: *type-map*
Package

com.hackinghat.cl-mysql-system

Source

connection.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Macros

Macro: with-lock LOCK &body BODY
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)

Macro: with-rows (VAR-ROW QUERY-STRING &key VAR-RESULT DATABASE TYPE-MAP) &body BODY

Takes a query-string and iterates over the result sets assigning var-row to each individual row. If you supply var-result it will hold the result set sequence number. This macro generates code that does not store the complete result so should be suitable for working with very large data sets.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.4 Functions

Function: cffi-utf8-length CFFI-STRING

We need this function because mysql_real_escape_string requires the length of the from string in bytes (not characters)

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: client-version ()

Returns a three part list containing the decoded client version information

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: connect &key HOST USER PASSWORD DATABASE PORT SOCKET CLIENT-FLAG MIN-CONNECTIONS MAX-CONNECTIONS

Connect will present to MySQL sensible defaults for all the connection items.
The following code will attach you to a MySQL instance running on localhost,
as the current user with no password. It will automatically turn on
compression between client-and-server and also enable multiple-result sets
if possible.

<pre><code>CL-USER> (connect)</code></pre>

If unsuccesful connect will raise a <strong>CL-MYSQL-ERROR</strong>, otherwise it will place
the connection into a pool, note that all connections are pool-able,
a single connection is simply the special case of a pool with only one
connection.

The pool has two slots, <strong>min-connections</strong> and <srong>max-connections</strong>. There will always be min-connections available in the pool. If you are using all
min-connections and max-connections is greater than min-connections,
the pool will continue to allocate connections until max-connections are
used. After this an attempt to aquire more connections from the pool
should block (if your implementation supports it). When a connection is
released (this is done automatically unless you explicity disable it) the
connection to the server is closed if we have allocated more connections
than min-connections.

The last allocated pool object is placed into a special variable
<strong>*last-database*</strong> which is defaulted from the higher level API functions.

Package

com.hackinghat.cl-mysql-system

Source

pool.lisp (file)

Function: disconnect &optional DATABASE

This method will disconnect all the connections in the pool. Note that if you attempt to use the pool again after calling this method it will re-allocate upto min-connections before servicing your request.

Package

com.hackinghat.cl-mysql-system

Source

pool.lisp (file)

Function: escape-string STRING &key DATABASE

Given a string, encode it appropriately. This function relies on the fact that the character set encoding was set to UTF-8 when the connection is made.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: extract-field ROW FIELD-INDEX FIELD-LENGTH TYPE-MAP FIELD-DETAIL

Returns either a string or an unsigned byte array for known binary types. The designation of binary types per the C API seems a bit weird. Basically, BIT, BINARY and VARBINARY are binary and so are BLOBs with the binary flag set. It seems that other fields also have the binary flag set that are not binary and the BIT type, whilst binary doesn’t have the flag set. Bizarre-o.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: list-dbs &key DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: list-fields TABLE &key DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: list-processes &key DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: list-tables &key DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: make-lock NAME
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)

Function: mysql-error MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-error.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: nth-row RESULT-SET-LIST N &optional NTH-RESULT-SET

Return the nth-row of the nth-result set.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: option OPTION VALUE &key DATABASE

Use this to set a client specific connection option. CL-USER> (option :opt-reconnect 1)

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: ping &key DATABASE

Check whether a connection is established or not. If :opt-reconnect is set and there is no connection then MySQL’s C API attempts a reconnection.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: query QUERY &key TYPE-MAP DATABASE STORE

For a SELECT query or stored procedure that returns data, query will return
a list of result sets. Each result set will have 1 or more sublists
where the first sublist contains the column names and the remaining lists
represent the rows of the result set. If the query does not return a result
set (for example if the query is an INSERT, UPDATE) the return value is the
number of rows affected. Because cl-mysql supports multiple-statements
you can execute code like the following:

<pre><code>CL-MYSQL-SYSTEM> (query "CREATE TABLE a(a INT);
INSERT INTO a (a) VALUES (1); DELETE FROM a; DROP TABLE a")
((0) (1) (1) (0))</code></pre>

The type-map, if set will alter the decoding into CL types. If you set
this to nil it will have the effect of disabling all CL type conversions
and return either character or binary data only.

This might be useful for performance reasons, (cl-mysql
is much faster when it doesn’t need to translate types) but it also might
be all you need. Consider for instance if you’re displaying a lot of
numerics on a web-page. If you do not need to convert the data into
floats/integers before displaying them on a page then raw could be useful
here too. cl-mysql attempts to convert all numeric types to their closest
CL representation. For very large numerics, or numerics that have very
high precision this might not be what you want. In this case you could
attempt to write your own conversion routine and inject it into cl-mysql
through the type-map.

The currented supported conversions are as follows (MySQL type -> CL type):

<ul><li><strong>DECIMAL/NUMERIC</strong> -> RATIO</li> <li><strong>INT/TINYINT/SMALLINT/MEDIUMINT/BIGINT/YEAR</strong> -> INTEGER</li> <li><strong>FLOAT/REAL/DOUBLE PRECISION</strong> -> DOUBLE-FLOAT</li> <li><strong>DATE/DATETIME/TIMESTAMP</strong> -> INTEGER (Universal time)</li>
<li><strong>TIME</strong> -> INTEGER (Seconds)</li> <li><strong>CHAR/VARCHAR/TEXT/TINYTEXT/MEDIUMTEXT/LONGTEXT</strong> -> STRING</li> <li><strong>BIT/BLOB/MEDIUMBLOB/LONGBLOB/TINYBLOB/GEOMETRY</strong> -> SIMPLE-ARRAY ’(UNSIGNED-BYTE 8 )</li> </ul>

If :store is T query returns a list of result sets. Each result set is a
list with the first element set to the data and the second elements set to
the column data. Since this structure can be a little awkward to handle
you can use nth-row to manipulate the structure more sanely.

If :store is NIL query returns the allocated connection object. You should
use next-result-set and next-row to step through the results.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: server-version &key DATABASE

Returns a three part list containing the decoded server version information

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: start-thread-in-nsecs FN N
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)

Function: string-to-date STRING &optional LEN
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: string-to-float STRING LEN

Convert a MySQL float representation into a double. Note that we could do better on DECIMAL/NUMERICs that have 0 places after the decimal.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: string-to-integer STRING &optional LEN
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: string-to-ratio STRING LEN
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: string-to-seconds STRING &optional LEN

Fairly ugly function to turn MySQL TIME duration into an integer representation.
It’s complicated because of ... well, read this: http://dev.mysql.com/doc/refman/5.0/en/time.html

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: string-to-universal-time STRING &optional LEN
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: use NAME &key DATABASE

Equivalent to running: CL-USER> (query "USE <name>")

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: wait-on-threads THREADS
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.5 Generic functions

Generic Function: aquire SELF BLOCK
Package

com.hackinghat.cl-mysql-system

Methods
Method: aquire (SELF connection) BLOCK
Source

pool.lisp (file)

Method: aquire (SELF connection-pool) BLOCK

Aquire from the pool a single connection object that can be passed to higher level API functions like QUERY.

On implementations that support threading this method will block if :block is T, and available connections is 0 and there are already max-connections. On implementations that do not support threading this method will always return NIL.

Source

pool.lisp (file)

Method: aquire SELF BLOCK
Source

pool.lisp (file)

Generic Function: available SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: available (SELF connection)
Source

connection.lisp (file)

Generic Function: available-connections OBJECT
Generic Function: (setf available-connections) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: available-connections (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Method: (setf available-connections) NEW-VALUE (CONNECTION-POOL connection-pool)

automatically generated writer method

Source

pool.lisp (file)

Generic Function: bind SELF SQL-TYPE &optional SUPPLIED-INDEX MAX-LEN
Package

com.hackinghat.cl-mysql-system

Methods
Method: bind (SELF statement) SQL-TYPE &optional SUPPLIED-INDEX MAX-LEN

Set up the bind structure for later use

Source

prepare.lisp (file)

Generic Function: bind-arg SELF INDEX
Package

com.hackinghat.cl-mysql-system

Methods
Method: bind-arg (SELF statement) INDEX
Source

prepare.lisp (file)

Generic Function: bound-map OBJECT
Generic Function: (setf bound-map) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: bound-map (STATEMENT statement)

automatically generated reader method

Source

prepare.lisp (file)

Method: (setf bound-map) NEW-VALUE (STATEMENT statement)

automatically generated writer method

Source

prepare.lisp (file)

Generic Function: can-aquire SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: can-aquire (SELF connection-pool)

Returns true if a call to aquire would result in a connection being allocated

Source

pool.lisp (file)

Generic Function: configure-bindings SELF NARGS
Package

com.hackinghat.cl-mysql-system

Methods
Method: configure-bindings (SELF statement) NARGS

Sets up a statement object ready to receive nargs bindings

Source

prepare.lisp (file)

Generic Function: connected SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: connected (SELF connection)
Source

connection.lisp (file)

Generic Function: connection-equal SELF OTHER
Package

com.hackinghat.cl-mysql-system

Methods
Method: connection-equal (SELF connection) (OTHER connection)

Two connections are equal if they point to the same memory location.

Source

connection.lisp (file)

Method: connection-equal SELF OTHER
Source

connection.lisp (file)

Generic Function: connections OBJECT
Generic Function: (setf connections) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: connections (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Method: (setf connections) NEW-VALUE (CONNECTION-POOL connection-pool)

automatically generated writer method

Source

pool.lisp (file)

Generic Function: contains SELF ARRAY CONN
Package

com.hackinghat.cl-mysql-system

Methods
Method: contains (SELF connection-pool) ARRAY CONN
Source

pool.lisp (file)

Generic Function: count-connections SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: count-connections (SELF connection-pool)

Count the number of connections in the pool. If you are dynamically changing the size of the pool after it is created this number could be greater or less than max/min connections. Set :available-only if you only want to know how many connections are currently ready to use.

Source

pool.lisp (file)

Generic Function: in-use OBJECT
Generic Function: (setf in-use) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: in-use (CONNECTION connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf in-use) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

connection.lisp (file)

Generic Function: max-connections OBJECT
Generic Function: (setf max-connections) MAX-CONNECT POOL
Package

com.hackinghat.cl-mysql-system

Methods
Method: max-connections (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Method: (setf max-connections) (MAX-CONNECT number) (POOL connection-pool)

Change the maximum number of connections available in the pool. Note that you can change this value whilst the pool is waiting for a connection to become available.

Source

pool.lisp (file)

Generic Function: min-connections OBJECT
Generic Function: (setf min-connections) MIN-CONNECT POOL
Package

com.hackinghat.cl-mysql-system

Methods
Method: min-connections (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Method: (setf min-connections) (MIN-CONNECT number) (POOL connection-pool)

Change the minimum number of connections available in the pool. Note that you can change this value whilst the pool is waiting for a connection to become available.

Source

pool.lisp (file)

Generic Function: next-index SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: next-index (SELF statement)

Returns the next unbound index or throws an error if there isn’t one. This
is just a convenience method to allow bind to be called on a simple list of types: CL-USER> mapcar (lambda (x) (bind a-statement x)) (:LONG :STRING :FLOAT))

Source

prepare.lisp (file)

Generic Function: next-result-set SELF &key DONT-RELEASE STORE
Package

com.hackinghat.cl-mysql-system

Methods
Method: next-result-set (SELF connection) &key DONT-RELEASE STORE

Position for the the next result set. Returns T if there is a result
set to process and NIL when the last result set has been passed.

sets. Use this method with (query "SELECT" :store NIL). Call next-result-set to position on the first result set then use next-row to fetch all the individual rows.

Use dont-release if you don’t want cl-mysql to release all the resources when the last result set has been processed. This might be useful, for instance, if you need access to the fields through result-set-fields after the result set has been processed.

You can, if you wish elect to not process each individual row of a result set by setting :store T. However, you cannot then use next-row because you must process the entire result set in one go.

<pre><code>CL-USER> (query "SELECT ..." :store nil)
CL-USER> (next-result-set *)
T
CL-USER> (next-row **)
...</code></pre>

Source

connection.lisp (file)

Generic Function: next-row SELF &key TYPE-MAP
Package

com.hackinghat.cl-mysql-system

Methods
Method: next-row (SELF connection) &key TYPE-MAP

Retrieve and decode (according to the type map) the next row in the query. This function will return NIL when the last row has been retrieved.

Source

connection.lisp (file)

Generic Function: pointer OBJECT
Generic Function: (setf pointer) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: pointer (STATEMENT statement)

automatically generated reader method

Source

prepare.lisp (file)

Method: pointer (CONNECTION connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf pointer) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

connection.lisp (file)

Generic Function: pool-lock OBJECT
Generic Function: (setf pool-lock) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: pool-lock (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Method: (setf pool-lock) NEW-VALUE (CONNECTION-POOL connection-pool)

automatically generated writer method

Source

pool.lisp (file)

Generic Function: process-result-set SELF TYPE-MAP
Package

com.hackinghat.cl-mysql-system

Methods
Method: process-result-set (SELF connection) TYPE-MAP

Returns a CONS of all the data in the result set. Note that this method should only be called by the client if you originally sent :store NIL to query but then set :store to T when calling next-result-set.

Source

connection.lisp (file)

Generic Function: release CONNECTABLE &optional OTHER-ARGS

Calling release will place the connection back into the pool. If the pool has more connections than max-connections then releasing the connection will close it and deallocate it.

Package

com.hackinghat.cl-mysql-system

Source

connection.lisp (file)

Methods
Method: release (SELF connection-pool) &optional CONN

Release a connection back into the pool.

Source

pool.lisp (file)

Method: release (SELF connection) &optional CONN

Convenience method to allow the release to be done with a connection

Source

pool.lisp (file)

Generic Function: result-set OBJECT
Generic Function: (setf result-set) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: result-set (CONNECTION connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf result-set) RESULT-SET (CONN connection)
Source

connection.lisp (file)

Generic Function: result-set-fields OBJECT
Generic Function: (setf result-set-fields) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: result-set-fields (CONNECTION connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf result-set-fields) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

connection.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.6 Conditions

Condition: cl-mysql-error ()
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Direct superclasses

error (condition)

Direct methods

cl-mysql-error-message (method)

Direct slots
Slot: message
Initargs

:message

Readers

cl-mysql-error-message (generic function)

Condition: mysql-error ()
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: message
Initargs

:message

Readers

mysql-error-message (generic function)

Slot: errno
Initargs

:errno

Readers

mysql-error-errno (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.7 Classes

Class: connection ()

The slots necessary to manage a MySQL database connection.

Package

com.hackinghat.cl-mysql-system

Source

connection.lisp (file)

Direct superclasses

connectable (class)

Direct methods
Direct slots
Slot: pointer
Initargs

:pointer

Initform

(cffi-sys:null-pointer)

Readers

pointer (generic function)

Writers

(setf pointer) (generic function)

Slot: result-set
Initform

(cffi-sys:null-pointer)

Readers

result-set (generic function)

Writers

(setf result-set) (generic function)

Slot: in-use
Type

(or null t)

Initargs

:in-use

Readers

in-use (generic function)

Writers

(setf in-use) (generic function)

Slot: owner-pool
Initargs

:owner-pool

Readers

owner-pool (generic function)

Slot: result-set-fields
Type

list

Readers

result-set-fields (generic function)

Writers

(setf result-set-fields) (generic function)

Slot: use-query-active
Type

(or null t)

Readers

use-query-active (generic function)

Writers

(setf use-query-active) (generic function)

Class: connection-pool ()

All connections are initiated through a pool.

Package

com.hackinghat.cl-mysql-system

Source

pool.lisp (file)

Direct superclasses

connectable (class)

Direct methods
Direct slots
Slot: hostname
Initargs

:hostname

Readers

hostname (generic function)

Slot: username
Initargs

:username

Readers

username (generic function)

Slot: password
Initargs

:password

Readers

password (generic function)

Slot: database
Initargs

:database

Readers

database (generic function)

Slot: port
Initargs

:port

Initform

0

Readers

port (generic function)

Slot: socket
Initargs

:socket

Readers

socket (generic function)

Slot: flags
Initargs

:flags

Initform

0

Readers

flags (generic function)

Slot: min-connections
Initargs

:min-connections

Initform

1

Readers

min-connections (generic function)

Slot: max-connections
Initargs

:max-connections

Initform

1

Readers

max-connections (generic function)

Slot: available-connections
Type

(or array null)

Readers

available-connections (generic function)

Writers

(setf available-connections) (generic function)

Slot: connections
Type

(or array null)

Readers

connections (generic function)

Writers

(setf connections) (generic function)

Slot: pool-lock
Initform

(com.hackinghat.cl-mysql-system:make-lock "pool lock")

Readers

pool-lock (generic function)

Writers

(setf pool-lock) (generic function)

Slot: wait-queue-lock
Initform

(com.hackinghat.cl-mysql-system:make-lock "queue lock")

Readers

wait-queue-lock (generic function)

Writers

(setf wait-queue-lock) (generic function)

Slot: wait-queue
Initform

(com.hackinghat.cl-mysql-system::make-wait-resource)

Readers

wait-queue (generic function)

Writers

(setf wait-queue) (generic function)

Class: statement ()

A holder for a MYSQL_STMT structure

Package

com.hackinghat.cl-mysql-system

Source

prepare.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: pointer
Initargs

:pointer

Initform

(cffi-sys:null-pointer)

Readers

pointer (generic function)

Slot: database
Initargs

:database

Readers

database (generic function)

Slot: nargs
Initargs

:nargs

Readers

nargs (generic function)

Writers

(setf nargs) (generic function)

Slot: args
Initargs

:args

Initform

(cffi-sys:null-pointer)

Readers

args (generic function)

Writers

(setf args) (generic function)

Slot: bound-map
Initargs

:bound-map

Readers

bound-map (generic function)

Writers

(setf bound-map) (generic function)

Slot: fully-bound
Readers

fully-bound (generic function)

Writers

(setf fully-bound) (generic function)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Constants

Constant: *sleep-period*
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)

Constant: +cant-read-charset+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +commands-out-of-sync+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +conn-host-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +conn-unknow-protocol+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +connection-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +data-truncated+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +embedded-connection+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +error-first+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +fetch-canceled+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-auto-increment+

Field is auto increment

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-binary+

Field is binary

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-blob+

Field is a blob

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-enum+

Field is an enum

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-multiple-key+

Field is part of a key

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-no-default+

Field doesn’t have a default value

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-not-null+

Field can’t be null

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-num+

Field is num

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-primary-key+

Field is part of a primary key

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-set+

Field is a set

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-timestamp+

Field is a timestamp

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-unique-key+

Field is part of a unique key

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-unsigned+

Field is unsigned

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +field-zerofill+

Field is zerofill

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +invalid-buffer-use+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +invalid-conn-handle+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +invalid-parameter-no+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +ipsock-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +localhost-connection+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +malformed-packet+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +namedpipe-connection+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +namedpipeopen-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +namedpipesetstate-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +namedpipewait-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +net-packet-too-large+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +no-data+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +no-parameters-exists+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +no-prepare-stmt+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +no-result-set+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +no-stmt-metadata+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +not-implemented+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +null-pointer+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +out-of-memory+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +params-not-bound+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +probe-master-connect+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +probe-slave-connect+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +probe-slave-hosts+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +probe-slave-status+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +secure-auth+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +server-gone-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +server-handshake-err+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +server-lost+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +server-lost-extended+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-connect-abandoned-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-connect-answer-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-connect-file-map-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-connect-map-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-connect-request-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-connect-set-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-connection+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-event-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-file-map-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +shared-memory-map-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +socket-create-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +ssl-connection-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +tcp-connection+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +unknown-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +unknown-host+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +unsupported-param-type+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +version-error+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +wrong-host-info+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Constant: +wrong-license+
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Special variables

Special Variable: *binary-types*
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Special Variable: *debug*
Package

com.hackinghat.cl-mysql-system

Source

pool.lisp (file)

Special Variable: *default-sequence-length*

This is the maximum length that a sequence sent as a bound parameter can be It’s a bit lame really. How it should really work is that ’bind’ gives you a binding and re-binds (if that’s possible) when the buffer is too small.
In practice, though, I doubt it matters very much.

Package

com.hackinghat.cl-mysql-system

Source

prepare.lisp (file)

Special Variable: *generate-alt-fns*

Compile the library with this value equal to T to get the indirection facility. For more performance (because there is no wrapper around the CFFI wrapper!) set this value to NIL

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Special Variable: *mysql-dev-api-url*

MySQL uses a standard page naming convention that matches our function names!

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Special Variable: *stmt-ctype-map*
Package

com.hackinghat.cl-mysql-system

Source

prepare.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Macros

Macro: defmysqlfun (NAME INTERNAL-NAME) RETURN-TYPE &body ARGS

Takes a mysql function name as a string and registers the
appropriate CFFI function as internal-name.

If *generate-alt-fns* is T internal-name that denotes T a wrapper function that sits around the function lib<internal-name>.

This function will call the lib<internal-name>, unless there is an ’alt-fn property set on the function’s symbol. If such a function exists it is called instead.

e.g.
CL-USER> (connect)
CL-USER> (setf (get ’mysql-close ’alt-fn) (lambda (db)
(print "Closing! ") (libmysql-close db)))
CL-USER> (disconnect)
Closing!

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Macro: with-connection (VAR &optional DATABASE RELEASE) &body BODY
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.4 Functions

Function: %set-int-option OPTION VALUE &key DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: %set-string-option OPTION VALUE &key DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: decode-version INT-VERSION

Return a list of version details <major> <release> <version>

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: error-if-non-zero DATABASE RETURN-VALUE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: error-if-null DATABASE RETURN-VALUE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: error-if-null-with-fields DATABASE RETURN-VALUE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: error-if-set DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: force-kill ()

Internal convenience function to clean up connections

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: get-character-set-info &key DATABASE

Returns the character set information for the connection as a sequence: (collation name number state)

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: get-field COLUMN-NAME FIELD-NAMES-AND-TYPES ROW

Returns the correct element in the sequence from the row that matches the column-name

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: make-wait-resource ()
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)

Function: mysql-affected-rows MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-affected-rows.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-character-set-name MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-character-set-name.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-close MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-close.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-errno MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-errno.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-escape-string TO FROM LENGTH

http://dev.mysql.com/doc/refman/5.0/en/mysql-escape-string.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-fetch-field MYSQL-RES

http://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-field.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-fetch-fields MYSQL-RES

http://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-fields.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-fetch-lengths MYSQL-RES

http://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-lengths.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-fetch-row MYSQL-RES

http://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-field-count MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-field-count.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-free-result MYSQL-RES

http://dev.mysql.com/doc/refman/5.0/en/mysql-free-result.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-get-character-set-info MYSQL CS

http://dev.mysql.com/doc/refman/5.0/en/mysql-get-character-set-info.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-get-client-version ()

http://dev.mysql.com/doc/refman/5.0/en/mysql-get-client-version.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-get-server-version MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-get-server-version.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-init MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-init.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-list-dbs MYSQL WILD

http://dev.mysql.com/doc/refman/5.0/en/mysql-list-dbs.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-list-fields MYSQL TABLE WILD

http://dev.mysql.com/doc/refman/5.0/en/mysql-list-fields.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-list-processes MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-list-processes.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-list-tables MYSQL WILD

http://dev.mysql.com/doc/refman/5.0/en/mysql-list-tables.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-next-result MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-next-result.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-num-fields MYSQL-RES

http://dev.mysql.com/doc/refman/5.0/en/mysql-num-fields.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-num-rows MYSQL-RES

http://dev.mysql.com/doc/refman/5.0/en/mysql-num-rows.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-options MYSQL OPTION ARG

http://dev.mysql.com/doc/refman/5.0/en/mysql-options.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-ping MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-ping.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-query MYSQL STATEMENT

http://dev.mysql.com/doc/refman/5.0/en/mysql-query.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-real-connect MYSQL HOST USER PASSWORD DATABASE PORT UNIX-SOCKET CLIENT-FLAG

http://dev.mysql.com/doc/refman/5.0/en/mysql-real-connect.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-real-escape-string MYSQL TO FROM LENGTH

http://dev.mysql.com/doc/refman/5.0/en/mysql-real-escape-string.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-select-db MYSQL DB

http://dev.mysql.com/doc/refman/5.0/en/mysql-select-db.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-set-character-set MYSQL CSNAME

http://dev.mysql.com/doc/refman/5.0/en/mysql-set-character-set.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-affected-rows STMT

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-affected-rows.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-bind-param STMT BIND

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-bind-param.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-close STMT

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-close.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-errno STMT

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-errno.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-error STMT

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-error.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-execute STMT

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-execute.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-init MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-init.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-param-count STMT

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-param-count.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-prepare STMT STMT_STR LENGTH

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-prepare.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-stmt-sqlstate STMT

http://dev.mysql.com/doc/refman/5.0/en/mysql-stmt-sqlstate.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-store-result MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-store-result.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: mysql-use-result MYSQL

http://dev.mysql.com/doc/refman/5.0/en/mysql-use-result.html

Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Function: pool-notify POOL
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)

Function: pool-wait POOL
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)

Function: prepare QUERY &key DATABASE

Prepare a query and return a statement object. Use execute to access it

Package

com.hackinghat.cl-mysql-system

Source

prepare.lisp (file)

Function: process-row MYSQL-RES ROW NUM-FIELDS FIELD-NAMES-AND-TYPES TYPE-MAP
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: repeat-char S N
Package

com.hackinghat.cl-mysql-system

Source

prepare.lisp (file)

Function: set-character-set CSNAME &key DATABASE
Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: single-result-set CONN FN &rest ARGS

MySQL provides a class of functions that just process a single result set. Note that we won’t explicity free the result set because return-or-close will do the cleanup for us.

Package

com.hackinghat.cl-mysql-system

Source

mysql.lisp (file)

Function: thread-alive-p THREAD
Package

com.hackinghat.cl-mysql-system

Source

thread.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.5 Generic functions

Generic Function: acquire CONNECTABLE &optional KEYWORD

Calling aquire on a single connection returns itself, on a connection-pool it will return
the first available connection. Note that the pool implementation of this method could block

Package

com.hackinghat.cl-mysql-system

Source

connection.lisp (file)

Generic Function: add-connection SELF CONN
Package

com.hackinghat.cl-mysql-system

Methods
Method: add-connection (SELF connection-pool) (CONN connection)

Add a connection into the pool.

Source

pool.lisp (file)

Generic Function: args OBJECT
Generic Function: (setf args) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: args (STATEMENT statement)

automatically generated reader method

Source

prepare.lisp (file)

Method: (setf args) NEW-VALUE (STATEMENT statement)

automatically generated writer method

Source

prepare.lisp (file)

Generic Function: assign-bound-argument SELF INDEX VALUE
Package

com.hackinghat.cl-mysql-system

Methods
Method: assign-bound-argument (SELF statement) INDEX VALUE

Take the supplied argument and try to bind it

Source

prepare.lisp (file)

Generic Function: bound-parameter-p SELF INDEX
Package

com.hackinghat.cl-mysql-system

Methods
Method: bound-parameter-p (SELF statement) INDEX

Returns T if the argument at index is bound.

Source

prepare.lisp (file)

Generic Function: bound-unbound-to-string SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: bound-unbound-to-string (SELF statement)

If the user didn’t bind all the arguments bind those unbound ones now.

Source

prepare.lisp (file)

Generic Function: can-aquire-lock SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: can-aquire-lock (SELF connection-pool)
Source

pool.lisp (file)

Generic Function: cl-mysql-error-message CONDITION
Package

com.hackinghat.cl-mysql-system

Methods
Method: cl-mysql-error-message (CONDITION cl-mysql-error)
Source

mysql.lisp (file)

Generic Function: clean-connections SELF ARRAY
Package

com.hackinghat.cl-mysql-system

Methods
Method: clean-connections (SELF connection-pool) ARRAY

Housekeeping to remove null connections from the end of the connections array. Pool should be locked.

Source

pool.lisp (file)

Generic Function: close-statement SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: close-statement (SELF statement)

Close a statement and free all the allocated memory.

Source

prepare.lisp (file)

Generic Function: connect-to-server SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: connect-to-server (SELF connection-pool)

Create a new single connection and add it to the pool.

Source

pool.lisp (file)

Generic Function: connect-upto-minimum SELF N MIN
Package

com.hackinghat.cl-mysql-system

Methods
Method: connect-upto-minimum (SELF connection-pool) N MIN

We use this method to allocate up to the minimum number of connections.
It is called once after initialize-instance and will be called again every time a connection is acquired from the pool.

Source

pool.lisp (file)

Generic Function: consume-unused-results SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: consume-unused-results (SELF connection)

If a client attempts to release a connection without consuming all the results then we take care of that for them. Because we are probably being called from release don’t also auto-release when we reach the last result!

Source

pool.lisp (file)

Generic Function: database OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: database (STATEMENT statement)

automatically generated reader method

Source

prepare.lisp (file)

Method: database (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Generic Function: disconnect-all SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: disconnect-all (SELF connection-pool)

Disconnects all the connections in the pool from the database.

Source

pool.lisp (file)

Generic Function: disconnect-from-server SELF CONN
Package

com.hackinghat.cl-mysql-system

Methods
Method: disconnect-from-server (SELF connection-pool) (CONN connection)

Internal method. Pool should be locked before-hand.

Source

pool.lisp (file)

Method: disconnect-from-server (SELF connection) CONN
Source

pool.lisp (file)

Generic Function: execute SELF &rest ARGS
Package

com.hackinghat.cl-mysql-system

Methods
Method: execute (SELF statement) &rest ARGS
Source

prepare.lisp (file)

Generic Function: flags OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: flags (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Generic Function: fully-bound OBJECT
Generic Function: (setf fully-bound) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: fully-bound (STATEMENT statement)

automatically generated reader method

Source

prepare.lisp (file)

Method: (setf fully-bound) NEW-VALUE (STATEMENT statement)

automatically generated writer method

Source

prepare.lisp (file)

Generic Function: hostname OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: hostname (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Generic Function: mysql-error-errno CONDITION
Package

com.hackinghat.cl-mysql-system

Methods
Method: mysql-error-errno (CONDITION mysql-error)
Source

mysql.lisp (file)

Generic Function: mysql-error-message CONDITION
Package

com.hackinghat.cl-mysql-system

Methods
Method: mysql-error-message (CONDITION mysql-error)
Source

mysql.lisp (file)

Generic Function: nargs OBJECT
Generic Function: (setf nargs) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: nargs (STATEMENT statement)

automatically generated reader method

Source

prepare.lisp (file)

Method: (setf nargs) NEW-VALUE (STATEMENT statement)

automatically generated writer method

Source

prepare.lisp (file)

Generic Function: owner-pool OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: owner-pool (CONNECTION connection)

automatically generated reader method

Source

connection.lisp (file)

Generic Function: param-count SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: param-count (SELF statement)

The number of required parameters that must be bound to this statement.

Source

prepare.lisp (file)

Generic Function: password OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: password (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Generic Function: port OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: port (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Generic Function: release-binding SELF INDEX
Package

com.hackinghat.cl-mysql-system

Methods
Method: release-binding (SELF statement) INDEX

Deallocates the memory that we attached to this binding.

Source

prepare.lisp (file)

Generic Function: remove-connection-from-array SELF ARRAY CONN
Package

com.hackinghat.cl-mysql-system

Methods
Method: remove-connection-from-array (SELF connection-pool) ARRAY CONN

Returns a new array with the given connection object removed (set to NIL) The pool should be locked before this method is called.

Source

pool.lisp (file)

Generic Function: result-data SELF TYPE-MAP
Package

com.hackinghat.cl-mysql-system

Methods
Method: result-data (SELF connection) TYPE-MAP

Internal function that processes a result set and returns all the data. If field-names-and-types is NIL the raw (string) data is returned

Source

connection.lisp (file)

Generic Function: return-or-close SELF CONN
Package

com.hackinghat.cl-mysql-system

Methods
Method: return-or-close (SELF connection-pool) (CONN connection)

Given a pool and a connection, close it if there are more than min-connections or return it to the pool if we have less than or equal to min-connections

Source

pool.lisp (file)

Generic Function: return-to-available SELF &optional CONN
Package

com.hackinghat.cl-mysql-system

Methods
Method: return-to-available (SELF connection-pool) &optional CONN

If the connection is not in the expected state raise an error.

Source

pool.lisp (file)

Method: return-to-available (SELF connection) &optional CONN
Source

pool.lisp (file)

Generic Function: set-field-names-and-types SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: set-field-names-and-types (SELF connection)

Retrieve from a MYSQL_RES a list of cons ((<field name> <field type>)*)

Source

connection.lisp (file)

Generic Function: socket OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: socket (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Generic Function: sqlstate SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: sqlstate (SELF statement)

Returns the ANSI / ODBC SQL status

Source

prepare.lisp (file)

Generic Function: take-first SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: take-first (SELF connection-pool)

Take the first available connection from the pool. If there are none, NIL is returned.

Source

pool.lisp (file)

Generic Function: toggle SELF
Package

com.hackinghat.cl-mysql-system

Methods
Method: toggle (SELF connection)
Source

connection.lisp (file)

Generic Function: use-query-active OBJECT
Generic Function: (setf use-query-active) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: use-query-active (CONNECTION connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf use-query-active) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

connection.lisp (file)

Generic Function: username OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: username (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Generic Function: wait-queue OBJECT
Generic Function: (setf wait-queue) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: wait-queue (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Method: (setf wait-queue) NEW-VALUE (CONNECTION-POOL connection-pool)

automatically generated writer method

Source

pool.lisp (file)

Generic Function: wait-queue-lock OBJECT
Generic Function: (setf wait-queue-lock) NEW-VALUE OBJECT
Package

com.hackinghat.cl-mysql-system

Methods
Method: wait-queue-lock (CONNECTION-POOL connection-pool)

automatically generated reader method

Source

pool.lisp (file)

Method: (setf wait-queue-lock) NEW-VALUE (CONNECTION-POOL connection-pool)

automatically generated writer method

Source

pool.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.6 Classes

Class: character-set-tclass ()
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: connectable ()

The base class of connectability. CL-MYSQL functions operate on a
connectable which is then subclassed into a single connection and a connection pool. Note that the connectable itself has no state.

Package

com.hackinghat.cl-mysql-system

Source

connection.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Class: mysql-bind-tclass ()
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: mysql-field-tclass ()
Package

com.hackinghat.cl-mysql-system

Source

system.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-mysql.asd: The cl-mysql<dot>asd file
cl-mysql/connection.lisp: The cl-mysql/connection<dot>lisp file
cl-mysql/mysql.lisp: The cl-mysql/mysql<dot>lisp file
cl-mysql/package.lisp: The cl-mysql/package<dot>lisp file
cl-mysql/pool.lisp: The cl-mysql/pool<dot>lisp file
cl-mysql/prepare.lisp: The cl-mysql/prepare<dot>lisp file
cl-mysql/system.lisp: The cl-mysql/system<dot>lisp file
cl-mysql/thread.lisp: The cl-mysql/thread<dot>lisp file

F
File, Lisp, cl-mysql.asd: The cl-mysql<dot>asd file
File, Lisp, cl-mysql/connection.lisp: The cl-mysql/connection<dot>lisp file
File, Lisp, cl-mysql/mysql.lisp: The cl-mysql/mysql<dot>lisp file
File, Lisp, cl-mysql/package.lisp: The cl-mysql/package<dot>lisp file
File, Lisp, cl-mysql/pool.lisp: The cl-mysql/pool<dot>lisp file
File, Lisp, cl-mysql/prepare.lisp: The cl-mysql/prepare<dot>lisp file
File, Lisp, cl-mysql/system.lisp: The cl-mysql/system<dot>lisp file
File, Lisp, cl-mysql/thread.lisp: The cl-mysql/thread<dot>lisp file

L
Lisp File, cl-mysql.asd: The cl-mysql<dot>asd file
Lisp File, cl-mysql/connection.lisp: The cl-mysql/connection<dot>lisp file
Lisp File, cl-mysql/mysql.lisp: The cl-mysql/mysql<dot>lisp file
Lisp File, cl-mysql/package.lisp: The cl-mysql/package<dot>lisp file
Lisp File, cl-mysql/pool.lisp: The cl-mysql/pool<dot>lisp file
Lisp File, cl-mysql/prepare.lisp: The cl-mysql/prepare<dot>lisp file
Lisp File, cl-mysql/system.lisp: The cl-mysql/system<dot>lisp file
Lisp File, cl-mysql/thread.lisp: The cl-mysql/thread<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   W  
Index Entry  Section

%
%set-int-option: Internal functions
%set-string-option: Internal functions

(
(setf args): Internal generic functions
(setf args): Internal generic functions
(setf available-connections): Exported generic functions
(setf available-connections): Exported generic functions
(setf bound-map): Exported generic functions
(setf bound-map): Exported generic functions
(setf connections): Exported generic functions
(setf connections): Exported generic functions
(setf fully-bound): Internal generic functions
(setf fully-bound): Internal generic functions
(setf in-use): Exported generic functions
(setf in-use): Exported generic functions
(setf max-connections): Exported generic functions
(setf max-connections): Exported generic functions
(setf min-connections): Exported generic functions
(setf min-connections): Exported generic functions
(setf nargs): Internal generic functions
(setf nargs): Internal generic functions
(setf pointer): Exported generic functions
(setf pointer): Exported generic functions
(setf pool-lock): Exported generic functions
(setf pool-lock): Exported generic functions
(setf result-set): Exported generic functions
(setf result-set): Exported generic functions
(setf result-set-fields): Exported generic functions
(setf result-set-fields): Exported generic functions
(setf use-query-active): Internal generic functions
(setf use-query-active): Internal generic functions
(setf wait-queue): Internal generic functions
(setf wait-queue): Internal generic functions
(setf wait-queue-lock): Internal generic functions
(setf wait-queue-lock): Internal generic functions

A
acquire: Internal generic functions
add-connection: Internal generic functions
add-connection: Internal generic functions
aquire: Exported generic functions
aquire: Exported generic functions
aquire: Exported generic functions
aquire: Exported generic functions
args: Internal generic functions
args: Internal generic functions
assign-bound-argument: Internal generic functions
assign-bound-argument: Internal generic functions
available: Exported generic functions
available: Exported generic functions
available-connections: Exported generic functions
available-connections: Exported generic functions

B
bind: Exported generic functions
bind: Exported generic functions
bind-arg: Exported generic functions
bind-arg: Exported generic functions
bound-map: Exported generic functions
bound-map: Exported generic functions
bound-parameter-p: Internal generic functions
bound-parameter-p: Internal generic functions
bound-unbound-to-string: Internal generic functions
bound-unbound-to-string: Internal generic functions

C
can-aquire: Exported generic functions
can-aquire: Exported generic functions
can-aquire-lock: Internal generic functions
can-aquire-lock: Internal generic functions
cffi-utf8-length: Exported functions
cl-mysql-error-message: Internal generic functions
cl-mysql-error-message: Internal generic functions
clean-connections: Internal generic functions
clean-connections: Internal generic functions
client-version: Exported functions
close-statement: Internal generic functions
close-statement: Internal generic functions
configure-bindings: Exported generic functions
configure-bindings: Exported generic functions
connect: Exported functions
connect-to-server: Internal generic functions
connect-to-server: Internal generic functions
connect-upto-minimum: Internal generic functions
connect-upto-minimum: Internal generic functions
connected: Exported generic functions
connected: Exported generic functions
connection-equal: Exported generic functions
connection-equal: Exported generic functions
connection-equal: Exported generic functions
connections: Exported generic functions
connections: Exported generic functions
consume-unused-results: Internal generic functions
consume-unused-results: Internal generic functions
contains: Exported generic functions
contains: Exported generic functions
count-connections: Exported generic functions
count-connections: Exported generic functions

D
database: Internal generic functions
database: Internal generic functions
database: Internal generic functions
decode-version: Internal functions
defmysqlfun: Internal macros
disconnect: Exported functions
disconnect-all: Internal generic functions
disconnect-all: Internal generic functions
disconnect-from-server: Internal generic functions
disconnect-from-server: Internal generic functions
disconnect-from-server: Internal generic functions

E
error-if-non-zero: Internal functions
error-if-null: Internal functions
error-if-null-with-fields: Internal functions
error-if-set: Internal functions
escape-string: Exported functions
execute: Internal generic functions
execute: Internal generic functions
extract-field: Exported functions

F
flags: Internal generic functions
flags: Internal generic functions
force-kill: Internal functions
fully-bound: Internal generic functions
fully-bound: Internal generic functions
Function, %set-int-option: Internal functions
Function, %set-string-option: Internal functions
Function, cffi-utf8-length: Exported functions
Function, client-version: Exported functions
Function, connect: Exported functions
Function, decode-version: Internal functions
Function, disconnect: Exported functions
Function, error-if-non-zero: Internal functions
Function, error-if-null: Internal functions
Function, error-if-null-with-fields: Internal functions
Function, error-if-set: Internal functions
Function, escape-string: Exported functions
Function, extract-field: Exported functions
Function, force-kill: Internal functions
Function, get-character-set-info: Internal functions
Function, get-field: Internal functions
Function, list-dbs: Exported functions
Function, list-fields: Exported functions
Function, list-processes: Exported functions
Function, list-tables: Exported functions
Function, make-lock: Exported functions
Function, make-wait-resource: Internal functions
Function, mysql-affected-rows: Internal functions
Function, mysql-character-set-name: Internal functions
Function, mysql-close: Internal functions
Function, mysql-errno: Internal functions
Function, mysql-error: Exported functions
Function, mysql-escape-string: Internal functions
Function, mysql-fetch-field: Internal functions
Function, mysql-fetch-fields: Internal functions
Function, mysql-fetch-lengths: Internal functions
Function, mysql-fetch-row: Internal functions
Function, mysql-field-count: Internal functions
Function, mysql-free-result: Internal functions
Function, mysql-get-character-set-info: Internal functions
Function, mysql-get-client-version: Internal functions
Function, mysql-get-server-version: Internal functions
Function, mysql-init: Internal functions
Function, mysql-list-dbs: Internal functions
Function, mysql-list-fields: Internal functions
Function, mysql-list-processes: Internal functions
Function, mysql-list-tables: Internal functions
Function, mysql-next-result: Internal functions
Function, mysql-num-fields: Internal functions
Function, mysql-num-rows: Internal functions
Function, mysql-options: Internal functions
Function, mysql-ping: Internal functions
Function, mysql-query: Internal functions
Function, mysql-real-connect: Internal functions
Function, mysql-real-escape-string: Internal functions
Function, mysql-select-db: Internal functions
Function, mysql-set-character-set: Internal functions
Function, mysql-stmt-affected-rows: Internal functions
Function, mysql-stmt-bind-param: Internal functions
Function, mysql-stmt-close: Internal functions
Function, mysql-stmt-errno: Internal functions
Function, mysql-stmt-error: Internal functions
Function, mysql-stmt-execute: Internal functions
Function, mysql-stmt-init: Internal functions
Function, mysql-stmt-param-count: Internal functions
Function, mysql-stmt-prepare: Internal functions
Function, mysql-stmt-sqlstate: Internal functions
Function, mysql-store-result: Internal functions
Function, mysql-use-result: Internal functions
Function, nth-row: Exported functions
Function, option: Exported functions
Function, ping: Exported functions
Function, pool-notify: Internal functions
Function, pool-wait: Internal functions
Function, prepare: Internal functions
Function, process-row: Internal functions
Function, query: Exported functions
Function, repeat-char: Internal functions
Function, server-version: Exported functions
Function, set-character-set: Internal functions
Function, single-result-set: Internal functions
Function, start-thread-in-nsecs: Exported functions
Function, string-to-date: Exported functions
Function, string-to-float: Exported functions
Function, string-to-integer: Exported functions
Function, string-to-ratio: Exported functions
Function, string-to-seconds: Exported functions
Function, string-to-universal-time: Exported functions
Function, thread-alive-p: Internal functions
Function, use: Exported functions
Function, wait-on-threads: Exported functions

G
Generic Function, (setf args): Internal generic functions
Generic Function, (setf available-connections): Exported generic functions
Generic Function, (setf bound-map): Exported generic functions
Generic Function, (setf connections): Exported generic functions
Generic Function, (setf fully-bound): Internal generic functions
Generic Function, (setf in-use): Exported generic functions
Generic Function, (setf max-connections): Exported generic functions
Generic Function, (setf min-connections): Exported generic functions
Generic Function, (setf nargs): Internal generic functions
Generic Function, (setf pointer): Exported generic functions
Generic Function, (setf pool-lock): Exported generic functions
Generic Function, (setf result-set): Exported generic functions
Generic Function, (setf result-set-fields): Exported generic functions
Generic Function, (setf use-query-active): Internal generic functions
Generic Function, (setf wait-queue): Internal generic functions
Generic Function, (setf wait-queue-lock): Internal generic functions
Generic Function, acquire: Internal generic functions
Generic Function, add-connection: Internal generic functions
Generic Function, aquire: Exported generic functions
Generic Function, args: Internal generic functions
Generic Function, assign-bound-argument: Internal generic functions
Generic Function, available: Exported generic functions
Generic Function, available-connections: Exported generic functions
Generic Function, bind: Exported generic functions
Generic Function, bind-arg: Exported generic functions
Generic Function, bound-map: Exported generic functions
Generic Function, bound-parameter-p: Internal generic functions
Generic Function, bound-unbound-to-string: Internal generic functions
Generic Function, can-aquire: Exported generic functions
Generic Function, can-aquire-lock: Internal generic functions
Generic Function, cl-mysql-error-message: Internal generic functions
Generic Function, clean-connections: Internal generic functions
Generic Function, close-statement: Internal generic functions
Generic Function, configure-bindings: Exported generic functions
Generic Function, connect-to-server: Internal generic functions
Generic Function, connect-upto-minimum: Internal generic functions
Generic Function, connected: Exported generic functions
Generic Function, connection-equal: Exported generic functions
Generic Function, connections: Exported generic functions
Generic Function, consume-unused-results: Internal generic functions
Generic Function, contains: Exported generic functions
Generic Function, count-connections: Exported generic functions
Generic Function, database: Internal generic functions
Generic Function, disconnect-all: Internal generic functions
Generic Function, disconnect-from-server: Internal generic functions
Generic Function, execute: Internal generic functions
Generic Function, flags: Internal generic functions
Generic Function, fully-bound: Internal generic functions
Generic Function, hostname: Internal generic functions
Generic Function, in-use: Exported generic functions
Generic Function, max-connections: Exported generic functions
Generic Function, min-connections: Exported generic functions
Generic Function, mysql-error-errno: Internal generic functions
Generic Function, mysql-error-message: Internal generic functions
Generic Function, nargs: Internal generic functions
Generic Function, next-index: Exported generic functions
Generic Function, next-result-set: Exported generic functions
Generic Function, next-row: Exported generic functions
Generic Function, owner-pool: Internal generic functions
Generic Function, param-count: Internal generic functions
Generic Function, password: Internal generic functions
Generic Function, pointer: Exported generic functions
Generic Function, pool-lock: Exported generic functions
Generic Function, port: Internal generic functions
Generic Function, process-result-set: Exported generic functions
Generic Function, release: Exported generic functions
Generic Function, release-binding: Internal generic functions
Generic Function, remove-connection-from-array: Internal generic functions
Generic Function, result-data: Internal generic functions
Generic Function, result-set: Exported generic functions
Generic Function, result-set-fields: Exported generic functions
Generic Function, return-or-close: Internal generic functions
Generic Function, return-to-available: Internal generic functions
Generic Function, set-field-names-and-types: Internal generic functions
Generic Function, socket: Internal generic functions
Generic Function, sqlstate: Internal generic functions
Generic Function, take-first: Internal generic functions
Generic Function, toggle: Internal generic functions
Generic Function, use-query-active: Internal generic functions
Generic Function, username: Internal generic functions
Generic Function, wait-queue: Internal generic functions
Generic Function, wait-queue-lock: Internal generic functions
get-character-set-info: Internal functions
get-field: Internal functions

H
hostname: Internal generic functions
hostname: Internal generic functions

I
in-use: Exported generic functions
in-use: Exported generic functions

L
list-dbs: Exported functions
list-fields: Exported functions
list-processes: Exported functions
list-tables: Exported functions

M
Macro, defmysqlfun: Internal macros
Macro, with-connection: Internal macros
Macro, with-lock: Exported macros
Macro, with-rows: Exported macros
make-lock: Exported functions
make-wait-resource: Internal functions
max-connections: Exported generic functions
max-connections: Exported generic functions
Method, (setf args): Internal generic functions
Method, (setf available-connections): Exported generic functions
Method, (setf bound-map): Exported generic functions
Method, (setf connections): Exported generic functions
Method, (setf fully-bound): Internal generic functions
Method, (setf in-use): Exported generic functions
Method, (setf max-connections): Exported generic functions
Method, (setf min-connections): Exported generic functions
Method, (setf nargs): Internal generic functions
Method, (setf pointer): Exported generic functions
Method, (setf pool-lock): Exported generic functions
Method, (setf result-set): Exported generic functions
Method, (setf result-set-fields): Exported generic functions
Method, (setf use-query-active): Internal generic functions
Method, (setf wait-queue): Internal generic functions
Method, (setf wait-queue-lock): Internal generic functions
Method, add-connection: Internal generic functions
Method, aquire: Exported generic functions
Method, aquire: Exported generic functions
Method, aquire: Exported generic functions
Method, args: Internal generic functions
Method, assign-bound-argument: Internal generic functions
Method, available: Exported generic functions
Method, available-connections: Exported generic functions
Method, bind: Exported generic functions
Method, bind-arg: Exported generic functions
Method, bound-map: Exported generic functions
Method, bound-parameter-p: Internal generic functions
Method, bound-unbound-to-string: Internal generic functions
Method, can-aquire: Exported generic functions
Method, can-aquire-lock: Internal generic functions
Method, cl-mysql-error-message: Internal generic functions
Method, clean-connections: Internal generic functions
Method, close-statement: Internal generic functions
Method, configure-bindings: Exported generic functions
Method, connect-to-server: Internal generic functions
Method, connect-upto-minimum: Internal generic functions
Method, connected: Exported generic functions
Method, connection-equal: Exported generic functions
Method, connection-equal: Exported generic functions
Method, connections: Exported generic functions
Method, consume-unused-results: Internal generic functions
Method, contains: Exported generic functions
Method, count-connections: Exported generic functions
Method, database: Internal generic functions
Method, database: Internal generic functions
Method, disconnect-all: Internal generic functions
Method, disconnect-from-server: Internal generic functions
Method, disconnect-from-server: Internal generic functions
Method, execute: Internal generic functions
Method, flags: Internal generic functions
Method, fully-bound: Internal generic functions
Method, hostname: Internal generic functions
Method, in-use: Exported generic functions
Method, max-connections: Exported generic functions
Method, min-connections: Exported generic functions
Method, mysql-error-errno: Internal generic functions
Method, mysql-error-message: Internal generic functions
Method, nargs: Internal generic functions
Method, next-index: Exported generic functions
Method, next-result-set: Exported generic functions
Method, next-row: Exported generic functions
Method, owner-pool: Internal generic functions
Method, param-count: Internal generic functions
Method, password: Internal generic functions
Method, pointer: Exported generic functions
Method, pointer: Exported generic functions
Method, pool-lock: Exported generic functions
Method, port: Internal generic functions
Method, process-result-set: Exported generic functions
Method, release: Exported generic functions
Method, release: Exported generic functions
Method, release-binding: Internal generic functions
Method, remove-connection-from-array: Internal generic functions
Method, result-data: Internal generic functions
Method, result-set: Exported generic functions
Method, result-set-fields: Exported generic functions
Method, return-or-close: Internal generic functions
Method, return-to-available: Internal generic functions
Method, return-to-available: Internal generic functions
Method, set-field-names-and-types: Internal generic functions
Method, socket: Internal generic functions
Method, sqlstate: Internal generic functions
Method, take-first: Internal generic functions
Method, toggle: Internal generic functions
Method, use-query-active: Internal generic functions
Method, username: Internal generic functions
Method, wait-queue: Internal generic functions
Method, wait-queue-lock: Internal generic functions
min-connections: Exported generic functions
min-connections: Exported generic functions
mysql-affected-rows: Internal functions
mysql-character-set-name: Internal functions
mysql-close: Internal functions
mysql-errno: Internal functions
mysql-error: Exported functions
mysql-error-errno: Internal generic functions
mysql-error-errno: Internal generic functions
mysql-error-message: Internal generic functions
mysql-error-message: Internal generic functions
mysql-escape-string: Internal functions
mysql-fetch-field: Internal functions
mysql-fetch-fields: Internal functions
mysql-fetch-lengths: Internal functions
mysql-fetch-row: Internal functions
mysql-field-count: Internal functions
mysql-free-result: Internal functions
mysql-get-character-set-info: Internal functions
mysql-get-client-version: Internal functions
mysql-get-server-version: Internal functions
mysql-init: Internal functions
mysql-list-dbs: Internal functions
mysql-list-fields: Internal functions
mysql-list-processes: Internal functions
mysql-list-tables: Internal functions
mysql-next-result: Internal functions
mysql-num-fields: Internal functions
mysql-num-rows: Internal functions
mysql-options: Internal functions
mysql-ping: Internal functions
mysql-query: Internal functions
mysql-real-connect: Internal functions
mysql-real-escape-string: Internal functions
mysql-select-db: Internal functions
mysql-set-character-set: Internal functions
mysql-stmt-affected-rows: Internal functions
mysql-stmt-bind-param: Internal functions
mysql-stmt-close: Internal functions
mysql-stmt-errno: Internal functions
mysql-stmt-error: Internal functions
mysql-stmt-execute: Internal functions
mysql-stmt-init: Internal functions
mysql-stmt-param-count: Internal functions
mysql-stmt-prepare: Internal functions
mysql-stmt-sqlstate: Internal functions
mysql-store-result: Internal functions
mysql-use-result: Internal functions

N
nargs: Internal generic functions
nargs: Internal generic functions
next-index: Exported generic functions
next-index: Exported generic functions
next-result-set: Exported generic functions
next-result-set: Exported generic functions
next-row: Exported generic functions
next-row: Exported generic functions
nth-row: Exported functions

O
option: Exported functions
owner-pool: Internal generic functions
owner-pool: Internal generic functions

P
param-count: Internal generic functions
param-count: Internal generic functions
password: Internal generic functions
password: Internal generic functions
ping: Exported functions
pointer: Exported generic functions
pointer: Exported generic functions
pointer: Exported generic functions
pool-lock: Exported generic functions
pool-lock: Exported generic functions
pool-notify: Internal functions
pool-wait: Internal functions
port: Internal generic functions
port: Internal generic functions
prepare: Internal functions
process-result-set: Exported generic functions
process-result-set: Exported generic functions
process-row: Internal functions

Q
query: Exported functions

R
release: Exported generic functions
release: Exported generic functions
release: Exported generic functions
release-binding: Internal generic functions
release-binding: Internal generic functions
remove-connection-from-array: Internal generic functions
remove-connection-from-array: Internal generic functions
repeat-char: Internal functions
result-data: Internal generic functions
result-data: Internal generic functions
result-set: Exported generic functions
result-set: Exported generic functions
result-set-fields: Exported generic functions
result-set-fields: Exported generic functions
return-or-close: Internal generic functions
return-or-close: Internal generic functions
return-to-available: Internal generic functions
return-to-available: Internal generic functions
return-to-available: Internal generic functions

S
server-version: Exported functions
set-character-set: Internal functions
set-field-names-and-types: Internal generic functions
set-field-names-and-types: Internal generic functions
single-result-set: Internal functions
socket: Internal generic functions
socket: Internal generic functions
sqlstate: Internal generic functions
sqlstate: Internal generic functions
start-thread-in-nsecs: Exported functions
string-to-date: Exported functions
string-to-float: Exported functions
string-to-integer: Exported functions
string-to-ratio: Exported functions
string-to-seconds: Exported functions
string-to-universal-time: Exported functions

T
take-first: Internal generic functions
take-first: Internal generic functions
thread-alive-p: Internal functions
toggle: Internal generic functions
toggle: Internal generic functions

U
use: Exported functions
use-query-active: Internal generic functions
use-query-active: Internal generic functions
username: Internal generic functions
username: Internal generic functions

W
wait-on-threads: Exported functions
wait-queue: Internal generic functions
wait-queue: Internal generic functions
wait-queue-lock: Internal generic functions
wait-queue-lock: Internal generic functions
with-connection: Internal macros
with-lock: Exported macros
with-rows: Exported macros

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
A   B   C   D   E   F   H   I   M   N   O   P   R   S   U   W  
Index Entry  Section

*
*binary-types*: Internal special variables
*debug*: Internal special variables
*default-sequence-length*: Internal special variables
*generate-alt-fns*: Internal special variables
*last-database*: Exported special variables
*mysql-dev-api-url*: Internal special variables
*sleep-period*: Internal constants
*stmt-ctype-map*: Internal special variables
*type-map*: Exported special variables

+
+cant-read-charset+: Internal constants
+client-compress+: Exported constants
+client-found-rows+: Exported constants
+client-ignore-sigpipe+: Exported constants
+client-ignore-space+: Exported constants
+client-interactive+: Exported constants
+client-local-files+: Exported constants
+client-multi-results+: Exported constants
+client-multi-statements+: Exported constants
+client-no-schema+: Exported constants
+client-remember-options+: Exported constants
+client-ssl+: Exported constants
+commands-out-of-sync+: Internal constants
+conn-host-error+: Internal constants
+conn-unknow-protocol+: Internal constants
+connection-error+: Internal constants
+data-truncated+: Internal constants
+embedded-connection+: Internal constants
+error-first+: Internal constants
+fetch-canceled+: Internal constants
+field-auto-increment+: Internal constants
+field-binary+: Internal constants
+field-blob+: Internal constants
+field-enum+: Internal constants
+field-multiple-key+: Internal constants
+field-no-default+: Internal constants
+field-not-null+: Internal constants
+field-num+: Internal constants
+field-primary-key+: Internal constants
+field-set+: Internal constants
+field-timestamp+: Internal constants
+field-unique-key+: Internal constants
+field-unsigned+: Internal constants
+field-zerofill+: Internal constants
+invalid-buffer-use+: Internal constants
+invalid-conn-handle+: Internal constants
+invalid-parameter-no+: Internal constants
+ipsock-error+: Internal constants
+localhost-connection+: Internal constants
+malformed-packet+: Internal constants
+namedpipe-connection+: Internal constants
+namedpipeopen-error+: Internal constants
+namedpipesetstate-error+: Internal constants
+namedpipewait-error+: Internal constants
+net-packet-too-large+: Internal constants
+no-data+: Internal constants
+no-parameters-exists+: Internal constants
+no-prepare-stmt+: Internal constants
+no-result-set+: Internal constants
+no-stmt-metadata+: Internal constants
+not-implemented+: Internal constants
+null-pointer+: Internal constants
+out-of-memory+: Internal constants
+params-not-bound+: Internal constants
+probe-master-connect+: Internal constants
+probe-slave-connect+: Internal constants
+probe-slave-hosts+: Internal constants
+probe-slave-status+: Internal constants
+secure-auth+: Internal constants
+server-gone-error+: Internal constants
+server-handshake-err+: Internal constants
+server-lost+: Internal constants
+server-lost-extended+: Internal constants
+shared-memory-connect-abandoned-error+: Internal constants
+shared-memory-connect-answer-error+: Internal constants
+shared-memory-connect-file-map-error+: Internal constants
+shared-memory-connect-map-error+: Internal constants
+shared-memory-connect-request-error+: Internal constants
+shared-memory-connect-set-error+: Internal constants
+shared-memory-connection+: Internal constants
+shared-memory-event-error+: Internal constants
+shared-memory-file-map-error+: Internal constants
+shared-memory-map-error+: Internal constants
+socket-create-error+: Internal constants
+ssl-connection-error+: Internal constants
+tcp-connection+: Internal constants
+unknown-error+: Internal constants
+unknown-host+: Internal constants
+unsupported-param-type+: Internal constants
+version-error+: Internal constants
+wrong-host-info+: Internal constants
+wrong-license+: Internal constants

A
args: Exported classes
available-connections: Exported classes

B
bound-map: Exported classes

C
connections: Exported classes
Constant, *sleep-period*: Internal constants
Constant, +cant-read-charset+: Internal constants
Constant, +client-compress+: Exported constants
Constant, +client-found-rows+: Exported constants
Constant, +client-ignore-sigpipe+: Exported constants
Constant, +client-ignore-space+: Exported constants
Constant, +client-interactive+: Exported constants
Constant, +client-local-files+: Exported constants
Constant, +client-multi-results+: Exported constants
Constant, +client-multi-statements+: Exported constants
Constant, +client-no-schema+: Exported constants
Constant, +client-remember-options+: Exported constants
Constant, +client-ssl+: Exported constants
Constant, +commands-out-of-sync+: Internal constants
Constant, +conn-host-error+: Internal constants
Constant, +conn-unknow-protocol+: Internal constants
Constant, +connection-error+: Internal constants
Constant, +data-truncated+: Internal constants
Constant, +embedded-connection+: Internal constants
Constant, +error-first+: Internal constants
Constant, +fetch-canceled+: Internal constants
Constant, +field-auto-increment+: Internal constants
Constant, +field-binary+: Internal constants
Constant, +field-blob+: Internal constants
Constant, +field-enum+: Internal constants
Constant, +field-multiple-key+: Internal constants
Constant, +field-no-default+: Internal constants
Constant, +field-not-null+: Internal constants
Constant, +field-num+: Internal constants
Constant, +field-primary-key+: Internal constants
Constant, +field-set+: Internal constants
Constant, +field-timestamp+: Internal constants
Constant, +field-unique-key+: Internal constants
Constant, +field-unsigned+: Internal constants
Constant, +field-zerofill+: Internal constants
Constant, +invalid-buffer-use+: Internal constants
Constant, +invalid-conn-handle+: Internal constants
Constant, +invalid-parameter-no+: Internal constants
Constant, +ipsock-error+: Internal constants
Constant, +localhost-connection+: Internal constants
Constant, +malformed-packet+: Internal constants
Constant, +namedpipe-connection+: Internal constants
Constant, +namedpipeopen-error+: Internal constants
Constant, +namedpipesetstate-error+: Internal constants
Constant, +namedpipewait-error+: Internal constants
Constant, +net-packet-too-large+: Internal constants
Constant, +no-data+: Internal constants
Constant, +no-parameters-exists+: Internal constants
Constant, +no-prepare-stmt+: Internal constants
Constant, +no-result-set+: Internal constants
Constant, +no-stmt-metadata+: Internal constants
Constant, +not-implemented+: Internal constants
Constant, +null-pointer+: Internal constants
Constant, +out-of-memory+: Internal constants
Constant, +params-not-bound+: Internal constants
Constant, +probe-master-connect+: Internal constants
Constant, +probe-slave-connect+: Internal constants
Constant, +probe-slave-hosts+: Internal constants
Constant, +probe-slave-status+: Internal constants
Constant, +secure-auth+: Internal constants
Constant, +server-gone-error+: Internal constants
Constant, +server-handshake-err+: Internal constants
Constant, +server-lost+: Internal constants
Constant, +server-lost-extended+: Internal constants
Constant, +shared-memory-connect-abandoned-error+: Internal constants
Constant, +shared-memory-connect-answer-error+: Internal constants
Constant, +shared-memory-connect-file-map-error+: Internal constants
Constant, +shared-memory-connect-map-error+: Internal constants
Constant, +shared-memory-connect-request-error+: Internal constants
Constant, +shared-memory-connect-set-error+: Internal constants
Constant, +shared-memory-connection+: Internal constants
Constant, +shared-memory-event-error+: Internal constants
Constant, +shared-memory-file-map-error+: Internal constants
Constant, +shared-memory-map-error+: Internal constants
Constant, +socket-create-error+: Internal constants
Constant, +ssl-connection-error+: Internal constants
Constant, +tcp-connection+: Internal constants
Constant, +unknown-error+: Internal constants
Constant, +unknown-host+: Internal constants
Constant, +unsupported-param-type+: Internal constants
Constant, +version-error+: Internal constants
Constant, +wrong-host-info+: Internal constants
Constant, +wrong-license+: Internal constants

D
database: Exported classes
database: Exported classes

E
errno: Exported conditions

F
flags: Exported classes
fully-bound: Exported classes

H
hostname: Exported classes

I
in-use: Exported classes

M
max-connections: Exported classes
message: Exported conditions
message: Exported conditions
min-connections: Exported classes

N
nargs: Exported classes

O
owner-pool: Exported classes

P
password: Exported classes
pointer: Exported classes
pointer: Exported classes
pool-lock: Exported classes
port: Exported classes

R
result-set: Exported classes
result-set-fields: Exported classes

S
Slot, args: Exported classes
Slot, available-connections: Exported classes
Slot, bound-map: Exported classes
Slot, connections: Exported classes
Slot, database: Exported classes
Slot, database: Exported classes
Slot, errno: Exported conditions
Slot, flags: Exported classes
Slot, fully-bound: Exported classes
Slot, hostname: Exported classes
Slot, in-use: Exported classes
Slot, max-connections: Exported classes
Slot, message: Exported conditions
Slot, message: Exported conditions
Slot, min-connections: Exported classes
Slot, nargs: Exported classes
Slot, owner-pool: Exported classes
Slot, password: Exported classes
Slot, pointer: Exported classes
Slot, pointer: Exported classes
Slot, pool-lock: Exported classes
Slot, port: Exported classes
Slot, result-set: Exported classes
Slot, result-set-fields: Exported classes
Slot, socket: Exported classes
Slot, use-query-active: Exported classes
Slot, username: Exported classes
Slot, wait-queue: Exported classes
Slot, wait-queue-lock: Exported classes
socket: Exported classes
Special Variable, *binary-types*: Internal special variables
Special Variable, *debug*: Internal special variables
Special Variable, *default-sequence-length*: Internal special variables
Special Variable, *generate-alt-fns*: Internal special variables
Special Variable, *last-database*: Exported special variables
Special Variable, *mysql-dev-api-url*: Internal special variables
Special Variable, *stmt-ctype-map*: Internal special variables
Special Variable, *type-map*: Exported special variables

U
use-query-active: Exported classes
username: Exported classes

W
wait-queue: Exported classes
wait-queue-lock: Exported classes

Jump to:   *   +  
A   B   C   D   E   F   H   I   M   N   O   P   R   S   U   W  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   M   P   S  
Index Entry  Section

C
character-set-tclass: Internal classes
cl-mysql: The cl-mysql system
cl-mysql-error: Exported conditions
Class, character-set-tclass: Internal classes
Class, connectable: Internal classes
Class, connection: Exported classes
Class, connection-pool: Exported classes
Class, mysql-bind-tclass: Internal classes
Class, mysql-field-tclass: Internal classes
Class, statement: Exported classes
com.hackinghat.cl-mysql: The com<dot>hackinghat<dot>cl-mysql package
com.hackinghat.cl-mysql-system: The com<dot>hackinghat<dot>cl-mysql-system package
Condition, cl-mysql-error: Exported conditions
Condition, mysql-error: Exported conditions
connectable: Internal classes
connection: Exported classes
connection-pool: Exported classes

M
mysql-bind-tclass: Internal classes
mysql-error: Exported conditions
mysql-field-tclass: Internal classes

P
Package, com.hackinghat.cl-mysql: The com<dot>hackinghat<dot>cl-mysql package
Package, com.hackinghat.cl-mysql-system: The com<dot>hackinghat<dot>cl-mysql-system package

S
statement: Exported classes
System, cl-mysql: The cl-mysql system

Jump to:   C   M   P   S