The sqlite Reference Manual

Table of Contents

The sqlite Reference Manual

This is the sqlite Reference Manual, version 0.2.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:49:51 2020 GMT+0.

1 Systems

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

1.1 sqlite

Maintainer

Jacek Złydach <cl-sqlite@jacek.zlydach.pl>

Author

Kalyanov Dmitry <Kalyanov.Dmitry@gmail.com>

Home Page

https://common-lisp.net/project/cl-sqlite/

Source Control

(:git "git@github.com:temporal/cl-sqlite.git")

Bug Tracker

https://github.com/TeMPOraL/cl-sqlite/issues

License

Public Domain

Description

CL-SQLITE package is an interface to the SQLite embedded relational database engine.

Version

0.2.1

Dependencies

• iterate
• cffi

Source

sqlite.asd (file)

Components

• sqlite-ffi.lisp (file)
• cache.lisp (file)
• sqlite.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 sqlite.asd

Location

sqlite.asd

Systems

sqlite (system)

2.1.2 sqlite/sqlite-ffi.lisp

Parent

sqlite (system)

Location

sqlite-ffi.lisp

Packages

sqlite-ffi

Exported Definitions

• destructor-static (function)
• destructor-transient (function)
• sqlite3-bind-blob (function)
• sqlite3-bind-double (function)
• sqlite3-bind-int64 (function)
• sqlite3-bind-null (function)
• sqlite3-bind-parameter-count (function)
• sqlite3-bind-parameter-index (function)
• sqlite3-bind-parameter-name (function)
• sqlite3-bind-text (function)
• sqlite3-busy-timeout (function)
• sqlite3-clear-bindings (function)
• sqlite3-close (function)
• sqlite3-column-blob (function)
• sqlite3-column-bytes (function)
• sqlite3-column-count (function)
• sqlite3-column-double (function)
• sqlite3-column-int64 (function)
• sqlite3-column-name (function)
• sqlite3-column-text (function)
• sqlite3-column-type (function)
• sqlite3-errmsg (function)
• sqlite3-finalize (function)
• sqlite3-last-insert-rowid (function)
• sqlite3-open (function)
• sqlite3-prepare (function)
• sqlite3-reset (function)
• sqlite3-step (function)

Internal Definitions

• destructor-transient-address (constant)
• sqlite3-stmt-tclass (class)
• sqlite3-tclass (class)

2.1.3 sqlite/cache.lisp

Parent

sqlite (system)

Location

cache.lisp

Packages

sqlite.cache

Exported Definitions

• get-from-cache (function)
• mru-cache (class)
• purge-cache (function)
• put-to-cache (function)

Internal Definitions

• cache-size (method)
• (setf cache-size) (method)
• destructor (method)
• (setf destructor) (method)
• last-access-time-table (method)
• (setf last-access-time-table) (method)
• objects-table (method)
• (setf objects-table) (method)
• pop-from-cache (function)
• remove-empty-objects-stacks (function)
• total-cached (method)
• (setf total-cached) (method)

2.1.4 sqlite/sqlite.lisp

Dependencies

• sqlite-ffi.lisp (file)
• cache.lisp (file)

Parent

sqlite (system)

Location

sqlite.lisp

Packages

sqlite

Exported Definitions

• bind-parameter (function)
• clear-statement-bindings (function)
• connect (function)
• disconnect (function)
• execute-non-query (function)
• execute-non-query/named (function)
• execute-one-row-m-v (function)
• execute-one-row-m-v/named (function)
• execute-single (function)
• execute-single/named (function)
• execute-to-list (function)
• execute-to-list/named (function)
• finalize-statement (function)
• last-insert-rowid (function)
• prepare-statement (function)
• reset-statement (function)
• set-busy-timeout (function)
• sqlite-constraint-error (condition)
• sqlite-error (function)
• sqlite-error (condition)
• sqlite-error-code (method)
• sqlite-error-db-handle (method)
• sqlite-error-message (method)
• sqlite-error-sql (method)
• sqlite-handle (class)
• sqlite-statement (class)
• statement-bind-parameter-names (method)
• statement-column-names (method)
• statement-column-value (function)
• step-statement (function)
• with-open-database (macro)
• with-transaction (macro)

