sl@0: /* sl@0: ** 2001 September 15 sl@0: ** sl@0: ** The author disclaims copyright to this source code. In place of sl@0: ** a legal notice, here is a blessing: sl@0: ** sl@0: ** May you do good and not evil. sl@0: ** May you find forgiveness for yourself and forgive others. sl@0: ** May you share freely, never taking more than you give. sl@0: ** sl@0: ************************************************************************* sl@0: ** This header file defines the interface that the SQLite library sl@0: ** presents to client programs. If a C-function, structure, datatype, sl@0: ** or constant definition does not appear in this file, then it is sl@0: ** not a published API of SQLite, is subject to change without sl@0: ** notice, and should not be referenced by programs that use SQLite. sl@0: ** sl@0: ** Some of the definitions that are in this file are marked as sl@0: ** "experimental". Experimental interfaces are normally new sl@0: ** features recently added to SQLite. We do not anticipate changes sl@0: ** to experimental interfaces but reserve to make minor changes if sl@0: ** experience from use "in the wild" suggest such changes are prudent. sl@0: ** sl@0: ** The official C-language API documentation for SQLite is derived sl@0: ** from comments in this file. This file is the authoritative source sl@0: ** on how SQLite interfaces are suppose to operate. sl@0: ** sl@0: ** The name of this file under configuration management is "sqlite.h.in". sl@0: ** The makefile makes some minor changes to this file (such as inserting sl@0: ** the version number) and changes its name to "sqlite3.h" as sl@0: ** part of the build process. sl@0: ** sl@0: ** @(#) $Id: sqlite.h.in,v 1.387 2008/08/05 17:53:23 drh Exp $ sl@0: */ sl@0: #ifndef _SQLITE3_H_ sl@0: #define _SQLITE3_H_ sl@0: #include /* Needed for the definition of va_list */ sl@0: sl@0: /* sl@0: ** Make sure we can call this stuff from C++. sl@0: */ sl@0: #ifdef __cplusplus sl@0: extern "C" { sl@0: #endif sl@0: sl@0: sl@0: /* sl@0: ** Add the ability to override 'extern' sl@0: */ sl@0: #ifndef SQLITE_EXTERN sl@0: # define SQLITE_EXTERN extern sl@0: #endif sl@0: sl@0: /* sl@0: ** Ensure these symbols were not defined by some previous header file. sl@0: */ sl@0: #ifdef SQLITE_VERSION sl@0: # undef SQLITE_VERSION sl@0: #endif sl@0: #ifdef SQLITE_VERSION_NUMBER sl@0: # undef SQLITE_VERSION_NUMBER sl@0: #endif sl@0: sl@0: /* sl@0: ** CAPI3REF: Compile-Time Library Version Numbers {H10010} sl@0: ** sl@0: ** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in sl@0: ** the sqlite3.h file specify the version of SQLite with which sl@0: ** that header file is associated. sl@0: ** sl@0: ** The "version" of SQLite is a string of the form "X.Y.Z". sl@0: ** The phrase "alpha" or "beta" might be appended after the Z. sl@0: ** The X value is major version number always 3 in SQLite3. sl@0: ** The X value only changes when backwards compatibility is sl@0: ** broken and we intend to never break backwards compatibility. sl@0: ** The Y value is the minor version number and only changes when sl@0: ** there are major feature enhancements that are forwards compatible sl@0: ** but not backwards compatible. sl@0: ** The Z value is the release number and is incremented with sl@0: ** each release but resets back to 0 whenever Y is incremented. sl@0: ** sl@0: ** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10011} The SQLITE_VERSION #define in the sqlite3.h header file shall sl@0: ** evaluate to a string literal that is the SQLite version sl@0: ** with which the header file is associated. sl@0: ** sl@0: ** {H10014} The SQLITE_VERSION_NUMBER #define shall resolve to an integer sl@0: ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z sl@0: ** are the major version, minor version, and release number. sl@0: */ sl@0: #define SQLITE_VERSION "3.6.1" sl@0: #define SQLITE_VERSION_NUMBER 3006001 sl@0: sl@0: /* sl@0: ** CAPI3REF: Run-Time Library Version Numbers {H10020} sl@0: ** KEYWORDS: sqlite3_version sl@0: ** sl@0: ** These features provide the same information as the [SQLITE_VERSION] sl@0: ** and [SQLITE_VERSION_NUMBER] #defines in the header, but are associated sl@0: ** with the library instead of the header file. Cautious programmers might sl@0: ** include a check in their application to verify that sl@0: ** sqlite3_libversion_number() always returns the value sl@0: ** [SQLITE_VERSION_NUMBER]. sl@0: ** sl@0: ** The sqlite3_libversion() function returns the same information as is sl@0: ** in the sqlite3_version[] string constant. The function is provided sl@0: ** for use in DLLs since DLL users usually do not have direct access to string sl@0: ** constants within the DLL. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10021} The [sqlite3_libversion_number()] interface shall return sl@0: ** an integer equal to [SQLITE_VERSION_NUMBER]. sl@0: ** sl@0: ** {H10022} The [sqlite3_version] string constant shall contain sl@0: ** the text of the [SQLITE_VERSION] string. sl@0: ** sl@0: ** {H10023} The [sqlite3_libversion()] function shall return sl@0: ** a pointer to the [sqlite3_version] string constant. sl@0: */ sl@0: SQLITE_EXTERN const char sqlite3_version[]; sl@0: const char *sqlite3_libversion(void); sl@0: int sqlite3_libversion_number(void); sl@0: sl@0: /* sl@0: ** CAPI3REF: Test To See If The Library Is Threadsafe {H10100} sl@0: ** sl@0: ** SQLite can be compiled with or without mutexes. When sl@0: ** the [SQLITE_THREADSAFE] C preprocessor macro is true, mutexes sl@0: ** are enabled and SQLite is threadsafe. When that macro is false, sl@0: ** the mutexes are omitted. Without the mutexes, it is not safe sl@0: ** to use SQLite concurrently from more than one thread. sl@0: ** sl@0: ** Enabling mutexes incurs a measurable performance penalty. sl@0: ** So if speed is of utmost importance, it makes sense to disable sl@0: ** the mutexes. But for maximum safety, mutexes should be enabled. sl@0: ** The default behavior is for mutexes to be enabled. sl@0: ** sl@0: ** This interface can be used by a program to make sure that the sl@0: ** version of SQLite that it is linking against was compiled with sl@0: ** the desired setting of the [SQLITE_THREADSAFE] macro. sl@0: ** sl@0: ** This interface only reports on the compile-time mutex setting sl@0: ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with sl@0: ** SQLITE_THREADSAFE=1 then mutexes are enabled by default but sl@0: ** can be fully or partially disabled using a call to [sqlite3_config()] sl@0: ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], sl@0: ** or [SQLITE_CONFIG_MUTEX]. The return value of this function shows sl@0: ** only the default compile-time setting, not any run-time changes sl@0: ** to that setting. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10101} The [sqlite3_threadsafe()] function shall return nonzero if sl@0: ** SQLite was compiled with the its mutexes enabled by default sl@0: ** or zero if SQLite was compiled such that mutexes are sl@0: ** permanently disabled. sl@0: ** sl@0: ** {H10102} The value returned by the [sqlite3_threadsafe()] function sl@0: ** shall not change when mutex setting are modified at sl@0: ** runtime using the [sqlite3_config()] interface and sl@0: ** especially the [SQLITE_CONFIG_SINGLETHREAD], sl@0: ** [SQLITE_CONFIG_MULTITHREAD], [SQLITE_CONFIG_SERIALIZED], sl@0: ** and [SQLITE_CONFIG_MUTEX] verbs. sl@0: */ sl@0: int sqlite3_threadsafe(void); sl@0: sl@0: /* sl@0: ** CAPI3REF: Database Connection Handle {H12000} sl@0: ** KEYWORDS: {database connection} {database connections} sl@0: ** sl@0: ** Each open SQLite database is represented by a pointer to an instance of sl@0: ** the opaque structure named "sqlite3". It is useful to think of an sqlite3 sl@0: ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and sl@0: ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] sl@0: ** is its destructor. There are many other interfaces (such as sl@0: ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and sl@0: ** [sqlite3_busy_timeout()] to name but three) that are methods on an sl@0: ** sqlite3 object. sl@0: */ sl@0: typedef struct sqlite3 sqlite3; sl@0: sl@0: /* sl@0: ** CAPI3REF: 64-Bit Integer Types {H10200} sl@0: ** KEYWORDS: sqlite_int64 sqlite_uint64 sl@0: ** sl@0: ** Because there is no cross-platform way to specify 64-bit integer types sl@0: ** SQLite includes typedefs for 64-bit signed and unsigned integers. sl@0: ** sl@0: ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. sl@0: ** The sqlite_int64 and sqlite_uint64 types are supported for backwards sl@0: ** compatibility only. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10201} The [sqlite_int64] and [sqlite3_int64] type shall specify sl@0: ** a 64-bit signed integer. sl@0: ** sl@0: ** {H10202} The [sqlite_uint64] and [sqlite3_uint64] type shall specify sl@0: ** a 64-bit unsigned integer. sl@0: */ sl@0: #ifdef SQLITE_INT64_TYPE sl@0: typedef SQLITE_INT64_TYPE sqlite_int64; sl@0: typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; sl@0: #elif defined(_MSC_VER) || defined(__BORLANDC__) sl@0: typedef __int64 sqlite_int64; sl@0: typedef unsigned __int64 sqlite_uint64; sl@0: #else sl@0: typedef long long int sqlite_int64; sl@0: typedef unsigned long long int sqlite_uint64; sl@0: #endif sl@0: typedef sqlite_int64 sqlite3_int64; sl@0: typedef sqlite_uint64 sqlite3_uint64; sl@0: sl@0: /* sl@0: ** If compiling for a processor that lacks floating point support, sl@0: ** substitute integer for floating-point. sl@0: */ sl@0: #ifdef SQLITE_OMIT_FLOATING_POINT sl@0: # define double sqlite3_int64 sl@0: #endif sl@0: sl@0: /* sl@0: ** CAPI3REF: Closing A Database Connection {H12010} sl@0: ** sl@0: ** This routine is the destructor for the [sqlite3] object. sl@0: ** sl@0: ** Applications should [sqlite3_finalize | finalize] all [prepared statements] sl@0: ** and [sqlite3_blob_close | close] all [BLOB handles] associated with sl@0: ** the [sqlite3] object prior to attempting to close the object. sl@0: ** The [sqlite3_next_stmt()] interface can be used to locate all sl@0: ** [prepared statements] associated with a [database connection] if desired. sl@0: ** Typical code might look like this: sl@0: ** sl@0: ** 
sl@0: ** sqlite3_stmt *pStmt;
sl@0: ** while( (pStmt = sqlite3_next_stmt(db, 0))!=0 ){
sl@0: **     sqlite3_finalize(pStmt);
sl@0: ** }
sl@0: **
sl@0: ** sl@0: ** If [sqlite3_close()] is invoked while a transaction is open, sl@0: ** the transaction is automatically rolled back. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12011} A successful call to [sqlite3_close(C)] shall destroy the sl@0: ** [database connection] object C. sl@0: ** sl@0: ** {H12012} A successful call to [sqlite3_close(C)] shall return SQLITE_OK. sl@0: ** sl@0: ** {H12013} A successful call to [sqlite3_close(C)] shall release all sl@0: ** memory and system resources associated with [database connection] sl@0: ** C. sl@0: ** sl@0: ** {H12014} A call to [sqlite3_close(C)] on a [database connection] C that sl@0: ** has one or more open [prepared statements] shall fail with sl@0: ** an [SQLITE_BUSY] error code. sl@0: ** sl@0: ** {H12015} A call to [sqlite3_close(C)] where C is a NULL pointer shall sl@0: ** return SQLITE_OK. sl@0: ** sl@0: ** {H12019} When [sqlite3_close(C)] is invoked on a [database connection] C sl@0: ** that has a pending transaction, the transaction shall be sl@0: ** rolled back. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12016} The C parameter to [sqlite3_close(C)] must be either a NULL sl@0: ** pointer or an [sqlite3] object pointer obtained sl@0: ** from [sqlite3_open()], [sqlite3_open16()], or sl@0: ** [sqlite3_open_v2()], and not previously closed. sl@0: */ sl@0: int sqlite3_close(sqlite3 *); sl@0: sl@0: /* sl@0: ** The type for a callback function. sl@0: ** This is legacy and deprecated. It is included for historical sl@0: ** compatibility and is not documented. sl@0: */ sl@0: typedef int (*sqlite3_callback)(void*,int,char**, char**); sl@0: sl@0: /* sl@0: ** CAPI3REF: One-Step Query Execution Interface {H12100} sl@0: ** sl@0: ** The sqlite3_exec() interface is a convenient way of running one or more sl@0: ** SQL statements without having to write a lot of C code. The UTF-8 encoded sl@0: ** SQL statements are passed in as the second parameter to sqlite3_exec(). sl@0: ** The statements are evaluated one by one until either an error or sl@0: ** an interrupt is encountered, or until they are all done. The 3rd parameter sl@0: ** is an optional callback that is invoked once for each row of any query sl@0: ** results produced by the SQL statements. The 5th parameter tells where sl@0: ** to write any error messages. sl@0: ** sl@0: ** The error message passed back through the 5th parameter is held sl@0: ** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak, sl@0: ** the calling application should call [sqlite3_free()] on any error sl@0: ** message returned through the 5th parameter when it has finished using sl@0: ** the error message. sl@0: ** sl@0: ** If the SQL statement in the 2nd parameter is NULL or an empty string sl@0: ** or a string containing only whitespace and comments, then no SQL sl@0: ** statements are evaluated and the database is not changed. sl@0: ** sl@0: ** The sqlite3_exec() interface is implemented in terms of sl@0: ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. sl@0: ** The sqlite3_exec() routine does nothing to the database that cannot be done sl@0: ** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12101} A successful invocation of [sqlite3_exec(D,S,C,A,E)] sl@0: ** shall sequentially evaluate all of the UTF-8 encoded, sl@0: ** semicolon-separated SQL statements in the zero-terminated sl@0: ** string S within the context of the [database connection] D. sl@0: ** sl@0: ** {H12102} If the S parameter to [sqlite3_exec(D,S,C,A,E)] is NULL then sl@0: ** the actions of the interface shall be the same as if the sl@0: ** S parameter were an empty string. sl@0: ** sl@0: ** {H12104} The return value of [sqlite3_exec()] shall be [SQLITE_OK] if all sl@0: ** SQL statements run successfully and to completion. sl@0: ** sl@0: ** {H12105} The return value of [sqlite3_exec()] shall be an appropriate sl@0: ** non-zero [error code] if any SQL statement fails. sl@0: ** sl@0: ** {H12107} If one or more of the SQL statements handed to [sqlite3_exec()] sl@0: ** return results and the 3rd parameter is not NULL, then sl@0: ** the callback function specified by the 3rd parameter shall be sl@0: ** invoked once for each row of result. sl@0: ** sl@0: ** {H12110} If the callback returns a non-zero value then [sqlite3_exec()] sl@0: ** shall abort the SQL statement it is currently evaluating, sl@0: ** skip all subsequent SQL statements, and return [SQLITE_ABORT]. sl@0: ** sl@0: ** {H12113} The [sqlite3_exec()] routine shall pass its 4th parameter through sl@0: ** as the 1st parameter of the callback. sl@0: ** sl@0: ** {H12116} The [sqlite3_exec()] routine shall set the 2nd parameter of its sl@0: ** callback to be the number of columns in the current row of sl@0: ** result. sl@0: ** sl@0: ** {H12119} The [sqlite3_exec()] routine shall set the 3rd parameter of its sl@0: ** callback to be an array of pointers to strings holding the sl@0: ** values for each column in the current result set row as sl@0: ** obtained from [sqlite3_column_text()]. sl@0: ** sl@0: ** {H12122} The [sqlite3_exec()] routine shall set the 4th parameter of its sl@0: ** callback to be an array of pointers to strings holding the sl@0: ** names of result columns as obtained from [sqlite3_column_name()]. sl@0: ** sl@0: ** {H12125} If the 3rd parameter to [sqlite3_exec()] is NULL then sl@0: ** [sqlite3_exec()] shall silently discard query results. sl@0: ** sl@0: ** {H12131} If an error occurs while parsing or evaluating any of the SQL sl@0: ** statements in the S parameter of [sqlite3_exec(D,S,C,A,E)] and if sl@0: ** the E parameter is not NULL, then [sqlite3_exec()] shall store sl@0: ** in *E an appropriate error message written into memory obtained sl@0: ** from [sqlite3_malloc()]. sl@0: ** sl@0: ** {H12134} The [sqlite3_exec(D,S,C,A,E)] routine shall set the value of sl@0: ** *E to NULL if E is not NULL and there are no errors. sl@0: ** sl@0: ** {H12137} The [sqlite3_exec(D,S,C,A,E)] function shall set the [error code] sl@0: ** and message accessible via [sqlite3_errcode()], sl@0: ** [sqlite3_errmsg()], and [sqlite3_errmsg16()]. sl@0: ** sl@0: ** {H12138} If the S parameter to [sqlite3_exec(D,S,C,A,E)] is NULL or an sl@0: ** empty string or contains nothing other than whitespace, comments, sl@0: ** and/or semicolons, then results of [sqlite3_errcode()], sl@0: ** [sqlite3_errmsg()], and [sqlite3_errmsg16()] sl@0: ** shall reset to indicate no errors. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12141} The first parameter to [sqlite3_exec()] must be an valid and open sl@0: ** [database connection]. sl@0: ** sl@0: ** {A12142} The database connection must not be closed while sl@0: ** [sqlite3_exec()] is running. sl@0: ** sl@0: ** {A12143} The calling function should use [sqlite3_free()] to free sl@0: ** the memory that *errmsg is left pointing at once the error sl@0: ** message is no longer needed. sl@0: ** sl@0: ** {A12145} The SQL statement text in the 2nd parameter to [sqlite3_exec()] sl@0: ** must remain unchanged while [sqlite3_exec()] is running. sl@0: */ sl@0: int sqlite3_exec( sl@0: sqlite3*, /* An open database */ sl@0: const char *sql, /* SQL to be evaluated */ sl@0: int (*callback)(void*,int,char**,char**), /* Callback function */ sl@0: void *, /* 1st argument to callback */ sl@0: char **errmsg /* Error msg written here */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Result Codes {H10210} sl@0: ** KEYWORDS: SQLITE_OK {error code} {error codes} sl@0: ** KEYWORDS: {result code} {result codes} sl@0: ** sl@0: ** Many SQLite functions return an integer result code from the set shown sl@0: ** here in order to indicates success or failure. sl@0: ** sl@0: ** New error codes may be added in future versions of SQLite. sl@0: ** sl@0: ** See also: [SQLITE_IOERR_READ | extended result codes] sl@0: */ sl@0: #define SQLITE_OK 0 /* Successful result */ sl@0: /* beginning-of-error-codes */ sl@0: #define SQLITE_ERROR 1 /* SQL error or missing database */ sl@0: #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ sl@0: #define SQLITE_PERM 3 /* Access permission denied */ sl@0: #define SQLITE_ABORT 4 /* Callback routine requested an abort */ sl@0: #define SQLITE_BUSY 5 /* The database file is locked */ sl@0: #define SQLITE_LOCKED 6 /* A table in the database is locked */ sl@0: #define SQLITE_NOMEM 7 /* A malloc() failed */ sl@0: #define SQLITE_READONLY 8 /* Attempt to write a readonly database */ sl@0: #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ sl@0: #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ sl@0: #define SQLITE_CORRUPT 11 /* The database disk image is malformed */ sl@0: #define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */ sl@0: #define SQLITE_FULL 13 /* Insertion failed because database is full */ sl@0: #define SQLITE_CANTOPEN 14 /* Unable to open the database file */ sl@0: #define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */ sl@0: #define SQLITE_EMPTY 16 /* Database is empty */ sl@0: #define SQLITE_SCHEMA 17 /* The database schema changed */ sl@0: #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ sl@0: #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ sl@0: #define SQLITE_MISMATCH 20 /* Data type mismatch */ sl@0: #define SQLITE_MISUSE 21 /* Library used incorrectly */ sl@0: #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ sl@0: #define SQLITE_AUTH 23 /* Authorization denied */ sl@0: #define SQLITE_FORMAT 24 /* Auxiliary database format error */ sl@0: #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ sl@0: #define SQLITE_NOTADB 26 /* File opened that is not a database file */ sl@0: #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ sl@0: #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ sl@0: /* end-of-error-codes */ sl@0: sl@0: /* sl@0: ** CAPI3REF: Extended Result Codes {H10220} sl@0: ** KEYWORDS: {extended error code} {extended error codes} sl@0: ** KEYWORDS: {extended result code} {extended result codes} sl@0: ** sl@0: ** In its default configuration, SQLite API routines return one of 26 integer sl@0: ** [SQLITE_OK | result codes]. However, experience has shown that many of sl@0: ** these result codes are too coarse-grained. They do not provide as sl@0: ** much information about problems as programmers might like. In an effort to sl@0: ** address this, newer versions of SQLite (version 3.3.8 and later) include sl@0: ** support for additional result codes that provide more detailed information sl@0: ** about errors. The extended result codes are enabled or disabled sl@0: ** on a per database connection basis using the sl@0: ** [sqlite3_extended_result_codes()] API. sl@0: ** sl@0: ** Some of the available extended result codes are listed here. sl@0: ** One may expect the number of extended result codes will be expand sl@0: ** over time. Software that uses extended result codes should expect sl@0: ** to see new result codes in future releases of SQLite. sl@0: ** sl@0: ** The SQLITE_OK result code will never be extended. It will always sl@0: ** be exactly zero. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10223} The symbolic name for an extended result code shall contains sl@0: ** a related primary result code as a prefix. sl@0: ** sl@0: ** {H10224} Primary result code names shall contain a single "_" character. sl@0: ** sl@0: ** {H10225} Extended result code names shall contain two or more "_" characters. sl@0: ** sl@0: ** {H10226} The numeric value of an extended result code shall contain the sl@0: ** numeric value of its corresponding primary result code in sl@0: ** its least significant 8 bits. sl@0: */ sl@0: #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) sl@0: #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) sl@0: #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) sl@0: #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) sl@0: #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) sl@0: #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) sl@0: #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) sl@0: #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) sl@0: #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) sl@0: #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) sl@0: #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) sl@0: #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) sl@0: #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) sl@0: #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) sl@0: sl@0: /* sl@0: ** CAPI3REF: Flags For File Open Operations {H10230} sl@0: ** sl@0: ** These bit values are intended for use in the sl@0: ** 3rd parameter to the [sqlite3_open_v2()] interface and sl@0: ** in the 4th parameter to the xOpen method of the sl@0: ** [sqlite3_vfs] object. sl@0: */ sl@0: #define SQLITE_OPEN_READONLY 0x00000001 sl@0: #define SQLITE_OPEN_READWRITE 0x00000002 sl@0: #define SQLITE_OPEN_CREATE 0x00000004 sl@0: #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 sl@0: #define SQLITE_OPEN_EXCLUSIVE 0x00000010 sl@0: #define SQLITE_OPEN_MAIN_DB 0x00000100 sl@0: #define SQLITE_OPEN_TEMP_DB 0x00000200 sl@0: #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 sl@0: #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 sl@0: #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 sl@0: #define SQLITE_OPEN_SUBJOURNAL 0x00002000 sl@0: #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 sl@0: #define SQLITE_OPEN_NOMUTEX 0x00008000 sl@0: sl@0: /* sl@0: ** CAPI3REF: Device Characteristics {H10240} sl@0: ** sl@0: ** The xDeviceCapabilities method of the [sqlite3_io_methods] sl@0: ** object returns an integer which is a vector of the these sl@0: ** bit values expressing I/O characteristics of the mass storage sl@0: ** device that holds the file that the [sqlite3_io_methods] sl@0: ** refers to. sl@0: ** sl@0: ** The SQLITE_IOCAP_ATOMIC property means that all writes of sl@0: ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values sl@0: ** mean that writes of blocks that are nnn bytes in size and sl@0: ** are aligned to an address which is an integer multiple of sl@0: ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means sl@0: ** that when data is appended to a file, the data is appended sl@0: ** first then the size of the file is extended, never the other sl@0: ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that sl@0: ** information is written to disk in the same order as calls sl@0: ** to xWrite(). sl@0: */ sl@0: #define SQLITE_IOCAP_ATOMIC 0x00000001 sl@0: #define SQLITE_IOCAP_ATOMIC512 0x00000002 sl@0: #define SQLITE_IOCAP_ATOMIC1K 0x00000004 sl@0: #define SQLITE_IOCAP_ATOMIC2K 0x00000008 sl@0: #define SQLITE_IOCAP_ATOMIC4K 0x00000010 sl@0: #define SQLITE_IOCAP_ATOMIC8K 0x00000020 sl@0: #define SQLITE_IOCAP_ATOMIC16K 0x00000040 sl@0: #define SQLITE_IOCAP_ATOMIC32K 0x00000080 sl@0: #define SQLITE_IOCAP_ATOMIC64K 0x00000100 sl@0: #define SQLITE_IOCAP_SAFE_APPEND 0x00000200 sl@0: #define SQLITE_IOCAP_SEQUENTIAL 0x00000400 sl@0: sl@0: /* sl@0: ** CAPI3REF: File Locking Levels {H10250} sl@0: ** sl@0: ** SQLite uses one of these integer values as the second sl@0: ** argument to calls it makes to the xLock() and xUnlock() methods sl@0: ** of an [sqlite3_io_methods] object. sl@0: */ sl@0: #define SQLITE_LOCK_NONE 0 sl@0: #define SQLITE_LOCK_SHARED 1 sl@0: #define SQLITE_LOCK_RESERVED 2 sl@0: #define SQLITE_LOCK_PENDING 3 sl@0: #define SQLITE_LOCK_EXCLUSIVE 4 sl@0: sl@0: /* sl@0: ** CAPI3REF: Synchronization Type Flags {H10260} sl@0: ** sl@0: ** When SQLite invokes the xSync() method of an sl@0: ** [sqlite3_io_methods] object it uses a combination of sl@0: ** these integer values as the second argument. sl@0: ** sl@0: ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the sl@0: ** sync operation only needs to flush data to mass storage. Inode sl@0: ** information need not be flushed. The SQLITE_SYNC_NORMAL flag means sl@0: ** to use normal fsync() semantics. The SQLITE_SYNC_FULL flag means sl@0: ** to use Mac OS-X style fullsync instead of fsync(). sl@0: */ sl@0: #define SQLITE_SYNC_NORMAL 0x00002 sl@0: #define SQLITE_SYNC_FULL 0x00003 sl@0: #define SQLITE_SYNC_DATAONLY 0x00010 sl@0: sl@0: /* sl@0: ** CAPI3REF: OS Interface Open File Handle {H11110} sl@0: ** sl@0: ** An [sqlite3_file] object represents an open file in the OS sl@0: ** interface layer. Individual OS interface implementations will sl@0: ** want to subclass this object by appending additional fields sl@0: ** for their own use. The pMethods entry is a pointer to an sl@0: ** [sqlite3_io_methods] object that defines methods for performing sl@0: ** I/O operations on the open file. sl@0: */ sl@0: typedef struct sqlite3_file sqlite3_file; sl@0: struct sqlite3_file { sl@0: const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: OS Interface File Virtual Methods Object {H11120} sl@0: ** sl@0: ** Every file opened by the [sqlite3_vfs] xOpen method populates an sl@0: ** [sqlite3_file] object (or, more commonly, a subclass of the sl@0: ** [sqlite3_file] object) with a pointer to an instance of this object. sl@0: ** This object defines the methods used to perform various operations sl@0: ** against the open file represented by the [sqlite3_file] object. sl@0: ** sl@0: ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or sl@0: ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). sl@0: ** The second choice is a Mac OS-X style fullsync. The [SQLITE_SYNC_DATAONLY] sl@0: ** flag may be ORed in to indicate that only the data of the file sl@0: ** and not its inode needs to be synced. sl@0: ** sl@0: ** The integer values to xLock() and xUnlock() are one of sl@0: **
    sl@0: **
  • [SQLITE_LOCK_NONE], sl@0: **
  • [SQLITE_LOCK_SHARED], sl@0: **
  • [SQLITE_LOCK_RESERVED], sl@0: **
  • [SQLITE_LOCK_PENDING], or sl@0: **
  • [SQLITE_LOCK_EXCLUSIVE]. sl@0: **
sl@0: ** xLock() increases the lock. xUnlock() decreases the lock. sl@0: ** The xCheckReservedLock() method checks whether any database connection, sl@0: ** either in this process or in some other process, is holding a RESERVED, sl@0: ** PENDING, or EXCLUSIVE lock on the file. It returns true sl@0: ** if such a lock exists and false otherwise. sl@0: ** sl@0: ** The xFileControl() method is a generic interface that allows custom sl@0: ** VFS implementations to directly control an open file using the sl@0: ** [sqlite3_file_control()] interface. The second "op" argument is an sl@0: ** integer opcode. The third argument is a generic pointer intended to sl@0: ** point to a structure that may contain arguments or space in which to sl@0: ** write return values. Potential uses for xFileControl() might be sl@0: ** functions to enable blocking locks with timeouts, to change the sl@0: ** locking strategy (for example to use dot-file locks), to inquire sl@0: ** about the status of a lock, or to break stale locks. The SQLite sl@0: ** core reserves all opcodes less than 100 for its own use. sl@0: ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. sl@0: ** Applications that define a custom xFileControl method should use opcodes sl@0: ** greater than 100 to avoid conflicts. sl@0: ** sl@0: ** The xSectorSize() method returns the sector size of the sl@0: ** device that underlies the file. The sector size is the sl@0: ** minimum write that can be performed without disturbing sl@0: ** other bytes in the file. The xDeviceCharacteristics() sl@0: ** method returns a bit vector describing behaviors of the sl@0: ** underlying device: sl@0: ** sl@0: **
    sl@0: **
  • [SQLITE_IOCAP_ATOMIC] sl@0: **
  • [SQLITE_IOCAP_ATOMIC512] sl@0: **
  • [SQLITE_IOCAP_ATOMIC1K] sl@0: **
  • [SQLITE_IOCAP_ATOMIC2K] sl@0: **
  • [SQLITE_IOCAP_ATOMIC4K] sl@0: **
  • [SQLITE_IOCAP_ATOMIC8K] sl@0: **
  • [SQLITE_IOCAP_ATOMIC16K] sl@0: **
  • [SQLITE_IOCAP_ATOMIC32K] sl@0: **
  • [SQLITE_IOCAP_ATOMIC64K] sl@0: **
  • [SQLITE_IOCAP_SAFE_APPEND] sl@0: **
  • [SQLITE_IOCAP_SEQUENTIAL] sl@0: **
sl@0: ** sl@0: ** The SQLITE_IOCAP_ATOMIC property means that all writes of sl@0: ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values sl@0: ** mean that writes of blocks that are nnn bytes in size and sl@0: ** are aligned to an address which is an integer multiple of sl@0: ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means sl@0: ** that when data is appended to a file, the data is appended sl@0: ** first then the size of the file is extended, never the other sl@0: ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that sl@0: ** information is written to disk in the same order as calls sl@0: ** to xWrite(). sl@0: */ sl@0: typedef struct sqlite3_io_methods sqlite3_io_methods; sl@0: struct sqlite3_io_methods { sl@0: int iVersion; sl@0: int (*xClose)(sqlite3_file*); sl@0: int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); sl@0: int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); sl@0: int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); sl@0: int (*xSync)(sqlite3_file*, int flags); sl@0: int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); sl@0: int (*xLock)(sqlite3_file*, int); sl@0: int (*xUnlock)(sqlite3_file*, int); sl@0: int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); sl@0: int (*xFileControl)(sqlite3_file*, int op, void *pArg); sl@0: int (*xSectorSize)(sqlite3_file*); sl@0: int (*xDeviceCharacteristics)(sqlite3_file*); sl@0: /* Additional methods may be added in future releases */ sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: Standard File Control Opcodes {H11310} sl@0: ** sl@0: ** These integer constants are opcodes for the xFileControl method sl@0: ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] sl@0: ** interface. sl@0: ** sl@0: ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This sl@0: ** opcode causes the xFileControl method to write the current state of sl@0: ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], sl@0: ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) sl@0: ** into an integer that the pArg argument points to. This capability sl@0: ** is used during testing and only needs to be supported when SQLITE_TEST sl@0: ** is defined. sl@0: ** sl@0: */ sl@0: #define SQLITE_FCNTL_LOCKSTATE 1 sl@0: sl@0: /* sl@0: ** CAPI3REF: Mutex Handle {H17110} sl@0: ** sl@0: ** The mutex module within SQLite defines [sqlite3_mutex] to be an sl@0: ** abstract type for a mutex object. The SQLite core never looks sl@0: ** at the internal representation of an [sqlite3_mutex]. It only sl@0: ** deals with pointers to the [sqlite3_mutex] object. sl@0: ** sl@0: ** Mutexes are created using [sqlite3_mutex_alloc()]. sl@0: */ sl@0: typedef struct sqlite3_mutex sqlite3_mutex; sl@0: sl@0: /* sl@0: ** CAPI3REF: OS Interface Object {H11140} sl@0: ** sl@0: ** An instance of the sqlite3_vfs object defines the interface between sl@0: ** the SQLite core and the underlying operating system. The "vfs" sl@0: ** in the name of the object stands for "virtual file system". sl@0: ** sl@0: ** The value of the iVersion field is initially 1 but may be larger in sl@0: ** future versions of SQLite. Additional fields may be appended to this sl@0: ** object when the iVersion value is increased. Note that the structure sl@0: ** of the sqlite3_vfs object changes in the transaction between sl@0: ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not sl@0: ** modified. sl@0: ** sl@0: ** The szOsFile field is the size of the subclassed [sqlite3_file] sl@0: ** structure used by this VFS. mxPathname is the maximum length of sl@0: ** a pathname in this VFS. sl@0: ** sl@0: ** Registered sqlite3_vfs objects are kept on a linked list formed by sl@0: ** the pNext pointer. The [sqlite3_vfs_register()] sl@0: ** and [sqlite3_vfs_unregister()] interfaces manage this list sl@0: ** in a thread-safe way. The [sqlite3_vfs_find()] interface sl@0: ** searches the list. Neither the application code nor the VFS sl@0: ** implementation should use the pNext pointer. sl@0: ** sl@0: ** The pNext field is the only field in the sqlite3_vfs sl@0: ** structure that SQLite will ever modify. SQLite will only access sl@0: ** or modify this field while holding a particular static mutex. sl@0: ** The application should never modify anything within the sqlite3_vfs sl@0: ** object once the object has been registered. sl@0: ** sl@0: ** The zName field holds the name of the VFS module. The name must sl@0: ** be unique across all VFS modules. sl@0: ** sl@0: ** {H11141} SQLite will guarantee that the zFilename parameter to xOpen sl@0: ** is either a NULL pointer or string obtained sl@0: ** from xFullPathname(). SQLite further guarantees that sl@0: ** the string will be valid and unchanged until xClose() is sl@0: ** called. {END} Because of the previous sentense, sl@0: ** the [sqlite3_file] can safely store a pointer to the sl@0: ** filename if it needs to remember the filename for some reason. sl@0: ** If the zFilename parameter is xOpen is a NULL pointer then xOpen sl@0: ** must invite its own temporary name for the file. Whenever the sl@0: ** xFilename parameter is NULL it will also be the case that the sl@0: ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. sl@0: ** sl@0: ** {H11142} The flags argument to xOpen() includes all bits set in sl@0: ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] sl@0: ** or [sqlite3_open16()] is used, then flags includes at least sl@0: ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. {END} sl@0: ** If xOpen() opens a file read-only then it sets *pOutFlags to sl@0: ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. sl@0: ** sl@0: ** {H11143} SQLite will also add one of the following flags to the xOpen() sl@0: ** call, depending on the object being opened: sl@0: ** sl@0: **
    sl@0: **
  • [SQLITE_OPEN_MAIN_DB] sl@0: **
  • [SQLITE_OPEN_MAIN_JOURNAL] sl@0: **
  • [SQLITE_OPEN_TEMP_DB] sl@0: **
  • [SQLITE_OPEN_TEMP_JOURNAL] sl@0: **
  • [SQLITE_OPEN_TRANSIENT_DB] sl@0: **
  • [SQLITE_OPEN_SUBJOURNAL] sl@0: **
  • [SQLITE_OPEN_MASTER_JOURNAL] sl@0: **
{END} sl@0: ** sl@0: ** The file I/O implementation can use the object type flags to sl@0: ** change the way it deals with files. For example, an application sl@0: ** that does not care about crash recovery or rollback might make sl@0: ** the open of a journal file a no-op. Writes to this journal would sl@0: ** also be no-ops, and any attempt to read the journal would return sl@0: ** SQLITE_IOERR. Or the implementation might recognize that a database sl@0: ** file will be doing page-aligned sector reads and writes in a random sl@0: ** order and set up its I/O subsystem accordingly. sl@0: ** sl@0: ** SQLite might also add one of the following flags to the xOpen method: sl@0: ** sl@0: **
    sl@0: **
  • [SQLITE_OPEN_DELETEONCLOSE] sl@0: **
  • [SQLITE_OPEN_EXCLUSIVE] sl@0: **
