Expand description
These exported APIs are stable and will not have breaking changes.
Re-exports§
pub use super::init_sqlite;
pub use super::sqlite;
pub use super::OpfsSAHPoolCfg;
pub use super::SQLite;
pub use super::SQLiteError;
pub use super::Version;
Structs§
Enums§
- Error
Code - Error Codes
Constants§
- FTS5_
TOKENIZE_ AUX - FTS5_
TOKENIZE_ DOCUMENT - FTS5_
TOKENIZE_ PREFIX - FTS5_
TOKENIZE_ QUERY - FTS5_
TOKEN_ COLOCATED - FULLY_
WITHIN - NOT_
WITHIN - PARTLY_
WITHIN - SQLIT
E3_ TEXT - SQLITE_
ABORT - SQLITE_
ABORT_ ROLLBACK - SQLITE_
ACCESS_ EXISTS - SQLITE_
ACCESS_ READ - SQLITE_
ACCESS_ READWRITE - SQLITE_
ALTER_ TABLE - SQLITE_
ANALYZE - SQLITE_
ANY - SQLITE_
ATTACH - SQLITE_
AUTH - SQLITE_
AUTH_ USER - SQLITE_
BLOB - SQLITE_
BUSY - SQLITE_
BUSY_ RECOVERY - SQLITE_
BUSY_ SNAPSHOT - SQLITE_
BUSY_ TIMEOUT - SQLITE_
CANTOPEN - SQLITE_
CANTOPEN_ CONVPATH - SQLITE_
CANTOPEN_ DIRTYWAL - SQLITE_
CANTOPEN_ FULLPATH - SQLITE_
CANTOPEN_ ISDIR - SQLITE_
CANTOPEN_ NOTEMPDIR - SQLITE_
CANTOPEN_ SYMLINK - SQLITE_
CHANGESETAPPLY_ FKNOACTION - SQLITE_
CHANGESETAPPLY_ IGNORENOOP - SQLITE_
CHANGESETAPPLY_ INVERT - SQLITE_
CHANGESETAPPLY_ NOSAVEPOINT - SQLITE_
CHANGESETSTART_ INVERT - SQLITE_
CHANGESET_ ABORT - SQLITE_
CHANGESET_ CONFLICT - SQLITE_
CHANGESET_ CONSTRAINT - SQLITE_
CHANGESET_ DATA - SQLITE_
CHANGESET_ FOREIGN_ KEY - SQLITE_
CHANGESET_ NOTFOUND - SQLITE_
CHANGESET_ OMIT - SQLITE_
CHANGESET_ REPLACE - SQLITE_
CHECKPOINT_ FULL - SQLITE_
CHECKPOINT_ PASSIVE - SQLITE_
CHECKPOINT_ RESTART - SQLITE_
CHECKPOINT_ TRUNCATE - SQLITE_
CONFIG_ COVERING_ INDEX_ SCAN - SQLITE_
CONFIG_ GETMALLOC - SQLITE_
CONFIG_ GETMUTEX - SQLITE_
CONFIG_ GETPCACHE - SQLITE_
CONFIG_ GETPCACH E2 - SQLITE_
CONFIG_ HEAP - SQLITE_
CONFIG_ LOG - SQLITE_
CONFIG_ LOOKASIDE - SQLITE_
CONFIG_ MALLOC - SQLITE_
CONFIG_ MEMDB_ MAXSIZE - SQLITE_
CONFIG_ MEMSTATUS - SQLITE_
CONFIG_ MMAP_ SIZE - SQLITE_
CONFIG_ MULTITHREAD - SQLITE_
CONFIG_ MUTEX - SQLITE_
CONFIG_ PAGECACHE - SQLITE_
CONFIG_ PCACHE - SQLITE_
CONFIG_ PCACH E2 - SQLITE_
CONFIG_ PCACHE_ HDRSZ - SQLITE_
CONFIG_ PMASZ - SQLITE_
CONFIG_ ROWID_ IN_ VIEW - SQLITE_
CONFIG_ SCRATCH - SQLITE_
CONFIG_ SERIALIZED - SQLITE_
CONFIG_ SINGLETHREAD - SQLITE_
CONFIG_ SMALL_ MALLOC - SQLITE_
CONFIG_ SORTERREF_ SIZE - SQLITE_
CONFIG_ SQLLOG - SQLITE_
CONFIG_ STMTJRNL_ SPILL - SQLITE_
CONFIG_ URI - SQLITE_
CONFIG_ WIN32_ HEAPSIZE - SQLITE_
CONSTRAINT - SQLITE_
CONSTRAINT_ CHECK - SQLITE_
CONSTRAINT_ COMMITHOOK - SQLITE_
CONSTRAINT_ DATATYPE - SQLITE_
CONSTRAINT_ FOREIGNKEY - SQLITE_
CONSTRAINT_ FUNCTION - SQLITE_
CONSTRAINT_ NOTNULL - SQLITE_
CONSTRAINT_ PINNED - SQLITE_
CONSTRAINT_ PRIMARYKEY - SQLITE_
CONSTRAINT_ ROWID - SQLITE_
CONSTRAINT_ TRIGGER - SQLITE_
CONSTRAINT_ UNIQUE - SQLITE_
CONSTRAINT_ VTAB - SQLITE_
COPY - SQLITE_
CORRUPT - SQLITE_
CORRUPT_ INDEX - SQLITE_
CORRUPT_ SEQUENCE - SQLITE_
CORRUPT_ VTAB - SQLITE_
CREATE_ INDEX - SQLITE_
CREATE_ TABLE - SQLITE_
CREATE_ TEMP_ INDEX - SQLITE_
CREATE_ TEMP_ TABLE - SQLITE_
CREATE_ TEMP_ TRIGGER - SQLITE_
CREATE_ TEMP_ VIEW - SQLITE_
CREATE_ TRIGGER - SQLITE_
CREATE_ VIEW - SQLITE_
CREATE_ VTABLE - SQLITE_
DBCONFIG_ DEFENSIVE - SQLITE_
DBCONFIG_ DQS_ DDL - SQLITE_
DBCONFIG_ DQS_ DML - SQLITE_
DBCONFIG_ ENABLE_ FKEY - SQLITE_
DBCONFIG_ ENABLE_ FTS3_ TOKENIZER - SQLITE_
DBCONFIG_ ENABLE_ LOAD_ EXTENSION - SQLITE_
DBCONFIG_ ENABLE_ QPSG - SQLITE_
DBCONFIG_ ENABLE_ TRIGGER - SQLITE_
DBCONFIG_ ENABLE_ VIEW - SQLITE_
DBCONFIG_ LEGACY_ ALTER_ TABLE - SQLITE_
DBCONFIG_ LEGACY_ FILE_ FORMAT - SQLITE_
DBCONFIG_ LOOKASIDE - SQLITE_
DBCONFIG_ MAINDBNAME - SQLITE_
DBCONFIG_ MAX - SQLITE_
DBCONFIG_ NO_ CKPT_ ON_ CLOSE - SQLITE_
DBCONFIG_ RESET_ DATABASE - SQLITE_
DBCONFIG_ REVERSE_ SCANORDER - SQLITE_
DBCONFIG_ STMT_ SCANSTATUS - SQLITE_
DBCONFIG_ TRIGGER_ EQP - SQLITE_
DBCONFIG_ TRUSTED_ SCHEMA - SQLITE_
DBCONFIG_ WRITABLE_ SCHEMA - SQLITE_
DBSTATUS_ CACHE_ HIT - SQLITE_
DBSTATUS_ CACHE_ MISS - SQLITE_
DBSTATUS_ CACHE_ SPILL - SQLITE_
DBSTATUS_ CACHE_ USED - SQLITE_
DBSTATUS_ CACHE_ USED_ SHARED - SQLITE_
DBSTATUS_ CACHE_ WRITE - SQLITE_
DBSTATUS_ DEFERRED_ FKS - SQLITE_
DBSTATUS_ LOOKASIDE_ HIT - SQLITE_
DBSTATUS_ LOOKASIDE_ MISS_ FULL - SQLITE_
DBSTATUS_ LOOKASIDE_ MISS_ SIZE - SQLITE_
DBSTATUS_ LOOKASIDE_ USED - SQLITE_
DBSTATUS_ MAX - SQLITE_
DBSTATUS_ SCHEMA_ USED - SQLITE_
DBSTATUS_ STMT_ USED - SQLITE_
DELETE - SQLITE_
DENY - SQLITE_
DESERIALIZE_ FREEONCLOSE - SQLITE_
DESERIALIZE_ READONLY - SQLITE_
DESERIALIZE_ RESIZEABLE - SQLITE_
DETACH - SQLITE_
DETERMINISTIC - SQLITE_
DIRECTONLY - SQLITE_
DONE - SQLITE_
DROP_ INDEX - SQLITE_
DROP_ TABLE - SQLITE_
DROP_ TEMP_ INDEX - SQLITE_
DROP_ TEMP_ TABLE - SQLITE_
DROP_ TEMP_ TRIGGER - SQLITE_
DROP_ TEMP_ VIEW - SQLITE_
DROP_ TRIGGER - SQLITE_
DROP_ VIEW - SQLITE_
DROP_ VTABLE - SQLITE_
EMPTY - SQLITE_
ERROR - SQLITE_
ERROR_ MISSING_ COLLSEQ - SQLITE_
ERROR_ RETRY - SQLITE_
ERROR_ SNAPSHOT - SQLITE_
FAIL - SQLITE_
FCNTL_ BEGIN_ ATOMIC_ WRITE - SQLITE_
FCNTL_ BUSYHANDLER - SQLITE_
FCNTL_ CHUNK_ SIZE - SQLITE_
FCNTL_ CKPT_ DONE - SQLITE_
FCNTL_ CKPT_ START - SQLITE_
FCNTL_ CKSM_ FILE - SQLITE_
FCNTL_ COMMIT_ ATOMIC_ WRITE - SQLITE_
FCNTL_ COMMIT_ PHASETWO - SQLITE_
FCNTL_ DATA_ VERSION - SQLITE_
FCNTL_ EXTERNAL_ READER - SQLITE_
FCNTL_ FILE_ POINTER - SQLITE_
FCNTL_ GET_ LOCKPROXYFILE - SQLITE_
FCNTL_ HAS_ MOVED - SQLITE_
FCNTL_ JOURNAL_ POINTER - SQLITE_
FCNTL_ LAST_ ERRNO - SQLITE_
FCNTL_ LOCKSTATE - SQLITE_
FCNTL_ LOCK_ TIMEOUT - SQLITE_
FCNTL_ MMAP_ SIZE - SQLITE_
FCNTL_ OVERWRITE - SQLITE_
FCNTL_ PDB - SQLITE_
FCNTL_ PERSIST_ WAL - SQLITE_
FCNTL_ POWERSAFE_ OVERWRITE - SQLITE_
FCNTL_ PRAGMA - SQLITE_
FCNTL_ RBU - SQLITE_
FCNTL_ RESERVE_ BYTES - SQLITE_
FCNTL_ RESET_ CACHE - SQLITE_
FCNTL_ ROLLBACK_ ATOMIC_ WRITE - SQLITE_
FCNTL_ SET_ LOCKPROXYFILE - SQLITE_
FCNTL_ SIZE_ HINT - SQLITE_
FCNTL_ SIZE_ LIMIT - SQLITE_
FCNTL_ SYNC - SQLITE_
FCNTL_ SYNC_ OMITTED - SQLITE_
FCNTL_ TEMPFILENAME - SQLITE_
FCNTL_ TRACE - SQLITE_
FCNTL_ VFSNAME - SQLITE_
FCNTL_ VFS_ POINTER - SQLITE_
FCNTL_ WAL_ BLOCK - SQLITE_
FCNTL_ WIN32_ AV_ RETRY - SQLITE_
FCNTL_ WIN32_ GET_ HANDLE - SQLITE_
FCNTL_ WIN32_ SET_ HANDLE - SQLITE_
FCNTL_ ZIPVFS - SQLITE_
FLOAT - SQLITE_
FORMAT - SQLITE_
FULL - SQLITE_
FUNCTION - SQLITE_
GET_ LOCKPROXYFILE - SQLITE_
IGNORE - SQLITE_
INDEX_ CONSTRAINT_ EQ - SQLITE_
INDEX_ CONSTRAINT_ FUNCTION - SQLITE_
INDEX_ CONSTRAINT_ GE - SQLITE_
INDEX_ CONSTRAINT_ GLOB - SQLITE_
INDEX_ CONSTRAINT_ GT - SQLITE_
INDEX_ CONSTRAINT_ IS - SQLITE_
INDEX_ CONSTRAINT_ ISNOT - SQLITE_
INDEX_ CONSTRAINT_ ISNOTNULL - SQLITE_
INDEX_ CONSTRAINT_ ISNULL - SQLITE_
INDEX_ CONSTRAINT_ LE - SQLITE_
INDEX_ CONSTRAINT_ LIKE - SQLITE_
INDEX_ CONSTRAINT_ LIMIT - SQLITE_
INDEX_ CONSTRAINT_ LT - SQLITE_
INDEX_ CONSTRAINT_ MATCH - SQLITE_
INDEX_ CONSTRAINT_ NE - SQLITE_
INDEX_ CONSTRAINT_ OFFSET - SQLITE_
INDEX_ CONSTRAINT_ REGEXP - SQLITE_
INDEX_ SCAN_ HEX - SQLITE_
INDEX_ SCAN_ UNIQUE - SQLITE_
INNOCUOUS - SQLITE_
INSERT - SQLITE_
INTEGER - SQLITE_
INTERNAL - SQLITE_
INTERRUPT - SQLITE_
IOCAP_ ATOMIC - SQLITE_
IOCAP_ ATOMI C1K - SQLITE_
IOCAP_ ATOMI C2K - SQLITE_
IOCAP_ ATOMI C4K - SQLITE_
IOCAP_ ATOMI C8K - SQLITE_
IOCAP_ ATOMI C16K - SQLITE_
IOCAP_ ATOMI C32K - SQLITE_
IOCAP_ ATOMI C64K - SQLITE_
IOCAP_ ATOMI C512 - SQLITE_
IOCAP_ BATCH_ ATOMIC - SQLITE_
IOCAP_ IMMUTABLE - SQLITE_
IOCAP_ POWERSAFE_ OVERWRITE - SQLITE_
IOCAP_ SAFE_ APPEND - SQLITE_
IOCAP_ SEQUENTIAL - SQLITE_
IOCAP_ SUBPAGE_ READ - SQLITE_
IOCAP_ UNDELETABLE_ WHEN_ OPEN - SQLITE_
IOERR - SQLITE_
IOERR_ ACCESS - SQLITE_
IOERR_ AUTH - SQLITE_
IOERR_ BEGIN_ ATOMIC - SQLITE_
IOERR_ BLOCKED - SQLITE_
IOERR_ CHECKRESERVEDLOCK - SQLITE_
IOERR_ CLOSE - SQLITE_
IOERR_ COMMIT_ ATOMIC - SQLITE_
IOERR_ CONVPATH - SQLITE_
IOERR_ CORRUPTFS - SQLITE_
IOERR_ DATA - SQLITE_
IOERR_ DELETE - SQLITE_
IOERR_ DELETE_ NOENT - SQLITE_
IOERR_ DIR_ CLOSE - SQLITE_
IOERR_ DIR_ FSYNC - SQLITE_
IOERR_ FSTAT - SQLITE_
IOERR_ FSYNC - SQLITE_
IOERR_ GETTEMPPATH - SQLITE_
IOERR_ IN_ PAGE - SQLITE_
IOERR_ LOCK - SQLITE_
IOERR_ MMAP - SQLITE_
IOERR_ NOMEM - SQLITE_
IOERR_ RDLOCK - SQLITE_
IOERR_ READ - SQLITE_
IOERR_ ROLLBACK_ ATOMIC - SQLITE_
IOERR_ SEEK - SQLITE_
IOERR_ SHMLOCK - SQLITE_
IOERR_ SHMMAP - SQLITE_
IOERR_ SHMOPEN - SQLITE_
IOERR_ SHMSIZE - SQLITE_
IOERR_ SHORT_ READ - SQLITE_
IOERR_ TRUNCATE - SQLITE_
IOERR_ UNLOCK - SQLITE_
IOERR_ VNODE - SQLITE_
IOERR_ WRITE - SQLITE_
LAST_ ERRNO - SQLITE_
LIMIT_ ATTACHED - SQLITE_
LIMIT_ COLUMN - SQLITE_
LIMIT_ COMPOUND_ SELECT - SQLITE_
LIMIT_ EXPR_ DEPTH - SQLITE_
LIMIT_ FUNCTION_ ARG - SQLITE_
LIMIT_ LENGTH - SQLITE_
LIMIT_ LIKE_ PATTERN_ LENGTH - SQLITE_
LIMIT_ SQL_ LENGTH - SQLITE_
LIMIT_ TRIGGER_ DEPTH - SQLITE_
LIMIT_ VARIABLE_ NUMBER - SQLITE_
LIMIT_ VDBE_ OP - SQLITE_
LIMIT_ WORKER_ THREADS - SQLITE_
LOCKED - SQLITE_
LOCKED_ SHAREDCACHE - SQLITE_
LOCKED_ VTAB - SQLITE_
LOCK_ EXCLUSIVE - SQLITE_
LOCK_ NONE - SQLITE_
LOCK_ PENDING - SQLITE_
LOCK_ RESERVED - SQLITE_
LOCK_ SHARED - SQLITE_
MISMATCH - SQLITE_
MISUSE - SQLITE_
MUTEX_ FAST - SQLITE_
MUTEX_ RECURSIVE - SQLITE_
MUTEX_ STATIC_ APP1 - SQLITE_
MUTEX_ STATIC_ APP2 - SQLITE_
MUTEX_ STATIC_ APP3 - SQLITE_
MUTEX_ STATIC_ LRU - SQLITE_
MUTEX_ STATIC_ LRU2 - SQLITE_
MUTEX_ STATIC_ MAIN - SQLITE_
MUTEX_ STATIC_ MASTER - SQLITE_
MUTEX_ STATIC_ MEM - SQLITE_
MUTEX_ STATIC_ MEM2 - SQLITE_
MUTEX_ STATIC_ OPEN - SQLITE_
MUTEX_ STATIC_ PMEM - SQLITE_
MUTEX_ STATIC_ PRNG - SQLITE_
MUTEX_ STATIC_ VFS1 - SQLITE_
MUTEX_ STATIC_ VFS2 - SQLITE_
MUTEX_ STATIC_ VFS3 - SQLITE_
NOLFS - SQLITE_
NOMEM - SQLITE_
NOTADB - SQLITE_
NOTFOUND - SQLITE_
NOTICE - SQLITE_
NOTICE_ RBU - SQLITE_
NOTICE_ RECOVER_ ROLLBACK - SQLITE_
NOTICE_ RECOVER_ WAL - SQLITE_
NULL - SQLITE_
OK - SQLITE_
OK_ LOAD_ PERMANENTLY - SQLITE_
OK_ SYMLINK - SQLITE_
OPEN_ AUTOPROXY - SQLITE_
OPEN_ CREATE - SQLITE_
OPEN_ DELETEONCLOSE - SQLITE_
OPEN_ EXCLUSIVE - SQLITE_
OPEN_ EXRESCODE - SQLITE_
OPEN_ FULLMUTEX - SQLITE_
OPEN_ MAIN_ DB - SQLITE_
OPEN_ MAIN_ JOURNAL - SQLITE_
OPEN_ MASTER_ JOURNAL - SQLITE_
OPEN_ MEMORY - SQLITE_
OPEN_ NOFOLLOW - SQLITE_
OPEN_ NOMUTEX - SQLITE_
OPEN_ PRIVATECACHE - SQLITE_
OPEN_ READONLY - SQLITE_
OPEN_ READWRITE - SQLITE_
OPEN_ SHAREDCACHE - SQLITE_
OPEN_ SUBJOURNAL - SQLITE_
OPEN_ SUPER_ JOURNAL - SQLITE_
OPEN_ TEMP_ DB - SQLITE_
OPEN_ TEMP_ JOURNAL - SQLITE_
OPEN_ TRANSIENT_ DB - SQLITE_
OPEN_ URI - SQLITE_
OPEN_ WAL - SQLITE_
PERM - SQLITE_
PRAGMA - SQLITE_
PREPARE_ NORMALIZE - SQLITE_
PREPARE_ NO_ VTAB - SQLITE_
PREPARE_ PERSISTENT - SQLITE_
PROTOCOL - SQLITE_
RANGE - SQLITE_
READ - SQLITE_
READONLY - SQLITE_
READONLY_ CANTINIT - SQLITE_
READONLY_ CANTLOCK - SQLITE_
READONLY_ DBMOVED - SQLITE_
READONLY_ DIRECTORY - SQLITE_
READONLY_ RECOVERY - SQLITE_
READONLY_ ROLLBACK - SQLITE_
RECURSIVE - SQLITE_
REINDEX - SQLITE_
REPLACE - SQLITE_
RESULT_ SUBTYPE - SQLITE_
ROLLBACK - SQLITE_
ROW - SQLITE_
SAVEPOINT - SQLITE_
SCANSTAT_ COMPLEX - SQLITE_
SCANSTAT_ EST - SQLITE_
SCANSTAT_ EXPLAIN - SQLITE_
SCANSTAT_ NAME - SQLITE_
SCANSTAT_ NCYCLE - SQLITE_
SCANSTAT_ NLOOP - SQLITE_
SCANSTAT_ NVISIT - SQLITE_
SCANSTAT_ PARENTID - SQLITE_
SCANSTAT_ SELECTID - SQLITE_
SCHEMA - SQLITE_
SELECT - SQLITE_
SELFORDE R1 - SQLITE_
SERIALIZE_ NOCOPY - SQLITE_
SESSION_ CONFIG_ STRMSIZE - SQLITE_
SESSION_ OBJCONFIG_ ROWID - SQLITE_
SESSION_ OBJCONFIG_ SIZE - SQLITE_
SET_ LOCKPROXYFILE - SQLITE_
SHM_ EXCLUSIVE - SQLITE_
SHM_ LOCK - SQLITE_
SHM_ NLOCK - SQLITE_
SHM_ SHARED - SQLITE_
SHM_ UNLOCK - SQLITE_
SOURCE_ ID - SQLITE_
STATUS_ MALLOC_ COUNT - SQLITE_
STATUS_ MALLOC_ SIZE - SQLITE_
STATUS_ MEMORY_ USED - SQLITE_
STATUS_ PAGECACHE_ OVERFLOW - SQLITE_
STATUS_ PAGECACHE_ SIZE - SQLITE_
STATUS_ PAGECACHE_ USED - SQLITE_
STATUS_ PARSER_ STACK - SQLITE_
STATUS_ SCRATCH_ OVERFLOW - SQLITE_
STATUS_ SCRATCH_ SIZE - SQLITE_
STATUS_ SCRATCH_ USED - SQLITE_
STMTSTATUS_ AUTOINDEX - SQLITE_
STMTSTATUS_ FILTER_ HIT - SQLITE_
STMTSTATUS_ FILTER_ MISS - SQLITE_
STMTSTATUS_ FULLSCAN_ STEP - SQLITE_
STMTSTATUS_ MEMUSED - SQLITE_
STMTSTATUS_ REPREPARE - SQLITE_
STMTSTATUS_ RUN - SQLITE_
STMTSTATUS_ SORT - SQLITE_
STMTSTATUS_ VM_ STEP - SQLITE_
SUBTYPE - SQLITE_
SYNC_ DATAONLY - SQLITE_
SYNC_ FULL - SQLITE_
SYNC_ NORMAL - SQLITE_
TESTCTRL_ ALWAYS - SQLITE_
TESTCTRL_ ASSERT - SQLITE_
TESTCTRL_ BENIGN_ MALLOC_ HOOKS - SQLITE_
TESTCTRL_ BITVEC_ TEST - SQLITE_
TESTCTRL_ BYTEORDER - SQLITE_
TESTCTRL_ EXPLAIN_ STMT - SQLITE_
TESTCTRL_ EXTRA_ SCHEMA_ CHECKS - SQLITE_
TESTCTRL_ FAULT_ INSTALL - SQLITE_
TESTCTRL_ FIRST - SQLITE_
TESTCTRL_ FK_ NO_ ACTION - SQLITE_
TESTCTRL_ GETOPT - SQLITE_
TESTCTRL_ IMPOSTER - SQLITE_
TESTCTRL_ INTERNAL_ FUNCTIONS - SQLITE_
TESTCTRL_ ISINIT - SQLITE_
TESTCTRL_ ISKEYWORD - SQLITE_
TESTCTRL_ JSON_ SELFCHECK - SQLITE_
TESTCTRL_ LAST - SQLITE_
TESTCTRL_ LOCALTIME_ FAULT - SQLITE_
TESTCTRL_ LOGEST - SQLITE_
TESTCTRL_ NEVER_ CORRUPT - SQLITE_
TESTCTRL_ ONCE_ RESET_ THRESHOLD - SQLITE_
TESTCTRL_ OPTIMIZATIONS - SQLITE_
TESTCTRL_ PARSER_ COVERAGE - SQLITE_
TESTCTRL_ PENDING_ BYTE - SQLITE_
TESTCTRL_ PRNG_ RESET - SQLITE_
TESTCTRL_ PRNG_ RESTORE - SQLITE_
TESTCTRL_ PRNG_ SAVE - SQLITE_
TESTCTRL_ PRNG_ SEED - SQLITE_
TESTCTRL_ RESERVE - SQLITE_
TESTCTRL_ RESULT_ INTREAL - SQLITE_
TESTCTRL_ SCRATCHMALLOC - SQLITE_
TESTCTRL_ SEEK_ COUNT - SQLITE_
TESTCTRL_ SORTER_ MMAP - SQLITE_
TESTCTRL_ TRACEFLAGS - SQLITE_
TESTCTRL_ TUNE - SQLITE_
TESTCTRL_ USELONGDOUBLE - SQLITE_
TESTCTRL_ VDBE_ COVERAGE - SQLITE_
TEXT - SQLITE_
TOOBIG - SQLITE_
TRACE_ CLOSE - SQLITE_
TRACE_ PROFILE - SQLITE_
TRACE_ ROW - SQLITE_
TRACE_ STMT - SQLITE_
TRANSACTION - SQLITE_
TXN_ NONE - SQLITE_
TXN_ READ - SQLITE_
TXN_ WRITE - SQLITE_
UPDATE - SQLITE_
UTF8 - SQLITE_
UTF16 - SQLITE_
UTF16BE - SQLITE_
UTF16LE - SQLITE_
UTF16_ ALIGNED - SQLITE_
VERSION - SQLITE_
VERSION_ NUMBER - SQLITE_
VTAB_ CONSTRAINT_ SUPPORT - SQLITE_
VTAB_ DIRECTONLY - SQLITE_
VTAB_ INNOCUOUS - SQLITE_
VTAB_ USES_ ALL_ SCHEMAS - SQLITE_
WARNING - SQLITE_
WARNING_ AUTOINDEX - SQLITE_
WIN32_ DATA_ DIRECTORY_ TYPE - SQLITE_
WIN32_ TEMP_ DIRECTORY_ TYPE
Functions§
- SQLITE_
STATIC - SQLITE_
TRANSIENT - code_
to_ str - sqlite3_
aggregate_ ⚠context - Implementations of aggregate SQL functions use this routine to allocate memory for storing their state.
- sqlite3_
bind_ ⚠blob - Bind a
BLOB
value to a parameter in a prepared statement. - sqlite3_
bind_ ⚠blob64 - Bind a
BLOB
value to a parameter in a prepared statement. - sqlite3_
bind_ ⚠double - Bind a double precision floating point number to a parameter in a prepared statement.
- sqlite3_
bind_ ⚠int - Bind an integer number to a parameter in a prepared statement.
- sqlite3_
bind_ ⚠int64 - Bind a 64 bit integer number to a parameter in a prepared statement.
- sqlite3_
bind_ ⚠null - Bind a
NULL
value to a parameter in a prepared statement. - sqlite3_
bind_ ⚠parameter_ count - Used to find the number of SQL parameters in a prepared statement. SQL
parameters are tokens of the form
?
,?NNN
,:AAA
,$AAA
, or@AAA
that serve as placeholders for values that are bound to the parameters at a later time. - sqlite3_
bind_ ⚠parameter_ name - See https://www.sqlite.org/c3ref/bind_parameter_name.html
- sqlite3_
bind_ ⚠pointer - Causes the
idx
-th parameter in prepared statementstmt
to have an SQL value ofNULL
, but to also be associated with the pointerptr
of typetype
.dtor
is either aNULL pointer
or a pointer to a destructor function forptr
. SQLite will invoke the destructordtor
with a single argument ofptr
when it is finished usingptr
. Thetype
parameter should be a static string, preferably a string literal. - sqlite3_
bind_ ⚠text - Bind a
TEXT
value to a parameter in a prepared statement. - sqlite3_
bind_ ⚠text64 - Bind a
TEXT
value to a parameter in a prepared statement. - sqlite3_
busy_ ⚠timeout - Set A Busy Timeout.
- sqlite3_
changes ⚠ - Returns the number of rows modified, inserted or deleted by the most
recently completed
INSERT
,UPDATE
orDELETE
statement on the database connection specified by the only parameter. Executing any other type of SQL statement does not modify the value returned by these functions.REturn
value is undefined if the number of changes is bigger than 32 bits. Usesqlite3_changes64()
instead in these cases. - sqlite3_
clear_ ⚠bindings - Use this routine to reset all host parameters to NULL.
- sqlite3_
close ⚠ - Destructor for the
sqlite3
object. - sqlite3_
close_ ⚠v2 - Destructor for the
sqlite3
object. - sqlite3_
column_ ⚠blob - Get a BLOB result value from a column in the current result row.
- sqlite3_
column_ ⚠bytes - Returns the initial data type of the result column in the current result row.
- sqlite3_
column_ ⚠count - Returns the number of columns in the result set returned by the prepared statement.
- sqlite3_
column_ ⚠database_ name - These routines provide a means to determine the database, table, and table column that is the origin of a particular result column in SELECT statement.
- sqlite3_
column_ ⚠decltype - See https://www.sqlite.org/c3ref/column_decltype.html
- sqlite3_
column_ ⚠double - Get a double precision floating point result value from a column in the current result row.
- sqlite3_
column_ ⚠int - Get an integer result value from a column in the current result row.
- sqlite3_
column_ ⚠int64 - Get a 64bit integer result value from a column in the current result row.
- sqlite3_
column_ ⚠name - Returns the name assigned to a particular column in the result set of a
SELECT statement
. - sqlite3_
column_ ⚠origin_ name - These routines provide a means to determine the database, table, and table column that is the origin of a particular result column in SELECT statement.
- sqlite3_
column_ ⚠table_ name - These routines provide a means to determine the database, table, and table column that is the origin of a particular result column in SELECT statement.
- sqlite3_
column_ ⚠type - Get the length in bytes of a
BLOB
orTEXT
column in the current result row. - sqlite3_
column_ ⚠value - Get a
sql_value*
result value from a column in the current result row. - sqlite3_
commit_ ⚠hook - Registers a callback function to be invoked whenever a transaction is
committed. Any callback set by a previous call to
sqlite3_commit_hook()
for the same database connection is overridden. - sqlite3_
config ⚠ - Used to make global configuration changes to
SQLite
in order to tune SQLite to the specific needs of the application. The default configuration is recommended for most applications and so this routine is usually not necessary. It is provided to support rare applications with unusual needs. - sqlite3_
context_ ⚠db_ handle - Returns a copy of the pointer to the database connection (the 1st
parameter) of the
sqlite3_create_function()
routine that originally registered the application defined function. - sqlite3_
create_ ⚠collation_ v2 - Add a collation to a database connection.
- sqlite3_
create_ ⚠function_ v2 - Add SQL function or aggregation or redefine the behavior of an existing SQL function or aggregation.
- sqlite3_
db_ ⚠handle - Returns the database connection handle to which a prepared statement
belongs. The database connection returned by
sqlite3_db_handle
is the same database connection that was the first argument to thesqlite3_prepare_v2()
call (or its variants) that was used to create the statement in the first place. - sqlite3_
deserialize ⚠ - Causes the database connection
db
to disconnect from databaseschema
and then reopenschema
as an in-memory database based on the serialization contained indata
. The serialized databasedata
isdbSize
bytes in size.bufferSize
is the size of the bufferdata
, which might be larger thandbSize
. IfbufferSize
is larger thandbSize
, and theSQLITE_DESERIALIZE_READONLY
bit is not set inflags
, thenSQLite
is permitted to add content to the in-memory database as long as the total size does not exceedbufferSize
bytes. - sqlite3_
errmsg ⚠ - If the most recent
sqlite3_*
API call associated with database connectiondb
failed, then thesqlite3_errmsg(db)
interface returns English- language text that describes the error. - sqlite3_
exec ⚠ - A convenience wrapper around
sqlite3_prepare_v2()
,sqlite3_step()
, andsqlite3_finalize()
, that allows an application to run multiple statements of SQL without having to use a lot of C code. - sqlite3_
extended_ ⚠errcode - If the most recent
sqlite3_*
API call associated with database connectiondb
failed, then thesqlite3_extended_errcode(db)
interface returns the extended result code for that API call, even when extended result codes are disabled. - sqlite3_
extended_ ⚠result_ codes - Enables or disables the
extended result codes
feature of SQLite. The extended result codes are disabled by default for historical compatibility. - sqlite3_
finalize ⚠ - The
sqlite3_finalize()
function is called to delete a prepared statement. If the most recent evaluation of the statement encountered no errors or if the statement is never been evaluated, thensqlite3_finalize()
returnsSQLITE_OK
. If the most recent evaluation of statementstmt
failed, thensqlite3_finalize(stmt)
returns the appropriate error code or extended error code. - sqlite3_
free ⚠ - Calling
sqlite3_free()
with a pointer previously returned bysqlite3_malloc()
orsqlite3_realloc()
releases that memory so that it might be reused. - sqlite3_
get_ ⚠auxdata - Returns a pointer to the metadata associated by the
sqlite3_set_auxdata(ctx, n , pAux, xDelete)
function with then
th argument value to the application-defined function.n
is zero for the left-most function argument. - sqlite3_
interrupt ⚠ - See https://www.sqlite.org/c3ref/interrupt.html
- sqlite3_
last_ ⚠insert_ rowid - Usually returns the
rowid
of the most recent successfulINSERT
into a rowid table or virtual table on database connectiondb
. Inserts intoWITHOUT ROWID
tables are not recorded. If no successfulINSERT
s into rowid tables have ever occurred on the database connectiondb
, thensqlite3_last_insert_rowid(db)
returns zero - sqlite3_
memory_ ⚠highwater - Return the maximum amount of memory that has ever been checked out since either the beginning of this process or since the most recent reset.
- sqlite3_
memory_ ⚠used - Return the amount of memory currently checked out.
- sqlite3_
open ⚠ - Open an
SQLite
database file as specified by thefilename
argument - sqlite3_
open_ ⚠v2 - Open an
SQLite
database file as specified by thefilename
argument and support opfs vfs on wasm platform. - sqlite3_
prepare_ ⚠v2 - Compiles a prepared statement.
- sqlite3_
prepare_ ⚠v3 - Compiles a prepared statement.
- sqlite3_
progress_ ⚠handler - Causes the callback function
callback
to be invoked periodically during long running calls tosqlite3_step()
andsqlite3_prepare()
and similar for database connectiondb
. An example use for this interface is to keep a GUI updated during a large query. - sqlite3_
reset ⚠ - Called to reset a [prepared statement] object back to its initial state,
ready to be re-executed. Any SQL statement variables that had values bound
to them using the
sqlite3_bind_*()
API retain their values. Usesqlite3_clear_bindings()
to reset the bindings. - sqlite3_
result_ ⚠blob - Sets the result from an application-defined function to be the
BLOB
whose content is pointed to by the second parameter and which isblobLen
bytes long. - sqlite3_
result_ ⚠double - Sets the result from an application-defined function to be a floating point value specified by its 2nd argument.
- sqlite3_
result_ ⚠error - Cause the implemented SQL function to throw an exception.
- sqlite3_
result_ ⚠int - Sets the return value of the application-defined function to be the 32-bit signed integer value given in the 2nd argument.
- sqlite3_
result_ ⚠int64 - Sets the return value of the application-defined function to be the 64-bit signed integer value given in the 2nd argument.
- sqlite3_
result_ ⚠null - Sets the return value of the application-defined function to be
NULL
. - sqlite3_
result_ ⚠text - Set the return value of the application-defined function to be a text string
- sqlite3_
rollback_ ⚠hook - The
sqlite3_rollback_hook()
interface registers a callback function to be invoked whenever a transaction is rolled back. Any callback set by a previous call tosqlite3_rollback_hook()
for the same database connection is overridden. - sqlite3_
serialize ⚠ - Returns a pointer to memory that is a serialization of the
schema
database on database connectiondb
. IfpiSize
is not a NULL pointer, then the size of the database in bytes is written into*piSize
. - sqlite3_
set_ ⚠auxdata - Saves
pAux
as metadata for then
-th argument of the application-defined function. - sqlite3_
sql ⚠ - Returns a pointer to a copy of the UTF-8 SQL text used to create prepared
statement
stmt
ifstmt
was created bysqlite3_prepare_v2()
orsqlite3_prepare_v3()
. - sqlite3_
status ⚠ - Used to retrieve runtime status information about the performance of
SQLite
, and optionally to reset various highwater marks. - sqlite3_
status64 ⚠ - Used to retrieve runtime status information about the performance of
SQLite
, and optionally to reset various highwater marks. - sqlite3_
step ⚠ - After a prepared statement has been prepared using any of
sqlite3_prepare_v2()
,sqlite3_prepare_v3()
,sqlite3_prepare16_v2()
, orsqlite3_prepare16_v3()
or one of the legacy interfacessqlite3_prepare()
orsqlite3_prepare16()
, this function must be called one or more times to evaluate the statement. - sqlite3_
stmt_ ⚠readonly - Returns true (non-zero) if and only if the prepared statement
stmt
makes no direct changes to the content of the database file. - sqlite3_
table_ ⚠column_ metadata - Returns information about column
colName
of tabletblName
in databasedbName
on database connectiondb
. Thesqlite3_table_column_metadata()
interface returnsSQLITE_OK
and fills in the non-NULL pointers in the final five arguments with appropriate values if the specified column exists. Thesqlite3_table_column_metadata()
interface returnsSQLITE_ERROR
if the specified column does not exist. - sqlite3_
update_ ⚠hook - Registers a callback function with the database connection identified by the first argument to be invoked whenever a row is updated, inserted or deleted in a rowid table. Any callback set by a previous call to this function for the same database connection is overridden.
- sqlite3_
user_ ⚠data - Returns a copy of the pointer that was the
pUserData
parameter (the 5th parameter) of thesqlite3_create_function()
routine that originally registered the application defined function. - sqlite3_
value_ ⚠blob - Extract a
BLOB
value from a protectedsqlite3_value
object. - sqlite3_
value_ ⚠bytes - Get the size of a
BLOB
orTEXT
value in bytes from a protectedsqlite3_value
object. - sqlite3_
value_ ⚠double - Extract a
REAL
value from a protectedsqlite3_value
object. - sqlite3_
value_ ⚠dup - Makes a copy of the
sqlite3_value
objectsqliteValue
and returns a pointer to that copy. Thesqlite3_value
returned is a protectedsqlite3_value
object even if the input is not. If `sqliteValue is a pointer value, then the result is a NULL value. - sqlite3_
value_ ⚠free - Frees an
sqlite3_value
object previously obtained fromsqlite3_value_dup()
. - sqlite3_
value_ ⚠int - Extract a
INTEGER
value from a protectedsqlite3_value
object. - sqlite3_
value_ ⚠int64 - Extract a 64-bit
INTEGER
value from a protectedsqlite3_value
object. - sqlite3_
value_ ⚠text - Extract a
TEXT
value from a protectedsqlite3_value
object. - sqlite3_
value_ ⚠type - Get the default datatype of the value from a protected
sqlite3_value
object.