Internal Definitions

• cache (method)
• (setf cache) (method)
• clause-for-in-sqlite-query-on-database-1 (macro)
• clause-for-in-sqlite-query/named-on-database-2 (macro)
• clause-for-on-sqlite-statement-3 (macro)
• database-path (method)
• (setf database-path) (method)
• db (method)
• handle (method)
• (setf handle) (method)
• handle (method)
• (setf handle) (method)
• parameters-count (method)
• (setf parameters-count) (method)
• parameters-names (method)
• (setf parameters-names) (method)
• really-finalize-statement (function)
• resultset-columns-count (method)
• (setf resultset-columns-count) (method)
• resultset-columns-names (method)
• (setf resultset-columns-names) (method)
• sql (method)
• sqlite-error-statement (method)
• sqlite-handle-statements (method)
• (setf sqlite-handle-statements) (method)
• statement-parameter-index (function)
• with-prepared-statement (macro)
• with-prepared-statement/named (macro)

3 Packages

Packages are listed by definition order.

3.1 sqlite-ffi

Source

sqlite-ffi.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• destructor-static (function)
• destructor-transient (function)
• sqlite3-bind-blob (function)
• sqlite3-bind-double (function)
• sqlite3-bind-int64 (function)
• sqlite3-bind-null (function)
• sqlite3-bind-parameter-count (function)
• sqlite3-bind-parameter-index (function)
• sqlite3-bind-parameter-name (function)
• sqlite3-bind-text (function)
• sqlite3-busy-timeout (function)
• sqlite3-clear-bindings (function)
• sqlite3-close (function)
• sqlite3-column-blob (function)
• sqlite3-column-bytes (function)
• sqlite3-column-count (function)
• sqlite3-column-double (function)
• sqlite3-column-int64 (function)
• sqlite3-column-name (function)
• sqlite3-column-text (function)
• sqlite3-column-type (function)
• sqlite3-errmsg (function)
• sqlite3-finalize (function)
• sqlite3-last-insert-rowid (function)
• sqlite3-open (function)
• sqlite3-prepare (function)
• sqlite3-reset (function)
• sqlite3-step (function)

Internal Definitions

• destructor-transient-address (constant)
• sqlite3-stmt-tclass (class)
• sqlite3-tclass (class)

3.2 sqlite.cache

Source

cache.lisp (file)

Use List

• iterate
• common-lisp

Exported Definitions

• get-from-cache (function)
• mru-cache (class)
• purge-cache (function)
• put-to-cache (function)

Internal Definitions

• cache-size (generic function)
• cache-size (method)
• (setf cache-size) (method)
• (setf cache-size) (generic function)
• destructor (generic function)
• destructor (method)
• (setf destructor) (method)
• (setf destructor) (generic function)
• last-access-time-table (generic function)
• last-access-time-table (method)
• (setf last-access-time-table) (method)
• (setf last-access-time-table) (generic function)
• objects-table (generic function)
• objects-table (method)
• (setf objects-table) (method)
• (setf objects-table) (generic function)
• pop-from-cache (function)
• remove-empty-objects-stacks (function)
• total-cached (generic function)
• total-cached (method)
• (setf total-cached) (method)
• (setf total-cached) (generic function)

3.3 sqlite

Source

sqlite.lisp (file)

Use List

• iterate
• common-lisp

Exported Definitions

• bind-parameter (function)
• clear-statement-bindings (function)
• connect (function)
• disconnect (function)
• execute-non-query (function)
• execute-non-query/named (function)
• execute-one-row-m-v (function)
• execute-one-row-m-v/named (function)
• execute-single (function)
• execute-single/named (function)
• execute-to-list (function)
• execute-to-list/named (function)
• finalize-statement (function)
• last-insert-rowid (function)
• prepare-statement (function)
• reset-statement (function)
• set-busy-timeout (function)
• sqlite-constraint-error (condition)
• sqlite-error (function)
• sqlite-error (condition)
• sqlite-error-code (generic function)
• sqlite-error-code (method)
• sqlite-error-db-handle (generic function)
• sqlite-error-db-handle (method)
• sqlite-error-message (generic function)
• sqlite-error-message (method)
• sqlite-error-sql (generic function)
• sqlite-error-sql (method)
• sqlite-handle (class)
• sqlite-statement (class)
• statement-bind-parameter-names (generic function)
• statement-bind-parameter-names (method)
• statement-column-names (generic function)
• statement-column-names (method)
• statement-column-value (function)
• step-statement (function)
• with-open-database (macro)
• with-transaction (macro)