sl@0: ** sl@0: ** {H11145} The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be sl@0: ** deleted when it is closed. {H11146} The [SQLITE_OPEN_DELETEONCLOSE] sl@0: ** will be set for TEMP databases, journals and for subjournals. sl@0: ** sl@0: ** {H11147} The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened sl@0: ** for exclusive access. This flag is set for all files except sl@0: ** for the main database file. sl@0: ** sl@0: ** {H11148} At least szOsFile bytes of memory are allocated by SQLite sl@0: ** to hold the [sqlite3_file] structure passed as the third sl@0: ** argument to xOpen. {END} The xOpen method does not have to sl@0: ** allocate the structure; it should just fill it in. sl@0: ** sl@0: ** {H11149} The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] sl@0: ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to sl@0: ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] sl@0: ** to test whether a file is at least readable. {END} The file can be a sl@0: ** directory. sl@0: ** sl@0: ** {H11150} SQLite will always allocate at least mxPathname+1 bytes for the sl@0: ** output buffer xFullPathname. {H11151} The exact size of the output buffer sl@0: ** is also passed as a parameter to both methods. {END} If the output buffer sl@0: ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is sl@0: ** handled as a fatal error by SQLite, vfs implementations should endeavor sl@0: ** to prevent this by setting mxPathname to a sufficiently large value. sl@0: ** sl@0: ** The xRandomness(), xSleep(), and xCurrentTime() interfaces sl@0: ** are not strictly a part of the filesystem, but they are sl@0: ** included in the VFS structure for completeness. sl@0: ** The xRandomness() function attempts to return nBytes bytes sl@0: ** of good-quality randomness into zOut. The return value is sl@0: ** the actual number of bytes of randomness obtained. sl@0: ** The xSleep() method causes the calling thread to sleep for at sl@0: ** least the number of microseconds given. The xCurrentTime() sl@0: ** method returns a Julian Day Number for the current date and time. sl@0: */ sl@0: typedef struct sqlite3_vfs sqlite3_vfs; sl@0: struct sqlite3_vfs { sl@0: int iVersion; /* Structure version number */ sl@0: int szOsFile; /* Size of subclassed sqlite3_file */ sl@0: int mxPathname; /* Maximum file pathname length */ sl@0: sqlite3_vfs *pNext; /* Next registered VFS */ sl@0: const char *zName; /* Name of this virtual file system */ sl@0: void *pAppData; /* Pointer to application-specific data */ sl@0: int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, sl@0: int flags, int *pOutFlags); sl@0: int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); sl@0: int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); sl@0: int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); sl@0: void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); sl@0: void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); sl@0: void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol); sl@0: void (*xDlClose)(sqlite3_vfs*, void*); sl@0: int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); sl@0: int (*xSleep)(sqlite3_vfs*, int microseconds); sl@0: int (*xCurrentTime)(sqlite3_vfs*, double*); sl@0: int (*xGetLastError)(sqlite3_vfs*, int, char *); sl@0: /* New fields may be appended in figure versions. The iVersion sl@0: ** value will increment whenever this happens. */ sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: Flags for the xAccess VFS method {H11190} sl@0: ** sl@0: ** {H11191} These integer constants can be used as the third parameter to sl@0: ** the xAccess method of an [sqlite3_vfs] object. {END} They determine sl@0: ** what kind of permissions the xAccess method is looking for. sl@0: ** {H11192} With SQLITE_ACCESS_EXISTS, the xAccess method sl@0: ** simply checks whether the file exists. sl@0: ** {H11193} With SQLITE_ACCESS_READWRITE, the xAccess method sl@0: ** checks whether the file is both readable and writable. sl@0: ** {H11194} With SQLITE_ACCESS_READ, the xAccess method sl@0: ** checks whether the file is readable. sl@0: */ sl@0: #define SQLITE_ACCESS_EXISTS 0 sl@0: #define SQLITE_ACCESS_READWRITE 1 sl@0: #define SQLITE_ACCESS_READ 2 sl@0: sl@0: /* sl@0: ** CAPI3REF: Initialize The SQLite Library {H10130} sl@0: ** sl@0: ** The sqlite3_initialize() routine initializes the sl@0: ** SQLite library. The sqlite3_shutdown() routine sl@0: ** deallocates any resources that were allocated by sqlite3_initialize(). sl@0: ** sl@0: ** A call to sqlite3_initialize() is an "effective" call if it is sl@0: ** the first time sqlite3_initialize() is invoked during the lifetime of sl@0: ** the process, or if it is the first time sqlite3_initialize() is invoked sl@0: ** following a call to sqlite3_shutdown(). Only an effective call sl@0: ** of sqlite3_initialize() does any initialization. All other calls sl@0: ** are harmless no-ops. sl@0: ** sl@0: ** Among other things, sqlite3_initialize() shall invoke sl@0: ** sqlite3_os_init(). Similarly, sqlite3_shutdown() sl@0: ** shall invoke sqlite3_os_end(). sl@0: ** sl@0: ** The sqlite3_initialize() routine returns SQLITE_OK on success. sl@0: ** If for some reason, sqlite3_initialize() is unable to initialize sl@0: ** the library (perhaps it is unable to allocate a needed resource such sl@0: ** as a mutex) it returns an [error code] other than SQLITE_OK. sl@0: ** sl@0: ** The sqlite3_initialize() routine is called internally by many other sl@0: ** SQLite interfaces so that an application usually does not need to sl@0: ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] sl@0: ** calls sqlite3_initialize() so the SQLite library will be automatically sl@0: ** initialized when [sqlite3_open()] is called if it has not be initialized sl@0: ** already. However, if SQLite is compiled with the SQLITE_OMIT_AUTOINIT sl@0: ** compile-time option, then the automatic calls to sqlite3_initialize() sl@0: ** are omitted and the application must call sqlite3_initialize() directly sl@0: ** prior to using any other SQLite interface. For maximum portability, sl@0: ** it is recommended that applications always invoke sqlite3_initialize() sl@0: ** directly prior to using any other SQLite interface. Future releases sl@0: ** of SQLite may require this. In other words, the behavior exhibited sl@0: ** when SQLite is compiled with SQLITE_OMIT_AUTOINIT might become the sl@0: ** default behavior in some future release of SQLite. sl@0: ** sl@0: ** The sqlite3_os_init() routine does operating-system specific sl@0: ** initialization of the SQLite library. The sqlite3_os_end() sl@0: ** routine undoes the effect of sqlite3_os_init(). Typical tasks sl@0: ** performed by these routines include allocation or deallocation sl@0: ** of static resources, initialization of global variables, sl@0: ** setting up a default [sqlite3_vfs] module, or setting up sl@0: ** a default configuration using [sqlite3_config()]. sl@0: ** sl@0: ** The application should never invoke either sqlite3_os_init() sl@0: ** or sqlite3_os_end() directly. The application should only invoke sl@0: ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() sl@0: ** interface is called automatically by sqlite3_initialize() and sl@0: ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate sl@0: ** implementations for sqlite3_os_init() and sqlite3_os_end() sl@0: ** are built into SQLite when it is compiled for unix, windows, or os/2. sl@0: ** When built for other platforms (using the SQLITE_OS_OTHER=1 compile-time sl@0: ** option) the application must supply a suitable implementation for sl@0: ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied sl@0: ** implementation of sqlite3_os_init() or sqlite3_os_end() sl@0: ** must return SQLITE_OK on success and some other [error code] upon sl@0: ** failure. sl@0: */ sl@0: int sqlite3_initialize(void); sl@0: int sqlite3_shutdown(void); sl@0: int sqlite3_os_init(void); sl@0: int sqlite3_os_end(void); sl@0: sl@0: /* sl@0: ** CAPI3REF: Configuring The SQLite Library {H10145} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** The sqlite3_config() interface is used to make global configuration sl@0: ** changes to SQLite in order to tune SQLite to the specific needs of sl@0: ** the application. The default configuration is recommended for most sl@0: ** applications and so this routine is usually not necessary. It is sl@0: ** provided to support rare applications with unusual needs. sl@0: ** sl@0: ** The sqlite3_config() interface is not threadsafe. The application sl@0: ** must insure that no other SQLite interfaces are invoked by other sl@0: ** threads while sqlite3_config() is running. Furthermore, sqlite3_config() sl@0: ** may only be invoked prior to library initialization using sl@0: ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. sl@0: ** Note, however, that sqlite3_config() can be called as part of the sl@0: ** implementation of an application-defined [sqlite3_os_init()]. sl@0: ** sl@0: ** The first argument to sqlite3_config() is an integer sl@0: ** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines sl@0: ** what property of SQLite is to be configured. Subsequent arguments sl@0: ** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] sl@0: ** in the first argument. sl@0: ** sl@0: ** When a configuration option is set, sqlite3_config() returns SQLITE_OK. sl@0: ** If the option is unknown or SQLite is unable to set the option sl@0: ** then this routine returns a non-zero [error code]. sl@0: */ sl@0: int sqlite3_config(int, ...); sl@0: sl@0: /* sl@0: ** CAPI3REF: Configure database connections {H10180} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** The sqlite3_db_config() interface is used to make configuration sl@0: ** changes to a [database connection]. The interface is similar to sl@0: ** [sqlite3_config()] except that the changes apply to a single sl@0: ** [database connection] (specified in the first argument). The sl@0: ** sqlite3_db_config() interface can only be used immediately after sl@0: ** the database connection is created using [sqlite3_open()], sl@0: ** [sqlite3_open16()], or [sqlite3_open_v2()]. sl@0: ** sl@0: ** The second argument to sqlite3_db_config(D,V,...) is the sl@0: ** configuration verb - an integer code that indicates what sl@0: ** aspect of the [database connection] is being configured. sl@0: ** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE]. sl@0: ** New verbs are likely to be added in future releases of SQLite. sl@0: ** Additional arguments depend on the verb. sl@0: */ sl@0: int sqlite3_db_config(sqlite3*, int op, ...); sl@0: sl@0: /* sl@0: ** CAPI3REF: Memory Allocation Routines {H10155} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** An instance of this object defines the interface between SQLite sl@0: ** and low-level memory allocation routines. sl@0: ** sl@0: ** This object is used in only one place in the SQLite interface. sl@0: ** A pointer to an instance of this object is the argument to sl@0: ** [sqlite3_config()] when the configuration option is sl@0: ** [SQLITE_CONFIG_MALLOC]. By creating an instance of this object sl@0: ** and passing it to [sqlite3_config()] during configuration, an sl@0: ** application can specify an alternative memory allocation subsystem sl@0: ** for SQLite to use for all of its dynamic memory needs. sl@0: ** sl@0: ** Note that SQLite comes with a built-in memory allocator that is sl@0: ** perfectly adequate for the overwhelming majority of applications sl@0: ** and that this object is only useful to a tiny minority of applications sl@0: ** with specialized memory allocation requirements. This object is sl@0: ** also used during testing of SQLite in order to specify an alternative sl@0: ** memory allocator that simulates memory out-of-memory conditions in sl@0: ** order to verify that SQLite recovers gracefully from such sl@0: ** conditions. sl@0: ** sl@0: ** The xMalloc, xFree, and xRealloc methods must work like the sl@0: ** malloc(), free(), and realloc() functions from the standard library. sl@0: ** sl@0: ** xSize should return the allocated size of a memory allocation sl@0: ** previously obtained from xMalloc or xRealloc. The allocated size sl@0: ** is always at least as big as the requested size but may be larger. sl@0: ** sl@0: ** The xRoundup method returns what would be the allocated size of sl@0: ** a memory allocation given a particular requested size. Most memory sl@0: ** allocators round up memory allocations at least to the next multiple sl@0: ** of 8. Some allocators round up to a larger multiple or to a power of 2. sl@0: ** sl@0: ** The xInit method initializes the memory allocator. (For example, sl@0: ** it might allocate any require mutexes or initialize internal data sl@0: ** structures. The xShutdown method is invoked (indirectly) by sl@0: ** [sqlite3_shutdown()] and should deallocate any resources acquired sl@0: ** by xInit. The pAppData pointer is used as the only parameter to sl@0: ** xInit and xShutdown. sl@0: */ sl@0: typedef struct sqlite3_mem_methods sqlite3_mem_methods; sl@0: struct sqlite3_mem_methods { sl@0: void *(*xMalloc)(int); /* Memory allocation function */ sl@0: void (*xFree)(void*); /* Free a prior allocation */ sl@0: void *(*xRealloc)(void*,int); /* Resize an allocation */ sl@0: int (*xSize)(void*); /* Return the size of an allocation */ sl@0: int (*xRoundup)(int); /* Round up request size to allocation size */ sl@0: int (*xInit)(void*); /* Initialize the memory allocator */ sl@0: void (*xShutdown)(void*); /* Deinitialize the memory allocator */ sl@0: void *pAppData; /* Argument to xInit() and xShutdown() */ sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: Configuration Options {H10160} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** These constants are the available integer configuration options that sl@0: ** can be passed as the first argument to the [sqlite3_config()] interface. sl@0: ** sl@0: ** New configuration options may be added in future releases of SQLite. sl@0: ** Existing configuration options might be discontinued. Applications sl@0: ** should check the return code from [sqlite3_config()] to make sure that sl@0: ** the call worked. The [sqlite3_config()] interface will return a sl@0: ** non-zero [error code] if a discontinued or unsupported configuration option sl@0: ** is invoked. sl@0: ** sl@0: **
sl@0: **
SQLITE_CONFIG_SINGLETHREAD
sl@0: **
There are no arguments to this option. This option disables sl@0: ** all mutexing and puts SQLite into a mode where it can only be used sl@0: ** by a single thread.
sl@0: ** sl@0: **
SQLITE_CONFIG_MULTITHREAD
sl@0: **
There are no arguments to this option. This option disables sl@0: ** mutexing on [database connection] and [prepared statement] objects. sl@0: ** The application is responsible for serializing access to sl@0: ** [database connections] and [prepared statements]. But other mutexes sl@0: ** are enabled so that SQLite will be safe to use in a multi-threaded sl@0: ** environment.
sl@0: ** sl@0: **
SQLITE_CONFIG_SERIALIZED
sl@0: **
There are no arguments to this option. This option enables sl@0: ** all mutexes including the recursive sl@0: ** mutexes on [database connection] and [prepared statement] objects. sl@0: ** In this mode (which is the default when SQLite is compiled with sl@0: ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access sl@0: ** to [database connections] and [prepared statements] so that the sl@0: ** application is free to use the same [database connection] or the sl@0: ** same [prepared statement] in different threads at the same time. sl@0: ** sl@0: **

This configuration option merely sets the default mutex sl@0: ** behavior to serialize access to [database connections]. Individual sl@0: ** [database connections] can override this setting sl@0: ** using the [SQLITE_OPEN_NOMUTEX] flag to [sqlite3_open_v2()].

sl@0: ** sl@0: **
SQLITE_CONFIG_MALLOC
sl@0: **
This option takes a single argument which is a pointer to an sl@0: ** instance of the [sqlite3_mem_methods] structure. The argument specifies sl@0: ** alternative low-level memory allocation routines to be used in place of sl@0: ** the memory allocation routines built into SQLite.
sl@0: ** sl@0: **
SQLITE_CONFIG_GETMALLOC
sl@0: **
This option takes a single argument which is a pointer to an sl@0: ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] sl@0: ** structure is filled with the currently defined memory allocation routines. sl@0: ** This option can be used to overload the default memory allocation sl@0: ** routines with a wrapper that simulations memory allocation failure or sl@0: ** tracks memory usage, for example.
sl@0: ** sl@0: **
SQLITE_CONFIG_MEMSTATUS
sl@0: **
This option takes single argument of type int, interpreted as a sl@0: ** boolean, which enables or disables the collection of memory allocation sl@0: ** statistics. When disabled, the following SQLite interfaces become sl@0: ** non-operational: sl@0: **
    sl@0: **
  • [sqlite3_memory_used()] sl@0: **
  • [sqlite3_memory_highwater()] sl@0: **
  • [sqlite3_soft_heap_limit()] sl@0: **
  • [sqlite3_status()] sl@0: **
