This is the sqlite Reference Manual, version 0.2.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:40:34 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
sqliteCL-SQLITE package is an interface to the SQLite embedded relational database engine.
Jacek Złydach <cl-sqlite@jacek.zlydach.pl>
Kalyanov Dmitry <Kalyanov.Dmitry@gmail.com>
(GIT git@github.com:TeMPOraL/cl-sqlite.git)
Public Domain
0.2.1
iterate (system).
cffi (system).
sqlite-ffi.lisp (file).
cache.lisp (file).
sqlite.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
sqlite/sqlite-ffi.lispsqlite (system).
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).
destructor-transient-address (constant).
sqlite3-stmt-tclass (class).
sqlite3-tclass (class).
sqlite/cache.lispsqlite (system).
get-from-cache (function).
mru-cache (class).
purge-cache (function).
put-to-cache (function).
cache-size (reader method).
(setf cache-size) (writer method).
destructor (reader method).
(setf destructor) (writer method).
last-access-time-table (reader method).
(setf last-access-time-table) (writer method).
objects-table (reader method).
(setf objects-table) (writer method).
pop-from-cache (function).
remove-empty-objects-stacks (function).
total-cached (reader method).
(setf total-cached) (writer method).
sqlite/sqlite.lispsqlite-ffi.lisp (file).
cache.lisp (file).
sqlite (system).
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).
initialize-instance (method).
initialize-instance (method).
last-insert-rowid (function).
prepare-statement (function).
print-object (method).
reset-statement (function).
set-busy-timeout (function).
sqlite-constraint-error (condition).
sqlite-error (function).
sqlite-error (condition).
sqlite-error-code (reader method).
sqlite-error-db-handle (reader method).
sqlite-error-message (reader method).
sqlite-error-sql (reader method).
sqlite-handle (class).
sqlite-statement (class).
statement-bind-parameter-names (reader method).
statement-column-names (reader method).
statement-column-value (function).
step-statement (function).
with-open-database (macro).
with-transaction (macro).
cache (reader method).
(setf cache) (writer 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 (reader method).
(setf database-path) (writer method).
db (reader method).
handle (reader method).
handle (reader method).
(setf handle) (writer method).
(setf handle) (writer method).
parameters-count (reader method).
(setf parameters-count) (writer method).
parameters-names (reader method).
(setf parameters-names) (writer method).
really-finalize-statement (function).
resultset-columns-count (reader method).
(setf resultset-columns-count) (writer method).
resultset-columns-names (reader method).
(setf resultset-columns-names) (writer method).
sql (reader method).
sqlite-error-statement (reader method).
sqlite-handle-statements (reader method).
(setf sqlite-handle-statements) (writer method).
statement-parameter-index (function).
with-prepared-statement (macro).
with-prepared-statement/named (macro).
Packages are listed by definition order.
sqlite-fficffi.
common-lisp.
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).
destructor-transient-address (constant).
sqlite3-stmt-tclass (class).
sqlite3-tclass (class).
sqlitecommon-lisp.
iterate.
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 reader).
sqlite-error-db-handle (generic reader).
sqlite-error-message (generic reader).
sqlite-error-sql (generic reader).
sqlite-handle (class).
sqlite-statement (class).
statement-bind-parameter-names (generic reader).
statement-column-names (generic reader).
statement-column-value (function).
step-statement (function).
with-open-database (macro).
with-transaction (macro).
cache (generic reader).
(setf cache) (generic writer).
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 reader).
(setf database-path) (generic writer).
db (generic reader).
handle (generic reader).
(setf handle) (generic writer).
parameters-count (generic reader).
(setf parameters-count) (generic writer).
parameters-names (generic reader).
(setf parameters-names) (generic writer).
really-finalize-statement (function).
resultset-columns-count (generic reader).
(setf resultset-columns-count) (generic writer).
resultset-columns-names (generic reader).
(setf resultset-columns-names) (generic writer).
sql (generic reader).
sqlite-error-statement (generic reader).
sqlite-handle-statements (generic reader).
(setf sqlite-handle-statements) (generic writer).
statement-parameter-index (function).
with-prepared-statement (macro).
with-prepared-statement/named (macro).
sqlite.cachecommon-lisp.
iterate.
get-from-cache (function).
mru-cache (class).
purge-cache (function).
put-to-cache (function).
cache-size (generic reader).
(setf cache-size) (generic writer).
destructor (generic reader).
(setf destructor) (generic writer).
last-access-time-table (generic reader).
(setf last-access-time-table) (generic writer).
objects-table (generic reader).
(setf objects-table) (generic writer).
pop-from-cache (function).
remove-empty-objects-stacks (function).
total-cached (generic reader).
(setf total-cached) (generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Wraps the BODY inside the transaction.
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
Sets all binding values to NULL.
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.
Disconnects the given HANDLE from the database. All further operations on the handle are invalid.
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.
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.
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.
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.
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.
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.
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.
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.
Finalizes the statement and signals that associated resources may be released. Note: does not immediately release resources because statements are cached.
Returns the auto-generated ID of the last inserted row on the database connection DB.
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 = ?
Resets the STATEMENT and prepare it to be called again.
Sets the maximum amount of time to wait for a locked database.
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
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.
sqlite-error)) ¶sqlite-error)) ¶sqlite-error)) ¶sqlite-error)) ¶sql.
sqlite-statement)) ¶automatically generated reader method
sqlite-statement)) ¶automatically generated reader method
sqlite-handle) &key database-path &allow-other-keys) ¶sqlite-statement) &key &allow-other-keys) ¶sqlite-error) stream) ¶simple-error.
(quote nil)
:db-handle
This slot is read-only.
(quote nil)
:error-code
This slot is read-only.
(quote nil)
:error-msg
This slot is read-only.
(quote nil)
:statement
This slot is read-only.
(quote nil)
:sql
This slot is read-only.
(make-hash-table :test (quote equal))
(make-hash-table :test (quote equal))
fixnum
0
fixnum
100
:cache-size
(function identity)
:destructor
Class that encapsulates the connection to the database. Use connect and disconnect.
Class that represents the prepared statement.
db.
(setf handle).
handle.
initialize-instance.
(setf parameters-count).
parameters-count.
(setf parameters-names).
parameters-names.
(setf resultset-columns-count).
resultset-columns-count.
(setf resultset-columns-names).
resultset-columns-names.
sql.
statement-bind-parameter-names.
statement-column-names.
sqlite-handle)) ¶automatically generated reader method
sqlite-handle)) ¶automatically generated writer method
sqlite-handle)) ¶automatically generated reader method
sqlite-handle)) ¶automatically generated writer method
sqlite-statement)) ¶automatically generated reader method
db.
sqlite-statement)) ¶automatically generated reader method
sqlite-handle)) ¶automatically generated reader method
sqlite-statement)) ¶automatically generated writer method
sqlite-handle)) ¶automatically generated writer method
sqlite-statement)) ¶automatically generated reader method
sqlite-statement)) ¶automatically generated writer method
sqlite-statement)) ¶automatically generated reader method
sqlite-statement)) ¶automatically generated writer method
sqlite-statement)) ¶automatically generated reader method
sqlite-statement)) ¶automatically generated writer method
sqlite-statement)) ¶automatically generated reader method
sqlite-statement)) ¶automatically generated writer method
sqlite-statement)) ¶automatically generated reader method
sql.
sqlite-error)) ¶sqlite-handle)) ¶automatically generated reader method
sqlite-handle)) ¶automatically generated writer method
| Jump to: | (
B C D E F G H I L M O P R S T W |
|---|
| Jump to: | (
B C D E F G H I L M O P R S T W |
|---|
| Jump to: | C D E H L O P S T |
|---|
| Jump to: | C D E H L O P S T |
|---|
| Jump to: | C F M P S |
|---|
| Jump to: | C F M P S |
|---|