Internal Definitions

• cache (generic function)
• cache (method)
• (setf cache) (method)
• (setf cache) (generic function)
• clause-for-in-sqlite-query-on-database-1 (macro)
• clause-for-in-sqlite-query/named-on-database-2 (macro)
• clause-for-on-sqlite-statement-3 (macro)
• database-path (generic function)
• database-path (method)
• (setf database-path) (method)
• (setf database-path) (generic function)
• db (generic function)
• db (method)
• handle (generic function)
• handle (method)
• (setf handle) (method)
• handle (method)
• (setf handle) (method)
• (setf handle) (generic function)
• parameters-count (generic function)
• parameters-count (method)
• (setf parameters-count) (method)
• (setf parameters-count) (generic function)
• parameters-names (generic function)
• parameters-names (method)
• (setf parameters-names) (method)
• (setf parameters-names) (generic function)
• really-finalize-statement (function)
• resultset-columns-count (generic function)
• resultset-columns-count (method)
• (setf resultset-columns-count) (method)
• (setf resultset-columns-count) (generic function)
• resultset-columns-names (generic function)
• resultset-columns-names (method)
• (setf resultset-columns-names) (method)
• (setf resultset-columns-names) (generic function)
• sql (generic function)
• sql (method)
• sqlite-error-statement (generic function)
• sqlite-error-statement (method)
• sqlite-handle-statements (generic function)
• sqlite-handle-statements (method)
• (setf sqlite-handle-statements) (method)
• (setf sqlite-handle-statements) (generic function)
• statement-parameter-index (function)
• with-prepared-statement (macro)
• with-prepared-statement/named (macro)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: with-open-database (DB PATH &key BUSY-TIMEOUT) &body BODY

Package

sqlite

Source

sqlite.lisp (file)

Macro: with-transaction DB &body BODY

Wraps the BODY inside the transaction.

Package

sqlite

Source

sqlite.lisp (file)

4.1.2 Functions

Function: bind-parameter STATEMENT PARAMETER VALUE

Sets the PARAMETER-th parameter in STATEMENT to the VALUE.
PARAMETER may be parameter index (starting from 1) or parameters name.
Supported types:
* NULL. Passed as NULL
* INTEGER. Passed as an 64-bit integer
* STRING. Passed as a string
* FLOAT. Passed as a double
* (VECTOR (UNSIGNED-BYTE 8)) and VECTOR that contains integers in range [0,256). Passed as a BLOB

Package

sqlite

Source

sqlite.lisp (file)

Function: clear-statement-bindings STATEMENT

Sets all binding values to NULL.

Package

sqlite

Source

sqlite.lisp (file)

Function: connect DATABASE-PATH &key BUSY-TIMEOUT

Connect to the sqlite database at the given DATABASE-PATH. Returns the SQLITE-HANDLE connected to the database. Use DISCONNECT to disconnect.
Operations will wait for locked databases for up to BUSY-TIMEOUT milliseconds; if BUSY-TIMEOUT is NIL, then operations on locked databases will fail immediately.

Package

sqlite

Source

sqlite.lisp (file)

Function: destructor-static ()

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: destructor-transient ()

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: disconnect HANDLE

Disconnects the given HANDLE from the database. All further operations on the handle are invalid.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-non-query DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns nothing.

Example:

(execute-non-query db "insert into users (user_name, real_name) values (?, ?)" "joe" "Joe the User")

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-non-query/named DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns nothing.

PARAMETERS is a list of alternating parameter names and values.

Example:

(execute-non-query db "insert into users (user_name, real_name) values (:name, :real_name)" ":name" "joe" ":real_name" "Joe the User")

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-one-row-m-v DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns the first row as multiple values.

