The cl-mssql Reference Manual

Table of Contents

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

The cl-mssql Reference Manual

This is the cl-mssql Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:51:00 2018 GMT+0.


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

1 Introduction

cl-mssql

A Common Lisp library for interacting with MS SQL Server databases.

Dependencies:

External:

Quicklisp-able:

License: LLGPL - for details, see COPYING


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

2 Systems

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


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

2.1 mssql

Dependencies
Source

mssql.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 mssql/src

Parent

mssql (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 mssql.asd

Location

mssql.asd

Systems

mssql (system)


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

4.1.2 mssql/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

mssql


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

4.1.3 mssql/src/mssql.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/mssql.lisp

Internal Definitions

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

4.1.4 mssql/src/connection.lisp

Dependency

mssql.lisp (file)

Parent

src (module)

Location

src/connection.lisp

Exported Definitions
Internal Definitions

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

4.1.5 mssql/src/query.lisp

Dependency

connection.lisp (file)

Parent

src (module)

Location

src/query.lisp

Exported Definitions

query (function)

Internal Definitions

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

4.1.6 mssql/src/execute.lisp

Dependency

connection.lisp (file)

Parent

src (module)

Location

src/execute.lisp

Exported Definitions
Internal Definitions

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

4.1.7 mssql/src/remote.lisp

Dependency

query.lisp (file)

Parent

src (module)

Location

src/remote.lisp

Exported Definitions

call-remote-procedure (function)

Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 mssql

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: *database*
Package

mssql

Source

connection.lisp (file)


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

6.1.2 Macros

Macro: with-connection (DATABASE USER PASSWORD HOST &key EXTERNAL-FORMAT) &body BODY

Connects to ‘database‘ on ‘host‘ using ‘user‘ and ‘password‘.
Inside of ‘body‘, the connection is bound to the special variable *database*

Package

mssql

Source

connection.lisp (file)

Macro: with-transaction (&key CONNECTION NAME) &body BODY

Execute the body within a database transaction, committing when the body exits normally, and aborting otherwise. An optional name can be given to the transaction, which can be used to force a commit or abort before the body unwinds.

Package

mssql

Source

execute.lisp (file)


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

6.1.3 Functions

Function: call-remote-procedure NAME &rest PARAMS
Package

mssql

Source

remote.lisp (file)

Function: commit-transaction TRANSACTION

Immediately commit an open transaction.

Package

mssql

Source

execute.lisp (file)

Function: connect DATABASE USER PASSWORD HOST &key EXTERNAL-FORMAT

Connects to ‘database‘ on ‘host‘ using ‘user‘ and ‘password‘. The external format defaults to :utf-8.

A CLOS object of type ’database-connection is returned.

Package

mssql

Source

connection.lisp (file)

Function: connect-toplevel DATABASE USER PASSWORD HOST &key EXTERNAL-FORMAT

Connects to ‘database‘ on ‘host‘ using ‘user‘ and ‘password‘. The connection is bound to the special variable *database*

Package

mssql

Source

connection.lisp (file)

Function: connected-p CONNECTION

Is ‘connection‘ available?

Package

mssql

Source

connection.lisp (file)

Function: disconnect CONNECTION

Disconnect from ‘connection‘.

Package

mssql

Source

connection.lisp (file)

Function: disconnect-toplevel ()

Disconnects from *database*

Package

mssql

Source

connection.lisp (file)

Function: execute QUERY &key CONNECTION
Package

mssql

Source

execute.lisp (file)

Function: query QUERY &key CONNECTION FORMAT

Sends in ‘query‘ to ‘connection‘, return the result as ‘format‘. Format can be any keyword found in *query-formats*.

Package

mssql

Source

query.lisp (file)

Function: rollback-transaction TRANSACTION

Immediately rollback an open transaction.

Package

mssql

Source

execute.lisp (file)


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

6.1.4 Classes

Class: database-connection ()
Package

mssql

Source

connection.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

object-register (method)

Direct slots
Slot: dbproc
Initargs

:dbproc

Slot: external-format
Initargs

:external-format

Initform

:utf-8


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

6.2 Internal definitions


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

6.2.1 Constants

Constant: +fail+
Package

mssql

Source

mssql.lisp (file)

Constant: +int_cancel+
Package

mssql

Source

mssql.lisp (file)

Constant: +no-more-results+
Package

mssql

Source

query.lisp (file)

Constant: +no-more-rows+
Package

mssql

Source

query.lisp (file)

Constant: +numeric-buf-sz+
Package

mssql

Source

query.lisp (file)


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

6.2.2 Special variables

Special Variable: *error-message-list*
Package

mssql

Source

mssql.lisp (file)

Special Variable: *query-formats*

Formats available for returning from QUERY.

Package

mssql

Source

query.lisp (file)


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

6.2.3 Macros

Macro: define-row-reader NAME (COLLUMN VALUE) &body BODY
Package

mssql

Source

query.lisp (file)

Macro: define-sybdb-function (FOREIGN-NAME LISP-NAME &optional CHECK-MODE ERROR-MESSAGE) RETURN-TYPE &body ARGS
Package

mssql

Source

mssql.lisp (file)


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

6.2.4 Functions

Function: %%dbcancel DBPROC
Package

mssql

Source

connection.lisp (file)

Function: %%dbcmd DBPROC CMDSTRING
Package

mssql

Source

connection.lisp (file)

Function: %%dblogin ()
Package

mssql

Source

connection.lisp (file)

Function: %%dbsetlname LOGIN VALUE WHICH
Package

mssql

Source

connection.lisp (file)

Function: %%dbsqlexec DBPROC
Package

mssql

Source

connection.lisp (file)

Function: %%tdsdbopen LOGIN SERVER MSDBLIB
Package

mssql

Source

connection.lisp (file)

Function: %dbcancel DBPROC
Package

mssql

Source

connection.lisp (file)

Function: %dbclose DBPROC
Package

mssql

Source

connection.lisp (file)

Function: %dbcmd DBPROC CMDSTRING
Package

mssql

Source

connection.lisp (file)

Function: %dbcolname DBPROC COLNUM
Package

mssql

Source

query.lisp (file)

Function: %dbcoltype DBPROC COLNUM
Package

mssql

Source

query.lisp (file)

Function: %dbconvert DBPROC SRCTYPE SRC SRCLEN DESTTYPE DEST DESTLEN
Package

mssql

Source

query.lisp (file)

Function: %dbdata DBPROC COLUMN
Package

mssql

Source

query.lisp (file)

Function: %dbdatlen DBPROC COLUMN
Package

mssql

Source

query.lisp (file)

Function: %dberrhandle HANDLER
Package

mssql

Source

mssql.lisp (file)

Function: %dblogin ()
Package

mssql

Source

connection.lisp (file)

Function: %dbloginfree LOGIN
Package

mssql

Source

connection.lisp (file)

Function: %dbmsghandle HANDLER
Package

mssql

Source

mssql.lisp (file)

Function: %dbnextrow DBPROC
Package

mssql

Source

query.lisp (file)

Function: %dbnumcols DBPROC
Package

mssql

Source

query.lisp (file)

Function: %dbresults DBPROC
Package

mssql

Source

query.lisp (file)

Function: %dbrpcinit DBPROC RPCNAME OPTIONS
Package

mssql

Source

remote.lisp (file)

Function: %dbrpcparam DBPROC PARAMNAME STATUS TYPE MAXLEN DATALEN VALUE
Package

mssql

Source

remote.lisp (file)

Function: %dbrpcsend DBPROC
Package

mssql

Source

remote.lisp (file)

Function: %dbsetlname LOGIN VALUE WHICH
Package

mssql

Source

connection.lisp (file)

Function: %dbsqlexec DBPROC
Package

mssql

Source

connection.lisp (file)

Function: %tdsdbopen LOGIN SERVER MSDBLIB
Package

mssql

Source

connection.lisp (file)

Function: all-rows %DBPROC COLLUMNS GET-ROW-FUN
Package

mssql

Source

query.lisp (file)

Function: cffi-string STR &optional POOL
Package

mssql

Source

mssql.lisp (file)

Function: field-name-s STR
Package

mssql

Source

query.lisp (file)

Function: get-results %DBPROC FORMAT &aux FORMAT-INFO
Package

mssql

Source

query.lisp (file)

Function: lisp-to-sysdb VAL
Package

mssql

Source

remote.lisp (file)

Function: one-row %DBPROC COLLUMNS GET-ROW-FUN
Package

mssql

Source

query.lisp (file)

Function: read-alist-row G0 G1
Package

mssql

Source

query.lisp (file)

Function: read-list-row G0 G1
Package

mssql

Source

query.lisp (file)

Function: read-plist-row G0 G1
Package

mssql

Source

query.lisp (file)

Function: read-single-value %DBPROC COLLUMNS
Package

mssql

Source

query.lisp (file)

Function: sysdb-data-to-lisp %DBPROC DATA TYPE LEN
Package

mssql

Source

query.lisp (file)


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

6.2.5 Generic functions

Generic Function: transaction-connection OBJECT
Package

mssql

Methods
Method: transaction-connection (TRANSACTION-HANDLE transaction-handle)

automatically generated reader method

Source

execute.lisp (file)

Generic Function: transaction-open-p OBJECT
Generic Function: (setf transaction-open-p) NEW-VALUE OBJECT
Package

mssql

Methods
Method: transaction-open-p (TRANSACTION-HANDLE transaction-handle)

automatically generated reader method

Source

execute.lisp (file)

Method: (setf transaction-open-p) NEW-VALUE (TRANSACTION-HANDLE transaction-handle)

automatically generated writer method

Source

execute.lisp (file)


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

6.2.6 Conditions

Condition: mssql-error ()
Package

mssql

Source

mssql.lisp (file)

Direct superclasses

error (condition)

Direct methods

print-object (method)

Direct slots
Slot: messages
Initargs

:messages

Initform

(quote nil)


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

6.2.7 Classes

Class: transaction-handle ()

Simple box type for storing the status and the
associated database connection of a transaction. When open-p is nil, the transaction has been aborted or committed.

Package

mssql

Source

execute.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: open-p
Initform

t

Readers

transaction-open-p (generic function)

Writers

(setf transaction-open-p) (generic function)

Slot: connection
Initargs

:connection

Readers

transaction-connection (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, mssql.asd: The mssql<dot>asd file
File, Lisp, mssql/src/connection.lisp: The mssql/src/connection<dot>lisp file
File, Lisp, mssql/src/execute.lisp: The mssql/src/execute<dot>lisp file
File, Lisp, mssql/src/mssql.lisp: The mssql/src/mssql<dot>lisp file
File, Lisp, mssql/src/packages.lisp: The mssql/src/packages<dot>lisp file
File, Lisp, mssql/src/query.lisp: The mssql/src/query<dot>lisp file
File, Lisp, mssql/src/remote.lisp: The mssql/src/remote<dot>lisp file

L
Lisp File, mssql.asd: The mssql<dot>asd file
Lisp File, mssql/src/connection.lisp: The mssql/src/connection<dot>lisp file
Lisp File, mssql/src/execute.lisp: The mssql/src/execute<dot>lisp file
Lisp File, mssql/src/mssql.lisp: The mssql/src/mssql<dot>lisp file
Lisp File, mssql/src/packages.lisp: The mssql/src/packages<dot>lisp file
Lisp File, mssql/src/query.lisp: The mssql/src/query<dot>lisp file
Lisp File, mssql/src/remote.lisp: The mssql/src/remote<dot>lisp file

M
Module, mssql/src: The mssql/src module
mssql.asd: The mssql<dot>asd file
mssql/src: The mssql/src module
mssql/src/connection.lisp: The mssql/src/connection<dot>lisp file
mssql/src/execute.lisp: The mssql/src/execute<dot>lisp file
mssql/src/mssql.lisp: The mssql/src/mssql<dot>lisp file
mssql/src/packages.lisp: The mssql/src/packages<dot>lisp file
mssql/src/query.lisp: The mssql/src/query<dot>lisp file
mssql/src/remote.lisp: The mssql/src/remote<dot>lisp file

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   L   M   O   Q   R   S   T   W  
Index Entry  Section

%
%%dbcancel: Internal functions
%%dbcmd: Internal functions
%%dblogin: Internal functions
%%dbsetlname: Internal functions
%%dbsqlexec: Internal functions
%%tdsdbopen: Internal functions
%dbcancel: Internal functions
%dbclose: Internal functions
%dbcmd: Internal functions
%dbcolname: Internal functions
%dbcoltype: Internal functions
%dbconvert: Internal functions
%dbdata: Internal functions
%dbdatlen: Internal functions
%dberrhandle: Internal functions
%dblogin: Internal functions
%dbloginfree: Internal functions
%dbmsghandle: Internal functions
%dbnextrow: Internal functions
%dbnumcols: Internal functions
%dbresults: Internal functions
%dbrpcinit: Internal functions
%dbrpcparam: Internal functions
%dbrpcsend: Internal functions
%dbsetlname: Internal functions
%dbsqlexec: Internal functions
%tdsdbopen: Internal functions

(
(setf transaction-open-p): Internal generic functions
(setf transaction-open-p): Internal generic functions

A
all-rows: Internal functions

C
call-remote-procedure: Exported functions
cffi-string: Internal functions
commit-transaction: Exported functions
connect: Exported functions
connect-toplevel: Exported functions
connected-p: Exported functions

D
define-row-reader: Internal macros
define-sybdb-function: Internal macros
disconnect: Exported functions
disconnect-toplevel: Exported functions

E
execute: Exported functions

F
field-name-s: Internal functions
Function, %%dbcancel: Internal functions
Function, %%dbcmd: Internal functions
Function, %%dblogin: Internal functions
Function, %%dbsetlname: Internal functions
Function, %%dbsqlexec: Internal functions
Function, %%tdsdbopen: Internal functions
Function, %dbcancel: Internal functions
Function, %dbclose: Internal functions
Function, %dbcmd: Internal functions
Function, %dbcolname: Internal functions
Function, %dbcoltype: Internal functions
Function, %dbconvert: Internal functions
Function, %dbdata: Internal functions
Function, %dbdatlen: Internal functions
Function, %dberrhandle: Internal functions
Function, %dblogin: Internal functions
Function, %dbloginfree: Internal functions
Function, %dbmsghandle: Internal functions
Function, %dbnextrow: Internal functions
Function, %dbnumcols: Internal functions
Function, %dbresults: Internal functions
Function, %dbrpcinit: Internal functions
Function, %dbrpcparam: Internal functions
Function, %dbrpcsend: Internal functions
Function, %dbsetlname: Internal functions
Function, %dbsqlexec: Internal functions
Function, %tdsdbopen: Internal functions
Function, all-rows: Internal functions
Function, call-remote-procedure: Exported functions
Function, cffi-string: Internal functions
Function, commit-transaction: Exported functions
Function, connect: Exported functions
Function, connect-toplevel: Exported functions
Function, connected-p: Exported functions
Function, disconnect: Exported functions
Function, disconnect-toplevel: Exported functions
Function, execute: Exported functions
Function, field-name-s: Internal functions
Function, get-results: Internal functions
Function, lisp-to-sysdb: Internal functions
Function, one-row: Internal functions
Function, query: Exported functions
Function, read-alist-row: Internal functions
Function, read-list-row: Internal functions
Function, read-plist-row: Internal functions
Function, read-single-value: Internal functions
Function, rollback-transaction: Exported functions
Function, sysdb-data-to-lisp: Internal functions

G
Generic Function, (setf transaction-open-p): Internal generic functions
Generic Function, transaction-connection: Internal generic functions
Generic Function, transaction-open-p: Internal generic functions
get-results: Internal functions

L
lisp-to-sysdb: Internal functions

M
Macro, define-row-reader: Internal macros
Macro, define-sybdb-function: Internal macros
Macro, with-connection: Exported macros
Macro, with-transaction: Exported macros
Method, (setf transaction-open-p): Internal generic functions
Method, transaction-connection: Internal generic functions
Method, transaction-open-p: Internal generic functions

O
one-row: Internal functions

Q
query: Exported functions

R
read-alist-row: Internal functions
read-list-row: Internal functions
read-plist-row: Internal functions
read-single-value: Internal functions
rollback-transaction: Exported functions

S
sysdb-data-to-lisp: Internal functions

T
transaction-connection: Internal generic functions
transaction-connection: Internal generic functions
transaction-open-p: Internal generic functions
transaction-open-p: Internal generic functions

W
with-connection: Exported macros
with-transaction: Exported macros

Jump to:   %   (  
A   C   D   E   F   G   L   M   O   Q   R   S   T   W  

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

A.3 Variables

Jump to:   *   +  
C   D   E   M   O   S  
Index Entry  Section

*
*database*: Exported special variables
*error-message-list*: Internal special variables
*query-formats*: Internal special variables

+
+fail+: Internal constants
+int_cancel+: Internal constants
+no-more-results+: Internal constants
+no-more-rows+: Internal constants
+numeric-buf-sz+: Internal constants

C
connection: Internal classes
Constant, +fail+: Internal constants
Constant, +int_cancel+: Internal constants
Constant, +no-more-results+: Internal constants
Constant, +no-more-rows+: Internal constants
Constant, +numeric-buf-sz+: Internal constants

D
dbproc: Exported classes

E
external-format: Exported classes

M
messages: Internal conditions

O
open-p: Internal classes

S
Slot, connection: Internal classes
Slot, dbproc: Exported classes
Slot, external-format: Exported classes
Slot, messages: Internal conditions
Slot, open-p: Internal classes
Special Variable, *database*: Exported special variables
Special Variable, *error-message-list*: Internal special variables
Special Variable, *query-formats*: Internal special variables

Jump to:   *   +  
C   D   E   M   O   S  

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

A.4 Data types

Jump to:   C   D   M   P   S   T  
Index Entry  Section

C
Class, database-connection: Exported classes
Class, transaction-handle: Internal classes
Condition, mssql-error: Internal conditions

D
database-connection: Exported classes

M
mssql: The mssql system
mssql: The mssql package
mssql-error: Internal conditions

P
Package, mssql: The mssql package

S
System, mssql: The mssql system

T
transaction-handle: Internal classes

Jump to:   C   D   M   P   S   T