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.
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The sqlite system |
Jacek Złydach <cl-sqlite@jacek.zlydach.pl>
Kalyanov Dmitry <Kalyanov.Dmitry@gmail.com>
(:git "git@github.com:temporal/cl-sqlite.git")
Public Domain
CL-SQLITE package is an interface to the SQLite embedded relational database engine.
0.2.1
sqlite.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The sqlite.asd file | ||
• The sqlite/sqlite-ffi.lisp file | ||
• The sqlite/cache.lisp file | ||
• The sqlite/sqlite.lisp file |
Next: The sqlite/sqlite-ffi․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
sqlite.asd
sqlite (system)
Next: The sqlite/cache․lisp file, Previous: The sqlite․asd file, Up: Lisp files [Contents][Index]
sqlite (system)
sqlite-ffi.lisp
Next: The sqlite/sqlite․lisp file, Previous: The sqlite/sqlite-ffi․lisp file, Up: Lisp files [Contents][Index]
sqlite (system)
cache.lisp
Previous: The sqlite/cache․lisp file, Up: Lisp files [Contents][Index]
sqlite (system)
sqlite.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The sqlite-ffi package | ||
• The sqlite.cache package | ||
• The sqlite package |
Next: The sqlite․cache package, Previous: Packages, Up: Packages [Contents][Index]
sqlite-ffi.lisp (file)
Next: The sqlite package, Previous: The sqlite-ffi package, Up: Packages [Contents][Index]
cache.lisp (file)
Previous: The sqlite․cache package, Up: Packages [Contents][Index]
sqlite.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
sqlite.lisp (file)
Wraps the BODY inside the transaction.
sqlite.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
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
sqlite.lisp (file)
Sets all binding values to NULL.
sqlite.lisp (file)
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.
sqlite.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
Disconnects the given HANDLE from the database. All further operations on the handle are invalid.
sqlite.lisp (file)
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.
sqlite.lisp (file)
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.
sqlite.lisp (file)
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.
sqlite.lisp (file)
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.
sqlite.lisp (file)
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.
sqlite.lisp (file)
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.
sqlite.lisp (file)
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.
sqlite.lisp (file)
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.
sqlite.lisp (file)
Finalizes the statement and signals that associated resources may be released. Note: does not immediately release resources because statements are cached.
sqlite.lisp (file)
cache.lisp (file)
Returns the auto-generated ID of the last inserted row on the database connection DB.
sqlite.lisp (file)
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 = ?
sqlite.lisp (file)
cache.lisp (file)
cache.lisp (file)
Resets the STATEMENT and prepare it to be called again.
sqlite.lisp (file)
Sets the maximum amount of time to wait for a locked database.
sqlite.lisp (file)
sqlite.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
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
sqlite.lisp (file)
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.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
sqlite.lisp (file)
sqlite.lisp (file)
sqlite.lisp (file)
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
sqlite.lisp (file)
sqlite-error (condition)
sqlite.lisp (file)
simple-error (condition)
sqlite-constraint-error (condition)
:db-handle
(quote nil)
sqlite-error-db-handle (generic function)
:error-code
(quote nil)
sqlite-error-code (generic function)
:error-msg
(quote nil)
sqlite-error-message (generic function)
:statement
(quote nil)
sqlite-error-statement (generic function)
:sql
(quote nil)
sqlite-error-sql (generic function)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
cache.lisp (file)
standard-object (class)
(make-hash-table :test (quote equal))
objects-table (generic function)
(setf objects-table) (generic function)
(make-hash-table :test (quote equal))
last-access-time-table (generic function)
(setf last-access-time-table) (generic function)
fixnum
0
total-cached (generic function)
(setf total-cached) (generic function)
fixnum
:cache-size
100
cache-size (generic function)
(setf cache-size) (generic function)
:destructor
(function identity)
destructor (generic function)
(setf destructor) (generic function)
Class that encapsulates the connection to the database. Use connect and disconnect.
sqlite.lisp (file)
standard-object (class)
handle (generic function)
(setf handle) (generic function)
database-path (generic function)
(setf database-path) (generic function)
cache (generic function)
(setf cache) (generic function)
sqlite-handle-statements (generic function)
(setf sqlite-handle-statements) (generic function)
Class that represents the prepared statement.
sqlite.lisp (file)
standard-object (class)
:db
db (generic function)
handle (generic function)
(setf handle) (generic function)
:sql
sql (generic function)
resultset-columns-count (generic function)
(setf resultset-columns-count) (generic function)
(setf resultset-columns-names) (generic function)
parameters-count (generic function)
(setf parameters-count) (generic function)
(setf parameters-names) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
sqlite-ffi.lisp (file)
Next: Internal functions, Previous: Internal constants, Up: Internal definitions [Contents][Index]
sqlite.lisp (file)
sqlite.lisp (file)
sqlite.lisp (file)
sqlite.lisp (file)
sqlite.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
cache.lisp (file)
sqlite.lisp (file)
cache.lisp (file)
sqlite.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
cache.lisp (file)
automatically generated writer method
cache.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated reader method
cache.lisp (file)
automatically generated writer method
cache.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
cache.lisp (file)
automatically generated writer method
cache.lisp (file)
automatically generated reader method
cache.lisp (file)
automatically generated writer method
cache.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
sqlite.lisp (file)
automatically generated reader method
sqlite.lisp (file)
automatically generated writer method
sqlite.lisp (file)
automatically generated reader method
cache.lisp (file)
automatically generated writer method
cache.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
sqlite-ffi.lisp (file)
sqlite-ffi.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L S |
---|
Jump to: | F L S |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
B C D E F G H L M O P R S T W |
---|
Jump to: | (
B C D E F G H L M O P R S T W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | C D E H L O P S T |
---|
Jump to: | C D E H L O P S T |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C M P S |
---|
Jump to: | C M P S |
---|