Example:
(execute-one-row-m-v db "select id, user_name, real_name from users where id = ?" 1)
=>
(values 1 "joe" "Joe the User")

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-one-row-m-v/named DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns the first row as multiple values.

PARAMETERS is a list of alternating parameters names and values.

Example:
(execute-one-row-m-v db "select id, user_name, real_name from users where id = :id" ":id" 1)
=>
(values 1 "joe" "Joe the User")

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-single DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns the first column of the first row as single value.

Example:
(execute-single db "select user_name from users where id = ?" 1)
=>
"joe"

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-single/named DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns the first column of the first row as single value.

PARAMETERS is a list of alternating parameters names and values.

Example:
(execute-single db "select user_name from users where id = :id" ":id" 1)
=>
"joe"

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-to-list DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns the results as list of lists.

Example:

(execute-to-list db "select id, user_name, real_name from users where user_name = ?" "joe")
=>
((1 "joe" "Joe the User")
(2 "joe" "Another Joe"))

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: execute-to-list/named DB SQL &rest PARAMETERS

Executes the query SQL to the database DB with given PARAMETERS. Returns the results as list of lists.

PARAMETERS is a list of alternating parameters names and values.

Example:

(execute-to-list db "select id, user_name, real_name from users where user_name = :user_name" ":user_name" "joe") =>
((1 "joe" "Joe the User")
(2 "joe" "Another Joe"))

See BIND-PARAMETER for the list of supported parameter types.

Package

sqlite

Source

sqlite.lisp (file)

Function: finalize-statement STATEMENT

Finalizes the statement and signals that associated resources may be released. Note: does not immediately release resources because statements are cached.

Package

sqlite

Source

sqlite.lisp (file)

Function: get-from-cache CACHE ID

Package

sqlite.cache

Source

cache.lisp (file)

Function: last-insert-rowid DB

Returns the auto-generated ID of the last inserted row on the database connection DB.

Package

sqlite

Source

sqlite.lisp (file)

Function: prepare-statement DB SQL

Prepare the statement to the DB that will execute the commands that are in SQL.

Returns the SQLITE-STATEMENT.

SQL must contain exactly one statement.
SQL may have some positional (not named) parameters specified with question marks.

Example:

select name from users where id = ?

Package

sqlite

Source

sqlite.lisp (file)

Function: purge-cache CACHE

Package

sqlite.cache

Source

cache.lisp (file)

Function: put-to-cache CACHE ID OBJECT

Package

sqlite.cache

Source

cache.lisp (file)

Function: reset-statement STATEMENT

Resets the STATEMENT and prepare it to be called again.

Package

sqlite

Source

sqlite.lisp (file)

Function: set-busy-timeout DB MILLISECONDS

Sets the maximum amount of time to wait for a locked database.

Package

sqlite

Source

sqlite.lisp (file)

Function: sqlite-error ERROR-CODE MESSAGE &key STATEMENT DB-HANDLE SQL-TEXT

Package

sqlite

Source

sqlite.lisp (file)

Function: sqlite3-bind-blob STATEMENT PARAMETER-INDEX VALUE BYTES-COUNT DESTRUCTOR

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-bind-double STATEMENT PARAMETER-INDEX VALUE

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-bind-int64 STATEMENT PARAMETER-INDEX VALUE

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-bind-null STATEMENT PARAMETER-INDEX

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-bind-parameter-count STATEMENT

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-bind-parameter-index STATEMENT NAME

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-bind-parameter-name STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-bind-text STATEMENT PARAMETER-INDEX VALUE OCTETS-COUNT DESTRUCTOR

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-busy-timeout DB MS

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-clear-bindings STATEMENT

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-close DB

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-blob STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-bytes STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-count STATEMENT

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-double STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-int64 STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-name STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-text STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-column-type STATEMENT COLUMN-NUMBER

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-errmsg DB

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-finalize STATEMENT

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-last-insert-rowid DB

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-open FILENAME DB

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-prepare DB SQL SQL-LENGTH-BYTES STMT TAIL

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-reset STATEMENT

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: sqlite3-step STATEMENT

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Function: statement-column-value STATEMENT COLUMN-NUMBER