sl@0: **
sl@0: ** sl@0: **
SQLITE_CONFIG_SCRATCH
sl@0: **
This option specifies a static memory buffer that SQLite can use for sl@0: ** scratch memory. There are three arguments: A pointer to the memory, the sl@0: ** size of each scratch buffer (sz), and the number of buffers (N). The sz sl@0: ** argument must be a multiple of 16. The sz parameter should be a few bytes sl@0: ** larger than the actual scratch space required due internal overhead. sl@0: ** The first sl@0: ** argument should point to an allocation of at least sz*N bytes of memory. sl@0: ** SQLite will use no more than one scratch buffer at once per thread, so sl@0: ** N should be set to the expected maximum number of threads. The sz sl@0: ** parameter should be 6 times the size of the largest database page size. sl@0: ** Scratch buffers are used as part of the btree balance operation. If sl@0: ** The btree balancer needs additional memory beyond what is provided by sl@0: ** scratch buffers or if no scratch buffer space is specified, then SQLite sl@0: ** goes to [sqlite3_malloc()] to obtain the memory it needs.
sl@0: ** sl@0: **
SQLITE_CONFIG_PAGECACHE
sl@0: **
This option specifies a static memory buffer that SQLite can use for sl@0: ** the database page cache. There are three arguments: A pointer to the sl@0: ** memory, the size of each page buffer (sz), and the number of pages (N). sl@0: ** The sz argument must be a power of two between 512 and 32768. The first sl@0: ** argument should point to an allocation of at least sz*N bytes of memory. sl@0: ** SQLite will use the memory provided by the first argument to satisfy its sl@0: ** memory needs for the first N pages that it adds to cache. If additional sl@0: ** page cache memory is needed beyond what is provided by this option, then sl@0: ** SQLite goes to [sqlite3_malloc()] for the additional storage space. sl@0: ** The implementation might use one or more of the N buffers to hold sl@0: ** memory accounting information.
sl@0: ** sl@0: **
SQLITE_CONFIG_HEAP
sl@0: **
This option specifies a static memory buffer that SQLite will use sl@0: ** for all of its dynamic memory allocation needs beyond those provided sl@0: ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. sl@0: ** There are three arguments: A pointer to the memory, the number of sl@0: ** bytes in the memory buffer, and the minimum allocation size. If sl@0: ** the first pointer (the memory pointer) is NULL, then SQLite reverts sl@0: ** to using its default memory allocator (the system malloc() implementation), sl@0: ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the sl@0: ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or sl@0: ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory sl@0: ** allocator is engaged to handle all of SQLites memory allocation needs.
sl@0: ** sl@0: **
SQLITE_CONFIG_MUTEX
sl@0: **
This option takes a single argument which is a pointer to an sl@0: ** instance of the [sqlite3_mutex_methods] structure. The argument specifies sl@0: ** alternative low-level mutex routines to be used in place sl@0: ** the mutex routines built into SQLite.
sl@0: ** sl@0: **
SQLITE_CONFIG_GETMUTEX
sl@0: **
This option takes a single argument which is a pointer to an sl@0: ** instance of the [sqlite3_mutex_methods] structure. The sl@0: ** [sqlite3_mutex_methods] sl@0: ** structure is filled with the currently defined mutex routines. sl@0: ** This option can be used to overload the default mutex allocation sl@0: ** routines with a wrapper used to track mutex usage for performance sl@0: ** profiling or testing, for example.
sl@0: ** sl@0: **
SQLITE_CONFIG_LOOKASIDE
sl@0: **
This option takes two arguments that determine the default sl@0: ** memory allcation lookaside optimization. The first argument is the sl@0: ** size of each lookaside buffer slot and the second is the number of sl@0: ** slots allocated to each database connection.
sl@0: ** sl@0: **
sl@0: */ sl@0: #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ sl@0: #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ sl@0: #define SQLITE_CONFIG_SERIALIZED 3 /* nil */ sl@0: #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ sl@0: #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ sl@0: #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ sl@0: #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ sl@0: #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ sl@0: #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ sl@0: #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ sl@0: #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ sl@0: #define SQLITE_CONFIG_CHUNKALLOC 12 /* int threshold */ sl@0: #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ sl@0: sl@0: /* sl@0: ** CAPI3REF: Configuration Options {H10170} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** These constants are the available integer configuration options that sl@0: ** can be passed as the second argument to the [sqlite3_db_config()] interface. sl@0: ** sl@0: ** New configuration options may be added in future releases of SQLite. sl@0: ** Existing configuration options might be discontinued. Applications sl@0: ** should check the return code from [sqlite3_db_config()] to make sure that sl@0: ** the call worked. The [sqlite3_db_config()] interface will return a sl@0: ** non-zero [error code] if a discontinued or unsupported configuration option sl@0: ** is invoked. sl@0: ** sl@0: **
sl@0: **
SQLITE_DBCONFIG_LOOKASIDE
sl@0: **
This option takes three additional arguments that determine the sl@0: ** [lookaside memory allocator] configuration for the [database connection]. sl@0: ** The first argument (the third parameter to [sqlite3_db_config()] is a sl@0: ** pointer to a memory buffer to use for lookaside memory. The first sl@0: ** argument may be NULL in which case SQLite will allocate the lookaside sl@0: ** buffer itself using [sqlite3_malloc()]. The second argument is the sl@0: ** size of each lookaside buffer slot and the third argument is the number of sl@0: ** slots. The size of the buffer in the first argument must be greater than sl@0: ** or equal to the product of the second and third arguments.
sl@0: ** sl@0: **
sl@0: */ sl@0: #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ sl@0: sl@0: sl@0: /* sl@0: ** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} sl@0: ** sl@0: ** The sqlite3_extended_result_codes() routine enables or disables the sl@0: ** [extended result codes] feature of SQLite. The extended result sl@0: ** codes are disabled by default for historical compatibility considerations. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12201} Each new [database connection] shall have the sl@0: ** [extended result codes] feature disabled by default. sl@0: ** sl@0: ** {H12202} The [sqlite3_extended_result_codes(D,F)] interface shall enable sl@0: ** [extended result codes] for the [database connection] D sl@0: ** if the F parameter is true, or disable them if F is false. sl@0: */ sl@0: int sqlite3_extended_result_codes(sqlite3*, int onoff); sl@0: sl@0: /* sl@0: ** CAPI3REF: Last Insert Rowid {H12220} sl@0: ** sl@0: ** Each entry in an SQLite table has a unique 64-bit signed sl@0: ** integer key called the "rowid". The rowid is always available sl@0: ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those sl@0: ** names are not also used by explicitly declared columns. If sl@0: ** the table has a column of type INTEGER PRIMARY KEY then that column sl@0: ** is another alias for the rowid. sl@0: ** sl@0: ** This routine returns the rowid of the most recent sl@0: ** successful INSERT into the database from the [database connection] sl@0: ** in the first argument. If no successful INSERTs sl@0: ** have ever occurred on that database connection, zero is returned. sl@0: ** sl@0: ** If an INSERT occurs within a trigger, then the rowid of the inserted sl@0: ** row is returned by this routine as long as the trigger is running. sl@0: ** But once the trigger terminates, the value returned by this routine sl@0: ** reverts to the last value inserted before the trigger fired. sl@0: ** sl@0: ** An INSERT that fails due to a constraint violation is not a sl@0: ** successful INSERT and does not change the value returned by this sl@0: ** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, sl@0: ** and INSERT OR ABORT make no changes to the return value of this sl@0: ** routine when their insertion fails. When INSERT OR REPLACE sl@0: ** encounters a constraint violation, it does not fail. The sl@0: ** INSERT continues to completion after deleting rows that caused sl@0: ** the constraint problem so INSERT OR REPLACE will always change sl@0: ** the return value of this interface. sl@0: ** sl@0: ** For the purposes of this routine, an INSERT is considered to sl@0: ** be successful even if it is subsequently rolled back. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12221} The [sqlite3_last_insert_rowid()] function returns the rowid sl@0: ** of the most recent successful INSERT performed on the same sl@0: ** [database connection] and within the same or higher level sl@0: ** trigger context, or zero if there have been no qualifying inserts. sl@0: ** sl@0: ** {H12223} The [sqlite3_last_insert_rowid()] function returns the sl@0: ** same value when called from the same trigger context sl@0: ** immediately before and after a ROLLBACK. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12232} If a separate thread performs a new INSERT on the same sl@0: ** database connection while the [sqlite3_last_insert_rowid()] sl@0: ** function is running and thus changes the last insert rowid, sl@0: ** then the value returned by [sqlite3_last_insert_rowid()] is sl@0: ** unpredictable and might not equal either the old or the new sl@0: ** last insert rowid. sl@0: */ sl@0: sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Count The Number Of Rows Modified {H12240} sl@0: ** sl@0: ** This function returns the number of database rows that were changed sl@0: ** or inserted or deleted by the most recently completed SQL statement sl@0: ** on the [database connection] specified by the first parameter. sl@0: ** Only changes that are directly specified by the INSERT, UPDATE, sl@0: ** or DELETE statement are counted. Auxiliary changes caused by sl@0: ** triggers are not counted. Use the [sqlite3_total_changes()] function sl@0: ** to find the total number of changes including changes caused by triggers. sl@0: ** sl@0: ** A "row change" is a change to a single row of a single table sl@0: ** caused by an INSERT, DELETE, or UPDATE statement. Rows that sl@0: ** are changed as side effects of REPLACE constraint resolution, sl@0: ** rollback, ABORT processing, DROP TABLE, or by any other sl@0: ** mechanisms do not count as direct row changes. sl@0: ** sl@0: ** A "trigger context" is a scope of execution that begins and sl@0: ** ends with the script of a trigger. Most SQL statements are sl@0: ** evaluated outside of any trigger. This is the "top level" sl@0: ** trigger context. If a trigger fires from the top level, a sl@0: ** new trigger context is entered for the duration of that one sl@0: ** trigger. Subtriggers create subcontexts for their duration. sl@0: ** sl@0: ** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does sl@0: ** not create a new trigger context. sl@0: ** sl@0: ** This function returns the number of direct row changes in the sl@0: ** most recent INSERT, UPDATE, or DELETE statement within the same sl@0: ** trigger context. sl@0: ** sl@0: ** Thus, when called from the top level, this function returns the sl@0: ** number of changes in the most recent INSERT, UPDATE, or DELETE sl@0: ** that also occurred at the top level. Within the body of a trigger, sl@0: ** the sqlite3_changes() interface can be called to find the number of sl@0: ** changes in the most recently completed INSERT, UPDATE, or DELETE sl@0: ** statement within the body of the same trigger. sl@0: ** However, the number returned does not include changes sl@0: ** caused by subtriggers since those have their own context. sl@0: ** sl@0: ** SQLite implements the command "DELETE FROM table" without a WHERE clause sl@0: ** by dropping and recreating the table. (This is much faster than going sl@0: ** through and deleting individual elements from the table.) Because of this sl@0: ** optimization, the deletions in "DELETE FROM table" are not row changes and sl@0: ** will not be counted by the sqlite3_changes() or [sqlite3_total_changes()] sl@0: ** functions, regardless of the number of elements that were originally sl@0: ** in the table. To get an accurate count of the number of rows deleted, use sl@0: ** "DELETE FROM table WHERE 1" instead. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12241} The [sqlite3_changes()] function shall return the number of sl@0: ** row changes caused by the most recent INSERT, UPDATE, sl@0: ** or DELETE statement on the same database connection and sl@0: ** within the same or higher trigger context, or zero if there have sl@0: ** not been any qualifying row changes. sl@0: ** sl@0: ** {H12243} Statements of the form "DELETE FROM tablename" with no sl@0: ** WHERE clause shall cause subsequent calls to sl@0: ** [sqlite3_changes()] to return zero, regardless of the sl@0: ** number of rows originally in the table. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12252} If a separate thread makes changes on the same database connection sl@0: ** while [sqlite3_changes()] is running then the value returned sl@0: ** is unpredictable and not meaningful. sl@0: */ sl@0: int sqlite3_changes(sqlite3*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Total Number Of Rows Modified {H12260} sl@0: ** sl@0: ** This function returns the number of row changes caused by INSERT, sl@0: ** UPDATE or DELETE statements since the [database connection] was opened. sl@0: ** The count includes all changes from all trigger contexts. However, sl@0: ** the count does not include changes used to implement REPLACE constraints, sl@0: ** do rollbacks or ABORT processing, or DROP table processing. sl@0: ** The changes are counted as soon as the statement that makes them is sl@0: ** completed (when the statement handle is passed to [sqlite3_reset()] or sl@0: ** [sqlite3_finalize()]). sl@0: ** sl@0: ** SQLite implements the command "DELETE FROM table" without a WHERE clause sl@0: ** by dropping and recreating the table. (This is much faster than going sl@0: ** through and deleting individual elements from the table.) Because of this sl@0: ** optimization, the deletions in "DELETE FROM table" are not row changes and sl@0: ** will not be counted by the sqlite3_changes() or [sqlite3_total_changes()] sl@0: ** functions, regardless of the number of elements that were originally sl@0: ** in the table. To get an accurate count of the number of rows deleted, use sl@0: ** "DELETE FROM table WHERE 1" instead. sl@0: ** sl@0: ** See also the [sqlite3_changes()] interface. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12261} The [sqlite3_total_changes()] returns the total number sl@0: ** of row changes caused by INSERT, UPDATE, and/or DELETE sl@0: ** statements on the same [database connection], in any sl@0: ** trigger context, since the database connection was created. sl@0: ** sl@0: ** {H12263} Statements of the form "DELETE FROM tablename" with no sl@0: ** WHERE clause shall not change the value returned sl@0: ** by [sqlite3_total_changes()]. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12264} If a separate thread makes changes on the same database connection sl@0: ** while [sqlite3_total_changes()] is running then the value sl@0: ** returned is unpredictable and not meaningful. sl@0: */ sl@0: int sqlite3_total_changes(sqlite3*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Interrupt A Long-Running Query {H12270} sl@0: ** sl@0: ** This function causes any pending database operation to abort and sl@0: ** return at its earliest opportunity. This routine is typically sl@0: ** called in response to a user action such as pressing "Cancel" sl@0: ** or Ctrl-C where the user wants a long query operation to halt sl@0: ** immediately. sl@0: ** sl@0: ** It is safe to call this routine from a thread different from the sl@0: ** thread that is currently running the database operation. But it sl@0: ** is not safe to call this routine with a [database connection] that sl@0: ** is closed or might close before sqlite3_interrupt() returns. sl@0: ** sl@0: ** If an SQL operation is very nearly finished at the time when sl@0: ** sqlite3_interrupt() is called, then it might not have an opportunity sl@0: ** to be interrupted and might continue to completion. sl@0: ** sl@0: ** An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. sl@0: ** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE sl@0: ** that is inside an explicit transaction, then the entire transaction sl@0: ** will be rolled back automatically. sl@0: ** sl@0: ** A call to sqlite3_interrupt() has no effect on SQL statements sl@0: ** that are started after sqlite3_interrupt() returns. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12271} The [sqlite3_interrupt()] interface will force all running sl@0: ** SQL statements associated with the same database connection sl@0: ** to halt after processing at most one additional row of data. sl@0: ** sl@0: ** {H12272} Any SQL statement that is interrupted by [sqlite3_interrupt()] sl@0: ** will return [SQLITE_INTERRUPT]. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12279} If the database connection closes while [sqlite3_interrupt()] sl@0: ** is running then bad things will likely happen. sl@0: */ sl@0: void sqlite3_interrupt(sqlite3*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} sl@0: ** sl@0: ** These routines are useful for command-line input to determine if the sl@0: ** currently entered text seems to form complete a SQL statement or sl@0: ** if additional input is needed before sending the text into sl@0: ** SQLite for parsing. These routines return true if the input string sl@0: ** appears to be a complete SQL statement. A statement is judged to be sl@0: ** complete if it ends with a semicolon token and is not a fragment of a sl@0: ** CREATE TRIGGER statement. Semicolons that are embedded within sl@0: ** string literals or quoted identifier names or comments are not sl@0: ** independent tokens (they are part of the token in which they are sl@0: ** embedded) and thus do not count as a statement terminator. sl@0: ** sl@0: ** These routines do not parse the SQL statements thus sl@0: ** will not detect syntactically incorrect SQL. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10511} A successful evaluation of [sqlite3_complete()] or sl@0: ** [sqlite3_complete16()] functions shall sl@0: ** return a numeric 1 if and only if the last non-whitespace sl@0: ** token in their input is a semicolon that is not in between sl@0: ** the BEGIN and END of a CREATE TRIGGER statement. sl@0: ** sl@0: ** {H10512} If a memory allocation error occurs during an invocation sl@0: ** of [sqlite3_complete()] or [sqlite3_complete16()] then the sl@0: ** routine shall return [SQLITE_NOMEM]. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A10512} The input to [sqlite3_complete()] must be a zero-terminated sl@0: ** UTF-8 string. sl@0: ** sl@0: ** {A10513} The input to [sqlite3_complete16()] must be a zero-terminated sl@0: ** UTF-16 string in native byte order. sl@0: */ sl@0: int sqlite3_complete(const char *sql); sl@0: int sqlite3_complete16(const void *sql); sl@0: sl@0: /* sl@0: ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} sl@0: ** sl@0: ** This routine sets a callback function that might be invoked whenever sl@0: ** an attempt is made to open a database table that another thread sl@0: ** or process has locked. sl@0: ** sl@0: ** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] sl@0: ** is returned immediately upon encountering the lock. If the busy callback sl@0: ** is not NULL, then the callback will be invoked with two arguments. sl@0: ** sl@0: ** The first argument to the handler is a copy of the void* pointer which sl@0: ** is the third argument to sqlite3_busy_handler(). The second argument to sl@0: ** the handler callback is the number of times that the busy handler has sl@0: ** been invoked for this locking event. If the sl@0: ** busy callback returns 0, then no additional attempts are made to sl@0: ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. sl@0: ** If the callback returns non-zero, then another attempt sl@0: ** is made to open the database for reading and the cycle repeats. sl@0: ** sl@0: ** The presence of a busy handler does not guarantee that it will be invoked sl@0: ** when there is lock contention. If SQLite determines that invoking the busy sl@0: ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] sl@0: ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. sl@0: ** Consider a scenario where one process is holding a read lock that sl@0: ** it is trying to promote to a reserved lock and sl@0: ** a second process is holding a reserved lock that it is trying sl@0: ** to promote to an exclusive lock. The first process cannot proceed sl@0: ** because it is blocked by the second and the second process cannot sl@0: ** proceed because it is blocked by the first. If both processes sl@0: ** invoke the busy handlers, neither will make any progress. Therefore, sl@0: ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this sl@0: ** will induce the first process to release its read lock and allow sl@0: ** the second process to proceed. sl@0: ** sl@0: ** The default busy callback is NULL. sl@0: ** sl@0: ** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] sl@0: ** when SQLite is in the middle of a large transaction where all the sl@0: ** changes will not fit into the in-memory cache. SQLite will sl@0: ** already hold a RESERVED lock on the database file, but it needs sl@0: ** to promote this lock to EXCLUSIVE so that it can spill cache sl@0: ** pages into the database file without harm to concurrent sl@0: ** readers. If it is unable to promote the lock, then the in-memory sl@0: ** cache will be left in an inconsistent state and so the error sl@0: ** code is promoted from the relatively benign [SQLITE_BUSY] to sl@0: ** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion sl@0: ** forces an automatic rollback of the changes. See the sl@0: ** sl@0: ** CorruptionFollowingBusyError wiki page for a discussion of why sl@0: ** this is important. sl@0: ** sl@0: ** There can only be a single busy handler defined for each sl@0: ** [database connection]. Setting a new busy handler clears any sl@0: ** previously set handler. Note that calling [sqlite3_busy_timeout()] sl@0: ** will also set or clear the busy handler. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12311} The [sqlite3_busy_handler(D,C,A)] function shall replace sl@0: ** busy callback in the [database connection] D with a new sl@0: ** a new busy handler C and application data pointer A. sl@0: ** sl@0: ** {H12312} Newly created [database connections] shall have a busy sl@0: ** handler of NULL. sl@0: ** sl@0: ** {H12314} When two or more [database connections] share a sl@0: ** [sqlite3_enable_shared_cache | common cache], sl@0: ** the busy handler for the database connection currently using sl@0: ** the cache shall be invoked when the cache encounters a lock. sl@0: ** sl@0: ** {H12316} If a busy handler callback returns zero, then the SQLite interface sl@0: ** that provoked the locking event shall return [SQLITE_BUSY]. sl@0: ** sl@0: ** {H12318} SQLite shall invokes the busy handler with two arguments which sl@0: ** are a copy of the pointer supplied by the 3rd parameter to sl@0: ** [sqlite3_busy_handler()] and a count of the number of prior sl@0: ** invocations of the busy handler for the same locking event. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12319} A busy handler must not close the database connection sl@0: ** or [prepared statement] that invoked the busy handler. sl@0: */ sl@0: int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Set A Busy Timeout {H12340} sl@0: ** sl@0: ** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps sl@0: ** for a specified amount of time when a table is locked. The handler sl@0: ** will sleep multiple times until at least "ms" milliseconds of sleeping sl@0: ** have accumulated. {H12343} After "ms" milliseconds of sleeping, sl@0: ** the handler returns 0 which causes [sqlite3_step()] to return sl@0: ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. sl@0: ** sl@0: ** Calling this routine with an argument less than or equal to zero sl@0: ** turns off all busy handlers. sl@0: ** sl@0: ** There can only be a single busy handler for a particular sl@0: ** [database connection] any any given moment. If another busy handler sl@0: ** was defined (using [sqlite3_busy_handler()]) prior to calling sl@0: ** this routine, that other busy handler is cleared. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12341} The [sqlite3_busy_timeout()] function shall override any prior sl@0: ** [sqlite3_busy_timeout()] or [sqlite3_busy_handler()] setting sl@0: ** on the same [database connection]. sl@0: ** sl@0: ** {H12343} If the 2nd parameter to [sqlite3_busy_timeout()] is less than sl@0: ** or equal to zero, then the busy handler shall be cleared so that sl@0: ** all subsequent locking events immediately return [SQLITE_BUSY]. sl@0: ** sl@0: ** {H12344} If the 2nd parameter to [sqlite3_busy_timeout()] is a positive sl@0: ** number N, then a busy handler shall be set that repeatedly calls sl@0: ** the xSleep() method in the [sqlite3_vfs | VFS interface] until sl@0: ** either the lock clears or until the cumulative sleep time sl@0: ** reported back by xSleep() exceeds N milliseconds. sl@0: */ sl@0: int sqlite3_busy_timeout(sqlite3*, int ms); sl@0: sl@0: /* sl@0: ** CAPI3REF: Convenience Routines For Running Queries {H12370} sl@0: ** sl@0: ** Definition: A result table is memory data structure created by the sl@0: ** [sqlite3_get_table()] interface. A result table records the sl@0: ** complete query results from one or more queries. sl@0: ** sl@0: ** The table conceptually has a number of rows and columns. But sl@0: ** these numbers are not part of the result table itself. These sl@0: ** numbers are obtained separately. Let N be the number of rows sl@0: ** and M be the number of columns. sl@0: ** sl@0: ** A result table is an array of pointers to zero-terminated UTF-8 strings. sl@0: ** There are (N+1)*M elements in the array. The first M pointers point sl@0: ** to zero-terminated strings that contain the names of the columns. sl@0: ** The remaining entries all point to query results. NULL values result sl@0: ** in NULL pointers. All other values are in their UTF-8 zero-terminated sl@0: ** string representation as returned by [sqlite3_column_text()]. sl@0: ** sl@0: ** A result table might consist of one or more memory allocations. sl@0: ** It is not safe to pass a result table directly to [sqlite3_free()]. sl@0: ** A result table should be deallocated using [sqlite3_free_table()]. sl@0: ** sl@0: ** As an example of the result table format, suppose a query result sl@0: ** is as follows: sl@0: ** sl@0: ** 
sl@0: **        Name        | Age
sl@0: **        -----------------------
sl@0: **        Alice       | 43
sl@0: **        Bob         | 28
sl@0: **        Cindy       | 21
sl@0: **
sl@0: ** sl@0: ** There are two column (M==2) and three rows (N==3). Thus the sl@0: ** result table has 8 entries. Suppose the result table is stored sl@0: ** in an array names azResult. Then azResult holds this content: sl@0: ** sl@0: ** 
sl@0: **        azResult[0] = "Name";
sl@0: **        azResult[1] = "Age";
sl@0: **        azResult[2] = "Alice";
sl@0: **        azResult[3] = "43";
sl@0: **        azResult[4] = "Bob";
sl@0: **        azResult[5] = "28";
sl@0: **        azResult[6] = "Cindy";
sl@0: **        azResult[7] = "21";
sl@0: **
sl@0: ** sl@0: ** The sqlite3_get_table() function evaluates one or more sl@0: ** semicolon-separated SQL statements in the zero-terminated UTF-8 sl@0: ** string of its 2nd parameter. It returns a result table to the sl@0: ** pointer given in its 3rd parameter. sl@0: ** sl@0: ** After the calling function has finished using the result, it should sl@0: ** pass the pointer to the result table to sqlite3_free_table() in order to sl@0: ** release the memory that was malloced. Because of the way the sl@0: ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling sl@0: ** function must not try to call [sqlite3_free()] directly. Only sl@0: ** [sqlite3_free_table()] is able to release the memory properly and safely. sl@0: ** sl@0: ** The sqlite3_get_table() interface is implemented as a wrapper around sl@0: ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access sl@0: ** to any internal data structures of SQLite. It uses only the public sl@0: ** interface defined here. As a consequence, errors that occur in the sl@0: ** wrapper layer outside of the internal [sqlite3_exec()] call are not sl@0: ** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12371} If a [sqlite3_get_table()] fails a memory allocation, then sl@0: ** it shall free the result table under construction, abort the sl@0: ** query in process, skip any subsequent queries, set the sl@0: ** *pazResult output pointer to NULL and return [SQLITE_NOMEM]. sl@0: ** sl@0: ** {H12373} If the pnColumn parameter to [sqlite3_get_table()] is not NULL sl@0: ** then a successful invocation of [sqlite3_get_table()] shall sl@0: ** write the number of columns in the sl@0: ** result set of the query into *pnColumn. sl@0: ** sl@0: ** {H12374} If the pnRow parameter to [sqlite3_get_table()] is not NULL sl@0: ** then a successful invocation of [sqlite3_get_table()] shall sl@0: ** writes the number of rows in the sl@0: ** result set of the query into *pnRow. sl@0: ** sl@0: ** {H12376} A successful invocation of [sqlite3_get_table()] that computes sl@0: ** N rows of result with C columns per row shall make *pazResult sl@0: ** point to an array of pointers to (N+1)*C strings where the first sl@0: ** C strings are column names as obtained from sl@0: ** [sqlite3_column_name()] and the rest are column result values sl@0: ** obtained from [sqlite3_column_text()]. sl@0: ** sl@0: ** {H12379} The values in the pazResult array returned by [sqlite3_get_table()] sl@0: ** shall remain valid until cleared by [sqlite3_free_table()]. sl@0: ** sl@0: ** {H12382} When an error occurs during evaluation of [sqlite3_get_table()] sl@0: ** the function shall set *pazResult to NULL, write an error message sl@0: ** into memory obtained from [sqlite3_malloc()], make sl@0: ** **pzErrmsg point to that error message, and return a sl@0: ** appropriate [error code]. sl@0: */ sl@0: int sqlite3_get_table( sl@0: sqlite3 *db, /* An open database */ sl@0: const char *zSql, /* SQL to be evaluated */ sl@0: char ***pazResult, /* Results of the query */ sl@0: int *pnRow, /* Number of result rows written here */ sl@0: int *pnColumn, /* Number of result columns written here */ sl@0: char **pzErrmsg /* Error msg written here */ sl@0: ); sl@0: void sqlite3_free_table(char **result); sl@0: sl@0: /* sl@0: ** CAPI3REF: Formatted String Printing Functions {H17400} sl@0: ** sl@0: ** These routines are workalikes of the "printf()" family of functions sl@0: ** from the standard C library. sl@0: ** sl@0: ** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their sl@0: ** results into memory obtained from [sqlite3_malloc()]. sl@0: ** The strings returned by these two routines should be sl@0: ** released by [sqlite3_free()]. Both routines return a sl@0: ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough sl@0: ** memory to hold the resulting string. sl@0: ** sl@0: ** In sqlite3_snprintf() routine is similar to "snprintf()" from sl@0: ** the standard C library. The result is written into the sl@0: ** buffer supplied as the second parameter whose size is given by sl@0: ** the first parameter. Note that the order of the sl@0: ** first two parameters is reversed from snprintf(). This is an sl@0: ** historical accident that cannot be fixed without breaking sl@0: ** backwards compatibility. Note also that sqlite3_snprintf() sl@0: ** returns a pointer to its buffer instead of the number of sl@0: ** characters actually written into the buffer. We admit that sl@0: ** the number of characters written would be a more useful return sl@0: ** value but we cannot change the implementation of sqlite3_snprintf() sl@0: ** now without breaking compatibility. sl@0: ** sl@0: ** As long as the buffer size is greater than zero, sqlite3_snprintf() sl@0: ** guarantees that the buffer is always zero-terminated. The first sl@0: ** parameter "n" is the total size of the buffer, including space for sl@0: ** the zero terminator. So the longest string that can be completely sl@0: ** written will be n-1 characters. sl@0: ** sl@0: ** These routines all implement some additional formatting sl@0: ** options that are useful for constructing SQL statements. sl@0: ** All of the usual printf() formatting options apply. In addition, there sl@0: ** is are "%q", "%Q", and "%z" options. sl@0: ** sl@0: ** The %q option works like %s in that it substitutes a null-terminated sl@0: ** string from the argument list. But %q also doubles every '\'' character. sl@0: ** %q is designed for use inside a string literal. By doubling each '\'' sl@0: ** character it escapes that character and allows it to be inserted into sl@0: ** the string. sl@0: ** sl@0: ** For example, assume the string variable zText contains text as follows: sl@0: ** sl@0: ** 
sl@0: **  char *zText = "It's a happy day!";
sl@0: **
sl@0: ** sl@0: ** One can use this text in an SQL statement as follows: sl@0: ** sl@0: ** 
sl@0: **  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
sl@0: **  sqlite3_exec(db, zSQL, 0, 0, 0);
sl@0: **  sqlite3_free(zSQL);
sl@0: **
sl@0: ** sl@0: ** Because the %q format string is used, the '\'' character in zText sl@0: ** is escaped and the SQL generated is as follows: sl@0: ** sl@0: ** 
sl@0: **  INSERT INTO table1 VALUES('It''s a happy day!')
sl@0: **
sl@0: ** sl@0: ** This is correct. Had we used %s instead of %q, the generated SQL sl@0: ** would have looked like this: sl@0: ** sl@0: ** 
sl@0: **  INSERT INTO table1 VALUES('It's a happy day!');
sl@0: **
sl@0: ** sl@0: ** This second example is an SQL syntax error. As a general rule you should sl@0: ** always use %q instead of %s when inserting text into a string literal. sl@0: ** sl@0: ** The %Q option works like %q except it also adds single quotes around sl@0: ** the outside of the total string. Additionally, if the parameter in the sl@0: ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without sl@0: ** single quotes) in place of the %Q option. So, for example, one could say: sl@0: ** sl@0: ** 
sl@0: **  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
sl@0: **  sqlite3_exec(db, zSQL, 0, 0, 0);
sl@0: **  sqlite3_free(zSQL);
sl@0: **
sl@0: ** sl@0: ** The code above will render a correct SQL statement in the zSQL sl@0: ** variable even if the zText variable is a NULL pointer. sl@0: ** sl@0: ** The "%z" formatting option works exactly like "%s" with the sl@0: ** addition that after the string has been read and copied into sl@0: ** the result, [sqlite3_free()] is called on the input string. {END} sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17403} The [sqlite3_mprintf()] and [sqlite3_vmprintf()] interfaces sl@0: ** return either pointers to zero-terminated UTF-8 strings held in sl@0: ** memory obtained from [sqlite3_malloc()] or NULL pointers if sl@0: ** a call to [sqlite3_malloc()] fails. sl@0: ** sl@0: ** {H17406} The [sqlite3_snprintf()] interface writes a zero-terminated sl@0: ** UTF-8 string into the buffer pointed to by the second parameter sl@0: ** provided that the first parameter is greater than zero. sl@0: ** sl@0: ** {H17407} The [sqlite3_snprintf()] interface does not write slots of sl@0: ** its output buffer (the second parameter) outside the range sl@0: ** of 0 through N-1 (where N is the first parameter) sl@0: ** regardless of the length of the string sl@0: ** requested by the format specification. sl@0: */ sl@0: char *sqlite3_mprintf(const char*,...); sl@0: char *sqlite3_vmprintf(const char*, va_list); sl@0: char *sqlite3_snprintf(int,char*,const char*, ...); sl@0: sl@0: /* sl@0: ** CAPI3REF: Memory Allocation Subsystem {H17300} sl@0: ** sl@0: ** The SQLite core uses these three routines for all of its own sl@0: ** internal memory allocation needs. "Core" in the previous sentence sl@0: ** does not include operating-system specific VFS implementation. The sl@0: ** Windows VFS uses native malloc() and free() for some operations. sl@0: ** sl@0: ** The sqlite3_malloc() routine returns a pointer to a block sl@0: ** of memory at least N bytes in length, where N is the parameter. sl@0: ** If sqlite3_malloc() is unable to obtain sufficient free sl@0: ** memory, it returns a NULL pointer. If the parameter N to sl@0: ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns sl@0: ** a NULL pointer. sl@0: ** sl@0: ** Calling sqlite3_free() with a pointer previously returned sl@0: ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so sl@0: ** that it might be reused. The sqlite3_free() routine is sl@0: ** a no-op if is called with a NULL pointer. Passing a NULL pointer sl@0: ** to sqlite3_free() is harmless. After being freed, memory sl@0: ** should neither be read nor written. Even reading previously freed sl@0: ** memory might result in a segmentation fault or other severe error. sl@0: ** Memory corruption, a segmentation fault, or other severe error sl@0: ** might result if sqlite3_free() is called with a non-NULL pointer that sl@0: ** was not obtained from sqlite3_malloc() or sqlite3_free(). sl@0: ** sl@0: ** The sqlite3_realloc() interface attempts to resize a sl@0: ** prior memory allocation to be at least N bytes, where N is the sl@0: ** second parameter. The memory allocation to be resized is the first sl@0: ** parameter. If the first parameter to sqlite3_realloc() sl@0: ** is a NULL pointer then its behavior is identical to calling sl@0: ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). sl@0: ** If the second parameter to sqlite3_realloc() is zero or sl@0: ** negative then the behavior is exactly the same as calling sl@0: ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). sl@0: ** sqlite3_realloc() returns a pointer to a memory allocation sl@0: ** of at least N bytes in size or NULL if sufficient memory is unavailable. sl@0: ** If M is the size of the prior allocation, then min(N,M) bytes sl@0: ** of the prior allocation are copied into the beginning of buffer returned sl@0: ** by sqlite3_realloc() and the prior allocation is freed. sl@0: ** If sqlite3_realloc() returns NULL, then the prior allocation sl@0: ** is not freed. sl@0: ** sl@0: ** The memory returned by sqlite3_malloc() and sqlite3_realloc() sl@0: ** is always aligned to at least an 8 byte boundary. {END} sl@0: ** sl@0: ** The default implementation of the memory allocation subsystem uses sl@0: ** the malloc(), realloc() and free() provided by the standard C library. sl@0: ** {H17382} However, if SQLite is compiled with the sl@0: ** SQLITE_MEMORY_SIZE=NNN C preprocessor macro (where NNN sl@0: ** is an integer), then SQLite create a static array of at least sl@0: ** NNN bytes in size and uses that array for all of its dynamic sl@0: ** memory allocation needs. {END} Additional memory allocator options sl@0: ** may be added in future releases. sl@0: ** sl@0: ** In SQLite version 3.5.0 and 3.5.1, it was possible to define sl@0: ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in sl@0: ** implementation of these routines to be omitted. That capability sl@0: ** is no longer provided. Only built-in memory allocators can be used. sl@0: ** sl@0: ** The Windows OS interface layer calls sl@0: ** the system malloc() and free() directly when converting sl@0: ** filenames between the UTF-8 encoding used by SQLite sl@0: ** and whatever filename encoding is used by the particular Windows sl@0: ** installation. Memory allocation errors are detected, but sl@0: ** they are reported back as [SQLITE_CANTOPEN] or sl@0: ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17303} The [sqlite3_malloc(N)] interface returns either a pointer to sl@0: ** a newly checked-out block of at least N bytes of memory sl@0: ** that is 8-byte aligned, or it returns NULL if it is unable sl@0: ** to fulfill the request. sl@0: ** sl@0: ** {H17304} The [sqlite3_malloc(N)] interface returns a NULL pointer if sl@0: ** N is less than or equal to zero. sl@0: ** sl@0: ** {H17305} The [sqlite3_free(P)] interface releases memory previously sl@0: ** returned from [sqlite3_malloc()] or [sqlite3_realloc()], sl@0: ** making it available for reuse. sl@0: ** sl@0: ** {H17306} A call to [sqlite3_free(NULL)] is a harmless no-op. sl@0: ** sl@0: ** {H17310} A call to [sqlite3_realloc(0,N)] is equivalent to a call sl@0: ** to [sqlite3_malloc(N)]. sl@0: ** sl@0: ** {H17312} A call to [sqlite3_realloc(P,0)] is equivalent to a call sl@0: ** to [sqlite3_free(P)]. sl@0: ** sl@0: ** {H17315} The SQLite core uses [sqlite3_malloc()], [sqlite3_realloc()], sl@0: ** and [sqlite3_free()] for all of its memory allocation and sl@0: ** deallocation needs. sl@0: ** sl@0: ** {H17318} The [sqlite3_realloc(P,N)] interface returns either a pointer sl@0: ** to a block of checked-out memory of at least N bytes in size sl@0: ** that is 8-byte aligned, or a NULL pointer. sl@0: ** sl@0: ** {H17321} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first sl@0: ** copies the first K bytes of content from P into the newly sl@0: ** allocated block, where K is the lesser of N and the size of sl@0: ** the buffer P. sl@0: ** sl@0: ** {H17322} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first sl@0: ** releases the buffer P. sl@0: ** sl@0: ** {H17323} When [sqlite3_realloc(P,N)] returns NULL, the buffer P is sl@0: ** not modified or released. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A17350} The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] sl@0: ** must be either NULL or else pointers obtained from a prior sl@0: ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have sl@0: ** not yet been released. sl@0: ** sl@0: ** {A17351} The application must not read or write any part of sl@0: ** a block of memory after it has been released using sl@0: ** [sqlite3_free()] or [sqlite3_realloc()]. sl@0: */ sl@0: void *sqlite3_malloc(int); sl@0: void *sqlite3_realloc(void*, int); sl@0: void sqlite3_free(void*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Memory Allocator Statistics {H17370} sl@0: ** sl@0: ** SQLite provides these two interfaces for reporting on the status sl@0: ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] sl@0: ** routines, which form the built-in memory allocation subsystem. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17371} The [sqlite3_memory_used()] routine returns the number of bytes sl@0: ** of memory currently outstanding (malloced but not freed). sl@0: ** sl@0: ** {H17373} The [sqlite3_memory_highwater()] routine returns the maximum sl@0: ** value of [sqlite3_memory_used()] since the high-water mark sl@0: ** was last reset. sl@0: ** sl@0: ** {H17374} The values returned by [sqlite3_memory_used()] and sl@0: ** [sqlite3_memory_highwater()] include any overhead sl@0: ** added by SQLite in its implementation of [sqlite3_malloc()], sl@0: ** but not overhead added by the any underlying system library sl@0: ** routines that [sqlite3_malloc()] may call. sl@0: ** sl@0: ** {H17375} The memory high-water mark is reset to the current value of sl@0: ** [sqlite3_memory_used()] if and only if the parameter to sl@0: ** [sqlite3_memory_highwater()] is true. The value returned sl@0: ** by [sqlite3_memory_highwater(1)] is the high-water mark sl@0: ** prior to the reset. sl@0: */ sl@0: sqlite3_int64 sqlite3_memory_used(void); sl@0: sqlite3_int64 sqlite3_memory_highwater(int resetFlag); sl@0: sl@0: /* sl@0: ** CAPI3REF: Pseudo-Random Number Generator {H17390} sl@0: ** sl@0: ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to sl@0: ** select random ROWIDs when inserting new records into a table that sl@0: ** already uses the largest possible ROWID. The PRNG is also used for sl@0: ** the build-in random() and randomblob() SQL functions. This interface allows sl@0: ** applications to access the same PRNG for other purposes. sl@0: ** sl@0: ** A call to this routine stores N bytes of randomness into buffer P. sl@0: ** sl@0: ** The first time this routine is invoked (either internally or by sl@0: ** the application) the PRNG is seeded using randomness obtained sl@0: ** from the xRandomness method of the default [sqlite3_vfs] object. sl@0: ** On all subsequent invocations, the pseudo-randomness is generated sl@0: ** internally and without recourse to the [sqlite3_vfs] xRandomness sl@0: ** method. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17392} The [sqlite3_randomness(N,P)] interface writes N bytes of sl@0: ** high-quality pseudo-randomness into buffer P. sl@0: */ sl@0: void sqlite3_randomness(int N, void *P); sl@0: sl@0: /* sl@0: ** CAPI3REF: Compile-Time Authorization Callbacks {H12500} sl@0: ** sl@0: ** This routine registers a authorizer callback with a particular sl@0: ** [database connection], supplied in the first argument. sl@0: ** The authorizer callback is invoked as SQL statements are being compiled sl@0: ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], sl@0: ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various sl@0: ** points during the compilation process, as logic is being created sl@0: ** to perform various actions, the authorizer callback is invoked to sl@0: ** see if those actions are allowed. The authorizer callback should sl@0: ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the sl@0: ** specific action but allow the SQL statement to continue to be sl@0: ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be sl@0: ** rejected with an error. If the authorizer callback returns sl@0: ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] sl@0: ** then the [sqlite3_prepare_v2()] or equivalent call that triggered sl@0: ** the authorizer will fail with an error message. sl@0: ** sl@0: ** When the callback returns [SQLITE_OK], that means the operation sl@0: ** requested is ok. When the callback returns [SQLITE_DENY], the sl@0: ** [sqlite3_prepare_v2()] or equivalent call that triggered the sl@0: ** authorizer will fail with an error message explaining that sl@0: ** access is denied. If the authorizer code is [SQLITE_READ] sl@0: ** and the callback returns [SQLITE_IGNORE] then the sl@0: ** [prepared statement] statement is constructed to substitute sl@0: ** a NULL value in place of the table column that would have sl@0: ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] sl@0: ** return can be used to deny an untrusted user access to individual sl@0: ** columns of a table. sl@0: ** sl@0: ** The first parameter to the authorizer callback is a copy of the third sl@0: ** parameter to the sqlite3_set_authorizer() interface. The second parameter sl@0: ** to the callback is an integer [SQLITE_COPY | action code] that specifies sl@0: ** the particular action to be authorized. The third through sixth parameters sl@0: ** to the callback are zero-terminated strings that contain additional sl@0: ** details about the action to be authorized. sl@0: ** sl@0: ** An authorizer is used when [sqlite3_prepare | preparing] sl@0: ** SQL statements from an untrusted source, to ensure that the SQL statements sl@0: ** do not try to access data they are not allowed to see, or that they do not sl@0: ** try to execute malicious statements that damage the database. For sl@0: ** example, an application may allow a user to enter arbitrary sl@0: ** SQL queries for evaluation by a database. But the application does sl@0: ** not want the user to be able to make arbitrary changes to the sl@0: ** database. An authorizer could then be put in place while the sl@0: ** user-entered SQL is being [sqlite3_prepare | prepared] that sl@0: ** disallows everything except [SELECT] statements. sl@0: ** sl@0: ** Applications that need to process SQL from untrusted sources sl@0: ** might also consider lowering resource limits using [sqlite3_limit()] sl@0: ** and limiting database size using the [max_page_count] [PRAGMA] sl@0: ** in addition to using an authorizer. sl@0: ** sl@0: ** Only a single authorizer can be in place on a database connection sl@0: ** at a time. Each call to sqlite3_set_authorizer overrides the sl@0: ** previous call. Disable the authorizer by installing a NULL callback. sl@0: ** The authorizer is disabled by default. sl@0: ** sl@0: ** Note that the authorizer callback is invoked only during sl@0: ** [sqlite3_prepare()] or its variants. Authorization is not sl@0: ** performed during statement evaluation in [sqlite3_step()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12501} The [sqlite3_set_authorizer(D,...)] interface registers a sl@0: ** authorizer callback with database connection D. sl@0: ** sl@0: ** {H12502} The authorizer callback is invoked as SQL statements are sl@0: ** being compiled. sl@0: ** sl@0: ** {H12503} If the authorizer callback returns any value other than sl@0: ** [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY], then sl@0: ** the [sqlite3_prepare_v2()] or equivalent call that caused sl@0: ** the authorizer callback to run shall fail with an sl@0: ** [SQLITE_ERROR] error code and an appropriate error message. sl@0: ** sl@0: ** {H12504} When the authorizer callback returns [SQLITE_OK], the operation sl@0: ** described is processed normally. sl@0: ** sl@0: ** {H12505} When the authorizer callback returns [SQLITE_DENY], the sl@0: ** [sqlite3_prepare_v2()] or equivalent call that caused the sl@0: ** authorizer callback to run shall fail sl@0: ** with an [SQLITE_ERROR] error code and an error message sl@0: ** explaining that access is denied. sl@0: ** sl@0: ** {H12506} If the authorizer code (the 2nd parameter to the authorizer sl@0: ** callback) is [SQLITE_READ] and the authorizer callback returns sl@0: ** [SQLITE_IGNORE], then the prepared statement is constructed to sl@0: ** insert a NULL value in place of the table column that would have sl@0: ** been read if [SQLITE_OK] had been returned. sl@0: ** sl@0: ** {H12507} If the authorizer code (the 2nd parameter to the authorizer sl@0: ** callback) is anything other than [SQLITE_READ], then sl@0: ** a return of [SQLITE_IGNORE] has the same effect as [SQLITE_DENY]. sl@0: ** sl@0: ** {H12510} The first parameter to the authorizer callback is a copy of sl@0: ** the third parameter to the [sqlite3_set_authorizer()] interface. sl@0: ** sl@0: ** {H12511} The second parameter to the callback is an integer sl@0: ** [SQLITE_COPY | action code] that specifies the particular action sl@0: ** to be authorized. sl@0: ** sl@0: ** {H12512} The third through sixth parameters to the callback are sl@0: ** zero-terminated strings that contain sl@0: ** additional details about the action to be authorized. sl@0: ** sl@0: ** {H12520} Each call to [sqlite3_set_authorizer()] overrides sl@0: ** any previously installed authorizer. sl@0: ** sl@0: ** {H12521} A NULL authorizer means that no authorization sl@0: ** callback is invoked. sl@0: ** sl@0: ** {H12522} The default authorizer is NULL. sl@0: */ sl@0: int sqlite3_set_authorizer( sl@0: sqlite3*, sl@0: int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), sl@0: void *pUserData sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Authorizer Return Codes {H12590} sl@0: ** sl@0: ** The [sqlite3_set_authorizer | authorizer callback function] must sl@0: ** return either [SQLITE_OK] or one of these two constants in order sl@0: ** to signal SQLite whether or not the action is permitted. See the sl@0: ** [sqlite3_set_authorizer | authorizer documentation] for additional sl@0: ** information. sl@0: */ sl@0: #define SQLITE_DENY 1 /* Abort the SQL statement with an error */ sl@0: #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ sl@0: sl@0: /* sl@0: ** CAPI3REF: Authorizer Action Codes {H12550} sl@0: ** sl@0: ** The [sqlite3_set_authorizer()] interface registers a callback function sl@0: ** that is invoked to authorize certain SQL statement actions. The sl@0: ** second parameter to the callback is an integer code that specifies sl@0: ** what action is being authorized. These are the integer action codes that sl@0: ** the authorizer callback may be passed. sl@0: ** sl@0: ** These action code values signify what kind of operation is to be sl@0: ** authorized. The 3rd and 4th parameters to the authorization sl@0: ** callback function will be parameters or NULL depending on which of these sl@0: ** codes is used as the second parameter. The 5th parameter to the sl@0: ** authorizer callback is the name of the database ("main", "temp", sl@0: ** etc.) if applicable. The 6th parameter to the authorizer callback sl@0: ** is the name of the inner-most trigger or view that is responsible for sl@0: ** the access attempt or NULL if this access attempt is directly from sl@0: ** top-level SQL code. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12551} The second parameter to an sl@0: ** [sqlite3_set_authorizer | authorizer callback] is always an integer sl@0: ** [SQLITE_COPY | authorizer code] that specifies what action sl@0: ** is being authorized. sl@0: ** sl@0: ** {H12552} The 3rd and 4th parameters to the sl@0: ** [sqlite3_set_authorizer | authorization callback] sl@0: ** will be parameters or NULL depending on which sl@0: ** [SQLITE_COPY | authorizer code] is used as the second parameter. sl@0: ** sl@0: ** {H12553} The 5th parameter to the sl@0: ** [sqlite3_set_authorizer | authorizer callback] is the name sl@0: ** of the database (example: "main", "temp", etc.) if applicable. sl@0: ** sl@0: ** {H12554} The 6th parameter to the sl@0: ** [sqlite3_set_authorizer | authorizer callback] is the name sl@0: ** of the inner-most trigger or view that is responsible for sl@0: ** the access attempt or NULL if this access attempt is directly from sl@0: ** top-level SQL code. sl@0: */ sl@0: /******************************************* 3rd ************ 4th ***********/ sl@0: #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ sl@0: #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ sl@0: #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ sl@0: #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ sl@0: #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ sl@0: #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ sl@0: #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ sl@0: #define SQLITE_CREATE_VIEW 8 /* View Name NULL */ sl@0: #define SQLITE_DELETE 9 /* Table Name NULL */ sl@0: #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ sl@0: #define SQLITE_DROP_TABLE 11 /* Table Name NULL */ sl@0: #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ sl@0: #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ sl@0: #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ sl@0: #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ sl@0: #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ sl@0: #define SQLITE_DROP_VIEW 17 /* View Name NULL */ sl@0: #define SQLITE_INSERT 18 /* Table Name NULL */ sl@0: #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ sl@0: #define SQLITE_READ 20 /* Table Name Column Name */ sl@0: #define SQLITE_SELECT 21 /* NULL NULL */ sl@0: #define SQLITE_TRANSACTION 22 /* NULL NULL */ sl@0: #define SQLITE_UPDATE 23 /* Table Name Column Name */ sl@0: #define SQLITE_ATTACH 24 /* Filename NULL */ sl@0: #define SQLITE_DETACH 25 /* Database Name NULL */ sl@0: #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ sl@0: #define SQLITE_REINDEX 27 /* Index Name NULL */ sl@0: #define SQLITE_ANALYZE 28 /* Table Name NULL */ sl@0: #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ sl@0: #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ sl@0: #define SQLITE_FUNCTION 31 /* Function Name NULL */ sl@0: #define SQLITE_COPY 0 /* No longer used */ sl@0: sl@0: /* sl@0: ** CAPI3REF: Tracing And Profiling Functions {H12280} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** These routines register callback functions that can be used for sl@0: ** tracing and profiling the execution of SQL statements. sl@0: ** sl@0: ** The callback function registered by sqlite3_trace() is invoked at sl@0: ** various times when an SQL statement is being run by [sqlite3_step()]. sl@0: ** The callback returns a UTF-8 rendering of the SQL statement text sl@0: ** as the statement first begins executing. Additional callbacks occur sl@0: ** as each triggered subprogram is entered. The callbacks for triggers sl@0: ** contain a UTF-8 SQL comment that identifies the trigger. sl@0: ** sl@0: ** The callback function registered by sqlite3_profile() is invoked sl@0: ** as each SQL statement finishes. The profile callback contains sl@0: ** the original statement text and an estimate of wall-clock time sl@0: ** of how long that statement took to run. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12281} The callback function registered by [sqlite3_trace()] is sl@0: ** whenever an SQL statement first begins to execute and sl@0: ** whenever a trigger subprogram first begins to run. sl@0: ** sl@0: ** {H12282} Each call to [sqlite3_trace()] overrides the previously sl@0: ** registered trace callback. sl@0: ** sl@0: ** {H12283} A NULL trace callback disables tracing. sl@0: ** sl@0: ** {H12284} The first argument to the trace callback is a copy of sl@0: ** the pointer which was the 3rd argument to [sqlite3_trace()]. sl@0: ** sl@0: ** {H12285} The second argument to the trace callback is a sl@0: ** zero-terminated UTF-8 string containing the original text sl@0: ** of the SQL statement as it was passed into [sqlite3_prepare_v2()] sl@0: ** or the equivalent, or an SQL comment indicating the beginning sl@0: ** of a trigger subprogram. sl@0: ** sl@0: ** {H12287} The callback function registered by [sqlite3_profile()] is invoked sl@0: ** as each SQL statement finishes. sl@0: ** sl@0: ** {H12288} The first parameter to the profile callback is a copy of sl@0: ** the 3rd parameter to [sqlite3_profile()]. sl@0: ** sl@0: ** {H12289} The second parameter to the profile callback is a sl@0: ** zero-terminated UTF-8 string that contains the complete text of sl@0: ** the SQL statement as it was processed by [sqlite3_prepare_v2()] sl@0: ** or the equivalent. sl@0: ** sl@0: ** {H12290} The third parameter to the profile callback is an estimate sl@0: ** of the number of nanoseconds of wall-clock time required to sl@0: ** run the SQL statement from start to finish. sl@0: */ sl@0: void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); sl@0: void *sqlite3_profile(sqlite3*, sl@0: void(*xProfile)(void*,const char*,sqlite3_uint64), void*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Query Progress Callbacks {H12910} sl@0: ** sl@0: ** This routine configures a callback function - the sl@0: ** progress callback - that is invoked periodically during long sl@0: ** running calls to [sqlite3_exec()], [sqlite3_step()] and sl@0: ** [sqlite3_get_table()]. An example use for this sl@0: ** interface is to keep a GUI updated during a large query. sl@0: ** sl@0: ** If the progress callback returns non-zero, the operation is sl@0: ** interrupted. This feature can be used to implement a sl@0: ** "Cancel" button on a GUI dialog box. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12911} The callback function registered by sqlite3_progress_handler() sl@0: ** is invoked periodically during long running calls to sl@0: ** [sqlite3_step()]. sl@0: ** sl@0: ** {H12912} The progress callback is invoked once for every N virtual sl@0: ** machine opcodes, where N is the second argument to sl@0: ** the [sqlite3_progress_handler()] call that registered sl@0: ** the callback. If N is less than 1, sqlite3_progress_handler() sl@0: ** acts as if a NULL progress handler had been specified. sl@0: ** sl@0: ** {H12913} The progress callback itself is identified by the third sl@0: ** argument to sqlite3_progress_handler(). sl@0: ** sl@0: ** {H12914} The fourth argument to sqlite3_progress_handler() is a sl@0: ** void pointer passed to the progress callback sl@0: ** function each time it is invoked. sl@0: ** sl@0: ** {H12915} If a call to [sqlite3_step()] results in fewer than N opcodes sl@0: ** being executed, then the progress callback is never invoked. sl@0: ** sl@0: ** {H12916} Every call to [sqlite3_progress_handler()] sl@0: ** overwrites any previously registered progress handler. sl@0: ** sl@0: ** {H12917} If the progress handler callback is NULL then no progress sl@0: ** handler is invoked. sl@0: ** sl@0: ** {H12918} If the progress callback returns a result other than 0, then sl@0: ** the behavior is a if [sqlite3_interrupt()] had been called. sl@0: ** sl@0: */ sl@0: void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Opening A New Database Connection {H12700} sl@0: ** sl@0: ** These routines open an SQLite database file whose name is given by the sl@0: ** filename argument. The filename argument is interpreted as UTF-8 for sl@0: ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte sl@0: ** order for sqlite3_open16(). A [database connection] handle is usually sl@0: ** returned in *ppDb, even if an error occurs. The only exception is that sl@0: ** if SQLite is unable to allocate memory to hold the [sqlite3] object, sl@0: ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] sl@0: ** object. If the database is opened (and/or created) successfully, then sl@0: ** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The sl@0: ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain sl@0: ** an English language description of the error. sl@0: ** sl@0: ** The default encoding for the database will be UTF-8 if sl@0: ** sqlite3_open() or sqlite3_open_v2() is called and sl@0: ** UTF-16 in the native byte order if sqlite3_open16() is used. sl@0: ** sl@0: ** Whether or not an error occurs when it is opened, resources sl@0: ** associated with the [database connection] handle should be released by sl@0: ** passing it to [sqlite3_close()] when it is no longer required. sl@0: ** sl@0: ** The sqlite3_open_v2() interface works like sqlite3_open() sl@0: ** except that it accepts two additional parameters for additional control sl@0: ** over the new database connection. The flags parameter can take one of sl@0: ** the following three values, optionally combined with the sl@0: ** [SQLITE_OPEN_NOMUTEX] flag: sl@0: ** sl@0: **
sl@0: **
[SQLITE_OPEN_READONLY]
sl@0: **
The database is opened in read-only mode. If the database does not sl@0: ** already exist, an error is returned.
sl@0: ** sl@0: **
[SQLITE_OPEN_READWRITE]
sl@0: **
The database is opened for reading and writing if possible, or reading sl@0: ** only if the file is write protected by the operating system. In either sl@0: ** case the database must already exist, otherwise an error is returned.
sl@0: ** sl@0: **
[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]
sl@0: **
The database is opened for reading and writing, and is creates it if sl@0: ** it does not already exist. This is the behavior that is always used for sl@0: ** sqlite3_open() and sqlite3_open16().
sl@0: **
sl@0: ** sl@0: ** If the 3rd parameter to sqlite3_open_v2() is not one of the sl@0: ** combinations shown above or one of the combinations shown above combined sl@0: ** with the [SQLITE_OPEN_NOMUTEX] flag, then the behavior is undefined. sl@0: ** sl@0: ** If the [SQLITE_OPEN_NOMUTEX] flag is set, then mutexes on the sl@0: ** opened [database connection] are disabled and the appliation must sl@0: ** insure that access to the [database connection] and its associated sl@0: ** [prepared statements] is serialized. The [SQLITE_OPEN_NOMUTEX] flag sl@0: ** is the default behavior is SQLite is configured using the sl@0: ** [SQLITE_CONFIG_MULTITHREAD] or [SQLITE_CONFIG_SINGLETHREAD] options sl@0: ** to [sqlite3_config()]. The [SQLITE_OPEN_NOMUTEX] flag only makes a sl@0: ** difference when SQLite is in its default [SQLITE_CONFIG_SERIALIZED] mode. sl@0: ** sl@0: ** If the filename is ":memory:", then a private, temporary in-memory database sl@0: ** is created for the connection. This in-memory database will vanish when sl@0: ** the database connection is closed. Future versions of SQLite might sl@0: ** make use of additional special filenames that begin with the ":" character. sl@0: ** It is recommended that when a database filename actually does begin with sl@0: ** a ":" character you should prefix the filename with a pathname such as sl@0: ** "./" to avoid ambiguity. sl@0: ** sl@0: ** If the filename is an empty string, then a private, temporary sl@0: ** on-disk database will be created. This private database will be sl@0: ** automatically deleted as soon as the database connection is closed. sl@0: ** sl@0: ** The fourth parameter to sqlite3_open_v2() is the name of the sl@0: ** [sqlite3_vfs] object that defines the operating system interface that sl@0: ** the new database connection should use. If the fourth parameter is sl@0: ** a NULL pointer then the default [sqlite3_vfs] object is used. sl@0: ** sl@0: ** Note to Windows users: The encoding used for the filename argument sl@0: ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever sl@0: ** codepage is currently defined. Filenames containing international sl@0: ** characters must be converted to UTF-8 prior to passing them into sl@0: ** sqlite3_open() or sqlite3_open_v2(). sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12701} The [sqlite3_open()], [sqlite3_open16()], and sl@0: ** [sqlite3_open_v2()] interfaces create a new sl@0: ** [database connection] associated with sl@0: ** the database file given in their first parameter. sl@0: ** sl@0: ** {H12702} The filename argument is interpreted as UTF-8 sl@0: ** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16 sl@0: ** in the native byte order for [sqlite3_open16()]. sl@0: ** sl@0: ** {H12703} A successful invocation of [sqlite3_open()], [sqlite3_open16()], sl@0: ** or [sqlite3_open_v2()] writes a pointer to a new sl@0: ** [database connection] into *ppDb. sl@0: ** sl@0: ** {H12704} The [sqlite3_open()], [sqlite3_open16()], and sl@0: ** [sqlite3_open_v2()] interfaces return [SQLITE_OK] upon success, sl@0: ** or an appropriate [error code] on failure. sl@0: ** sl@0: ** {H12706} The default text encoding for a new database created using sl@0: ** [sqlite3_open()] or [sqlite3_open_v2()] will be UTF-8. sl@0: ** sl@0: ** {H12707} The default text encoding for a new database created using sl@0: ** [sqlite3_open16()] will be UTF-16. sl@0: ** sl@0: ** {H12709} The [sqlite3_open(F,D)] interface is equivalent to sl@0: ** [sqlite3_open_v2(F,D,G,0)] where the G parameter is sl@0: ** [SQLITE_OPEN_READWRITE]|[SQLITE_OPEN_CREATE]. sl@0: ** sl@0: ** {H12711} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the sl@0: ** bit value [SQLITE_OPEN_READONLY] then the database is opened sl@0: ** for reading only. sl@0: ** sl@0: ** {H12712} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the sl@0: ** bit value [SQLITE_OPEN_READWRITE] then the database is opened sl@0: ** reading and writing if possible, or for reading only if the sl@0: ** file is write protected by the operating system. sl@0: ** sl@0: ** {H12713} If the G parameter to [sqlite3_open(v2(F,D,G,V)] omits the sl@0: ** bit value [SQLITE_OPEN_CREATE] and the database does not sl@0: ** previously exist, an error is returned. sl@0: ** sl@0: ** {H12714} If the G parameter to [sqlite3_open(v2(F,D,G,V)] contains the sl@0: ** bit value [SQLITE_OPEN_CREATE] and the database does not sl@0: ** previously exist, then an attempt is made to create and sl@0: ** initialize the database. sl@0: ** sl@0: ** {H12717} If the filename argument to [sqlite3_open()], [sqlite3_open16()], sl@0: ** or [sqlite3_open_v2()] is ":memory:", then an private, sl@0: ** ephemeral, in-memory database is created for the connection. sl@0: ** Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required sl@0: ** in sqlite3_open_v2()? sl@0: ** sl@0: ** {H12719} If the filename is NULL or an empty string, then a private, sl@0: ** ephemeral on-disk database will be created. sl@0: ** Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required sl@0: ** in sqlite3_open_v2()? sl@0: ** sl@0: ** {H12721} The [database connection] created by [sqlite3_open_v2(F,D,G,V)] sl@0: ** will use the [sqlite3_vfs] object identified by the V parameter, sl@0: ** or the default [sqlite3_vfs] object if V is a NULL pointer. sl@0: ** sl@0: ** {H12723} Two [database connections] will share a common cache if both were sl@0: ** opened with the same VFS while [shared cache mode] was enabled and sl@0: ** if both filenames compare equal using memcmp() after having been sl@0: ** processed by the [sqlite3_vfs | xFullPathname] method of the VFS. sl@0: */ sl@0: int sqlite3_open( sl@0: const char *filename, /* Database filename (UTF-8) */ sl@0: sqlite3 **ppDb /* OUT: SQLite db handle */ sl@0: ); sl@0: int sqlite3_open16( sl@0: const void *filename, /* Database filename (UTF-16) */ sl@0: sqlite3 **ppDb /* OUT: SQLite db handle */ sl@0: ); sl@0: int sqlite3_open_v2( sl@0: const char *filename, /* Database filename (UTF-8) */ sl@0: sqlite3 **ppDb, /* OUT: SQLite db handle */ sl@0: int flags, /* Flags */ sl@0: const char *zVfs /* Name of VFS module to use */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Error Codes And Messages {H12800} sl@0: ** sl@0: ** The sqlite3_errcode() interface returns the numeric [result code] or sl@0: ** [extended result code] for the most recent failed sqlite3_* API call sl@0: ** associated with a [database connection]. If a prior API call failed sl@0: ** but the most recent API call succeeded, the return value from sl@0: ** sqlite3_errcode() is undefined. sl@0: ** sl@0: ** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language sl@0: ** text that describes the error, as either UTF-8 or UTF-16 respectively. sl@0: ** Memory to hold the error message string is managed internally. sl@0: ** The application does not need to worry about freeing the result. sl@0: ** However, the error string might be overwritten or deallocated by sl@0: ** subsequent calls to other SQLite interface functions. sl@0: ** sl@0: ** If an interface fails with SQLITE_MISUSE, that means the interface sl@0: ** was invoked incorrectly by the application. In that case, the sl@0: ** error code and message may or may not be set. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12801} The [sqlite3_errcode(D)] interface returns the numeric sl@0: ** [result code] or [extended result code] for the most recently sl@0: ** failed interface call associated with the [database connection] D. sl@0: ** sl@0: ** {H12803} The [sqlite3_errmsg(D)] and [sqlite3_errmsg16(D)] sl@0: ** interfaces return English-language text that describes sl@0: ** the error in the mostly recently failed interface call, sl@0: ** encoded as either UTF-8 or UTF-16 respectively. sl@0: ** sl@0: ** {H12807} The strings returned by [sqlite3_errmsg()] and [sqlite3_errmsg16()] sl@0: ** are valid until the next SQLite interface call. sl@0: ** sl@0: ** {H12808} Calls to API routines that do not return an error code sl@0: ** (example: [sqlite3_data_count()]) do not sl@0: ** change the error code or message returned by sl@0: ** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()]. sl@0: ** sl@0: ** {H12809} Interfaces that are not associated with a specific sl@0: ** [database connection] (examples: sl@0: ** [sqlite3_mprintf()] or [sqlite3_enable_shared_cache()] sl@0: ** do not change the values returned by sl@0: ** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()]. sl@0: */ sl@0: int sqlite3_errcode(sqlite3 *db); sl@0: const char *sqlite3_errmsg(sqlite3*); sl@0: const void *sqlite3_errmsg16(sqlite3*); sl@0: sl@0: /* sl@0: ** CAPI3REF: SQL Statement Object {H13000} sl@0: ** KEYWORDS: {prepared statement} {prepared statements} sl@0: ** sl@0: ** An instance of this object represents a single SQL statement. sl@0: ** This object is variously known as a "prepared statement" or a sl@0: ** "compiled SQL statement" or simply as a "statement". sl@0: ** sl@0: ** The life of a statement object goes something like this: sl@0: ** sl@0: **
    sl@0: **
  1. Create the object using [sqlite3_prepare_v2()] or a related sl@0: ** function. sl@0: **
  2. Bind values to [host parameters] using the sqlite3_bind_*() sl@0: ** interfaces. sl@0: **
  3. Run the SQL by calling [sqlite3_step()] one or more times. sl@0: **
  4. Reset the statement using [sqlite3_reset()] then go back sl@0: ** to step 2. Do this zero or more times. sl@0: **
  5. Destroy the object using [sqlite3_finalize()]. sl@0: **
sl@0: ** sl@0: ** Refer to documentation on individual methods above for additional sl@0: ** information. sl@0: */ sl@0: typedef struct sqlite3_stmt sqlite3_stmt; sl@0: sl@0: /* sl@0: ** CAPI3REF: Run-time Limits {H12760} sl@0: ** sl@0: ** This interface allows the size of various constructs to be limited sl@0: ** on a connection by connection basis. The first parameter is the sl@0: ** [database connection] whose limit is to be set or queried. The sl@0: ** second parameter is one of the [limit categories] that define a sl@0: ** class of constructs to be size limited. The third parameter is the sl@0: ** new limit for that construct. The function returns the old limit. sl@0: ** sl@0: ** If the new limit is a negative number, the limit is unchanged. sl@0: ** For the limit category of SQLITE_LIMIT_XYZ there is a hard upper sl@0: ** bound set by a compile-time C preprocessor macro named SQLITE_MAX_XYZ. sl@0: ** (The "_LIMIT_" in the name is changed to "_MAX_".) sl@0: ** Attempts to increase a limit above its hard upper bound are sl@0: ** silently truncated to the hard upper limit. sl@0: ** sl@0: ** Run time limits are intended for use in applications that manage sl@0: ** both their own internal database and also databases that are controlled sl@0: ** by untrusted external sources. An example application might be a sl@0: ** webbrowser that has its own databases for storing history and sl@0: ** separate databases controlled by JavaScript applications downloaded sl@0: ** off the Internet. The internal databases can be given the sl@0: ** large, default limits. Databases managed by external sources can sl@0: ** be given much smaller limits designed to prevent a denial of service sl@0: ** attack. Developers might also want to use the [sqlite3_set_authorizer()] sl@0: ** interface to further control untrusted SQL. The size of the database sl@0: ** created by an untrusted script can be contained using the sl@0: ** [max_page_count] [PRAGMA]. sl@0: ** sl@0: ** New run-time limit categories may be added in future releases. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12762} A successful call to [sqlite3_limit(D,C,V)] where V is sl@0: ** positive changes the limit on the size of construct C in the sl@0: ** [database connection] D to the lesser of V and the hard upper sl@0: ** bound on the size of C that is set at compile-time. sl@0: ** sl@0: ** {H12766} A successful call to [sqlite3_limit(D,C,V)] where V is negative sl@0: ** leaves the state of the [database connection] D unchanged. sl@0: ** sl@0: ** {H12769} A successful call to [sqlite3_limit(D,C,V)] returns the sl@0: ** value of the limit on the size of construct C in the sl@0: ** [database connection] D as it was prior to the call. sl@0: */ sl@0: int sqlite3_limit(sqlite3*, int id, int newVal); sl@0: sl@0: /* sl@0: ** CAPI3REF: Run-Time Limit Categories {H12790} sl@0: ** KEYWORDS: {limit category} {limit categories} sl@0: ** sl@0: ** These constants define various aspects of a [database connection] sl@0: ** that can be limited in size by calls to [sqlite3_limit()]. sl@0: ** The meanings of the various limits are as follows: sl@0: ** sl@0: **
sl@0: **
SQLITE_LIMIT_LENGTH
sl@0: **
The maximum size of any string or BLOB or table row.
sl@0: ** sl@0: **
SQLITE_LIMIT_SQL_LENGTH
sl@0: **
The maximum length of an SQL statement.
sl@0: ** sl@0: **
SQLITE_LIMIT_COLUMN
sl@0: **
The maximum number of columns in a table definition or in the sl@0: ** result set of a SELECT or the maximum number of columns in an index sl@0: ** or in an ORDER BY or GROUP BY clause.
sl@0: ** sl@0: **
SQLITE_LIMIT_EXPR_DEPTH
sl@0: **
The maximum depth of the parse tree on any expression.
sl@0: ** sl@0: **
SQLITE_LIMIT_COMPOUND_SELECT
sl@0: **
The maximum number of terms in a compound SELECT statement.
sl@0: ** sl@0: **
SQLITE_LIMIT_VDBE_OP
sl@0: **
The maximum number of instructions in a virtual machine program sl@0: ** used to implement an SQL statement.
sl@0: ** sl@0: **
SQLITE_LIMIT_FUNCTION_ARG
sl@0: **
The maximum number of arguments on a function.
sl@0: ** sl@0: **
SQLITE_LIMIT_ATTACHED
sl@0: **
The maximum number of attached databases.
sl@0: ** sl@0: **
SQLITE_LIMIT_LIKE_PATTERN_LENGTH
sl@0: **
The maximum length of the pattern argument to the LIKE or sl@0: ** GLOB operators.
sl@0: ** sl@0: **
SQLITE_LIMIT_VARIABLE_NUMBER
sl@0: **
The maximum number of variables in an SQL statement that can sl@0: ** be bound.
sl@0: **
sl@0: */ sl@0: #define SQLITE_LIMIT_LENGTH 0 sl@0: #define SQLITE_LIMIT_SQL_LENGTH 1 sl@0: #define SQLITE_LIMIT_COLUMN 2 sl@0: #define SQLITE_LIMIT_EXPR_DEPTH 3 sl@0: #define SQLITE_LIMIT_COMPOUND_SELECT 4 sl@0: #define SQLITE_LIMIT_VDBE_OP 5 sl@0: #define SQLITE_LIMIT_FUNCTION_ARG 6 sl@0: #define SQLITE_LIMIT_ATTACHED 7 sl@0: #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 sl@0: #define SQLITE_LIMIT_VARIABLE_NUMBER 9 sl@0: sl@0: /* sl@0: ** CAPI3REF: Compiling An SQL Statement {H13010} sl@0: ** KEYWORDS: {SQL statement compiler} sl@0: ** sl@0: ** To execute an SQL query, it must first be compiled into a byte-code sl@0: ** program using one of these routines. sl@0: ** sl@0: ** The first argument, "db", is a [database connection] obtained from a sl@0: ** prior call to [sqlite3_open()], [sqlite3_open_v2()] or [sqlite3_open16()]. sl@0: ** sl@0: ** The second argument, "zSql", is the statement to be compiled, encoded sl@0: ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() sl@0: ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() sl@0: ** use UTF-16. sl@0: ** sl@0: ** If the nByte argument is less than zero, then zSql is read up to the sl@0: ** first zero terminator. If nByte is non-negative, then it is the maximum sl@0: ** number of bytes read from zSql. When nByte is non-negative, the sl@0: ** zSql string ends at either the first '\000' or '\u0000' character or sl@0: ** the nByte-th byte, whichever comes first. If the caller knows sl@0: ** that the supplied string is nul-terminated, then there is a small sl@0: ** performance advantage to be gained by passing an nByte parameter that sl@0: ** is equal to the number of bytes in the input string including sl@0: ** the nul-terminator bytes. sl@0: ** sl@0: ** *pzTail is made to point to the first byte past the end of the sl@0: ** first SQL statement in zSql. These routines only compile the first sl@0: ** statement in zSql, so *pzTail is left pointing to what remains sl@0: ** uncompiled. sl@0: ** sl@0: ** *ppStmt is left pointing to a compiled [prepared statement] that can be sl@0: ** executed using [sqlite3_step()]. If there is an error, *ppStmt is set sl@0: ** to NULL. If the input text contains no SQL (if the input is an empty sl@0: ** string or a comment) then *ppStmt is set to NULL. sl@0: ** {A13018} The calling procedure is responsible for deleting the compiled sl@0: ** SQL statement using [sqlite3_finalize()] after it has finished with it. sl@0: ** sl@0: ** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned. sl@0: ** sl@0: ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are sl@0: ** recommended for all new programs. The two older interfaces are retained sl@0: ** for backwards compatibility, but their use is discouraged. sl@0: ** In the "v2" interfaces, the prepared statement sl@0: ** that is returned (the [sqlite3_stmt] object) contains a copy of the sl@0: ** original SQL text. This causes the [sqlite3_step()] interface to sl@0: ** behave a differently in two ways: sl@0: ** sl@0: **
    sl@0: **
  1. sl@0: ** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it sl@0: ** always used to do, [sqlite3_step()] will automatically recompile the SQL sl@0: ** statement and try to run it again. If the schema has changed in sl@0: ** a way that makes the statement no longer valid, [sqlite3_step()] will still sl@0: ** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is sl@0: ** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the sl@0: ** error go away. Note: use [sqlite3_errmsg()] to find the text sl@0: ** of the parsing error that results in an [SQLITE_SCHEMA] return. sl@0: **
    2. sl@0: ** sl@0: **
  2. sl@0: ** When an error occurs, [sqlite3_step()] will return one of the detailed sl@0: ** [error codes] or [extended error codes]. The legacy behavior was that sl@0: ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code sl@0: ** and you would have to make a second call to [sqlite3_reset()] in order sl@0: ** to find the underlying cause of the problem. With the "v2" prepare sl@0: ** interfaces, the underlying reason for the error is returned immediately. sl@0: **
    3. sl@0: **
sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13011} The [sqlite3_prepare(db,zSql,...)] and sl@0: ** [sqlite3_prepare_v2(db,zSql,...)] interfaces interpret the sl@0: ** text in their zSql parameter as UTF-8. sl@0: ** sl@0: ** {H13012} The [sqlite3_prepare16(db,zSql,...)] and sl@0: ** [sqlite3_prepare16_v2(db,zSql,...)] interfaces interpret the sl@0: ** text in their zSql parameter as UTF-16 in the native byte order. sl@0: ** sl@0: ** {H13013} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)] sl@0: ** and its variants is less than zero, the SQL text is sl@0: ** read from zSql is read up to the first zero terminator. sl@0: ** sl@0: ** {H13014} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)] sl@0: ** and its variants is non-negative, then at most nBytes bytes of sl@0: ** SQL text is read from zSql. sl@0: ** sl@0: ** {H13015} In [sqlite3_prepare_v2(db,zSql,N,P,pzTail)] and its variants sl@0: ** if the zSql input text contains more than one SQL statement sl@0: ** and pzTail is not NULL, then *pzTail is made to point to the sl@0: ** first byte past the end of the first SQL statement in zSql. sl@0: ** What does *pzTail point to if there is one statement? sl@0: ** sl@0: ** {H13016} A successful call to [sqlite3_prepare_v2(db,zSql,N,ppStmt,...)] sl@0: ** or one of its variants writes into *ppStmt a pointer to a new sl@0: ** [prepared statement] or a pointer to NULL if zSql contains sl@0: ** nothing other than whitespace or comments. sl@0: ** sl@0: ** {H13019} The [sqlite3_prepare_v2()] interface and its variants return sl@0: ** [SQLITE_OK] or an appropriate [error code] upon failure. sl@0: ** sl@0: ** {H13021} Before [sqlite3_prepare(db,zSql,nByte,ppStmt,pzTail)] or its sl@0: ** variants returns an error (any value other than [SQLITE_OK]), sl@0: ** they first set *ppStmt to NULL. sl@0: */ sl@0: int sqlite3_prepare( sl@0: sqlite3 *db, /* Database handle */ sl@0: const char *zSql, /* SQL statement, UTF-8 encoded */ sl@0: int nByte, /* Maximum length of zSql in bytes. */ sl@0: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ sl@0: const char **pzTail /* OUT: Pointer to unused portion of zSql */ sl@0: ); sl@0: int sqlite3_prepare_v2( sl@0: sqlite3 *db, /* Database handle */ sl@0: const char *zSql, /* SQL statement, UTF-8 encoded */ sl@0: int nByte, /* Maximum length of zSql in bytes. */ sl@0: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ sl@0: const char **pzTail /* OUT: Pointer to unused portion of zSql */ sl@0: ); sl@0: int sqlite3_prepare16( sl@0: sqlite3 *db, /* Database handle */ sl@0: const void *zSql, /* SQL statement, UTF-16 encoded */ sl@0: int nByte, /* Maximum length of zSql in bytes. */ sl@0: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ sl@0: const void **pzTail /* OUT: Pointer to unused portion of zSql */ sl@0: ); sl@0: int sqlite3_prepare16_v2( sl@0: sqlite3 *db, /* Database handle */ sl@0: const void *zSql, /* SQL statement, UTF-16 encoded */ sl@0: int nByte, /* Maximum length of zSql in bytes. */ sl@0: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ sl@0: const void **pzTail /* OUT: Pointer to unused portion of zSql */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPIREF: Retrieving Statement SQL {H13100} sl@0: ** sl@0: ** This interface can be used to retrieve a saved copy of the original sl@0: ** SQL text used to create a [prepared statement] if that statement was sl@0: ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13101} If the [prepared statement] passed as the argument to sl@0: ** [sqlite3_sql()] was compiled using either [sqlite3_prepare_v2()] or sl@0: ** [sqlite3_prepare16_v2()], then [sqlite3_sql()] returns sl@0: ** a pointer to a zero-terminated string containing a UTF-8 rendering sl@0: ** of the original SQL statement. sl@0: ** sl@0: ** {H13102} If the [prepared statement] passed as the argument to sl@0: ** [sqlite3_sql()] was compiled using either [sqlite3_prepare()] or sl@0: ** [sqlite3_prepare16()], then [sqlite3_sql()] returns a NULL pointer. sl@0: ** sl@0: ** {H13103} The string returned by [sqlite3_sql(S)] is valid until the sl@0: ** [prepared statement] S is deleted using [sqlite3_finalize(S)]. sl@0: */ sl@0: const char *sqlite3_sql(sqlite3_stmt *pStmt); sl@0: sl@0: /* sl@0: ** CAPI3REF: Dynamically Typed Value Object {H15000} sl@0: ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} sl@0: ** sl@0: ** SQLite uses the sqlite3_value object to represent all values sl@0: ** that can be stored in a database table. SQLite uses dynamic typing sl@0: ** for the values it stores. Values stored in sqlite3_value objects sl@0: ** can be integers, floating point values, strings, BLOBs, or NULL. sl@0: ** sl@0: ** An sqlite3_value object may be either "protected" or "unprotected". sl@0: ** Some interfaces require a protected sqlite3_value. Other interfaces sl@0: ** will accept either a protected or an unprotected sqlite3_value. sl@0: ** Every interface that accepts sqlite3_value arguments specifies sl@0: ** whether or not it requires a protected sqlite3_value. sl@0: ** sl@0: ** The terms "protected" and "unprotected" refer to whether or not sl@0: ** a mutex is held. A internal mutex is held for a protected sl@0: ** sqlite3_value object but no mutex is held for an unprotected sl@0: ** sqlite3_value object. If SQLite is compiled to be single-threaded sl@0: ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) sl@0: ** or if SQLite is run in one of reduced mutex modes sl@0: ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] sl@0: ** then there is no distinction between protected and unprotected sl@0: ** sqlite3_value objects and they can be used interchangeably. However, sl@0: ** for maximum code portability it is recommended that applications sl@0: ** still make the distinction between between protected and unprotected sl@0: ** sqlite3_value objects even when not strictly required. sl@0: ** sl@0: ** The sqlite3_value objects that are passed as parameters into the sl@0: ** implementation of [application-defined SQL functions] are protected. sl@0: ** The sqlite3_value object returned by sl@0: ** [sqlite3_column_value()] is unprotected. sl@0: ** Unprotected sqlite3_value objects may only be used with sl@0: ** [sqlite3_result_value()] and [sqlite3_bind_value()]. sl@0: ** The [sqlite3_value_blob | sqlite3_value_type()] family of sl@0: ** interfaces require protected sqlite3_value objects. sl@0: */ sl@0: typedef struct Mem sqlite3_value; sl@0: sl@0: /* sl@0: ** CAPI3REF: SQL Function Context Object {H16001} sl@0: ** sl@0: ** The context in which an SQL function executes is stored in an sl@0: ** sqlite3_context object. A pointer to an sqlite3_context object sl@0: ** is always first parameter to [application-defined SQL functions]. sl@0: ** The application-defined SQL function implementation will pass this sl@0: ** pointer through into calls to [sqlite3_result_int | sqlite3_result()], sl@0: ** [sqlite3_aggregate_context()], [sqlite3_user_data()], sl@0: ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], sl@0: ** and/or [sqlite3_set_auxdata()]. sl@0: */ sl@0: typedef struct sqlite3_context sqlite3_context; sl@0: sl@0: /* sl@0: ** CAPI3REF: Binding Values To Prepared Statements {H13500} sl@0: ** KEYWORDS: {host parameter} {host parameters} {host parameter name} sl@0: ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} sl@0: ** sl@0: ** In the SQL strings input to [sqlite3_prepare_v2()] and its variants, sl@0: ** literals may be replaced by a parameter in one of these forms: sl@0: ** sl@0: **
    sl@0: **
  • ? sl@0: **
  • ?NNN sl@0: **
  • :VVV sl@0: **
  • @VVV sl@0: **
  • $VVV sl@0: **
sl@0: ** sl@0: ** In the parameter forms shown above NNN is an integer literal, sl@0: ** and VVV is an alpha-numeric parameter name. The values of these sl@0: ** parameters (also called "host parameter names" or "SQL parameters") sl@0: ** can be set using the sqlite3_bind_*() routines defined here. sl@0: ** sl@0: ** The first argument to the sqlite3_bind_*() routines is always sl@0: ** a pointer to the [sqlite3_stmt] object returned from sl@0: ** [sqlite3_prepare_v2()] or its variants. sl@0: ** sl@0: ** The second argument is the index of the SQL parameter to be set. sl@0: ** The leftmost SQL parameter has an index of 1. When the same named sl@0: ** SQL parameter is used more than once, second and subsequent sl@0: ** occurrences have the same index as the first occurrence. sl@0: ** The index for named parameters can be looked up using the sl@0: ** [sqlite3_bind_parameter_index()] API if desired. The index sl@0: ** for "?NNN" parameters is the value of NNN. sl@0: ** The NNN value must be between 1 and the [sqlite3_limit()] sl@0: ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). sl@0: ** sl@0: ** The third argument is the value to bind to the parameter. sl@0: ** sl@0: ** In those routines that have a fourth argument, its value is the sl@0: ** number of bytes in the parameter. To be clear: the value is the sl@0: ** number of bytes in the value, not the number of characters. sl@0: ** If the fourth parameter is negative, the length of the string is sl@0: ** the number of bytes up to the first zero terminator. sl@0: ** sl@0: ** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and sl@0: ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or sl@0: ** string after SQLite has finished with it. If the fifth argument is sl@0: ** the special value [SQLITE_STATIC], then SQLite assumes that the sl@0: ** information is in static, unmanaged space and does not need to be freed. sl@0: ** If the fifth argument has the value [SQLITE_TRANSIENT], then sl@0: ** SQLite makes its own private copy of the data immediately, before sl@0: ** the sqlite3_bind_*() routine returns. sl@0: ** sl@0: ** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that sl@0: ** is filled with zeroes. A zeroblob uses a fixed amount of memory sl@0: ** (just an integer to hold its size) while it is being processed. sl@0: ** Zeroblobs are intended to serve as placeholders for BLOBs whose sl@0: ** content is later written using sl@0: ** [sqlite3_blob_open | incremental BLOB I/O] routines. sl@0: ** A negative value for the zeroblob results in a zero-length BLOB. sl@0: ** sl@0: ** The sqlite3_bind_*() routines must be called after sl@0: ** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and sl@0: ** before [sqlite3_step()]. sl@0: ** Bindings are not cleared by the [sqlite3_reset()] routine. sl@0: ** Unbound parameters are interpreted as NULL. sl@0: ** sl@0: ** These routines return [SQLITE_OK] on success or an error code if sl@0: ** anything goes wrong. [SQLITE_RANGE] is returned if the parameter sl@0: ** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails. sl@0: ** [SQLITE_MISUSE] might be returned if these routines are called on a sl@0: ** virtual machine that is the wrong state or which has already been finalized. sl@0: ** Detection of misuse is unreliable. Applications should not depend sl@0: ** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a sl@0: ** a logic error in the application. Future versions of SQLite might sl@0: ** panic rather than return SQLITE_MISUSE. sl@0: ** sl@0: ** See also: [sqlite3_bind_parameter_count()], sl@0: ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13506} The [SQL statement compiler] recognizes tokens of the forms sl@0: ** "?", "?NNN", "$VVV", ":VVV", and "@VVV" as SQL parameters, sl@0: ** where NNN is any sequence of one or more digits sl@0: ** and where VVV is any sequence of one or more alphanumeric sl@0: ** characters or "::" optionally followed by a string containing sl@0: ** no spaces and contained within parentheses. sl@0: ** sl@0: ** {H13509} The initial value of an SQL parameter is NULL. sl@0: ** sl@0: ** {H13512} The index of an "?" SQL parameter is one larger than the sl@0: ** largest index of SQL parameter to the left, or 1 if sl@0: ** the "?" is the leftmost SQL parameter. sl@0: ** sl@0: ** {H13515} The index of an "?NNN" SQL parameter is the integer NNN. sl@0: ** sl@0: ** {H13518} The index of an ":VVV", "$VVV", or "@VVV" SQL parameter is sl@0: ** the same as the index of leftmost occurrences of the same sl@0: ** parameter, or one more than the largest index over all sl@0: ** parameters to the left if this is the first occurrence sl@0: ** of this parameter, or 1 if this is the leftmost parameter. sl@0: ** sl@0: ** {H13521} The [SQL statement compiler] fails with an [SQLITE_RANGE] sl@0: ** error if the index of an SQL parameter is less than 1 sl@0: ** or greater than the compile-time SQLITE_MAX_VARIABLE_NUMBER sl@0: ** parameter. sl@0: ** sl@0: ** {H13524} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,V,...)] sl@0: ** associate the value V with all SQL parameters having an sl@0: ** index of N in the [prepared statement] S. sl@0: ** sl@0: ** {H13527} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,...)] sl@0: ** override prior calls with the same values of S and N. sl@0: ** sl@0: ** {H13530} Bindings established by [sqlite3_bind_text | sqlite3_bind(S,...)] sl@0: ** persist across calls to [sqlite3_reset(S)]. sl@0: ** sl@0: ** {H13533} In calls to [sqlite3_bind_blob(S,N,V,L,D)], sl@0: ** [sqlite3_bind_text(S,N,V,L,D)], or sl@0: ** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds the first L sl@0: ** bytes of the BLOB or string pointed to by V, when L sl@0: ** is non-negative. sl@0: ** sl@0: ** {H13536} In calls to [sqlite3_bind_text(S,N,V,L,D)] or sl@0: ** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds characters sl@0: ** from V through the first zero character when L is negative. sl@0: ** sl@0: ** {H13539} In calls to [sqlite3_bind_blob(S,N,V,L,D)], sl@0: ** [sqlite3_bind_text(S,N,V,L,D)], or sl@0: ** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special sl@0: ** constant [SQLITE_STATIC], SQLite assumes that the value V sl@0: ** is held in static unmanaged space that will not change sl@0: ** during the lifetime of the binding. sl@0: ** sl@0: ** {H13542} In calls to [sqlite3_bind_blob(S,N,V,L,D)], sl@0: ** [sqlite3_bind_text(S,N,V,L,D)], or sl@0: ** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special sl@0: ** constant [SQLITE_TRANSIENT], the routine makes a sl@0: ** private copy of the value V before it returns. sl@0: ** sl@0: ** {H13545} In calls to [sqlite3_bind_blob(S,N,V,L,D)], sl@0: ** [sqlite3_bind_text(S,N,V,L,D)], or sl@0: ** [sqlite3_bind_text16(S,N,V,L,D)] when D is a pointer to sl@0: ** a function, SQLite invokes that function to destroy the sl@0: ** value V after it has finished using the value V. sl@0: ** sl@0: ** {H13548} In calls to [sqlite3_bind_zeroblob(S,N,V,L)] the value bound sl@0: ** is a BLOB of L bytes, or a zero-length BLOB if L is negative. sl@0: ** sl@0: ** {H13551} In calls to [sqlite3_bind_value(S,N,V)] the V argument may sl@0: ** be either a [protected sqlite3_value] object or an sl@0: ** [unprotected sqlite3_value] object. sl@0: */ sl@0: int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); sl@0: int sqlite3_bind_double(sqlite3_stmt*, int, double); sl@0: int sqlite3_bind_int(sqlite3_stmt*, int, int); sl@0: int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); sl@0: int sqlite3_bind_null(sqlite3_stmt*, int); sl@0: int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); sl@0: int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); sl@0: int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); sl@0: int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); sl@0: sl@0: /* sl@0: ** CAPI3REF: Number Of SQL Parameters {H13600} sl@0: ** sl@0: ** This routine can be used to find the number of [SQL parameters] sl@0: ** in a [prepared statement]. SQL parameters are tokens of the sl@0: ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as sl@0: ** placeholders for values that are [sqlite3_bind_blob | bound] sl@0: ** to the parameters at a later time. sl@0: ** sl@0: ** This routine actually returns the index of the largest (rightmost) sl@0: ** parameter. For all forms except ?NNN, this will correspond to the sl@0: ** number of unique parameters. If parameters of the ?NNN are used, sl@0: ** there may be gaps in the list. sl@0: ** sl@0: ** See also: [sqlite3_bind_blob|sqlite3_bind()], sl@0: ** [sqlite3_bind_parameter_name()], and sl@0: ** [sqlite3_bind_parameter_index()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13601} The [sqlite3_bind_parameter_count(S)] interface returns sl@0: ** the largest index of all SQL parameters in the sl@0: ** [prepared statement] S, or 0 if S contains no SQL parameters. sl@0: */ sl@0: int sqlite3_bind_parameter_count(sqlite3_stmt*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Name Of A Host Parameter {H13620} sl@0: ** sl@0: ** This routine returns a pointer to the name of the n-th sl@0: ** [SQL parameter] in a [prepared statement]. sl@0: ** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" sl@0: ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" sl@0: ** respectively. sl@0: ** In other words, the initial ":" or "$" or "@" or "?" sl@0: ** is included as part of the name. sl@0: ** Parameters of the form "?" without a following integer have no name sl@0: ** and are also referred to as "anonymous parameters". sl@0: ** sl@0: ** The first host parameter has an index of 1, not 0. sl@0: ** sl@0: ** If the value n is out of range or if the n-th parameter is sl@0: ** nameless, then NULL is returned. The returned string is sl@0: ** always in UTF-8 encoding even if the named parameter was sl@0: ** originally specified as UTF-16 in [sqlite3_prepare16()] or sl@0: ** [sqlite3_prepare16_v2()]. sl@0: ** sl@0: ** See also: [sqlite3_bind_blob|sqlite3_bind()], sl@0: ** [sqlite3_bind_parameter_count()], and sl@0: ** [sqlite3_bind_parameter_index()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13621} The [sqlite3_bind_parameter_name(S,N)] interface returns sl@0: ** a UTF-8 rendering of the name of the SQL parameter in sl@0: ** the [prepared statement] S having index N, or sl@0: ** NULL if there is no SQL parameter with index N or if the sl@0: ** parameter with index N is an anonymous parameter "?". sl@0: */ sl@0: const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); sl@0: sl@0: /* sl@0: ** CAPI3REF: Index Of A Parameter With A Given Name {H13640} sl@0: ** sl@0: ** Return the index of an SQL parameter given its name. The sl@0: ** index value returned is suitable for use as the second sl@0: ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero sl@0: ** is returned if no matching parameter is found. The parameter sl@0: ** name must be given in UTF-8 even if the original statement sl@0: ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. sl@0: ** sl@0: ** See also: [sqlite3_bind_blob|sqlite3_bind()], sl@0: ** [sqlite3_bind_parameter_count()], and sl@0: ** [sqlite3_bind_parameter_index()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13641} The [sqlite3_bind_parameter_index(S,N)] interface returns sl@0: ** the index of SQL parameter in the [prepared statement] sl@0: ** S whose name matches the UTF-8 string N, or 0 if there is sl@0: ** no match. sl@0: */ sl@0: int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); sl@0: sl@0: /* sl@0: ** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} sl@0: ** sl@0: ** Contrary to the intuition of many, [sqlite3_reset()] does not reset sl@0: ** the [sqlite3_bind_blob | bindings] on a [prepared statement]. sl@0: ** Use this routine to reset all host parameters to NULL. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13661} The [sqlite3_clear_bindings(S)] interface resets all SQL sl@0: ** parameter bindings in the [prepared statement] S back to NULL. sl@0: */ sl@0: int sqlite3_clear_bindings(sqlite3_stmt*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Number Of Columns In A Result Set {H13710} sl@0: ** sl@0: ** Return the number of columns in the result set returned by the sl@0: ** [prepared statement]. This routine returns 0 if pStmt is an SQL sl@0: ** statement that does not return data (for example an [UPDATE]). sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13711} The [sqlite3_column_count(S)] interface returns the number of sl@0: ** columns in the result set generated by the [prepared statement] S, sl@0: ** or 0 if S does not generate a result set. sl@0: */ sl@0: int sqlite3_column_count(sqlite3_stmt *pStmt); sl@0: sl@0: /* sl@0: ** CAPI3REF: Column Names In A Result Set {H13720} sl@0: ** sl@0: ** These routines return the name assigned to a particular column sl@0: ** in the result set of a [SELECT] statement. The sqlite3_column_name() sl@0: ** interface returns a pointer to a zero-terminated UTF-8 string sl@0: ** and sqlite3_column_name16() returns a pointer to a zero-terminated sl@0: ** UTF-16 string. The first parameter is the [prepared statement] sl@0: ** that implements the [SELECT] statement. The second parameter is the sl@0: ** column number. The leftmost column is number 0. sl@0: ** sl@0: ** The returned string pointer is valid until either the [prepared statement] sl@0: ** is destroyed by [sqlite3_finalize()] or until the next call to sl@0: ** sqlite3_column_name() or sqlite3_column_name16() on the same column. sl@0: ** sl@0: ** If sqlite3_malloc() fails during the processing of either routine sl@0: ** (for example during a conversion from UTF-8 to UTF-16) then a sl@0: ** NULL pointer is returned. sl@0: ** sl@0: ** The name of a result column is the value of the "AS" clause for sl@0: ** that column, if there is an AS clause. If there is no AS clause sl@0: ** then the name of the column is unspecified and may change from sl@0: ** one release of SQLite to the next. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13721} A successful invocation of the [sqlite3_column_name(S,N)] sl@0: ** interface returns the name of the Nth column (where 0 is sl@0: ** the leftmost column) for the result set of the sl@0: ** [prepared statement] S as a zero-terminated UTF-8 string. sl@0: ** sl@0: ** {H13723} A successful invocation of the [sqlite3_column_name16(S,N)] sl@0: ** interface returns the name of the Nth column (where 0 is sl@0: ** the leftmost column) for the result set of the sl@0: ** [prepared statement] S as a zero-terminated UTF-16 string sl@0: ** in the native byte order. sl@0: ** sl@0: ** {H13724} The [sqlite3_column_name()] and [sqlite3_column_name16()] sl@0: ** interfaces return a NULL pointer if they are unable to sl@0: ** allocate memory to hold their normal return strings. sl@0: ** sl@0: ** {H13725} If the N parameter to [sqlite3_column_name(S,N)] or sl@0: ** [sqlite3_column_name16(S,N)] is out of range, then the sl@0: ** interfaces return a NULL pointer. sl@0: ** sl@0: ** {H13726} The strings returned by [sqlite3_column_name(S,N)] and sl@0: ** [sqlite3_column_name16(S,N)] are valid until the next sl@0: ** call to either routine with the same S and N parameters sl@0: ** or until [sqlite3_finalize(S)] is called. sl@0: ** sl@0: ** {H13727} When a result column of a [SELECT] statement contains sl@0: ** an AS clause, the name of that column is the identifier sl@0: ** to the right of the AS keyword. sl@0: */ sl@0: const char *sqlite3_column_name(sqlite3_stmt*, int N); sl@0: const void *sqlite3_column_name16(sqlite3_stmt*, int N); sl@0: sl@0: /* sl@0: ** CAPI3REF: Source Of Data In A Query Result {H13740} sl@0: ** sl@0: ** These routines provide a means to determine what column of what sl@0: ** table in which database a result of a [SELECT] statement comes from. sl@0: ** The name of the database or table or column can be returned as sl@0: ** either a UTF-8 or UTF-16 string. The _database_ routines return sl@0: ** the database name, the _table_ routines return the table name, and sl@0: ** the origin_ routines return the column name. sl@0: ** The returned string is valid until the [prepared statement] is destroyed sl@0: ** using [sqlite3_finalize()] or until the same information is requested sl@0: ** again in a different encoding. sl@0: ** sl@0: ** The names returned are the original un-aliased names of the sl@0: ** database, table, and column. sl@0: ** sl@0: ** The first argument to the following calls is a [prepared statement]. sl@0: ** These functions return information about the Nth column returned by sl@0: ** the statement, where N is the second function argument. sl@0: ** sl@0: ** If the Nth column returned by the statement is an expression or sl@0: ** subquery and is not a column value, then all of these functions return sl@0: ** NULL. These routine might also return NULL if a memory allocation error sl@0: ** occurs. Otherwise, they return the name of the attached database, table sl@0: ** and column that query result column was extracted from. sl@0: ** sl@0: ** As with all other SQLite APIs, those postfixed with "16" return sl@0: ** UTF-16 encoded strings, the other functions return UTF-8. {END} sl@0: ** sl@0: ** These APIs are only available if the library was compiled with the sl@0: ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. sl@0: ** sl@0: ** {A13751} sl@0: ** If two or more threads call one or more of these routines against the same sl@0: ** prepared statement and column at the same time then the results are sl@0: ** undefined. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13741} The [sqlite3_column_database_name(S,N)] interface returns either sl@0: ** the UTF-8 zero-terminated name of the database from which the sl@0: ** Nth result column of the [prepared statement] S is extracted, sl@0: ** or NULL if the Nth column of S is a general expression sl@0: ** or if unable to allocate memory to store the name. sl@0: ** sl@0: ** {H13742} The [sqlite3_column_database_name16(S,N)] interface returns either sl@0: ** the UTF-16 native byte order zero-terminated name of the database sl@0: ** from which the Nth result column of the [prepared statement] S is sl@0: ** extracted, or NULL if the Nth column of S is a general expression sl@0: ** or if unable to allocate memory to store the name. sl@0: ** sl@0: ** {H13743} The [sqlite3_column_table_name(S,N)] interface returns either sl@0: ** the UTF-8 zero-terminated name of the table from which the sl@0: ** Nth result column of the [prepared statement] S is extracted, sl@0: ** or NULL if the Nth column of S is a general expression sl@0: ** or if unable to allocate memory to store the name. sl@0: ** sl@0: ** {H13744} The [sqlite3_column_table_name16(S,N)] interface returns either sl@0: ** the UTF-16 native byte order zero-terminated name of the table sl@0: ** from which the Nth result column of the [prepared statement] S is sl@0: ** extracted, or NULL if the Nth column of S is a general expression sl@0: ** or if unable to allocate memory to store the name. sl@0: ** sl@0: ** {H13745} The [sqlite3_column_origin_name(S,N)] interface returns either sl@0: ** the UTF-8 zero-terminated name of the table column from which the sl@0: ** Nth result column of the [prepared statement] S is extracted, sl@0: ** or NULL if the Nth column of S is a general expression sl@0: ** or if unable to allocate memory to store the name. sl@0: ** sl@0: ** {H13746} The [sqlite3_column_origin_name16(S,N)] interface returns either sl@0: ** the UTF-16 native byte order zero-terminated name of the table sl@0: ** column from which the Nth result column of the sl@0: ** [prepared statement] S is extracted, or NULL if the Nth column sl@0: ** of S is a general expression or if unable to allocate memory sl@0: ** to store the name. sl@0: ** sl@0: ** {H13748} The return values from sl@0: ** [sqlite3_column_database_name | column metadata interfaces] sl@0: ** are valid for the lifetime of the [prepared statement] sl@0: ** or until the encoding is changed by another metadata sl@0: ** interface call for the same prepared statement and column. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A13751} If two or more threads call one or more sl@0: ** [sqlite3_column_database_name | column metadata interfaces] sl@0: ** for the same [prepared statement] and result column sl@0: ** at the same time then the results are undefined. sl@0: */ sl@0: const char *sqlite3_column_database_name(sqlite3_stmt*,int); sl@0: const void *sqlite3_column_database_name16(sqlite3_stmt*,int); sl@0: const char *sqlite3_column_table_name(sqlite3_stmt*,int); sl@0: const void *sqlite3_column_table_name16(sqlite3_stmt*,int); sl@0: const char *sqlite3_column_origin_name(sqlite3_stmt*,int); sl@0: const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); sl@0: sl@0: /* sl@0: ** CAPI3REF: Declared Datatype Of A Query Result {H13760} sl@0: ** sl@0: ** The first parameter is a [prepared statement]. sl@0: ** If this statement is a [SELECT] statement and the Nth column of the sl@0: ** returned result set of that [SELECT] is a table column (not an sl@0: ** expression or subquery) then the declared type of the table sl@0: ** column is returned. If the Nth column of the result set is an sl@0: ** expression or subquery, then a NULL pointer is returned. sl@0: ** The returned string is always UTF-8 encoded. {END} sl@0: ** sl@0: ** For example, given the database schema: sl@0: ** sl@0: ** CREATE TABLE t1(c1 VARIANT); sl@0: ** sl@0: ** and the following statement to be compiled: sl@0: ** sl@0: ** SELECT c1 + 1, c1 FROM t1; sl@0: ** sl@0: ** this routine would return the string "VARIANT" for the second result sl@0: ** column (i==1), and a NULL pointer for the first result column (i==0). sl@0: ** sl@0: ** SQLite uses dynamic run-time typing. So just because a column sl@0: ** is declared to contain a particular type does not mean that the sl@0: ** data stored in that column is of the declared type. SQLite is sl@0: ** strongly typed, but the typing is dynamic not static. Type sl@0: ** is associated with individual values, not with the containers sl@0: ** used to hold those values. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13761} A successful call to [sqlite3_column_decltype(S,N)] returns a sl@0: ** zero-terminated UTF-8 string containing the declared datatype sl@0: ** of the table column that appears as the Nth column (numbered sl@0: ** from 0) of the result set to the [prepared statement] S. sl@0: ** sl@0: ** {H13762} A successful call to [sqlite3_column_decltype16(S,N)] sl@0: ** returns a zero-terminated UTF-16 native byte order string sl@0: ** containing the declared datatype of the table column that appears sl@0: ** as the Nth column (numbered from 0) of the result set to the sl@0: ** [prepared statement] S. sl@0: ** sl@0: ** {H13763} If N is less than 0 or N is greater than or equal to sl@0: ** the number of columns in the [prepared statement] S, sl@0: ** or if the Nth column of S is an expression or subquery rather sl@0: ** than a table column, or if a memory allocation failure sl@0: ** occurs during encoding conversions, then sl@0: ** calls to [sqlite3_column_decltype(S,N)] or sl@0: ** [sqlite3_column_decltype16(S,N)] return NULL. sl@0: */ sl@0: const char *sqlite3_column_decltype(sqlite3_stmt*,int); sl@0: const void *sqlite3_column_decltype16(sqlite3_stmt*,int); sl@0: sl@0: /* sl@0: ** CAPI3REF: Evaluate An SQL Statement {H13200} sl@0: ** sl@0: ** After a [prepared statement] has been prepared using either sl@0: ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy sl@0: ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function sl@0: ** must be called one or more times to evaluate the statement. sl@0: ** sl@0: ** The details of the behavior of the sqlite3_step() interface depend sl@0: ** on whether the statement was prepared using the newer "v2" interface sl@0: ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy sl@0: ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the sl@0: ** new "v2" interface is recommended for new applications but the legacy sl@0: ** interface will continue to be supported. sl@0: ** sl@0: ** In the legacy interface, the return value will be either [SQLITE_BUSY], sl@0: ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. sl@0: ** With the "v2" interface, any of the other [result codes] or sl@0: ** [extended result codes] might be returned as well. sl@0: ** sl@0: ** [SQLITE_BUSY] means that the database engine was unable to acquire the sl@0: ** database locks it needs to do its job. If the statement is a [COMMIT] sl@0: ** or occurs outside of an explicit transaction, then you can retry the sl@0: ** statement. If the statement is not a [COMMIT] and occurs within a sl@0: ** explicit transaction then you should rollback the transaction before sl@0: ** continuing. sl@0: ** sl@0: ** [SQLITE_DONE] means that the statement has finished executing sl@0: ** successfully. sqlite3_step() should not be called again on this virtual sl@0: ** machine without first calling [sqlite3_reset()] to reset the virtual sl@0: ** machine back to its initial state. sl@0: ** sl@0: ** If the SQL statement being executed returns any data, then [SQLITE_ROW] sl@0: ** is returned each time a new row of data is ready for processing by the sl@0: ** caller. The values may be accessed using the [column access functions]. sl@0: ** sqlite3_step() is called again to retrieve the next row of data. sl@0: ** sl@0: ** [SQLITE_ERROR] means that a run-time error (such as a constraint sl@0: ** violation) has occurred. sqlite3_step() should not be called again on sl@0: ** the VM. More information may be found by calling [sqlite3_errmsg()]. sl@0: ** With the legacy interface, a more specific error code (for example, sl@0: ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) sl@0: ** can be obtained by calling [sqlite3_reset()] on the sl@0: ** [prepared statement]. In the "v2" interface, sl@0: ** the more specific error code is returned directly by sqlite3_step(). sl@0: ** sl@0: ** [SQLITE_MISUSE] means that the this routine was called inappropriately. sl@0: ** Perhaps it was called on a [prepared statement] that has sl@0: ** already been [sqlite3_finalize | finalized] or on one that had sl@0: ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could sl@0: ** be the case that the same database connection is being used by two or sl@0: ** more threads at the same moment in time. sl@0: ** sl@0: ** Goofy Interface Alert: In the legacy interface, the sqlite3_step() sl@0: ** API always returns a generic error code, [SQLITE_ERROR], following any sl@0: ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call sl@0: ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the sl@0: ** specific [error codes] that better describes the error. sl@0: ** We admit that this is a goofy design. The problem has been fixed sl@0: ** with the "v2" interface. If you prepare all of your SQL statements sl@0: ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead sl@0: ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, sl@0: ** then the more specific [error codes] are returned directly sl@0: ** by sqlite3_step(). The use of the "v2" interface is recommended. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13202} If the [prepared statement] S is ready to be run, then sl@0: ** [sqlite3_step(S)] advances that prepared statement until sl@0: ** completion or until it is ready to return another row of the sl@0: ** result set, or until an [sqlite3_interrupt | interrupt] sl@0: ** or a run-time error occurs. sl@0: ** sl@0: ** {H15304} When a call to [sqlite3_step(S)] causes the [prepared statement] sl@0: ** S to run to completion, the function returns [SQLITE_DONE]. sl@0: ** sl@0: ** {H15306} When a call to [sqlite3_step(S)] stops because it is ready to sl@0: ** return another row of the result set, it returns [SQLITE_ROW]. sl@0: ** sl@0: ** {H15308} If a call to [sqlite3_step(S)] encounters an sl@0: ** [sqlite3_interrupt | interrupt] or a run-time error, sl@0: ** it returns an appropriate error code that is not one of sl@0: ** [SQLITE_OK], [SQLITE_ROW], or [SQLITE_DONE]. sl@0: ** sl@0: ** {H15310} If an [sqlite3_interrupt | interrupt] or a run-time error sl@0: ** occurs during a call to [sqlite3_step(S)] sl@0: ** for a [prepared statement] S created using sl@0: ** legacy interfaces [sqlite3_prepare()] or sl@0: ** [sqlite3_prepare16()], then the function returns either sl@0: ** [SQLITE_ERROR], [SQLITE_BUSY], or [SQLITE_MISUSE]. sl@0: */ sl@0: int sqlite3_step(sqlite3_stmt*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Number of columns in a result set {H13770} sl@0: ** sl@0: ** Returns the number of values in the current row of the result set. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13771} After a call to [sqlite3_step(S)] that returns [SQLITE_ROW], sl@0: ** the [sqlite3_data_count(S)] routine will return the same value sl@0: ** as the [sqlite3_column_count(S)] function. sl@0: ** sl@0: ** {H13772} After [sqlite3_step(S)] has returned any value other than sl@0: ** [SQLITE_ROW] or before [sqlite3_step(S)] has been called on the sl@0: ** [prepared statement] for the first time since it was sl@0: ** [sqlite3_prepare | prepared] or [sqlite3_reset | reset], sl@0: ** the [sqlite3_data_count(S)] routine returns zero. sl@0: */ sl@0: int sqlite3_data_count(sqlite3_stmt *pStmt); sl@0: sl@0: /* sl@0: ** CAPI3REF: Fundamental Datatypes {H10265} sl@0: ** KEYWORDS: SQLITE_TEXT sl@0: ** sl@0: ** {H10266} Every value in SQLite has one of five fundamental datatypes: sl@0: ** sl@0: **
    sl@0: **
  • 64-bit signed integer sl@0: **
  • 64-bit IEEE floating point number sl@0: **
  • string sl@0: **
  • BLOB sl@0: **
  • NULL sl@0: **
{END} sl@0: ** sl@0: ** These constants are codes for each of those types. sl@0: ** sl@0: ** Note that the SQLITE_TEXT constant was also used in SQLite version 2 sl@0: ** for a completely different meaning. Software that links against both sl@0: ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not sl@0: ** SQLITE_TEXT. sl@0: */ sl@0: #define SQLITE_INTEGER 1 sl@0: #define SQLITE_FLOAT 2 sl@0: #define SQLITE_BLOB 4 sl@0: #define SQLITE_NULL 5 sl@0: #ifdef SQLITE_TEXT sl@0: # undef SQLITE_TEXT sl@0: #else sl@0: # define SQLITE_TEXT 3 sl@0: #endif sl@0: #define SQLITE3_TEXT 3 sl@0: sl@0: /* sl@0: ** CAPI3REF: Result Values From A Query {H13800} sl@0: ** KEYWORDS: {column access functions} sl@0: ** sl@0: ** These routines form the "result set query" interface. sl@0: ** sl@0: ** These routines return information about a single column of the current sl@0: ** result row of a query. In every case the first argument is a pointer sl@0: ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] sl@0: ** that was returned from [sqlite3_prepare_v2()] or one of its variants) sl@0: ** and the second argument is the index of the column for which information sl@0: ** should be returned. The leftmost column of the result set has the index 0. sl@0: ** sl@0: ** If the SQL statement does not currently point to a valid row, or if the sl@0: ** column index is out of range, the result is undefined. sl@0: ** These routines may only be called when the most recent call to sl@0: ** [sqlite3_step()] has returned [SQLITE_ROW] and neither sl@0: ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. sl@0: ** If any of these routines are called after [sqlite3_reset()] or sl@0: ** [sqlite3_finalize()] or after [sqlite3_step()] has returned sl@0: ** something other than [SQLITE_ROW], the results are undefined. sl@0: ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] sl@0: ** are called from a different thread while any of these routines sl@0: ** are pending, then the results are undefined. sl@0: ** sl@0: ** The sqlite3_column_type() routine returns the sl@0: ** [SQLITE_INTEGER | datatype code] for the initial data type sl@0: ** of the result column. The returned value is one of [SQLITE_INTEGER], sl@0: ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value sl@0: ** returned by sqlite3_column_type() is only meaningful if no type sl@0: ** conversions have occurred as described below. After a type conversion, sl@0: ** the value returned by sqlite3_column_type() is undefined. Future sl@0: ** versions of SQLite may change the behavior of sqlite3_column_type() sl@0: ** following a type conversion. sl@0: ** sl@0: ** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() sl@0: ** routine returns the number of bytes in that BLOB or string. sl@0: ** If the result is a UTF-16 string, then sqlite3_column_bytes() converts sl@0: ** the string to UTF-8 and then returns the number of bytes. sl@0: ** If the result is a numeric value then sqlite3_column_bytes() uses sl@0: ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns sl@0: ** the number of bytes in that string. sl@0: ** The value returned does not include the zero terminator at the end sl@0: ** of the string. For clarity: the value returned is the number of sl@0: ** bytes in the string, not the number of characters. sl@0: ** sl@0: ** Strings returned by sqlite3_column_text() and sqlite3_column_text16(), sl@0: ** even empty strings, are always zero terminated. The return sl@0: ** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary sl@0: ** pointer, possibly even a NULL pointer. sl@0: ** sl@0: ** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes() sl@0: ** but leaves the result in UTF-16 in native byte order instead of UTF-8. sl@0: ** The zero terminator is not included in this count. sl@0: ** sl@0: ** The object returned by [sqlite3_column_value()] is an sl@0: ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object sl@0: ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. sl@0: ** If the [unprotected sqlite3_value] object returned by sl@0: ** [sqlite3_column_value()] is used in any other way, including calls sl@0: ** to routines like [sqlite3_value_int()], [sqlite3_value_text()], sl@0: ** or [sqlite3_value_bytes()], then the behavior is undefined. sl@0: ** sl@0: ** These routines attempt to convert the value where appropriate. For sl@0: ** example, if the internal representation is FLOAT and a text result sl@0: ** is requested, [sqlite3_snprintf()] is used internally to perform the sl@0: ** conversion automatically. The following table details the conversions sl@0: ** that are applied: sl@0: ** sl@0: **
sl@0: ** sl@0: **
Internal
Type 		Requested
Type 		Conversion sl@0: ** sl@0: **
NULL INTEGER Result is 0 sl@0: **
NULL FLOAT Result is 0.0 sl@0: **
NULL TEXT Result is NULL pointer sl@0: **
NULL BLOB Result is NULL pointer sl@0: **
INTEGER FLOAT Convert from integer to float sl@0: **
INTEGER TEXT ASCII rendering of the integer sl@0: **
INTEGER BLOB Same as INTEGER->TEXT sl@0: **
FLOAT INTEGER Convert from float to integer sl@0: **
FLOAT TEXT ASCII rendering of the float sl@0: **
FLOAT BLOB Same as FLOAT->TEXT sl@0: **
TEXT INTEGER Use atoi() sl@0: **
TEXT FLOAT Use atof() sl@0: **
TEXT BLOB No change sl@0: **
BLOB INTEGER Convert to TEXT then use atoi() sl@0: **
BLOB FLOAT Convert to TEXT then use atof() sl@0: **
BLOB TEXT Add a zero terminator if needed sl@0: **
sl@0: **
sl@0: ** sl@0: ** The table above makes reference to standard C library functions atoi() sl@0: ** and atof(). SQLite does not really use these functions. It has its sl@0: ** own equivalent internal routines. The atoi() and atof() names are sl@0: ** used in the table for brevity and because they are familiar to most sl@0: ** C programmers. sl@0: ** sl@0: ** Note that when type conversions occur, pointers returned by prior sl@0: ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or sl@0: ** sqlite3_column_text16() may be invalidated. sl@0: ** Type conversions and pointer invalidations might occur sl@0: ** in the following cases: sl@0: ** sl@0: **
    sl@0: **
  • The initial content is a BLOB and sqlite3_column_text() or sl@0: ** sqlite3_column_text16() is called. A zero-terminator might sl@0: ** need to be added to the string.
    • sl@0: **
  • The initial content is UTF-8 text and sqlite3_column_bytes16() or sl@0: ** sqlite3_column_text16() is called. The content must be converted sl@0: ** to UTF-16.
    • sl@0: **
  • The initial content is UTF-16 text and sqlite3_column_bytes() or sl@0: ** sqlite3_column_text() is called. The content must be converted sl@0: ** to UTF-8.
    • sl@0: **