Returns the COLUMN-NUMBER-th column’s value of the current row of the STATEMENT. Columns are numbered from zero. Returns:
* NIL for NULL
* INTEGER for integers
* DOUBLE-FLOAT for floats
* STRING for text
* (SIMPLE-ARRAY (UNSIGNED-BYTE 8)) for BLOBs

Package

sqlite

Source

sqlite.lisp (file)

Function: step-statement STATEMENT

Steps to the next row of the resultset of STATEMENT.
Returns T is successfully advanced to the next row and NIL if there are no more rows.

Package

sqlite

Source

sqlite.lisp (file)

4.1.3 Generic functions

Generic Function: sqlite-error-code CONDITION

Package

sqlite

Methods

Method: sqlite-error-code (CONDITION sqlite-error)

Source

sqlite.lisp (file)

Generic Function: sqlite-error-db-handle CONDITION

Package

sqlite

Methods

Method: sqlite-error-db-handle (CONDITION sqlite-error)

Source

sqlite.lisp (file)

Generic Function: sqlite-error-message CONDITION

Package

sqlite

Methods

Method: sqlite-error-message (CONDITION sqlite-error)

Source

sqlite.lisp (file)

Generic Function: sqlite-error-sql CONDITION

Package

sqlite

Methods

Method: sqlite-error-sql (CONDITION sqlite-error)

Source

sqlite.lisp (file)

Generic Function: statement-bind-parameter-names OBJECT

Package

sqlite

Methods

Method: statement-bind-parameter-names (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Generic Function: statement-column-names OBJECT

Package

sqlite

Methods

Method: statement-column-names (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

4.1.4 Conditions

Condition: sqlite-constraint-error ()

Package

sqlite

Source

sqlite.lisp (file)

Direct superclasses

sqlite-error (condition)

Condition: sqlite-error ()

Package

sqlite

Source

sqlite.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses

sqlite-constraint-error (condition)

Direct methods

• print-object (method)
• sqlite-error-sql (method)
• sqlite-error-statement (method)
• sqlite-error-message (method)
• sqlite-error-code (method)
• sqlite-error-db-handle (method)

Direct slots

Slot: handle

Initargs

:db-handle

Initform

(quote nil)

Readers

sqlite-error-db-handle (generic function)

Slot: error-code

Initargs

:error-code

Initform

(quote nil)

Readers

sqlite-error-code (generic function)

Slot: error-msg

Initargs

:error-msg

Initform

(quote nil)

Readers

sqlite-error-message (generic function)

Slot: statement

Initargs

:statement

Initform

(quote nil)

Readers

sqlite-error-statement (generic function)

Slot: sql

Initargs

:sql

Initform

(quote nil)

Readers

sqlite-error-sql (generic function)

4.1.5 Classes

Class: mru-cache ()

Package

sqlite.cache

Source

cache.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• destructor (method)
• destructor (method)
• cache-size (method)
• cache-size (method)
• total-cached (method)
• total-cached (method)
• last-access-time-table (method)
• last-access-time-table (method)
• objects-table (method)
• objects-table (method)

Direct slots

Slot: objects-table

Initform

(make-hash-table :test (quote equal))

Readers

objects-table (generic function)

Writers

(setf objects-table) (generic function)

Slot: last-access-time-table

Initform

(make-hash-table :test (quote equal))

Readers

last-access-time-table (generic function)

Writers

(setf last-access-time-table) (generic function)

Slot: total-cached

Type

fixnum

Initform

0

Readers

total-cached (generic function)

Writers

(setf total-cached) (generic function)

Slot: cache-size

Type

fixnum

Initargs

:cache-size

Initform

100

Readers

cache-size (generic function)

Writers

(setf cache-size) (generic function)

Slot: destructor

Initargs

:destructor

Initform

(function identity)

Readers

destructor (generic function)

Writers

(setf destructor) (generic function)

Class: sqlite-handle ()

Class that encapsulates the connection to the database. Use connect and disconnect.

Package

sqlite

Source

sqlite.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• sqlite-handle-statements (method)
• sqlite-handle-statements (method)
• cache (method)
• cache (method)
• database-path (method)
• database-path (method)
• handle (method)
• handle (method)

Direct slots

Slot: handle

Readers

handle (generic function)

Writers

(setf handle) (generic function)

Slot: database-path

Readers

database-path (generic function)

Writers

(setf database-path) (generic function)

Slot: cache

Readers

cache (generic function)

Writers

(setf cache) (generic function)

Slot: statements

Readers

sqlite-handle-statements (generic function)

Writers

(setf sqlite-handle-statements) (generic function)

Class: sqlite-statement ()

Class that represents the prepared statement.

Package

sqlite

Source

sqlite.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• parameters-names (method)
• parameters-names (method)
• statement-bind-parameter-names (method)
• parameters-count (method)
• parameters-count (method)
• resultset-columns-names (method)
• resultset-columns-names (method)
• statement-column-names (method)
• resultset-columns-count (method)
• resultset-columns-count (method)
• sql (method)
• handle (method)
• handle (method)
• db (method)

Direct slots

Slot: db

Initargs

:db

Readers

db (generic function)

Slot: handle

Readers

handle (generic function)

Writers

(setf handle) (generic function)

Slot: sql

Initargs

:sql

Readers

sql (generic function)

Slot: columns-count

Readers

resultset-columns-count (generic function)

Writers

(setf resultset-columns-count) (generic function)

Slot: columns-names

Readers

• statement-column-names (generic function)
• resultset-columns-names (generic function)

Writers

(setf resultset-columns-names) (generic function)

Slot: parameters-count

Readers

parameters-count (generic function)

Writers

(setf parameters-count) (generic function)

Slot: parameters-names

Readers

• statement-bind-parameter-names (generic function)
• parameters-names (generic function)

Writers

(setf parameters-names) (generic function)

4.2 Internal definitions

4.2.1 Constants

Constant: destructor-transient-address

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

4.2.2 Macros

Macro: clause-for-in-sqlite-query-on-database-1 &key (FOR VARS) (IN-SQLITE-QUERY QUERY-EXPRESSION) (ON-DATABASE DB) (WITH-PARAMETERS PARAMETERS) GENERATE

Package

sqlite

Source

sqlite.lisp (file)

Macro: clause-for-in-sqlite-query/named-on-database-2 &key (FOR VARS) (IN-SQLITE-QUERY/NAMED QUERY-EXPRESSION) (ON-DATABASE DB) (WITH-PARAMETERS PARAMETERS) GENERATE

Package

sqlite

Source

sqlite.lisp (file)

Macro: clause-for-on-sqlite-statement-3 &key (FOR VARS) (ON-SQLITE-STATEMENT STATEMENT) GENERATE

Package

sqlite

Source

sqlite.lisp (file)

Macro: with-prepared-statement STATEMENT-VAR (DB SQL PARAMETERS-VAR) &body BODY

Package

sqlite

Source

sqlite.lisp (file)

Macro: with-prepared-statement/named STATEMENT-VAR (DB SQL PARAMETERS-VAR) &body BODY

Package

sqlite

Source

sqlite.lisp (file)

4.2.3 Functions

Function: pop-from-cache CACHE

Package

sqlite.cache

Source

cache.lisp (file)

Function: really-finalize-statement STATEMENT

Package

sqlite

Source

sqlite.lisp (file)

Function: remove-empty-objects-stacks CACHE

Package

sqlite.cache

Source

cache.lisp (file)

Function: statement-parameter-index STATEMENT PARAMETER-NAME

Package

sqlite

Source

sqlite.lisp (file)

4.2.4 Generic functions

Generic Function: cache OBJECT

Generic Function: (setf cache) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: cache (SQLITE-HANDLE sqlite-handle)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf cache) NEW-VALUE (SQLITE-HANDLE sqlite-handle)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: cache-size OBJECT

Generic Function: (setf cache-size) NEW-VALUE OBJECT

Package

sqlite.cache

Methods

Method: cache-size (MRU-CACHE mru-cache)

automatically generated reader method

Source

cache.lisp (file)

Method: (setf cache-size) NEW-VALUE (MRU-CACHE mru-cache)

automatically generated writer method

Source

cache.lisp (file)

Generic Function: database-path OBJECT

Generic Function: (setf database-path) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: database-path (SQLITE-HANDLE sqlite-handle)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf database-path) NEW-VALUE (SQLITE-HANDLE sqlite-handle)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: db OBJECT