sl@0: ** sl@0: ** Conversions between UTF-16be and UTF-16le are always done in place and do sl@0: ** not invalidate a prior pointer, though of course the content of the buffer sl@0: ** that the prior pointer points to will have been modified. Other kinds sl@0: ** of conversion are done in place when it is possible, but sometimes they sl@0: ** are not possible and in those cases prior pointers are invalidated. sl@0: ** sl@0: ** The safest and easiest to remember policy is to invoke these routines sl@0: ** in one of the following ways: sl@0: ** sl@0: **
    sl@0: **
  • sqlite3_column_text() followed by sqlite3_column_bytes()
    • sl@0: **
  • sqlite3_column_blob() followed by sqlite3_column_bytes()
    • sl@0: **
  • sqlite3_column_text16() followed by sqlite3_column_bytes16()
    • sl@0: **
sl@0: ** sl@0: ** In other words, you should call sqlite3_column_text(), sl@0: ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result sl@0: ** into the desired format, then invoke sqlite3_column_bytes() or sl@0: ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls sl@0: ** to sqlite3_column_text() or sqlite3_column_blob() with calls to sl@0: ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() sl@0: ** with calls to sqlite3_column_bytes(). sl@0: ** sl@0: ** The pointers returned are valid until a type conversion occurs as sl@0: ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or sl@0: ** [sqlite3_finalize()] is called. The memory space used to hold strings sl@0: ** and BLOBs is freed automatically. Do not pass the pointers returned sl@0: ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into sl@0: ** [sqlite3_free()]. sl@0: ** sl@0: ** If a memory allocation error occurs during the evaluation of any sl@0: ** of these routines, a default value is returned. The default value sl@0: ** is either the integer 0, the floating point number 0.0, or a NULL sl@0: ** pointer. Subsequent calls to [sqlite3_errcode()] will return sl@0: ** [SQLITE_NOMEM]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13803} The [sqlite3_column_blob(S,N)] interface converts the sl@0: ** Nth column in the current row of the result set for sl@0: ** the [prepared statement] S into a BLOB and then returns a sl@0: ** pointer to the converted value. sl@0: ** sl@0: ** {H13806} The [sqlite3_column_bytes(S,N)] interface returns the sl@0: ** number of bytes in the BLOB or string (exclusive of the sl@0: ** zero terminator on the string) that was returned by the sl@0: ** most recent call to [sqlite3_column_blob(S,N)] or sl@0: ** [sqlite3_column_text(S,N)]. sl@0: ** sl@0: ** {H13809} The [sqlite3_column_bytes16(S,N)] interface returns the sl@0: ** number of bytes in the string (exclusive of the sl@0: ** zero terminator on the string) that was returned by the sl@0: ** most recent call to [sqlite3_column_text16(S,N)]. sl@0: ** sl@0: ** {H13812} The [sqlite3_column_double(S,N)] interface converts the sl@0: ** Nth column in the current row of the result set for the sl@0: ** [prepared statement] S into a floating point value and sl@0: ** returns a copy of that value. sl@0: ** sl@0: ** {H13815} The [sqlite3_column_int(S,N)] interface converts the sl@0: ** Nth column in the current row of the result set for the sl@0: ** [prepared statement] S into a 64-bit signed integer and sl@0: ** returns the lower 32 bits of that integer. sl@0: ** sl@0: ** {H13818} The [sqlite3_column_int64(S,N)] interface converts the sl@0: ** Nth column in the current row of the result set for the sl@0: ** [prepared statement] S into a 64-bit signed integer and sl@0: ** returns a copy of that integer. sl@0: ** sl@0: ** {H13821} The [sqlite3_column_text(S,N)] interface converts the sl@0: ** Nth column in the current row of the result set for sl@0: ** the [prepared statement] S into a zero-terminated UTF-8 sl@0: ** string and returns a pointer to that string. sl@0: ** sl@0: ** {H13824} The [sqlite3_column_text16(S,N)] interface converts the sl@0: ** Nth column in the current row of the result set for the sl@0: ** [prepared statement] S into a zero-terminated 2-byte sl@0: ** aligned UTF-16 native byte order string and returns sl@0: ** a pointer to that string. sl@0: ** sl@0: ** {H13827} The [sqlite3_column_type(S,N)] interface returns sl@0: ** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT], sl@0: ** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for sl@0: ** the Nth column in the current row of the result set for sl@0: ** the [prepared statement] S. sl@0: ** sl@0: ** {H13830} The [sqlite3_column_value(S,N)] interface returns a sl@0: ** pointer to an [unprotected sqlite3_value] object for the sl@0: ** Nth column in the current row of the result set for sl@0: ** the [prepared statement] S. sl@0: */ sl@0: const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); sl@0: int sqlite3_column_bytes(sqlite3_stmt*, int iCol); sl@0: int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); sl@0: double sqlite3_column_double(sqlite3_stmt*, int iCol); sl@0: int sqlite3_column_int(sqlite3_stmt*, int iCol); sl@0: sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); sl@0: const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); sl@0: const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); sl@0: int sqlite3_column_type(sqlite3_stmt*, int iCol); sl@0: sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); sl@0: sl@0: /* sl@0: ** CAPI3REF: Destroy A Prepared Statement Object {H13300} sl@0: ** sl@0: ** The sqlite3_finalize() function is called to delete a [prepared statement]. sl@0: ** If the statement was executed successfully or not executed at all, then sl@0: ** SQLITE_OK is returned. If execution of the statement failed then an sl@0: ** [error code] or [extended error code] is returned. sl@0: ** sl@0: ** This routine can be called at any point during the execution of the sl@0: ** [prepared statement]. If the virtual machine has not sl@0: ** completed execution when this routine is called, that is like sl@0: ** encountering an error or an [sqlite3_interrupt | interrupt]. sl@0: ** Incomplete updates may be rolled back and transactions canceled, sl@0: ** depending on the circumstances, and the sl@0: ** [error code] returned will be [SQLITE_ABORT]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H11302} The [sqlite3_finalize(S)] interface destroys the sl@0: ** [prepared statement] S and releases all sl@0: ** memory and file resources held by that object. sl@0: ** sl@0: ** {H11304} If the most recent call to [sqlite3_step(S)] for the sl@0: ** [prepared statement] S returned an error, sl@0: ** then [sqlite3_finalize(S)] returns that same error. sl@0: */ sl@0: int sqlite3_finalize(sqlite3_stmt *pStmt); sl@0: sl@0: /* sl@0: ** CAPI3REF: Reset A Prepared Statement Object {H13330} sl@0: ** sl@0: ** The sqlite3_reset() function is called to reset a [prepared statement] sl@0: ** object back to its initial state, ready to be re-executed. sl@0: ** Any SQL statement variables that had values bound to them using sl@0: ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. sl@0: ** Use [sqlite3_clear_bindings()] to reset the bindings. sl@0: ** sl@0: ** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S sl@0: ** back to the beginning of its program. sl@0: ** sl@0: ** {H11334} If the most recent call to [sqlite3_step(S)] for the sl@0: ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], sl@0: ** or if [sqlite3_step(S)] has never before been called on S, sl@0: ** then [sqlite3_reset(S)] returns [SQLITE_OK]. sl@0: ** sl@0: ** {H11336} If the most recent call to [sqlite3_step(S)] for the sl@0: ** [prepared statement] S indicated an error, then sl@0: ** [sqlite3_reset(S)] returns an appropriate [error code]. sl@0: ** sl@0: ** {H11338} The [sqlite3_reset(S)] interface does not change the values sl@0: ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. sl@0: */ sl@0: int sqlite3_reset(sqlite3_stmt *pStmt); sl@0: sl@0: /* sl@0: ** CAPI3REF: Create Or Redefine SQL Functions {H16100} sl@0: ** KEYWORDS: {function creation routines} sl@0: ** KEYWORDS: {application-defined SQL function} sl@0: ** KEYWORDS: {application-defined SQL functions} sl@0: ** sl@0: ** These two functions (collectively known as "function creation routines") sl@0: ** are used to add SQL functions or aggregates or to redefine the behavior sl@0: ** of existing SQL functions or aggregates. The only difference between the sl@0: ** two is that the second parameter, the name of the (scalar) function or sl@0: ** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16 sl@0: ** for sqlite3_create_function16(). sl@0: ** sl@0: ** The first parameter is the [database connection] to which the SQL sl@0: ** function is to be added. If a single program uses more than one database sl@0: ** connection internally, then SQL functions must be added individually to sl@0: ** each database connection. sl@0: ** sl@0: ** The second parameter is the name of the SQL function to be created or sl@0: ** redefined. The length of the name is limited to 255 bytes, exclusive of sl@0: ** the zero-terminator. Note that the name length limit is in bytes, not sl@0: ** characters. Any attempt to create a function with a longer name sl@0: ** will result in [SQLITE_ERROR] being returned. sl@0: ** sl@0: ** The third parameter is the number of arguments that the SQL function or sl@0: ** aggregate takes. If this parameter is negative, then the SQL function or sl@0: ** aggregate may take any number of arguments. sl@0: ** sl@0: ** The fourth parameter, eTextRep, specifies what sl@0: ** [SQLITE_UTF8 | text encoding] this SQL function prefers for sl@0: ** its parameters. Any SQL function implementation should be able to work sl@0: ** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be sl@0: ** more efficient with one encoding than another. It is allowed to sl@0: ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple sl@0: ** times with the same function but with different values of eTextRep. sl@0: ** When multiple implementations of the same function are available, SQLite sl@0: ** will pick the one that involves the least amount of data conversion. sl@0: ** If there is only a single implementation which does not care what text sl@0: ** encoding is used, then the fourth argument should be [SQLITE_ANY]. sl@0: ** sl@0: ** The fifth parameter is an arbitrary pointer. The implementation of the sl@0: ** function can gain access to this pointer using [sqlite3_user_data()]. sl@0: ** sl@0: ** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are sl@0: ** pointers to C-language functions that implement the SQL function or sl@0: ** aggregate. A scalar SQL function requires an implementation of the xFunc sl@0: ** callback only, NULL pointers should be passed as the xStep and xFinal sl@0: ** parameters. An aggregate SQL function requires an implementation of xStep sl@0: ** and xFinal and NULL should be passed for xFunc. To delete an existing sl@0: ** SQL function or aggregate, pass NULL for all three function callbacks. sl@0: ** sl@0: ** It is permitted to register multiple implementations of the same sl@0: ** functions with the same name but with either differing numbers of sl@0: ** arguments or differing preferred text encodings. SQLite will use sl@0: ** the implementation most closely matches the way in which the sl@0: ** SQL function is used. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16103} The [sqlite3_create_function16()] interface behaves exactly sl@0: ** like [sqlite3_create_function()] in every way except that it sl@0: ** interprets the zFunctionName argument as zero-terminated UTF-16 sl@0: ** native byte order instead of as zero-terminated UTF-8. sl@0: ** sl@0: ** {H16106} A successful invocation of sl@0: ** the [sqlite3_create_function(D,X,N,E,...)] interface registers sl@0: ** or replaces callback functions in the [database connection] D sl@0: ** used to implement the SQL function named X with N parameters sl@0: ** and having a preferred text encoding of E. sl@0: ** sl@0: ** {H16109} A successful call to [sqlite3_create_function(D,X,N,E,P,F,S,L)] sl@0: ** replaces the P, F, S, and L values from any prior calls with sl@0: ** the same D, X, N, and E values. sl@0: ** sl@0: ** {H16112} The [sqlite3_create_function(D,X,...)] interface fails with sl@0: ** a return code of [SQLITE_ERROR] if the SQL function name X is sl@0: ** longer than 255 bytes exclusive of the zero terminator. sl@0: ** sl@0: ** {H16118} Either F must be NULL and S and L are non-NULL or else F sl@0: ** is non-NULL and S and L are NULL, otherwise sl@0: ** [sqlite3_create_function(D,X,N,E,P,F,S,L)] returns [SQLITE_ERROR]. sl@0: ** sl@0: ** {H16121} The [sqlite3_create_function(D,...)] interface fails with an sl@0: ** error code of [SQLITE_BUSY] if there exist [prepared statements] sl@0: ** associated with the [database connection] D. sl@0: ** sl@0: ** {H16124} The [sqlite3_create_function(D,X,N,...)] interface fails with an sl@0: ** error code of [SQLITE_ERROR] if parameter N (specifying the number sl@0: ** of arguments to the SQL function being registered) is less sl@0: ** than -1 or greater than 127. sl@0: ** sl@0: ** {H16127} When N is non-negative, the [sqlite3_create_function(D,X,N,...)] sl@0: ** interface causes callbacks to be invoked for the SQL function sl@0: ** named X when the number of arguments to the SQL function is sl@0: ** exactly N. sl@0: ** sl@0: ** {H16130} When N is -1, the [sqlite3_create_function(D,X,N,...)] sl@0: ** interface causes callbacks to be invoked for the SQL function sl@0: ** named X with any number of arguments. sl@0: ** sl@0: ** {H16133} When calls to [sqlite3_create_function(D,X,N,...)] sl@0: ** specify multiple implementations of the same function X sl@0: ** and when one implementation has N>=0 and the other has N=(-1) sl@0: ** the implementation with a non-zero N is preferred. sl@0: ** sl@0: ** {H16136} When calls to [sqlite3_create_function(D,X,N,E,...)] sl@0: ** specify multiple implementations of the same function X with sl@0: ** the same number of arguments N but with different sl@0: ** encodings E, then the implementation where E matches the sl@0: ** database encoding is preferred. sl@0: ** sl@0: ** {H16139} For an aggregate SQL function created using sl@0: ** [sqlite3_create_function(D,X,N,E,P,0,S,L)] the finalizer sl@0: ** function L will always be invoked exactly once if the sl@0: ** step function S is called one or more times. sl@0: ** sl@0: ** {H16142} When SQLite invokes either the xFunc or xStep function of sl@0: ** an application-defined SQL function or aggregate created sl@0: ** by [sqlite3_create_function()] or [sqlite3_create_function16()], sl@0: ** then the array of [sqlite3_value] objects passed as the sl@0: ** third parameter are always [protected sqlite3_value] objects. sl@0: */ sl@0: int sqlite3_create_function( sl@0: sqlite3 *db, sl@0: const char *zFunctionName, sl@0: int nArg, sl@0: int eTextRep, sl@0: void *pApp, sl@0: void (*xFunc)(sqlite3_context*,int,sqlite3_value**), sl@0: void (*xStep)(sqlite3_context*,int,sqlite3_value**), sl@0: void (*xFinal)(sqlite3_context*) sl@0: ); sl@0: int sqlite3_create_function16( sl@0: sqlite3 *db, sl@0: const void *zFunctionName, sl@0: int nArg, sl@0: int eTextRep, sl@0: void *pApp, sl@0: void (*xFunc)(sqlite3_context*,int,sqlite3_value**), sl@0: void (*xStep)(sqlite3_context*,int,sqlite3_value**), sl@0: void (*xFinal)(sqlite3_context*) sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Text Encodings {H10267} sl@0: ** sl@0: ** These constant define integer codes that represent the various sl@0: ** text encodings supported by SQLite. sl@0: */ sl@0: #define SQLITE_UTF8 1 sl@0: #define SQLITE_UTF16LE 2 sl@0: #define SQLITE_UTF16BE 3 sl@0: #define SQLITE_UTF16 4 /* Use native byte order */ sl@0: #define SQLITE_ANY 5 /* sqlite3_create_function only */ sl@0: #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ sl@0: sl@0: /* sl@0: ** CAPI3REF: Deprecated Functions sl@0: ** DEPRECATED sl@0: ** sl@0: ** These functions are [deprecated]. In order to maintain sl@0: ** backwards compatibility with older code, these functions continue sl@0: ** to be supported. However, new applications should avoid sl@0: ** the use of these functions. To help encourage people to avoid sl@0: ** using these functions, we are not going to tell you want they do. sl@0: */ sl@0: int sqlite3_aggregate_count(sqlite3_context*); sl@0: int sqlite3_expired(sqlite3_stmt*); sl@0: int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); sl@0: int sqlite3_global_recover(void); sl@0: void sqlite3_thread_cleanup(void); sl@0: int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); sl@0: sl@0: /* sl@0: ** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} sl@0: ** sl@0: ** The C-language implementation of SQL functions and aggregates uses sl@0: ** this set of interface routines to access the parameter values on sl@0: ** the function or aggregate. sl@0: ** sl@0: ** The xFunc (for scalar functions) or xStep (for aggregates) parameters sl@0: ** to [sqlite3_create_function()] and [sqlite3_create_function16()] sl@0: ** define callbacks that implement the SQL functions and aggregates. sl@0: ** The 4th parameter to these callbacks is an array of pointers to sl@0: ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for sl@0: ** each parameter to the SQL function. These routines are used to sl@0: ** extract values from the [sqlite3_value] objects. sl@0: ** sl@0: ** These routines work only with [protected sqlite3_value] objects. sl@0: ** Any attempt to use these routines on an [unprotected sqlite3_value] sl@0: ** object results in undefined behavior. sl@0: ** sl@0: ** These routines work just like the corresponding [column access functions] sl@0: ** except that these routines take a single [protected sqlite3_value] object sl@0: ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. sl@0: ** sl@0: ** The sqlite3_value_text16() interface extracts a UTF-16 string sl@0: ** in the native byte-order of the host machine. The sl@0: ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces sl@0: ** extract UTF-16 strings as big-endian and little-endian respectively. sl@0: ** sl@0: ** The sqlite3_value_numeric_type() interface attempts to apply sl@0: ** numeric affinity to the value. This means that an attempt is sl@0: ** made to convert the value to an integer or floating point. If sl@0: ** such a conversion is possible without loss of information (in other sl@0: ** words, if the value is a string that looks like a number) sl@0: ** then the conversion is performed. Otherwise no conversion occurs. sl@0: ** The [SQLITE_INTEGER | datatype] after conversion is returned. sl@0: ** sl@0: ** Please pay particular attention to the fact that the pointer returned sl@0: ** from [sqlite3_value_blob()], [sqlite3_value_text()], or sl@0: ** [sqlite3_value_text16()] can be invalidated by a subsequent call to sl@0: ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], sl@0: ** or [sqlite3_value_text16()]. sl@0: ** sl@0: ** These routines must be called from the same thread as sl@0: ** the SQL function that supplied the [sqlite3_value*] parameters. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H15103} The [sqlite3_value_blob(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a BLOB and then sl@0: ** returns a pointer to the converted value. sl@0: ** sl@0: ** {H15106} The [sqlite3_value_bytes(V)] interface returns the sl@0: ** number of bytes in the BLOB or string (exclusive of the sl@0: ** zero terminator on the string) that was returned by the sl@0: ** most recent call to [sqlite3_value_blob(V)] or sl@0: ** [sqlite3_value_text(V)]. sl@0: ** sl@0: ** {H15109} The [sqlite3_value_bytes16(V)] interface returns the sl@0: ** number of bytes in the string (exclusive of the sl@0: ** zero terminator on the string) that was returned by the sl@0: ** most recent call to [sqlite3_value_text16(V)], sl@0: ** [sqlite3_value_text16be(V)], or [sqlite3_value_text16le(V)]. sl@0: ** sl@0: ** {H15112} The [sqlite3_value_double(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a floating point value and sl@0: ** returns a copy of that value. sl@0: ** sl@0: ** {H15115} The [sqlite3_value_int(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a 64-bit signed integer and sl@0: ** returns the lower 32 bits of that integer. sl@0: ** sl@0: ** {H15118} The [sqlite3_value_int64(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a 64-bit signed integer and sl@0: ** returns a copy of that integer. sl@0: ** sl@0: ** {H15121} The [sqlite3_value_text(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a zero-terminated UTF-8 sl@0: ** string and returns a pointer to that string. sl@0: ** sl@0: ** {H15124} The [sqlite3_value_text16(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a zero-terminated 2-byte sl@0: ** aligned UTF-16 native byte order sl@0: ** string and returns a pointer to that string. sl@0: ** sl@0: ** {H15127} The [sqlite3_value_text16be(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a zero-terminated 2-byte sl@0: ** aligned UTF-16 big-endian sl@0: ** string and returns a pointer to that string. sl@0: ** sl@0: ** {H15130} The [sqlite3_value_text16le(V)] interface converts the sl@0: ** [protected sqlite3_value] object V into a zero-terminated 2-byte sl@0: ** aligned UTF-16 little-endian sl@0: ** string and returns a pointer to that string. sl@0: ** sl@0: ** {H15133} The [sqlite3_value_type(V)] interface returns sl@0: ** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT], sl@0: ** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for sl@0: ** the [sqlite3_value] object V. sl@0: ** sl@0: ** {H15136} The [sqlite3_value_numeric_type(V)] interface converts sl@0: ** the [protected sqlite3_value] object V into either an integer or sl@0: ** a floating point value if it can do so without loss of sl@0: ** information, and returns one of [SQLITE_NULL], sl@0: ** [SQLITE_INTEGER], [SQLITE_FLOAT], [SQLITE_TEXT], or sl@0: ** [SQLITE_BLOB] as appropriate for the sl@0: ** [protected sqlite3_value] object V after the conversion attempt. sl@0: */ sl@0: const void *sqlite3_value_blob(sqlite3_value*); sl@0: int sqlite3_value_bytes(sqlite3_value*); sl@0: int sqlite3_value_bytes16(sqlite3_value*); sl@0: double sqlite3_value_double(sqlite3_value*); sl@0: int sqlite3_value_int(sqlite3_value*); sl@0: sqlite3_int64 sqlite3_value_int64(sqlite3_value*); sl@0: const unsigned char *sqlite3_value_text(sqlite3_value*); sl@0: const void *sqlite3_value_text16(sqlite3_value*); sl@0: const void *sqlite3_value_text16le(sqlite3_value*); sl@0: const void *sqlite3_value_text16be(sqlite3_value*); sl@0: int sqlite3_value_type(sqlite3_value*); sl@0: int sqlite3_value_numeric_type(sqlite3_value*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Obtain Aggregate Function Context {H16210} sl@0: ** sl@0: ** The implementation of aggregate SQL functions use this routine to allocate sl@0: ** a structure for storing their state. sl@0: ** sl@0: ** The first time the sqlite3_aggregate_context() routine is called for a sl@0: ** particular aggregate, SQLite allocates nBytes of memory, zeroes out that sl@0: ** memory, and returns a pointer to it. On second and subsequent calls to sl@0: ** sqlite3_aggregate_context() for the same aggregate function index, sl@0: ** the same buffer is returned. The implementation of the aggregate can use sl@0: ** the returned buffer to accumulate data. sl@0: ** sl@0: ** SQLite automatically frees the allocated buffer when the aggregate sl@0: ** query concludes. sl@0: ** sl@0: ** The first parameter should be a copy of the sl@0: ** [sqlite3_context | SQL function context] that is the first parameter sl@0: ** to the callback routine that implements the aggregate function. sl@0: ** sl@0: ** This routine must be called from the same thread in which sl@0: ** the aggregate SQL function is running. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16211} The first invocation of [sqlite3_aggregate_context(C,N)] for sl@0: ** a particular instance of an aggregate function (for a particular sl@0: ** context C) causes SQLite to allocate N bytes of memory, sl@0: ** zero that memory, and return a pointer to the allocated memory. sl@0: ** sl@0: ** {H16213} If a memory allocation error occurs during sl@0: ** [sqlite3_aggregate_context(C,N)] then the function returns 0. sl@0: ** sl@0: ** {H16215} Second and subsequent invocations of sl@0: ** [sqlite3_aggregate_context(C,N)] for the same context pointer C sl@0: ** ignore the N parameter and return a pointer to the same sl@0: ** block of memory returned by the first invocation. sl@0: ** sl@0: ** {H16217} The memory allocated by [sqlite3_aggregate_context(C,N)] is sl@0: ** automatically freed on the next call to [sqlite3_reset()] sl@0: ** or [sqlite3_finalize()] for the [prepared statement] containing sl@0: ** the aggregate function associated with context C. sl@0: */ sl@0: void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); sl@0: sl@0: /* sl@0: ** CAPI3REF: User Data For Functions {H16240} sl@0: ** sl@0: ** The sqlite3_user_data() interface returns a copy of sl@0: ** the pointer that was the pUserData parameter (the 5th parameter) sl@0: ** of the [sqlite3_create_function()] sl@0: ** and [sqlite3_create_function16()] routines that originally sl@0: ** registered the application defined function. {END} sl@0: ** sl@0: ** This routine must be called from the same thread in which sl@0: ** the application-defined function is running. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16243} The [sqlite3_user_data(C)] interface returns a copy of the sl@0: ** P pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)] sl@0: ** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that sl@0: ** registered the SQL function associated with [sqlite3_context] C. sl@0: */ sl@0: void *sqlite3_user_data(sqlite3_context*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Database Connection For Functions {H16250} sl@0: ** sl@0: ** The sqlite3_context_db_handle() interface returns a copy of sl@0: ** the pointer to the [database connection] (the 1st parameter) sl@0: ** of the [sqlite3_create_function()] sl@0: ** and [sqlite3_create_function16()] routines that originally sl@0: ** registered the application defined function. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16253} The [sqlite3_context_db_handle(C)] interface returns a copy of the sl@0: ** D pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)] sl@0: ** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that sl@0: ** registered the SQL function associated with [sqlite3_context] C. sl@0: */ sl@0: sqlite3 *sqlite3_context_db_handle(sqlite3_context*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Function Auxiliary Data {H16270} sl@0: ** sl@0: ** The following two functions may be used by scalar SQL functions to sl@0: ** associate metadata with argument values. If the same value is passed to sl@0: ** multiple invocations of the same SQL function during query execution, under sl@0: ** some circumstances the associated metadata may be preserved. This may sl@0: ** be used, for example, to add a regular-expression matching scalar sl@0: ** function. The compiled version of the regular expression is stored as sl@0: ** metadata associated with the SQL value passed as the regular expression sl@0: ** pattern. The compiled regular expression can be reused on multiple sl@0: ** invocations of the same function so that the original pattern string sl@0: ** does not need to be recompiled on each invocation. sl@0: ** sl@0: ** The sqlite3_get_auxdata() interface returns a pointer to the metadata sl@0: ** associated by the sqlite3_set_auxdata() function with the Nth argument sl@0: ** value to the application-defined function. If no metadata has been ever sl@0: ** been set for the Nth argument of the function, or if the corresponding sl@0: ** function parameter has changed since the meta-data was set, sl@0: ** then sqlite3_get_auxdata() returns a NULL pointer. sl@0: ** sl@0: ** The sqlite3_set_auxdata() interface saves the metadata sl@0: ** pointed to by its 3rd parameter as the metadata for the N-th sl@0: ** argument of the application-defined function. Subsequent sl@0: ** calls to sqlite3_get_auxdata() might return this data, if it has sl@0: ** not been destroyed. sl@0: ** If it is not NULL, SQLite will invoke the destructor sl@0: ** function given by the 4th parameter to sqlite3_set_auxdata() on sl@0: ** the metadata when the corresponding function parameter changes sl@0: ** or when the SQL statement completes, whichever comes first. sl@0: ** sl@0: ** SQLite is free to call the destructor and drop metadata on any sl@0: ** parameter of any function at any time. The only guarantee is that sl@0: ** the destructor will be called before the metadata is dropped. sl@0: ** sl@0: ** In practice, metadata is preserved between function calls for sl@0: ** expressions that are constant at compile time. This includes literal sl@0: ** values and SQL variables. sl@0: ** sl@0: ** These routines must be called from the same thread in which sl@0: ** the SQL function is running. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16272} The [sqlite3_get_auxdata(C,N)] interface returns a pointer sl@0: ** to metadata associated with the Nth parameter of the SQL function sl@0: ** whose context is C, or NULL if there is no metadata associated sl@0: ** with that parameter. sl@0: ** sl@0: ** {H16274} The [sqlite3_set_auxdata(C,N,P,D)] interface assigns a metadata sl@0: ** pointer P to the Nth parameter of the SQL function with context C. sl@0: ** sl@0: ** {H16276} SQLite will invoke the destructor D with a single argument sl@0: ** which is the metadata pointer P following a call to sl@0: ** [sqlite3_set_auxdata(C,N,P,D)] when SQLite ceases to hold sl@0: ** the metadata. sl@0: ** sl@0: ** {H16277} SQLite ceases to hold metadata for an SQL function parameter sl@0: ** when the value of that parameter changes. sl@0: ** sl@0: ** {H16278} When [sqlite3_set_auxdata(C,N,P,D)] is invoked, the destructor sl@0: ** is called for any prior metadata associated with the same function sl@0: ** context C and parameter N. sl@0: ** sl@0: ** {H16279} SQLite will call destructors for any metadata it is holding sl@0: ** in a particular [prepared statement] S when either sl@0: ** [sqlite3_reset(S)] or [sqlite3_finalize(S)] is called. sl@0: */ sl@0: void *sqlite3_get_auxdata(sqlite3_context*, int N); sl@0: void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); sl@0: sl@0: sl@0: /* sl@0: ** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} sl@0: ** sl@0: ** These are special values for the destructor that is passed in as the sl@0: ** final argument to routines like [sqlite3_result_blob()]. If the destructor sl@0: ** argument is SQLITE_STATIC, it means that the content pointer is constant sl@0: ** and will never change. It does not need to be destroyed. The sl@0: ** SQLITE_TRANSIENT value means that the content will likely change in sl@0: ** the near future and that SQLite should make its own private copy of sl@0: ** the content before returning. sl@0: ** sl@0: ** The typedef is necessary to work around problems in certain sl@0: ** C++ compilers. See ticket #2191. sl@0: */ sl@0: typedef void (*sqlite3_destructor_type)(void*); sl@0: #define SQLITE_STATIC ((sqlite3_destructor_type)0) sl@0: #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) sl@0: sl@0: /* sl@0: ** CAPI3REF: Setting The Result Of An SQL Function {H16400} sl@0: ** sl@0: ** These routines are used by the xFunc or xFinal callbacks that sl@0: ** implement SQL functions and aggregates. See sl@0: ** [sqlite3_create_function()] and [sqlite3_create_function16()] sl@0: ** for additional information. sl@0: ** sl@0: ** These functions work very much like the [parameter binding] family of sl@0: ** functions used to bind values to host parameters in prepared statements. sl@0: ** Refer to the [SQL parameter] documentation for additional information. sl@0: ** sl@0: ** The sqlite3_result_blob() interface sets the result from sl@0: ** an application-defined function to be the BLOB whose content is pointed sl@0: ** to by the second parameter and which is N bytes long where N is the sl@0: ** third parameter. sl@0: ** sl@0: ** The sqlite3_result_zeroblob() interfaces set the result of sl@0: ** the application-defined function to be a BLOB containing all zero sl@0: ** bytes and N bytes in size, where N is the value of the 2nd parameter. sl@0: ** sl@0: ** The sqlite3_result_double() interface sets the result from sl@0: ** an application-defined function to be a floating point value specified sl@0: ** by its 2nd argument. sl@0: ** sl@0: ** The sqlite3_result_error() and sqlite3_result_error16() functions sl@0: ** cause the implemented SQL function to throw an exception. sl@0: ** SQLite uses the string pointed to by the sl@0: ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() sl@0: ** as the text of an error message. SQLite interprets the error sl@0: ** message string from sqlite3_result_error() as UTF-8. SQLite sl@0: ** interprets the string from sqlite3_result_error16() as UTF-16 in native sl@0: ** byte order. If the third parameter to sqlite3_result_error() sl@0: ** or sqlite3_result_error16() is negative then SQLite takes as the error sl@0: ** message all text up through the first zero character. sl@0: ** If the third parameter to sqlite3_result_error() or sl@0: ** sqlite3_result_error16() is non-negative then SQLite takes that many sl@0: ** bytes (not characters) from the 2nd parameter as the error message. sl@0: ** The sqlite3_result_error() and sqlite3_result_error16() sl@0: ** routines make a private copy of the error message text before sl@0: ** they return. Hence, the calling function can deallocate or sl@0: ** modify the text after they return without harm. sl@0: ** The sqlite3_result_error_code() function changes the error code sl@0: ** returned by SQLite as a result of an error in a function. By default, sl@0: ** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error() sl@0: ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. sl@0: ** sl@0: ** The sqlite3_result_toobig() interface causes SQLite to throw an error sl@0: ** indicating that a string or BLOB is to long to represent. sl@0: ** sl@0: ** The sqlite3_result_nomem() interface causes SQLite to throw an error sl@0: ** indicating that a memory allocation failed. sl@0: ** sl@0: ** The sqlite3_result_int() interface sets the return value sl@0: ** of the application-defined function to be the 32-bit signed integer sl@0: ** value given in the 2nd argument. sl@0: ** The sqlite3_result_int64() interface sets the return value sl@0: ** of the application-defined function to be the 64-bit signed integer sl@0: ** value given in the 2nd argument. sl@0: ** sl@0: ** The sqlite3_result_null() interface sets the return value sl@0: ** of the application-defined function to be NULL. sl@0: ** sl@0: ** The sqlite3_result_text(), sqlite3_result_text16(), sl@0: ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces sl@0: ** set the return value of the application-defined function to be sl@0: ** a text string which is represented as UTF-8, UTF-16 native byte order, sl@0: ** UTF-16 little endian, or UTF-16 big endian, respectively. sl@0: ** SQLite takes the text result from the application from sl@0: ** the 2nd parameter of the sqlite3_result_text* interfaces. sl@0: ** If the 3rd parameter to the sqlite3_result_text* interfaces sl@0: ** is negative, then SQLite takes result text from the 2nd parameter sl@0: ** through the first zero character. sl@0: ** If the 3rd parameter to the sqlite3_result_text* interfaces sl@0: ** is non-negative, then as many bytes (not characters) of the text sl@0: ** pointed to by the 2nd parameter are taken as the application-defined sl@0: ** function result. sl@0: ** If the 4th parameter to the sqlite3_result_text* interfaces sl@0: ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that sl@0: ** function as the destructor on the text or BLOB result when it has sl@0: ** finished using that result. sl@0: ** If the 4th parameter to the sqlite3_result_text* interfaces or sl@0: ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite sl@0: ** assumes that the text or BLOB result is in constant space and does not sl@0: ** copy the it or call a destructor when it has finished using that result. sl@0: ** If the 4th parameter to the sqlite3_result_text* interfaces sl@0: ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT sl@0: ** then SQLite makes a copy of the result into space obtained from sl@0: ** from [sqlite3_malloc()] before it returns. sl@0: ** sl@0: ** The sqlite3_result_value() interface sets the result of sl@0: ** the application-defined function to be a copy the sl@0: ** [unprotected sqlite3_value] object specified by the 2nd parameter. The sl@0: ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] sl@0: ** so that the [sqlite3_value] specified in the parameter may change or sl@0: ** be deallocated after sqlite3_result_value() returns without harm. sl@0: ** A [protected sqlite3_value] object may always be used where an sl@0: ** [unprotected sqlite3_value] object is required, so either sl@0: ** kind of [sqlite3_value] object can be used with this interface. sl@0: ** sl@0: ** If these routines are called from within the different thread sl@0: ** than the one containing the application-defined function that received sl@0: ** the [sqlite3_context] pointer, the results are undefined. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16403} The default return value from any SQL function is NULL. sl@0: ** sl@0: ** {H16406} The [sqlite3_result_blob(C,V,N,D)] interface changes the sl@0: ** return value of function C to be a BLOB that is N bytes sl@0: ** in length and with content pointed to by V. sl@0: ** sl@0: ** {H16409} The [sqlite3_result_double(C,V)] interface changes the sl@0: ** return value of function C to be the floating point value V. sl@0: ** sl@0: ** {H16412} The [sqlite3_result_error(C,V,N)] interface changes the return sl@0: ** value of function C to be an exception with error code sl@0: ** [SQLITE_ERROR] and a UTF-8 error message copied from V up to the sl@0: ** first zero byte or until N bytes are read if N is positive. sl@0: ** sl@0: ** {H16415} The [sqlite3_result_error16(C,V,N)] interface changes the return sl@0: ** value of function C to be an exception with error code sl@0: ** [SQLITE_ERROR] and a UTF-16 native byte order error message sl@0: ** copied from V up to the first zero terminator or until N bytes sl@0: ** are read if N is positive. sl@0: ** sl@0: ** {H16418} The [sqlite3_result_error_toobig(C)] interface changes the return sl@0: ** value of the function C to be an exception with error code sl@0: ** [SQLITE_TOOBIG] and an appropriate error message. sl@0: ** sl@0: ** {H16421} The [sqlite3_result_error_nomem(C)] interface changes the return sl@0: ** value of the function C to be an exception with error code sl@0: ** [SQLITE_NOMEM] and an appropriate error message. sl@0: ** sl@0: ** {H16424} The [sqlite3_result_error_code(C,E)] interface changes the return sl@0: ** value of the function C to be an exception with error code E. sl@0: ** The error message text is unchanged. sl@0: ** sl@0: ** {H16427} The [sqlite3_result_int(C,V)] interface changes the sl@0: ** return value of function C to be the 32-bit integer value V. sl@0: ** sl@0: ** {H16430} The [sqlite3_result_int64(C,V)] interface changes the sl@0: ** return value of function C to be the 64-bit integer value V. sl@0: ** sl@0: ** {H16433} The [sqlite3_result_null(C)] interface changes the sl@0: ** return value of function C to be NULL. sl@0: ** sl@0: ** {H16436} The [sqlite3_result_text(C,V,N,D)] interface changes the sl@0: ** return value of function C to be the UTF-8 string sl@0: ** V up to the first zero if N is negative sl@0: ** or the first N bytes of V if N is non-negative. sl@0: ** sl@0: ** {H16439} The [sqlite3_result_text16(C,V,N,D)] interface changes the sl@0: ** return value of function C to be the UTF-16 native byte order sl@0: ** string V up to the first zero if N is negative sl@0: ** or the first N bytes of V if N is non-negative. sl@0: ** sl@0: ** {H16442} The [sqlite3_result_text16be(C,V,N,D)] interface changes the sl@0: ** return value of function C to be the UTF-16 big-endian sl@0: ** string V up to the first zero if N is negative sl@0: ** or the first N bytes or V if N is non-negative. sl@0: ** sl@0: ** {H16445} The [sqlite3_result_text16le(C,V,N,D)] interface changes the sl@0: ** return value of function C to be the UTF-16 little-endian sl@0: ** string V up to the first zero if N is negative sl@0: ** or the first N bytes of V if N is non-negative. sl@0: ** sl@0: ** {H16448} The [sqlite3_result_value(C,V)] interface changes the sl@0: ** return value of function C to be the [unprotected sqlite3_value] sl@0: ** object V. sl@0: ** sl@0: ** {H16451} The [sqlite3_result_zeroblob(C,N)] interface changes the sl@0: ** return value of function C to be an N-byte BLOB of all zeros. sl@0: ** sl@0: ** {H16454} The [sqlite3_result_error()] and [sqlite3_result_error16()] sl@0: ** interfaces make a copy of their error message strings before sl@0: ** returning. sl@0: ** sl@0: ** {H16457} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], sl@0: ** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], sl@0: ** [sqlite3_result_text16be(C,V,N,D)], or sl@0: ** [sqlite3_result_text16le(C,V,N,D)] is the constant [SQLITE_STATIC] sl@0: ** then no destructor is ever called on the pointer V and SQLite sl@0: ** assumes that V is immutable. sl@0: ** sl@0: ** {H16460} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], sl@0: ** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], sl@0: ** [sqlite3_result_text16be(C,V,N,D)], or sl@0: ** [sqlite3_result_text16le(C,V,N,D)] is the constant sl@0: ** [SQLITE_TRANSIENT] then the interfaces makes a copy of the sl@0: ** content of V and retains the copy. sl@0: ** sl@0: ** {H16463} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], sl@0: ** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], sl@0: ** [sqlite3_result_text16be(C,V,N,D)], or sl@0: ** [sqlite3_result_text16le(C,V,N,D)] is some value other than sl@0: ** the constants [SQLITE_STATIC] and [SQLITE_TRANSIENT] then sl@0: ** SQLite will invoke the destructor D with V as its only argument sl@0: ** when it has finished with the V value. sl@0: */ sl@0: void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); sl@0: void sqlite3_result_double(sqlite3_context*, double); sl@0: void sqlite3_result_error(sqlite3_context*, const char*, int); sl@0: void sqlite3_result_error16(sqlite3_context*, const void*, int); sl@0: void sqlite3_result_error_toobig(sqlite3_context*); sl@0: void sqlite3_result_error_nomem(sqlite3_context*); sl@0: void sqlite3_result_error_code(sqlite3_context*, int); sl@0: void sqlite3_result_int(sqlite3_context*, int); sl@0: void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); sl@0: void sqlite3_result_null(sqlite3_context*); sl@0: void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); sl@0: void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); sl@0: void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); sl@0: void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); sl@0: void sqlite3_result_value(sqlite3_context*, sqlite3_value*); sl@0: void sqlite3_result_zeroblob(sqlite3_context*, int n); sl@0: sl@0: /* sl@0: ** CAPI3REF: Define New Collating Sequences {H16600} sl@0: ** sl@0: ** These functions are used to add new collation sequences to the sl@0: ** [database connection] specified as the first argument. sl@0: ** sl@0: ** The name of the new collation sequence is specified as a UTF-8 string sl@0: ** for sqlite3_create_collation() and sqlite3_create_collation_v2() sl@0: ** and a UTF-16 string for sqlite3_create_collation16(). In all cases sl@0: ** the name is passed as the second function argument. sl@0: ** sl@0: ** The third argument may be one of the constants [SQLITE_UTF8], sl@0: ** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied sl@0: ** routine expects to be passed pointers to strings encoded using UTF-8, sl@0: ** UTF-16 little-endian, or UTF-16 big-endian, respectively. The sl@0: ** third argument might also be [SQLITE_UTF16_ALIGNED] to indicate that sl@0: ** the routine expects pointers to 16-bit word aligned strings sl@0: ** of UTF-16 in the native byte order of the host computer. sl@0: ** sl@0: ** A pointer to the user supplied routine must be passed as the fifth sl@0: ** argument. If it is NULL, this is the same as deleting the collation sl@0: ** sequence (so that SQLite cannot call it anymore). sl@0: ** Each time the application supplied function is invoked, it is passed sl@0: ** as its first parameter a copy of the void* passed as the fourth argument sl@0: ** to sqlite3_create_collation() or sqlite3_create_collation16(). sl@0: ** sl@0: ** The remaining arguments to the application-supplied routine are two strings, sl@0: ** each represented by a (length, data) pair and encoded in the encoding sl@0: ** that was passed as the third argument when the collation sequence was sl@0: ** registered. {END} The application defined collation routine should sl@0: ** return negative, zero or positive if the first string is less than, sl@0: ** equal to, or greater than the second string. i.e. (STRING1 - STRING2). sl@0: ** sl@0: ** The sqlite3_create_collation_v2() works like sqlite3_create_collation() sl@0: ** except that it takes an extra argument which is a destructor for sl@0: ** the collation. The destructor is called when the collation is sl@0: ** destroyed and is passed a copy of the fourth parameter void* pointer sl@0: ** of the sqlite3_create_collation_v2(). sl@0: ** Collations are destroyed when they are overridden by later calls to the sl@0: ** collation creation functions or when the [database connection] is closed sl@0: ** using [sqlite3_close()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16603} A successful call to the sl@0: ** [sqlite3_create_collation_v2(B,X,E,P,F,D)] interface sl@0: ** registers function F as the comparison function used to sl@0: ** implement collation X on the [database connection] B for sl@0: ** databases having encoding E. sl@0: ** sl@0: ** {H16604} SQLite understands the X parameter to sl@0: ** [sqlite3_create_collation_v2(B,X,E,P,F,D)] as a zero-terminated sl@0: ** UTF-8 string in which case is ignored for ASCII characters and sl@0: ** is significant for non-ASCII characters. sl@0: ** sl@0: ** {H16606} Successive calls to [sqlite3_create_collation_v2(B,X,E,P,F,D)] sl@0: ** with the same values for B, X, and E, override prior values sl@0: ** of P, F, and D. sl@0: ** sl@0: ** {H16609} If the destructor D in [sqlite3_create_collation_v2(B,X,E,P,F,D)] sl@0: ** is not NULL then it is called with argument P when the sl@0: ** collating function is dropped by SQLite. sl@0: ** sl@0: ** {H16612} A collating function is dropped when it is overloaded. sl@0: ** sl@0: ** {H16615} A collating function is dropped when the database connection sl@0: ** is closed using [sqlite3_close()]. sl@0: ** sl@0: ** {H16618} The pointer P in [sqlite3_create_collation_v2(B,X,E,P,F,D)] sl@0: ** is passed through as the first parameter to the comparison sl@0: ** function F for all subsequent invocations of F. sl@0: ** sl@0: ** {H16621} A call to [sqlite3_create_collation(B,X,E,P,F)] is exactly sl@0: ** the same as a call to [sqlite3_create_collation_v2()] with sl@0: ** the same parameters and a NULL destructor. sl@0: ** sl@0: ** {H16624} Following a [sqlite3_create_collation_v2(B,X,E,P,F,D)], sl@0: ** SQLite uses the comparison function F for all text comparison sl@0: ** operations on the [database connection] B on text values that sl@0: ** use the collating sequence named X. sl@0: ** sl@0: ** {H16627} The [sqlite3_create_collation16(B,X,E,P,F)] works the same sl@0: ** as [sqlite3_create_collation(B,X,E,P,F)] except that the sl@0: ** collation name X is understood as UTF-16 in native byte order sl@0: ** instead of UTF-8. sl@0: ** sl@0: ** {H16630} When multiple comparison functions are available for the same sl@0: ** collating sequence, SQLite chooses the one whose text encoding sl@0: ** requires the least amount of conversion from the default sl@0: ** text encoding of the database. sl@0: */ sl@0: int sqlite3_create_collation( sl@0: sqlite3*, sl@0: const char *zName, sl@0: int eTextRep, sl@0: void*, sl@0: int(*xCompare)(void*,int,const void*,int,const void*) sl@0: ); sl@0: int sqlite3_create_collation_v2( sl@0: sqlite3*, sl@0: const char *zName, sl@0: int eTextRep, sl@0: void*, sl@0: int(*xCompare)(void*,int,const void*,int,const void*), sl@0: void(*xDestroy)(void*) sl@0: ); sl@0: int sqlite3_create_collation16( sl@0: sqlite3*, sl@0: const void *zName, sl@0: int eTextRep, sl@0: void*, sl@0: int(*xCompare)(void*,int,const void*,int,const void*) sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Collation Needed Callbacks {H16700} sl@0: ** sl@0: ** To avoid having to register all collation sequences before a database sl@0: ** can be used, a single callback function may be registered with the sl@0: ** [database connection] to be called whenever an undefined collation sl@0: ** sequence is required. sl@0: ** sl@0: ** If the function is registered using the sqlite3_collation_needed() API, sl@0: ** then it is passed the names of undefined collation sequences as strings sl@0: ** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used, sl@0: ** the names are passed as UTF-16 in machine native byte order. sl@0: ** A call to either function replaces any existing callback. sl@0: ** sl@0: ** When the callback is invoked, the first argument passed is a copy sl@0: ** of the second argument to sqlite3_collation_needed() or sl@0: ** sqlite3_collation_needed16(). The second argument is the database sl@0: ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], sl@0: ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation sl@0: ** sequence function required. The fourth parameter is the name of the sl@0: ** required collation sequence. sl@0: ** sl@0: ** The callback function should register the desired collation using sl@0: ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or sl@0: ** [sqlite3_create_collation_v2()]. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16702} A successful call to [sqlite3_collation_needed(D,P,F)] sl@0: ** or [sqlite3_collation_needed16(D,P,F)] causes sl@0: ** the [database connection] D to invoke callback F with first sl@0: ** parameter P whenever it needs a comparison function for a sl@0: ** collating sequence that it does not know about. sl@0: ** sl@0: ** {H16704} Each successful call to [sqlite3_collation_needed()] or sl@0: ** [sqlite3_collation_needed16()] overrides the callback registered sl@0: ** on the same [database connection] by prior calls to either sl@0: ** interface. sl@0: ** sl@0: ** {H16706} The name of the requested collating function passed in the sl@0: ** 4th parameter to the callback is in UTF-8 if the callback sl@0: ** was registered using [sqlite3_collation_needed()] and sl@0: ** is in UTF-16 native byte order if the callback was sl@0: ** registered using [sqlite3_collation_needed16()]. sl@0: */ sl@0: int sqlite3_collation_needed( sl@0: sqlite3*, sl@0: void*, sl@0: void(*)(void*,sqlite3*,int eTextRep,const char*) sl@0: ); sl@0: int sqlite3_collation_needed16( sl@0: sqlite3*, sl@0: void*, sl@0: void(*)(void*,sqlite3*,int eTextRep,const void*) sl@0: ); sl@0: sl@0: /* sl@0: ** Specify the key for an encrypted database. This routine should be sl@0: ** called right after sqlite3_open(). sl@0: ** sl@0: ** The code to implement this API is not available in the public release sl@0: ** of SQLite. sl@0: */ sl@0: int sqlite3_key( sl@0: sqlite3 *db, /* Database to be rekeyed */ sl@0: const void *pKey, int nKey /* The key */ sl@0: ); sl@0: sl@0: /* sl@0: ** Change the key on an open database. If the current database is not sl@0: ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the sl@0: ** database is decrypted. sl@0: ** sl@0: ** The code to implement this API is not available in the public release sl@0: ** of SQLite. sl@0: */ sl@0: int sqlite3_rekey( sl@0: sqlite3 *db, /* Database to be rekeyed */ sl@0: const void *pKey, int nKey /* The new key */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Suspend Execution For A Short Time {H10530} sl@0: ** sl@0: ** The sqlite3_sleep() function causes the current thread to suspend execution sl@0: ** for at least a number of milliseconds specified in its parameter. sl@0: ** sl@0: ** If the operating system does not support sleep requests with sl@0: ** millisecond time resolution, then the time will be rounded up to sl@0: ** the nearest second. The number of milliseconds of sleep actually sl@0: ** requested from the operating system is returned. sl@0: ** sl@0: ** SQLite implements this interface by calling the xSleep() sl@0: ** method of the default [sqlite3_vfs] object. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10533} The [sqlite3_sleep(M)] interface invokes the xSleep sl@0: ** method of the default [sqlite3_vfs|VFS] in order to sl@0: ** suspend execution of the current thread for at least sl@0: ** M milliseconds. sl@0: ** sl@0: ** {H10536} The [sqlite3_sleep(M)] interface returns the number of sl@0: ** milliseconds of sleep actually requested of the operating sl@0: ** system, which might be larger than the parameter M. sl@0: */ sl@0: int sqlite3_sleep(int); sl@0: sl@0: /* sl@0: ** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} sl@0: ** sl@0: ** If this global variable is made to point to a string which is sl@0: ** the name of a folder (a.k.a. directory), then all temporary files sl@0: ** created by SQLite will be placed in that directory. If this variable sl@0: ** is a NULL pointer, then SQLite performs a search for an appropriate sl@0: ** temporary file directory. sl@0: ** sl@0: ** It is not safe to modify this variable once a [database connection] sl@0: ** has been opened. It is intended that this variable be set once sl@0: ** as part of process initialization and before any SQLite interface sl@0: ** routines have been call and remain unchanged thereafter. sl@0: */ sl@0: SQLITE_EXTERN char *sqlite3_temp_directory; sl@0: sl@0: /* sl@0: ** CAPI3REF: Test For Auto-Commit Mode {H12930} sl@0: ** KEYWORDS: {autocommit mode} sl@0: ** sl@0: ** The sqlite3_get_autocommit() interface returns non-zero or sl@0: ** zero if the given database connection is or is not in autocommit mode, sl@0: ** respectively. Autocommit mode is on by default. sl@0: ** Autocommit mode is disabled by a [BEGIN] statement. sl@0: ** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. sl@0: ** sl@0: ** If certain kinds of errors occur on a statement within a multi-statement sl@0: ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], sl@0: ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the sl@0: ** transaction might be rolled back automatically. The only way to sl@0: ** find out whether SQLite automatically rolled back the transaction after sl@0: ** an error is to use this function. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12931} The [sqlite3_get_autocommit(D)] interface returns non-zero or sl@0: ** zero if the [database connection] D is or is not in autocommit sl@0: ** mode, respectively. sl@0: ** sl@0: ** {H12932} Autocommit mode is on by default. sl@0: ** sl@0: ** {H12933} Autocommit mode is disabled by a successful [BEGIN] statement. sl@0: ** sl@0: ** {H12934} Autocommit mode is enabled by a successful [COMMIT] or [ROLLBACK] sl@0: ** statement. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A12936} If another thread changes the autocommit status of the database sl@0: ** connection while this routine is running, then the return value sl@0: ** is undefined. sl@0: */ sl@0: int sqlite3_get_autocommit(sqlite3*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} sl@0: ** sl@0: ** The sqlite3_db_handle interface returns the [database connection] handle sl@0: ** to which a [prepared statement] belongs. The database handle returned by sl@0: ** sqlite3_db_handle is the same database handle that was the first argument sl@0: ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to sl@0: ** create the statement in the first place. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13123} The [sqlite3_db_handle(S)] interface returns a pointer sl@0: ** to the [database connection] associated with the sl@0: ** [prepared statement] S. sl@0: */ sl@0: sqlite3 *sqlite3_db_handle(sqlite3_stmt*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Find the next prepared statement {H13140} sl@0: ** sl@0: ** This interface returns a pointer to the next [prepared statement] after sl@0: ** pStmt associated with the [database connection] pDb. If pStmt is NULL sl@0: ** then this interface returns a pointer to the first prepared statement sl@0: ** associated with the database connection pDb. If no prepared statement sl@0: ** satisfies the conditions of this routine, it returns NULL. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H13143} If D is a [database connection] that holds one or more sl@0: ** unfinalized [prepared statements] and S is a NULL pointer, sl@0: ** then [sqlite3_next_stmt(D, S)] routine shall return a pointer sl@0: ** to one of the prepared statements associated with D. sl@0: ** sl@0: ** {H13146} If D is a [database connection] that holds no unfinalized sl@0: ** [prepared statements] and S is a NULL pointer, then sl@0: ** [sqlite3_next_stmt(D, S)] routine shall return a NULL pointer. sl@0: ** sl@0: ** {H13149} If S is a [prepared statement] in the [database connection] D sl@0: ** and S is not the last prepared statement in D, then sl@0: ** [sqlite3_next_stmt(D, S)] routine shall return a pointer sl@0: ** to the next prepared statement in D after S. sl@0: ** sl@0: ** {H13152} If S is the last [prepared statement] in the sl@0: ** [database connection] D then the [sqlite3_next_stmt(D, S)] sl@0: ** routine shall return a NULL pointer. sl@0: ** sl@0: ** ASSUMPTIONS: sl@0: ** sl@0: ** {A13154} The [database connection] pointer D in a call to sl@0: ** [sqlite3_next_stmt(D,S)] must refer to an open database sl@0: ** connection and in particular must not be a NULL pointer. sl@0: */ sl@0: sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); sl@0: sl@0: /* sl@0: ** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} sl@0: ** sl@0: ** The sqlite3_commit_hook() interface registers a callback sl@0: ** function to be invoked whenever a transaction is committed. sl@0: ** Any callback set by a previous call to sqlite3_commit_hook() sl@0: ** for the same database connection is overridden. sl@0: ** The sqlite3_rollback_hook() interface registers a callback sl@0: ** function to be invoked whenever a transaction is committed. sl@0: ** Any callback set by a previous call to sqlite3_commit_hook() sl@0: ** for the same database connection is overridden. sl@0: ** The pArg argument is passed through to the callback. sl@0: ** If the callback on a commit hook function returns non-zero, sl@0: ** then the commit is converted into a rollback. sl@0: ** sl@0: ** If another function was previously registered, its sl@0: ** pArg value is returned. Otherwise NULL is returned. sl@0: ** sl@0: ** Registering a NULL function disables the callback. sl@0: ** sl@0: ** For the purposes of this API, a transaction is said to have been sl@0: ** rolled back if an explicit "ROLLBACK" statement is executed, or sl@0: ** an error or constraint causes an implicit rollback to occur. sl@0: ** The rollback callback is not invoked if a transaction is sl@0: ** automatically rolled back because the database connection is closed. sl@0: ** The rollback callback is not invoked if a transaction is sl@0: ** rolled back because a commit callback returned non-zero. sl@0: ** Check on this sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12951} The [sqlite3_commit_hook(D,F,P)] interface registers the sl@0: ** callback function F to be invoked with argument P whenever sl@0: ** a transaction commits on the [database connection] D. sl@0: ** sl@0: ** {H12952} The [sqlite3_commit_hook(D,F,P)] interface returns the P argument sl@0: ** from the previous call with the same [database connection] D, sl@0: ** or NULL on the first call for a particular database connection D. sl@0: ** sl@0: ** {H12953} Each call to [sqlite3_commit_hook()] overwrites the callback sl@0: ** registered by prior calls. sl@0: ** sl@0: ** {H12954} If the F argument to [sqlite3_commit_hook(D,F,P)] is NULL sl@0: ** then the commit hook callback is canceled and no callback sl@0: ** is invoked when a transaction commits. sl@0: ** sl@0: ** {H12955} If the commit callback returns non-zero then the commit is sl@0: ** converted into a rollback. sl@0: ** sl@0: ** {H12961} The [sqlite3_rollback_hook(D,F,P)] interface registers the sl@0: ** callback function F to be invoked with argument P whenever sl@0: ** a transaction rolls back on the [database connection] D. sl@0: ** sl@0: ** {H12962} The [sqlite3_rollback_hook(D,F,P)] interface returns the P sl@0: ** argument from the previous call with the same sl@0: ** [database connection] D, or NULL on the first call sl@0: ** for a particular database connection D. sl@0: ** sl@0: ** {H12963} Each call to [sqlite3_rollback_hook()] overwrites the callback sl@0: ** registered by prior calls. sl@0: ** sl@0: ** {H12964} If the F argument to [sqlite3_rollback_hook(D,F,P)] is NULL sl@0: ** then the rollback hook callback is canceled and no callback sl@0: ** is invoked when a transaction rolls back. sl@0: */ sl@0: void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); sl@0: void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Data Change Notification Callbacks {H12970} sl@0: ** sl@0: ** The sqlite3_update_hook() interface registers a callback function sl@0: ** with the [database connection] identified by the first argument sl@0: ** to be invoked whenever a row is updated, inserted or deleted. sl@0: ** Any callback set by a previous call to this function sl@0: ** for the same database connection is overridden. sl@0: ** sl@0: ** The second argument is a pointer to the function to invoke when a sl@0: ** row is updated, inserted or deleted. sl@0: ** The first argument to the callback is a copy of the third argument sl@0: ** to sqlite3_update_hook(). sl@0: ** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], sl@0: ** or [SQLITE_UPDATE], depending on the operation that caused the callback sl@0: ** to be invoked. sl@0: ** The third and fourth arguments to the callback contain pointers to the sl@0: ** database and table name containing the affected row. sl@0: ** The final callback parameter is the rowid of the row. In the case of sl@0: ** an update, this is the rowid after the update takes place. sl@0: ** sl@0: ** The update hook is not invoked when internal system tables are sl@0: ** modified (i.e. sqlite_master and sqlite_sequence). sl@0: ** sl@0: ** If another function was previously registered, its pArg value sl@0: ** is returned. Otherwise NULL is returned. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H12971} The [sqlite3_update_hook(D,F,P)] interface causes the callback sl@0: ** function F to be invoked with first parameter P whenever sl@0: ** a table row is modified, inserted, or deleted on sl@0: ** the [database connection] D. sl@0: ** sl@0: ** {H12973} The [sqlite3_update_hook(D,F,P)] interface returns the value sl@0: ** of P for the previous call on the same [database connection] D, sl@0: ** or NULL for the first call. sl@0: ** sl@0: ** {H12975} If the update hook callback F in [sqlite3_update_hook(D,F,P)] sl@0: ** is NULL then the no update callbacks are made. sl@0: ** sl@0: ** {H12977} Each call to [sqlite3_update_hook(D,F,P)] overrides prior calls sl@0: ** to the same interface on the same [database connection] D. sl@0: ** sl@0: ** {H12979} The update hook callback is not invoked when internal system sl@0: ** tables such as sqlite_master and sqlite_sequence are modified. sl@0: ** sl@0: ** {H12981} The second parameter to the update callback sl@0: ** is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], sl@0: ** depending on the operation that caused the callback to be invoked. sl@0: ** sl@0: ** {H12983} The third and fourth arguments to the callback contain pointers sl@0: ** to zero-terminated UTF-8 strings which are the names of the sl@0: ** database and table that is being updated. sl@0: sl@0: ** {H12985} The final callback parameter is the rowid of the row after sl@0: ** the change occurs. sl@0: */ sl@0: void *sqlite3_update_hook( sl@0: sqlite3*, sl@0: void(*)(void *,int ,char const *,char const *,sqlite3_int64), sl@0: void* sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} sl@0: ** KEYWORDS: {shared cache} {shared cache mode} sl@0: ** sl@0: ** This routine enables or disables the sharing of the database cache sl@0: ** and schema data structures between [database connection | connections] sl@0: ** to the same database. Sharing is enabled if the argument is true sl@0: ** and disabled if the argument is false. sl@0: ** sl@0: ** Cache sharing is enabled and disabled for an entire process. {END} sl@0: ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, sl@0: ** sharing was enabled or disabled for each thread separately. sl@0: ** sl@0: ** The cache sharing mode set by this interface effects all subsequent sl@0: ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. sl@0: ** Existing database connections continue use the sharing mode sl@0: ** that was in effect at the time they were opened. sl@0: ** sl@0: ** Virtual tables cannot be used with a shared cache. When shared sl@0: ** cache is enabled, the [sqlite3_create_module()] API used to register sl@0: ** virtual tables will always return an error. sl@0: ** sl@0: ** This routine returns [SQLITE_OK] if shared cache was enabled or disabled sl@0: ** successfully. An [error code] is returned otherwise. sl@0: ** sl@0: ** Shared cache is disabled by default. But this might change in sl@0: ** future releases of SQLite. Applications that care about shared sl@0: ** cache setting should set it explicitly. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H10331} A successful invocation of [sqlite3_enable_shared_cache(B)] sl@0: ** will enable or disable shared cache mode for any subsequently sl@0: ** created [database connection] in the same process. sl@0: ** sl@0: ** {H10336} When shared cache is enabled, the [sqlite3_create_module()] sl@0: ** interface will always return an error. sl@0: ** sl@0: ** {H10337} The [sqlite3_enable_shared_cache(B)] interface returns sl@0: ** [SQLITE_OK] if shared cache was enabled or disabled successfully. sl@0: ** sl@0: ** {H10339} Shared cache is disabled by default. sl@0: */ sl@0: int sqlite3_enable_shared_cache(int); sl@0: sl@0: /* sl@0: ** CAPI3REF: Attempt To Free Heap Memory {H17340} sl@0: ** sl@0: ** The sqlite3_release_memory() interface attempts to free N bytes sl@0: ** of heap memory by deallocating non-essential memory allocations sl@0: ** held by the database library. {END} Memory used to cache database sl@0: ** pages to improve performance is an example of non-essential memory. sl@0: ** sqlite3_release_memory() returns the number of bytes actually freed, sl@0: ** which might be more or less than the amount requested. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17341} The [sqlite3_release_memory(N)] interface attempts to sl@0: ** free N bytes of heap memory by deallocating non-essential sl@0: ** memory allocations held by the database library. sl@0: ** sl@0: ** {H16342} The [sqlite3_release_memory(N)] returns the number sl@0: ** of bytes actually freed, which might be more or less sl@0: ** than the amount requested. sl@0: */ sl@0: int sqlite3_release_memory(int); sl@0: sl@0: /* sl@0: ** CAPI3REF: Impose A Limit On Heap Size {H17350} sl@0: ** sl@0: ** The sqlite3_soft_heap_limit() interface places a "soft" limit sl@0: ** on the amount of heap memory that may be allocated by SQLite. sl@0: ** If an internal allocation is requested that would exceed the sl@0: ** soft heap limit, [sqlite3_release_memory()] is invoked one or sl@0: ** more times to free up some space before the allocation is performed. sl@0: ** sl@0: ** The limit is called "soft", because if [sqlite3_release_memory()] sl@0: ** cannot free sufficient memory to prevent the limit from being exceeded, sl@0: ** the memory is allocated anyway and the current operation proceeds. sl@0: ** sl@0: ** A negative or zero value for N means that there is no soft heap limit and sl@0: ** [sqlite3_release_memory()] will only be called when memory is exhausted. sl@0: ** The default value for the soft heap limit is zero. sl@0: ** sl@0: ** SQLite makes a best effort to honor the soft heap limit. sl@0: ** But if the soft heap limit cannot be honored, execution will sl@0: ** continue without error or notification. This is why the limit is sl@0: ** called a "soft" limit. It is advisory only. sl@0: ** sl@0: ** Prior to SQLite version 3.5.0, this routine only constrained the memory sl@0: ** allocated by a single thread - the same thread in which this routine sl@0: ** runs. Beginning with SQLite version 3.5.0, the soft heap limit is sl@0: ** applied to all threads. The value specified for the soft heap limit sl@0: ** is an upper bound on the total memory allocation for all threads. In sl@0: ** version 3.5.0 there is no mechanism for limiting the heap usage for sl@0: ** individual threads. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H16351} The [sqlite3_soft_heap_limit(N)] interface places a soft limit sl@0: ** of N bytes on the amount of heap memory that may be allocated sl@0: ** using [sqlite3_malloc()] or [sqlite3_realloc()] at any point sl@0: ** in time. sl@0: ** sl@0: ** {H16352} If a call to [sqlite3_malloc()] or [sqlite3_realloc()] would sl@0: ** cause the total amount of allocated memory to exceed the sl@0: ** soft heap limit, then [sqlite3_release_memory()] is invoked sl@0: ** in an attempt to reduce the memory usage prior to proceeding sl@0: ** with the memory allocation attempt. sl@0: ** sl@0: ** {H16353} Calls to [sqlite3_malloc()] or [sqlite3_realloc()] that trigger sl@0: ** attempts to reduce memory usage through the soft heap limit sl@0: ** mechanism continue even if the attempt to reduce memory sl@0: ** usage is unsuccessful. sl@0: ** sl@0: ** {H16354} A negative or zero value for N in a call to sl@0: ** [sqlite3_soft_heap_limit(N)] means that there is no soft sl@0: ** heap limit and [sqlite3_release_memory()] will only be sl@0: ** called when memory is completely exhausted. sl@0: ** sl@0: ** {H16355} The default value for the soft heap limit is zero. sl@0: ** sl@0: ** {H16358} Each call to [sqlite3_soft_heap_limit(N)] overrides the sl@0: ** values set by all prior calls. sl@0: */ sl@0: void sqlite3_soft_heap_limit(int); sl@0: sl@0: /* sl@0: ** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} sl@0: ** sl@0: ** This routine returns metadata about a specific column of a specific sl@0: ** database table accessible using the [database connection] handle sl@0: ** passed as the first function argument. sl@0: ** sl@0: ** The column is identified by the second, third and fourth parameters to sl@0: ** this function. The second parameter is either the name of the database sl@0: ** (i.e. "main", "temp" or an attached database) containing the specified sl@0: ** table or NULL. If it is NULL, then all attached databases are searched sl@0: ** for the table using the same algorithm used by the database engine to sl@0: ** resolve unqualified table references. sl@0: ** sl@0: ** The third and fourth parameters to this function are the table and column sl@0: ** name of the desired column, respectively. Neither of these parameters sl@0: ** may be NULL. sl@0: ** sl@0: ** Metadata is returned by writing to the memory locations passed as the 5th sl@0: ** and subsequent parameters to this function. Any of these arguments may be sl@0: ** NULL, in which case the corresponding element of metadata is omitted. sl@0: ** sl@0: **
sl@0: ** sl@0: **
Parameter Output
Type 		Description sl@0: ** sl@0: **
5th const char* Data type sl@0: **
6th const char* Name of default collation sequence sl@0: **
7th int True if column has a NOT NULL constraint sl@0: **
8th int True if column is part of the PRIMARY KEY sl@0: **
9th int True if column is AUTOINCREMENT sl@0: **
sl@0: **
sl@0: ** sl@0: ** The memory pointed to by the character pointers returned for the sl@0: ** declaration type and collation sequence is valid only until the next sl@0: ** call to any SQLite API function. sl@0: ** sl@0: ** If the specified table is actually a view, an [error code] is returned. sl@0: ** sl@0: ** If the specified column is "rowid", "oid" or "_rowid_" and an sl@0: ** INTEGER PRIMARY KEY column has been explicitly declared, then the output sl@0: ** parameters are set for the explicitly declared column. If there is no sl@0: ** explicitly declared INTEGER PRIMARY KEY column, then the output sl@0: ** parameters are set as follows: sl@0: ** sl@0: ** 
sl@0: **     data type: "INTEGER"
sl@0: **     collation sequence: "BINARY"
sl@0: **     not null: 0
sl@0: **     primary key: 1
sl@0: **     auto increment: 0
sl@0: **
sl@0: ** sl@0: ** This function may load one or more schemas from database files. If an sl@0: ** error occurs during this process, or if the requested table or column sl@0: ** cannot be found, an [error code] is returned and an error message left sl@0: ** in the [database connection] (to be retrieved using sqlite3_errmsg()). sl@0: ** sl@0: ** This API is only available if the library was compiled with the sl@0: ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. sl@0: */ sl@0: int sqlite3_table_column_metadata( sl@0: sqlite3 *db, /* Connection handle */ sl@0: const char *zDbName, /* Database name or NULL */ sl@0: const char *zTableName, /* Table name */ sl@0: const char *zColumnName, /* Column name */ sl@0: char const **pzDataType, /* OUTPUT: Declared data type */ sl@0: char const **pzCollSeq, /* OUTPUT: Collation sequence name */ sl@0: int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ sl@0: int *pPrimaryKey, /* OUTPUT: True if column part of PK */ sl@0: int *pAutoinc /* OUTPUT: True if column is auto-increment */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Load An Extension {H12600} sl@0: ** sl@0: ** This interface loads an SQLite extension library from the named file. sl@0: ** sl@0: ** {H12601} The sqlite3_load_extension() interface attempts to load an sl@0: ** SQLite extension library contained in the file zFile. sl@0: ** sl@0: ** {H12602} The entry point is zProc. sl@0: ** sl@0: ** {H12603} zProc may be 0, in which case the name of the entry point sl@0: ** defaults to "sqlite3_extension_init". sl@0: ** sl@0: ** {H12604} The sqlite3_load_extension() interface shall return sl@0: ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. sl@0: ** sl@0: ** {H12605} If an error occurs and pzErrMsg is not 0, then the sl@0: ** [sqlite3_load_extension()] interface shall attempt to sl@0: ** fill *pzErrMsg with error message text stored in memory sl@0: ** obtained from [sqlite3_malloc()]. {END} The calling function sl@0: ** should free this memory by calling [sqlite3_free()]. sl@0: ** sl@0: ** {H12606} Extension loading must be enabled using sl@0: ** [sqlite3_enable_load_extension()] prior to calling this API, sl@0: ** otherwise an error will be returned. sl@0: */ sl@0: int sqlite3_load_extension( sl@0: sqlite3 *db, /* Load the extension into this database connection */ sl@0: const char *zFile, /* Name of the shared library containing extension */ sl@0: const char *zProc, /* Entry point. Derived from zFile if 0 */ sl@0: char **pzErrMsg /* Put error message here if not 0 */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Enable Or Disable Extension Loading {H12620} sl@0: ** sl@0: ** So as not to open security holes in older applications that are sl@0: ** unprepared to deal with extension loading, and as a means of disabling sl@0: ** extension loading while evaluating user-entered SQL, the following API sl@0: ** is provided to turn the [sqlite3_load_extension()] mechanism on and off. sl@0: ** sl@0: ** Extension loading is off by default. See ticket #1863. sl@0: ** sl@0: ** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1 sl@0: ** to turn extension loading on and call it with onoff==0 to turn sl@0: ** it back off again. sl@0: ** sl@0: ** {H12622} Extension loading is off by default. sl@0: */ sl@0: int sqlite3_enable_load_extension(sqlite3 *db, int onoff); sl@0: sl@0: /* sl@0: ** CAPI3REF: Automatically Load An Extensions {H12640} sl@0: ** sl@0: ** This API can be invoked at program startup in order to register sl@0: ** one or more statically linked extensions that will be available sl@0: ** to all new [database connections]. {END} sl@0: ** sl@0: ** This routine stores a pointer to the extension in an array that is sl@0: ** obtained from [sqlite3_malloc()]. If you run a memory leak checker sl@0: ** on your program and it reports a leak because of this array, invoke sl@0: ** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory. sl@0: ** sl@0: ** {H12641} This function registers an extension entry point that is sl@0: ** automatically invoked whenever a new [database connection] sl@0: ** is opened using [sqlite3_open()], [sqlite3_open16()], sl@0: ** or [sqlite3_open_v2()]. sl@0: ** sl@0: ** {H12642} Duplicate extensions are detected so calling this routine sl@0: ** multiple times with the same extension is harmless. sl@0: ** sl@0: ** {H12643} This routine stores a pointer to the extension in an array sl@0: ** that is obtained from [sqlite3_malloc()]. sl@0: ** sl@0: ** {H12644} Automatic extensions apply across all threads. sl@0: */ sl@0: int sqlite3_auto_extension(void *xEntryPoint); sl@0: sl@0: /* sl@0: ** CAPI3REF: Reset Automatic Extension Loading {H12660} sl@0: ** sl@0: ** This function disables all previously registered automatic sl@0: ** extensions. {END} It undoes the effect of all prior sl@0: ** [sqlite3_auto_extension()] calls. sl@0: ** sl@0: ** {H12661} This function disables all previously registered sl@0: ** automatic extensions. sl@0: ** sl@0: ** {H12662} This function disables automatic extensions in all threads. sl@0: */ sl@0: void sqlite3_reset_auto_extension(void); sl@0: sl@0: /* sl@0: ****** EXPERIMENTAL - subject to change without notice ************** sl@0: ** sl@0: ** The interface to the virtual-table mechanism is currently considered sl@0: ** to be experimental. The interface might change in incompatible ways. sl@0: ** If this is a problem for you, do not use the interface at this time. sl@0: ** sl@0: ** When the virtual-table mechanism stabilizes, we will declare the sl@0: ** interface fixed, support it indefinitely, and remove this comment. sl@0: */ sl@0: sl@0: /* sl@0: ** Structures used by the virtual table interface sl@0: */ sl@0: typedef struct sqlite3_vtab sqlite3_vtab; sl@0: typedef struct sqlite3_index_info sqlite3_index_info; sl@0: typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; sl@0: typedef struct sqlite3_module sqlite3_module; sl@0: sl@0: /* sl@0: ** CAPI3REF: Virtual Table Object {H18000} sl@0: ** KEYWORDS: sqlite3_module sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** A module is a class of virtual tables. Each module is defined sl@0: ** by an instance of the following structure. This structure consists sl@0: ** mostly of methods for the module. sl@0: ** sl@0: ** This interface is experimental and is subject to change or sl@0: ** removal in future releases of SQLite. sl@0: */ sl@0: struct sqlite3_module { sl@0: int iVersion; sl@0: int (*xCreate)(sqlite3*, void *pAux, sl@0: int argc, const char *const*argv, sl@0: sqlite3_vtab **ppVTab, char**); sl@0: int (*xConnect)(sqlite3*, void *pAux, sl@0: int argc, const char *const*argv, sl@0: sqlite3_vtab **ppVTab, char**); sl@0: int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); sl@0: int (*xDisconnect)(sqlite3_vtab *pVTab); sl@0: int (*xDestroy)(sqlite3_vtab *pVTab); sl@0: int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); sl@0: int (*xClose)(sqlite3_vtab_cursor*); sl@0: int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, sl@0: int argc, sqlite3_value **argv); sl@0: int (*xNext)(sqlite3_vtab_cursor*); sl@0: int (*xEof)(sqlite3_vtab_cursor*); sl@0: int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); sl@0: int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); sl@0: int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); sl@0: int (*xBegin)(sqlite3_vtab *pVTab); sl@0: int (*xSync)(sqlite3_vtab *pVTab); sl@0: int (*xCommit)(sqlite3_vtab *pVTab); sl@0: int (*xRollback)(sqlite3_vtab *pVTab); sl@0: int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, sl@0: void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), sl@0: void **ppArg); sl@0: int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: Virtual Table Indexing Information {H18100} sl@0: ** KEYWORDS: sqlite3_index_info sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** The sqlite3_index_info structure and its substructures is used to sl@0: ** pass information into and receive the reply from the xBestIndex sl@0: ** method of an sqlite3_module. The fields under **Inputs** are the sl@0: ** inputs to xBestIndex and are read-only. xBestIndex inserts its sl@0: ** results into the **Outputs** fields. sl@0: ** sl@0: ** The aConstraint[] array records WHERE clause constraints of the form: sl@0: ** sl@0: ** 
column OP expr
sl@0: ** sl@0: ** where OP is =, <, <=, >, or >=. The particular operator is sl@0: ** stored in aConstraint[].op. The index of the column is stored in sl@0: ** aConstraint[].iColumn. aConstraint[].usable is TRUE if the sl@0: ** expr on the right-hand side can be evaluated (and thus the constraint sl@0: ** is usable) and false if it cannot. sl@0: ** sl@0: ** The optimizer automatically inverts terms of the form "expr OP column" sl@0: ** and makes other simplifications to the WHERE clause in an attempt to sl@0: ** get as many WHERE clause terms into the form shown above as possible. sl@0: ** The aConstraint[] array only reports WHERE clause terms in the correct sl@0: ** form that refer to the particular virtual table being queried. sl@0: ** sl@0: ** Information about the ORDER BY clause is stored in aOrderBy[]. sl@0: ** Each term of aOrderBy records a column of the ORDER BY clause. sl@0: ** sl@0: ** The xBestIndex method must fill aConstraintUsage[] with information sl@0: ** about what parameters to pass to xFilter. If argvIndex>0 then sl@0: ** the right-hand side of the corresponding aConstraint[] is evaluated sl@0: ** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit sl@0: ** is true, then the constraint is assumed to be fully handled by the sl@0: ** virtual table and is not checked again by SQLite. sl@0: ** sl@0: ** The idxNum and idxPtr values are recorded and passed into xFilter. sl@0: ** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true. sl@0: ** sl@0: ** The orderByConsumed means that output from xFilter will occur in sl@0: ** the correct order to satisfy the ORDER BY clause so that no separate sl@0: ** sorting step is required. sl@0: ** sl@0: ** The estimatedCost value is an estimate of the cost of doing the sl@0: ** particular lookup. A full scan of a table with N entries should have sl@0: ** a cost of N. A binary search of a table of N entries should have a sl@0: ** cost of approximately log(N). sl@0: ** sl@0: ** This interface is experimental and is subject to change or sl@0: ** removal in future releases of SQLite. sl@0: */ sl@0: struct sqlite3_index_info { sl@0: /* Inputs */ sl@0: int nConstraint; /* Number of entries in aConstraint */ sl@0: struct sqlite3_index_constraint { sl@0: int iColumn; /* Column on left-hand side of constraint */ sl@0: unsigned char op; /* Constraint operator */ sl@0: unsigned char usable; /* True if this constraint is usable */ sl@0: int iTermOffset; /* Used internally - xBestIndex should ignore */ sl@0: } *aConstraint; /* Table of WHERE clause constraints */ sl@0: int nOrderBy; /* Number of terms in the ORDER BY clause */ sl@0: struct sqlite3_index_orderby { sl@0: int iColumn; /* Column number */ sl@0: unsigned char desc; /* True for DESC. False for ASC. */ sl@0: } *aOrderBy; /* The ORDER BY clause */ sl@0: /* Outputs */ sl@0: struct sqlite3_index_constraint_usage { sl@0: int argvIndex; /* if >0, constraint is part of argv to xFilter */ sl@0: unsigned char omit; /* Do not code a test for this constraint */ sl@0: } *aConstraintUsage; sl@0: int idxNum; /* Number used to identify the index */ sl@0: char *idxStr; /* String, possibly obtained from sqlite3_malloc */ sl@0: int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ sl@0: int orderByConsumed; /* True if output is already ordered */ sl@0: double estimatedCost; /* Estimated cost of using this index */ sl@0: }; sl@0: #define SQLITE_INDEX_CONSTRAINT_EQ 2 sl@0: #define SQLITE_INDEX_CONSTRAINT_GT 4 sl@0: #define SQLITE_INDEX_CONSTRAINT_LE 8 sl@0: #define SQLITE_INDEX_CONSTRAINT_LT 16 sl@0: #define SQLITE_INDEX_CONSTRAINT_GE 32 sl@0: #define SQLITE_INDEX_CONSTRAINT_MATCH 64 sl@0: sl@0: /* sl@0: ** CAPI3REF: Register A Virtual Table Implementation {H18200} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** This routine is used to register a new module name with a sl@0: ** [database connection]. Module names must be registered before sl@0: ** creating new virtual tables on the module, or before using sl@0: ** preexisting virtual tables of the module. sl@0: ** sl@0: ** This interface is experimental and is subject to change or sl@0: ** removal in future releases of SQLite. sl@0: */ sl@0: int sqlite3_create_module( sl@0: sqlite3 *db, /* SQLite connection to register module with */ sl@0: const char *zName, /* Name of the module */ sl@0: const sqlite3_module *, /* Methods for the module */ sl@0: void * /* Client data for xCreate/xConnect */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Register A Virtual Table Implementation {H18210} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** This routine is identical to the [sqlite3_create_module()] method above, sl@0: ** except that it allows a destructor function to be specified. It is sl@0: ** even more experimental than the rest of the virtual tables API. sl@0: */ sl@0: int sqlite3_create_module_v2( sl@0: sqlite3 *db, /* SQLite connection to register module with */ sl@0: const char *zName, /* Name of the module */ sl@0: const sqlite3_module *, /* Methods for the module */ sl@0: void *, /* Client data for xCreate/xConnect */ sl@0: void(*xDestroy)(void*) /* Module destructor function */ sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Virtual Table Instance Object {H18010} sl@0: ** KEYWORDS: sqlite3_vtab sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** Every module implementation uses a subclass of the following structure sl@0: ** to describe a particular instance of the module. Each subclass will sl@0: ** be tailored to the specific needs of the module implementation. sl@0: ** The purpose of this superclass is to define certain fields that are sl@0: ** common to all module implementations. sl@0: ** sl@0: ** Virtual tables methods can set an error message by assigning a sl@0: ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should sl@0: ** take care that any prior string is freed by a call to [sqlite3_free()] sl@0: ** prior to assigning a new string to zErrMsg. After the error message sl@0: ** is delivered up to the client application, the string will be automatically sl@0: ** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note sl@0: ** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field sl@0: ** since virtual tables are commonly implemented in loadable extensions which sl@0: ** do not have access to sqlite3MPrintf() or sqlite3Free(). sl@0: ** sl@0: ** This interface is experimental and is subject to change or sl@0: ** removal in future releases of SQLite. sl@0: */ sl@0: struct sqlite3_vtab { sl@0: const sqlite3_module *pModule; /* The module for this virtual table */ sl@0: int nRef; /* Used internally */ sl@0: char *zErrMsg; /* Error message from sqlite3_mprintf() */ sl@0: /* Virtual table implementations will typically add additional fields */ sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: Virtual Table Cursor Object {H18020} sl@0: ** KEYWORDS: sqlite3_vtab_cursor sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** Every module implementation uses a subclass of the following structure sl@0: ** to describe cursors that point into the virtual table and are used sl@0: ** to loop through the virtual table. Cursors are created using the sl@0: ** xOpen method of the module. Each module implementation will define sl@0: ** the content of a cursor structure to suit its own needs. sl@0: ** sl@0: ** This superclass exists in order to define fields of the cursor that sl@0: ** are common to all implementations. sl@0: ** sl@0: ** This interface is experimental and is subject to change or sl@0: ** removal in future releases of SQLite. sl@0: */ sl@0: struct sqlite3_vtab_cursor { sl@0: sqlite3_vtab *pVtab; /* Virtual table of this cursor */ sl@0: /* Virtual table implementations will typically add additional fields */ sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** The xCreate and xConnect methods of a module use the following API sl@0: ** to declare the format (the names and datatypes of the columns) of sl@0: ** the virtual tables they implement. sl@0: ** sl@0: ** This interface is experimental and is subject to change or sl@0: ** removal in future releases of SQLite. sl@0: */ sl@0: int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable); sl@0: sl@0: /* sl@0: ** CAPI3REF: Overload A Function For A Virtual Table {H18300} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** Virtual tables can provide alternative implementations of functions sl@0: ** using the xFindFunction method. But global versions of those functions sl@0: ** must exist in order to be overloaded. sl@0: ** sl@0: ** This API makes sure a global version of a function with a particular sl@0: ** name and number of parameters exists. If no such function exists sl@0: ** before this API is called, a new function is created. The implementation sl@0: ** of the new function always causes an exception to be thrown. So sl@0: ** the new function is not good for anything by itself. Its only sl@0: ** purpose is to be a placeholder function that can be overloaded sl@0: ** by virtual tables. sl@0: ** sl@0: ** This API should be considered part of the virtual table interface, sl@0: ** which is experimental and subject to change. sl@0: */ sl@0: int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); sl@0: sl@0: /* sl@0: ** The interface to the virtual-table mechanism defined above (back up sl@0: ** to a comment remarkably similar to this one) is currently considered sl@0: ** to be experimental. The interface might change in incompatible ways. sl@0: ** If this is a problem for you, do not use the interface at this time. sl@0: ** sl@0: ** When the virtual-table mechanism stabilizes, we will declare the sl@0: ** interface fixed, support it indefinitely, and remove this comment. sl@0: ** sl@0: ****** EXPERIMENTAL - subject to change without notice ************** sl@0: */ sl@0: sl@0: /* sl@0: ** CAPI3REF: A Handle To An Open BLOB {H17800} sl@0: ** KEYWORDS: {BLOB handle} {BLOB handles} sl@0: ** sl@0: ** An instance of this object represents an open BLOB on which sl@0: ** [sqlite3_blob_open | incremental BLOB I/O] can be performed. sl@0: ** Objects of this type are created by [sqlite3_blob_open()] sl@0: ** and destroyed by [sqlite3_blob_close()]. sl@0: ** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces sl@0: ** can be used to read or write small subsections of the BLOB. sl@0: ** The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. sl@0: */ sl@0: typedef struct sqlite3_blob sqlite3_blob; sl@0: sl@0: /* sl@0: ** CAPI3REF: Open A BLOB For Incremental I/O {H17810} sl@0: ** sl@0: ** This interfaces opens a [BLOB handle | handle] to the BLOB located sl@0: ** in row iRow, column zColumn, table zTable in database zDb; sl@0: ** in other words, the same BLOB that would be selected by: sl@0: ** sl@0: ** 
sl@0: **     SELECT zColumn FROM zDb.zTable WHERE rowid = iRow;
sl@0: **
{END} sl@0: ** sl@0: ** If the flags parameter is non-zero, the the BLOB is opened for read sl@0: ** and write access. If it is zero, the BLOB is opened for read access. sl@0: ** sl@0: ** Note that the database name is not the filename that contains sl@0: ** the database but rather the symbolic name of the database that sl@0: ** is assigned when the database is connected using [ATTACH]. sl@0: ** For the main database file, the database name is "main". sl@0: ** For TEMP tables, the database name is "temp". sl@0: ** sl@0: ** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written sl@0: ** to *ppBlob. Otherwise an [error code] is returned and any value written sl@0: ** to *ppBlob should not be used by the caller. sl@0: ** This function sets the [database connection] error code and message sl@0: ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()]. sl@0: ** sl@0: ** If the row that a BLOB handle points to is modified by an sl@0: ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects sl@0: ** then the BLOB handle is marked as "expired". sl@0: ** This is true if any column of the row is changed, even a column sl@0: ** other than the one the BLOB handle is open on. sl@0: ** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for sl@0: ** a expired BLOB handle fail with an return code of [SQLITE_ABORT]. sl@0: ** Changes written into a BLOB prior to the BLOB expiring are not sl@0: ** rollback by the expiration of the BLOB. Such changes will eventually sl@0: ** commit if the transaction continues to completion. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17813} A successful invocation of the [sqlite3_blob_open(D,B,T,C,R,F,P)] sl@0: ** interface shall open an [sqlite3_blob] object P on the BLOB sl@0: ** in column C of the table T in the database B on sl@0: ** the [database connection] D. sl@0: ** sl@0: ** {H17814} A successful invocation of [sqlite3_blob_open(D,...)] shall start sl@0: ** a new transaction on the [database connection] D if that sl@0: ** connection is not already in a transaction. sl@0: ** sl@0: ** {H17816} The [sqlite3_blob_open(D,B,T,C,R,F,P)] interface shall open sl@0: ** the BLOB for read and write access if and only if the F sl@0: ** parameter is non-zero. sl@0: ** sl@0: ** {H17819} The [sqlite3_blob_open()] interface shall return [SQLITE_OK] on sl@0: ** success and an appropriate [error code] on failure. sl@0: ** sl@0: ** {H17821} If an error occurs during evaluation of [sqlite3_blob_open(D,...)] sl@0: ** then subsequent calls to [sqlite3_errcode(D)], sl@0: ** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] shall return sl@0: ** information appropriate for that error. sl@0: ** sl@0: ** {H17824} If any column in the row that a [sqlite3_blob] has open is sl@0: ** changed by a separate [UPDATE] or [DELETE] statement or by sl@0: ** an [ON CONFLICT] side effect, then the [sqlite3_blob] shall sl@0: ** be marked as invalid. sl@0: */ sl@0: int sqlite3_blob_open( sl@0: sqlite3*, sl@0: const char *zDb, sl@0: const char *zTable, sl@0: const char *zColumn, sl@0: sqlite3_int64 iRow, sl@0: int flags, sl@0: sqlite3_blob **ppBlob sl@0: ); sl@0: sl@0: /* sl@0: ** CAPI3REF: Close A BLOB Handle {H17830} sl@0: ** sl@0: ** Closes an open [BLOB handle]. sl@0: ** sl@0: ** Closing a BLOB shall cause the current transaction to commit sl@0: ** if there are no other BLOBs, no pending prepared statements, and the sl@0: ** database connection is in [autocommit mode]. sl@0: ** If any writes were made to the BLOB, they might be held in cache sl@0: ** until the close operation if they will fit. {END} sl@0: ** sl@0: ** Closing the BLOB often forces the changes sl@0: ** out to disk and so if any I/O errors occur, they will likely occur sl@0: ** at the time when the BLOB is closed. {H17833} Any errors that occur during sl@0: ** closing are reported as a non-zero return value. sl@0: ** sl@0: ** The BLOB is closed unconditionally. Even if this routine returns sl@0: ** an error code, the BLOB is still closed. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17833} The [sqlite3_blob_close(P)] interface closes an [sqlite3_blob] sl@0: ** object P previously opened using [sqlite3_blob_open()]. sl@0: ** sl@0: ** {H17836} Closing an [sqlite3_blob] object using sl@0: ** [sqlite3_blob_close()] shall cause the current transaction to sl@0: ** commit if there are no other open [sqlite3_blob] objects sl@0: ** or [prepared statements] on the same [database connection] and sl@0: ** the database connection is in [autocommit mode]. sl@0: ** sl@0: ** {H17839} The [sqlite3_blob_close(P)] interfaces shall close the sl@0: ** [sqlite3_blob] object P unconditionally, even if sl@0: ** [sqlite3_blob_close(P)] returns something other than [SQLITE_OK]. sl@0: */ sl@0: int sqlite3_blob_close(sqlite3_blob *); sl@0: sl@0: /* sl@0: ** CAPI3REF: Return The Size Of An Open BLOB {H17840} sl@0: ** sl@0: ** Returns the size in bytes of the BLOB accessible via the open sl@0: ** []BLOB handle] in its only argument. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17843} The [sqlite3_blob_bytes(P)] interface returns the size sl@0: ** in bytes of the BLOB that the [sqlite3_blob] object P sl@0: ** refers to. sl@0: */ sl@0: int sqlite3_blob_bytes(sqlite3_blob *); sl@0: sl@0: /* sl@0: ** CAPI3REF: Read Data From A BLOB Incrementally {H17850} sl@0: ** sl@0: ** This function is used to read data from an open [BLOB handle] into a sl@0: ** caller-supplied buffer. N bytes of data are copied into buffer Z sl@0: ** from the open BLOB, starting at offset iOffset. sl@0: ** sl@0: ** If offset iOffset is less than N bytes from the end of the BLOB, sl@0: ** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is sl@0: ** less than zero, [SQLITE_ERROR] is returned and no data is read. sl@0: ** sl@0: ** An attempt to read from an expired [BLOB handle] fails with an sl@0: ** error code of [SQLITE_ABORT]. sl@0: ** sl@0: ** On success, SQLITE_OK is returned. sl@0: ** Otherwise, an [error code] or an [extended error code] is returned. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17853} A successful invocation of [sqlite3_blob_read(P,Z,N,X)] sl@0: ** shall reads N bytes of data out of the BLOB referenced by sl@0: ** [BLOB handle] P beginning at offset X and store those bytes sl@0: ** into buffer Z. sl@0: ** sl@0: ** {H17856} In [sqlite3_blob_read(P,Z,N,X)] if the size of the BLOB sl@0: ** is less than N+X bytes, then the function shall leave the sl@0: ** Z buffer unchanged and return [SQLITE_ERROR]. sl@0: ** sl@0: ** {H17859} In [sqlite3_blob_read(P,Z,N,X)] if X or N is less than zero sl@0: ** then the function shall leave the Z buffer unchanged sl@0: ** and return [SQLITE_ERROR]. sl@0: ** sl@0: ** {H17862} The [sqlite3_blob_read(P,Z,N,X)] interface shall return [SQLITE_OK] sl@0: ** if N bytes are successfully read into buffer Z. sl@0: ** sl@0: ** {H17863} If the [BLOB handle] P is expired and X and N are within bounds sl@0: ** then [sqlite3_blob_read(P,Z,N,X)] shall leave the Z buffer sl@0: ** unchanged and return [SQLITE_ABORT]. sl@0: ** sl@0: ** {H17865} If the requested read could not be completed, sl@0: ** the [sqlite3_blob_read(P,Z,N,X)] interface shall return an sl@0: ** appropriate [error code] or [extended error code]. sl@0: ** sl@0: ** {H17868} If an error occurs during evaluation of [sqlite3_blob_read(P,...)] sl@0: ** then subsequent calls to [sqlite3_errcode(D)], sl@0: ** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] shall return sl@0: ** information appropriate for that error, where D is the sl@0: ** [database connection] that was used to open the [BLOB handle] P. sl@0: */ sl@0: int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); sl@0: sl@0: /* sl@0: ** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} sl@0: ** sl@0: ** This function is used to write data into an open [BLOB handle] from a sl@0: ** caller-supplied buffer. N bytes of data are copied from the buffer Z sl@0: ** into the open BLOB, starting at offset iOffset. sl@0: ** sl@0: ** If the [BLOB handle] passed as the first argument was not opened for sl@0: ** writing (the flags parameter to [sqlite3_blob_open()] was zero), sl@0: ** this function returns [SQLITE_READONLY]. sl@0: ** sl@0: ** This function may only modify the contents of the BLOB; it is sl@0: ** not possible to increase the size of a BLOB using this API. sl@0: ** If offset iOffset is less than N bytes from the end of the BLOB, sl@0: ** [SQLITE_ERROR] is returned and no data is written. If N is sl@0: ** less than zero [SQLITE_ERROR] is returned and no data is written. sl@0: ** sl@0: ** An attempt to write to an expired [BLOB handle] fails with an sl@0: ** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred sl@0: ** before the [BLOB handle] expired are not rolled back by the sl@0: ** expiration of the handle, though of course those changes might sl@0: ** have been overwritten by the statement that expired the BLOB handle sl@0: ** or by other independent statements. sl@0: ** sl@0: ** On success, SQLITE_OK is returned. sl@0: ** Otherwise, an [error code] or an [extended error code] is returned. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H17873} A successful invocation of [sqlite3_blob_write(P,Z,N,X)] sl@0: ** shall write N bytes of data from buffer Z into the BLOB sl@0: ** referenced by [BLOB handle] P beginning at offset X into sl@0: ** the BLOB. sl@0: ** sl@0: ** {H17874} In the absence of other overridding changes, the changes sl@0: ** written to a BLOB by [sqlite3_blob_write()] shall sl@0: ** remain in effect after the associated [BLOB handle] expires. sl@0: ** sl@0: ** {H17875} If the [BLOB handle] P was opened for reading only then sl@0: ** an invocation of [sqlite3_blob_write(P,Z,N,X)] shall leave sl@0: ** the referenced BLOB unchanged and return [SQLITE_READONLY]. sl@0: ** sl@0: ** {H17876} If the size of the BLOB referenced by [BLOB handle] P is sl@0: ** less than N+X bytes then [sqlite3_blob_write(P,Z,N,X)] shall sl@0: ** leave the BLOB unchanged and return [SQLITE_ERROR]. sl@0: ** sl@0: ** {H17877} If the [BLOB handle] P is expired and X and N are within bounds sl@0: ** then [sqlite3_blob_read(P,Z,N,X)] shall leave the BLOB sl@0: ** unchanged and return [SQLITE_ABORT]. sl@0: ** sl@0: ** {H17879} If X or N are less than zero then [sqlite3_blob_write(P,Z,N,X)] sl@0: ** shall leave the BLOB referenced by [BLOB handle] P unchanged sl@0: ** and return [SQLITE_ERROR]. sl@0: ** sl@0: ** {H17882} The [sqlite3_blob_write(P,Z,N,X)] interface shall return sl@0: ** [SQLITE_OK] if N bytes where successfully written into the BLOB. sl@0: ** sl@0: ** {H17885} If the requested write could not be completed, sl@0: ** the [sqlite3_blob_write(P,Z,N,X)] interface shall return an sl@0: ** appropriate [error code] or [extended error code]. sl@0: ** sl@0: ** {H17888} If an error occurs during evaluation of [sqlite3_blob_write(D,...)] sl@0: ** then subsequent calls to [sqlite3_errcode(D)], sl@0: ** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] shall return sl@0: ** information appropriate for that error. sl@0: */ sl@0: int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); sl@0: sl@0: /* sl@0: ** CAPI3REF: Virtual File System Objects {H11200} sl@0: ** sl@0: ** A virtual filesystem (VFS) is an [sqlite3_vfs] object sl@0: ** that SQLite uses to interact sl@0: ** with the underlying operating system. Most SQLite builds come with a sl@0: ** single default VFS that is appropriate for the host computer. sl@0: ** New VFSes can be registered and existing VFSes can be unregistered. sl@0: ** The following interfaces are provided. sl@0: ** sl@0: ** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. sl@0: ** Names are case sensitive. sl@0: ** Names are zero-terminated UTF-8 strings. sl@0: ** If there is no match, a NULL pointer is returned. sl@0: ** If zVfsName is NULL then the default VFS is returned. sl@0: ** sl@0: ** New VFSes are registered with sqlite3_vfs_register(). sl@0: ** Each new VFS becomes the default VFS if the makeDflt flag is set. sl@0: ** The same VFS can be registered multiple times without injury. sl@0: ** To make an existing VFS into the default VFS, register it again sl@0: ** with the makeDflt flag set. If two different VFSes with the sl@0: ** same name are registered, the behavior is undefined. If a sl@0: ** VFS is registered with a name that is NULL or an empty string, sl@0: ** then the behavior is undefined. sl@0: ** sl@0: ** Unregister a VFS with the sqlite3_vfs_unregister() interface. sl@0: ** If the default VFS is unregistered, another VFS is chosen as sl@0: ** the default. The choice for the new VFS is arbitrary. sl@0: ** sl@0: ** INVARIANTS: sl@0: ** sl@0: ** {H11203} The [sqlite3_vfs_find(N)] interface returns a pointer to the sl@0: ** registered [sqlite3_vfs] object whose name exactly matches sl@0: ** the zero-terminated UTF-8 string N, or it returns NULL if sl@0: ** there is no match. sl@0: ** sl@0: ** {H11206} If the N parameter to [sqlite3_vfs_find(N)] is NULL then sl@0: ** the function returns a pointer to the default [sqlite3_vfs] sl@0: ** object if there is one, or NULL if there is no default sl@0: ** [sqlite3_vfs] object. sl@0: ** sl@0: ** {H11209} The [sqlite3_vfs_register(P,F)] interface registers the sl@0: ** well-formed [sqlite3_vfs] object P using the name given sl@0: ** by the zName field of the object. sl@0: ** sl@0: ** {H11212} Using the [sqlite3_vfs_register(P,F)] interface to register sl@0: ** the same [sqlite3_vfs] object multiple times is a harmless no-op. sl@0: ** sl@0: ** {H11215} The [sqlite3_vfs_register(P,F)] interface makes the [sqlite3_vfs] sl@0: ** object P the default [sqlite3_vfs] object if F is non-zero. sl@0: ** sl@0: ** {H11218} The [sqlite3_vfs_unregister(P)] interface unregisters the sl@0: ** [sqlite3_vfs] object P so that it is no longer returned by sl@0: ** subsequent calls to [sqlite3_vfs_find()]. sl@0: */ sl@0: sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); sl@0: int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); sl@0: int sqlite3_vfs_unregister(sqlite3_vfs*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Mutexes {H17000} sl@0: ** sl@0: ** The SQLite core uses these routines for thread sl@0: ** synchronization. Though they are intended for internal sl@0: ** use by SQLite, code that links against SQLite is sl@0: ** permitted to use any of these routines. sl@0: ** sl@0: ** The SQLite source code contains multiple implementations sl@0: ** of these mutex routines. An appropriate implementation sl@0: ** is selected automatically at compile-time. The following sl@0: ** implementations are available in the SQLite core: sl@0: ** sl@0: **
    sl@0: **
  • SQLITE_MUTEX_OS2 sl@0: **
  • SQLITE_MUTEX_PTHREAD sl@0: **
  • SQLITE_MUTEX_W32 sl@0: **
  • SQLITE_MUTEX_NOOP sl@0: **
sl@0: ** sl@0: ** The SQLITE_MUTEX_NOOP implementation is a set of routines sl@0: ** that does no real locking and is appropriate for use in sl@0: ** a single-threaded application. The SQLITE_MUTEX_OS2, sl@0: ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations sl@0: ** are appropriate for use on OS/2, Unix, and Windows. sl@0: ** sl@0: ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor sl@0: ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex sl@0: ** implementation is included with the library. In this case the sl@0: ** application must supply a custom mutex implementation using the sl@0: ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function sl@0: ** before calling sqlite3_initialize() or any other public sqlite3_ sl@0: ** function that calls sqlite3_initialize(). sl@0: ** sl@0: ** {H17011} The sqlite3_mutex_alloc() routine allocates a new sl@0: ** mutex and returns a pointer to it. {H17012} If it returns NULL sl@0: ** that means that a mutex could not be allocated. {H17013} SQLite sl@0: ** will unwind its stack and return an error. {H17014} The argument sl@0: ** to sqlite3_mutex_alloc() is one of these integer constants: sl@0: ** sl@0: **
    sl@0: **
  • SQLITE_MUTEX_FAST sl@0: **
  • SQLITE_MUTEX_RECURSIVE sl@0: **
  • SQLITE_MUTEX_STATIC_MASTER sl@0: **
  • SQLITE_MUTEX_STATIC_MEM sl@0: **
  • SQLITE_MUTEX_STATIC_MEM2 sl@0: **
  • SQLITE_MUTEX_STATIC_PRNG sl@0: **
  • SQLITE_MUTEX_STATIC_LRU sl@0: **
  • SQLITE_MUTEX_STATIC_LRU2 sl@0: **
sl@0: ** sl@0: ** {H17015} The first two constants cause sqlite3_mutex_alloc() to create sl@0: ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE sl@0: ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END} sl@0: ** The mutex implementation does not need to make a distinction sl@0: ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does sl@0: ** not want to. {H17016} But SQLite will only request a recursive mutex in sl@0: ** cases where it really needs one. {END} If a faster non-recursive mutex sl@0: ** implementation is available on the host platform, the mutex subsystem sl@0: ** might return such a mutex in response to SQLITE_MUTEX_FAST. sl@0: ** sl@0: ** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return sl@0: ** a pointer to a static preexisting mutex. {END} Four static mutexes are sl@0: ** used by the current version of SQLite. Future versions of SQLite sl@0: ** may add additional static mutexes. Static mutexes are for internal sl@0: ** use by SQLite only. Applications that use SQLite mutexes should sl@0: ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or sl@0: ** SQLITE_MUTEX_RECURSIVE. sl@0: ** sl@0: ** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST sl@0: ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() sl@0: ** returns a different mutex on every call. {H17034} But for the static sl@0: ** mutex types, the same mutex is returned on every call that has sl@0: ** the same type number. sl@0: ** sl@0: ** {H17019} The sqlite3_mutex_free() routine deallocates a previously sl@0: ** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every sl@0: ** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in sl@0: ** use when they are deallocated. {A17022} Attempting to deallocate a static sl@0: ** mutex results in undefined behavior. {H17023} SQLite never deallocates sl@0: ** a static mutex. {END} sl@0: ** sl@0: ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt sl@0: ** to enter a mutex. {H17024} If another thread is already within the mutex, sl@0: ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return sl@0: ** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK] sl@0: ** upon successful entry. {H17026} Mutexes created using sl@0: ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. sl@0: ** {H17027} In such cases the, sl@0: ** mutex must be exited an equal number of times before another thread sl@0: ** can enter. {A17028} If the same thread tries to enter any other sl@0: ** kind of mutex more than once, the behavior is undefined. sl@0: ** {H17029} SQLite will never exhibit sl@0: ** such behavior in its own use of mutexes. sl@0: ** sl@0: ** Some systems (for example, Windows 95) do not support the operation sl@0: ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() sl@0: ** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses sl@0: ** sqlite3_mutex_try() as an optimization so this is acceptable behavior. sl@0: ** sl@0: ** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was sl@0: ** previously entered by the same thread. {A17032} The behavior sl@0: ** is undefined if the mutex is not currently entered by the sl@0: ** calling thread or is not currently allocated. {H17033} SQLite will sl@0: ** never do either. {END} sl@0: ** sl@0: ** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or sl@0: ** sqlite3_mutex_leave() is a NULL pointer, then all three routines sl@0: ** behave as no-ops. sl@0: ** sl@0: ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. sl@0: */ sl@0: sqlite3_mutex *sqlite3_mutex_alloc(int); sl@0: void sqlite3_mutex_free(sqlite3_mutex*); sl@0: void sqlite3_mutex_enter(sqlite3_mutex*); sl@0: int sqlite3_mutex_try(sqlite3_mutex*); sl@0: void sqlite3_mutex_leave(sqlite3_mutex*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Mutex Methods Object {H17120} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** An instance of this structure defines the low-level routines sl@0: ** used to allocate and use mutexes. sl@0: ** sl@0: ** Usually, the default mutex implementations provided by SQLite are sl@0: ** sufficient, however the user has the option of substituting a custom sl@0: ** implementation for specialized deployments or systems for which SQLite sl@0: ** does not provide a suitable implementation. In this case, the user sl@0: ** creates and populates an instance of this structure to pass sl@0: ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. sl@0: ** Additionally, an instance of this structure can be used as an sl@0: ** output variable when querying the system for the current mutex sl@0: ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. sl@0: ** sl@0: ** The xMutexInit method defined by this structure is invoked as sl@0: ** part of system initialization by the sqlite3_initialize() function. sl@0: ** {H17001} The xMutexInit routine shall be called by SQLite once for each sl@0: ** effective call to [sqlite3_initialize()]. sl@0: ** sl@0: ** The xMutexEnd method defined by this structure is invoked as sl@0: ** part of system shutdown by the sqlite3_shutdown() function. The sl@0: ** implementation of this method is expected to release all outstanding sl@0: ** resources obtained by the mutex methods implementation, especially sl@0: ** those obtained by the xMutexInit method. {H17003} The xMutexEnd() sl@0: ** interface shall be invoked once for each call to [sqlite3_shutdown()]. sl@0: ** sl@0: ** The remaining seven methods defined by this structure (xMutexAlloc, sl@0: ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and sl@0: ** xMutexNotheld) implement the following interfaces (respectively): sl@0: ** sl@0: **
    sl@0: **
  • [sqlite3_mutex_alloc()]
    • sl@0: **
  • [sqlite3_mutex_free()]
    • sl@0: **
  • [sqlite3_mutex_enter()]
    • sl@0: **
  • [sqlite3_mutex_try()]
    • sl@0: **
  • [sqlite3_mutex_leave()]
    • sl@0: **
  • [sqlite3_mutex_held()]
    • sl@0: **
  • [sqlite3_mutex_notheld()]
    • sl@0: **
sl@0: ** sl@0: ** The only difference is that the public sqlite3_XXX functions enumerated sl@0: ** above silently ignore any invocations that pass a NULL pointer instead sl@0: ** of a valid mutex handle. The implementations of the methods defined sl@0: ** by this structure are not required to handle this case, the results sl@0: ** of passing a NULL pointer instead of a valid mutex handle are undefined sl@0: ** (i.e. it is acceptable to provide an implementation that segfaults if sl@0: ** it is passed a NULL pointer). sl@0: */ sl@0: typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; sl@0: struct sqlite3_mutex_methods { sl@0: int (*xMutexInit)(void); sl@0: int (*xMutexEnd)(void); sl@0: sqlite3_mutex *(*xMutexAlloc)(int); sl@0: void (*xMutexFree)(sqlite3_mutex *); sl@0: void (*xMutexEnter)(sqlite3_mutex *); sl@0: int (*xMutexTry)(sqlite3_mutex *); sl@0: void (*xMutexLeave)(sqlite3_mutex *); sl@0: int (*xMutexHeld)(sqlite3_mutex *); sl@0: int (*xMutexNotheld)(sqlite3_mutex *); sl@0: }; sl@0: sl@0: /* sl@0: ** CAPI3REF: Mutex Verification Routines {H17080} sl@0: ** sl@0: ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines sl@0: ** are intended for use inside assert() statements. {H17081} The SQLite core sl@0: ** never uses these routines except inside an assert() and applications sl@0: ** are advised to follow the lead of the core. {H17082} The core only sl@0: ** provides implementations for these routines when it is compiled sl@0: ** with the SQLITE_DEBUG flag. {A17087} External mutex implementations sl@0: ** are only required to provide these routines if SQLITE_DEBUG is sl@0: ** defined and if NDEBUG is not defined. sl@0: ** sl@0: ** {H17083} These routines should return true if the mutex in their argument sl@0: ** is held or not held, respectively, by the calling thread. sl@0: ** sl@0: ** {X17084} The implementation is not required to provided versions of these sl@0: ** routines that actually work. If the implementation does not provide working sl@0: ** versions of these routines, it should at least provide stubs that always sl@0: ** return true so that one does not get spurious assertion failures. sl@0: ** sl@0: ** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then sl@0: ** the routine should return 1. {END} This seems counter-intuitive since sl@0: ** clearly the mutex cannot be held if it does not exist. But the sl@0: ** the reason the mutex does not exist is because the build is not sl@0: ** using mutexes. And we do not want the assert() containing the sl@0: ** call to sqlite3_mutex_held() to fail, so a non-zero return is sl@0: ** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld() sl@0: ** interface should also return 1 when given a NULL pointer. sl@0: */ sl@0: int sqlite3_mutex_held(sqlite3_mutex*); sl@0: int sqlite3_mutex_notheld(sqlite3_mutex*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Mutex Types {H17001} sl@0: ** sl@0: ** The [sqlite3_mutex_alloc()] interface takes a single argument sl@0: ** which is one of these integer constants. sl@0: ** sl@0: ** The set of static mutexes may change from one SQLite release to the sl@0: ** next. Applications that override the built-in mutex logic must be sl@0: ** prepared to accommodate additional static mutexes. sl@0: */ sl@0: #define SQLITE_MUTEX_FAST 0 sl@0: #define SQLITE_MUTEX_RECURSIVE 1 sl@0: #define SQLITE_MUTEX_STATIC_MASTER 2 sl@0: #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ sl@0: #define SQLITE_MUTEX_STATIC_MEM2 4 /* sqlite3_release_memory() */ sl@0: #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ sl@0: #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ sl@0: #define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */ sl@0: sl@0: /* sl@0: ** CAPI3REF: Low-Level Control Of Database Files {H11300} sl@0: ** sl@0: ** {H11301} The [sqlite3_file_control()] interface makes a direct call to the sl@0: ** xFileControl method for the [sqlite3_io_methods] object associated sl@0: ** with a particular database identified by the second argument. {H11302} The sl@0: ** name of the database is the name assigned to the database by the sl@0: ** ATTACH SQL command that opened the sl@0: ** database. {H11303} To control the main database file, use the name "main" sl@0: ** or a NULL pointer. {H11304} The third and fourth parameters to this routine sl@0: ** are passed directly through to the second and third parameters of sl@0: ** the xFileControl method. {H11305} The return value of the xFileControl sl@0: ** method becomes the return value of this routine. sl@0: ** sl@0: ** {H11306} If the second parameter (zDbName) does not match the name of any sl@0: ** open database file, then SQLITE_ERROR is returned. {H11307} This error sl@0: ** code is not remembered and will not be recalled by [sqlite3_errcode()] sl@0: ** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might sl@0: ** also return SQLITE_ERROR. {A11309} There is no way to distinguish between sl@0: ** an incorrect zDbName and an SQLITE_ERROR return from the underlying sl@0: ** xFileControl method. {END} sl@0: ** sl@0: ** See also: [SQLITE_FCNTL_LOCKSTATE] sl@0: */ sl@0: int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); sl@0: sl@0: /* sl@0: ** CAPI3REF: Testing Interface {H11400} sl@0: ** sl@0: ** The sqlite3_test_control() interface is used to read out internal sl@0: ** state of SQLite and to inject faults into SQLite for testing sl@0: ** purposes. The first parameter is an operation code that determines sl@0: ** the number, meaning, and operation of all subsequent parameters. sl@0: ** sl@0: ** This interface is not for use by applications. It exists solely sl@0: ** for verifying the correct operation of the SQLite library. Depending sl@0: ** on how the SQLite library is compiled, this interface might not exist. sl@0: ** sl@0: ** The details of the operation codes, their meanings, the parameters sl@0: ** they take, and what they do are all subject to change without notice. sl@0: ** Unlike most of the SQLite API, this function is not guaranteed to sl@0: ** operate consistently from one release to the next. sl@0: */ sl@0: int sqlite3_test_control(int op, ...); sl@0: sl@0: /* sl@0: ** CAPI3REF: Testing Interface Operation Codes {H11410} sl@0: ** sl@0: ** These constants are the valid operation code parameters used sl@0: ** as the first argument to [sqlite3_test_control()]. sl@0: ** sl@0: ** These parameters and their meanings are subject to change sl@0: ** without notice. These values are for testing purposes only. sl@0: ** Applications should not use any of these parameters or the sl@0: ** [sqlite3_test_control()] interface. sl@0: */ sl@0: #define SQLITE_TESTCTRL_PRNG_SAVE 5 sl@0: #define SQLITE_TESTCTRL_PRNG_RESTORE 6 sl@0: #define SQLITE_TESTCTRL_PRNG_RESET 7 sl@0: #define SQLITE_TESTCTRL_BITVEC_TEST 8 sl@0: #define SQLITE_TESTCTRL_FAULT_INSTALL 9 sl@0: #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 sl@0: sl@0: /* sl@0: ** CAPI3REF: SQLite Runtime Status {H17200} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** This interface is used to retrieve runtime status information sl@0: ** about the preformance of SQLite, and optionally to reset various sl@0: ** highwater marks. The first argument is an integer code for sl@0: ** the specific parameter to measure. Recognized integer codes sl@0: ** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...]. sl@0: ** The current value of the parameter is returned into *pCurrent. sl@0: ** The highest recorded value is returned in *pHighwater. If the sl@0: ** resetFlag is true, then the highest record value is reset after sl@0: ** *pHighwater is written. Some parameters do not record the highest sl@0: ** value. For those parameters sl@0: ** nothing is written into *pHighwater and the resetFlag is ignored. sl@0: ** Other parameters record only the highwater mark and not the current sl@0: ** value. For these latter parameters nothing is written into *pCurrent. sl@0: ** sl@0: ** This routine returns SQLITE_OK on success and a non-zero sl@0: ** [error code] on failure. sl@0: ** sl@0: ** This routine is threadsafe but is not atomic. This routine can sl@0: ** called while other threads are running the same or different SQLite sl@0: ** interfaces. However the values returned in *pCurrent and sl@0: ** *pHighwater reflect the status of SQLite at different points in time sl@0: ** and it is possible that another thread might change the parameter sl@0: ** in between the times when *pCurrent and *pHighwater are written. sl@0: ** sl@0: ** See also: [sqlite3_db_status()] sl@0: */ sl@0: int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); sl@0: sl@0: /* sl@0: ** CAPI3REF: Database Connection Status {H17201} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** This interface is used to retrieve runtime status information sl@0: ** about a single [database connection]. The first argument is the sl@0: ** database connection object to be interrogated. The second argument sl@0: ** is the parameter to interrogate. Currently, the only allowed value sl@0: ** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED]. sl@0: ** Additional options will likely appear in future releases of SQLite. sl@0: ** sl@0: ** The current value of the request parameter is written into *pCur sl@0: ** and the highest instantaneous value is written into *pHiwtr. If sl@0: ** the resetFlg is true, then the highest instantaneous value is sl@0: ** reset back down to the current value. sl@0: ** sl@0: ** See also: [sqlite3_status()]. sl@0: */ sl@0: int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); sl@0: sl@0: /* sl@0: ** CAPI3REF: Status Parameters {H17250} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** These integer constants designate various run-time status parameters sl@0: ** that can be returned by [sqlite3_status()]. sl@0: ** sl@0: **
sl@0: **
SQLITE_STATUS_MEMORY_USED
sl@0: **
This parameter is the current amount of memory checked out sl@0: ** using [sqlite3_malloc()], either directly or indirectly. The sl@0: ** figure includes calls made to [sqlite3_malloc()] by the application sl@0: ** and internal memory usage by the SQLite library. Scratch memory sl@0: ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache sl@0: ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in sl@0: ** this parameter. The amount returned is the sum of the allocation sl@0: ** sizes as reported by the xSize method in [sqlite3_mem_methods].
sl@0: ** sl@0: **
SQLITE_STATUS_MALLOC_SIZE
sl@0: **
This parameter records the largest memory allocation request sl@0: ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their sl@0: ** internal equivalents). Only the value returned in the sl@0: ** *pHighwater parameter to [sqlite3_status()] is of interest. sl@0: ** The value written into the *pCurrent parameter is undefined.
sl@0: ** sl@0: **
SQLITE_STATUS_PAGECACHE_USED
sl@0: **
This parameter returns the number of pages used out of the sl@0: ** [pagecache memory allocator] that was configured using sl@0: ** [SQLITE_CONFIG_PAGECACHE]. The sl@0: ** value returned is in pages, not in bytes.
sl@0: ** sl@0: **
SQLITE_STATUS_PAGECACHE_OVERFLOW
sl@0: **
This parameter returns the number of bytes of page cache sl@0: ** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE] sl@0: ** buffer and where forced to overflow to [sqlite3_malloc()]. The sl@0: ** returned value includes allocations that overflowed because they sl@0: ** where too large (they were larger than the "sz" parameter to sl@0: ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because sl@0: ** no space was left in the page cache.
sl@0: ** sl@0: **
SQLITE_STATUS_PAGECACHE_SIZE
sl@0: **
This parameter records the largest memory allocation request sl@0: ** handed to [pagecache memory allocator]. Only the value returned in the sl@0: ** *pHighwater parameter to [sqlite3_status()] is of interest. sl@0: ** The value written into the *pCurrent parameter is undefined.
sl@0: ** sl@0: **
SQLITE_STATUS_SCRATCH_USED
sl@0: **
This parameter returns the number of allocations used out of the sl@0: ** [scratch memory allocator] configured using sl@0: ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not sl@0: ** in bytes. Since a single thread may only have one scratch allocation sl@0: ** outstanding at time, this parameter also reports the number of threads sl@0: ** using scratch memory at the same time.
sl@0: ** sl@0: **
SQLITE_STATUS_SCRATCH_OVERFLOW
sl@0: **
This parameter returns the number of bytes of scratch memory sl@0: ** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH] sl@0: ** buffer and where forced to overflow to [sqlite3_malloc()]. The values sl@0: ** returned include overflows because the requested allocation was too sl@0: ** larger (that is, because the requested allocation was larger than the sl@0: ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer sl@0: ** slots were available. sl@0: **
sl@0: ** sl@0: **
SQLITE_STATUS_SCRATCH_SIZE
sl@0: **
This parameter records the largest memory allocation request sl@0: ** handed to [scratch memory allocator]. Only the value returned in the sl@0: ** *pHighwater parameter to [sqlite3_status()] is of interest. sl@0: ** The value written into the *pCurrent parameter is undefined.
sl@0: ** sl@0: **
SQLITE_STATUS_PARSER_STACK
sl@0: **
This parameter records the deepest parser stack. It is only sl@0: ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].
sl@0: **
sl@0: ** sl@0: ** New status parameters may be added from time to time. sl@0: */ sl@0: #define SQLITE_STATUS_MEMORY_USED 0 sl@0: #define SQLITE_STATUS_PAGECACHE_USED 1 sl@0: #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 sl@0: #define SQLITE_STATUS_SCRATCH_USED 3 sl@0: #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 sl@0: #define SQLITE_STATUS_MALLOC_SIZE 5 sl@0: #define SQLITE_STATUS_PARSER_STACK 6 sl@0: #define SQLITE_STATUS_PAGECACHE_SIZE 7 sl@0: #define SQLITE_STATUS_SCRATCH_SIZE 8 sl@0: sl@0: /* sl@0: ** CAPI3REF: Status Parameters for database connections {H17275} sl@0: ** EXPERIMENTAL sl@0: ** sl@0: ** Status verbs for [sqlite3_db_status()]. sl@0: ** sl@0: **
sl@0: **
SQLITE_DBSTATUS_LOOKASIDE_USED
sl@0: **
This parameter returns the number of lookaside memory slots currently sl@0: ** checked out.
sl@0: **
sl@0: */ sl@0: #define SQLITE_DBSTATUS_LOOKASIDE_USED 0 sl@0: sl@0: /* sl@0: ** Undo the hack that converts floating point types to integer for sl@0: ** builds on processors without floating point support. sl@0: */ sl@0: #ifdef SQLITE_OMIT_FLOATING_POINT sl@0: # undef double sl@0: #endif sl@0: sl@0: #ifdef __cplusplus sl@0: } /* End of the 'extern "C"' block */ sl@0: #endif sl@0: #endif