Package

sqlite

Methods

Method: db (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Generic Function: destructor OBJECT

Generic Function: (setf destructor) NEW-VALUE OBJECT

Package

sqlite.cache

Methods

Method: destructor (MRU-CACHE mru-cache)

automatically generated reader method

Source

cache.lisp (file)

Method: (setf destructor) NEW-VALUE (MRU-CACHE mru-cache)

automatically generated writer method

Source

cache.lisp (file)

Generic Function: handle OBJECT

Generic Function: (setf handle) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: handle (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf handle) NEW-VALUE (SQLITE-STATEMENT sqlite-statement)

automatically generated writer method

Source

sqlite.lisp (file)

Method: handle (SQLITE-HANDLE sqlite-handle)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf handle) NEW-VALUE (SQLITE-HANDLE sqlite-handle)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: last-access-time-table OBJECT

Generic Function: (setf last-access-time-table) NEW-VALUE OBJECT

Package

sqlite.cache

Methods

Method: last-access-time-table (MRU-CACHE mru-cache)

automatically generated reader method

Source

cache.lisp (file)

Method: (setf last-access-time-table) NEW-VALUE (MRU-CACHE mru-cache)

automatically generated writer method

Source

cache.lisp (file)

Generic Function: objects-table OBJECT

Generic Function: (setf objects-table) NEW-VALUE OBJECT

Package

sqlite.cache

Methods

Method: objects-table (MRU-CACHE mru-cache)

automatically generated reader method

Source

cache.lisp (file)

Method: (setf objects-table) NEW-VALUE (MRU-CACHE mru-cache)

automatically generated writer method

Source

cache.lisp (file)

Generic Function: parameters-count OBJECT

Generic Function: (setf parameters-count) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: parameters-count (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf parameters-count) NEW-VALUE (SQLITE-STATEMENT sqlite-statement)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: parameters-names OBJECT

Generic Function: (setf parameters-names) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: parameters-names (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf parameters-names) NEW-VALUE (SQLITE-STATEMENT sqlite-statement)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: resultset-columns-count OBJECT

Generic Function: (setf resultset-columns-count) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: resultset-columns-count (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf resultset-columns-count) NEW-VALUE (SQLITE-STATEMENT sqlite-statement)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: resultset-columns-names OBJECT

Generic Function: (setf resultset-columns-names) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: resultset-columns-names (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf resultset-columns-names) NEW-VALUE (SQLITE-STATEMENT sqlite-statement)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: sql OBJECT

Package

sqlite

Methods

Method: sql (SQLITE-STATEMENT sqlite-statement)

automatically generated reader method

Source

sqlite.lisp (file)

Generic Function: sqlite-error-statement CONDITION

Package

sqlite

Methods

Method: sqlite-error-statement (CONDITION sqlite-error)

Source

sqlite.lisp (file)

Generic Function: sqlite-handle-statements OBJECT

Generic Function: (setf sqlite-handle-statements) NEW-VALUE OBJECT

Package

sqlite

Methods

Method: sqlite-handle-statements (SQLITE-HANDLE sqlite-handle)

automatically generated reader method

Source

sqlite.lisp (file)

Method: (setf sqlite-handle-statements) NEW-VALUE (SQLITE-HANDLE sqlite-handle)

automatically generated writer method

Source

sqlite.lisp (file)

Generic Function: total-cached OBJECT

Generic Function: (setf total-cached) NEW-VALUE OBJECT

Package

sqlite.cache

Methods

Method: total-cached (MRU-CACHE mru-cache)

automatically generated reader method

Source

cache.lisp (file)

Method: (setf total-cached) NEW-VALUE (MRU-CACHE mru-cache)

automatically generated writer method

Source

cache.lisp (file)

4.2.5 Classes

Class: sqlite3-stmt-tclass ()

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Direct superclasses

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

Class: sqlite3-tclass ()

Package

sqlite-ffi

Source

sqlite-ffi.lisp (file)

Direct superclasses

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

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types