ds@1952: /* ds@1952: ** 2001 September 15 ds@1952: ** ds@1952: ** The author disclaims copyright to this source code. In place of ds@1952: ** a legal notice, here is a blessing: ds@1952: ** ds@1952: ** May you do good and not evil. ds@1952: ** May you find forgiveness for yourself and forgive others. ds@1952: ** May you share freely, never taking more than you give. ds@1952: ** ds@1952: ************************************************************************* ds@1952: ** This header file defines the interface that the SQLite library ds@1952: ** presents to client programs. If a C-function, structure, datatype, ds@1952: ** or constant definition does not appear in this file, then it is ds@1952: ** not a published API of SQLite, is subject to change without ds@1952: ** notice, and should not be referenced by programs that use SQLite. ds@1952: ** ds@1952: ** Some of the definitions that are in this file are marked as ds@1952: ** "experimental". Experimental interfaces are normally new skamonkey@3594: ** features recently added to SQLite. We do not anticipate changes skamonkey@3594: ** to experimental interfaces but reserve the right to make minor changes skamonkey@3594: ** if experience from use "in the wild" suggest such changes are prudent. ds@1952: ** ds@1952: ** The official C-language API documentation for SQLite is derived ds@1952: ** from comments in this file. This file is the authoritative source ds@1952: ** on how SQLite interfaces are suppose to operate. ds@1952: ** ds@1952: ** The name of this file under configuration management is "sqlite.h.in". ds@1952: ** The makefile makes some minor changes to this file (such as inserting ds@1952: ** the version number) and changes its name to "sqlite3.h" as ds@1952: ** part of the build process. ds@1952: */ ds@1952: #ifndef _SQLITE3_H_ ds@1952: #define _SQLITE3_H_ ds@1952: #include /* Needed for the definition of va_list */ ds@1952: ds@1952: /* ds@1952: ** Make sure we can call this stuff from C++. ds@1952: */ ds@1952: #ifdef __cplusplus ds@1952: extern "C" { ds@1952: #endif ds@1952: ds@1952: ds@1952: /* ds@1952: ** Add the ability to override 'extern' ds@1952: */ ds@1952: #ifndef SQLITE_EXTERN ds@1952: # define SQLITE_EXTERN extern ds@1952: #endif ds@1952: skamonkey@3594: #ifndef SQLITE_API skamonkey@3594: # define SQLITE_API skamonkey@3594: #endif skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** These no-op macros are used in front of interfaces to mark those skamonkey@3594: ** interfaces as either deprecated or experimental. New applications skamonkey@3594: ** should not use deprecated interfaces - they are support for backwards skamonkey@3594: ** compatibility only. Application writers should be aware that skamonkey@3594: ** experimental interfaces are subject to change in point releases. skamonkey@3594: ** skamonkey@3594: ** These macros used to resolve to various kinds of compiler magic that skamonkey@3594: ** would generate warning messages when they were used. But that skamonkey@3594: ** compiler magic ended up generating such a flurry of bug reports skamonkey@3594: ** that we have taken it all out and gone back to using simple skamonkey@3594: ** noop macros. skamonkey@3594: */ skamonkey@3594: #define SQLITE_DEPRECATED skamonkey@3594: #define SQLITE_EXPERIMENTAL skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** Ensure these symbols were not defined by some previous header file. ds@1952: */ ds@1952: #ifdef SQLITE_VERSION ds@1952: # undef SQLITE_VERSION ds@1952: #endif ds@1952: #ifdef SQLITE_VERSION_NUMBER ds@1952: # undef SQLITE_VERSION_NUMBER ds@1952: #endif ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Compile-Time Library Version Numbers ds@1952: ** skamonkey@3594: ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header skamonkey@3594: ** evaluates to a string literal that is the SQLite version in the skamonkey@3594: ** format "X.Y.Z" where X is the major version number (always 3 for skamonkey@3594: ** SQLite3) and Y is the minor version number and Z is the release number.)^ skamonkey@3594: ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer skamonkey@3594: ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same skamonkey@3594: ** numbers used in [SQLITE_VERSION].)^ skamonkey@3594: ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also skamonkey@3594: ** be larger than the release from which it is derived. Either Y will skamonkey@3594: ** be held constant and Z will be incremented or else Y will be incremented skamonkey@3594: ** and Z will be reset to zero. skamonkey@3594: ** skamonkey@3594: ** Since version 3.6.18, SQLite source code has been stored in the skamonkey@3594: ** Fossil configuration management skamonkey@3594: ** system. ^The SQLITE_SOURCE_ID macro evaluates to skamonkey@3594: ** a string which identifies a particular check-in of SQLite skamonkey@3594: ** within its configuration management system. ^The SQLITE_SOURCE_ID skamonkey@3594: ** string contains the date and time of the check-in (UTC) and an SHA1 skamonkey@3594: ** hash of the entire source tree. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_libversion()], skamonkey@3594: ** [sqlite3_libversion_number()], [sqlite3_sourceid()], skamonkey@3594: ** [sqlite_version()] and [sqlite_source_id()]. skamonkey@3594: */ skamonkey@3594: #define SQLITE_VERSION "3.7.13" skamonkey@3594: #define SQLITE_VERSION_NUMBER 3007013 skamonkey@3594: #define SQLITE_SOURCE_ID "2012-06-11 02:05:22 f5b5a13f7394dc143aa136f1d4faba6839eaa6dc" ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Run-Time Library Version Numbers skamonkey@3594: ** KEYWORDS: sqlite3_version, sqlite3_sourceid skamonkey@3594: ** skamonkey@3594: ** These interfaces provide the same information as the [SQLITE_VERSION], skamonkey@3594: ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros skamonkey@3594: ** but are associated with the library instead of the header file. ^(Cautious skamonkey@3594: ** programmers might include assert() statements in their application to skamonkey@3594: ** verify that values returned by these interfaces match the macros in skamonkey@3594: ** the header, and thus insure that the application is skamonkey@3594: ** compiled with matching library and header files. skamonkey@3594: ** skamonkey@3594: ** 
skamonkey@3594: ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
skamonkey@3594: ** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
skamonkey@3594: ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] skamonkey@3594: ** macro. ^The sqlite3_libversion() function returns a pointer to the skamonkey@3594: ** to the sqlite3_version[] string constant. The sqlite3_libversion() skamonkey@3594: ** function is provided for use in DLLs since DLL users usually do not have skamonkey@3594: ** direct access to string constants within the DLL. ^The skamonkey@3594: ** sqlite3_libversion_number() function returns an integer equal to skamonkey@3594: ** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns skamonkey@3594: ** a pointer to a string constant whose value is the same as the skamonkey@3594: ** [SQLITE_SOURCE_ID] C preprocessor macro. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite_version()] and [sqlite_source_id()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API SQLITE_EXTERN const char sqlite3_version[]; skamonkey@3594: SQLITE_API const char *sqlite3_libversion(void); skamonkey@3594: SQLITE_API const char *sqlite3_sourceid(void); skamonkey@3594: SQLITE_API int sqlite3_libversion_number(void); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Run-Time Library Compilation Options Diagnostics skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_compileoption_used() function returns 0 or 1 skamonkey@3594: ** indicating whether the specified option was defined at skamonkey@3594: ** compile time. ^The SQLITE_ prefix may be omitted from the skamonkey@3594: ** option name passed to sqlite3_compileoption_used(). skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_compileoption_get() function allows iterating skamonkey@3594: ** over the list of options that were defined at compile time by skamonkey@3594: ** returning the N-th compile time option string. ^If N is out of range, skamonkey@3594: ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ skamonkey@3594: ** prefix is omitted from any strings returned by skamonkey@3594: ** sqlite3_compileoption_get(). skamonkey@3594: ** skamonkey@3594: ** ^Support for the diagnostic functions sqlite3_compileoption_used() skamonkey@3594: ** and sqlite3_compileoption_get() may be omitted by specifying the skamonkey@3594: ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. skamonkey@3594: ** skamonkey@3594: ** See also: SQL functions [sqlite_compileoption_used()] and skamonkey@3594: ** [sqlite_compileoption_get()] and the [compile_options pragma]. skamonkey@3594: */ skamonkey@3594: #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS skamonkey@3594: SQLITE_API int sqlite3_compileoption_used(const char *zOptName); skamonkey@3594: SQLITE_API const char *sqlite3_compileoption_get(int N); skamonkey@3594: #endif ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Test To See If The Library Is Threadsafe ds@1952: ** skamonkey@3594: ** ^The sqlite3_threadsafe() function returns zero if and only if skamonkey@3594: ** SQLite was compiled with mutexing code omitted due to the skamonkey@3594: ** [SQLITE_THREADSAFE] compile-time option being set to 0. skamonkey@3594: ** skamonkey@3594: ** SQLite can be compiled with or without mutexes. When skamonkey@3594: ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes skamonkey@3594: ** are enabled and SQLite is threadsafe. When the skamonkey@3594: ** [SQLITE_THREADSAFE] macro is 0, skamonkey@3594: ** the mutexes are omitted. Without the mutexes, it is not safe skamonkey@3594: ** to use SQLite concurrently from more than one thread. skamonkey@3594: ** skamonkey@3594: ** Enabling mutexes incurs a measurable performance penalty. skamonkey@3594: ** So if speed is of utmost importance, it makes sense to disable skamonkey@3594: ** the mutexes. But for maximum safety, mutexes should be enabled. skamonkey@3594: ** ^The default behavior is for mutexes to be enabled. skamonkey@3594: ** skamonkey@3594: ** This interface can be used by an application to make sure that the skamonkey@3594: ** version of SQLite that it is linking against was compiled with skamonkey@3594: ** the desired setting of the [SQLITE_THREADSAFE] macro. skamonkey@3594: ** skamonkey@3594: ** This interface only reports on the compile-time mutex setting skamonkey@3594: ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with skamonkey@3594: ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but skamonkey@3594: ** can be fully or partially disabled using a call to [sqlite3_config()] skamonkey@3594: ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], skamonkey@3594: ** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the skamonkey@3594: ** sqlite3_threadsafe() function shows only the compile-time setting of skamonkey@3594: ** thread safety, not any run-time changes to that setting made by skamonkey@3594: ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() skamonkey@3594: ** is unchanged by calls to sqlite3_config().)^ skamonkey@3594: ** skamonkey@3594: ** See the [threading mode] documentation for additional information. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_threadsafe(void); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Database Connection Handle skamonkey@3594: ** KEYWORDS: {database connection} {database connections} skamonkey@3594: ** skamonkey@3594: ** Each open SQLite database is represented by a pointer to an instance of skamonkey@3594: ** the opaque structure named "sqlite3". It is useful to think of an sqlite3 ds@1952: ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and skamonkey@3594: ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] skamonkey@3594: ** is its destructor. There are many other interfaces (such as skamonkey@3594: ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and skamonkey@3594: ** [sqlite3_busy_timeout()] to name but three) that are methods on an skamonkey@3594: ** sqlite3 object. ds@1952: */ ds@1952: typedef struct sqlite3 sqlite3; ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: 64-Bit Integer Types skamonkey@3594: ** KEYWORDS: sqlite_int64 sqlite_uint64 skamonkey@3594: ** skamonkey@3594: ** Because there is no cross-platform way to specify 64-bit integer types skamonkey@3594: ** SQLite includes typedefs for 64-bit signed and unsigned integers. skamonkey@3594: ** skamonkey@3594: ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. skamonkey@3594: ** The sqlite_int64 and sqlite_uint64 types are supported for backwards skamonkey@3594: ** compatibility only. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_int64 and sqlite_int64 types can store integer values skamonkey@3594: ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The skamonkey@3594: ** sqlite3_uint64 and sqlite_uint64 types can store integer values skamonkey@3594: ** between 0 and +18446744073709551615 inclusive. ds@1952: */ ds@1952: #ifdef SQLITE_INT64_TYPE ds@1952: typedef SQLITE_INT64_TYPE sqlite_int64; ds@1952: typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; ds@1952: #elif defined(_MSC_VER) || defined(__BORLANDC__) ds@1952: typedef __int64 sqlite_int64; ds@1952: typedef unsigned __int64 sqlite_uint64; ds@1952: #else ds@1952: typedef long long int sqlite_int64; ds@1952: typedef unsigned long long int sqlite_uint64; ds@1952: #endif ds@1952: typedef sqlite_int64 sqlite3_int64; ds@1952: typedef sqlite_uint64 sqlite3_uint64; ds@1952: ds@1952: /* ds@1952: ** If compiling for a processor that lacks floating point support, skamonkey@3594: ** substitute integer for floating-point. ds@1952: */ ds@1952: #ifdef SQLITE_OMIT_FLOATING_POINT ds@1952: # define double sqlite3_int64 ds@1952: #endif ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Closing A Database Connection ds@1952: ** skamonkey@3594: ** ^The sqlite3_close() routine is the destructor for the [sqlite3] object. skamonkey@3594: ** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is skamonkey@3594: ** successfully destroyed and all associated resources are deallocated. skamonkey@3594: ** skamonkey@3594: ** Applications must [sqlite3_finalize | finalize] all [prepared statements] skamonkey@3594: ** and [sqlite3_blob_close | close] all [BLOB handles] associated with skamonkey@3594: ** the [sqlite3] object prior to attempting to close the object. ^If skamonkey@3594: ** sqlite3_close() is called on a [database connection] that still has skamonkey@3594: ** outstanding [prepared statements] or [BLOB handles], then it returns skamonkey@3594: ** SQLITE_BUSY. skamonkey@3594: ** skamonkey@3594: ** ^If [sqlite3_close()] is invoked while a transaction is open, skamonkey@3594: ** the transaction is automatically rolled back. skamonkey@3594: ** skamonkey@3594: ** The C parameter to [sqlite3_close(C)] must be either a NULL skamonkey@3594: ** pointer or an [sqlite3] object pointer obtained skamonkey@3594: ** from [sqlite3_open()], [sqlite3_open16()], or skamonkey@3594: ** [sqlite3_open_v2()], and not previously closed. skamonkey@3594: ** ^Calling sqlite3_close() with a NULL pointer argument is a skamonkey@3594: ** harmless no-op. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_close(sqlite3 *); ds@1952: ds@1952: /* ds@1952: ** The type for a callback function. ds@1952: ** This is legacy and deprecated. It is included for historical ds@1952: ** compatibility and is not documented. ds@1952: */ ds@1952: typedef int (*sqlite3_callback)(void*,int,char**, char**); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: One-Step Query Execution Interface ds@1952: ** skamonkey@3594: ** The sqlite3_exec() interface is a convenience wrapper around skamonkey@3594: ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], skamonkey@3594: ** that allows an application to run multiple statements of SQL skamonkey@3594: ** without having to use a lot of C code. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, skamonkey@3594: ** semicolon-separate SQL statements passed into its 2nd argument, skamonkey@3594: ** in the context of the [database connection] passed in as its 1st skamonkey@3594: ** argument. ^If the callback function of the 3rd argument to skamonkey@3594: ** sqlite3_exec() is not NULL, then it is invoked for each result row skamonkey@3594: ** coming out of the evaluated SQL statements. ^The 4th argument to skamonkey@3594: ** sqlite3_exec() is relayed through to the 1st argument of each skamonkey@3594: ** callback invocation. ^If the callback pointer to sqlite3_exec() skamonkey@3594: ** is NULL, then no callback is ever invoked and result rows are skamonkey@3594: ** ignored. skamonkey@3594: ** skamonkey@3594: ** ^If an error occurs while evaluating the SQL statements passed into skamonkey@3594: ** sqlite3_exec(), then execution of the current statement stops and skamonkey@3594: ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() skamonkey@3594: ** is not NULL then any error message is written into memory obtained skamonkey@3594: ** from [sqlite3_malloc()] and passed back through the 5th parameter. skamonkey@3594: ** To avoid memory leaks, the application should invoke [sqlite3_free()] skamonkey@3594: ** on error message strings returned through the 5th parameter of skamonkey@3594: ** of sqlite3_exec() after the error message string is no longer needed. skamonkey@3594: ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors skamonkey@3594: ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to skamonkey@3594: ** NULL before returning. skamonkey@3594: ** skamonkey@3594: ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() skamonkey@3594: ** routine returns SQLITE_ABORT without invoking the callback again and skamonkey@3594: ** without running any subsequent SQL statements. skamonkey@3594: ** skamonkey@3594: ** ^The 2nd argument to the sqlite3_exec() callback function is the skamonkey@3594: ** number of columns in the result. ^The 3rd argument to the sqlite3_exec() skamonkey@3594: ** callback is an array of pointers to strings obtained as if from skamonkey@3594: ** [sqlite3_column_text()], one for each column. ^If an element of a skamonkey@3594: ** result row is NULL then the corresponding string pointer for the skamonkey@3594: ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the skamonkey@3594: ** sqlite3_exec() callback is an array of pointers to strings where each skamonkey@3594: ** entry represents the name of corresponding result column as obtained skamonkey@3594: ** from [sqlite3_column_name()]. skamonkey@3594: ** skamonkey@3594: ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer skamonkey@3594: ** to an empty string, or a pointer that contains only whitespace and/or skamonkey@3594: ** SQL comments, then no SQL statements are evaluated and the database skamonkey@3594: ** is not changed. skamonkey@3594: ** skamonkey@3594: ** Restrictions: skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_exec( ds@1952: sqlite3*, /* An open database */ skamonkey@3594: const char *sql, /* SQL to be evaluated */ ds@1952: int (*callback)(void*,int,char**,char**), /* Callback function */ ds@1952: void *, /* 1st argument to callback */ ds@1952: char **errmsg /* Error msg written here */ ds@1952: ); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Result Codes skamonkey@3594: ** KEYWORDS: SQLITE_OK {error code} {error codes} skamonkey@3594: ** KEYWORDS: {result code} {result codes} ds@1952: ** ds@1952: ** Many SQLite functions return an integer result code from the set shown skamonkey@3594: ** here in order to indicate success or failure. skamonkey@3594: ** skamonkey@3594: ** New error codes may be added in future versions of SQLite. skamonkey@3594: ** skamonkey@3594: ** See also: [SQLITE_IOERR_READ | extended result codes], skamonkey@3594: ** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes]. ds@1952: */ ds@1952: #define SQLITE_OK 0 /* Successful result */ ds@1952: /* beginning-of-error-codes */ ds@1952: #define SQLITE_ERROR 1 /* SQL error or missing database */ skamonkey@3594: #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ ds@1952: #define SQLITE_PERM 3 /* Access permission denied */ ds@1952: #define SQLITE_ABORT 4 /* Callback routine requested an abort */ ds@1952: #define SQLITE_BUSY 5 /* The database file is locked */ ds@1952: #define SQLITE_LOCKED 6 /* A table in the database is locked */ ds@1952: #define SQLITE_NOMEM 7 /* A malloc() failed */ ds@1952: #define SQLITE_READONLY 8 /* Attempt to write a readonly database */ ds@1952: #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ ds@1952: #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ ds@1952: #define SQLITE_CORRUPT 11 /* The database disk image is malformed */ skamonkey@3594: #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ ds@1952: #define SQLITE_FULL 13 /* Insertion failed because database is full */ ds@1952: #define SQLITE_CANTOPEN 14 /* Unable to open the database file */ skamonkey@3594: #define SQLITE_PROTOCOL 15 /* Database lock protocol error */ ds@1952: #define SQLITE_EMPTY 16 /* Database is empty */ ds@1952: #define SQLITE_SCHEMA 17 /* The database schema changed */ ds@1952: #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ ds@1952: #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ ds@1952: #define SQLITE_MISMATCH 20 /* Data type mismatch */ ds@1952: #define SQLITE_MISUSE 21 /* Library used incorrectly */ ds@1952: #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ ds@1952: #define SQLITE_AUTH 23 /* Authorization denied */ ds@1952: #define SQLITE_FORMAT 24 /* Auxiliary database format error */ ds@1952: #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ ds@1952: #define SQLITE_NOTADB 26 /* File opened that is not a database file */ ds@1952: #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ ds@1952: #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ ds@1952: /* end-of-error-codes */ ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Extended Result Codes skamonkey@3594: ** KEYWORDS: {extended error code} {extended error codes} skamonkey@3594: ** KEYWORDS: {extended result code} {extended result codes} ds@1952: ** ds@1952: ** In its default configuration, SQLite API routines return one of 26 integer skamonkey@3594: ** [SQLITE_OK | result codes]. However, experience has shown that many of skamonkey@3594: ** these result codes are too coarse-grained. They do not provide as skamonkey@3594: ** much information about problems as programmers might like. In an effort to ds@1952: ** address this, newer versions of SQLite (version 3.3.8 and later) include ds@1952: ** support for additional result codes that provide more detailed information skamonkey@3594: ** about errors. The extended result codes are enabled or disabled skamonkey@3594: ** on a per database connection basis using the skamonkey@3594: ** [sqlite3_extended_result_codes()] API. skamonkey@3594: ** skamonkey@3594: ** Some of the available extended result codes are listed here. skamonkey@3594: ** One may expect the number of extended result codes will be expand ds@1952: ** over time. Software that uses extended result codes should expect ds@1952: ** to see new result codes in future releases of SQLite. ds@1952: ** ds@1952: ** The SQLITE_OK result code will never be extended. It will always ds@1952: ** be exactly zero. ds@1952: */ skamonkey@3594: #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) skamonkey@3594: #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) skamonkey@3594: #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) skamonkey@3594: #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) skamonkey@3594: #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) skamonkey@3594: #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) skamonkey@3594: #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) skamonkey@3594: #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) skamonkey@3594: #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) skamonkey@3594: #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) skamonkey@3594: #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) skamonkey@3594: #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) skamonkey@3594: #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) skamonkey@3594: #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) skamonkey@3594: #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) skamonkey@3594: #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) skamonkey@3594: #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) skamonkey@3594: #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) skamonkey@3594: #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) skamonkey@3594: #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) skamonkey@3594: #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) skamonkey@3594: #define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) skamonkey@3594: #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) skamonkey@3594: #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) skamonkey@3594: #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) skamonkey@3594: #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) skamonkey@3594: #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) skamonkey@3594: #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) skamonkey@3594: #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) skamonkey@3594: #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Flags For File Open Operations ds@1952: ** skamonkey@3594: ** These bit values are intended for use in the skamonkey@3594: ** 3rd parameter to the [sqlite3_open_v2()] interface and skamonkey@3594: ** in the 4th parameter to the [sqlite3_vfs.xOpen] method. skamonkey@3594: */ skamonkey@3594: #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ skamonkey@3594: #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ skamonkey@3594: #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ skamonkey@3594: skamonkey@3594: /* Reserved: 0x00F00000 */ ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Device Characteristics ds@1952: ** skamonkey@3594: ** The xDeviceCharacteristics method of the [sqlite3_io_methods] skamonkey@3594: ** object returns an integer which is a vector of the these ds@1952: ** bit values expressing I/O characteristics of the mass storage ds@1952: ** device that holds the file that the [sqlite3_io_methods] ds@1952: ** refers to. ds@1952: ** ds@1952: ** The SQLITE_IOCAP_ATOMIC property means that all writes of ds@1952: ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values ds@1952: ** mean that writes of blocks that are nnn bytes in size and ds@1952: ** are aligned to an address which is an integer multiple of ds@1952: ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means ds@1952: ** that when data is appended to a file, the data is appended ds@1952: ** first then the size of the file is extended, never the other ds@1952: ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that ds@1952: ** information is written to disk in the same order as calls skamonkey@3594: ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that skamonkey@3594: ** after reboot following a crash or power loss, the only bytes in a skamonkey@3594: ** file that were written at the application level might have changed skamonkey@3594: ** and that adjacent bytes, even bytes within the same sector are skamonkey@3594: ** guaranteed to be unchanged. skamonkey@3594: */ skamonkey@3594: #define SQLITE_IOCAP_ATOMIC 0x00000001 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC512 0x00000002 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC1K 0x00000004 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC2K 0x00000008 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC4K 0x00000010 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC8K 0x00000020 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC16K 0x00000040 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC32K 0x00000080 skamonkey@3594: #define SQLITE_IOCAP_ATOMIC64K 0x00000100 skamonkey@3594: #define SQLITE_IOCAP_SAFE_APPEND 0x00000200 skamonkey@3594: #define SQLITE_IOCAP_SEQUENTIAL 0x00000400 skamonkey@3594: #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 skamonkey@3594: #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: File Locking Levels ds@1952: ** skamonkey@3594: ** SQLite uses one of these integer values as the second ds@1952: ** argument to calls it makes to the xLock() and xUnlock() methods ds@1952: ** of an [sqlite3_io_methods] object. ds@1952: */ ds@1952: #define SQLITE_LOCK_NONE 0 ds@1952: #define SQLITE_LOCK_SHARED 1 ds@1952: #define SQLITE_LOCK_RESERVED 2 ds@1952: #define SQLITE_LOCK_PENDING 3 ds@1952: #define SQLITE_LOCK_EXCLUSIVE 4 ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Synchronization Type Flags ds@1952: ** skamonkey@3594: ** When SQLite invokes the xSync() method of an skamonkey@3594: ** [sqlite3_io_methods] object it uses a combination of skamonkey@3594: ** these integer values as the second argument. ds@1952: ** ds@1952: ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the ds@1952: ** sync operation only needs to flush data to mass storage. Inode skamonkey@3594: ** information need not be flushed. If the lower four bits of the flag skamonkey@3594: ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. skamonkey@3594: ** If the lower four bits equal SQLITE_SYNC_FULL, that means skamonkey@3594: ** to use Mac OS X style fullsync instead of fsync(). skamonkey@3594: ** skamonkey@3594: ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags skamonkey@3594: ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL skamonkey@3594: ** settings. The [synchronous pragma] determines when calls to the skamonkey@3594: ** xSync VFS method occur and applies uniformly across all platforms. skamonkey@3594: ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how skamonkey@3594: ** energetic or rigorous or forceful the sync operations are and skamonkey@3594: ** only make a difference on Mac OSX for the default SQLite code. skamonkey@3594: ** (Third-party VFS implementations might also make the distinction skamonkey@3594: ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the skamonkey@3594: ** operating systems natively supported by SQLite, only Mac OSX skamonkey@3594: ** cares about the difference.) ds@1952: */ ds@1952: #define SQLITE_SYNC_NORMAL 0x00002 ds@1952: #define SQLITE_SYNC_FULL 0x00003 ds@1952: #define SQLITE_SYNC_DATAONLY 0x00010 ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: OS Interface Open File Handle ds@1952: ** skamonkey@3594: ** An [sqlite3_file] object represents an open file in the skamonkey@3594: ** [sqlite3_vfs | OS interface layer]. Individual OS interface skamonkey@3594: ** implementations will ds@1952: ** want to subclass this object by appending additional fields ds@1952: ** for their own use. The pMethods entry is a pointer to an ds@1952: ** [sqlite3_io_methods] object that defines methods for performing ds@1952: ** I/O operations on the open file. ds@1952: */ ds@1952: typedef struct sqlite3_file sqlite3_file; ds@1952: struct sqlite3_file { ds@1952: const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ ds@1952: }; ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: OS Interface File Virtual Methods Object ds@1952: ** skamonkey@3594: ** Every file opened by the [sqlite3_vfs.xOpen] method populates an skamonkey@3594: ** [sqlite3_file] object (or, more commonly, a subclass of the skamonkey@3594: ** [sqlite3_file] object) with a pointer to an instance of this object. skamonkey@3594: ** This object defines the methods used to perform various operations skamonkey@3594: ** against the open file represented by the [sqlite3_file] object. skamonkey@3594: ** skamonkey@3594: ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element skamonkey@3594: ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method skamonkey@3594: ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The skamonkey@3594: ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] skamonkey@3594: ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element skamonkey@3594: ** to NULL. ds@1952: ** ds@1952: ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or ds@1952: ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). skamonkey@3594: ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] skamonkey@3594: ** flag may be ORed in to indicate that only the data of the file skamonkey@3594: ** and not its inode needs to be synced. skamonkey@3594: ** ds@1952: ** The integer values to xLock() and xUnlock() are one of ds@1952: ** skamonkey@3594: ** xLock() increases the lock. xUnlock() decreases the lock. skamonkey@3594: ** The xCheckReservedLock() method checks whether any database connection, skamonkey@3594: ** either in this process or in some other process, is holding a RESERVED, ds@1952: ** PENDING, or EXCLUSIVE lock on the file. It returns true skamonkey@3594: ** if such a lock exists and false otherwise. skamonkey@3594: ** ds@1952: ** The xFileControl() method is a generic interface that allows custom ds@1952: ** VFS implementations to directly control an open file using the skamonkey@3594: ** [sqlite3_file_control()] interface. The second "op" argument is an skamonkey@3594: ** integer opcode. The third argument is a generic pointer intended to skamonkey@3594: ** point to a structure that may contain arguments or space in which to ds@1952: ** write return values. Potential uses for xFileControl() might be ds@1952: ** functions to enable blocking locks with timeouts, to change the ds@1952: ** locking strategy (for example to use dot-file locks), to inquire ds@1952: ** about the status of a lock, or to break stale locks. The SQLite skamonkey@3594: ** core reserves all opcodes less than 100 for its own use. ds@1952: ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. skamonkey@3594: ** Applications that define a custom xFileControl method should use opcodes skamonkey@3594: ** greater than 100 to avoid conflicts. VFS implementations should skamonkey@3594: ** return [SQLITE_NOTFOUND] for file control opcodes that they do not skamonkey@3594: ** recognize. ds@1952: ** ds@1952: ** The xSectorSize() method returns the sector size of the ds@1952: ** device that underlies the file. The sector size is the ds@1952: ** minimum write that can be performed without disturbing ds@1952: ** other bytes in the file. The xDeviceCharacteristics() ds@1952: ** method returns a bit vector describing behaviors of the ds@1952: ** underlying device: ds@1952: ** ds@1952: ** ds@1952: ** ds@1952: ** The SQLITE_IOCAP_ATOMIC property means that all writes of ds@1952: ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values ds@1952: ** mean that writes of blocks that are nnn bytes in size and ds@1952: ** are aligned to an address which is an integer multiple of ds@1952: ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means ds@1952: ** that when data is appended to a file, the data is appended ds@1952: ** first then the size of the file is extended, never the other ds@1952: ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that ds@1952: ** information is written to disk in the same order as calls ds@1952: ** to xWrite(). skamonkey@3594: ** skamonkey@3594: ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill skamonkey@3594: ** in the unread portions of the buffer with zeros. A VFS that skamonkey@3594: ** fails to zero-fill short reads might seem to work. However, skamonkey@3594: ** failure to zero-fill short reads will eventually lead to skamonkey@3594: ** database corruption. ds@1952: */ ds@1952: typedef struct sqlite3_io_methods sqlite3_io_methods; ds@1952: struct sqlite3_io_methods { ds@1952: int iVersion; ds@1952: int (*xClose)(sqlite3_file*); ds@1952: int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); ds@1952: int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); ds@1952: int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); ds@1952: int (*xSync)(sqlite3_file*, int flags); ds@1952: int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); ds@1952: int (*xLock)(sqlite3_file*, int); ds@1952: int (*xUnlock)(sqlite3_file*, int); skamonkey@3594: int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); ds@1952: int (*xFileControl)(sqlite3_file*, int op, void *pArg); ds@1952: int (*xSectorSize)(sqlite3_file*); ds@1952: int (*xDeviceCharacteristics)(sqlite3_file*); skamonkey@3594: /* Methods above are valid for version 1 */ skamonkey@3594: int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); skamonkey@3594: int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); skamonkey@3594: void (*xShmBarrier)(sqlite3_file*); skamonkey@3594: int (*xShmUnmap)(sqlite3_file*, int deleteFlag); skamonkey@3594: /* Methods above are valid for version 2 */ ds@1952: /* Additional methods may be added in future releases */ ds@1952: }; ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Standard File Control Opcodes ds@1952: ** ds@1952: ** These integer constants are opcodes for the xFileControl method skamonkey@3594: ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] ds@1952: ** interface. ds@1952: ** ds@1952: ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This skamonkey@3594: ** opcode causes the xFileControl method to write the current state of ds@1952: ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], ds@1952: ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) skamonkey@3594: ** into an integer that the pArg argument points to. This capability ds@1952: ** is used during testing and only needs to be supported when SQLITE_TEST ds@1952: ** is defined. skamonkey@3594: ** skamonkey@3594: */ skamonkey@3594: #define SQLITE_FCNTL_LOCKSTATE 1 skamonkey@3594: #define SQLITE_GET_LOCKPROXYFILE 2 skamonkey@3594: #define SQLITE_SET_LOCKPROXYFILE 3 skamonkey@3594: #define SQLITE_LAST_ERRNO 4 skamonkey@3594: #define SQLITE_FCNTL_SIZE_HINT 5 skamonkey@3594: #define SQLITE_FCNTL_CHUNK_SIZE 6 skamonkey@3594: #define SQLITE_FCNTL_FILE_POINTER 7 skamonkey@3594: #define SQLITE_FCNTL_SYNC_OMITTED 8 skamonkey@3594: #define SQLITE_FCNTL_WIN32_AV_RETRY 9 skamonkey@3594: #define SQLITE_FCNTL_PERSIST_WAL 10 skamonkey@3594: #define SQLITE_FCNTL_OVERWRITE 11 skamonkey@3594: #define SQLITE_FCNTL_VFSNAME 12 skamonkey@3594: #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 skamonkey@3594: #define SQLITE_FCNTL_PRAGMA 14 ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Mutex Handle ds@1952: ** ds@1952: ** The mutex module within SQLite defines [sqlite3_mutex] to be an ds@1952: ** abstract type for a mutex object. The SQLite core never looks ds@1952: ** at the internal representation of an [sqlite3_mutex]. It only ds@1952: ** deals with pointers to the [sqlite3_mutex] object. ds@1952: ** ds@1952: ** Mutexes are created using [sqlite3_mutex_alloc()]. ds@1952: */ ds@1952: typedef struct sqlite3_mutex sqlite3_mutex; ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: OS Interface Object ds@1952: ** skamonkey@3594: ** An instance of the sqlite3_vfs object defines the interface between skamonkey@3594: ** the SQLite core and the underlying operating system. The "vfs" skamonkey@3594: ** in the name of the object stands for "virtual file system". See skamonkey@3594: ** the [VFS | VFS documentation] for further information. skamonkey@3594: ** skamonkey@3594: ** The value of the iVersion field is initially 1 but may be larger in skamonkey@3594: ** future versions of SQLite. Additional fields may be appended to this skamonkey@3594: ** object when the iVersion value is increased. Note that the structure skamonkey@3594: ** of the sqlite3_vfs object changes in the transaction between skamonkey@3594: ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not skamonkey@3594: ** modified. ds@1952: ** ds@1952: ** The szOsFile field is the size of the subclassed [sqlite3_file] ds@1952: ** structure used by this VFS. mxPathname is the maximum length of ds@1952: ** a pathname in this VFS. ds@1952: ** skamonkey@3594: ** Registered sqlite3_vfs objects are kept on a linked list formed by ds@1952: ** the pNext pointer. The [sqlite3_vfs_register()] ds@1952: ** and [sqlite3_vfs_unregister()] interfaces manage this list ds@1952: ** in a thread-safe way. The [sqlite3_vfs_find()] interface skamonkey@3594: ** searches the list. Neither the application code nor the VFS skamonkey@3594: ** implementation should use the pNext pointer. skamonkey@3594: ** skamonkey@3594: ** The pNext field is the only field in the sqlite3_vfs ds@1952: ** structure that SQLite will ever modify. SQLite will only access ds@1952: ** or modify this field while holding a particular static mutex. ds@1952: ** The application should never modify anything within the sqlite3_vfs ds@1952: ** object once the object has been registered. ds@1952: ** ds@1952: ** The zName field holds the name of the VFS module. The name must ds@1952: ** be unique across all VFS modules. ds@1952: ** skamonkey@3594: ** [[sqlite3_vfs.xOpen]] skamonkey@3594: ** ^SQLite guarantees that the zFilename parameter to xOpen skamonkey@3594: ** is either a NULL pointer or string obtained skamonkey@3594: ** from xFullPathname() with an optional suffix added. skamonkey@3594: ** ^If a suffix is added to the zFilename parameter, it will skamonkey@3594: ** consist of a single "-" character followed by no more than skamonkey@3594: ** 11 alphanumeric and/or "-" characters. skamonkey@3594: ** ^SQLite further guarantees that skamonkey@3594: ** the string will be valid and unchanged until xClose() is skamonkey@3594: ** called. Because of the previous sentence, skamonkey@3594: ** the [sqlite3_file] can safely store a pointer to the ds@1952: ** filename if it needs to remember the filename for some reason. skamonkey@3594: ** If the zFilename parameter to xOpen is a NULL pointer then xOpen skamonkey@3594: ** must invent its own temporary name for the file. ^Whenever the skamonkey@3594: ** xFilename parameter is NULL it will also be the case that the skamonkey@3594: ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. skamonkey@3594: ** skamonkey@3594: ** The flags argument to xOpen() includes all bits set in skamonkey@3594: ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] skamonkey@3594: ** or [sqlite3_open16()] is used, then flags includes at least skamonkey@3594: ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. ds@1952: ** If xOpen() opens a file read-only then it sets *pOutFlags to skamonkey@3594: ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. skamonkey@3594: ** skamonkey@3594: ** ^(SQLite will also add one of the following flags to the xOpen() ds@1952: ** call, depending on the object being opened: skamonkey@3594: ** ds@1952: ** )^ ds@1952: ** ds@1952: ** The file I/O implementation can use the object type flags to skamonkey@3594: ** change the way it deals with files. For example, an application skamonkey@3594: ** that does not care about crash recovery or rollback might make skamonkey@3594: ** the open of a journal file a no-op. Writes to this journal would skamonkey@3594: ** also be no-ops, and any attempt to read the journal would return skamonkey@3594: ** SQLITE_IOERR. Or the implementation might recognize that a database skamonkey@3594: ** file will be doing page-aligned sector reads and writes in a random skamonkey@3594: ** order and set up its I/O subsystem accordingly. skamonkey@3594: ** skamonkey@3594: ** SQLite might also add one of the following flags to the xOpen method: skamonkey@3594: ** ds@1952: ** skamonkey@3594: ** ds@1952: ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be skamonkey@3594: ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] skamonkey@3594: ** will be set for TEMP databases and their journals, transient skamonkey@3594: ** databases, and subjournals. skamonkey@3594: ** skamonkey@3594: ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction skamonkey@3594: ** with the [SQLITE_OPEN_CREATE] flag, which are both directly skamonkey@3594: ** analogous to the O_EXCL and O_CREAT flags of the POSIX open() skamonkey@3594: ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the skamonkey@3594: ** SQLITE_OPEN_CREATE, is used to indicate that file should always skamonkey@3594: ** be created, and that it is an error if it already exists. skamonkey@3594: ** It is not used to indicate the file should be opened skamonkey@3594: ** for exclusive access. skamonkey@3594: ** skamonkey@3594: ** ^At least szOsFile bytes of memory are allocated by SQLite skamonkey@3594: ** to hold the [sqlite3_file] structure passed as the third skamonkey@3594: ** argument to xOpen. The xOpen method does not have to skamonkey@3594: ** allocate the structure; it should just fill it in. Note that skamonkey@3594: ** the xOpen method must set the sqlite3_file.pMethods to either skamonkey@3594: ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do skamonkey@3594: ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods skamonkey@3594: ** element will be valid after xOpen returns regardless of the success skamonkey@3594: ** or failure of the xOpen call. skamonkey@3594: ** skamonkey@3594: ** [[sqlite3_vfs.xAccess]] skamonkey@3594: ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] skamonkey@3594: ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to skamonkey@3594: ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] skamonkey@3594: ** to test whether a file is at least readable. The file can be a ds@1952: ** directory. skamonkey@3594: ** skamonkey@3594: ** ^SQLite will always allocate at least mxPathname+1 bytes for the skamonkey@3594: ** output buffer xFullPathname. The exact size of the output buffer skamonkey@3594: ** is also passed as a parameter to both methods. If the output buffer skamonkey@3594: ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is skamonkey@3594: ** handled as a fatal error by SQLite, vfs implementations should endeavor skamonkey@3594: ** to prevent this by setting mxPathname to a sufficiently large value. skamonkey@3594: ** skamonkey@3594: ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() skamonkey@3594: ** interfaces are not strictly a part of the filesystem, but they are ds@1952: ** included in the VFS structure for completeness. ds@1952: ** The xRandomness() function attempts to return nBytes bytes ds@1952: ** of good-quality randomness into zOut. The return value is skamonkey@3594: ** the actual number of bytes of randomness obtained. skamonkey@3594: ** The xSleep() method causes the calling thread to sleep for at skamonkey@3594: ** least the number of microseconds given. ^The xCurrentTime() skamonkey@3594: ** method returns a Julian Day Number for the current date and time as skamonkey@3594: ** a floating point value. skamonkey@3594: ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian skamonkey@3594: ** Day Number multiplied by 86400000 (the number of milliseconds in skamonkey@3594: ** a 24-hour day). skamonkey@3594: ** ^SQLite will use the xCurrentTimeInt64() method to get the current skamonkey@3594: ** date and time if that method is available (if iVersion is 2 or skamonkey@3594: ** greater and the function pointer is not NULL) and will fall back skamonkey@3594: ** to xCurrentTime() if xCurrentTimeInt64() is unavailable. skamonkey@3594: ** skamonkey@3594: ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces skamonkey@3594: ** are not used by the SQLite core. These optional interfaces are provided skamonkey@3594: ** by some VFSes to facilitate testing of the VFS code. By overriding skamonkey@3594: ** system calls with functions under its control, a test program can skamonkey@3594: ** simulate faults and error conditions that would otherwise be difficult skamonkey@3594: ** or impossible to induce. The set of system calls that can be overridden skamonkey@3594: ** varies from one VFS to another, and from one version of the same VFS to the skamonkey@3594: ** next. Applications that use these interfaces must be prepared for any skamonkey@3594: ** or all of these interfaces to be NULL or for their behavior to change skamonkey@3594: ** from one release to the next. Applications must not attempt to access skamonkey@3594: ** any of these methods if the iVersion of the VFS is less than 3. ds@1952: */ ds@1952: typedef struct sqlite3_vfs sqlite3_vfs; skamonkey@3594: typedef void (*sqlite3_syscall_ptr)(void); ds@1952: struct sqlite3_vfs { skamonkey@3594: int iVersion; /* Structure version number (currently 3) */ ds@1952: int szOsFile; /* Size of subclassed sqlite3_file */ ds@1952: int mxPathname; /* Maximum file pathname length */ ds@1952: sqlite3_vfs *pNext; /* Next registered VFS */ ds@1952: const char *zName; /* Name of this virtual file system */ ds@1952: void *pAppData; /* Pointer to application-specific data */ ds@1952: int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, ds@1952: int flags, int *pOutFlags); ds@1952: int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); skamonkey@3594: int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); ds@1952: int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); ds@1952: void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); ds@1952: void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); skamonkey@3594: void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); ds@1952: void (*xDlClose)(sqlite3_vfs*, void*); ds@1952: int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); ds@1952: int (*xSleep)(sqlite3_vfs*, int microseconds); ds@1952: int (*xCurrentTime)(sqlite3_vfs*, double*); skamonkey@3594: int (*xGetLastError)(sqlite3_vfs*, int, char *); skamonkey@3594: /* skamonkey@3594: ** The methods above are in version 1 of the sqlite_vfs object skamonkey@3594: ** definition. Those that follow are added in version 2 or later skamonkey@3594: */ skamonkey@3594: int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); skamonkey@3594: /* skamonkey@3594: ** The methods above are in versions 1 and 2 of the sqlite_vfs object. skamonkey@3594: ** Those below are for version 3 and greater. skamonkey@3594: */ skamonkey@3594: int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); skamonkey@3594: sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); skamonkey@3594: const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); skamonkey@3594: /* skamonkey@3594: ** The methods above are in versions 1 through 3 of the sqlite_vfs object. skamonkey@3594: ** New fields may be appended in figure versions. The iVersion skamonkey@3594: ** value will increment whenever this happens. skamonkey@3594: */ ds@1952: }; ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Flags for the xAccess VFS method ds@1952: ** ds@1952: ** These integer constants can be used as the third parameter to ds@1952: ** the xAccess method of an [sqlite3_vfs] object. They determine skamonkey@3594: ** what kind of permissions the xAccess method is looking for. skamonkey@3594: ** With SQLITE_ACCESS_EXISTS, the xAccess method skamonkey@3594: ** simply checks whether the file exists. skamonkey@3594: ** With SQLITE_ACCESS_READWRITE, the xAccess method skamonkey@3594: ** checks whether the named directory is both readable and writable skamonkey@3594: ** (in other words, if files can be added, removed, and renamed within skamonkey@3594: ** the directory). skamonkey@3594: ** The SQLITE_ACCESS_READWRITE constant is currently used only by the skamonkey@3594: ** [temp_store_directory pragma], though this could change in a future skamonkey@3594: ** release of SQLite. skamonkey@3594: ** With SQLITE_ACCESS_READ, the xAccess method skamonkey@3594: ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is skamonkey@3594: ** currently unused, though it might be used in a future release of skamonkey@3594: ** SQLite. ds@1952: */ ds@1952: #define SQLITE_ACCESS_EXISTS 0 skamonkey@3594: #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ skamonkey@3594: #define SQLITE_ACCESS_READ 2 /* Unused */ skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Flags for the xShmLock VFS method skamonkey@3594: ** skamonkey@3594: ** These integer constants define the various locking operations skamonkey@3594: ** allowed by the xShmLock method of [sqlite3_io_methods]. The skamonkey@3594: ** following are the only legal combinations of flags to the skamonkey@3594: ** xShmLock method: skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as skamonkey@3594: ** was given no the corresponding lock. skamonkey@3594: ** skamonkey@3594: ** The xShmLock method can transition between unlocked and SHARED or skamonkey@3594: ** between unlocked and EXCLUSIVE. It cannot transition between SHARED skamonkey@3594: ** and EXCLUSIVE. skamonkey@3594: */ skamonkey@3594: #define SQLITE_SHM_UNLOCK 1 skamonkey@3594: #define SQLITE_SHM_LOCK 2 skamonkey@3594: #define SQLITE_SHM_SHARED 4 skamonkey@3594: #define SQLITE_SHM_EXCLUSIVE 8 skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Maximum xShmLock index skamonkey@3594: ** skamonkey@3594: ** The xShmLock method on [sqlite3_io_methods] may use values skamonkey@3594: ** between 0 and this upper bound as its "offset" argument. skamonkey@3594: ** The SQLite core will never attempt to acquire or release a skamonkey@3594: ** lock outside of this range skamonkey@3594: */ skamonkey@3594: #define SQLITE_SHM_NLOCK 8 skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Initialize The SQLite Library skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_initialize() routine initializes the skamonkey@3594: ** SQLite library. ^The sqlite3_shutdown() routine skamonkey@3594: ** deallocates any resources that were allocated by sqlite3_initialize(). skamonkey@3594: ** These routines are designed to aid in process initialization and skamonkey@3594: ** shutdown on embedded systems. Workstation applications using skamonkey@3594: ** SQLite normally do not need to invoke either of these routines. skamonkey@3594: ** skamonkey@3594: ** A call to sqlite3_initialize() is an "effective" call if it is skamonkey@3594: ** the first time sqlite3_initialize() is invoked during the lifetime of skamonkey@3594: ** the process, or if it is the first time sqlite3_initialize() is invoked skamonkey@3594: ** following a call to sqlite3_shutdown(). ^(Only an effective call skamonkey@3594: ** of sqlite3_initialize() does any initialization. All other calls skamonkey@3594: ** are harmless no-ops.)^ skamonkey@3594: ** skamonkey@3594: ** A call to sqlite3_shutdown() is an "effective" call if it is the first skamonkey@3594: ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only skamonkey@3594: ** an effective call to sqlite3_shutdown() does any deinitialization. skamonkey@3594: ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ skamonkey@3594: ** skamonkey@3594: ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() skamonkey@3594: ** is not. The sqlite3_shutdown() interface must only be called from a skamonkey@3594: ** single thread. All open [database connections] must be closed and all skamonkey@3594: ** other SQLite resources must be deallocated prior to invoking skamonkey@3594: ** sqlite3_shutdown(). skamonkey@3594: ** skamonkey@3594: ** Among other things, ^sqlite3_initialize() will invoke skamonkey@3594: ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() skamonkey@3594: ** will invoke sqlite3_os_end(). skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. skamonkey@3594: ** ^If for some reason, sqlite3_initialize() is unable to initialize skamonkey@3594: ** the library (perhaps it is unable to allocate a needed resource such skamonkey@3594: ** as a mutex) it returns an [error code] other than [SQLITE_OK]. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_initialize() routine is called internally by many other skamonkey@3594: ** SQLite interfaces so that an application usually does not need to skamonkey@3594: ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] skamonkey@3594: ** calls sqlite3_initialize() so the SQLite library will be automatically skamonkey@3594: ** initialized when [sqlite3_open()] is called if it has not be initialized skamonkey@3594: ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] skamonkey@3594: ** compile-time option, then the automatic calls to sqlite3_initialize() skamonkey@3594: ** are omitted and the application must call sqlite3_initialize() directly skamonkey@3594: ** prior to using any other SQLite interface. For maximum portability, skamonkey@3594: ** it is recommended that applications always invoke sqlite3_initialize() skamonkey@3594: ** directly prior to using any other SQLite interface. Future releases skamonkey@3594: ** of SQLite may require this. In other words, the behavior exhibited skamonkey@3594: ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the skamonkey@3594: ** default behavior in some future release of SQLite. skamonkey@3594: ** skamonkey@3594: ** The sqlite3_os_init() routine does operating-system specific skamonkey@3594: ** initialization of the SQLite library. The sqlite3_os_end() skamonkey@3594: ** routine undoes the effect of sqlite3_os_init(). Typical tasks skamonkey@3594: ** performed by these routines include allocation or deallocation skamonkey@3594: ** of static resources, initialization of global variables, skamonkey@3594: ** setting up a default [sqlite3_vfs] module, or setting up skamonkey@3594: ** a default configuration using [sqlite3_config()]. skamonkey@3594: ** skamonkey@3594: ** The application should never invoke either sqlite3_os_init() skamonkey@3594: ** or sqlite3_os_end() directly. The application should only invoke skamonkey@3594: ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() skamonkey@3594: ** interface is called automatically by sqlite3_initialize() and skamonkey@3594: ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate skamonkey@3594: ** implementations for sqlite3_os_init() and sqlite3_os_end() skamonkey@3594: ** are built into SQLite when it is compiled for Unix, Windows, or OS/2. skamonkey@3594: ** When [custom builds | built for other platforms] skamonkey@3594: ** (using the [SQLITE_OS_OTHER=1] compile-time skamonkey@3594: ** option) the application must supply a suitable implementation for skamonkey@3594: ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied skamonkey@3594: ** implementation of sqlite3_os_init() or sqlite3_os_end() skamonkey@3594: ** must return [SQLITE_OK] on success and some other [error code] upon skamonkey@3594: ** failure. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_initialize(void); skamonkey@3594: SQLITE_API int sqlite3_shutdown(void); skamonkey@3594: SQLITE_API int sqlite3_os_init(void); skamonkey@3594: SQLITE_API int sqlite3_os_end(void); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Configuring The SQLite Library skamonkey@3594: ** skamonkey@3594: ** The sqlite3_config() interface is used to make global configuration skamonkey@3594: ** changes to SQLite in order to tune SQLite to the specific needs of skamonkey@3594: ** the application. The default configuration is recommended for most skamonkey@3594: ** applications and so this routine is usually not necessary. It is skamonkey@3594: ** provided to support rare applications with unusual needs. skamonkey@3594: ** skamonkey@3594: ** The sqlite3_config() interface is not threadsafe. The application skamonkey@3594: ** must insure that no other SQLite interfaces are invoked by other skamonkey@3594: ** threads while sqlite3_config() is running. Furthermore, sqlite3_config() skamonkey@3594: ** may only be invoked prior to library initialization using skamonkey@3594: ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. skamonkey@3594: ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before skamonkey@3594: ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. skamonkey@3594: ** Note, however, that ^sqlite3_config() can be called as part of the skamonkey@3594: ** implementation of an application-defined [sqlite3_os_init()]. skamonkey@3594: ** skamonkey@3594: ** The first argument to sqlite3_config() is an integer skamonkey@3594: ** [configuration option] that determines skamonkey@3594: ** what property of SQLite is to be configured. Subsequent arguments skamonkey@3594: ** vary depending on the [configuration option] skamonkey@3594: ** in the first argument. skamonkey@3594: ** skamonkey@3594: ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. skamonkey@3594: ** ^If the option is unknown or SQLite is unable to set the option skamonkey@3594: ** then this routine returns a non-zero [error code]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_config(int, ...); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Configure database connections skamonkey@3594: ** skamonkey@3594: ** The sqlite3_db_config() interface is used to make configuration skamonkey@3594: ** changes to a [database connection]. The interface is similar to skamonkey@3594: ** [sqlite3_config()] except that the changes apply to a single skamonkey@3594: ** [database connection] (specified in the first argument). skamonkey@3594: ** skamonkey@3594: ** The second argument to sqlite3_db_config(D,V,...) is the skamonkey@3594: ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code skamonkey@3594: ** that indicates what aspect of the [database connection] is being configured. skamonkey@3594: ** Subsequent arguments vary depending on the configuration verb. skamonkey@3594: ** skamonkey@3594: ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if skamonkey@3594: ** the call is considered successful. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Memory Allocation Routines skamonkey@3594: ** skamonkey@3594: ** An instance of this object defines the interface between SQLite skamonkey@3594: ** and low-level memory allocation routines. skamonkey@3594: ** skamonkey@3594: ** This object is used in only one place in the SQLite interface. skamonkey@3594: ** A pointer to an instance of this object is the argument to skamonkey@3594: ** [sqlite3_config()] when the configuration option is skamonkey@3594: ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. skamonkey@3594: ** By creating an instance of this object skamonkey@3594: ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) skamonkey@3594: ** during configuration, an application can specify an alternative skamonkey@3594: ** memory allocation subsystem for SQLite to use for all of its skamonkey@3594: ** dynamic memory needs. skamonkey@3594: ** skamonkey@3594: ** Note that SQLite comes with several [built-in memory allocators] skamonkey@3594: ** that are perfectly adequate for the overwhelming majority of applications skamonkey@3594: ** and that this object is only useful to a tiny minority of applications skamonkey@3594: ** with specialized memory allocation requirements. This object is skamonkey@3594: ** also used during testing of SQLite in order to specify an alternative skamonkey@3594: ** memory allocator that simulates memory out-of-memory conditions in skamonkey@3594: ** order to verify that SQLite recovers gracefully from such skamonkey@3594: ** conditions. skamonkey@3594: ** skamonkey@3594: ** The xMalloc, xRealloc, and xFree methods must work like the skamonkey@3594: ** malloc(), realloc() and free() functions from the standard C library. skamonkey@3594: ** ^SQLite guarantees that the second argument to skamonkey@3594: ** xRealloc is always a value returned by a prior call to xRoundup. skamonkey@3594: ** skamonkey@3594: ** xSize should return the allocated size of a memory allocation skamonkey@3594: ** previously obtained from xMalloc or xRealloc. The allocated size skamonkey@3594: ** is always at least as big as the requested size but may be larger. skamonkey@3594: ** skamonkey@3594: ** The xRoundup method returns what would be the allocated size of skamonkey@3594: ** a memory allocation given a particular requested size. Most memory skamonkey@3594: ** allocators round up memory allocations at least to the next multiple skamonkey@3594: ** of 8. Some allocators round up to a larger multiple or to a power of 2. skamonkey@3594: ** Every memory allocation request coming in through [sqlite3_malloc()] skamonkey@3594: ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, skamonkey@3594: ** that causes the corresponding memory allocation to fail. skamonkey@3594: ** skamonkey@3594: ** The xInit method initializes the memory allocator. (For example, skamonkey@3594: ** it might allocate any require mutexes or initialize internal data skamonkey@3594: ** structures. The xShutdown method is invoked (indirectly) by skamonkey@3594: ** [sqlite3_shutdown()] and should deallocate any resources acquired skamonkey@3594: ** by xInit. The pAppData pointer is used as the only parameter to skamonkey@3594: ** xInit and xShutdown. skamonkey@3594: ** skamonkey@3594: ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes skamonkey@3594: ** the xInit method, so the xInit method need not be threadsafe. The skamonkey@3594: ** xShutdown method is only called from [sqlite3_shutdown()] so it does skamonkey@3594: ** not need to be threadsafe either. For all other methods, SQLite skamonkey@3594: ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the skamonkey@3594: ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which skamonkey@3594: ** it is by default) and so the methods are automatically serialized. skamonkey@3594: ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other skamonkey@3594: ** methods must be threadsafe or else make their own arrangements for skamonkey@3594: ** serialization. skamonkey@3594: ** skamonkey@3594: ** SQLite will never invoke xInit() more than once without an intervening skamonkey@3594: ** call to xShutdown(). skamonkey@3594: */ skamonkey@3594: typedef struct sqlite3_mem_methods sqlite3_mem_methods; skamonkey@3594: struct sqlite3_mem_methods { skamonkey@3594: void *(*xMalloc)(int); /* Memory allocation function */ skamonkey@3594: void (*xFree)(void*); /* Free a prior allocation */ skamonkey@3594: void *(*xRealloc)(void*,int); /* Resize an allocation */ skamonkey@3594: int (*xSize)(void*); /* Return the size of an allocation */ skamonkey@3594: int (*xRoundup)(int); /* Round up request size to allocation size */ skamonkey@3594: int (*xInit)(void*); /* Initialize the memory allocator */ skamonkey@3594: void (*xShutdown)(void*); /* Deinitialize the memory allocator */ skamonkey@3594: void *pAppData; /* Argument to xInit() and xShutdown() */ skamonkey@3594: }; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Configuration Options skamonkey@3594: ** KEYWORDS: {configuration option} skamonkey@3594: ** skamonkey@3594: ** These constants are the available integer configuration options that skamonkey@3594: ** can be passed as the first argument to the [sqlite3_config()] interface. skamonkey@3594: ** skamonkey@3594: ** New configuration options may be added in future releases of SQLite. skamonkey@3594: ** Existing configuration options might be discontinued. Applications skamonkey@3594: ** should check the return code from [sqlite3_config()] to make sure that skamonkey@3594: ** the call worked. The [sqlite3_config()] interface will return a skamonkey@3594: ** non-zero [error code] if a discontinued or unsupported configuration option skamonkey@3594: ** is invoked. skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: ** [[SQLITE_CONFIG_SINGLETHREAD]]
SQLITE_CONFIG_SINGLETHREAD
skamonkey@3594: **
There are no arguments to this option. ^This option sets the skamonkey@3594: ** [threading mode] to Single-thread. In other words, it disables skamonkey@3594: ** all mutexing and puts SQLite into a mode where it can only be used skamonkey@3594: ** by a single thread. ^If SQLite is compiled with skamonkey@3594: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then skamonkey@3594: ** it is not possible to change the [threading mode] from its default skamonkey@3594: ** value of Single-thread and so [sqlite3_config()] will return skamonkey@3594: ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD skamonkey@3594: ** configuration option.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_MULTITHREAD]]
SQLITE_CONFIG_MULTITHREAD
skamonkey@3594: **
There are no arguments to this option. ^This option sets the skamonkey@3594: ** [threading mode] to Multi-thread. In other words, it disables skamonkey@3594: ** mutexing on [database connection] and [prepared statement] objects. skamonkey@3594: ** The application is responsible for serializing access to skamonkey@3594: ** [database connections] and [prepared statements]. But other mutexes skamonkey@3594: ** are enabled so that SQLite will be safe to use in a multi-threaded skamonkey@3594: ** environment as long as no two threads attempt to use the same skamonkey@3594: ** [database connection] at the same time. ^If SQLite is compiled with skamonkey@3594: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then skamonkey@3594: ** it is not possible to set the Multi-thread [threading mode] and skamonkey@3594: ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the skamonkey@3594: ** SQLITE_CONFIG_MULTITHREAD configuration option.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_SERIALIZED]]
SQLITE_CONFIG_SERIALIZED
skamonkey@3594: **
There are no arguments to this option. ^This option sets the skamonkey@3594: ** [threading mode] to Serialized. In other words, this option enables skamonkey@3594: ** all mutexes including the recursive skamonkey@3594: ** mutexes on [database connection] and [prepared statement] objects. skamonkey@3594: ** In this mode (which is the default when SQLite is compiled with skamonkey@3594: ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access skamonkey@3594: ** to [database connections] and [prepared statements] so that the skamonkey@3594: ** application is free to use the same [database connection] or the skamonkey@3594: ** same [prepared statement] in different threads at the same time. skamonkey@3594: ** ^If SQLite is compiled with skamonkey@3594: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then skamonkey@3594: ** it is not possible to set the Serialized [threading mode] and skamonkey@3594: ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the skamonkey@3594: ** SQLITE_CONFIG_SERIALIZED configuration option.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_MALLOC]]
SQLITE_CONFIG_MALLOC
skamonkey@3594: **
^(This option takes a single argument which is a pointer to an skamonkey@3594: ** instance of the [sqlite3_mem_methods] structure. The argument specifies skamonkey@3594: ** alternative low-level memory allocation routines to be used in place of skamonkey@3594: ** the memory allocation routines built into SQLite.)^ ^SQLite makes skamonkey@3594: ** its own private copy of the content of the [sqlite3_mem_methods] structure skamonkey@3594: ** before the [sqlite3_config()] call returns.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_GETMALLOC]]
SQLITE_CONFIG_GETMALLOC
skamonkey@3594: **
^(This option takes a single argument which is a pointer to an skamonkey@3594: ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] skamonkey@3594: ** structure is filled with the currently defined memory allocation routines.)^ skamonkey@3594: ** This option can be used to overload the default memory allocation skamonkey@3594: ** routines with a wrapper that simulations memory allocation failure or skamonkey@3594: ** tracks memory usage, for example.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_MEMSTATUS]]
SQLITE_CONFIG_MEMSTATUS
skamonkey@3594: **
^This option takes single argument of type int, interpreted as a skamonkey@3594: ** boolean, which enables or disables the collection of memory allocation skamonkey@3594: ** statistics. ^(When memory allocation statistics are disabled, the skamonkey@3594: ** following SQLite interfaces become non-operational: skamonkey@3594: **
    skamonkey@3594: **
  • [sqlite3_memory_used()] skamonkey@3594: **
  • [sqlite3_memory_highwater()] skamonkey@3594: **
  • [sqlite3_soft_heap_limit64()] skamonkey@3594: **
  • [sqlite3_status()] skamonkey@3594: **
)^ skamonkey@3594: ** ^Memory allocation statistics are enabled by default unless SQLite is skamonkey@3594: ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory skamonkey@3594: ** allocation statistics are disabled by default. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_SCRATCH]]
SQLITE_CONFIG_SCRATCH
skamonkey@3594: **
^This option specifies a static memory buffer that SQLite can use for skamonkey@3594: ** scratch memory. There are three arguments: A pointer an 8-byte skamonkey@3594: ** aligned memory buffer from which the scratch allocations will be skamonkey@3594: ** drawn, the size of each scratch allocation (sz), skamonkey@3594: ** and the maximum number of scratch allocations (N). The sz skamonkey@3594: ** argument must be a multiple of 16. skamonkey@3594: ** The first argument must be a pointer to an 8-byte aligned buffer skamonkey@3594: ** of at least sz*N bytes of memory. skamonkey@3594: ** ^SQLite will use no more than two scratch buffers per thread. So skamonkey@3594: ** N should be set to twice the expected maximum number of threads. skamonkey@3594: ** ^SQLite will never require a scratch buffer that is more than 6 skamonkey@3594: ** times the database page size. ^If SQLite needs needs additional skamonkey@3594: ** scratch memory beyond what is provided by this configuration option, then skamonkey@3594: ** [sqlite3_malloc()] will be used to obtain the memory needed.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_PAGECACHE]]
SQLITE_CONFIG_PAGECACHE
skamonkey@3594: **
^This option specifies a static memory buffer that SQLite can use for skamonkey@3594: ** the database page cache with the default page cache implementation. skamonkey@3594: ** This configuration should not be used if an application-define page skamonkey@3594: ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option. skamonkey@3594: ** There are three arguments to this option: A pointer to 8-byte aligned skamonkey@3594: ** memory, the size of each page buffer (sz), and the number of pages (N). skamonkey@3594: ** The sz argument should be the size of the largest database page skamonkey@3594: ** (a power of two between 512 and 32768) plus a little extra for each skamonkey@3594: ** page header. ^The page header size is 20 to 40 bytes depending on skamonkey@3594: ** the host architecture. ^It is harmless, apart from the wasted memory, skamonkey@3594: ** to make sz a little too large. The first skamonkey@3594: ** argument should point to an allocation of at least sz*N bytes of memory. skamonkey@3594: ** ^SQLite will use the memory provided by the first argument to satisfy its skamonkey@3594: ** memory needs for the first N pages that it adds to cache. ^If additional skamonkey@3594: ** page cache memory is needed beyond what is provided by this option, then skamonkey@3594: ** SQLite goes to [sqlite3_malloc()] for the additional storage space. skamonkey@3594: ** The pointer in the first argument must skamonkey@3594: ** be aligned to an 8-byte boundary or subsequent behavior of SQLite skamonkey@3594: ** will be undefined.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_HEAP]]
SQLITE_CONFIG_HEAP
skamonkey@3594: **
^This option specifies a static memory buffer that SQLite will use skamonkey@3594: ** for all of its dynamic memory allocation needs beyond those provided skamonkey@3594: ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. skamonkey@3594: ** There are three arguments: An 8-byte aligned pointer to the memory, skamonkey@3594: ** the number of bytes in the memory buffer, and the minimum allocation size. skamonkey@3594: ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts skamonkey@3594: ** to using its default memory allocator (the system malloc() implementation), skamonkey@3594: ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the skamonkey@3594: ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or skamonkey@3594: ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory skamonkey@3594: ** allocator is engaged to handle all of SQLites memory allocation needs. skamonkey@3594: ** The first pointer (the memory pointer) must be aligned to an 8-byte skamonkey@3594: ** boundary or subsequent behavior of SQLite will be undefined. skamonkey@3594: ** The minimum allocation size is capped at 2**12. Reasonable values skamonkey@3594: ** for the minimum allocation size are 2**5 through 2**8.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_MUTEX]]
SQLITE_CONFIG_MUTEX
skamonkey@3594: **
^(This option takes a single argument which is a pointer to an skamonkey@3594: ** instance of the [sqlite3_mutex_methods] structure. The argument specifies skamonkey@3594: ** alternative low-level mutex routines to be used in place skamonkey@3594: ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the skamonkey@3594: ** content of the [sqlite3_mutex_methods] structure before the call to skamonkey@3594: ** [sqlite3_config()] returns. ^If SQLite is compiled with skamonkey@3594: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then skamonkey@3594: ** the entire mutexing subsystem is omitted from the build and hence calls to skamonkey@3594: ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will skamonkey@3594: ** return [SQLITE_ERROR].
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_GETMUTEX]]
SQLITE_CONFIG_GETMUTEX
skamonkey@3594: **
^(This option takes a single argument which is a pointer to an skamonkey@3594: ** instance of the [sqlite3_mutex_methods] structure. The skamonkey@3594: ** [sqlite3_mutex_methods] skamonkey@3594: ** structure is filled with the currently defined mutex routines.)^ skamonkey@3594: ** This option can be used to overload the default mutex allocation skamonkey@3594: ** routines with a wrapper used to track mutex usage for performance skamonkey@3594: ** profiling or testing, for example. ^If SQLite is compiled with skamonkey@3594: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then skamonkey@3594: ** the entire mutexing subsystem is omitted from the build and hence calls to skamonkey@3594: ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will skamonkey@3594: ** return [SQLITE_ERROR].
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_LOOKASIDE]]
SQLITE_CONFIG_LOOKASIDE
skamonkey@3594: **
^(This option takes two arguments that determine the default skamonkey@3594: ** memory allocation for the lookaside memory allocator on each skamonkey@3594: ** [database connection]. The first argument is the skamonkey@3594: ** size of each lookaside buffer slot and the second is the number of skamonkey@3594: ** slots allocated to each database connection.)^ ^(This option sets the skamonkey@3594: ** default lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] skamonkey@3594: ** verb to [sqlite3_db_config()] can be used to change the lookaside skamonkey@3594: ** configuration on individual connections.)^
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_PCACHE2]]
SQLITE_CONFIG_PCACHE2
skamonkey@3594: **
^(This option takes a single argument which is a pointer to skamonkey@3594: ** an [sqlite3_pcache_methods2] object. This object specifies the interface skamonkey@3594: ** to a custom page cache implementation.)^ ^SQLite makes a copy of the skamonkey@3594: ** object and uses it for page cache memory allocations.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_GETPCACHE2]]
SQLITE_CONFIG_GETPCACHE2
skamonkey@3594: **
^(This option takes a single argument which is a pointer to an skamonkey@3594: ** [sqlite3_pcache_methods2] object. SQLite copies of the current skamonkey@3594: ** page cache implementation into that object.)^
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_LOG]]
SQLITE_CONFIG_LOG
skamonkey@3594: **
^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a skamonkey@3594: ** function with a call signature of void(*)(void*,int,const char*), skamonkey@3594: ** and a pointer to void. ^If the function pointer is not NULL, it is skamonkey@3594: ** invoked by [sqlite3_log()] to process each logging event. ^If the skamonkey@3594: ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. skamonkey@3594: ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is skamonkey@3594: ** passed through as the first parameter to the application-defined logger skamonkey@3594: ** function whenever that function is invoked. ^The second parameter to skamonkey@3594: ** the logger function is a copy of the first parameter to the corresponding skamonkey@3594: ** [sqlite3_log()] call and is intended to be a [result code] or an skamonkey@3594: ** [extended result code]. ^The third parameter passed to the logger is skamonkey@3594: ** log message after formatting via [sqlite3_snprintf()]. skamonkey@3594: ** The SQLite logging interface is not reentrant; the logger function skamonkey@3594: ** supplied by the application must not invoke any SQLite interface. skamonkey@3594: ** In a multi-threaded application, the application-defined logger skamonkey@3594: ** function must be threadsafe.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_URI]]
SQLITE_CONFIG_URI skamonkey@3594: **
This option takes a single argument of type int. If non-zero, then skamonkey@3594: ** URI handling is globally enabled. If the parameter is zero, then URI handling skamonkey@3594: ** is globally disabled. If URI handling is globally enabled, all filenames skamonkey@3594: ** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or skamonkey@3594: ** specified as part of [ATTACH] commands are interpreted as URIs, regardless skamonkey@3594: ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database skamonkey@3594: ** connection is opened. If it is globally disabled, filenames are skamonkey@3594: ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the skamonkey@3594: ** database connection is opened. By default, URI handling is globally skamonkey@3594: ** disabled. The default value may be changed by compiling with the skamonkey@3594: ** [SQLITE_USE_URI] symbol defined. skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] skamonkey@3594: **
SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE skamonkey@3594: **
These options are obsolete and should not be used by new code. skamonkey@3594: ** They are retained for backwards compatibility but are now no-ops. skamonkey@3594: **
skamonkey@3594: */ skamonkey@3594: #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ skamonkey@3594: #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ skamonkey@3594: #define SQLITE_CONFIG_SERIALIZED 3 /* nil */ skamonkey@3594: #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ skamonkey@3594: #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ skamonkey@3594: #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ skamonkey@3594: #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ skamonkey@3594: #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ skamonkey@3594: #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ skamonkey@3594: #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ skamonkey@3594: #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ skamonkey@3594: /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ skamonkey@3594: #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ skamonkey@3594: #define SQLITE_CONFIG_PCACHE 14 /* no-op */ skamonkey@3594: #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ skamonkey@3594: #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ skamonkey@3594: #define SQLITE_CONFIG_URI 17 /* int */ skamonkey@3594: #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ skamonkey@3594: #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Database Connection Configuration Options skamonkey@3594: ** skamonkey@3594: ** These constants are the available integer configuration options that skamonkey@3594: ** can be passed as the second argument to the [sqlite3_db_config()] interface. skamonkey@3594: ** skamonkey@3594: ** New configuration options may be added in future releases of SQLite. skamonkey@3594: ** Existing configuration options might be discontinued. Applications skamonkey@3594: ** should check the return code from [sqlite3_db_config()] to make sure that skamonkey@3594: ** the call worked. ^The [sqlite3_db_config()] interface will return a skamonkey@3594: ** non-zero [error code] if a discontinued or unsupported configuration option skamonkey@3594: ** is invoked. skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: **
SQLITE_DBCONFIG_LOOKASIDE
skamonkey@3594: **
^This option takes three additional arguments that determine the skamonkey@3594: ** [lookaside memory allocator] configuration for the [database connection]. skamonkey@3594: ** ^The first argument (the third parameter to [sqlite3_db_config()] is a skamonkey@3594: ** pointer to a memory buffer to use for lookaside memory. skamonkey@3594: ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb skamonkey@3594: ** may be NULL in which case SQLite will allocate the skamonkey@3594: ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the skamonkey@3594: ** size of each lookaside buffer slot. ^The third argument is the number of skamonkey@3594: ** slots. The size of the buffer in the first argument must be greater than skamonkey@3594: ** or equal to the product of the second and third arguments. The buffer skamonkey@3594: ** must be aligned to an 8-byte boundary. ^If the second argument to skamonkey@3594: ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally skamonkey@3594: ** rounded down to the next smaller multiple of 8. ^(The lookaside memory skamonkey@3594: ** configuration for a database connection can only be changed when that skamonkey@3594: ** connection is not currently using lookaside memory, or in other words skamonkey@3594: ** when the "current value" returned by skamonkey@3594: ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. skamonkey@3594: ** Any attempt to change the lookaside memory configuration when lookaside skamonkey@3594: ** memory is in use leaves the configuration unchanged and returns skamonkey@3594: ** [SQLITE_BUSY].)^
skamonkey@3594: ** skamonkey@3594: **
SQLITE_DBCONFIG_ENABLE_FKEY
skamonkey@3594: **
^This option is used to enable or disable the enforcement of skamonkey@3594: ** [foreign key constraints]. There should be two additional arguments. skamonkey@3594: ** The first argument is an integer which is 0 to disable FK enforcement, skamonkey@3594: ** positive to enable FK enforcement or negative to leave FK enforcement skamonkey@3594: ** unchanged. The second parameter is a pointer to an integer into which skamonkey@3594: ** is written 0 or 1 to indicate whether FK enforcement is off or on skamonkey@3594: ** following this call. The second parameter may be a NULL pointer, in skamonkey@3594: ** which case the FK enforcement setting is not reported back.
skamonkey@3594: ** skamonkey@3594: **
SQLITE_DBCONFIG_ENABLE_TRIGGER
skamonkey@3594: **
^This option is used to enable or disable [CREATE TRIGGER | triggers]. skamonkey@3594: ** There should be two additional arguments. skamonkey@3594: ** The first argument is an integer which is 0 to disable triggers, skamonkey@3594: ** positive to enable triggers or negative to leave the setting unchanged. skamonkey@3594: ** The second parameter is a pointer to an integer into which skamonkey@3594: ** is written 0 or 1 to indicate whether triggers are disabled or enabled skamonkey@3594: ** following this call. The second parameter may be a NULL pointer, in skamonkey@3594: ** which case the trigger setting is not reported back.
skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: */ skamonkey@3594: #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ skamonkey@3594: #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ skamonkey@3594: #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ skamonkey@3594: ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Enable Or Disable Extended Result Codes ds@1952: ** skamonkey@3594: ** ^The sqlite3_extended_result_codes() routine enables or disables the skamonkey@3594: ** [extended result codes] feature of SQLite. ^The extended result skamonkey@3594: ** codes are disabled by default for historical compatibility. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Last Insert Rowid ds@1952: ** skamonkey@3594: ** ^Each entry in an SQLite table has a unique 64-bit signed skamonkey@3594: ** integer key called the [ROWID | "rowid"]. ^The rowid is always available skamonkey@3594: ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those skamonkey@3594: ** names are not also used by explicitly declared columns. ^If skamonkey@3594: ** the table has a column of type [INTEGER PRIMARY KEY] then that column skamonkey@3594: ** is another alias for the rowid. skamonkey@3594: ** skamonkey@3594: ** ^This routine returns the [rowid] of the most recent skamonkey@3594: ** successful [INSERT] into the database from the [database connection] skamonkey@3594: ** in the first argument. ^As of SQLite version 3.7.7, this routines skamonkey@3594: ** records the last insert rowid of both ordinary tables and [virtual tables]. skamonkey@3594: ** ^If no successful [INSERT]s skamonkey@3594: ** have ever occurred on that database connection, zero is returned. skamonkey@3594: ** skamonkey@3594: ** ^(If an [INSERT] occurs within a trigger or within a [virtual table] skamonkey@3594: ** method, then this routine will return the [rowid] of the inserted skamonkey@3594: ** row as long as the trigger or virtual table method is running. skamonkey@3594: ** But once the trigger or virtual table method ends, the value returned skamonkey@3594: ** by this routine reverts to what it was before the trigger or virtual skamonkey@3594: ** table method began.)^ skamonkey@3594: ** skamonkey@3594: ** ^An [INSERT] that fails due to a constraint violation is not a skamonkey@3594: ** successful [INSERT] and does not change the value returned by this skamonkey@3594: ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, skamonkey@3594: ** and INSERT OR ABORT make no changes to the return value of this skamonkey@3594: ** routine when their insertion fails. ^(When INSERT OR REPLACE skamonkey@3594: ** encounters a constraint violation, it does not fail. The skamonkey@3594: ** INSERT continues to completion after deleting rows that caused skamonkey@3594: ** the constraint problem so INSERT OR REPLACE will always change skamonkey@3594: ** the return value of this interface.)^ skamonkey@3594: ** skamonkey@3594: ** ^For the purposes of this routine, an [INSERT] is considered to skamonkey@3594: ** be successful even if it is subsequently rolled back. skamonkey@3594: ** skamonkey@3594: ** This function is accessible to SQL statements via the skamonkey@3594: ** [last_insert_rowid() SQL function]. skamonkey@3594: ** skamonkey@3594: ** If a separate thread performs a new [INSERT] on the same skamonkey@3594: ** database connection while the [sqlite3_last_insert_rowid()] skamonkey@3594: ** function is running and thus changes the last insert [rowid], skamonkey@3594: ** then the value returned by [sqlite3_last_insert_rowid()] is skamonkey@3594: ** unpredictable and might not equal either the old or the new skamonkey@3594: ** last insert [rowid]. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Count The Number Of Rows Modified ds@1952: ** skamonkey@3594: ** ^This function returns the number of database rows that were changed skamonkey@3594: ** or inserted or deleted by the most recently completed SQL statement skamonkey@3594: ** on the [database connection] specified by the first parameter. skamonkey@3594: ** ^(Only changes that are directly specified by the [INSERT], [UPDATE], skamonkey@3594: ** or [DELETE] statement are counted. Auxiliary changes caused by skamonkey@3594: ** triggers or [foreign key actions] are not counted.)^ Use the skamonkey@3594: ** [sqlite3_total_changes()] function to find the total number of changes skamonkey@3594: ** including changes caused by triggers and foreign key actions. skamonkey@3594: ** skamonkey@3594: ** ^Changes to a view that are simulated by an [INSTEAD OF trigger] skamonkey@3594: ** are not counted. Only real table changes are counted. skamonkey@3594: ** skamonkey@3594: ** ^(A "row change" is a change to a single row of a single table skamonkey@3594: ** caused by an INSERT, DELETE, or UPDATE statement. Rows that skamonkey@3594: ** are changed as side effects of [REPLACE] constraint resolution, skamonkey@3594: ** rollback, ABORT processing, [DROP TABLE], or by any other skamonkey@3594: ** mechanisms do not count as direct row changes.)^ skamonkey@3594: ** skamonkey@3594: ** A "trigger context" is a scope of execution that begins and skamonkey@3594: ** ends with the script of a [CREATE TRIGGER | trigger]. skamonkey@3594: ** Most SQL statements are skamonkey@3594: ** evaluated outside of any trigger. This is the "top level" skamonkey@3594: ** trigger context. If a trigger fires from the top level, a skamonkey@3594: ** new trigger context is entered for the duration of that one skamonkey@3594: ** trigger. Subtriggers create subcontexts for their duration. skamonkey@3594: ** skamonkey@3594: ** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does skamonkey@3594: ** not create a new trigger context. skamonkey@3594: ** skamonkey@3594: ** ^This function returns the number of direct row changes in the skamonkey@3594: ** most recent INSERT, UPDATE, or DELETE statement within the same skamonkey@3594: ** trigger context. skamonkey@3594: ** skamonkey@3594: ** ^Thus, when called from the top level, this function returns the skamonkey@3594: ** number of changes in the most recent INSERT, UPDATE, or DELETE skamonkey@3594: ** that also occurred at the top level. ^(Within the body of a trigger, skamonkey@3594: ** the sqlite3_changes() interface can be called to find the number of ds@1952: ** changes in the most recently completed INSERT, UPDATE, or DELETE skamonkey@3594: ** statement within the body of the same trigger. skamonkey@3594: ** However, the number returned does not include changes skamonkey@3594: ** caused by subtriggers since those have their own context.)^ skamonkey@3594: ** skamonkey@3594: ** See also the [sqlite3_total_changes()] interface, the skamonkey@3594: ** [count_changes pragma], and the [changes() SQL function]. skamonkey@3594: ** skamonkey@3594: ** If a separate thread makes changes on the same database connection skamonkey@3594: ** while [sqlite3_changes()] is running then the value returned skamonkey@3594: ** is unpredictable and not meaningful. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_changes(sqlite3*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Total Number Of Rows Modified skamonkey@3594: ** skamonkey@3594: ** ^This function returns the number of row changes caused by [INSERT], skamonkey@3594: ** [UPDATE] or [DELETE] statements since the [database connection] was opened. skamonkey@3594: ** ^(The count returned by sqlite3_total_changes() includes all changes skamonkey@3594: ** from all [CREATE TRIGGER | trigger] contexts and changes made by skamonkey@3594: ** [foreign key actions]. However, skamonkey@3594: ** the count does not include changes used to implement [REPLACE] constraints, skamonkey@3594: ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The skamonkey@3594: ** count does not include rows of views that fire an [INSTEAD OF trigger], skamonkey@3594: ** though if the INSTEAD OF trigger makes changes of its own, those changes skamonkey@3594: ** are counted.)^ skamonkey@3594: ** ^The sqlite3_total_changes() function counts the changes as soon as skamonkey@3594: ** the statement that makes them is completed (when the statement handle skamonkey@3594: ** is passed to [sqlite3_reset()] or [sqlite3_finalize()]). skamonkey@3594: ** skamonkey@3594: ** See also the [sqlite3_changes()] interface, the skamonkey@3594: ** [count_changes pragma], and the [total_changes() SQL function]. skamonkey@3594: ** skamonkey@3594: ** If a separate thread makes changes on the same database connection skamonkey@3594: ** while [sqlite3_total_changes()] is running then the value skamonkey@3594: ** returned is unpredictable and not meaningful. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_total_changes(sqlite3*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Interrupt A Long-Running Query ds@1952: ** skamonkey@3594: ** ^This function causes any pending database operation to abort and skamonkey@3594: ** return at its earliest opportunity. This routine is typically ds@1952: ** called in response to a user action such as pressing "Cancel" ds@1952: ** or Ctrl-C where the user wants a long query operation to halt ds@1952: ** immediately. ds@1952: ** skamonkey@3594: ** ^It is safe to call this routine from a thread different from the ds@1952: ** thread that is currently running the database operation. But it skamonkey@3594: ** is not safe to call this routine with a [database connection] that ds@1952: ** is closed or might close before sqlite3_interrupt() returns. ds@1952: ** skamonkey@3594: ** ^If an SQL operation is very nearly finished at the time when skamonkey@3594: ** sqlite3_interrupt() is called, then it might not have an opportunity skamonkey@3594: ** to be interrupted and might continue to completion. skamonkey@3594: ** skamonkey@3594: ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. skamonkey@3594: ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE skamonkey@3594: ** that is inside an explicit transaction, then the entire transaction skamonkey@3594: ** will be rolled back automatically. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_interrupt(D) call is in effect until all currently running skamonkey@3594: ** SQL statements on [database connection] D complete. ^Any new SQL statements skamonkey@3594: ** that are started after the sqlite3_interrupt() call and before the skamonkey@3594: ** running statements reaches zero are interrupted as if they had been skamonkey@3594: ** running prior to the sqlite3_interrupt() call. ^New SQL statements skamonkey@3594: ** that are started after the running statement count reaches zero are skamonkey@3594: ** not effected by the sqlite3_interrupt(). skamonkey@3594: ** ^A call to sqlite3_interrupt(D) that occurs when there are no running skamonkey@3594: ** SQL statements is a no-op and has no effect on SQL statements skamonkey@3594: ** that are started after the sqlite3_interrupt() call returns. skamonkey@3594: ** skamonkey@3594: ** If the database connection closes while [sqlite3_interrupt()] skamonkey@3594: ** is running then bad things will likely happen. skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_interrupt(sqlite3*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Determine If An SQL Statement Is Complete ds@1952: ** skamonkey@3594: ** These routines are useful during command-line input to determine if the skamonkey@3594: ** currently entered text seems to form a complete SQL statement or skamonkey@3594: ** if additional input is needed before sending the text into skamonkey@3594: ** SQLite for parsing. ^These routines return 1 if the input string skamonkey@3594: ** appears to be a complete SQL statement. ^A statement is judged to be skamonkey@3594: ** complete if it ends with a semicolon token and is not a prefix of a skamonkey@3594: ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within skamonkey@3594: ** string literals or quoted identifier names or comments are not skamonkey@3594: ** independent tokens (they are part of the token in which they are skamonkey@3594: ** embedded) and thus do not count as a statement terminator. ^Whitespace skamonkey@3594: ** and comments that follow the final semicolon are ignored. skamonkey@3594: ** skamonkey@3594: ** ^These routines return 0 if the statement is incomplete. ^If a skamonkey@3594: ** memory allocation fails, then SQLITE_NOMEM is returned. skamonkey@3594: ** skamonkey@3594: ** ^These routines do not parse the SQL statements thus skamonkey@3594: ** will not detect syntactically incorrect SQL. skamonkey@3594: ** skamonkey@3594: ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior skamonkey@3594: ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked skamonkey@3594: ** automatically by sqlite3_complete16(). If that initialization fails, skamonkey@3594: ** then the return value from sqlite3_complete16() will be non-zero skamonkey@3594: ** regardless of whether or not the input SQL is complete.)^ skamonkey@3594: ** skamonkey@3594: ** The input to [sqlite3_complete()] must be a zero-terminated skamonkey@3594: ** UTF-8 string. skamonkey@3594: ** skamonkey@3594: ** The input to [sqlite3_complete16()] must be a zero-terminated skamonkey@3594: ** UTF-16 string in native byte order. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_complete(const char *sql); skamonkey@3594: SQLITE_API int sqlite3_complete16(const void *sql); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors ds@1952: ** skamonkey@3594: ** ^This routine sets a callback function that might be invoked whenever skamonkey@3594: ** an attempt is made to open a database table that another thread skamonkey@3594: ** or process has locked. skamonkey@3594: ** skamonkey@3594: ** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] skamonkey@3594: ** is returned immediately upon encountering the lock. ^If the busy callback skamonkey@3594: ** is not NULL, then the callback might be invoked with two arguments. skamonkey@3594: ** skamonkey@3594: ** ^The first argument to the busy handler is a copy of the void* pointer which skamonkey@3594: ** is the third argument to sqlite3_busy_handler(). ^The second argument to skamonkey@3594: ** the busy handler callback is the number of times that the busy handler has skamonkey@3594: ** been invoked for this locking event. ^If the ds@1952: ** busy callback returns 0, then no additional attempts are made to ds@1952: ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. skamonkey@3594: ** ^If the callback returns non-zero, then another attempt skamonkey@3594: ** is made to open the database for reading and the cycle repeats. skamonkey@3594: ** skamonkey@3594: ** The presence of a busy handler does not guarantee that it will be invoked skamonkey@3594: ** when there is lock contention. ^If SQLite determines that invoking the busy skamonkey@3594: ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] skamonkey@3594: ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. ds@1952: ** Consider a scenario where one process is holding a read lock that ds@1952: ** it is trying to promote to a reserved lock and ds@1952: ** a second process is holding a reserved lock that it is trying ds@1952: ** to promote to an exclusive lock. The first process cannot proceed ds@1952: ** because it is blocked by the second and the second process cannot ds@1952: ** proceed because it is blocked by the first. If both processes ds@1952: ** invoke the busy handlers, neither will make any progress. Therefore, ds@1952: ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this ds@1952: ** will induce the first process to release its read lock and allow ds@1952: ** the second process to proceed. ds@1952: ** skamonkey@3594: ** ^The default busy callback is NULL. skamonkey@3594: ** skamonkey@3594: ** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] skamonkey@3594: ** when SQLite is in the middle of a large transaction where all the ds@1952: ** changes will not fit into the in-memory cache. SQLite will ds@1952: ** already hold a RESERVED lock on the database file, but it needs ds@1952: ** to promote this lock to EXCLUSIVE so that it can spill cache ds@1952: ** pages into the database file without harm to concurrent skamonkey@3594: ** readers. ^If it is unable to promote the lock, then the in-memory ds@1952: ** cache will be left in an inconsistent state and so the error ds@1952: ** code is promoted from the relatively benign [SQLITE_BUSY] to skamonkey@3594: ** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion skamonkey@3594: ** forces an automatic rollback of the changes. See the skamonkey@3594: ** ds@1952: ** CorruptionFollowingBusyError wiki page for a discussion of why ds@1952: ** this is important. skamonkey@3594: ** skamonkey@3594: ** ^(There can only be a single busy handler defined for each skamonkey@3594: ** [database connection]. Setting a new busy handler clears any skamonkey@3594: ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] skamonkey@3594: ** will also set or clear the busy handler. skamonkey@3594: ** skamonkey@3594: ** The busy callback should not take any actions which modify the skamonkey@3594: ** database connection that invoked the busy handler. Any such actions skamonkey@3594: ** result in undefined behavior. skamonkey@3594: ** skamonkey@3594: ** A busy handler must not close the database connection skamonkey@3594: ** or [prepared statement] that invoked the busy handler. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Set A Busy Timeout ds@1952: ** skamonkey@3594: ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps skamonkey@3594: ** for a specified amount of time when a table is locked. ^The handler skamonkey@3594: ** will sleep multiple times until at least "ms" milliseconds of sleeping skamonkey@3594: ** have accumulated. ^After at least "ms" milliseconds of sleeping, skamonkey@3594: ** the handler returns 0 which causes [sqlite3_step()] to return skamonkey@3594: ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. skamonkey@3594: ** skamonkey@3594: ** ^Calling this routine with an argument less than or equal to zero ds@1952: ** turns off all busy handlers. ds@1952: ** skamonkey@3594: ** ^(There can only be a single busy handler for a particular skamonkey@3594: ** [database connection] any any given moment. If another busy handler skamonkey@3594: ** was defined (using [sqlite3_busy_handler()]) prior to calling skamonkey@3594: ** this routine, that other busy handler is cleared.)^ skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Convenience Routines For Running Queries ds@1952: ** skamonkey@3594: ** This is a legacy interface that is preserved for backwards compatibility. skamonkey@3594: ** Use of this interface is not recommended. skamonkey@3594: ** skamonkey@3594: ** Definition: A result table is memory data structure created by the skamonkey@3594: ** [sqlite3_get_table()] interface. A result table records the skamonkey@3594: ** complete query results from one or more queries. skamonkey@3594: ** skamonkey@3594: ** The table conceptually has a number of rows and columns. But skamonkey@3594: ** these numbers are not part of the result table itself. These skamonkey@3594: ** numbers are obtained separately. Let N be the number of rows skamonkey@3594: ** and M be the number of columns. skamonkey@3594: ** skamonkey@3594: ** A result table is an array of pointers to zero-terminated UTF-8 strings. skamonkey@3594: ** There are (N+1)*M elements in the array. The first M pointers point skamonkey@3594: ** to zero-terminated strings that contain the names of the columns. skamonkey@3594: ** The remaining entries all point to query results. NULL values result skamonkey@3594: ** in NULL pointers. All other values are in their UTF-8 zero-terminated skamonkey@3594: ** string representation as returned by [sqlite3_column_text()]. skamonkey@3594: ** skamonkey@3594: ** A result table might consist of one or more memory allocations. skamonkey@3594: ** It is not safe to pass a result table directly to [sqlite3_free()]. skamonkey@3594: ** A result table should be deallocated using [sqlite3_free_table()]. skamonkey@3594: ** skamonkey@3594: ** ^(As an example of the result table format, suppose a query result skamonkey@3594: ** is as follows: ds@1952: ** ds@1952: ** 
ds@1952: **        Name        | Age
ds@1952: **        -----------------------
ds@1952: **        Alice       | 43
ds@1952: **        Bob         | 28
ds@1952: **        Cindy       | 21
ds@1952: **
ds@1952: ** skamonkey@3594: ** There are two column (M==2) and three rows (N==3). Thus the skamonkey@3594: ** result table has 8 entries. Suppose the result table is stored skamonkey@3594: ** in an array names azResult. Then azResult holds this content: ds@1952: ** ds@1952: ** 
ds@1952: **        azResult[0] = "Name";
ds@1952: **        azResult[1] = "Age";
ds@1952: **        azResult[2] = "Alice";
ds@1952: **        azResult[3] = "43";
ds@1952: **        azResult[4] = "Bob";
ds@1952: **        azResult[5] = "28";
ds@1952: **        azResult[6] = "Cindy";
ds@1952: **        azResult[7] = "21";
skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_get_table() function evaluates one or more skamonkey@3594: ** semicolon-separated SQL statements in the zero-terminated UTF-8 skamonkey@3594: ** string of its 2nd parameter and returns a result table to the skamonkey@3594: ** pointer given in its 3rd parameter. skamonkey@3594: ** skamonkey@3594: ** After the application has finished with the result from sqlite3_get_table(), skamonkey@3594: ** it must pass the result table pointer to sqlite3_free_table() in order to skamonkey@3594: ** release the memory that was malloced. Because of the way the skamonkey@3594: ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling skamonkey@3594: ** function must not try to call [sqlite3_free()] directly. Only skamonkey@3594: ** [sqlite3_free_table()] is able to release the memory properly and safely. skamonkey@3594: ** skamonkey@3594: ** The sqlite3_get_table() interface is implemented as a wrapper around skamonkey@3594: ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access skamonkey@3594: ** to any internal data structures of SQLite. It uses only the public skamonkey@3594: ** interface defined here. As a consequence, errors that occur in the skamonkey@3594: ** wrapper layer outside of the internal [sqlite3_exec()] call are not skamonkey@3594: ** reflected in subsequent calls to [sqlite3_errcode()] or skamonkey@3594: ** [sqlite3_errmsg()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_get_table( skamonkey@3594: sqlite3 *db, /* An open database */ skamonkey@3594: const char *zSql, /* SQL to be evaluated */ skamonkey@3594: char ***pazResult, /* Results of the query */ skamonkey@3594: int *pnRow, /* Number of result rows written here */ skamonkey@3594: int *pnColumn, /* Number of result columns written here */ skamonkey@3594: char **pzErrmsg /* Error msg written here */ ds@1952: ); skamonkey@3594: SQLITE_API void sqlite3_free_table(char **result); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Formatted String Printing Functions ds@1952: ** skamonkey@3594: ** These routines are work-alikes of the "printf()" family of functions ds@1952: ** from the standard C library. ds@1952: ** skamonkey@3594: ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their ds@1952: ** results into memory obtained from [sqlite3_malloc()]. ds@1952: ** The strings returned by these two routines should be skamonkey@3594: ** released by [sqlite3_free()]. ^Both routines return a ds@1952: ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough ds@1952: ** memory to hold the resulting string. ds@1952: ** skamonkey@3594: ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from ds@1952: ** the standard C library. The result is written into the ds@1952: ** buffer supplied as the second parameter whose size is given by skamonkey@3594: ** the first parameter. Note that the order of the skamonkey@3594: ** first two parameters is reversed from snprintf().)^ This is an ds@1952: ** historical accident that cannot be fixed without breaking skamonkey@3594: ** backwards compatibility. ^(Note also that sqlite3_snprintf() ds@1952: ** returns a pointer to its buffer instead of the number of skamonkey@3594: ** characters actually written into the buffer.)^ We admit that ds@1952: ** the number of characters written would be a more useful return ds@1952: ** value but we cannot change the implementation of sqlite3_snprintf() ds@1952: ** now without breaking compatibility. ds@1952: ** skamonkey@3594: ** ^As long as the buffer size is greater than zero, sqlite3_snprintf() skamonkey@3594: ** guarantees that the buffer is always zero-terminated. ^The first ds@1952: ** parameter "n" is the total size of the buffer, including space for ds@1952: ** the zero terminator. So the longest string that can be completely ds@1952: ** written will be n-1 characters. ds@1952: ** skamonkey@3594: ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). skamonkey@3594: ** ds@1952: ** These routines all implement some additional formatting ds@1952: ** options that are useful for constructing SQL statements. skamonkey@3594: ** All of the usual printf() formatting options apply. In addition, there ds@1952: ** is are "%q", "%Q", and "%z" options. ds@1952: ** skamonkey@3594: ** ^(The %q option works like %s in that it substitutes a nul-terminated ds@1952: ** string from the argument list. But %q also doubles every '\'' character. skamonkey@3594: ** %q is designed for use inside a string literal.)^ By doubling each '\'' ds@1952: ** character it escapes that character and allows it to be inserted into ds@1952: ** the string. ds@1952: ** skamonkey@3594: ** For example, assume the string variable zText contains text as follows: ds@1952: ** ds@1952: ** 
ds@1952: **  char *zText = "It's a happy day!";
ds@1952: **
ds@1952: ** ds@1952: ** One can use this text in an SQL statement as follows: ds@1952: ** ds@1952: ** 
ds@1952: **  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
ds@1952: **  sqlite3_exec(db, zSQL, 0, 0, 0);
ds@1952: **  sqlite3_free(zSQL);
ds@1952: **
ds@1952: ** ds@1952: ** Because the %q format string is used, the '\'' character in zText ds@1952: ** is escaped and the SQL generated is as follows: ds@1952: ** ds@1952: ** 
ds@1952: **  INSERT INTO table1 VALUES('It''s a happy day!')
ds@1952: **
ds@1952: ** ds@1952: ** This is correct. Had we used %s instead of %q, the generated SQL ds@1952: ** would have looked like this: ds@1952: ** ds@1952: ** 
ds@1952: **  INSERT INTO table1 VALUES('It's a happy day!');
ds@1952: **
ds@1952: ** skamonkey@3594: ** This second example is an SQL syntax error. As a general rule you should skamonkey@3594: ** always use %q instead of %s when inserting text into a string literal. skamonkey@3594: ** skamonkey@3594: ** ^(The %Q option works like %q except it also adds single quotes around skamonkey@3594: ** the outside of the total string. Additionally, if the parameter in the skamonkey@3594: ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without skamonkey@3594: ** single quotes).)^ So, for example, one could say: ds@1952: ** ds@1952: ** 
ds@1952: **  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
ds@1952: **  sqlite3_exec(db, zSQL, 0, 0, 0);
ds@1952: **  sqlite3_free(zSQL);
ds@1952: **
ds@1952: ** ds@1952: ** The code above will render a correct SQL statement in the zSQL ds@1952: ** variable even if the zText variable is a NULL pointer. ds@1952: ** skamonkey@3594: ** ^(The "%z" formatting option works like "%s" but with the ds@1952: ** addition that after the string has been read and copied into skamonkey@3594: ** the result, [sqlite3_free()] is called on the input string.)^ skamonkey@3594: */ skamonkey@3594: SQLITE_API char *sqlite3_mprintf(const char*,...); skamonkey@3594: SQLITE_API char *sqlite3_vmprintf(const char*, va_list); skamonkey@3594: SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); skamonkey@3594: SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Memory Allocation Subsystem ds@1952: ** ds@1952: ** The SQLite core uses these three routines for all of its own skamonkey@3594: ** internal memory allocation needs. "Core" in the previous sentence skamonkey@3594: ** does not include operating-system specific VFS implementation. The skamonkey@3594: ** Windows VFS uses native malloc() and free() for some operations. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_malloc() routine returns a pointer to a block skamonkey@3594: ** of memory at least N bytes in length, where N is the parameter. skamonkey@3594: ** ^If sqlite3_malloc() is unable to obtain sufficient free skamonkey@3594: ** memory, it returns a NULL pointer. ^If the parameter N to skamonkey@3594: ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns skamonkey@3594: ** a NULL pointer. skamonkey@3594: ** skamonkey@3594: ** ^Calling sqlite3_free() with a pointer previously returned skamonkey@3594: ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so skamonkey@3594: ** that it might be reused. ^The sqlite3_free() routine is skamonkey@3594: ** a no-op if is called with a NULL pointer. Passing a NULL pointer skamonkey@3594: ** to sqlite3_free() is harmless. After being freed, memory skamonkey@3594: ** should neither be read nor written. Even reading previously freed skamonkey@3594: ** memory might result in a segmentation fault or other severe error. skamonkey@3594: ** Memory corruption, a segmentation fault, or other severe error skamonkey@3594: ** might result if sqlite3_free() is called with a non-NULL pointer that skamonkey@3594: ** was not obtained from sqlite3_malloc() or sqlite3_realloc(). skamonkey@3594: ** skamonkey@3594: ** ^(The sqlite3_realloc() interface attempts to resize a skamonkey@3594: ** prior memory allocation to be at least N bytes, where N is the skamonkey@3594: ** second parameter. The memory allocation to be resized is the first skamonkey@3594: ** parameter.)^ ^ If the first parameter to sqlite3_realloc() skamonkey@3594: ** is a NULL pointer then its behavior is identical to calling skamonkey@3594: ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). skamonkey@3594: ** ^If the second parameter to sqlite3_realloc() is zero or skamonkey@3594: ** negative then the behavior is exactly the same as calling skamonkey@3594: ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). skamonkey@3594: ** ^sqlite3_realloc() returns a pointer to a memory allocation skamonkey@3594: ** of at least N bytes in size or NULL if sufficient memory is unavailable. skamonkey@3594: ** ^If M is the size of the prior allocation, then min(N,M) bytes skamonkey@3594: ** of the prior allocation are copied into the beginning of buffer returned skamonkey@3594: ** by sqlite3_realloc() and the prior allocation is freed. skamonkey@3594: ** ^If sqlite3_realloc() returns NULL, then the prior allocation skamonkey@3594: ** is not freed. skamonkey@3594: ** skamonkey@3594: ** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() skamonkey@3594: ** is always aligned to at least an 8 byte boundary, or to a skamonkey@3594: ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time skamonkey@3594: ** option is used. skamonkey@3594: ** skamonkey@3594: ** In SQLite version 3.5.0 and 3.5.1, it was possible to define skamonkey@3594: ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in skamonkey@3594: ** implementation of these routines to be omitted. That capability skamonkey@3594: ** is no longer provided. Only built-in memory allocators can be used. skamonkey@3594: ** skamonkey@3594: ** Prior to SQLite version 3.7.10, the Windows OS interface layer called ds@1952: ** the system malloc() and free() directly when converting ds@1952: ** filenames between the UTF-8 encoding used by SQLite skamonkey@3594: ** and whatever filename encoding is used by the particular Windows skamonkey@3594: ** installation. Memory allocation errors were detected, but skamonkey@3594: ** they were reported back as [SQLITE_CANTOPEN] or ds@1952: ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. skamonkey@3594: ** skamonkey@3594: ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] skamonkey@3594: ** must be either NULL or else pointers obtained from a prior skamonkey@3594: ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have skamonkey@3594: ** not yet been released. skamonkey@3594: ** skamonkey@3594: ** The application must not read or write any part of skamonkey@3594: ** a block of memory after it has been released using skamonkey@3594: ** [sqlite3_free()] or [sqlite3_realloc()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API void *sqlite3_malloc(int); skamonkey@3594: SQLITE_API void *sqlite3_realloc(void*, int); skamonkey@3594: SQLITE_API void sqlite3_free(void*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Memory Allocator Statistics ds@1952: ** skamonkey@3594: ** SQLite provides these two interfaces for reporting on the status skamonkey@3594: ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] skamonkey@3594: ** routines, which form the built-in memory allocation subsystem. skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_memory_used()] routine returns the number of bytes skamonkey@3594: ** of memory currently outstanding (malloced but not freed). skamonkey@3594: ** ^The [sqlite3_memory_highwater()] routine returns the maximum skamonkey@3594: ** value of [sqlite3_memory_used()] since the high-water mark skamonkey@3594: ** was last reset. ^The values returned by [sqlite3_memory_used()] and skamonkey@3594: ** [sqlite3_memory_highwater()] include any overhead skamonkey@3594: ** added by SQLite in its implementation of [sqlite3_malloc()], skamonkey@3594: ** but not overhead added by the any underlying system library skamonkey@3594: ** routines that [sqlite3_malloc()] may call. skamonkey@3594: ** skamonkey@3594: ** ^The memory high-water mark is reset to the current value of skamonkey@3594: ** [sqlite3_memory_used()] if and only if the parameter to skamonkey@3594: ** [sqlite3_memory_highwater()] is true. ^The value returned skamonkey@3594: ** by [sqlite3_memory_highwater(1)] is the high-water mark skamonkey@3594: ** prior to the reset. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3_int64 sqlite3_memory_used(void); skamonkey@3594: SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Pseudo-Random Number Generator skamonkey@3594: ** skamonkey@3594: ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to skamonkey@3594: ** select random [ROWID | ROWIDs] when inserting new records into a table that skamonkey@3594: ** already uses the largest possible [ROWID]. The PRNG is also used for skamonkey@3594: ** the build-in random() and randomblob() SQL functions. This interface allows skamonkey@3594: ** applications to access the same PRNG for other purposes. skamonkey@3594: ** skamonkey@3594: ** ^A call to this routine stores N bytes of randomness into buffer P. skamonkey@3594: ** skamonkey@3594: ** ^The first time this routine is invoked (either internally or by skamonkey@3594: ** the application) the PRNG is seeded using randomness obtained skamonkey@3594: ** from the xRandomness method of the default [sqlite3_vfs] object. skamonkey@3594: ** ^On all subsequent invocations, the pseudo-randomness is generated skamonkey@3594: ** internally and without recourse to the [sqlite3_vfs] xRandomness skamonkey@3594: ** method. skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_randomness(int N, void *P); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Compile-Time Authorization Callbacks skamonkey@3594: ** skamonkey@3594: ** ^This routine registers an authorizer callback with a particular skamonkey@3594: ** [database connection], supplied in the first argument. skamonkey@3594: ** ^The authorizer callback is invoked as SQL statements are being compiled ds@1952: ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], skamonkey@3594: ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various ds@1952: ** points during the compilation process, as logic is being created ds@1952: ** to perform various actions, the authorizer callback is invoked to skamonkey@3594: ** see if those actions are allowed. ^The authorizer callback should skamonkey@3594: ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the ds@1952: ** specific action but allow the SQL statement to continue to be ds@1952: ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be skamonkey@3594: ** rejected with an error. ^If the authorizer callback returns skamonkey@3594: ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] skamonkey@3594: ** then the [sqlite3_prepare_v2()] or equivalent call that triggered skamonkey@3594: ** the authorizer will fail with an error message. skamonkey@3594: ** skamonkey@3594: ** When the callback returns [SQLITE_OK], that means the operation skamonkey@3594: ** requested is ok. ^When the callback returns [SQLITE_DENY], the skamonkey@3594: ** [sqlite3_prepare_v2()] or equivalent call that triggered the skamonkey@3594: ** authorizer will fail with an error message explaining that skamonkey@3594: ** access is denied. skamonkey@3594: ** skamonkey@3594: ** ^The first parameter to the authorizer callback is a copy of the third skamonkey@3594: ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter skamonkey@3594: ** to the callback is an integer [SQLITE_COPY | action code] that specifies skamonkey@3594: ** the particular action to be authorized. ^The third through sixth parameters skamonkey@3594: ** to the callback are zero-terminated strings that contain additional ds@1952: ** details about the action to be authorized. ds@1952: ** skamonkey@3594: ** ^If the action code is [SQLITE_READ] skamonkey@3594: ** and the callback returns [SQLITE_IGNORE] then the skamonkey@3594: ** [prepared statement] statement is constructed to substitute skamonkey@3594: ** a NULL value in place of the table column that would have skamonkey@3594: ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] skamonkey@3594: ** return can be used to deny an untrusted user access to individual skamonkey@3594: ** columns of a table. skamonkey@3594: ** ^If the action code is [SQLITE_DELETE] and the callback returns skamonkey@3594: ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the skamonkey@3594: ** [truncate optimization] is disabled and all rows are deleted individually. skamonkey@3594: ** skamonkey@3594: ** An authorizer is used when [sqlite3_prepare | preparing] skamonkey@3594: ** SQL statements from an untrusted source, to ensure that the SQL statements skamonkey@3594: ** do not try to access data they are not allowed to see, or that they do not skamonkey@3594: ** try to execute malicious statements that damage the database. For ds@1952: ** example, an application may allow a user to enter arbitrary ds@1952: ** SQL queries for evaluation by a database. But the application does ds@1952: ** not want the user to be able to make arbitrary changes to the ds@1952: ** database. An authorizer could then be put in place while the skamonkey@3594: ** user-entered SQL is being [sqlite3_prepare | prepared] that skamonkey@3594: ** disallows everything except [SELECT] statements. skamonkey@3594: ** skamonkey@3594: ** Applications that need to process SQL from untrusted sources skamonkey@3594: ** might also consider lowering resource limits using [sqlite3_limit()] skamonkey@3594: ** and limiting database size using the [max_page_count] [PRAGMA] skamonkey@3594: ** in addition to using an authorizer. skamonkey@3594: ** skamonkey@3594: ** ^(Only a single authorizer can be in place on a database connection ds@1952: ** at a time. Each call to sqlite3_set_authorizer overrides the skamonkey@3594: ** previous call.)^ ^Disable the authorizer by installing a NULL callback. skamonkey@3594: ** The authorizer is disabled by default. skamonkey@3594: ** skamonkey@3594: ** The authorizer callback must not do anything that will modify skamonkey@3594: ** the database connection that invoked the authorizer callback. skamonkey@3594: ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their skamonkey@3594: ** database connections for the meaning of "modify" in this paragraph. skamonkey@3594: ** skamonkey@3594: ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the skamonkey@3594: ** statement might be re-prepared during [sqlite3_step()] due to a skamonkey@3594: ** schema change. Hence, the application should ensure that the skamonkey@3594: ** correct authorizer callback remains in place during the [sqlite3_step()]. skamonkey@3594: ** skamonkey@3594: ** ^Note that the authorizer callback is invoked only during ds@1952: ** [sqlite3_prepare()] or its variants. Authorization is not skamonkey@3594: ** performed during statement evaluation in [sqlite3_step()], unless skamonkey@3594: ** as stated in the previous paragraph, sqlite3_step() invokes skamonkey@3594: ** sqlite3_prepare_v2() to reprepare a statement after a schema change. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_set_authorizer( ds@1952: sqlite3*, ds@1952: int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), ds@1952: void *pUserData ds@1952: ); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Authorizer Return Codes ds@1952: ** ds@1952: ** The [sqlite3_set_authorizer | authorizer callback function] must ds@1952: ** return either [SQLITE_OK] or one of these two constants in order ds@1952: ** to signal SQLite whether or not the action is permitted. See the ds@1952: ** [sqlite3_set_authorizer | authorizer documentation] for additional ds@1952: ** information. skamonkey@3594: ** skamonkey@3594: ** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code] skamonkey@3594: ** from the [sqlite3_vtab_on_conflict()] interface. ds@1952: */ ds@1952: #define SQLITE_DENY 1 /* Abort the SQL statement with an error */ ds@1952: #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Authorizer Action Codes ds@1952: ** ds@1952: ** The [sqlite3_set_authorizer()] interface registers a callback function skamonkey@3594: ** that is invoked to authorize certain SQL statement actions. The ds@1952: ** second parameter to the callback is an integer code that specifies ds@1952: ** what action is being authorized. These are the integer action codes that ds@1952: ** the authorizer callback may be passed. ds@1952: ** skamonkey@3594: ** These action code values signify what kind of operation is to be skamonkey@3594: ** authorized. The 3rd and 4th parameters to the authorization skamonkey@3594: ** callback function will be parameters or NULL depending on which of these skamonkey@3594: ** codes is used as the second parameter. ^(The 5th parameter to the skamonkey@3594: ** authorizer callback is the name of the database ("main", "temp", skamonkey@3594: ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback ds@1952: ** is the name of the inner-most trigger or view that is responsible for skamonkey@3594: ** the access attempt or NULL if this access attempt is directly from ds@1952: ** top-level SQL code. ds@1952: */ ds@1952: /******************************************* 3rd ************ 4th ***********/ ds@1952: #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ ds@1952: #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ ds@1952: #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ ds@1952: #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ ds@1952: #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ ds@1952: #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ ds@1952: #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ ds@1952: #define SQLITE_CREATE_VIEW 8 /* View Name NULL */ ds@1952: #define SQLITE_DELETE 9 /* Table Name NULL */ ds@1952: #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ ds@1952: #define SQLITE_DROP_TABLE 11 /* Table Name NULL */ ds@1952: #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ ds@1952: #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ ds@1952: #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ ds@1952: #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ ds@1952: #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ ds@1952: #define SQLITE_DROP_VIEW 17 /* View Name NULL */ ds@1952: #define SQLITE_INSERT 18 /* Table Name NULL */ ds@1952: #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ ds@1952: #define SQLITE_READ 20 /* Table Name Column Name */ ds@1952: #define SQLITE_SELECT 21 /* NULL NULL */ skamonkey@3594: #define SQLITE_TRANSACTION 22 /* Operation NULL */ ds@1952: #define SQLITE_UPDATE 23 /* Table Name Column Name */ ds@1952: #define SQLITE_ATTACH 24 /* Filename NULL */ ds@1952: #define SQLITE_DETACH 25 /* Database Name NULL */ ds@1952: #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ ds@1952: #define SQLITE_REINDEX 27 /* Index Name NULL */ ds@1952: #define SQLITE_ANALYZE 28 /* Table Name NULL */ ds@1952: #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ ds@1952: #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ skamonkey@3594: #define SQLITE_FUNCTION 31 /* NULL Function Name */ skamonkey@3594: #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ ds@1952: #define SQLITE_COPY 0 /* No longer used */ ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Tracing And Profiling Functions ds@1952: ** ds@1952: ** These routines register callback functions that can be used for ds@1952: ** tracing and profiling the execution of SQL statements. skamonkey@3594: ** skamonkey@3594: ** ^The callback function registered by sqlite3_trace() is invoked at skamonkey@3594: ** various times when an SQL statement is being run by [sqlite3_step()]. skamonkey@3594: ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the skamonkey@3594: ** SQL statement text as the statement first begins executing. skamonkey@3594: ** ^(Additional sqlite3_trace() callbacks might occur skamonkey@3594: ** as each triggered subprogram is entered. The callbacks for triggers skamonkey@3594: ** contain a UTF-8 SQL comment that identifies the trigger.)^ skamonkey@3594: ** skamonkey@3594: ** ^The callback function registered by sqlite3_profile() is invoked skamonkey@3594: ** as each SQL statement finishes. ^The profile callback contains skamonkey@3594: ** the original statement text and an estimate of wall-clock time skamonkey@3594: ** of how long that statement took to run. ^The profile callback skamonkey@3594: ** time is in units of nanoseconds, however the current implementation skamonkey@3594: ** is only capable of millisecond resolution so the six least significant skamonkey@3594: ** digits in the time are meaningless. Future versions of SQLite skamonkey@3594: ** might provide greater resolution on the profiler callback. The skamonkey@3594: ** sqlite3_profile() function is considered experimental and is skamonkey@3594: ** subject to change in future versions of SQLite. skamonkey@3594: */ skamonkey@3594: SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); skamonkey@3594: SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, ds@1952: void(*xProfile)(void*,const char*,sqlite3_uint64), void*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Query Progress Callbacks ds@1952: ** skamonkey@3594: ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback skamonkey@3594: ** function X to be invoked periodically during long running calls to skamonkey@3594: ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for skamonkey@3594: ** database connection D. An example use for this ds@1952: ** interface is to keep a GUI updated during a large query. ds@1952: ** skamonkey@3594: ** ^The parameter P is passed through as the only parameter to the skamonkey@3594: ** callback function X. ^The parameter N is the number of skamonkey@3594: ** [virtual machine instructions] that are evaluated between successive skamonkey@3594: ** invocations of the callback X. skamonkey@3594: ** skamonkey@3594: ** ^Only a single progress handler may be defined at one time per skamonkey@3594: ** [database connection]; setting a new progress handler cancels the skamonkey@3594: ** old one. ^Setting parameter X to NULL disables the progress handler. skamonkey@3594: ** ^The progress handler is also disabled by setting N to a value less skamonkey@3594: ** than 1. skamonkey@3594: ** skamonkey@3594: ** ^If the progress callback returns non-zero, the operation is skamonkey@3594: ** interrupted. This feature can be used to implement a skamonkey@3594: ** "Cancel" button on a GUI progress dialog box. skamonkey@3594: ** skamonkey@3594: ** The progress handler callback must not do anything that will modify skamonkey@3594: ** the database connection that invoked the progress handler. skamonkey@3594: ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their skamonkey@3594: ** database connections for the meaning of "modify" in this paragraph. skamonkey@3594: ** skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Opening A New Database Connection ds@1952: ** skamonkey@3594: ** ^These routines open an SQLite database file as specified by the skamonkey@3594: ** filename argument. ^The filename argument is interpreted as UTF-8 for skamonkey@3594: ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte skamonkey@3594: ** order for sqlite3_open16(). ^(A [database connection] handle is usually skamonkey@3594: ** returned in *ppDb, even if an error occurs. The only exception is that skamonkey@3594: ** if SQLite is unable to allocate memory to hold the [sqlite3] object, skamonkey@3594: ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] skamonkey@3594: ** object.)^ ^(If the database is opened (and/or created) successfully, then skamonkey@3594: ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The skamonkey@3594: ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain skamonkey@3594: ** an English language description of the error following a failure of any skamonkey@3594: ** of the sqlite3_open() routines. skamonkey@3594: ** skamonkey@3594: ** ^The default encoding for the database will be UTF-8 if skamonkey@3594: ** sqlite3_open() or sqlite3_open_v2() is called and skamonkey@3594: ** UTF-16 in the native byte order if sqlite3_open16() is used. skamonkey@3594: ** skamonkey@3594: ** Whether or not an error occurs when it is opened, resources skamonkey@3594: ** associated with the [database connection] handle should be released by skamonkey@3594: ** passing it to [sqlite3_close()] when it is no longer required. skamonkey@3594: ** skamonkey@3594: ** The sqlite3_open_v2() interface works like sqlite3_open() skamonkey@3594: ** except that it accepts two additional parameters for additional control skamonkey@3594: ** over the new database connection. ^(The flags parameter to skamonkey@3594: ** sqlite3_open_v2() can take one of skamonkey@3594: ** the following three values, optionally combined with the skamonkey@3594: ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], skamonkey@3594: ** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: ** ^(
[SQLITE_OPEN_READONLY]
skamonkey@3594: **
The database is opened in read-only mode. If the database does not skamonkey@3594: ** already exist, an error is returned.
)^ skamonkey@3594: ** skamonkey@3594: ** ^(
[SQLITE_OPEN_READWRITE]
skamonkey@3594: **
The database is opened for reading and writing if possible, or reading skamonkey@3594: ** only if the file is write protected by the operating system. In either skamonkey@3594: ** case the database must already exist, otherwise an error is returned.
)^ skamonkey@3594: ** skamonkey@3594: ** ^(
[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]
skamonkey@3594: **
The database is opened for reading and writing, and is created if skamonkey@3594: ** it does not already exist. This is the behavior that is always used for skamonkey@3594: ** sqlite3_open() and sqlite3_open16().
)^ skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** If the 3rd parameter to sqlite3_open_v2() is not one of the skamonkey@3594: ** combinations shown above optionally combined with other skamonkey@3594: ** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] skamonkey@3594: ** then the behavior is undefined. skamonkey@3594: ** skamonkey@3594: ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection skamonkey@3594: ** opens in the multi-thread [threading mode] as long as the single-thread skamonkey@3594: ** mode has not been set at compile-time or start-time. ^If the skamonkey@3594: ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens skamonkey@3594: ** in the serialized [threading mode] unless single-thread was skamonkey@3594: ** previously selected at compile-time or start-time. skamonkey@3594: ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be skamonkey@3594: ** eligible to use [shared cache mode], regardless of whether or not shared skamonkey@3594: ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The skamonkey@3594: ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not skamonkey@3594: ** participate in [shared cache mode] even if it is enabled. skamonkey@3594: ** skamonkey@3594: ** ^The fourth parameter to sqlite3_open_v2() is the name of the skamonkey@3594: ** [sqlite3_vfs] object that defines the operating system interface that skamonkey@3594: ** the new database connection should use. ^If the fourth parameter is skamonkey@3594: ** a NULL pointer then the default [sqlite3_vfs] object is used. skamonkey@3594: ** skamonkey@3594: ** ^If the filename is ":memory:", then a private, temporary in-memory database skamonkey@3594: ** is created for the connection. ^This in-memory database will vanish when skamonkey@3594: ** the database connection is closed. Future versions of SQLite might skamonkey@3594: ** make use of additional special filenames that begin with the ":" character. skamonkey@3594: ** It is recommended that when a database filename actually does begin with skamonkey@3594: ** a ":" character you should prefix the filename with a pathname such as skamonkey@3594: ** "./" to avoid ambiguity. skamonkey@3594: ** skamonkey@3594: ** ^If the filename is an empty string, then a private, temporary skamonkey@3594: ** on-disk database will be created. ^This private database will be ds@1952: ** automatically deleted as soon as the database connection is closed. ds@1952: ** skamonkey@3594: ** [[URI filenames in sqlite3_open()]]

URI Filenames

skamonkey@3594: ** skamonkey@3594: ** ^If [URI filename] interpretation is enabled, and the filename argument skamonkey@3594: ** begins with "file:", then the filename is interpreted as a URI. ^URI skamonkey@3594: ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is skamonkey@3594: ** set in the fourth argument to sqlite3_open_v2(), or if it has skamonkey@3594: ** been enabled globally using the [SQLITE_CONFIG_URI] option with the skamonkey@3594: ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. skamonkey@3594: ** As of SQLite version 3.7.7, URI filename interpretation is turned off skamonkey@3594: ** by default, but future releases of SQLite might enable URI filename skamonkey@3594: ** interpretation by default. See "[URI filenames]" for additional skamonkey@3594: ** information. skamonkey@3594: ** skamonkey@3594: ** URI filenames are parsed according to RFC 3986. ^If the URI contains an skamonkey@3594: ** authority, then it must be either an empty string or the string skamonkey@3594: ** "localhost". ^If the authority is not an empty string or "localhost", an skamonkey@3594: ** error is returned to the caller. ^The fragment component of a URI, if skamonkey@3594: ** present, is ignored. skamonkey@3594: ** skamonkey@3594: ** ^SQLite uses the path component of the URI as the name of the disk file skamonkey@3594: ** which contains the database. ^If the path begins with a '/' character, skamonkey@3594: ** then it is interpreted as an absolute path. ^If the path does not begin skamonkey@3594: ** with a '/' (meaning that the authority section is omitted from the URI) skamonkey@3594: ** then the path is interpreted as a relative path. skamonkey@3594: ** ^On windows, the first component of an absolute path skamonkey@3594: ** is a drive specification (e.g. "C:"). skamonkey@3594: ** skamonkey@3594: ** [[core URI query parameters]] skamonkey@3594: ** The query component of a URI may contain parameters that are interpreted skamonkey@3594: ** either by SQLite itself, or by a [VFS | custom VFS implementation]. skamonkey@3594: ** SQLite interprets the following three query parameters: skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: ** ^Specifying an unknown parameter in the query component of a URI is not an skamonkey@3594: ** error. Future versions of SQLite might understand additional query skamonkey@3594: ** parameters. See "[query parameters with special meaning to SQLite]" for skamonkey@3594: ** additional information. skamonkey@3594: ** skamonkey@3594: ** [[URI filename examples]]

URI filename examples

skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: **
URI filenames Results skamonkey@3594: **
file:data.db skamonkey@3594: ** Open the file "data.db" in the current directory. skamonkey@3594: **
file:/home/fred/data.db
skamonkey@3594: ** file:///home/fred/data.db
skamonkey@3594: ** file://localhost/home/fred/data.db
skamonkey@3594: ** Open the database file "/home/fred/data.db". skamonkey@3594: **
file://darkstar/home/fred/data.db skamonkey@3594: ** An error. "darkstar" is not a recognized authority. skamonkey@3594: **
skamonkey@3594: ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db skamonkey@3594: ** Windows only: Open the file "data.db" on fred's desktop on drive skamonkey@3594: ** C:. Note that the %20 escaping in this example is not strictly skamonkey@3594: ** necessary - space characters can be used literally skamonkey@3594: ** in URI filenames. skamonkey@3594: **
file:data.db?mode=ro&cache=private skamonkey@3594: ** Open file "data.db" in the current directory for read-only access. skamonkey@3594: ** Regardless of whether or not shared-cache mode is enabled by skamonkey@3594: ** default, use a private cache. skamonkey@3594: **
file:/home/fred/data.db?vfs=unix-nolock skamonkey@3594: ** Open file "/home/fred/data.db". Use the special VFS "unix-nolock". skamonkey@3594: **
file:data.db?mode=readonly skamonkey@3594: ** An error. "readonly" is not a valid option for the "mode" parameter. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** ^URI hexadecimal escape sequences (%HH) are supported within the path and skamonkey@3594: ** query components of a URI. A hexadecimal escape sequence consists of a skamonkey@3594: ** percent sign - "%" - followed by exactly two hexadecimal digits skamonkey@3594: ** specifying an octet value. ^Before the path or query components of a skamonkey@3594: ** URI filename are interpreted, they are encoded using UTF-8 and all skamonkey@3594: ** hexadecimal escape sequences replaced by a single byte containing the skamonkey@3594: ** corresponding octet. If this process generates an invalid UTF-8 encoding, skamonkey@3594: ** the results are undefined. skamonkey@3594: ** skamonkey@3594: ** Note to Windows users: The encoding used for the filename argument skamonkey@3594: ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever ds@1952: ** codepage is currently defined. Filenames containing international ds@1952: ** characters must be converted to UTF-8 prior to passing them into skamonkey@3594: ** sqlite3_open() or sqlite3_open_v2(). skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_open( ds@1952: const char *filename, /* Database filename (UTF-8) */ ds@1952: sqlite3 **ppDb /* OUT: SQLite db handle */ ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_open16( ds@1952: const void *filename, /* Database filename (UTF-16) */ ds@1952: sqlite3 **ppDb /* OUT: SQLite db handle */ ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_open_v2( ds@1952: const char *filename, /* Database filename (UTF-8) */ ds@1952: sqlite3 **ppDb, /* OUT: SQLite db handle */ ds@1952: int flags, /* Flags */ ds@1952: const char *zVfs /* Name of VFS module to use */ ds@1952: ); ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Obtain Values For URI Parameters skamonkey@3594: ** skamonkey@3594: ** These are utility routines, useful to VFS implementations, that check skamonkey@3594: ** to see if a database file was a URI that contained a specific query skamonkey@3594: ** parameter, and if so obtains the value of that query parameter. skamonkey@3594: ** skamonkey@3594: ** If F is the database filename pointer passed into the xOpen() method of skamonkey@3594: ** a VFS implementation when the flags parameter to xOpen() has one or skamonkey@3594: ** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and skamonkey@3594: ** P is the name of the query parameter, then skamonkey@3594: ** sqlite3_uri_parameter(F,P) returns the value of the P skamonkey@3594: ** parameter if it exists or a NULL pointer if P does not appear as a skamonkey@3594: ** query parameter on F. If P is a query parameter of F skamonkey@3594: ** has no explicit value, then sqlite3_uri_parameter(F,P) returns skamonkey@3594: ** a pointer to an empty string. skamonkey@3594: ** skamonkey@3594: ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean skamonkey@3594: ** parameter and returns true (1) or false (0) according to the value skamonkey@3594: ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the skamonkey@3594: ** value of query parameter P is one of "yes", "true", or "on" in any skamonkey@3594: ** case or if the value begins with a non-zero number. The skamonkey@3594: ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of skamonkey@3594: ** query parameter P is one of "no", "false", or "off" in any case or skamonkey@3594: ** if the value begins with a numeric zero. If P is not a query skamonkey@3594: ** parameter on F or if the value of P is does not match any of the skamonkey@3594: ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). skamonkey@3594: ** skamonkey@3594: ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a skamonkey@3594: ** 64-bit signed integer and returns that integer, or D if P does not skamonkey@3594: ** exist. If the value of P is something other than an integer, then skamonkey@3594: ** zero is returned. skamonkey@3594: ** skamonkey@3594: ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and skamonkey@3594: ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and skamonkey@3594: ** is not a database file pathname pointer that SQLite passed into the xOpen skamonkey@3594: ** VFS method, then the behavior of this routine is undefined and probably skamonkey@3594: ** undesirable. skamonkey@3594: */ skamonkey@3594: SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); skamonkey@3594: SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); skamonkey@3594: SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); skamonkey@3594: skamonkey@3594: skamonkey@3594: /* ds@1952: ** CAPI3REF: Error Codes And Messages ds@1952: ** skamonkey@3594: ** ^The sqlite3_errcode() interface returns the numeric [result code] or skamonkey@3594: ** [extended result code] for the most recent failed sqlite3_* API call skamonkey@3594: ** associated with a [database connection]. If a prior API call failed skamonkey@3594: ** but the most recent API call succeeded, the return value from skamonkey@3594: ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() skamonkey@3594: ** interface is the same except that it always returns the skamonkey@3594: ** [extended result code] even when extended result codes are skamonkey@3594: ** disabled. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language skamonkey@3594: ** text that describes the error, as either UTF-8 or UTF-16 respectively. skamonkey@3594: ** ^(Memory to hold the error message string is managed internally. skamonkey@3594: ** The application does not need to worry about freeing the result. skamonkey@3594: ** However, the error string might be overwritten or deallocated by skamonkey@3594: ** subsequent calls to other SQLite interface functions.)^ skamonkey@3594: ** skamonkey@3594: ** When the serialized [threading mode] is in use, it might be the skamonkey@3594: ** case that a second error occurs on a separate thread in between skamonkey@3594: ** the time of the first error and the call to these interfaces. skamonkey@3594: ** When that happens, the second error will be reported since these skamonkey@3594: ** interfaces always report the most recent result. To avoid skamonkey@3594: ** this, each thread can obtain exclusive use of the [database connection] D skamonkey@3594: ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning skamonkey@3594: ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after skamonkey@3594: ** all calls to the interfaces listed here are completed. skamonkey@3594: ** skamonkey@3594: ** If an interface fails with SQLITE_MISUSE, that means the interface skamonkey@3594: ** was invoked incorrectly by the application. In that case, the skamonkey@3594: ** error code and message may or may not be set. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_errcode(sqlite3 *db); skamonkey@3594: SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); skamonkey@3594: SQLITE_API const char *sqlite3_errmsg(sqlite3*); skamonkey@3594: SQLITE_API const void *sqlite3_errmsg16(sqlite3*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: SQL Statement Object skamonkey@3594: ** KEYWORDS: {prepared statement} {prepared statements} skamonkey@3594: ** skamonkey@3594: ** An instance of this object represents a single SQL statement. skamonkey@3594: ** This object is variously known as a "prepared statement" or a ds@1952: ** "compiled SQL statement" or simply as a "statement". skamonkey@3594: ** ds@1952: ** The life of a statement object goes something like this: ds@1952: ** ds@1952: **
    ds@1952: **
  1. Create the object using [sqlite3_prepare_v2()] or a related ds@1952: ** function. skamonkey@3594: **
  2. Bind values to [host parameters] using the sqlite3_bind_*() skamonkey@3594: ** interfaces. ds@1952: **
  3. Run the SQL by calling [sqlite3_step()] one or more times. ds@1952: **
  4. Reset the statement using [sqlite3_reset()] then go back ds@1952: ** to step 2. Do this zero or more times. ds@1952: **
  5. Destroy the object using [sqlite3_finalize()]. ds@1952: **
ds@1952: ** ds@1952: ** Refer to documentation on individual methods above for additional ds@1952: ** information. ds@1952: */ ds@1952: typedef struct sqlite3_stmt sqlite3_stmt; ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Run-time Limits skamonkey@3594: ** skamonkey@3594: ** ^(This interface allows the size of various constructs to be limited skamonkey@3594: ** on a connection by connection basis. The first parameter is the skamonkey@3594: ** [database connection] whose limit is to be set or queried. The skamonkey@3594: ** second parameter is one of the [limit categories] that define a skamonkey@3594: ** class of constructs to be size limited. The third parameter is the skamonkey@3594: ** new limit for that construct.)^ skamonkey@3594: ** skamonkey@3594: ** ^If the new limit is a negative number, the limit is unchanged. skamonkey@3594: ** ^(For each limit category SQLITE_LIMIT_NAME there is a skamonkey@3594: ** [limits | hard upper bound] skamonkey@3594: ** set at compile-time by a C preprocessor macro called skamonkey@3594: ** [limits | SQLITE_MAX_NAME]. skamonkey@3594: ** (The "_LIMIT_" in the name is changed to "_MAX_".))^ skamonkey@3594: ** ^Attempts to increase a limit above its hard upper bound are skamonkey@3594: ** silently truncated to the hard upper bound. skamonkey@3594: ** skamonkey@3594: ** ^Regardless of whether or not the limit was changed, the skamonkey@3594: ** [sqlite3_limit()] interface returns the prior value of the limit. skamonkey@3594: ** ^Hence, to find the current value of a limit without changing it, skamonkey@3594: ** simply invoke this interface with the third parameter set to -1. skamonkey@3594: ** skamonkey@3594: ** Run-time limits are intended for use in applications that manage skamonkey@3594: ** both their own internal database and also databases that are controlled skamonkey@3594: ** by untrusted external sources. An example application might be a skamonkey@3594: ** web browser that has its own databases for storing history and skamonkey@3594: ** separate databases controlled by JavaScript applications downloaded skamonkey@3594: ** off the Internet. The internal databases can be given the skamonkey@3594: ** large, default limits. Databases managed by external sources can skamonkey@3594: ** be given much smaller limits designed to prevent a denial of service skamonkey@3594: ** attack. Developers might also want to use the [sqlite3_set_authorizer()] skamonkey@3594: ** interface to further control untrusted SQL. The size of the database skamonkey@3594: ** created by an untrusted script can be contained using the skamonkey@3594: ** [max_page_count] [PRAGMA]. skamonkey@3594: ** skamonkey@3594: ** New run-time limit categories may be added in future releases. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Run-Time Limit Categories skamonkey@3594: ** KEYWORDS: {limit category} {*limit categories} skamonkey@3594: ** skamonkey@3594: ** These constants define various performance limits skamonkey@3594: ** that can be lowered at run-time using [sqlite3_limit()]. skamonkey@3594: ** The synopsis of the meanings of the various limits is shown below. skamonkey@3594: ** Additional information is available at [limits | Limits in SQLite]. skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: ** [[SQLITE_LIMIT_LENGTH]] ^(
SQLITE_LIMIT_LENGTH
skamonkey@3594: **
The maximum size of any string or BLOB or table row, in bytes.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(
SQLITE_LIMIT_SQL_LENGTH
skamonkey@3594: **
The maximum length of an SQL statement, in bytes.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_COLUMN]] ^(
SQLITE_LIMIT_COLUMN
skamonkey@3594: **
The maximum number of columns in a table definition or in the skamonkey@3594: ** result set of a [SELECT] or the maximum number of columns in an index skamonkey@3594: ** or in an ORDER BY or GROUP BY clause.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(
SQLITE_LIMIT_EXPR_DEPTH
skamonkey@3594: **
The maximum depth of the parse tree on any expression.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(
SQLITE_LIMIT_COMPOUND_SELECT
skamonkey@3594: **
The maximum number of terms in a compound SELECT statement.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_VDBE_OP]] ^(
SQLITE_LIMIT_VDBE_OP
skamonkey@3594: **
The maximum number of instructions in a virtual machine program skamonkey@3594: ** used to implement an SQL statement. This limit is not currently skamonkey@3594: ** enforced, though that might be added in some future release of skamonkey@3594: ** SQLite.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(
SQLITE_LIMIT_FUNCTION_ARG
skamonkey@3594: **
The maximum number of arguments on a function.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_ATTACHED]] ^(
SQLITE_LIMIT_ATTACHED
skamonkey@3594: **
The maximum number of [ATTACH | attached databases].)^
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] skamonkey@3594: ** ^(
SQLITE_LIMIT_LIKE_PATTERN_LENGTH
skamonkey@3594: **
The maximum length of the pattern argument to the [LIKE] or skamonkey@3594: ** [GLOB] operators.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_VARIABLE_NUMBER]] skamonkey@3594: ** ^(
SQLITE_LIMIT_VARIABLE_NUMBER
skamonkey@3594: **
The maximum index number of any [parameter] in an SQL statement.)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(
SQLITE_LIMIT_TRIGGER_DEPTH
skamonkey@3594: **
The maximum depth of recursion for triggers.
)^ skamonkey@3594: **
skamonkey@3594: */ skamonkey@3594: #define SQLITE_LIMIT_LENGTH 0 skamonkey@3594: #define SQLITE_LIMIT_SQL_LENGTH 1 skamonkey@3594: #define SQLITE_LIMIT_COLUMN 2 skamonkey@3594: #define SQLITE_LIMIT_EXPR_DEPTH 3 skamonkey@3594: #define SQLITE_LIMIT_COMPOUND_SELECT 4 skamonkey@3594: #define SQLITE_LIMIT_VDBE_OP 5 skamonkey@3594: #define SQLITE_LIMIT_FUNCTION_ARG 6 skamonkey@3594: #define SQLITE_LIMIT_ATTACHED 7 skamonkey@3594: #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 skamonkey@3594: #define SQLITE_LIMIT_VARIABLE_NUMBER 9 skamonkey@3594: #define SQLITE_LIMIT_TRIGGER_DEPTH 10 skamonkey@3594: skamonkey@3594: /* ds@1952: ** CAPI3REF: Compiling An SQL Statement skamonkey@3594: ** KEYWORDS: {SQL statement compiler} ds@1952: ** ds@1952: ** To execute an SQL query, it must first be compiled into a byte-code skamonkey@3594: ** program using one of these routines. skamonkey@3594: ** skamonkey@3594: ** The first argument, "db", is a [database connection] obtained from a skamonkey@3594: ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or skamonkey@3594: ** [sqlite3_open16()]. The database connection must not have been closed. skamonkey@3594: ** skamonkey@3594: ** The second argument, "zSql", is the statement to be compiled, encoded ds@1952: ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() skamonkey@3594: ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() ds@1952: ** use UTF-16. ds@1952: ** skamonkey@3594: ** ^If the nByte argument is less than zero, then zSql is read up to the skamonkey@3594: ** first zero terminator. ^If nByte is non-negative, then it is the maximum skamonkey@3594: ** number of bytes read from zSql. ^When nByte is non-negative, the skamonkey@3594: ** zSql string ends at either the first '\000' or '\u0000' character or skamonkey@3594: ** the nByte-th byte, whichever comes first. If the caller knows skamonkey@3594: ** that the supplied string is nul-terminated, then there is a small skamonkey@3594: ** performance advantage to be gained by passing an nByte parameter that skamonkey@3594: ** is equal to the number of bytes in the input string including skamonkey@3594: ** the nul-terminator bytes as this saves SQLite from having to skamonkey@3594: ** make a copy of the input string. skamonkey@3594: ** skamonkey@3594: ** ^If pzTail is not NULL then *pzTail is made to point to the first byte skamonkey@3594: ** past the end of the first SQL statement in zSql. These routines only skamonkey@3594: ** compile the first statement in zSql, so *pzTail is left pointing to skamonkey@3594: ** what remains uncompiled. skamonkey@3594: ** skamonkey@3594: ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be skamonkey@3594: ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set skamonkey@3594: ** to NULL. ^If the input text contains no SQL (if the input is an empty skamonkey@3594: ** string or a comment) then *ppStmt is set to NULL. skamonkey@3594: ** The calling procedure is responsible for deleting the compiled skamonkey@3594: ** SQL statement using [sqlite3_finalize()] after it has finished with it. skamonkey@3594: ** ppStmt may not be NULL. skamonkey@3594: ** skamonkey@3594: ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; skamonkey@3594: ** otherwise an [error code] is returned. ds@1952: ** ds@1952: ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are ds@1952: ** recommended for all new programs. The two older interfaces are retained ds@1952: ** for backwards compatibility, but their use is discouraged. skamonkey@3594: ** ^In the "v2" interfaces, the prepared statement skamonkey@3594: ** that is returned (the [sqlite3_stmt] object) contains a copy of the ds@1952: ** original SQL text. This causes the [sqlite3_step()] interface to skamonkey@3594: ** behave differently in three ways: ds@1952: ** ds@1952: **
    ds@1952: **
  1. skamonkey@3594: ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it ds@1952: ** always used to do, [sqlite3_step()] will automatically recompile the SQL skamonkey@3594: ** statement and try to run it again. skamonkey@3594: **
    2. skamonkey@3594: ** skamonkey@3594: **
  2. skamonkey@3594: ** ^When an error occurs, [sqlite3_step()] will return one of the detailed skamonkey@3594: ** [error codes] or [extended error codes]. ^The legacy behavior was that skamonkey@3594: ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code skamonkey@3594: ** and the application would have to make a second call to [sqlite3_reset()] skamonkey@3594: ** in order to find the underlying cause of the problem. With the "v2" prepare skamonkey@3594: ** interfaces, the underlying reason for the error is returned immediately. ds@1952: **
    3. ds@1952: ** ds@1952: **
  3. skamonkey@3594: ** ^If the specific value bound to [parameter | host parameter] in the skamonkey@3594: ** WHERE clause might influence the choice of query plan for a statement, skamonkey@3594: ** then the statement will be automatically recompiled, as if there had been skamonkey@3594: ** a schema change, on the first [sqlite3_step()] call following any change skamonkey@3594: ** to the [sqlite3_bind_text | bindings] of that [parameter]. skamonkey@3594: ** ^The specific value of WHERE-clause [parameter] might influence the skamonkey@3594: ** choice of query plan if the parameter is the left-hand side of a [LIKE] skamonkey@3594: ** or [GLOB] operator or if the parameter is compared to an indexed column skamonkey@3594: ** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled. skamonkey@3594: ** the ds@1952: **
    4. ds@1952: **
ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_prepare( ds@1952: sqlite3 *db, /* Database handle */ ds@1952: const char *zSql, /* SQL statement, UTF-8 encoded */ ds@1952: int nByte, /* Maximum length of zSql in bytes. */ ds@1952: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ ds@1952: const char **pzTail /* OUT: Pointer to unused portion of zSql */ ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_prepare_v2( ds@1952: sqlite3 *db, /* Database handle */ ds@1952: const char *zSql, /* SQL statement, UTF-8 encoded */ ds@1952: int nByte, /* Maximum length of zSql in bytes. */ ds@1952: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ ds@1952: const char **pzTail /* OUT: Pointer to unused portion of zSql */ ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_prepare16( ds@1952: sqlite3 *db, /* Database handle */ ds@1952: const void *zSql, /* SQL statement, UTF-16 encoded */ ds@1952: int nByte, /* Maximum length of zSql in bytes. */ ds@1952: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ ds@1952: const void **pzTail /* OUT: Pointer to unused portion of zSql */ ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_prepare16_v2( ds@1952: sqlite3 *db, /* Database handle */ ds@1952: const void *zSql, /* SQL statement, UTF-16 encoded */ ds@1952: int nByte, /* Maximum length of zSql in bytes. */ ds@1952: sqlite3_stmt **ppStmt, /* OUT: Statement handle */ ds@1952: const void **pzTail /* OUT: Pointer to unused portion of zSql */ ds@1952: ); ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Retrieving Statement SQL skamonkey@3594: ** skamonkey@3594: ** ^This interface can be used to retrieve a saved copy of the original skamonkey@3594: ** SQL text used to create a [prepared statement] if that statement was skamonkey@3594: ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Determine If An SQL Statement Writes The Database skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if skamonkey@3594: ** and only if the [prepared statement] X makes no direct changes to skamonkey@3594: ** the content of the database file. skamonkey@3594: ** skamonkey@3594: ** Note that [application-defined SQL functions] or skamonkey@3594: ** [virtual tables] might change the database indirectly as a side effect. skamonkey@3594: ** ^(For example, if an application defines a function "eval()" that skamonkey@3594: ** calls [sqlite3_exec()], then the following SQL statement would skamonkey@3594: ** change the database file through side-effects: skamonkey@3594: ** skamonkey@3594: ** 
skamonkey@3594: **    SELECT eval('DELETE FROM t1') FROM t2;
skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** But because the [SELECT] statement does not change the database file skamonkey@3594: ** directly, sqlite3_stmt_readonly() would still return true.)^ skamonkey@3594: ** skamonkey@3594: ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], skamonkey@3594: ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, skamonkey@3594: ** since the statements themselves do not actually modify the database but skamonkey@3594: ** rather they control the timing of when other statements modify the skamonkey@3594: ** database. ^The [ATTACH] and [DETACH] statements also cause skamonkey@3594: ** sqlite3_stmt_readonly() to return true since, while those statements skamonkey@3594: ** change the configuration of a database connection, they do not make skamonkey@3594: ** changes to the content of the database files on disk. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Determine If A Prepared Statement Has Been Reset skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the skamonkey@3594: ** [prepared statement] S has been stepped at least once using skamonkey@3594: ** [sqlite3_step(S)] but has not run to completion and/or has not skamonkey@3594: ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) skamonkey@3594: ** interface returns false if S is a NULL pointer. If S is not a skamonkey@3594: ** NULL pointer and is not a pointer to a valid [prepared statement] skamonkey@3594: ** object, then the behavior is undefined and probably undesirable. skamonkey@3594: ** skamonkey@3594: ** This interface can be used in combination [sqlite3_next_stmt()] skamonkey@3594: ** to locate all prepared statements associated with a database skamonkey@3594: ** connection that are in need of being reset. This can be used, skamonkey@3594: ** for example, in diagnostic routines to search for prepared skamonkey@3594: ** statements that are holding a transaction open. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Dynamically Typed Value Object skamonkey@3594: ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} skamonkey@3594: ** skamonkey@3594: ** SQLite uses the sqlite3_value object to represent all values skamonkey@3594: ** that can be stored in a database table. SQLite uses dynamic typing skamonkey@3594: ** for the values it stores. ^Values stored in sqlite3_value objects skamonkey@3594: ** can be integers, floating point values, strings, BLOBs, or NULL. skamonkey@3594: ** skamonkey@3594: ** An sqlite3_value object may be either "protected" or "unprotected". skamonkey@3594: ** Some interfaces require a protected sqlite3_value. Other interfaces skamonkey@3594: ** will accept either a protected or an unprotected sqlite3_value. skamonkey@3594: ** Every interface that accepts sqlite3_value arguments specifies skamonkey@3594: ** whether or not it requires a protected sqlite3_value. skamonkey@3594: ** skamonkey@3594: ** The terms "protected" and "unprotected" refer to whether or not skamonkey@3594: ** a mutex is held. An internal mutex is held for a protected skamonkey@3594: ** sqlite3_value object but no mutex is held for an unprotected skamonkey@3594: ** sqlite3_value object. If SQLite is compiled to be single-threaded skamonkey@3594: ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) skamonkey@3594: ** or if SQLite is run in one of reduced mutex modes skamonkey@3594: ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] skamonkey@3594: ** then there is no distinction between protected and unprotected skamonkey@3594: ** sqlite3_value objects and they can be used interchangeably. However, skamonkey@3594: ** for maximum code portability it is recommended that applications skamonkey@3594: ** still make the distinction between protected and unprotected skamonkey@3594: ** sqlite3_value objects even when not strictly required. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_value objects that are passed as parameters into the skamonkey@3594: ** implementation of [application-defined SQL functions] are protected. skamonkey@3594: ** ^The sqlite3_value object returned by skamonkey@3594: ** [sqlite3_column_value()] is unprotected. skamonkey@3594: ** Unprotected sqlite3_value objects may only be used with skamonkey@3594: ** [sqlite3_result_value()] and [sqlite3_bind_value()]. skamonkey@3594: ** The [sqlite3_value_blob | sqlite3_value_type()] family of skamonkey@3594: ** interfaces require protected sqlite3_value objects. ds@1952: */ ds@1952: typedef struct Mem sqlite3_value; ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: SQL Function Context Object ds@1952: ** ds@1952: ** The context in which an SQL function executes is stored in an skamonkey@3594: ** sqlite3_context object. ^A pointer to an sqlite3_context object skamonkey@3594: ** is always first parameter to [application-defined SQL functions]. skamonkey@3594: ** The application-defined SQL function implementation will pass this skamonkey@3594: ** pointer through into calls to [sqlite3_result_int | sqlite3_result()], skamonkey@3594: ** [sqlite3_aggregate_context()], [sqlite3_user_data()], skamonkey@3594: ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], skamonkey@3594: ** and/or [sqlite3_set_auxdata()]. ds@1952: */ ds@1952: typedef struct sqlite3_context sqlite3_context; ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Binding Values To Prepared Statements skamonkey@3594: ** KEYWORDS: {host parameter} {host parameters} {host parameter name} skamonkey@3594: ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} skamonkey@3594: ** skamonkey@3594: ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, skamonkey@3594: ** literals may be replaced by a [parameter] that matches one of following skamonkey@3594: ** templates: ds@1952: ** ds@1952: ** ds@1952: ** skamonkey@3594: ** In the templates above, NNN represents an integer literal, skamonkey@3594: ** and VVV represents an alphanumeric identifier.)^ ^The values of these skamonkey@3594: ** parameters (also called "host parameter names" or "SQL parameters") ds@1952: ** can be set using the sqlite3_bind_*() routines defined here. ds@1952: ** skamonkey@3594: ** ^The first argument to the sqlite3_bind_*() routines is always skamonkey@3594: ** a pointer to the [sqlite3_stmt] object returned from skamonkey@3594: ** [sqlite3_prepare_v2()] or its variants. skamonkey@3594: ** skamonkey@3594: ** ^The second argument is the index of the SQL parameter to be set. skamonkey@3594: ** ^The leftmost SQL parameter has an index of 1. ^When the same named skamonkey@3594: ** SQL parameter is used more than once, second and subsequent skamonkey@3594: ** occurrences have the same index as the first occurrence. skamonkey@3594: ** ^The index for named parameters can be looked up using the skamonkey@3594: ** [sqlite3_bind_parameter_index()] API if desired. ^The index skamonkey@3594: ** for "?NNN" parameters is the value of NNN. skamonkey@3594: ** ^The NNN value must be between 1 and the [sqlite3_limit()] skamonkey@3594: ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). skamonkey@3594: ** skamonkey@3594: ** ^The third argument is the value to bind to the parameter. skamonkey@3594: ** skamonkey@3594: ** ^(In those routines that have a fourth argument, its value is the skamonkey@3594: ** number of bytes in the parameter. To be clear: the value is the skamonkey@3594: ** number of bytes in the value, not the number of characters.)^ skamonkey@3594: ** ^If the fourth parameter is negative, the length of the string is skamonkey@3594: ** the number of bytes up to the first zero terminator. skamonkey@3594: ** If a non-negative fourth parameter is provided to sqlite3_bind_text() skamonkey@3594: ** or sqlite3_bind_text16() then that parameter must be the byte offset skamonkey@3594: ** where the NUL terminator would occur assuming the string were NUL skamonkey@3594: ** terminated. If any NUL characters occur at byte offsets less than skamonkey@3594: ** the value of the fourth parameter then the resulting string value will skamonkey@3594: ** contain embedded NULs. The result of expressions involving strings skamonkey@3594: ** with embedded NULs is undefined. skamonkey@3594: ** skamonkey@3594: ** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and ds@1952: ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or skamonkey@3594: ** string after SQLite has finished with it. ^The destructor is called skamonkey@3594: ** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(), skamonkey@3594: ** sqlite3_bind_text(), or sqlite3_bind_text16() fails. skamonkey@3594: ** ^If the fifth argument is skamonkey@3594: ** the special value [SQLITE_STATIC], then SQLite assumes that the skamonkey@3594: ** information is in static, unmanaged space and does not need to be freed. skamonkey@3594: ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then skamonkey@3594: ** SQLite makes its own private copy of the data immediately, before skamonkey@3594: ** the sqlite3_bind_*() routine returns. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that skamonkey@3594: ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory skamonkey@3594: ** (just an integer to hold its size) while it is being processed. skamonkey@3594: ** Zeroblobs are intended to serve as placeholders for BLOBs whose skamonkey@3594: ** content is later written using skamonkey@3594: ** [sqlite3_blob_open | incremental BLOB I/O] routines. skamonkey@3594: ** ^A negative value for the zeroblob results in a zero-length BLOB. skamonkey@3594: ** skamonkey@3594: ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer skamonkey@3594: ** for the [prepared statement] or with a prepared statement for which skamonkey@3594: ** [sqlite3_step()] has been called more recently than [sqlite3_reset()], skamonkey@3594: ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() skamonkey@3594: ** routine is passed a [prepared statement] that has been finalized, the skamonkey@3594: ** result is undefined and probably harmful. skamonkey@3594: ** skamonkey@3594: ** ^Bindings are not cleared by the [sqlite3_reset()] routine. skamonkey@3594: ** ^Unbound parameters are interpreted as NULL. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an skamonkey@3594: ** [error code] if anything goes wrong. skamonkey@3594: ** ^[SQLITE_RANGE] is returned if the parameter skamonkey@3594: ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_bind_parameter_count()], skamonkey@3594: ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); skamonkey@3594: SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); skamonkey@3594: SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); skamonkey@3594: SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); skamonkey@3594: SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); skamonkey@3594: SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); skamonkey@3594: SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); skamonkey@3594: SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); skamonkey@3594: SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Number Of SQL Parameters skamonkey@3594: ** skamonkey@3594: ** ^This routine can be used to find the number of [SQL parameters] skamonkey@3594: ** in a [prepared statement]. SQL parameters are tokens of the skamonkey@3594: ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as skamonkey@3594: ** placeholders for values that are [sqlite3_bind_blob | bound] skamonkey@3594: ** to the parameters at a later time. skamonkey@3594: ** skamonkey@3594: ** ^(This routine actually returns the index of the largest (rightmost) skamonkey@3594: ** parameter. For all forms except ?NNN, this will correspond to the skamonkey@3594: ** number of unique parameters. If parameters of the ?NNN form are used, skamonkey@3594: ** there may be gaps in the list.)^ skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_bind_blob|sqlite3_bind()], skamonkey@3594: ** [sqlite3_bind_parameter_name()], and skamonkey@3594: ** [sqlite3_bind_parameter_index()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Name Of A Host Parameter ds@1952: ** skamonkey@3594: ** ^The sqlite3_bind_parameter_name(P,N) interface returns skamonkey@3594: ** the name of the N-th [SQL parameter] in the [prepared statement] P. skamonkey@3594: ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" skamonkey@3594: ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" skamonkey@3594: ** respectively. skamonkey@3594: ** In other words, the initial ":" or "$" or "@" or "?" skamonkey@3594: ** is included as part of the name.)^ skamonkey@3594: ** ^Parameters of the form "?" without a following integer have no name skamonkey@3594: ** and are referred to as "nameless" or "anonymous parameters". skamonkey@3594: ** skamonkey@3594: ** ^The first host parameter has an index of 1, not 0. skamonkey@3594: ** skamonkey@3594: ** ^If the value N is out of range or if the N-th parameter is skamonkey@3594: ** nameless, then NULL is returned. ^The returned string is skamonkey@3594: ** always in UTF-8 encoding even if the named parameter was skamonkey@3594: ** originally specified as UTF-16 in [sqlite3_prepare16()] or skamonkey@3594: ** [sqlite3_prepare16_v2()]. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_bind_blob|sqlite3_bind()], skamonkey@3594: ** [sqlite3_bind_parameter_count()], and skamonkey@3594: ** [sqlite3_bind_parameter_index()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Index Of A Parameter With A Given Name ds@1952: ** skamonkey@3594: ** ^Return the index of an SQL parameter given its name. ^The skamonkey@3594: ** index value returned is suitable for use as the second skamonkey@3594: ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero skamonkey@3594: ** is returned if no matching parameter is found. ^The parameter skamonkey@3594: ** name must be given in UTF-8 even if the original statement skamonkey@3594: ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_bind_blob|sqlite3_bind()], skamonkey@3594: ** [sqlite3_bind_parameter_count()], and skamonkey@3594: ** [sqlite3_bind_parameter_index()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Reset All Bindings On A Prepared Statement ds@1952: ** skamonkey@3594: ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset skamonkey@3594: ** the [sqlite3_bind_blob | bindings] on a [prepared statement]. skamonkey@3594: ** ^Use this routine to reset all host parameters to NULL. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Number Of Columns In A Result Set ds@1952: ** skamonkey@3594: ** ^Return the number of columns in the result set returned by the skamonkey@3594: ** [prepared statement]. ^This routine returns 0 if pStmt is an SQL skamonkey@3594: ** statement that does not return data (for example an [UPDATE]). skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_data_count()] skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Column Names In A Result Set ds@1952: ** skamonkey@3594: ** ^These routines return the name assigned to a particular column skamonkey@3594: ** in the result set of a [SELECT] statement. ^The sqlite3_column_name() skamonkey@3594: ** interface returns a pointer to a zero-terminated UTF-8 string skamonkey@3594: ** and sqlite3_column_name16() returns a pointer to a zero-terminated skamonkey@3594: ** UTF-16 string. ^The first parameter is the [prepared statement] skamonkey@3594: ** that implements the [SELECT] statement. ^The second parameter is the skamonkey@3594: ** column number. ^The leftmost column is number 0. skamonkey@3594: ** skamonkey@3594: ** ^The returned string pointer is valid until either the [prepared statement] skamonkey@3594: ** is destroyed by [sqlite3_finalize()] or until the statement is automatically skamonkey@3594: ** reprepared by the first call to [sqlite3_step()] for a particular run skamonkey@3594: ** or until the next call to skamonkey@3594: ** sqlite3_column_name() or sqlite3_column_name16() on the same column. skamonkey@3594: ** skamonkey@3594: ** ^If sqlite3_malloc() fails during the processing of either routine ds@1952: ** (for example during a conversion from UTF-8 to UTF-16) then a ds@1952: ** NULL pointer is returned. skamonkey@3594: ** skamonkey@3594: ** ^The name of a result column is the value of the "AS" clause for skamonkey@3594: ** that column, if there is an AS clause. If there is no AS clause skamonkey@3594: ** then the name of the column is unspecified and may change from skamonkey@3594: ** one release of SQLite to the next. skamonkey@3594: */ skamonkey@3594: SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); skamonkey@3594: SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Source Of Data In A Query Result ds@1952: ** skamonkey@3594: ** ^These routines provide a means to determine the database, table, and skamonkey@3594: ** table column that is the origin of a particular result column in skamonkey@3594: ** [SELECT] statement. skamonkey@3594: ** ^The name of the database or table or column can be returned as skamonkey@3594: ** either a UTF-8 or UTF-16 string. ^The _database_ routines return ds@1952: ** the database name, the _table_ routines return the table name, and ds@1952: ** the origin_ routines return the column name. skamonkey@3594: ** ^The returned string is valid until the [prepared statement] is destroyed skamonkey@3594: ** using [sqlite3_finalize()] or until the statement is automatically skamonkey@3594: ** reprepared by the first call to [sqlite3_step()] for a particular run skamonkey@3594: ** or until the same information is requested ds@1952: ** again in a different encoding. ds@1952: ** skamonkey@3594: ** ^The names returned are the original un-aliased names of the ds@1952: ** database, table, and column. ds@1952: ** skamonkey@3594: ** ^The first argument to these interfaces is a [prepared statement]. skamonkey@3594: ** ^These functions return information about the Nth result column returned by ds@1952: ** the statement, where N is the second function argument. skamonkey@3594: ** ^The left-most column is column 0 for these routines. skamonkey@3594: ** skamonkey@3594: ** ^If the Nth column returned by the statement is an expression or skamonkey@3594: ** subquery and is not a column value, then all of these functions return skamonkey@3594: ** NULL. ^These routine might also return NULL if a memory allocation error skamonkey@3594: ** occurs. ^Otherwise, they return the name of the attached database, table, skamonkey@3594: ** or column that query result column was extracted from. skamonkey@3594: ** skamonkey@3594: ** ^As with all other SQLite APIs, those whose names end with "16" return skamonkey@3594: ** UTF-16 encoded strings and the other functions return UTF-8. skamonkey@3594: ** skamonkey@3594: ** ^These APIs are only available if the library was compiled with the skamonkey@3594: ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. ds@1952: ** ds@1952: ** If two or more threads call one or more of these routines against the same ds@1952: ** prepared statement and column at the same time then the results are ds@1952: ** undefined. skamonkey@3594: ** skamonkey@3594: ** If two or more threads call one or more skamonkey@3594: ** [sqlite3_column_database_name | column metadata interfaces] skamonkey@3594: ** for the same [prepared statement] and result column skamonkey@3594: ** at the same time then the results are undefined. skamonkey@3594: */ skamonkey@3594: SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); skamonkey@3594: SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); skamonkey@3594: SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); skamonkey@3594: SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); skamonkey@3594: SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); skamonkey@3594: SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Declared Datatype Of A Query Result ds@1952: ** skamonkey@3594: ** ^(The first parameter is a [prepared statement]. skamonkey@3594: ** If this statement is a [SELECT] statement and the Nth column of the skamonkey@3594: ** returned result set of that [SELECT] is a table column (not an ds@1952: ** expression or subquery) then the declared type of the table skamonkey@3594: ** column is returned.)^ ^If the Nth column of the result set is an ds@1952: ** expression or subquery, then a NULL pointer is returned. skamonkey@3594: ** ^The returned string is always UTF-8 encoded. skamonkey@3594: ** skamonkey@3594: ** ^(For example, given the database schema: ds@1952: ** ds@1952: ** CREATE TABLE t1(c1 VARIANT); ds@1952: ** skamonkey@3594: ** and the following statement to be compiled: ds@1952: ** ds@1952: ** SELECT c1 + 1, c1 FROM t1; ds@1952: ** skamonkey@3594: ** this routine would return the string "VARIANT" for the second result skamonkey@3594: ** column (i==1), and a NULL pointer for the first result column (i==0).)^ skamonkey@3594: ** skamonkey@3594: ** ^SQLite uses dynamic run-time typing. ^So just because a column ds@1952: ** is declared to contain a particular type does not mean that the ds@1952: ** data stored in that column is of the declared type. SQLite is skamonkey@3594: ** strongly typed, but the typing is dynamic not static. ^Type ds@1952: ** is associated with individual values, not with the containers ds@1952: ** used to hold those values. ds@1952: */ skamonkey@3594: SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); skamonkey@3594: SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Evaluate An SQL Statement skamonkey@3594: ** skamonkey@3594: ** After a [prepared statement] has been prepared using either skamonkey@3594: ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy skamonkey@3594: ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function skamonkey@3594: ** must be called one or more times to evaluate the statement. skamonkey@3594: ** skamonkey@3594: ** The details of the behavior of the sqlite3_step() interface depend ds@1952: ** on whether the statement was prepared using the newer "v2" interface ds@1952: ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy ds@1952: ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the ds@1952: ** new "v2" interface is recommended for new applications but the legacy ds@1952: ** interface will continue to be supported. ds@1952: ** skamonkey@3594: ** ^In the legacy interface, the return value will be either [SQLITE_BUSY], ds@1952: ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. skamonkey@3594: ** ^With the "v2" interface, any of the other [result codes] or skamonkey@3594: ** [extended result codes] might be returned as well. skamonkey@3594: ** skamonkey@3594: ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the skamonkey@3594: ** database locks it needs to do its job. ^If the statement is a [COMMIT] ds@1952: ** or occurs outside of an explicit transaction, then you can retry the skamonkey@3594: ** statement. If the statement is not a [COMMIT] and occurs within an ds@1952: ** explicit transaction then you should rollback the transaction before ds@1952: ** continuing. ds@1952: ** skamonkey@3594: ** ^[SQLITE_DONE] means that the statement has finished executing ds@1952: ** successfully. sqlite3_step() should not be called again on this virtual ds@1952: ** machine without first calling [sqlite3_reset()] to reset the virtual ds@1952: ** machine back to its initial state. ds@1952: ** skamonkey@3594: ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] skamonkey@3594: ** is returned each time a new row of data is ready for processing by the skamonkey@3594: ** caller. The values may be accessed using the [column access functions]. ds@1952: ** sqlite3_step() is called again to retrieve the next row of data. skamonkey@3594: ** skamonkey@3594: ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint ds@1952: ** violation) has occurred. sqlite3_step() should not be called again on ds@1952: ** the VM. More information may be found by calling [sqlite3_errmsg()]. skamonkey@3594: ** ^With the legacy interface, a more specific error code (for example, ds@1952: ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) ds@1952: ** can be obtained by calling [sqlite3_reset()] on the skamonkey@3594: ** [prepared statement]. ^In the "v2" interface, ds@1952: ** the more specific error code is returned directly by sqlite3_step(). ds@1952: ** ds@1952: ** [SQLITE_MISUSE] means that the this routine was called inappropriately. skamonkey@3594: ** Perhaps it was called on a [prepared statement] that has skamonkey@3594: ** already been [sqlite3_finalize | finalized] or on one that had ds@1952: ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could ds@1952: ** be the case that the same database connection is being used by two or ds@1952: ** more threads at the same moment in time. ds@1952: ** skamonkey@3594: ** For all versions of SQLite up to and including 3.6.23.1, a call to skamonkey@3594: ** [sqlite3_reset()] was required after sqlite3_step() returned anything skamonkey@3594: ** other than [SQLITE_ROW] before any subsequent invocation of skamonkey@3594: ** sqlite3_step(). Failure to reset the prepared statement using skamonkey@3594: ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from skamonkey@3594: ** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began skamonkey@3594: ** calling [sqlite3_reset()] automatically in this circumstance rather skamonkey@3594: ** than returning [SQLITE_MISUSE]. This is not considered a compatibility skamonkey@3594: ** break because any application that ever receives an SQLITE_MISUSE error skamonkey@3594: ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option skamonkey@3594: ** can be used to restore the legacy behavior. skamonkey@3594: ** skamonkey@3594: ** Goofy Interface Alert: In the legacy interface, the sqlite3_step() skamonkey@3594: ** API always returns a generic error code, [SQLITE_ERROR], following any skamonkey@3594: ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call skamonkey@3594: ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the skamonkey@3594: ** specific [error codes] that better describes the error. ds@1952: ** We admit that this is a goofy design. The problem has been fixed ds@1952: ** with the "v2" interface. If you prepare all of your SQL statements ds@1952: ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead skamonkey@3594: ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, skamonkey@3594: ** then the more specific [error codes] are returned directly ds@1952: ** by sqlite3_step(). The use of the "v2" interface is recommended. ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_step(sqlite3_stmt*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Number of columns in a result set skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_data_count(P) interface returns the number of columns in the skamonkey@3594: ** current row of the result set of [prepared statement] P. skamonkey@3594: ** ^If prepared statement P does not have results ready to return skamonkey@3594: ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of skamonkey@3594: ** interfaces) then sqlite3_data_count(P) returns 0. skamonkey@3594: ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. skamonkey@3594: ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to skamonkey@3594: ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P) skamonkey@3594: ** will return non-zero if previous call to [sqlite3_step](P) returned skamonkey@3594: ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] skamonkey@3594: ** where it always returns zero since each step of that multi-step skamonkey@3594: ** pragma returns 0 columns of data. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_column_count()] skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Fundamental Datatypes skamonkey@3594: ** KEYWORDS: SQLITE_TEXT skamonkey@3594: ** skamonkey@3594: ** ^(Every value in SQLite has one of five fundamental datatypes: ds@1952: ** ds@1952: ** )^ ds@1952: ** ds@1952: ** These constants are codes for each of those types. ds@1952: ** ds@1952: ** Note that the SQLITE_TEXT constant was also used in SQLite version 2 ds@1952: ** for a completely different meaning. Software that links against both skamonkey@3594: ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not ds@1952: ** SQLITE_TEXT. ds@1952: */ ds@1952: #define SQLITE_INTEGER 1 ds@1952: #define SQLITE_FLOAT 2 ds@1952: #define SQLITE_BLOB 4 ds@1952: #define SQLITE_NULL 5 ds@1952: #ifdef SQLITE_TEXT ds@1952: # undef SQLITE_TEXT ds@1952: #else ds@1952: # define SQLITE_TEXT 3 ds@1952: #endif ds@1952: #define SQLITE3_TEXT 3 ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Result Values From A Query skamonkey@3594: ** KEYWORDS: {column access functions} skamonkey@3594: ** skamonkey@3594: ** These routines form the "result set" interface. skamonkey@3594: ** skamonkey@3594: ** ^These routines return information about a single column of the current skamonkey@3594: ** result row of a query. ^In every case the first argument is a pointer skamonkey@3594: ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] skamonkey@3594: ** that was returned from [sqlite3_prepare_v2()] or one of its variants) skamonkey@3594: ** and the second argument is the index of the column for which information skamonkey@3594: ** should be returned. ^The leftmost column of the result set has the index 0. skamonkey@3594: ** ^The number of columns in the result can be determined using skamonkey@3594: ** [sqlite3_column_count()]. skamonkey@3594: ** skamonkey@3594: ** If the SQL statement does not currently point to a valid row, or if the skamonkey@3594: ** column index is out of range, the result is undefined. ds@1952: ** These routines may only be called when the most recent call to ds@1952: ** [sqlite3_step()] has returned [SQLITE_ROW] and neither skamonkey@3594: ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. ds@1952: ** If any of these routines are called after [sqlite3_reset()] or ds@1952: ** [sqlite3_finalize()] or after [sqlite3_step()] has returned ds@1952: ** something other than [SQLITE_ROW], the results are undefined. ds@1952: ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] ds@1952: ** are called from a different thread while any of these routines skamonkey@3594: ** are pending, then the results are undefined. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_column_type() routine returns the ds@1952: ** [SQLITE_INTEGER | datatype code] for the initial data type skamonkey@3594: ** of the result column. ^The returned value is one of [SQLITE_INTEGER], ds@1952: ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value ds@1952: ** returned by sqlite3_column_type() is only meaningful if no type ds@1952: ** conversions have occurred as described below. After a type conversion, ds@1952: ** the value returned by sqlite3_column_type() is undefined. Future ds@1952: ** versions of SQLite may change the behavior of sqlite3_column_type() ds@1952: ** following a type conversion. ds@1952: ** skamonkey@3594: ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() ds@1952: ** routine returns the number of bytes in that BLOB or string. skamonkey@3594: ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts ds@1952: ** the string to UTF-8 and then returns the number of bytes. skamonkey@3594: ** ^If the result is a numeric value then sqlite3_column_bytes() uses ds@1952: ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns ds@1952: ** the number of bytes in that string. skamonkey@3594: ** ^If the result is NULL, then sqlite3_column_bytes() returns zero. skamonkey@3594: ** skamonkey@3594: ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() skamonkey@3594: ** routine returns the number of bytes in that BLOB or string. skamonkey@3594: ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts skamonkey@3594: ** the string to UTF-16 and then returns the number of bytes. skamonkey@3594: ** ^If the result is a numeric value then sqlite3_column_bytes16() uses skamonkey@3594: ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns skamonkey@3594: ** the number of bytes in that string. skamonkey@3594: ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. skamonkey@3594: ** skamonkey@3594: ** ^The values returned by [sqlite3_column_bytes()] and skamonkey@3594: ** [sqlite3_column_bytes16()] do not include the zero terminators at the end skamonkey@3594: ** of the string. ^For clarity: the values returned by skamonkey@3594: ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of ds@1952: ** bytes in the string, not the number of characters. ds@1952: ** skamonkey@3594: ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), skamonkey@3594: ** even empty strings, are always zero-terminated. ^The return skamonkey@3594: ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. skamonkey@3594: ** skamonkey@3594: ** ^The object returned by [sqlite3_column_value()] is an skamonkey@3594: ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object skamonkey@3594: ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. skamonkey@3594: ** If the [unprotected sqlite3_value] object returned by skamonkey@3594: ** [sqlite3_column_value()] is used in any other way, including calls skamonkey@3594: ** to routines like [sqlite3_value_int()], [sqlite3_value_text()], skamonkey@3594: ** or [sqlite3_value_bytes()], then the behavior is undefined. skamonkey@3594: ** skamonkey@3594: ** These routines attempt to convert the value where appropriate. ^For ds@1952: ** example, if the internal representation is FLOAT and a text result skamonkey@3594: ** is requested, [sqlite3_snprintf()] is used internally to perform the skamonkey@3594: ** conversion automatically. ^(The following table details the conversions skamonkey@3594: ** that are applied: ds@1952: ** ds@1952: **
ds@1952: ** ds@1952: **
Internal
Type 		Requested
Type 		Conversion ds@1952: ** ds@1952: **
NULL INTEGER Result is 0 ds@1952: **
NULL FLOAT Result is 0.0 ds@1952: **
NULL TEXT Result is NULL pointer ds@1952: **
NULL BLOB Result is NULL pointer ds@1952: **
INTEGER FLOAT Convert from integer to float ds@1952: **
INTEGER TEXT ASCII rendering of the integer skamonkey@3594: **
INTEGER BLOB Same as INTEGER->TEXT ds@1952: **
FLOAT INTEGER Convert from float to integer ds@1952: **
FLOAT TEXT ASCII rendering of the float ds@1952: **
FLOAT BLOB Same as FLOAT->TEXT ds@1952: **
TEXT INTEGER Use atoi() ds@1952: **
TEXT FLOAT Use atof() ds@1952: **
TEXT BLOB No change ds@1952: **
BLOB INTEGER Convert to TEXT then use atoi() ds@1952: **
BLOB FLOAT Convert to TEXT then use atof() ds@1952: **
BLOB TEXT Add a zero terminator if needed ds@1952: **
skamonkey@3594: **
)^ ds@1952: ** ds@1952: ** The table above makes reference to standard C library functions atoi() ds@1952: ** and atof(). SQLite does not really use these functions. It has its skamonkey@3594: ** own equivalent internal routines. The atoi() and atof() names are ds@1952: ** used in the table for brevity and because they are familiar to most ds@1952: ** C programmers. ds@1952: ** ds@1952: ** Note that when type conversions occur, pointers returned by prior ds@1952: ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or skamonkey@3594: ** sqlite3_column_text16() may be invalidated. ds@1952: ** Type conversions and pointer invalidations might occur ds@1952: ** in the following cases: ds@1952: ** ds@1952: ** ds@1952: ** skamonkey@3594: ** ^Conversions between UTF-16be and UTF-16le are always done in place and do ds@1952: ** not invalidate a prior pointer, though of course the content of the buffer skamonkey@3594: ** that the prior pointer references will have been modified. Other kinds skamonkey@3594: ** of conversion are done in place when it is possible, but sometimes they skamonkey@3594: ** are not possible and in those cases prior pointers are invalidated. ds@1952: ** ds@1952: ** The safest and easiest to remember policy is to invoke these routines ds@1952: ** in one of the following ways: ds@1952: ** skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: ** In other words, you should call sqlite3_column_text(), skamonkey@3594: ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result skamonkey@3594: ** into the desired format, then invoke sqlite3_column_bytes() or skamonkey@3594: ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls skamonkey@3594: ** to sqlite3_column_text() or sqlite3_column_blob() with calls to skamonkey@3594: ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() skamonkey@3594: ** with calls to sqlite3_column_bytes(). skamonkey@3594: ** skamonkey@3594: ** ^The pointers returned are valid until a type conversion occurs as ds@1952: ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or skamonkey@3594: ** [sqlite3_finalize()] is called. ^The memory space used to hold strings skamonkey@3594: ** and BLOBs is freed automatically. Do not pass the pointers returned skamonkey@3594: ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into ds@1952: ** [sqlite3_free()]. ds@1952: ** skamonkey@3594: ** ^(If a memory allocation error occurs during the evaluation of any ds@1952: ** of these routines, a default value is returned. The default value ds@1952: ** is either the integer 0, the floating point number 0.0, or a NULL ds@1952: ** pointer. Subsequent calls to [sqlite3_errcode()] will return skamonkey@3594: ** [SQLITE_NOMEM].)^ skamonkey@3594: */ skamonkey@3594: SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); skamonkey@3594: SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Destroy A Prepared Statement Object ds@1952: ** skamonkey@3594: ** ^The sqlite3_finalize() function is called to delete a [prepared statement]. skamonkey@3594: ** ^If the most recent evaluation of the statement encountered no errors skamonkey@3594: ** or if the statement is never been evaluated, then sqlite3_finalize() returns skamonkey@3594: ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then skamonkey@3594: ** sqlite3_finalize(S) returns the appropriate [error code] or skamonkey@3594: ** [extended error code]. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_finalize(S) routine can be called at any point during skamonkey@3594: ** the life cycle of [prepared statement] S: skamonkey@3594: ** before statement S is ever evaluated, after skamonkey@3594: ** one or more calls to [sqlite3_reset()], or after any call skamonkey@3594: ** to [sqlite3_step()] regardless of whether or not the statement has skamonkey@3594: ** completed execution. skamonkey@3594: ** skamonkey@3594: ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. skamonkey@3594: ** skamonkey@3594: ** The application must finalize every [prepared statement] in order to avoid skamonkey@3594: ** resource leaks. It is a grievous error for the application to try to use skamonkey@3594: ** a prepared statement after it has been finalized. Any use of a prepared skamonkey@3594: ** statement after it has been finalized can result in undefined and skamonkey@3594: ** undesirable behavior such as segfaults and heap corruption. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Reset A Prepared Statement Object ds@1952: ** skamonkey@3594: ** The sqlite3_reset() function is called to reset a [prepared statement] skamonkey@3594: ** object back to its initial state, ready to be re-executed. skamonkey@3594: ** ^Any SQL statement variables that had values bound to them using ds@1952: ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. ds@1952: ** Use [sqlite3_clear_bindings()] to reset the bindings. skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S skamonkey@3594: ** back to the beginning of its program. skamonkey@3594: ** skamonkey@3594: ** ^If the most recent call to [sqlite3_step(S)] for the skamonkey@3594: ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], skamonkey@3594: ** or if [sqlite3_step(S)] has never before been called on S, skamonkey@3594: ** then [sqlite3_reset(S)] returns [SQLITE_OK]. skamonkey@3594: ** skamonkey@3594: ** ^If the most recent call to [sqlite3_step(S)] for the skamonkey@3594: ** [prepared statement] S indicated an error, then skamonkey@3594: ** [sqlite3_reset(S)] returns an appropriate [error code]. skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_reset(S)] interface does not change the values skamonkey@3594: ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Create Or Redefine SQL Functions skamonkey@3594: ** KEYWORDS: {function creation routines} skamonkey@3594: ** KEYWORDS: {application-defined SQL function} skamonkey@3594: ** KEYWORDS: {application-defined SQL functions} skamonkey@3594: ** skamonkey@3594: ** ^These functions (collectively known as "function creation routines") skamonkey@3594: ** are used to add SQL functions or aggregates or to redefine the behavior skamonkey@3594: ** of existing SQL functions or aggregates. The only differences between skamonkey@3594: ** these routines are the text encoding expected for skamonkey@3594: ** the second parameter (the name of the function being created) skamonkey@3594: ** and the presence or absence of a destructor callback for skamonkey@3594: ** the application data pointer. skamonkey@3594: ** skamonkey@3594: ** ^The first parameter is the [database connection] to which the SQL skamonkey@3594: ** function is to be added. ^If an application uses more than one database skamonkey@3594: ** connection then application-defined SQL functions must be added skamonkey@3594: ** to each database connection separately. skamonkey@3594: ** skamonkey@3594: ** ^The second parameter is the name of the SQL function to be created or skamonkey@3594: ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 skamonkey@3594: ** representation, exclusive of the zero-terminator. ^Note that the name skamonkey@3594: ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. skamonkey@3594: ** ^Any attempt to create a function with a longer name skamonkey@3594: ** will result in [SQLITE_MISUSE] being returned. skamonkey@3594: ** skamonkey@3594: ** ^The third parameter (nArg) skamonkey@3594: ** is the number of arguments that the SQL function or skamonkey@3594: ** aggregate takes. ^If this parameter is -1, then the SQL function or skamonkey@3594: ** aggregate may take any number of arguments between 0 and the limit skamonkey@3594: ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third skamonkey@3594: ** parameter is less than -1 or greater than 127 then the behavior is skamonkey@3594: ** undefined. skamonkey@3594: ** skamonkey@3594: ** ^The fourth parameter, eTextRep, specifies what ds@1952: ** [SQLITE_UTF8 | text encoding] this SQL function prefers for skamonkey@3594: ** its parameters. Every SQL function implementation must be able to work skamonkey@3594: ** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be skamonkey@3594: ** more efficient with one encoding than another. ^An application may ds@1952: ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple ds@1952: ** times with the same function but with different values of eTextRep. skamonkey@3594: ** ^When multiple implementations of the same function are available, SQLite ds@1952: ** will pick the one that involves the least amount of data conversion. skamonkey@3594: ** If there is only a single implementation which does not care what text skamonkey@3594: ** encoding is used, then the fourth argument should be [SQLITE_ANY]. skamonkey@3594: ** skamonkey@3594: ** ^(The fifth parameter is an arbitrary pointer. The implementation of the skamonkey@3594: ** function can gain access to this pointer using [sqlite3_user_data()].)^ skamonkey@3594: ** skamonkey@3594: ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are skamonkey@3594: ** pointers to C-language functions that implement the SQL function or skamonkey@3594: ** aggregate. ^A scalar SQL function requires an implementation of the xFunc skamonkey@3594: ** callback only; NULL pointers must be passed as the xStep and xFinal skamonkey@3594: ** parameters. ^An aggregate SQL function requires an implementation of xStep skamonkey@3594: ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing skamonkey@3594: ** SQL function or aggregate, pass NULL pointers for all three function skamonkey@3594: ** callbacks. skamonkey@3594: ** skamonkey@3594: ** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, skamonkey@3594: ** then it is destructor for the application data pointer. skamonkey@3594: ** The destructor is invoked when the function is deleted, either by being skamonkey@3594: ** overloaded or when the database connection closes.)^ skamonkey@3594: ** ^The destructor is also invoked if the call to skamonkey@3594: ** sqlite3_create_function_v2() fails. skamonkey@3594: ** ^When the destructor callback of the tenth parameter is invoked, it skamonkey@3594: ** is passed a single argument which is a copy of the application data skamonkey@3594: ** pointer which was the fifth parameter to sqlite3_create_function_v2(). skamonkey@3594: ** skamonkey@3594: ** ^It is permitted to register multiple implementations of the same ds@1952: ** functions with the same name but with either differing numbers of skamonkey@3594: ** arguments or differing preferred text encodings. ^SQLite will use skamonkey@3594: ** the implementation that most closely matches the way in which the skamonkey@3594: ** SQL function is used. ^A function implementation with a non-negative skamonkey@3594: ** nArg parameter is a better match than a function implementation with skamonkey@3594: ** a negative nArg. ^A function where the preferred text encoding skamonkey@3594: ** matches the database encoding is a better skamonkey@3594: ** match than a function where the encoding is different. skamonkey@3594: ** ^A function where the encoding difference is between UTF16le and UTF16be skamonkey@3594: ** is a closer match than a function where the encoding difference is skamonkey@3594: ** between UTF8 and UTF16. skamonkey@3594: ** skamonkey@3594: ** ^Built-in functions may be overloaded by new application-defined functions. skamonkey@3594: ** skamonkey@3594: ** ^An application-defined function is permitted to call other skamonkey@3594: ** SQLite interfaces. However, such calls must not skamonkey@3594: ** close the database connection nor finalize or reset the prepared skamonkey@3594: ** statement in which the function is running. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_create_function( skamonkey@3594: sqlite3 *db, ds@1952: const char *zFunctionName, ds@1952: int nArg, ds@1952: int eTextRep, skamonkey@3594: void *pApp, ds@1952: void (*xFunc)(sqlite3_context*,int,sqlite3_value**), ds@1952: void (*xStep)(sqlite3_context*,int,sqlite3_value**), ds@1952: void (*xFinal)(sqlite3_context*) ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_create_function16( skamonkey@3594: sqlite3 *db, ds@1952: const void *zFunctionName, ds@1952: int nArg, ds@1952: int eTextRep, skamonkey@3594: void *pApp, ds@1952: void (*xFunc)(sqlite3_context*,int,sqlite3_value**), ds@1952: void (*xStep)(sqlite3_context*,int,sqlite3_value**), ds@1952: void (*xFinal)(sqlite3_context*) ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_create_function_v2( skamonkey@3594: sqlite3 *db, skamonkey@3594: const char *zFunctionName, skamonkey@3594: int nArg, skamonkey@3594: int eTextRep, skamonkey@3594: void *pApp, skamonkey@3594: void (*xFunc)(sqlite3_context*,int,sqlite3_value**), skamonkey@3594: void (*xStep)(sqlite3_context*,int,sqlite3_value**), skamonkey@3594: void (*xFinal)(sqlite3_context*), skamonkey@3594: void(*xDestroy)(void*) skamonkey@3594: ); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Text Encodings ds@1952: ** ds@1952: ** These constant define integer codes that represent the various ds@1952: ** text encodings supported by SQLite. ds@1952: */ ds@1952: #define SQLITE_UTF8 1 ds@1952: #define SQLITE_UTF16LE 2 ds@1952: #define SQLITE_UTF16BE 3 ds@1952: #define SQLITE_UTF16 4 /* Use native byte order */ ds@1952: #define SQLITE_ANY 5 /* sqlite3_create_function only */ ds@1952: #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Deprecated Functions skamonkey@3594: ** DEPRECATED skamonkey@3594: ** skamonkey@3594: ** These functions are [deprecated]. In order to maintain skamonkey@3594: ** backwards compatibility with older code, these functions continue skamonkey@3594: ** to be supported. However, new applications should avoid ds@1952: ** the use of these functions. To help encourage people to avoid skamonkey@3594: ** using these functions, we are not going to tell you what they do. skamonkey@3594: */ skamonkey@3594: #ifndef SQLITE_OMIT_DEPRECATED skamonkey@3594: SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); skamonkey@3594: SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); skamonkey@3594: SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); skamonkey@3594: SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); skamonkey@3594: SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); skamonkey@3594: SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); skamonkey@3594: #endif ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Obtaining SQL Function Parameter Values ds@1952: ** ds@1952: ** The C-language implementation of SQL functions and aggregates uses ds@1952: ** this set of interface routines to access the parameter values on ds@1952: ** the function or aggregate. ds@1952: ** ds@1952: ** The xFunc (for scalar functions) or xStep (for aggregates) parameters ds@1952: ** to [sqlite3_create_function()] and [sqlite3_create_function16()] ds@1952: ** define callbacks that implement the SQL functions and aggregates. skamonkey@3594: ** The 3rd parameter to these callbacks is an array of pointers to skamonkey@3594: ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for ds@1952: ** each parameter to the SQL function. These routines are used to ds@1952: ** extract values from the [sqlite3_value] objects. ds@1952: ** skamonkey@3594: ** These routines work only with [protected sqlite3_value] objects. skamonkey@3594: ** Any attempt to use these routines on an [unprotected sqlite3_value] skamonkey@3594: ** object results in undefined behavior. skamonkey@3594: ** skamonkey@3594: ** ^These routines work just like the corresponding [column access functions] skamonkey@3594: ** except that these routines take a single [protected sqlite3_value] object skamonkey@3594: ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_value_text16() interface extracts a UTF-16 string skamonkey@3594: ** in the native byte-order of the host machine. ^The ds@1952: ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces skamonkey@3594: ** extract UTF-16 strings as big-endian and little-endian respectively. skamonkey@3594: ** skamonkey@3594: ** ^(The sqlite3_value_numeric_type() interface attempts to apply ds@1952: ** numeric affinity to the value. This means that an attempt is ds@1952: ** made to convert the value to an integer or floating point. If skamonkey@3594: ** such a conversion is possible without loss of information (in other skamonkey@3594: ** words, if the value is a string that looks like a number) skamonkey@3594: ** then the conversion is performed. Otherwise no conversion occurs. skamonkey@3594: ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ skamonkey@3594: ** skamonkey@3594: ** Please pay particular attention to the fact that the pointer returned skamonkey@3594: ** from [sqlite3_value_blob()], [sqlite3_value_text()], or ds@1952: ** [sqlite3_value_text16()] can be invalidated by a subsequent call to ds@1952: ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], skamonkey@3594: ** or [sqlite3_value_text16()]. ds@1952: ** ds@1952: ** These routines must be called from the same thread as skamonkey@3594: ** the SQL function that supplied the [sqlite3_value*] parameters. skamonkey@3594: */ skamonkey@3594: SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); skamonkey@3594: SQLITE_API int sqlite3_value_bytes(sqlite3_value*); skamonkey@3594: SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); skamonkey@3594: SQLITE_API double sqlite3_value_double(sqlite3_value*); skamonkey@3594: SQLITE_API int sqlite3_value_int(sqlite3_value*); skamonkey@3594: SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); skamonkey@3594: SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); skamonkey@3594: SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); skamonkey@3594: SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); skamonkey@3594: SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); skamonkey@3594: SQLITE_API int sqlite3_value_type(sqlite3_value*); skamonkey@3594: SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Obtain Aggregate Function Context ds@1952: ** skamonkey@3594: ** Implementations of aggregate SQL functions use this skamonkey@3594: ** routine to allocate memory for storing their state. skamonkey@3594: ** skamonkey@3594: ** ^The first time the sqlite3_aggregate_context(C,N) routine is called skamonkey@3594: ** for a particular aggregate function, SQLite skamonkey@3594: ** allocates N of memory, zeroes out that memory, and returns a pointer skamonkey@3594: ** to the new memory. ^On second and subsequent calls to skamonkey@3594: ** sqlite3_aggregate_context() for the same aggregate function instance, skamonkey@3594: ** the same buffer is returned. Sqlite3_aggregate_context() is normally skamonkey@3594: ** called once for each invocation of the xStep callback and then one skamonkey@3594: ** last time when the xFinal callback is invoked. ^(When no rows match skamonkey@3594: ** an aggregate query, the xStep() callback of the aggregate function skamonkey@3594: ** implementation is never called and xFinal() is called exactly once. skamonkey@3594: ** In those cases, sqlite3_aggregate_context() might be called for the skamonkey@3594: ** first time from within xFinal().)^ skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is skamonkey@3594: ** less than or equal to zero or if a memory allocate error occurs. skamonkey@3594: ** skamonkey@3594: ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is skamonkey@3594: ** determined by the N parameter on first successful call. Changing the skamonkey@3594: ** value of N in subsequent call to sqlite3_aggregate_context() within skamonkey@3594: ** the same aggregate function instance will not resize the memory skamonkey@3594: ** allocation.)^ skamonkey@3594: ** skamonkey@3594: ** ^SQLite automatically frees the memory allocated by skamonkey@3594: ** sqlite3_aggregate_context() when the aggregate query concludes. skamonkey@3594: ** skamonkey@3594: ** The first parameter must be a copy of the skamonkey@3594: ** [sqlite3_context | SQL function context] that is the first parameter skamonkey@3594: ** to the xStep or xFinal callback routine that implements the aggregate ds@1952: ** function. ds@1952: ** ds@1952: ** This routine must be called from the same thread in which ds@1952: ** the aggregate SQL function is running. ds@1952: */ skamonkey@3594: SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: User Data For Functions ds@1952: ** skamonkey@3594: ** ^The sqlite3_user_data() interface returns a copy of skamonkey@3594: ** the pointer that was the pUserData parameter (the 5th parameter) skamonkey@3594: ** of the [sqlite3_create_function()] skamonkey@3594: ** and [sqlite3_create_function16()] routines that originally skamonkey@3594: ** registered the application defined function. ds@1952: ** ds@1952: ** This routine must be called from the same thread in which skamonkey@3594: ** the application-defined function is running. skamonkey@3594: */ skamonkey@3594: SQLITE_API void *sqlite3_user_data(sqlite3_context*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Database Connection For Functions skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_context_db_handle() interface returns a copy of skamonkey@3594: ** the pointer to the [database connection] (the 1st parameter) skamonkey@3594: ** of the [sqlite3_create_function()] skamonkey@3594: ** and [sqlite3_create_function16()] routines that originally skamonkey@3594: ** registered the application defined function. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Function Auxiliary Data ds@1952: ** ds@1952: ** The following two functions may be used by scalar SQL functions to skamonkey@3594: ** associate metadata with argument values. If the same value is passed to ds@1952: ** multiple invocations of the same SQL function during query execution, under skamonkey@3594: ** some circumstances the associated metadata may be preserved. This may ds@1952: ** be used, for example, to add a regular-expression matching scalar ds@1952: ** function. The compiled version of the regular expression is stored as skamonkey@3594: ** metadata associated with the SQL value passed as the regular expression ds@1952: ** pattern. The compiled regular expression can be reused on multiple ds@1952: ** invocations of the same function so that the original pattern string ds@1952: ** does not need to be recompiled on each invocation. ds@1952: ** skamonkey@3594: ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata skamonkey@3594: ** associated by the sqlite3_set_auxdata() function with the Nth argument skamonkey@3594: ** value to the application-defined function. ^If no metadata has been ever skamonkey@3594: ** been set for the Nth argument of the function, or if the corresponding skamonkey@3594: ** function parameter has changed since the meta-data was set, skamonkey@3594: ** then sqlite3_get_auxdata() returns a NULL pointer. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_set_auxdata() interface saves the metadata skamonkey@3594: ** pointed to by its 3rd parameter as the metadata for the N-th skamonkey@3594: ** argument of the application-defined function. Subsequent skamonkey@3594: ** calls to sqlite3_get_auxdata() might return this data, if it has skamonkey@3594: ** not been destroyed. skamonkey@3594: ** ^If it is not NULL, SQLite will invoke the destructor skamonkey@3594: ** function given by the 4th parameter to sqlite3_set_auxdata() on skamonkey@3594: ** the metadata when the corresponding function parameter changes skamonkey@3594: ** or when the SQL statement completes, whichever comes first. skamonkey@3594: ** skamonkey@3594: ** SQLite is free to call the destructor and drop metadata on any skamonkey@3594: ** parameter of any function at any time. ^The only guarantee is that skamonkey@3594: ** the destructor will be called before the metadata is dropped. skamonkey@3594: ** skamonkey@3594: ** ^(In practice, metadata is preserved between function calls for ds@1952: ** expressions that are constant at compile time. This includes literal skamonkey@3594: ** values and [parameters].)^ ds@1952: ** ds@1952: ** These routines must be called from the same thread in which ds@1952: ** the SQL function is running. ds@1952: */ skamonkey@3594: SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); skamonkey@3594: SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); ds@1952: ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Constants Defining Special Destructor Behavior ds@1952: ** skamonkey@3594: ** These are special values for the destructor that is passed in as the skamonkey@3594: ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor ds@1952: ** argument is SQLITE_STATIC, it means that the content pointer is constant skamonkey@3594: ** and will never change. It does not need to be destroyed. ^The ds@1952: ** SQLITE_TRANSIENT value means that the content will likely change in ds@1952: ** the near future and that SQLite should make its own private copy of ds@1952: ** the content before returning. ds@1952: ** ds@1952: ** The typedef is necessary to work around problems in certain ds@1952: ** C++ compilers. See ticket #2191. ds@1952: */ ds@1952: typedef void (*sqlite3_destructor_type)(void*); ds@1952: #define SQLITE_STATIC ((sqlite3_destructor_type)0) ds@1952: #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Setting The Result Of An SQL Function ds@1952: ** ds@1952: ** These routines are used by the xFunc or xFinal callbacks that ds@1952: ** implement SQL functions and aggregates. See ds@1952: ** [sqlite3_create_function()] and [sqlite3_create_function16()] ds@1952: ** for additional information. ds@1952: ** skamonkey@3594: ** These functions work very much like the [parameter binding] family of skamonkey@3594: ** functions used to bind values to host parameters in prepared statements. skamonkey@3594: ** Refer to the [SQL parameter] documentation for additional information. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_blob() interface sets the result from skamonkey@3594: ** an application-defined function to be the BLOB whose content is pointed skamonkey@3594: ** to by the second parameter and which is N bytes long where N is the skamonkey@3594: ** third parameter. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_zeroblob() interfaces set the result of skamonkey@3594: ** the application-defined function to be a BLOB containing all zero skamonkey@3594: ** bytes and N bytes in size, where N is the value of the 2nd parameter. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_double() interface sets the result from skamonkey@3594: ** an application-defined function to be a floating point value specified skamonkey@3594: ** by its 2nd argument. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_error() and sqlite3_result_error16() functions skamonkey@3594: ** cause the implemented SQL function to throw an exception. skamonkey@3594: ** ^SQLite uses the string pointed to by the skamonkey@3594: ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() skamonkey@3594: ** as the text of an error message. ^SQLite interprets the error skamonkey@3594: ** message string from sqlite3_result_error() as UTF-8. ^SQLite skamonkey@3594: ** interprets the string from sqlite3_result_error16() as UTF-16 in native skamonkey@3594: ** byte order. ^If the third parameter to sqlite3_result_error() skamonkey@3594: ** or sqlite3_result_error16() is negative then SQLite takes as the error skamonkey@3594: ** message all text up through the first zero character. skamonkey@3594: ** ^If the third parameter to sqlite3_result_error() or skamonkey@3594: ** sqlite3_result_error16() is non-negative then SQLite takes that many skamonkey@3594: ** bytes (not characters) from the 2nd parameter as the error message. skamonkey@3594: ** ^The sqlite3_result_error() and sqlite3_result_error16() skamonkey@3594: ** routines make a private copy of the error message text before skamonkey@3594: ** they return. Hence, the calling function can deallocate or skamonkey@3594: ** modify the text after they return without harm. skamonkey@3594: ** ^The sqlite3_result_error_code() function changes the error code skamonkey@3594: ** returned by SQLite as a result of an error in a function. ^By default, skamonkey@3594: ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() skamonkey@3594: ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_toobig() interface causes SQLite to throw an error skamonkey@3594: ** indicating that a string or BLOB is too long to represent. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_nomem() interface causes SQLite to throw an error skamonkey@3594: ** indicating that a memory allocation failed. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_int() interface sets the return value skamonkey@3594: ** of the application-defined function to be the 32-bit signed integer skamonkey@3594: ** value given in the 2nd argument. skamonkey@3594: ** ^The sqlite3_result_int64() interface sets the return value skamonkey@3594: ** of the application-defined function to be the 64-bit signed integer skamonkey@3594: ** value given in the 2nd argument. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_null() interface sets the return value skamonkey@3594: ** of the application-defined function to be NULL. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_text(), sqlite3_result_text16(), skamonkey@3594: ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces skamonkey@3594: ** set the return value of the application-defined function to be skamonkey@3594: ** a text string which is represented as UTF-8, UTF-16 native byte order, skamonkey@3594: ** UTF-16 little endian, or UTF-16 big endian, respectively. skamonkey@3594: ** ^SQLite takes the text result from the application from skamonkey@3594: ** the 2nd parameter of the sqlite3_result_text* interfaces. skamonkey@3594: ** ^If the 3rd parameter to the sqlite3_result_text* interfaces skamonkey@3594: ** is negative, then SQLite takes result text from the 2nd parameter skamonkey@3594: ** through the first zero character. skamonkey@3594: ** ^If the 3rd parameter to the sqlite3_result_text* interfaces skamonkey@3594: ** is non-negative, then as many bytes (not characters) of the text skamonkey@3594: ** pointed to by the 2nd parameter are taken as the application-defined skamonkey@3594: ** function result. If the 3rd parameter is non-negative, then it skamonkey@3594: ** must be the byte offset into the string where the NUL terminator would skamonkey@3594: ** appear if the string where NUL terminated. If any NUL characters occur skamonkey@3594: ** in the string at a byte offset that is less than the value of the 3rd skamonkey@3594: ** parameter, then the resulting string will contain embedded NULs and the skamonkey@3594: ** result of expressions operating on strings with embedded NULs is undefined. skamonkey@3594: ** ^If the 4th parameter to the sqlite3_result_text* interfaces skamonkey@3594: ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that skamonkey@3594: ** function as the destructor on the text or BLOB result when it has skamonkey@3594: ** finished using that result. skamonkey@3594: ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to skamonkey@3594: ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite skamonkey@3594: ** assumes that the text or BLOB result is in constant space and does not skamonkey@3594: ** copy the content of the parameter nor call a destructor on the content skamonkey@3594: ** when it has finished using that result. skamonkey@3594: ** ^If the 4th parameter to the sqlite3_result_text* interfaces skamonkey@3594: ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT skamonkey@3594: ** then SQLite makes a copy of the result into space obtained from skamonkey@3594: ** from [sqlite3_malloc()] before it returns. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_result_value() interface sets the result of skamonkey@3594: ** the application-defined function to be a copy the skamonkey@3594: ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The skamonkey@3594: ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] skamonkey@3594: ** so that the [sqlite3_value] specified in the parameter may change or skamonkey@3594: ** be deallocated after sqlite3_result_value() returns without harm. skamonkey@3594: ** ^A [protected sqlite3_value] object may always be used where an skamonkey@3594: ** [unprotected sqlite3_value] object is required, so either skamonkey@3594: ** kind of [sqlite3_value] object can be used with this interface. skamonkey@3594: ** skamonkey@3594: ** If these routines are called from within the different thread skamonkey@3594: ** than the one containing the application-defined function that received skamonkey@3594: ** the [sqlite3_context] pointer, the results are undefined. skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); skamonkey@3594: SQLITE_API void sqlite3_result_double(sqlite3_context*, double); skamonkey@3594: SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); skamonkey@3594: SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); skamonkey@3594: SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); skamonkey@3594: SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); skamonkey@3594: SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); skamonkey@3594: SQLITE_API void sqlite3_result_int(sqlite3_context*, int); skamonkey@3594: SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); skamonkey@3594: SQLITE_API void sqlite3_result_null(sqlite3_context*); skamonkey@3594: SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); skamonkey@3594: SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); skamonkey@3594: SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); skamonkey@3594: SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); skamonkey@3594: SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); skamonkey@3594: SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Define New Collating Sequences ds@1952: ** skamonkey@3594: ** ^These functions add, remove, or modify a [collation] associated skamonkey@3594: ** with the [database connection] specified as the first argument. skamonkey@3594: ** skamonkey@3594: ** ^The name of the collation is a UTF-8 string ds@1952: ** for sqlite3_create_collation() and sqlite3_create_collation_v2() skamonkey@3594: ** and a UTF-16 string in native byte order for sqlite3_create_collation16(). skamonkey@3594: ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are skamonkey@3594: ** considered to be the same name. skamonkey@3594: ** skamonkey@3594: ** ^(The third argument (eTextRep) must be one of the constants: skamonkey@3594: ** )^ skamonkey@3594: ** ^The eTextRep argument determines the encoding of strings passed skamonkey@3594: ** to the collating function callback, xCallback. skamonkey@3594: ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep skamonkey@3594: ** force strings to be UTF16 with native byte order. skamonkey@3594: ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin skamonkey@3594: ** on an even byte address. skamonkey@3594: ** skamonkey@3594: ** ^The fourth argument, pArg, is an application data pointer that is passed skamonkey@3594: ** through as the first argument to the collating function callback. skamonkey@3594: ** skamonkey@3594: ** ^The fifth argument, xCallback, is a pointer to the collating function. skamonkey@3594: ** ^Multiple collating functions can be registered using the same name but skamonkey@3594: ** with different eTextRep parameters and SQLite will use whichever skamonkey@3594: ** function requires the least amount of data transformation. skamonkey@3594: ** ^If the xCallback argument is NULL then the collating function is skamonkey@3594: ** deleted. ^When all collating functions having the same name are deleted, skamonkey@3594: ** that collation is no longer usable. skamonkey@3594: ** skamonkey@3594: ** ^The collating function callback is invoked with a copy of the pArg skamonkey@3594: ** application data pointer and with two strings in the encoding specified skamonkey@3594: ** by the eTextRep argument. The collating function must return an skamonkey@3594: ** integer that is negative, zero, or positive skamonkey@3594: ** if the first string is less than, equal to, or greater than the second, skamonkey@3594: ** respectively. A collating function must always return the same answer skamonkey@3594: ** given the same inputs. If two or more collating functions are registered skamonkey@3594: ** to the same collation name (using different eTextRep values) then all skamonkey@3594: ** must give an equivalent answer when invoked with equivalent strings. skamonkey@3594: ** The collating function must obey the following properties for all skamonkey@3594: ** strings A, B, and C: skamonkey@3594: ** skamonkey@3594: **
    skamonkey@3594: **
  1. If A==B then B==A. skamonkey@3594: **
  2. If A==B and B==C then A==C. skamonkey@3594: **
  3. If A<B THEN B>A. skamonkey@3594: **
  4. If A<B and B<C then A<C. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** If a collating function fails any of the above constraints and that skamonkey@3594: ** collating function is registered and used, then the behavior of SQLite skamonkey@3594: ** is undefined. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() skamonkey@3594: ** with the addition that the xDestroy callback is invoked on pArg when skamonkey@3594: ** the collating function is deleted. skamonkey@3594: ** ^Collating functions are deleted when they are overridden by later skamonkey@3594: ** calls to the collation creation functions or when the skamonkey@3594: ** [database connection] is closed using [sqlite3_close()]. skamonkey@3594: ** skamonkey@3594: ** ^The xDestroy callback is not called if the skamonkey@3594: ** sqlite3_create_collation_v2() function fails. Applications that invoke skamonkey@3594: ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should skamonkey@3594: ** check the return code and dispose of the application data pointer skamonkey@3594: ** themselves rather than expecting SQLite to deal with it for them. skamonkey@3594: ** This is different from every other SQLite interface. The inconsistency skamonkey@3594: ** is unfortunate but cannot be changed without breaking backwards skamonkey@3594: ** compatibility. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_create_collation( ds@1952: sqlite3*, ds@1952: const char *zName, ds@1952: int eTextRep, skamonkey@3594: void *pArg, ds@1952: int(*xCompare)(void*,int,const void*,int,const void*) ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_create_collation_v2( ds@1952: sqlite3*, ds@1952: const char *zName, ds@1952: int eTextRep, skamonkey@3594: void *pArg, ds@1952: int(*xCompare)(void*,int,const void*,int,const void*), ds@1952: void(*xDestroy)(void*) ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_create_collation16( ds@1952: sqlite3*, skamonkey@3594: const void *zName, ds@1952: int eTextRep, skamonkey@3594: void *pArg, ds@1952: int(*xCompare)(void*,int,const void*,int,const void*) ds@1952: ); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Collation Needed Callbacks ds@1952: ** skamonkey@3594: ** ^To avoid having to register all collation sequences before a database ds@1952: ** can be used, a single callback function may be registered with the skamonkey@3594: ** [database connection] to be invoked whenever an undefined collation skamonkey@3594: ** sequence is required. skamonkey@3594: ** skamonkey@3594: ** ^If the function is registered using the sqlite3_collation_needed() API, ds@1952: ** then it is passed the names of undefined collation sequences as strings skamonkey@3594: ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, skamonkey@3594: ** the names are passed as UTF-16 in machine native byte order. skamonkey@3594: ** ^A call to either function replaces the existing collation-needed callback. skamonkey@3594: ** skamonkey@3594: ** ^(When the callback is invoked, the first argument passed is a copy ds@1952: ** of the second argument to sqlite3_collation_needed() or skamonkey@3594: ** sqlite3_collation_needed16(). The second argument is the database skamonkey@3594: ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], skamonkey@3594: ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation skamonkey@3594: ** sequence function required. The fourth parameter is the name of the skamonkey@3594: ** required collation sequence.)^ ds@1952: ** ds@1952: ** The callback function should register the desired collation using ds@1952: ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or ds@1952: ** [sqlite3_create_collation_v2()]. ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_collation_needed( ds@1952: sqlite3*, ds@1952: void*, ds@1952: void(*)(void*,sqlite3*,int eTextRep,const char*) ds@1952: ); skamonkey@3594: SQLITE_API int sqlite3_collation_needed16( ds@1952: sqlite3*, ds@1952: void*, ds@1952: void(*)(void*,sqlite3*,int eTextRep,const void*) ds@1952: ); ds@1952: skamonkey@3594: #ifdef SQLITE_HAS_CODEC ds@1952: /* ds@1952: ** Specify the key for an encrypted database. This routine should be ds@1952: ** called right after sqlite3_open(). ds@1952: ** ds@1952: ** The code to implement this API is not available in the public release ds@1952: ** of SQLite. ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_key( ds@1952: sqlite3 *db, /* Database to be rekeyed */ ds@1952: const void *pKey, int nKey /* The key */ ds@1952: ); ds@1952: ds@1952: /* ds@1952: ** Change the key on an open database. If the current database is not ds@1952: ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the ds@1952: ** database is decrypted. ds@1952: ** ds@1952: ** The code to implement this API is not available in the public release ds@1952: ** of SQLite. ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_rekey( ds@1952: sqlite3 *db, /* Database to be rekeyed */ ds@1952: const void *pKey, int nKey /* The new key */ ds@1952: ); ds@1952: ds@1952: /* skamonkey@3594: ** Specify the activation key for a SEE database. Unless skamonkey@3594: ** activated, none of the SEE routines will work. skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_activate_see( skamonkey@3594: const char *zPassPhrase /* Activation phrase */ skamonkey@3594: ); skamonkey@3594: #endif skamonkey@3594: skamonkey@3594: #ifdef SQLITE_ENABLE_CEROD skamonkey@3594: /* skamonkey@3594: ** Specify the activation key for a CEROD database. Unless skamonkey@3594: ** activated, none of the CEROD routines will work. skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_activate_cerod( skamonkey@3594: const char *zPassPhrase /* Activation phrase */ skamonkey@3594: ); skamonkey@3594: #endif skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Suspend Execution For A Short Time skamonkey@3594: ** skamonkey@3594: ** The sqlite3_sleep() function causes the current thread to suspend execution skamonkey@3594: ** for at least a number of milliseconds specified in its parameter. skamonkey@3594: ** skamonkey@3594: ** If the operating system does not support sleep requests with skamonkey@3594: ** millisecond time resolution, then the time will be rounded up to skamonkey@3594: ** the nearest second. The number of milliseconds of sleep actually ds@1952: ** requested from the operating system is returned. ds@1952: ** skamonkey@3594: ** ^SQLite implements this interface by calling the xSleep() skamonkey@3594: ** method of the default [sqlite3_vfs] object. If the xSleep() method skamonkey@3594: ** of the default VFS is not implemented correctly, or not implemented at skamonkey@3594: ** all, then the behavior of sqlite3_sleep() may deviate from the description skamonkey@3594: ** in the previous paragraphs. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_sleep(int); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Name Of The Folder Holding Temporary Files skamonkey@3594: ** skamonkey@3594: ** ^(If this global variable is made to point to a string which is skamonkey@3594: ** the name of a folder (a.k.a. directory), then all temporary files skamonkey@3594: ** created by SQLite when using a built-in [sqlite3_vfs | VFS] skamonkey@3594: ** will be placed in that directory.)^ ^If this variable skamonkey@3594: ** is a NULL pointer, then SQLite performs a search for an appropriate skamonkey@3594: ** temporary file directory. skamonkey@3594: ** skamonkey@3594: ** It is not safe to read or modify this variable in more than one skamonkey@3594: ** thread at a time. It is not safe to read or modify this variable skamonkey@3594: ** if a [database connection] is being used at the same time in a separate skamonkey@3594: ** thread. skamonkey@3594: ** It is intended that this variable be set once ds@1952: ** as part of process initialization and before any SQLite interface skamonkey@3594: ** routines have been called and that this variable remain unchanged skamonkey@3594: ** thereafter. skamonkey@3594: ** skamonkey@3594: ** ^The [temp_store_directory pragma] may modify this variable and cause skamonkey@3594: ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, skamonkey@3594: ** the [temp_store_directory pragma] always assumes that any string skamonkey@3594: ** that this variable points to is held in memory obtained from skamonkey@3594: ** [sqlite3_malloc] and the pragma may attempt to free that memory skamonkey@3594: ** using [sqlite3_free]. skamonkey@3594: ** Hence, if this variable is modified directly, either it should be skamonkey@3594: ** made NULL or made to point to memory obtained from [sqlite3_malloc] skamonkey@3594: ** or else the use of the [temp_store_directory pragma] should be avoided. skamonkey@3594: */ skamonkey@3594: SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Name Of The Folder Holding Database Files skamonkey@3594: ** skamonkey@3594: ** ^(If this global variable is made to point to a string which is skamonkey@3594: ** the name of a folder (a.k.a. directory), then all database files skamonkey@3594: ** specified with a relative pathname and created or accessed by skamonkey@3594: ** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed skamonkey@3594: ** to be relative to that directory.)^ ^If this variable is a NULL skamonkey@3594: ** pointer, then SQLite assumes that all database files specified skamonkey@3594: ** with a relative pathname are relative to the current directory skamonkey@3594: ** for the process. Only the windows VFS makes use of this global skamonkey@3594: ** variable; it is ignored by the unix VFS. skamonkey@3594: ** skamonkey@3594: ** Changing the value of this variable while a database connection is skamonkey@3594: ** open can result in a corrupt database. skamonkey@3594: ** skamonkey@3594: ** It is not safe to read or modify this variable in more than one skamonkey@3594: ** thread at a time. It is not safe to read or modify this variable skamonkey@3594: ** if a [database connection] is being used at the same time in a separate skamonkey@3594: ** thread. skamonkey@3594: ** It is intended that this variable be set once skamonkey@3594: ** as part of process initialization and before any SQLite interface skamonkey@3594: ** routines have been called and that this variable remain unchanged skamonkey@3594: ** thereafter. skamonkey@3594: ** skamonkey@3594: ** ^The [data_store_directory pragma] may modify this variable and cause skamonkey@3594: ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, skamonkey@3594: ** the [data_store_directory pragma] always assumes that any string skamonkey@3594: ** that this variable points to is held in memory obtained from skamonkey@3594: ** [sqlite3_malloc] and the pragma may attempt to free that memory skamonkey@3594: ** using [sqlite3_free]. skamonkey@3594: ** Hence, if this variable is modified directly, either it should be skamonkey@3594: ** made NULL or made to point to memory obtained from [sqlite3_malloc] skamonkey@3594: ** or else the use of the [data_store_directory pragma] should be avoided. skamonkey@3594: */ skamonkey@3594: SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Test For Auto-Commit Mode skamonkey@3594: ** KEYWORDS: {autocommit mode} skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_get_autocommit() interface returns non-zero or skamonkey@3594: ** zero if the given database connection is or is not in autocommit mode, skamonkey@3594: ** respectively. ^Autocommit mode is on by default. skamonkey@3594: ** ^Autocommit mode is disabled by a [BEGIN] statement. skamonkey@3594: ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. ds@1952: ** ds@1952: ** If certain kinds of errors occur on a statement within a multi-statement skamonkey@3594: ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], ds@1952: ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the ds@1952: ** transaction might be rolled back automatically. The only way to skamonkey@3594: ** find out whether SQLite automatically rolled back the transaction after ds@1952: ** an error is to use this function. ds@1952: ** ds@1952: ** If another thread changes the autocommit status of the database ds@1952: ** connection while this routine is running, then the return value ds@1952: ** is undefined. ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_get_autocommit(sqlite3*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Find The Database Handle Of A Prepared Statement skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_db_handle interface returns the [database connection] handle skamonkey@3594: ** to which a [prepared statement] belongs. ^The [database connection] skamonkey@3594: ** returned by sqlite3_db_handle is the same [database connection] skamonkey@3594: ** that was the first argument skamonkey@3594: ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to skamonkey@3594: ** create the statement in the first place. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Return The Filename For A Database Connection skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename skamonkey@3594: ** associated with database N of connection D. ^The main database file skamonkey@3594: ** has the name "main". If there is no attached database N on the database skamonkey@3594: ** connection D, or if database N is a temporary or in-memory database, then skamonkey@3594: ** a NULL pointer is returned. skamonkey@3594: ** skamonkey@3594: ** ^The filename returned by this function is the output of the skamonkey@3594: ** xFullPathname method of the [VFS]. ^In other words, the filename skamonkey@3594: ** will be an absolute pathname, even if the filename used skamonkey@3594: ** to open the database originally was a URI or relative pathname. skamonkey@3594: */ skamonkey@3594: SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Determine if a database is read-only skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N skamonkey@3594: ** of connection D is read-only, 0 if it is read/write, or -1 if N is not skamonkey@3594: ** the name of a database on connection D. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Find the next prepared statement skamonkey@3594: ** skamonkey@3594: ** ^This interface returns a pointer to the next [prepared statement] after skamonkey@3594: ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL skamonkey@3594: ** then this interface returns a pointer to the first prepared statement skamonkey@3594: ** associated with the database connection pDb. ^If no prepared statement skamonkey@3594: ** satisfies the conditions of this routine, it returns NULL. skamonkey@3594: ** skamonkey@3594: ** The [database connection] pointer D in a call to skamonkey@3594: ** [sqlite3_next_stmt(D,S)] must refer to an open database skamonkey@3594: ** connection and in particular must not be a NULL pointer. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Commit And Rollback Notification Callbacks ds@1952: ** skamonkey@3594: ** ^The sqlite3_commit_hook() interface registers a callback skamonkey@3594: ** function to be invoked whenever a transaction is [COMMIT | committed]. skamonkey@3594: ** ^Any callback set by a previous call to sqlite3_commit_hook() skamonkey@3594: ** for the same database connection is overridden. skamonkey@3594: ** ^The sqlite3_rollback_hook() interface registers a callback skamonkey@3594: ** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. skamonkey@3594: ** ^Any callback set by a previous call to sqlite3_rollback_hook() skamonkey@3594: ** for the same database connection is overridden. skamonkey@3594: ** ^The pArg argument is passed through to the callback. skamonkey@3594: ** ^If the callback on a commit hook function returns non-zero, skamonkey@3594: ** then the commit is converted into a rollback. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions skamonkey@3594: ** return the P argument from the previous call of the same function skamonkey@3594: ** on the same [database connection] D, or NULL for skamonkey@3594: ** the first call for each function on D. skamonkey@3594: ** skamonkey@3594: ** The commit and rollback hook callbacks are not reentrant. skamonkey@3594: ** The callback implementation must not do anything that will modify skamonkey@3594: ** the database connection that invoked the callback. Any actions skamonkey@3594: ** to modify the database connection must be deferred until after the skamonkey@3594: ** completion of the [sqlite3_step()] call that triggered the commit skamonkey@3594: ** or rollback hook in the first place. skamonkey@3594: ** Note that running any other SQL statements, including SELECT statements, skamonkey@3594: ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify skamonkey@3594: ** the database connections for the meaning of "modify" in this paragraph. skamonkey@3594: ** skamonkey@3594: ** ^Registering a NULL function disables the callback. skamonkey@3594: ** skamonkey@3594: ** ^When the commit hook callback routine returns zero, the [COMMIT] skamonkey@3594: ** operation is allowed to continue normally. ^If the commit hook skamonkey@3594: ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. skamonkey@3594: ** ^The rollback hook is invoked on a rollback that results from a commit skamonkey@3594: ** hook returning non-zero, just as it would be with any other rollback. skamonkey@3594: ** skamonkey@3594: ** ^For the purposes of this API, a transaction is said to have been ds@1952: ** rolled back if an explicit "ROLLBACK" statement is executed, or skamonkey@3594: ** an error or constraint causes an implicit rollback to occur. skamonkey@3594: ** ^The rollback callback is not invoked if a transaction is skamonkey@3594: ** automatically rolled back because the database connection is closed. skamonkey@3594: ** skamonkey@3594: ** See also the [sqlite3_update_hook()] interface. skamonkey@3594: */ skamonkey@3594: SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); skamonkey@3594: SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Data Change Notification Callbacks ds@1952: ** skamonkey@3594: ** ^The sqlite3_update_hook() interface registers a callback function skamonkey@3594: ** with the [database connection] identified by the first argument skamonkey@3594: ** to be invoked whenever a row is updated, inserted or deleted. skamonkey@3594: ** ^Any callback set by a previous call to this function skamonkey@3594: ** for the same database connection is overridden. skamonkey@3594: ** skamonkey@3594: ** ^The second argument is a pointer to the function to invoke when a skamonkey@3594: ** row is updated, inserted or deleted. skamonkey@3594: ** ^The first argument to the callback is a copy of the third argument skamonkey@3594: ** to sqlite3_update_hook(). skamonkey@3594: ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], skamonkey@3594: ** or [SQLITE_UPDATE], depending on the operation that caused the callback skamonkey@3594: ** to be invoked. skamonkey@3594: ** ^The third and fourth arguments to the callback contain pointers to the skamonkey@3594: ** database and table name containing the affected row. skamonkey@3594: ** ^The final callback parameter is the [rowid] of the row. skamonkey@3594: ** ^In the case of an update, this is the [rowid] after the update takes place. skamonkey@3594: ** skamonkey@3594: ** ^(The update hook is not invoked when internal system tables are skamonkey@3594: ** modified (i.e. sqlite_master and sqlite_sequence).)^ skamonkey@3594: ** skamonkey@3594: ** ^In the current implementation, the update hook skamonkey@3594: ** is not invoked when duplication rows are deleted because of an skamonkey@3594: ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook skamonkey@3594: ** invoked when rows are deleted using the [truncate optimization]. skamonkey@3594: ** The exceptions defined in this paragraph might change in a future skamonkey@3594: ** release of SQLite. skamonkey@3594: ** skamonkey@3594: ** The update hook implementation must not do anything that will modify skamonkey@3594: ** the database connection that invoked the update hook. Any actions skamonkey@3594: ** to modify the database connection must be deferred until after the skamonkey@3594: ** completion of the [sqlite3_step()] call that triggered the update hook. skamonkey@3594: ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their skamonkey@3594: ** database connections for the meaning of "modify" in this paragraph. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_update_hook(D,C,P) function skamonkey@3594: ** returns the P argument from the previous call skamonkey@3594: ** on the same [database connection] D, or NULL for skamonkey@3594: ** the first call on D. skamonkey@3594: ** skamonkey@3594: ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] skamonkey@3594: ** interfaces. skamonkey@3594: */ skamonkey@3594: SQLITE_API void *sqlite3_update_hook( ds@1952: sqlite3*, ds@1952: void(*)(void *,int ,char const *,char const *,sqlite3_int64), ds@1952: void* ds@1952: ); ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Enable Or Disable Shared Pager Cache skamonkey@3594: ** skamonkey@3594: ** ^(This routine enables or disables the sharing of the database cache skamonkey@3594: ** and schema data structures between [database connection | connections] skamonkey@3594: ** to the same database. Sharing is enabled if the argument is true skamonkey@3594: ** and disabled if the argument is false.)^ skamonkey@3594: ** skamonkey@3594: ** ^Cache sharing is enabled and disabled for an entire process. skamonkey@3594: ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, skamonkey@3594: ** sharing was enabled or disabled for each thread separately. skamonkey@3594: ** skamonkey@3594: ** ^(The cache sharing mode set by this interface effects all subsequent ds@1952: ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. skamonkey@3594: ** Existing database connections continue use the sharing mode skamonkey@3594: ** that was in effect at the time they were opened.)^ skamonkey@3594: ** skamonkey@3594: ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled skamonkey@3594: ** successfully. An [error code] is returned otherwise.)^ skamonkey@3594: ** skamonkey@3594: ** ^Shared cache is disabled by default. But this might change in ds@1952: ** future releases of SQLite. Applications that care about shared ds@1952: ** cache setting should set it explicitly. skamonkey@3594: ** skamonkey@3594: ** See Also: [SQLite Shared-Cache Mode] skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_enable_shared_cache(int); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Attempt To Free Heap Memory skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_release_memory() interface attempts to free N bytes skamonkey@3594: ** of heap memory by deallocating non-essential memory allocations skamonkey@3594: ** held by the database library. Memory used to cache database skamonkey@3594: ** pages to improve performance is an example of non-essential memory. skamonkey@3594: ** ^sqlite3_release_memory() returns the number of bytes actually freed, skamonkey@3594: ** which might be more or less than the amount requested. skamonkey@3594: ** ^The sqlite3_release_memory() routine is a no-op returning zero skamonkey@3594: ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_db_release_memory()] skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_release_memory(int); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Free Memory Used By A Database Connection skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap skamonkey@3594: ** memory as possible from database connection D. Unlike the skamonkey@3594: ** [sqlite3_release_memory()] interface, this interface is effect even skamonkey@3594: ** when then [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is skamonkey@3594: ** omitted. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_release_memory()] skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_db_release_memory(sqlite3*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Impose A Limit On Heap Size skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the skamonkey@3594: ** soft limit on the amount of heap memory that may be allocated by SQLite. skamonkey@3594: ** ^SQLite strives to keep heap memory utilization below the soft heap skamonkey@3594: ** limit by reducing the number of pages held in the page cache skamonkey@3594: ** as heap memory usages approaches the limit. skamonkey@3594: ** ^The soft heap limit is "soft" because even though SQLite strives to stay skamonkey@3594: ** below the limit, it will exceed the limit rather than generate skamonkey@3594: ** an [SQLITE_NOMEM] error. In other words, the soft heap limit skamonkey@3594: ** is advisory only. skamonkey@3594: ** skamonkey@3594: ** ^The return value from sqlite3_soft_heap_limit64() is the size of skamonkey@3594: ** the soft heap limit prior to the call, or negative in the case of an skamonkey@3594: ** error. ^If the argument N is negative skamonkey@3594: ** then no change is made to the soft heap limit. Hence, the current skamonkey@3594: ** size of the soft heap limit can be determined by invoking skamonkey@3594: ** sqlite3_soft_heap_limit64() with a negative argument. skamonkey@3594: ** skamonkey@3594: ** ^If the argument N is zero then the soft heap limit is disabled. skamonkey@3594: ** skamonkey@3594: ** ^(The soft heap limit is not enforced in the current implementation skamonkey@3594: ** if one or more of following conditions are true: skamonkey@3594: ** skamonkey@3594: ** )^ skamonkey@3594: ** skamonkey@3594: ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced skamonkey@3594: ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] skamonkey@3594: ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], skamonkey@3594: ** the soft heap limit is enforced on every memory allocation. Without skamonkey@3594: ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced skamonkey@3594: ** when memory is allocated by the page cache. Testing suggests that because skamonkey@3594: ** the page cache is the predominate memory user in SQLite, most skamonkey@3594: ** applications will achieve adequate soft heap limit enforcement without skamonkey@3594: ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. skamonkey@3594: ** skamonkey@3594: ** The circumstances under which SQLite will enforce the soft heap limit may skamonkey@3594: ** changes in future releases of SQLite. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Deprecated Soft Heap Limit Interface skamonkey@3594: ** DEPRECATED skamonkey@3594: ** skamonkey@3594: ** This is a deprecated version of the [sqlite3_soft_heap_limit64()] skamonkey@3594: ** interface. This routine is provided for historical compatibility skamonkey@3594: ** only. All new applications should use the skamonkey@3594: ** [sqlite3_soft_heap_limit64()] interface rather than this one. skamonkey@3594: */ skamonkey@3594: SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Extract Metadata About A Column Of A Table skamonkey@3594: ** skamonkey@3594: ** ^This routine returns metadata about a specific column of a specific skamonkey@3594: ** database table accessible using the [database connection] handle skamonkey@3594: ** passed as the first function argument. skamonkey@3594: ** skamonkey@3594: ** ^The column is identified by the second, third and fourth parameters to skamonkey@3594: ** this function. ^The second parameter is either the name of the database skamonkey@3594: ** (i.e. "main", "temp", or an attached database) containing the specified skamonkey@3594: ** table or NULL. ^If it is NULL, then all attached databases are searched skamonkey@3594: ** for the table using the same algorithm used by the database engine to ds@1952: ** resolve unqualified table references. ds@1952: ** skamonkey@3594: ** ^The third and fourth parameters to this function are the table and column skamonkey@3594: ** name of the desired column, respectively. Neither of these parameters ds@1952: ** may be NULL. ds@1952: ** skamonkey@3594: ** ^Metadata is returned by writing to the memory locations passed as the 5th skamonkey@3594: ** and subsequent parameters to this function. ^Any of these arguments may be skamonkey@3594: ** NULL, in which case the corresponding element of metadata is omitted. skamonkey@3594: ** skamonkey@3594: ** ^(
skamonkey@3594: ** skamonkey@3594: **
Parameter Output
Type 		Description skamonkey@3594: ** skamonkey@3594: **
5th const char* Data type skamonkey@3594: **
6th const char* Name of default collation sequence skamonkey@3594: **
7th int True if column has a NOT NULL constraint skamonkey@3594: **
8th int True if column is part of the PRIMARY KEY skamonkey@3594: **
9th int True if column is [AUTOINCREMENT] skamonkey@3594: **
skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** ^The memory pointed to by the character pointers returned for the skamonkey@3594: ** declaration type and collation sequence is valid only until the next skamonkey@3594: ** call to any SQLite API function. skamonkey@3594: ** skamonkey@3594: ** ^If the specified table is actually a view, an [error code] is returned. skamonkey@3594: ** skamonkey@3594: ** ^If the specified column is "rowid", "oid" or "_rowid_" and an skamonkey@3594: ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output skamonkey@3594: ** parameters are set for the explicitly declared column. ^(If there is no skamonkey@3594: ** explicitly declared [INTEGER PRIMARY KEY] column, then the output skamonkey@3594: ** parameters are set as follows: ds@1952: ** ds@1952: ** 
ds@1952: **     data type: "INTEGER"
ds@1952: **     collation sequence: "BINARY"
ds@1952: **     not null: 0
ds@1952: **     primary key: 1
ds@1952: **     auto increment: 0
skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** ^(This function may load one or more schemas from database files. If an ds@1952: ** error occurs during this process, or if the requested table or column skamonkey@3594: ** cannot be found, an [error code] is returned and an error message left skamonkey@3594: ** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^ skamonkey@3594: ** skamonkey@3594: ** ^This API is only available if the library was compiled with the skamonkey@3594: ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_table_column_metadata( ds@1952: sqlite3 *db, /* Connection handle */ ds@1952: const char *zDbName, /* Database name or NULL */ ds@1952: const char *zTableName, /* Table name */ ds@1952: const char *zColumnName, /* Column name */ ds@1952: char const **pzDataType, /* OUTPUT: Declared data type */ ds@1952: char const **pzCollSeq, /* OUTPUT: Collation sequence name */ ds@1952: int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ ds@1952: int *pPrimaryKey, /* OUTPUT: True if column part of PK */ ds@1952: int *pAutoinc /* OUTPUT: True if column is auto-increment */ ds@1952: ); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Load An Extension ds@1952: ** skamonkey@3594: ** ^This interface loads an SQLite extension library from the named file. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_load_extension() interface attempts to load an skamonkey@3594: ** SQLite extension library contained in the file zFile. skamonkey@3594: ** skamonkey@3594: ** ^The entry point is zProc. skamonkey@3594: ** ^zProc may be 0, in which case the name of the entry point skamonkey@3594: ** defaults to "sqlite3_extension_init". skamonkey@3594: ** ^The sqlite3_load_extension() interface returns skamonkey@3594: ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. skamonkey@3594: ** ^If an error occurs and pzErrMsg is not 0, then the skamonkey@3594: ** [sqlite3_load_extension()] interface shall attempt to skamonkey@3594: ** fill *pzErrMsg with error message text stored in memory skamonkey@3594: ** obtained from [sqlite3_malloc()]. The calling function skamonkey@3594: ** should free this memory by calling [sqlite3_free()]. skamonkey@3594: ** skamonkey@3594: ** ^Extension loading must be enabled using skamonkey@3594: ** [sqlite3_enable_load_extension()] prior to calling this API, skamonkey@3594: ** otherwise an error will be returned. skamonkey@3594: ** skamonkey@3594: ** See also the [load_extension() SQL function]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_load_extension( ds@1952: sqlite3 *db, /* Load the extension into this database connection */ ds@1952: const char *zFile, /* Name of the shared library containing extension */ ds@1952: const char *zProc, /* Entry point. Derived from zFile if 0 */ ds@1952: char **pzErrMsg /* Put error message here if not 0 */ ds@1952: ); ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Enable Or Disable Extension Loading skamonkey@3594: ** skamonkey@3594: ** ^So as not to open security holes in older applications that are ds@1952: ** unprepared to deal with extension loading, and as a means of disabling skamonkey@3594: ** extension loading while evaluating user-entered SQL, the following API skamonkey@3594: ** is provided to turn the [sqlite3_load_extension()] mechanism on and off. skamonkey@3594: ** skamonkey@3594: ** ^Extension loading is off by default. See ticket #1863. skamonkey@3594: ** ^Call the sqlite3_enable_load_extension() routine with onoff==1 skamonkey@3594: ** to turn extension loading on and call it with onoff==0 to turn skamonkey@3594: ** it back off again. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Automatically Load Statically Linked Extensions skamonkey@3594: ** skamonkey@3594: ** ^This interface causes the xEntryPoint() function to be invoked for skamonkey@3594: ** each new [database connection] that is created. The idea here is that skamonkey@3594: ** xEntryPoint() is the entry point for a statically linked SQLite extension skamonkey@3594: ** that is to be automatically loaded into all new database connections. skamonkey@3594: ** skamonkey@3594: ** ^(Even though the function prototype shows that xEntryPoint() takes skamonkey@3594: ** no arguments and returns void, SQLite invokes xEntryPoint() with three skamonkey@3594: ** arguments and expects and integer result as if the signature of the skamonkey@3594: ** entry point where as follows: skamonkey@3594: ** skamonkey@3594: ** 
skamonkey@3594: **    int xEntryPoint(
skamonkey@3594: **      sqlite3 *db,
skamonkey@3594: **      const char **pzErrMsg,
skamonkey@3594: **      const struct sqlite3_api_routines *pThunk
skamonkey@3594: **    );
skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg skamonkey@3594: ** point to an appropriate error message (obtained from [sqlite3_mprintf()]) skamonkey@3594: ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg skamonkey@3594: ** is NULL before calling the xEntryPoint(). ^SQLite will invoke skamonkey@3594: ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any skamonkey@3594: ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], skamonkey@3594: ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. skamonkey@3594: ** skamonkey@3594: ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already skamonkey@3594: ** on the list of automatic extensions is a harmless no-op. ^No entry point skamonkey@3594: ** will be called more than once for each database connection that is opened. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_reset_auto_extension()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Reset Automatic Extension Loading ds@1952: ** skamonkey@3594: ** ^This interface disables all automatic extensions previously skamonkey@3594: ** registered using [sqlite3_auto_extension()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_reset_auto_extension(void); skamonkey@3594: skamonkey@3594: /* ds@1952: ** The interface to the virtual-table mechanism is currently considered ds@1952: ** to be experimental. The interface might change in incompatible ways. ds@1952: ** If this is a problem for you, do not use the interface at this time. ds@1952: ** skamonkey@3594: ** When the virtual-table mechanism stabilizes, we will declare the ds@1952: ** interface fixed, support it indefinitely, and remove this comment. ds@1952: */ ds@1952: ds@1952: /* ds@1952: ** Structures used by the virtual table interface ds@1952: */ ds@1952: typedef struct sqlite3_vtab sqlite3_vtab; ds@1952: typedef struct sqlite3_index_info sqlite3_index_info; ds@1952: typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; ds@1952: typedef struct sqlite3_module sqlite3_module; ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Virtual Table Object skamonkey@3594: ** KEYWORDS: sqlite3_module {virtual table module} skamonkey@3594: ** skamonkey@3594: ** This structure, sometimes called a "virtual table module", skamonkey@3594: ** defines the implementation of a [virtual tables]. skamonkey@3594: ** This structure consists mostly of methods for the module. skamonkey@3594: ** skamonkey@3594: ** ^A virtual table module is created by filling in a persistent skamonkey@3594: ** instance of this structure and passing a pointer to that instance skamonkey@3594: ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. skamonkey@3594: ** ^The registration remains valid until it is replaced by a different skamonkey@3594: ** module or until the [database connection] closes. The content skamonkey@3594: ** of this structure must not change while it is registered with skamonkey@3594: ** any database connection. ds@1952: */ ds@1952: struct sqlite3_module { ds@1952: int iVersion; ds@1952: int (*xCreate)(sqlite3*, void *pAux, ds@1952: int argc, const char *const*argv, ds@1952: sqlite3_vtab **ppVTab, char**); ds@1952: int (*xConnect)(sqlite3*, void *pAux, ds@1952: int argc, const char *const*argv, ds@1952: sqlite3_vtab **ppVTab, char**); ds@1952: int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); ds@1952: int (*xDisconnect)(sqlite3_vtab *pVTab); ds@1952: int (*xDestroy)(sqlite3_vtab *pVTab); ds@1952: int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); ds@1952: int (*xClose)(sqlite3_vtab_cursor*); ds@1952: int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, ds@1952: int argc, sqlite3_value **argv); ds@1952: int (*xNext)(sqlite3_vtab_cursor*); ds@1952: int (*xEof)(sqlite3_vtab_cursor*); ds@1952: int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); ds@1952: int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); ds@1952: int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); ds@1952: int (*xBegin)(sqlite3_vtab *pVTab); ds@1952: int (*xSync)(sqlite3_vtab *pVTab); ds@1952: int (*xCommit)(sqlite3_vtab *pVTab); ds@1952: int (*xRollback)(sqlite3_vtab *pVTab); ds@1952: int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, ds@1952: void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), ds@1952: void **ppArg); ds@1952: int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); skamonkey@3594: /* The methods above are in version 1 of the sqlite_module object. Those skamonkey@3594: ** below are for version 2 and greater. */ skamonkey@3594: int (*xSavepoint)(sqlite3_vtab *pVTab, int); skamonkey@3594: int (*xRelease)(sqlite3_vtab *pVTab, int); skamonkey@3594: int (*xRollbackTo)(sqlite3_vtab *pVTab, int); ds@1952: }; ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Virtual Table Indexing Information skamonkey@3594: ** KEYWORDS: sqlite3_index_info skamonkey@3594: ** skamonkey@3594: ** The sqlite3_index_info structure and its substructures is used as part skamonkey@3594: ** of the [virtual table] interface to skamonkey@3594: ** pass information into and receive the reply from the [xBestIndex] skamonkey@3594: ** method of a [virtual table module]. The fields under **Inputs** are the ds@1952: ** inputs to xBestIndex and are read-only. xBestIndex inserts its ds@1952: ** results into the **Outputs** fields. ds@1952: ** skamonkey@3594: ** ^(The aConstraint[] array records WHERE clause constraints of the form: skamonkey@3594: ** skamonkey@3594: **
column OP expr
skamonkey@3594: ** skamonkey@3594: ** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is skamonkey@3594: ** stored in aConstraint[].op using one of the skamonkey@3594: ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ skamonkey@3594: ** ^(The index of the column is stored in skamonkey@3594: ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the ds@1952: ** expr on the right-hand side can be evaluated (and thus the constraint skamonkey@3594: ** is usable) and false if it cannot.)^ skamonkey@3594: ** skamonkey@3594: ** ^The optimizer automatically inverts terms of the form "expr OP column" ds@1952: ** and makes other simplifications to the WHERE clause in an attempt to ds@1952: ** get as many WHERE clause terms into the form shown above as possible. skamonkey@3594: ** ^The aConstraint[] array only reports WHERE clause terms that are skamonkey@3594: ** relevant to the particular virtual table being queried. skamonkey@3594: ** skamonkey@3594: ** ^Information about the ORDER BY clause is stored in aOrderBy[]. skamonkey@3594: ** ^Each term of aOrderBy records a column of the ORDER BY clause. skamonkey@3594: ** skamonkey@3594: ** The [xBestIndex] method must fill aConstraintUsage[] with information skamonkey@3594: ** about what parameters to pass to xFilter. ^If argvIndex>0 then ds@1952: ** the right-hand side of the corresponding aConstraint[] is evaluated skamonkey@3594: ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit ds@1952: ** is true, then the constraint is assumed to be fully handled by the skamonkey@3594: ** virtual table and is not checked again by SQLite.)^ skamonkey@3594: ** skamonkey@3594: ** ^The idxNum and idxPtr values are recorded and passed into the skamonkey@3594: ** [xFilter] method. skamonkey@3594: ** ^[sqlite3_free()] is used to free idxPtr if and only if skamonkey@3594: ** needToFreeIdxPtr is true. skamonkey@3594: ** skamonkey@3594: ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in ds@1952: ** the correct order to satisfy the ORDER BY clause so that no separate ds@1952: ** sorting step is required. ds@1952: ** skamonkey@3594: ** ^The estimatedCost value is an estimate of the cost of doing the ds@1952: ** particular lookup. A full scan of a table with N entries should have ds@1952: ** a cost of N. A binary search of a table of N entries should have a ds@1952: ** cost of approximately log(N). ds@1952: */ ds@1952: struct sqlite3_index_info { ds@1952: /* Inputs */ ds@1952: int nConstraint; /* Number of entries in aConstraint */ ds@1952: struct sqlite3_index_constraint { ds@1952: int iColumn; /* Column on left-hand side of constraint */ ds@1952: unsigned char op; /* Constraint operator */ ds@1952: unsigned char usable; /* True if this constraint is usable */ ds@1952: int iTermOffset; /* Used internally - xBestIndex should ignore */ ds@1952: } *aConstraint; /* Table of WHERE clause constraints */ ds@1952: int nOrderBy; /* Number of terms in the ORDER BY clause */ ds@1952: struct sqlite3_index_orderby { ds@1952: int iColumn; /* Column number */ ds@1952: unsigned char desc; /* True for DESC. False for ASC. */ ds@1952: } *aOrderBy; /* The ORDER BY clause */ ds@1952: /* Outputs */ ds@1952: struct sqlite3_index_constraint_usage { ds@1952: int argvIndex; /* if >0, constraint is part of argv to xFilter */ ds@1952: unsigned char omit; /* Do not code a test for this constraint */ ds@1952: } *aConstraintUsage; ds@1952: int idxNum; /* Number used to identify the index */ ds@1952: char *idxStr; /* String, possibly obtained from sqlite3_malloc */ ds@1952: int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ ds@1952: int orderByConsumed; /* True if output is already ordered */ ds@1952: double estimatedCost; /* Estimated cost of using this index */ ds@1952: }; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Virtual Table Constraint Operator Codes skamonkey@3594: ** skamonkey@3594: ** These macros defined the allowed values for the skamonkey@3594: ** [sqlite3_index_info].aConstraint[].op field. Each value represents skamonkey@3594: ** an operator that is part of a constraint term in the wHERE clause of skamonkey@3594: ** a query that uses a [virtual table]. skamonkey@3594: */ ds@1952: #define SQLITE_INDEX_CONSTRAINT_EQ 2 ds@1952: #define SQLITE_INDEX_CONSTRAINT_GT 4 ds@1952: #define SQLITE_INDEX_CONSTRAINT_LE 8 ds@1952: #define SQLITE_INDEX_CONSTRAINT_LT 16 ds@1952: #define SQLITE_INDEX_CONSTRAINT_GE 32 ds@1952: #define SQLITE_INDEX_CONSTRAINT_MATCH 64 ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Register A Virtual Table Implementation skamonkey@3594: ** skamonkey@3594: ** ^These routines are used to register a new [virtual table module] name. skamonkey@3594: ** ^Module names must be registered before skamonkey@3594: ** creating a new [virtual table] using the module and before using a skamonkey@3594: ** preexisting [virtual table] for the module. skamonkey@3594: ** skamonkey@3594: ** ^The module name is registered on the [database connection] specified skamonkey@3594: ** by the first parameter. ^The name of the module is given by the skamonkey@3594: ** second parameter. ^The third parameter is a pointer to skamonkey@3594: ** the implementation of the [virtual table module]. ^The fourth skamonkey@3594: ** parameter is an arbitrary client data pointer that is passed through skamonkey@3594: ** into the [xCreate] and [xConnect] methods of the virtual table module skamonkey@3594: ** when a new virtual table is be being created or reinitialized. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_create_module_v2() interface has a fifth parameter which skamonkey@3594: ** is a pointer to a destructor for the pClientData. ^SQLite will skamonkey@3594: ** invoke the destructor function (if it is not NULL) when SQLite skamonkey@3594: ** no longer needs the pClientData pointer. ^The destructor will also skamonkey@3594: ** be invoked if the call to sqlite3_create_module_v2() fails. skamonkey@3594: ** ^The sqlite3_create_module() skamonkey@3594: ** interface is equivalent to sqlite3_create_module_v2() with a NULL skamonkey@3594: ** destructor. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_create_module( ds@1952: sqlite3 *db, /* SQLite connection to register module with */ ds@1952: const char *zName, /* Name of the module */ skamonkey@3594: const sqlite3_module *p, /* Methods for the module */ skamonkey@3594: void *pClientData /* Client data for xCreate/xConnect */ skamonkey@3594: ); skamonkey@3594: SQLITE_API int sqlite3_create_module_v2( skamonkey@3594: sqlite3 *db, /* SQLite connection to register module with */ skamonkey@3594: const char *zName, /* Name of the module */ skamonkey@3594: const sqlite3_module *p, /* Methods for the module */ skamonkey@3594: void *pClientData, /* Client data for xCreate/xConnect */ ds@1952: void(*xDestroy)(void*) /* Module destructor function */ ds@1952: ); ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Virtual Table Instance Object skamonkey@3594: ** KEYWORDS: sqlite3_vtab skamonkey@3594: ** skamonkey@3594: ** Every [virtual table module] implementation uses a subclass skamonkey@3594: ** of this object to describe a particular instance skamonkey@3594: ** of the [virtual table]. Each subclass will skamonkey@3594: ** be tailored to the specific needs of the module implementation. skamonkey@3594: ** The purpose of this superclass is to define certain fields that are skamonkey@3594: ** common to all module implementations. skamonkey@3594: ** skamonkey@3594: ** ^Virtual tables methods can set an error message by assigning a skamonkey@3594: ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should skamonkey@3594: ** take care that any prior string is freed by a call to [sqlite3_free()] skamonkey@3594: ** prior to assigning a new string to zErrMsg. ^After the error message ds@1952: ** is delivered up to the client application, the string will be automatically skamonkey@3594: ** freed by sqlite3_free() and the zErrMsg field will be zeroed. ds@1952: */ ds@1952: struct sqlite3_vtab { ds@1952: const sqlite3_module *pModule; /* The module for this virtual table */ skamonkey@3594: int nRef; /* NO LONGER USED */ ds@1952: char *zErrMsg; /* Error message from sqlite3_mprintf() */ ds@1952: /* Virtual table implementations will typically add additional fields */ ds@1952: }; ds@1952: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Virtual Table Cursor Object skamonkey@3594: ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} skamonkey@3594: ** skamonkey@3594: ** Every [virtual table module] implementation uses a subclass of the skamonkey@3594: ** following structure to describe cursors that point into the skamonkey@3594: ** [virtual table] and are used ds@1952: ** to loop through the virtual table. Cursors are created using the skamonkey@3594: ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed skamonkey@3594: ** by the [sqlite3_module.xClose | xClose] method. Cursors are used skamonkey@3594: ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods skamonkey@3594: ** of the module. Each module implementation will define ds@1952: ** the content of a cursor structure to suit its own needs. ds@1952: ** ds@1952: ** This superclass exists in order to define fields of the cursor that ds@1952: ** are common to all implementations. ds@1952: */ ds@1952: struct sqlite3_vtab_cursor { ds@1952: sqlite3_vtab *pVtab; /* Virtual table of this cursor */ ds@1952: /* Virtual table implementations will typically add additional fields */ ds@1952: }; ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Declare The Schema Of A Virtual Table skamonkey@3594: ** skamonkey@3594: ** ^The [xCreate] and [xConnect] methods of a skamonkey@3594: ** [virtual table module] call this interface ds@1952: ** to declare the format (the names and datatypes of the columns) of ds@1952: ** the virtual tables they implement. ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Overload A Function For A Virtual Table skamonkey@3594: ** skamonkey@3594: ** ^(Virtual tables can provide alternative implementations of functions skamonkey@3594: ** using the [xFindFunction] method of the [virtual table module]. skamonkey@3594: ** But global versions of those functions skamonkey@3594: ** must exist in order to be overloaded.)^ skamonkey@3594: ** skamonkey@3594: ** ^(This API makes sure a global version of a function with a particular ds@1952: ** name and number of parameters exists. If no such function exists skamonkey@3594: ** before this API is called, a new function is created.)^ ^The implementation ds@1952: ** of the new function always causes an exception to be thrown. So ds@1952: ** the new function is not good for anything by itself. Its only skamonkey@3594: ** purpose is to be a placeholder function that can be overloaded skamonkey@3594: ** by a [virtual table]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); ds@1952: ds@1952: /* ds@1952: ** The interface to the virtual-table mechanism defined above (back up ds@1952: ** to a comment remarkably similar to this one) is currently considered ds@1952: ** to be experimental. The interface might change in incompatible ways. ds@1952: ** If this is a problem for you, do not use the interface at this time. ds@1952: ** ds@1952: ** When the virtual-table mechanism stabilizes, we will declare the ds@1952: ** interface fixed, support it indefinitely, and remove this comment. ds@1952: */ ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: A Handle To An Open BLOB skamonkey@3594: ** KEYWORDS: {BLOB handle} {BLOB handles} skamonkey@3594: ** skamonkey@3594: ** An instance of this object represents an open BLOB on which skamonkey@3594: ** [sqlite3_blob_open | incremental BLOB I/O] can be performed. skamonkey@3594: ** ^Objects of this type are created by [sqlite3_blob_open()] skamonkey@3594: ** and destroyed by [sqlite3_blob_close()]. skamonkey@3594: ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces skamonkey@3594: ** can be used to read or write small subsections of the BLOB. skamonkey@3594: ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. ds@1952: */ ds@1952: typedef struct sqlite3_blob sqlite3_blob; ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Open A BLOB For Incremental I/O ds@1952: ** skamonkey@3594: ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located skamonkey@3594: ** in row iRow, column zColumn, table zTable in database zDb; skamonkey@3594: ** in other words, the same BLOB that would be selected by: ds@1952: ** ds@1952: ** 
skamonkey@3594: **     SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** ^If the flags parameter is non-zero, then the BLOB is opened for read skamonkey@3594: ** and write access. ^If it is zero, the BLOB is opened for read access. skamonkey@3594: ** ^It is not possible to open a column that is part of an index or primary skamonkey@3594: ** key for writing. ^If [foreign key constraints] are enabled, it is skamonkey@3594: ** not possible to open a column that is part of a [child key] for writing. skamonkey@3594: ** skamonkey@3594: ** ^Note that the database name is not the filename that contains skamonkey@3594: ** the database but rather the symbolic name of the database that skamonkey@3594: ** appears after the AS keyword when the database is connected using [ATTACH]. skamonkey@3594: ** ^For the main database file, the database name is "main". skamonkey@3594: ** ^For TEMP tables, the database name is "temp". skamonkey@3594: ** skamonkey@3594: ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written skamonkey@3594: ** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set skamonkey@3594: ** to be a null pointer.)^ skamonkey@3594: ** ^This function sets the [database connection] error code and message skamonkey@3594: ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related skamonkey@3594: ** functions. ^Note that the *ppBlob variable is always initialized in a skamonkey@3594: ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob skamonkey@3594: ** regardless of the success or failure of this routine. skamonkey@3594: ** skamonkey@3594: ** ^(If the row that a BLOB handle points to is modified by an skamonkey@3594: ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects skamonkey@3594: ** then the BLOB handle is marked as "expired". skamonkey@3594: ** This is true if any column of the row is changed, even a column skamonkey@3594: ** other than the one the BLOB handle is open on.)^ skamonkey@3594: ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for skamonkey@3594: ** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. skamonkey@3594: ** ^(Changes written into a BLOB prior to the BLOB expiring are not skamonkey@3594: ** rolled back by the expiration of the BLOB. Such changes will eventually skamonkey@3594: ** commit if the transaction continues to completion.)^ skamonkey@3594: ** skamonkey@3594: ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of skamonkey@3594: ** the opened blob. ^The size of a blob may not be changed by this skamonkey@3594: ** interface. Use the [UPDATE] SQL command to change the size of a skamonkey@3594: ** blob. skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces skamonkey@3594: ** and the built-in [zeroblob] SQL function can be used, if desired, skamonkey@3594: ** to create an empty, zero-filled blob in which to read or write using skamonkey@3594: ** this interface. skamonkey@3594: ** skamonkey@3594: ** To avoid a resource leak, every open [BLOB handle] should eventually skamonkey@3594: ** be released by a call to [sqlite3_blob_close()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_blob_open( ds@1952: sqlite3*, ds@1952: const char *zDb, ds@1952: const char *zTable, ds@1952: const char *zColumn, ds@1952: sqlite3_int64 iRow, ds@1952: int flags, ds@1952: sqlite3_blob **ppBlob ds@1952: ); ds@1952: ds@1952: /* skamonkey@3594: ** CAPI3REF: Move a BLOB Handle to a New Row skamonkey@3594: ** skamonkey@3594: ** ^This function is used to move an existing blob handle so that it points skamonkey@3594: ** to a different row of the same database table. ^The new row is identified skamonkey@3594: ** by the rowid value passed as the second argument. Only the row can be skamonkey@3594: ** changed. ^The database, table and column on which the blob handle is open skamonkey@3594: ** remain the same. Moving an existing blob handle to a new row can be skamonkey@3594: ** faster than closing the existing handle and opening a new one. skamonkey@3594: ** skamonkey@3594: ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - skamonkey@3594: ** it must exist and there must be either a blob or text value stored in skamonkey@3594: ** the nominated column.)^ ^If the new row is not present in the table, or if skamonkey@3594: ** it does not contain a blob or text value, or if another error occurs, an skamonkey@3594: ** SQLite error code is returned and the blob handle is considered aborted. skamonkey@3594: ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or skamonkey@3594: ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return skamonkey@3594: ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle skamonkey@3594: ** always returns zero. skamonkey@3594: ** skamonkey@3594: ** ^This function sets the database handle error code and message. skamonkey@3594: */ skamonkey@3594: SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Close A BLOB Handle skamonkey@3594: ** skamonkey@3594: ** ^Closes an open [BLOB handle]. skamonkey@3594: ** skamonkey@3594: ** ^Closing a BLOB shall cause the current transaction to commit skamonkey@3594: ** if there are no other BLOBs, no pending prepared statements, and the skamonkey@3594: ** database connection is in [autocommit mode]. skamonkey@3594: ** ^If any writes were made to the BLOB, they might be held in cache skamonkey@3594: ** until the close operation if they will fit. skamonkey@3594: ** skamonkey@3594: ** ^(Closing the BLOB often forces the changes skamonkey@3594: ** out to disk and so if any I/O errors occur, they will likely occur skamonkey@3594: ** at the time when the BLOB is closed. Any errors that occur during skamonkey@3594: ** closing are reported as a non-zero return value.)^ skamonkey@3594: ** skamonkey@3594: ** ^(The BLOB is closed unconditionally. Even if this routine returns skamonkey@3594: ** an error code, the BLOB is still closed.)^ skamonkey@3594: ** skamonkey@3594: ** ^Calling this routine with a null pointer (such as would be returned skamonkey@3594: ** by a failed call to [sqlite3_blob_open()]) is a harmless no-op. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_blob_close(sqlite3_blob *); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Return The Size Of An Open BLOB skamonkey@3594: ** skamonkey@3594: ** ^Returns the size in bytes of the BLOB accessible via the skamonkey@3594: ** successfully opened [BLOB handle] in its only argument. ^The skamonkey@3594: ** incremental blob I/O routines can only read or overwriting existing skamonkey@3594: ** blob content; they cannot change the size of a blob. skamonkey@3594: ** skamonkey@3594: ** This routine only works on a [BLOB handle] which has been created skamonkey@3594: ** by a prior successful call to [sqlite3_blob_open()] and which has not skamonkey@3594: ** been closed by [sqlite3_blob_close()]. Passing any other pointer in skamonkey@3594: ** to this routine results in undefined and probably undesirable behavior. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Read Data From A BLOB Incrementally skamonkey@3594: ** skamonkey@3594: ** ^(This function is used to read data from an open [BLOB handle] into a skamonkey@3594: ** caller-supplied buffer. N bytes of data are copied into buffer Z skamonkey@3594: ** from the open BLOB, starting at offset iOffset.)^ skamonkey@3594: ** skamonkey@3594: ** ^If offset iOffset is less than N bytes from the end of the BLOB, skamonkey@3594: ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is skamonkey@3594: ** less than zero, [SQLITE_ERROR] is returned and no data is read. skamonkey@3594: ** ^The size of the blob (and hence the maximum value of N+iOffset) skamonkey@3594: ** can be determined using the [sqlite3_blob_bytes()] interface. skamonkey@3594: ** skamonkey@3594: ** ^An attempt to read from an expired [BLOB handle] fails with an skamonkey@3594: ** error code of [SQLITE_ABORT]. skamonkey@3594: ** skamonkey@3594: ** ^(On success, sqlite3_blob_read() returns SQLITE_OK. skamonkey@3594: ** Otherwise, an [error code] or an [extended error code] is returned.)^ skamonkey@3594: ** skamonkey@3594: ** This routine only works on a [BLOB handle] which has been created skamonkey@3594: ** by a prior successful call to [sqlite3_blob_open()] and which has not skamonkey@3594: ** been closed by [sqlite3_blob_close()]. Passing any other pointer in skamonkey@3594: ** to this routine results in undefined and probably undesirable behavior. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_blob_write()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Write Data Into A BLOB Incrementally skamonkey@3594: ** skamonkey@3594: ** ^This function is used to write data into an open [BLOB handle] from a skamonkey@3594: ** caller-supplied buffer. ^N bytes of data are copied from the buffer Z skamonkey@3594: ** into the open BLOB, starting at offset iOffset. skamonkey@3594: ** skamonkey@3594: ** ^If the [BLOB handle] passed as the first argument was not opened for skamonkey@3594: ** writing (the flags parameter to [sqlite3_blob_open()] was zero), skamonkey@3594: ** this function returns [SQLITE_READONLY]. skamonkey@3594: ** skamonkey@3594: ** ^This function may only modify the contents of the BLOB; it is skamonkey@3594: ** not possible to increase the size of a BLOB using this API. skamonkey@3594: ** ^If offset iOffset is less than N bytes from the end of the BLOB, skamonkey@3594: ** [SQLITE_ERROR] is returned and no data is written. ^If N is skamonkey@3594: ** less than zero [SQLITE_ERROR] is returned and no data is written. skamonkey@3594: ** The size of the BLOB (and hence the maximum value of N+iOffset) skamonkey@3594: ** can be determined using the [sqlite3_blob_bytes()] interface. skamonkey@3594: ** skamonkey@3594: ** ^An attempt to write to an expired [BLOB handle] fails with an skamonkey@3594: ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred skamonkey@3594: ** before the [BLOB handle] expired are not rolled back by the skamonkey@3594: ** expiration of the handle, though of course those changes might skamonkey@3594: ** have been overwritten by the statement that expired the BLOB handle skamonkey@3594: ** or by other independent statements. skamonkey@3594: ** skamonkey@3594: ** ^(On success, sqlite3_blob_write() returns SQLITE_OK. skamonkey@3594: ** Otherwise, an [error code] or an [extended error code] is returned.)^ skamonkey@3594: ** skamonkey@3594: ** This routine only works on a [BLOB handle] which has been created skamonkey@3594: ** by a prior successful call to [sqlite3_blob_open()] and which has not skamonkey@3594: ** been closed by [sqlite3_blob_close()]. Passing any other pointer in skamonkey@3594: ** to this routine results in undefined and probably undesirable behavior. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_blob_read()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Virtual File System Objects ds@1952: ** ds@1952: ** A virtual filesystem (VFS) is an [sqlite3_vfs] object ds@1952: ** that SQLite uses to interact skamonkey@3594: ** with the underlying operating system. Most SQLite builds come with a ds@1952: ** single default VFS that is appropriate for the host computer. ds@1952: ** New VFSes can be registered and existing VFSes can be unregistered. ds@1952: ** The following interfaces are provided. ds@1952: ** skamonkey@3594: ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. skamonkey@3594: ** ^Names are case sensitive. skamonkey@3594: ** ^Names are zero-terminated UTF-8 strings. skamonkey@3594: ** ^If there is no match, a NULL pointer is returned. skamonkey@3594: ** ^If zVfsName is NULL then the default VFS is returned. skamonkey@3594: ** skamonkey@3594: ** ^New VFSes are registered with sqlite3_vfs_register(). skamonkey@3594: ** ^Each new VFS becomes the default VFS if the makeDflt flag is set. skamonkey@3594: ** ^The same VFS can be registered multiple times without injury. skamonkey@3594: ** ^To make an existing VFS into the default VFS, register it again ds@1952: ** with the makeDflt flag set. If two different VFSes with the ds@1952: ** same name are registered, the behavior is undefined. If a ds@1952: ** VFS is registered with a name that is NULL or an empty string, ds@1952: ** then the behavior is undefined. skamonkey@3594: ** skamonkey@3594: ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. skamonkey@3594: ** ^(If the default VFS is unregistered, another VFS is chosen as skamonkey@3594: ** the default. The choice for the new VFS is arbitrary.)^ skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); skamonkey@3594: SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); skamonkey@3594: SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Mutexes ds@1952: ** ds@1952: ** The SQLite core uses these routines for thread skamonkey@3594: ** synchronization. Though they are intended for internal ds@1952: ** use by SQLite, code that links against SQLite is ds@1952: ** permitted to use any of these routines. ds@1952: ** skamonkey@3594: ** The SQLite source code contains multiple implementations ds@1952: ** of these mutex routines. An appropriate implementation skamonkey@3594: ** is selected automatically at compile-time. ^(The following ds@1952: ** implementations are available in the SQLite core: ds@1952: ** ds@1952: ** )^ skamonkey@3594: ** skamonkey@3594: ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines skamonkey@3594: ** that does no real locking and is appropriate for use in skamonkey@3594: ** a single-threaded application. ^The SQLITE_MUTEX_OS2, skamonkey@3594: ** SQLITE_MUTEX_PTHREADS, and SQLITE_MUTEX_W32 implementations skamonkey@3594: ** are appropriate for use on OS/2, Unix, and Windows. skamonkey@3594: ** skamonkey@3594: ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor ds@1952: ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex skamonkey@3594: ** implementation is included with the library. In this case the skamonkey@3594: ** application must supply a custom mutex implementation using the skamonkey@3594: ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function skamonkey@3594: ** before calling sqlite3_initialize() or any other public sqlite3_ skamonkey@3594: ** function that calls sqlite3_initialize().)^ skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_mutex_alloc() routine allocates a new skamonkey@3594: ** mutex and returns a pointer to it. ^If it returns NULL skamonkey@3594: ** that means that a mutex could not be allocated. ^SQLite skamonkey@3594: ** will unwind its stack and return an error. ^(The argument ds@1952: ** to sqlite3_mutex_alloc() is one of these integer constants: ds@1952: ** ds@1952: ** )^ skamonkey@3594: ** skamonkey@3594: ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) skamonkey@3594: ** cause sqlite3_mutex_alloc() to create skamonkey@3594: ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE ds@1952: ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. ds@1952: ** The mutex implementation does not need to make a distinction ds@1952: ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does skamonkey@3594: ** not want to. ^SQLite will only request a recursive mutex in skamonkey@3594: ** cases where it really needs one. ^If a faster non-recursive mutex ds@1952: ** implementation is available on the host platform, the mutex subsystem ds@1952: ** might return such a mutex in response to SQLITE_MUTEX_FAST. ds@1952: ** skamonkey@3594: ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other skamonkey@3594: ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return skamonkey@3594: ** a pointer to a static preexisting mutex. ^Six static mutexes are ds@1952: ** used by the current version of SQLite. Future versions of SQLite ds@1952: ** may add additional static mutexes. Static mutexes are for internal ds@1952: ** use by SQLite only. Applications that use SQLite mutexes should ds@1952: ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or ds@1952: ** SQLITE_MUTEX_RECURSIVE. ds@1952: ** skamonkey@3594: ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST ds@1952: ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() skamonkey@3594: ** returns a different mutex on every call. ^But for the static ds@1952: ** mutex types, the same mutex is returned on every call that has ds@1952: ** the same type number. ds@1952: ** skamonkey@3594: ** ^The sqlite3_mutex_free() routine deallocates a previously skamonkey@3594: ** allocated dynamic mutex. ^SQLite is careful to deallocate every skamonkey@3594: ** dynamic mutex that it allocates. The dynamic mutexes must not be in ds@1952: ** use when they are deallocated. Attempting to deallocate a static skamonkey@3594: ** mutex results in undefined behavior. ^SQLite never deallocates ds@1952: ** a static mutex. ds@1952: ** skamonkey@3594: ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt skamonkey@3594: ** to enter a mutex. ^If another thread is already within the mutex, ds@1952: ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return skamonkey@3594: ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] skamonkey@3594: ** upon successful entry. ^(Mutexes created using skamonkey@3594: ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. skamonkey@3594: ** In such cases the, ds@1952: ** mutex must be exited an equal number of times before another thread skamonkey@3594: ** can enter.)^ ^(If the same thread tries to enter any other skamonkey@3594: ** kind of mutex more than once, the behavior is undefined. skamonkey@3594: ** SQLite will never exhibit skamonkey@3594: ** such behavior in its own use of mutexes.)^ skamonkey@3594: ** skamonkey@3594: ** ^(Some systems (for example, Windows 95) do not support the operation skamonkey@3594: ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() skamonkey@3594: ** will always return SQLITE_BUSY. The SQLite core only ever uses skamonkey@3594: ** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^ skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_mutex_leave() routine exits a mutex that was skamonkey@3594: ** previously entered by the same thread. ^(The behavior ds@1952: ** is undefined if the mutex is not currently entered by the ds@1952: ** calling thread or is not currently allocated. SQLite will skamonkey@3594: ** never do either.)^ skamonkey@3594: ** skamonkey@3594: ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or skamonkey@3594: ** sqlite3_mutex_leave() is a NULL pointer, then all three routines skamonkey@3594: ** behave as no-ops. ds@1952: ** ds@1952: ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. ds@1952: */ skamonkey@3594: SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); skamonkey@3594: SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); skamonkey@3594: SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); skamonkey@3594: SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); skamonkey@3594: SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Mutex Methods Object skamonkey@3594: ** skamonkey@3594: ** An instance of this structure defines the low-level routines skamonkey@3594: ** used to allocate and use mutexes. skamonkey@3594: ** skamonkey@3594: ** Usually, the default mutex implementations provided by SQLite are skamonkey@3594: ** sufficient, however the user has the option of substituting a custom skamonkey@3594: ** implementation for specialized deployments or systems for which SQLite skamonkey@3594: ** does not provide a suitable implementation. In this case, the user skamonkey@3594: ** creates and populates an instance of this structure to pass skamonkey@3594: ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. skamonkey@3594: ** Additionally, an instance of this structure can be used as an skamonkey@3594: ** output variable when querying the system for the current mutex skamonkey@3594: ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. skamonkey@3594: ** skamonkey@3594: ** ^The xMutexInit method defined by this structure is invoked as skamonkey@3594: ** part of system initialization by the sqlite3_initialize() function. skamonkey@3594: ** ^The xMutexInit routine is called by SQLite exactly once for each skamonkey@3594: ** effective call to [sqlite3_initialize()]. skamonkey@3594: ** skamonkey@3594: ** ^The xMutexEnd method defined by this structure is invoked as skamonkey@3594: ** part of system shutdown by the sqlite3_shutdown() function. The skamonkey@3594: ** implementation of this method is expected to release all outstanding skamonkey@3594: ** resources obtained by the mutex methods implementation, especially skamonkey@3594: ** those obtained by the xMutexInit method. ^The xMutexEnd() skamonkey@3594: ** interface is invoked exactly once for each call to [sqlite3_shutdown()]. skamonkey@3594: ** skamonkey@3594: ** ^(The remaining seven methods defined by this structure (xMutexAlloc, skamonkey@3594: ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and skamonkey@3594: ** xMutexNotheld) implement the following interfaces (respectively): skamonkey@3594: ** skamonkey@3594: ** )^ skamonkey@3594: ** skamonkey@3594: ** The only difference is that the public sqlite3_XXX functions enumerated skamonkey@3594: ** above silently ignore any invocations that pass a NULL pointer instead skamonkey@3594: ** of a valid mutex handle. The implementations of the methods defined skamonkey@3594: ** by this structure are not required to handle this case, the results skamonkey@3594: ** of passing a NULL pointer instead of a valid mutex handle are undefined skamonkey@3594: ** (i.e. it is acceptable to provide an implementation that segfaults if skamonkey@3594: ** it is passed a NULL pointer). skamonkey@3594: ** skamonkey@3594: ** The xMutexInit() method must be threadsafe. ^It must be harmless to skamonkey@3594: ** invoke xMutexInit() multiple times within the same process and without skamonkey@3594: ** intervening calls to xMutexEnd(). Second and subsequent calls to skamonkey@3594: ** xMutexInit() must be no-ops. skamonkey@3594: ** skamonkey@3594: ** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] skamonkey@3594: ** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory skamonkey@3594: ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite skamonkey@3594: ** memory allocation for a fast or recursive mutex. skamonkey@3594: ** skamonkey@3594: ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is skamonkey@3594: ** called, but only if the prior call to xMutexInit returned SQLITE_OK. skamonkey@3594: ** If xMutexInit fails in any way, it is expected to clean up after itself skamonkey@3594: ** prior to returning. skamonkey@3594: */ skamonkey@3594: typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; skamonkey@3594: struct sqlite3_mutex_methods { skamonkey@3594: int (*xMutexInit)(void); skamonkey@3594: int (*xMutexEnd)(void); skamonkey@3594: sqlite3_mutex *(*xMutexAlloc)(int); skamonkey@3594: void (*xMutexFree)(sqlite3_mutex *); skamonkey@3594: void (*xMutexEnter)(sqlite3_mutex *); skamonkey@3594: int (*xMutexTry)(sqlite3_mutex *); skamonkey@3594: void (*xMutexLeave)(sqlite3_mutex *); skamonkey@3594: int (*xMutexHeld)(sqlite3_mutex *); skamonkey@3594: int (*xMutexNotheld)(sqlite3_mutex *); skamonkey@3594: }; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Mutex Verification Routines ds@1952: ** ds@1952: ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines skamonkey@3594: ** are intended for use inside assert() statements. ^The SQLite core ds@1952: ** never uses these routines except inside an assert() and applications skamonkey@3594: ** are advised to follow the lead of the core. ^The SQLite core only ds@1952: ** provides implementations for these routines when it is compiled skamonkey@3594: ** with the SQLITE_DEBUG flag. ^External mutex implementations ds@1952: ** are only required to provide these routines if SQLITE_DEBUG is ds@1952: ** defined and if NDEBUG is not defined. ds@1952: ** skamonkey@3594: ** ^These routines should return true if the mutex in their argument ds@1952: ** is held or not held, respectively, by the calling thread. ds@1952: ** skamonkey@3594: ** ^The implementation is not required to provide versions of these skamonkey@3594: ** routines that actually work. If the implementation does not provide working skamonkey@3594: ** versions of these routines, it should at least provide stubs that always skamonkey@3594: ** return true so that one does not get spurious assertion failures. skamonkey@3594: ** skamonkey@3594: ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then skamonkey@3594: ** the routine should return 1. This seems counter-intuitive since skamonkey@3594: ** clearly the mutex cannot be held if it does not exist. But ds@1952: ** the reason the mutex does not exist is because the build is not ds@1952: ** using mutexes. And we do not want the assert() containing the ds@1952: ** call to sqlite3_mutex_held() to fail, so a non-zero return is skamonkey@3594: ** the appropriate thing to do. ^The sqlite3_mutex_notheld() ds@1952: ** interface should also return 1 when given a NULL pointer. ds@1952: */ skamonkey@3594: #ifndef NDEBUG skamonkey@3594: SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); skamonkey@3594: SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); skamonkey@3594: #endif ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Mutex Types ds@1952: ** ds@1952: ** The [sqlite3_mutex_alloc()] interface takes a single argument ds@1952: ** which is one of these integer constants. skamonkey@3594: ** skamonkey@3594: ** The set of static mutexes may change from one SQLite release to the skamonkey@3594: ** next. Applications that override the built-in mutex logic must be skamonkey@3594: ** prepared to accommodate additional static mutexes. ds@1952: */ ds@1952: #define SQLITE_MUTEX_FAST 0 ds@1952: #define SQLITE_MUTEX_RECURSIVE 1 ds@1952: #define SQLITE_MUTEX_STATIC_MASTER 2 ds@1952: #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ skamonkey@3594: #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ skamonkey@3594: #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ ds@1952: #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ ds@1952: #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ skamonkey@3594: #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ skamonkey@3594: #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Retrieve the mutex for a database connection skamonkey@3594: ** skamonkey@3594: ** ^This interface returns a pointer the [sqlite3_mutex] object that skamonkey@3594: ** serializes access to the [database connection] given in the argument skamonkey@3594: ** when the [threading mode] is Serialized. skamonkey@3594: ** ^If the [threading mode] is Single-thread or Multi-thread then this skamonkey@3594: ** routine returns a NULL pointer. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); ds@1952: ds@1952: /* ds@1952: ** CAPI3REF: Low-Level Control Of Database Files ds@1952: ** skamonkey@3594: ** ^The [sqlite3_file_control()] interface makes a direct call to the ds@1952: ** xFileControl method for the [sqlite3_io_methods] object associated skamonkey@3594: ** with a particular database identified by the second argument. ^The skamonkey@3594: ** name of the database is "main" for the main database or "temp" for the skamonkey@3594: ** TEMP database, or the name that appears after the AS keyword for skamonkey@3594: ** databases that are added using the [ATTACH] SQL command. skamonkey@3594: ** ^A NULL pointer can be used in place of "main" to refer to the skamonkey@3594: ** main database file. skamonkey@3594: ** ^The third and fourth parameters to this routine ds@1952: ** are passed directly through to the second and third parameters of skamonkey@3594: ** the xFileControl method. ^The return value of the xFileControl ds@1952: ** method becomes the return value of this routine. ds@1952: ** skamonkey@3594: ** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes skamonkey@3594: ** a pointer to the underlying [sqlite3_file] object to be written into skamonkey@3594: ** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER skamonkey@3594: ** case is a short-circuit path which does not actually invoke the skamonkey@3594: ** underlying sqlite3_io_methods.xFileControl method. skamonkey@3594: ** skamonkey@3594: ** ^If the second parameter (zDbName) does not match the name of any skamonkey@3594: ** open database file, then SQLITE_ERROR is returned. ^This error ds@1952: ** code is not remembered and will not be recalled by [sqlite3_errcode()] ds@1952: ** or [sqlite3_errmsg()]. The underlying xFileControl method might ds@1952: ** also return SQLITE_ERROR. There is no way to distinguish between ds@1952: ** an incorrect zDbName and an SQLITE_ERROR return from the underlying ds@1952: ** xFileControl method. ds@1952: ** ds@1952: ** See also: [SQLITE_FCNTL_LOCKSTATE] ds@1952: */ skamonkey@3594: SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Testing Interface skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_test_control() interface is used to read out internal skamonkey@3594: ** state of SQLite and to inject faults into SQLite for testing skamonkey@3594: ** purposes. ^The first parameter is an operation code that determines skamonkey@3594: ** the number, meaning, and operation of all subsequent parameters. skamonkey@3594: ** skamonkey@3594: ** This interface is not for use by applications. It exists solely skamonkey@3594: ** for verifying the correct operation of the SQLite library. Depending skamonkey@3594: ** on how the SQLite library is compiled, this interface might not exist. skamonkey@3594: ** skamonkey@3594: ** The details of the operation codes, their meanings, the parameters skamonkey@3594: ** they take, and what they do are all subject to change without notice. skamonkey@3594: ** Unlike most of the SQLite API, this function is not guaranteed to skamonkey@3594: ** operate consistently from one release to the next. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_test_control(int op, ...); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Testing Interface Operation Codes skamonkey@3594: ** skamonkey@3594: ** These constants are the valid operation code parameters used skamonkey@3594: ** as the first argument to [sqlite3_test_control()]. skamonkey@3594: ** skamonkey@3594: ** These parameters and their meanings are subject to change skamonkey@3594: ** without notice. These values are for testing purposes only. skamonkey@3594: ** Applications should not use any of these parameters or the skamonkey@3594: ** [sqlite3_test_control()] interface. skamonkey@3594: */ skamonkey@3594: #define SQLITE_TESTCTRL_FIRST 5 skamonkey@3594: #define SQLITE_TESTCTRL_PRNG_SAVE 5 skamonkey@3594: #define SQLITE_TESTCTRL_PRNG_RESTORE 6 skamonkey@3594: #define SQLITE_TESTCTRL_PRNG_RESET 7 skamonkey@3594: #define SQLITE_TESTCTRL_BITVEC_TEST 8 skamonkey@3594: #define SQLITE_TESTCTRL_FAULT_INSTALL 9 skamonkey@3594: #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 skamonkey@3594: #define SQLITE_TESTCTRL_PENDING_BYTE 11 skamonkey@3594: #define SQLITE_TESTCTRL_ASSERT 12 skamonkey@3594: #define SQLITE_TESTCTRL_ALWAYS 13 skamonkey@3594: #define SQLITE_TESTCTRL_RESERVE 14 skamonkey@3594: #define SQLITE_TESTCTRL_OPTIMIZATIONS 15 skamonkey@3594: #define SQLITE_TESTCTRL_ISKEYWORD 16 skamonkey@3594: #define SQLITE_TESTCTRL_SCRATCHMALLOC 17 skamonkey@3594: #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 skamonkey@3594: #define SQLITE_TESTCTRL_EXPLAIN_STMT 19 skamonkey@3594: #define SQLITE_TESTCTRL_LAST 19 skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: SQLite Runtime Status skamonkey@3594: ** skamonkey@3594: ** ^This interface is used to retrieve runtime status information skamonkey@3594: ** about the performance of SQLite, and optionally to reset various skamonkey@3594: ** highwater marks. ^The first argument is an integer code for skamonkey@3594: ** the specific parameter to measure. ^(Recognized integer codes skamonkey@3594: ** are of the form [status parameters | SQLITE_STATUS_...].)^ skamonkey@3594: ** ^The current value of the parameter is returned into *pCurrent. skamonkey@3594: ** ^The highest recorded value is returned in *pHighwater. ^If the skamonkey@3594: ** resetFlag is true, then the highest record value is reset after skamonkey@3594: ** *pHighwater is written. ^(Some parameters do not record the highest skamonkey@3594: ** value. For those parameters skamonkey@3594: ** nothing is written into *pHighwater and the resetFlag is ignored.)^ skamonkey@3594: ** ^(Other parameters record only the highwater mark and not the current skamonkey@3594: ** value. For these latter parameters nothing is written into *pCurrent.)^ skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_status() routine returns SQLITE_OK on success and a skamonkey@3594: ** non-zero [error code] on failure. skamonkey@3594: ** skamonkey@3594: ** This routine is threadsafe but is not atomic. This routine can be skamonkey@3594: ** called while other threads are running the same or different SQLite skamonkey@3594: ** interfaces. However the values returned in *pCurrent and skamonkey@3594: ** *pHighwater reflect the status of SQLite at different points in time skamonkey@3594: ** and it is possible that another thread might change the parameter skamonkey@3594: ** in between the times when *pCurrent and *pHighwater are written. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_db_status()] skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Status Parameters skamonkey@3594: ** KEYWORDS: {status parameters} skamonkey@3594: ** skamonkey@3594: ** These integer constants designate various run-time status parameters skamonkey@3594: ** that can be returned by [sqlite3_status()]. skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: ** [[SQLITE_STATUS_MEMORY_USED]] ^(
SQLITE_STATUS_MEMORY_USED
skamonkey@3594: **
This parameter is the current amount of memory checked out skamonkey@3594: ** using [sqlite3_malloc()], either directly or indirectly. The skamonkey@3594: ** figure includes calls made to [sqlite3_malloc()] by the application skamonkey@3594: ** and internal memory usage by the SQLite library. Scratch memory skamonkey@3594: ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache skamonkey@3594: ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in skamonkey@3594: ** this parameter. The amount returned is the sum of the allocation skamonkey@3594: ** sizes as reported by the xSize method in [sqlite3_mem_methods].
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(
SQLITE_STATUS_MALLOC_SIZE
skamonkey@3594: **
This parameter records the largest memory allocation request skamonkey@3594: ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their skamonkey@3594: ** internal equivalents). Only the value returned in the skamonkey@3594: ** *pHighwater parameter to [sqlite3_status()] is of interest. skamonkey@3594: ** The value written into the *pCurrent parameter is undefined.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(
SQLITE_STATUS_MALLOC_COUNT
skamonkey@3594: **
This parameter records the number of separate memory allocations skamonkey@3594: ** currently checked out.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(
SQLITE_STATUS_PAGECACHE_USED
skamonkey@3594: **
This parameter returns the number of pages used out of the skamonkey@3594: ** [pagecache memory allocator] that was configured using skamonkey@3594: ** [SQLITE_CONFIG_PAGECACHE]. The skamonkey@3594: ** value returned is in pages, not in bytes.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] skamonkey@3594: ** ^(
SQLITE_STATUS_PAGECACHE_OVERFLOW
skamonkey@3594: **
This parameter returns the number of bytes of page cache skamonkey@3594: ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] skamonkey@3594: ** buffer and where forced to overflow to [sqlite3_malloc()]. The skamonkey@3594: ** returned value includes allocations that overflowed because they skamonkey@3594: ** where too large (they were larger than the "sz" parameter to skamonkey@3594: ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because skamonkey@3594: ** no space was left in the page cache.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(
SQLITE_STATUS_PAGECACHE_SIZE
skamonkey@3594: **
This parameter records the largest memory allocation request skamonkey@3594: ** handed to [pagecache memory allocator]. Only the value returned in the skamonkey@3594: ** *pHighwater parameter to [sqlite3_status()] is of interest. skamonkey@3594: ** The value written into the *pCurrent parameter is undefined.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_SCRATCH_USED]] ^(
SQLITE_STATUS_SCRATCH_USED
skamonkey@3594: **
This parameter returns the number of allocations used out of the skamonkey@3594: ** [scratch memory allocator] configured using skamonkey@3594: ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not skamonkey@3594: ** in bytes. Since a single thread may only have one scratch allocation skamonkey@3594: ** outstanding at time, this parameter also reports the number of threads skamonkey@3594: ** using scratch memory at the same time.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(
SQLITE_STATUS_SCRATCH_OVERFLOW
skamonkey@3594: **
This parameter returns the number of bytes of scratch memory skamonkey@3594: ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] skamonkey@3594: ** buffer and where forced to overflow to [sqlite3_malloc()]. The values skamonkey@3594: ** returned include overflows because the requested allocation was too skamonkey@3594: ** larger (that is, because the requested allocation was larger than the skamonkey@3594: ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer skamonkey@3594: ** slots were available. skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(
SQLITE_STATUS_SCRATCH_SIZE
skamonkey@3594: **
This parameter records the largest memory allocation request skamonkey@3594: ** handed to [scratch memory allocator]. Only the value returned in the skamonkey@3594: ** *pHighwater parameter to [sqlite3_status()] is of interest. skamonkey@3594: ** The value written into the *pCurrent parameter is undefined.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STATUS_PARSER_STACK]] ^(
SQLITE_STATUS_PARSER_STACK
skamonkey@3594: **
This parameter records the deepest parser stack. It is only skamonkey@3594: ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].
)^ skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** New status parameters may be added from time to time. skamonkey@3594: */ skamonkey@3594: #define SQLITE_STATUS_MEMORY_USED 0 skamonkey@3594: #define SQLITE_STATUS_PAGECACHE_USED 1 skamonkey@3594: #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 skamonkey@3594: #define SQLITE_STATUS_SCRATCH_USED 3 skamonkey@3594: #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 skamonkey@3594: #define SQLITE_STATUS_MALLOC_SIZE 5 skamonkey@3594: #define SQLITE_STATUS_PARSER_STACK 6 skamonkey@3594: #define SQLITE_STATUS_PAGECACHE_SIZE 7 skamonkey@3594: #define SQLITE_STATUS_SCRATCH_SIZE 8 skamonkey@3594: #define SQLITE_STATUS_MALLOC_COUNT 9 skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Database Connection Status skamonkey@3594: ** skamonkey@3594: ** ^This interface is used to retrieve runtime status information skamonkey@3594: ** about a single [database connection]. ^The first argument is the skamonkey@3594: ** database connection object to be interrogated. ^The second argument skamonkey@3594: ** is an integer constant, taken from the set of skamonkey@3594: ** [SQLITE_DBSTATUS options], that skamonkey@3594: ** determines the parameter to interrogate. The set of skamonkey@3594: ** [SQLITE_DBSTATUS options] is likely skamonkey@3594: ** to grow in future releases of SQLite. skamonkey@3594: ** skamonkey@3594: ** ^The current value of the requested parameter is written into *pCur skamonkey@3594: ** and the highest instantaneous value is written into *pHiwtr. ^If skamonkey@3594: ** the resetFlg is true, then the highest instantaneous value is skamonkey@3594: ** reset back down to the current value. skamonkey@3594: ** skamonkey@3594: ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a skamonkey@3594: ** non-zero [error code] on failure. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Status Parameters for database connections skamonkey@3594: ** KEYWORDS: {SQLITE_DBSTATUS options} skamonkey@3594: ** skamonkey@3594: ** These constants are the available integer "verbs" that can be passed as skamonkey@3594: ** the second argument to the [sqlite3_db_status()] interface. skamonkey@3594: ** skamonkey@3594: ** New verbs may be added in future releases of SQLite. Existing verbs skamonkey@3594: ** might be discontinued. Applications should check the return code from skamonkey@3594: ** [sqlite3_db_status()] to make sure that the call worked. skamonkey@3594: ** The [sqlite3_db_status()] interface will return a non-zero error code skamonkey@3594: ** if a discontinued or unsupported verb is invoked. skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(
SQLITE_DBSTATUS_LOOKASIDE_USED
skamonkey@3594: **
This parameter returns the number of lookaside memory slots currently skamonkey@3594: ** checked out.
)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(
SQLITE_DBSTATUS_LOOKASIDE_HIT
skamonkey@3594: **
This parameter returns the number malloc attempts that were skamonkey@3594: ** satisfied using lookaside memory. Only the high-water value is meaningful; skamonkey@3594: ** the current value is always zero.)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] skamonkey@3594: ** ^(
SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE
skamonkey@3594: **
This parameter returns the number malloc attempts that might have skamonkey@3594: ** been satisfied using lookaside memory but failed due to the amount of skamonkey@3594: ** memory requested being larger than the lookaside slot size. skamonkey@3594: ** Only the high-water value is meaningful; skamonkey@3594: ** the current value is always zero.)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] skamonkey@3594: ** ^(
SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL
skamonkey@3594: **
This parameter returns the number malloc attempts that might have skamonkey@3594: ** been satisfied using lookaside memory but failed due to all lookaside skamonkey@3594: ** memory already being in use. skamonkey@3594: ** Only the high-water value is meaningful; skamonkey@3594: ** the current value is always zero.)^ skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(
SQLITE_DBSTATUS_CACHE_USED
skamonkey@3594: **
This parameter returns the approximate number of of bytes of heap skamonkey@3594: ** memory used by all pager caches associated with the database connection.)^ skamonkey@3594: ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(
SQLITE_DBSTATUS_SCHEMA_USED
skamonkey@3594: **
This parameter returns the approximate number of of bytes of heap skamonkey@3594: ** memory used to store the schema for all databases associated skamonkey@3594: ** with the connection - main, temp, and any [ATTACH]-ed databases.)^ skamonkey@3594: ** ^The full amount of memory used by the schemas is reported, even if the skamonkey@3594: ** schema memory is shared with other database connections due to skamonkey@3594: ** [shared cache mode] being enabled. skamonkey@3594: ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_STMT_USED]] ^(
SQLITE_DBSTATUS_STMT_USED
skamonkey@3594: **
This parameter returns the approximate number of of bytes of heap skamonkey@3594: ** and lookaside memory used by all prepared statements associated with skamonkey@3594: ** the database connection.)^ skamonkey@3594: ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(
SQLITE_DBSTATUS_CACHE_HIT
skamonkey@3594: **
This parameter returns the number of pager cache hits that have skamonkey@3594: ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT skamonkey@3594: ** is always 0. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(
SQLITE_DBSTATUS_CACHE_MISS
skamonkey@3594: **
This parameter returns the number of pager cache misses that have skamonkey@3594: ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS skamonkey@3594: ** is always 0. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(
SQLITE_DBSTATUS_CACHE_WRITE
skamonkey@3594: **
This parameter returns the number of dirty cache entries that have skamonkey@3594: ** been written to disk. Specifically, the number of pages written to the skamonkey@3594: ** wal file in wal mode databases, or the number of pages written to the skamonkey@3594: ** database file in rollback mode databases. Any pages written as part of skamonkey@3594: ** transaction rollback or database recovery operations are not included. skamonkey@3594: ** If an IO or other error occurs while writing a page to disk, the effect skamonkey@3594: ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The skamonkey@3594: ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. skamonkey@3594: **
skamonkey@3594: **
skamonkey@3594: */ skamonkey@3594: #define SQLITE_DBSTATUS_LOOKASIDE_USED 0 skamonkey@3594: #define SQLITE_DBSTATUS_CACHE_USED 1 skamonkey@3594: #define SQLITE_DBSTATUS_SCHEMA_USED 2 skamonkey@3594: #define SQLITE_DBSTATUS_STMT_USED 3 skamonkey@3594: #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 skamonkey@3594: #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 skamonkey@3594: #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 skamonkey@3594: #define SQLITE_DBSTATUS_CACHE_HIT 7 skamonkey@3594: #define SQLITE_DBSTATUS_CACHE_MISS 8 skamonkey@3594: #define SQLITE_DBSTATUS_CACHE_WRITE 9 skamonkey@3594: #define SQLITE_DBSTATUS_MAX 9 /* Largest defined DBSTATUS */ skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Prepared Statement Status skamonkey@3594: ** skamonkey@3594: ** ^(Each prepared statement maintains various skamonkey@3594: ** [SQLITE_STMTSTATUS counters] that measure the number skamonkey@3594: ** of times it has performed specific operations.)^ These counters can skamonkey@3594: ** be used to monitor the performance characteristics of the prepared skamonkey@3594: ** statements. For example, if the number of table steps greatly exceeds skamonkey@3594: ** the number of table searches or result rows, that would tend to indicate skamonkey@3594: ** that the prepared statement is using a full table scan rather than skamonkey@3594: ** an index. skamonkey@3594: ** skamonkey@3594: ** ^(This interface is used to retrieve and reset counter values from skamonkey@3594: ** a [prepared statement]. The first argument is the prepared statement skamonkey@3594: ** object to be interrogated. The second argument skamonkey@3594: ** is an integer code for a specific [SQLITE_STMTSTATUS counter] skamonkey@3594: ** to be interrogated.)^ skamonkey@3594: ** ^The current value of the requested counter is returned. skamonkey@3594: ** ^If the resetFlg is true, then the counter is reset to zero after this skamonkey@3594: ** interface call returns. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_status()] and [sqlite3_db_status()]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Status Parameters for prepared statements skamonkey@3594: ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} skamonkey@3594: ** skamonkey@3594: ** These preprocessor macros define integer codes that name counter skamonkey@3594: ** values associated with the [sqlite3_stmt_status()] interface. skamonkey@3594: ** The meanings of the various counters are as follows: skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]]
SQLITE_STMTSTATUS_FULLSCAN_STEP
skamonkey@3594: **
^This is the number of times that SQLite has stepped forward in skamonkey@3594: ** a table as part of a full table scan. Large numbers for this counter skamonkey@3594: ** may indicate opportunities for performance improvement through skamonkey@3594: ** careful use of indices.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STMTSTATUS_SORT]]
SQLITE_STMTSTATUS_SORT
skamonkey@3594: **
^This is the number of sort operations that have occurred. skamonkey@3594: ** A non-zero value in this counter may indicate an opportunity to skamonkey@3594: ** improvement performance through careful use of indices.
skamonkey@3594: ** skamonkey@3594: ** [[SQLITE_STMTSTATUS_AUTOINDEX]]
SQLITE_STMTSTATUS_AUTOINDEX
skamonkey@3594: **
^This is the number of rows inserted into transient indices that skamonkey@3594: ** were created automatically in order to help joins run faster. skamonkey@3594: ** A non-zero value in this counter may indicate an opportunity to skamonkey@3594: ** improvement performance by adding permanent indices that do not skamonkey@3594: ** need to be reinitialized each time the statement is run.
skamonkey@3594: **
skamonkey@3594: */ skamonkey@3594: #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 skamonkey@3594: #define SQLITE_STMTSTATUS_SORT 2 skamonkey@3594: #define SQLITE_STMTSTATUS_AUTOINDEX 3 skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Custom Page Cache Object skamonkey@3594: ** skamonkey@3594: ** The sqlite3_pcache type is opaque. It is implemented by skamonkey@3594: ** the pluggable module. The SQLite core has no knowledge of skamonkey@3594: ** its size or internal structure and never deals with the skamonkey@3594: ** sqlite3_pcache object except by holding and passing pointers skamonkey@3594: ** to the object. skamonkey@3594: ** skamonkey@3594: ** See [sqlite3_pcache_methods2] for additional information. skamonkey@3594: */ skamonkey@3594: typedef struct sqlite3_pcache sqlite3_pcache; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Custom Page Cache Object skamonkey@3594: ** skamonkey@3594: ** The sqlite3_pcache_page object represents a single page in the skamonkey@3594: ** page cache. The page cache will allocate instances of this skamonkey@3594: ** object. Various methods of the page cache use pointers to instances skamonkey@3594: ** of this object as parameters or as their return value. skamonkey@3594: ** skamonkey@3594: ** See [sqlite3_pcache_methods2] for additional information. skamonkey@3594: */ skamonkey@3594: typedef struct sqlite3_pcache_page sqlite3_pcache_page; skamonkey@3594: struct sqlite3_pcache_page { skamonkey@3594: void *pBuf; /* The content of the page */ skamonkey@3594: void *pExtra; /* Extra information associated with the page */ skamonkey@3594: }; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Application Defined Page Cache. skamonkey@3594: ** KEYWORDS: {page cache} skamonkey@3594: ** skamonkey@3594: ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can skamonkey@3594: ** register an alternative page cache implementation by passing in an skamonkey@3594: ** instance of the sqlite3_pcache_methods2 structure.)^ skamonkey@3594: ** In many applications, most of the heap memory allocated by skamonkey@3594: ** SQLite is used for the page cache. skamonkey@3594: ** By implementing a skamonkey@3594: ** custom page cache using this API, an application can better control skamonkey@3594: ** the amount of memory consumed by SQLite, the way in which skamonkey@3594: ** that memory is allocated and released, and the policies used to skamonkey@3594: ** determine exactly which parts of a database file are cached and for skamonkey@3594: ** how long. skamonkey@3594: ** skamonkey@3594: ** The alternative page cache mechanism is an skamonkey@3594: ** extreme measure that is only needed by the most demanding applications. skamonkey@3594: ** The built-in page cache is recommended for most uses. skamonkey@3594: ** skamonkey@3594: ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an skamonkey@3594: ** internal buffer by SQLite within the call to [sqlite3_config]. Hence skamonkey@3594: ** the application may discard the parameter after the call to skamonkey@3594: ** [sqlite3_config()] returns.)^ skamonkey@3594: ** skamonkey@3594: ** [[the xInit() page cache method]] skamonkey@3594: ** ^(The xInit() method is called once for each effective skamonkey@3594: ** call to [sqlite3_initialize()])^ skamonkey@3594: ** (usually only once during the lifetime of the process). ^(The xInit() skamonkey@3594: ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ skamonkey@3594: ** The intent of the xInit() method is to set up global data structures skamonkey@3594: ** required by the custom page cache implementation. skamonkey@3594: ** ^(If the xInit() method is NULL, then the skamonkey@3594: ** built-in default page cache is used instead of the application defined skamonkey@3594: ** page cache.)^ skamonkey@3594: ** skamonkey@3594: ** [[the xShutdown() page cache method]] skamonkey@3594: ** ^The xShutdown() method is called by [sqlite3_shutdown()]. skamonkey@3594: ** It can be used to clean up skamonkey@3594: ** any outstanding resources before process shutdown, if required. skamonkey@3594: ** ^The xShutdown() method may be NULL. skamonkey@3594: ** skamonkey@3594: ** ^SQLite automatically serializes calls to the xInit method, skamonkey@3594: ** so the xInit method need not be threadsafe. ^The skamonkey@3594: ** xShutdown method is only called from [sqlite3_shutdown()] so it does skamonkey@3594: ** not need to be threadsafe either. All other methods must be threadsafe skamonkey@3594: ** in multithreaded applications. skamonkey@3594: ** skamonkey@3594: ** ^SQLite will never invoke xInit() more than once without an intervening skamonkey@3594: ** call to xShutdown(). skamonkey@3594: ** skamonkey@3594: ** [[the xCreate() page cache methods]] skamonkey@3594: ** ^SQLite invokes the xCreate() method to construct a new cache instance. skamonkey@3594: ** SQLite will typically create one cache instance for each open database file, skamonkey@3594: ** though this is not guaranteed. ^The skamonkey@3594: ** first parameter, szPage, is the size in bytes of the pages that must skamonkey@3594: ** be allocated by the cache. ^szPage will always a power of two. ^The skamonkey@3594: ** second parameter szExtra is a number of bytes of extra storage skamonkey@3594: ** associated with each page cache entry. ^The szExtra parameter will skamonkey@3594: ** a number less than 250. SQLite will use the skamonkey@3594: ** extra szExtra bytes on each page to store metadata about the underlying skamonkey@3594: ** database page on disk. The value passed into szExtra depends skamonkey@3594: ** on the SQLite version, the target platform, and how SQLite was compiled. skamonkey@3594: ** ^The third argument to xCreate(), bPurgeable, is true if the cache being skamonkey@3594: ** created will be used to cache database pages of a file stored on disk, or skamonkey@3594: ** false if it is used for an in-memory database. The cache implementation skamonkey@3594: ** does not have to do anything special based with the value of bPurgeable; skamonkey@3594: ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will skamonkey@3594: ** never invoke xUnpin() except to deliberately delete a page. skamonkey@3594: ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to skamonkey@3594: ** false will always have the "discard" flag set to true. skamonkey@3594: ** ^Hence, a cache created with bPurgeable false will skamonkey@3594: ** never contain any unpinned pages. skamonkey@3594: ** skamonkey@3594: ** [[the xCachesize() page cache method]] skamonkey@3594: ** ^(The xCachesize() method may be called at any time by SQLite to set the skamonkey@3594: ** suggested maximum cache-size (number of pages stored by) the cache skamonkey@3594: ** instance passed as the first argument. This is the value configured using skamonkey@3594: ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable skamonkey@3594: ** parameter, the implementation is not required to do anything with this skamonkey@3594: ** value; it is advisory only. skamonkey@3594: ** skamonkey@3594: ** [[the xPagecount() page cache methods]] skamonkey@3594: ** The xPagecount() method must return the number of pages currently skamonkey@3594: ** stored in the cache, both pinned and unpinned. skamonkey@3594: ** skamonkey@3594: ** [[the xFetch() page cache methods]] skamonkey@3594: ** The xFetch() method locates a page in the cache and returns a pointer to skamonkey@3594: ** an sqlite3_pcache_page object associated with that page, or a NULL pointer. skamonkey@3594: ** The pBuf element of the returned sqlite3_pcache_page object will be a skamonkey@3594: ** pointer to a buffer of szPage bytes used to store the content of a skamonkey@3594: ** single database page. The pExtra element of sqlite3_pcache_page will be skamonkey@3594: ** a pointer to the szExtra bytes of extra storage that SQLite has requested skamonkey@3594: ** for each entry in the page cache. skamonkey@3594: ** skamonkey@3594: ** The page to be fetched is determined by the key. ^The minimum key value skamonkey@3594: ** is 1. After it has been retrieved using xFetch, the page is considered skamonkey@3594: ** to be "pinned". skamonkey@3594: ** skamonkey@3594: ** If the requested page is already in the page cache, then the page cache skamonkey@3594: ** implementation must return a pointer to the page buffer with its content skamonkey@3594: ** intact. If the requested page is not already in the cache, then the skamonkey@3594: ** cache implementation should use the value of the createFlag skamonkey@3594: ** parameter to help it determined what action to take: skamonkey@3594: ** skamonkey@3594: ** skamonkey@3594: **
createFlag Behaviour when page is not already in cache skamonkey@3594: **
0 Do not allocate a new page. Return NULL. skamonkey@3594: **
1 Allocate a new page if it easy and convenient to do so. skamonkey@3594: ** Otherwise return NULL. skamonkey@3594: **
2 Make every effort to allocate a new page. Only return skamonkey@3594: ** NULL if allocating a new page is effectively impossible. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite skamonkey@3594: ** will only use a createFlag of 2 after a prior call with a createFlag of 1 skamonkey@3594: ** failed.)^ In between the to xFetch() calls, SQLite may skamonkey@3594: ** attempt to unpin one or more cache pages by spilling the content of skamonkey@3594: ** pinned pages to disk and synching the operating system disk cache. skamonkey@3594: ** skamonkey@3594: ** [[the xUnpin() page cache method]] skamonkey@3594: ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page skamonkey@3594: ** as its second argument. If the third parameter, discard, is non-zero, skamonkey@3594: ** then the page must be evicted from the cache. skamonkey@3594: ** ^If the discard parameter is skamonkey@3594: ** zero, then the page may be discarded or retained at the discretion of skamonkey@3594: ** page cache implementation. ^The page cache implementation skamonkey@3594: ** may choose to evict unpinned pages at any time. skamonkey@3594: ** skamonkey@3594: ** The cache must not perform any reference counting. A single skamonkey@3594: ** call to xUnpin() unpins the page regardless of the number of prior calls skamonkey@3594: ** to xFetch(). skamonkey@3594: ** skamonkey@3594: ** [[the xRekey() page cache methods]] skamonkey@3594: ** The xRekey() method is used to change the key value associated with the skamonkey@3594: ** page passed as the second argument. If the cache skamonkey@3594: ** previously contains an entry associated with newKey, it must be skamonkey@3594: ** discarded. ^Any prior cache entry associated with newKey is guaranteed not skamonkey@3594: ** to be pinned. skamonkey@3594: ** skamonkey@3594: ** When SQLite calls the xTruncate() method, the cache must discard all skamonkey@3594: ** existing cache entries with page numbers (keys) greater than or equal skamonkey@3594: ** to the value of the iLimit parameter passed to xTruncate(). If any skamonkey@3594: ** of these pages are pinned, they are implicitly unpinned, meaning that skamonkey@3594: ** they can be safely discarded. skamonkey@3594: ** skamonkey@3594: ** [[the xDestroy() page cache method]] skamonkey@3594: ** ^The xDestroy() method is used to delete a cache allocated by xCreate(). skamonkey@3594: ** All resources associated with the specified cache should be freed. ^After skamonkey@3594: ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] skamonkey@3594: ** handle invalid, and will not use it with any other sqlite3_pcache_methods2 skamonkey@3594: ** functions. skamonkey@3594: ** skamonkey@3594: ** [[the xShrink() page cache method]] skamonkey@3594: ** ^SQLite invokes the xShrink() method when it wants the page cache to skamonkey@3594: ** free up as much of heap memory as possible. The page cache implementation skamonkey@3594: ** is not obligated to free any memory, but well-behaved implementations should skamonkey@3594: ** do their best. skamonkey@3594: */ skamonkey@3594: typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2; skamonkey@3594: struct sqlite3_pcache_methods2 { skamonkey@3594: int iVersion; skamonkey@3594: void *pArg; skamonkey@3594: int (*xInit)(void*); skamonkey@3594: void (*xShutdown)(void*); skamonkey@3594: sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); skamonkey@3594: void (*xCachesize)(sqlite3_pcache*, int nCachesize); skamonkey@3594: int (*xPagecount)(sqlite3_pcache*); skamonkey@3594: sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); skamonkey@3594: void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); skamonkey@3594: void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, skamonkey@3594: unsigned oldKey, unsigned newKey); skamonkey@3594: void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); skamonkey@3594: void (*xDestroy)(sqlite3_pcache*); skamonkey@3594: void (*xShrink)(sqlite3_pcache*); skamonkey@3594: }; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** This is the obsolete pcache_methods object that has now been replaced skamonkey@3594: ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is skamonkey@3594: ** retained in the header file for backwards compatibility only. skamonkey@3594: */ skamonkey@3594: typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; skamonkey@3594: struct sqlite3_pcache_methods { skamonkey@3594: void *pArg; skamonkey@3594: int (*xInit)(void*); skamonkey@3594: void (*xShutdown)(void*); skamonkey@3594: sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); skamonkey@3594: void (*xCachesize)(sqlite3_pcache*, int nCachesize); skamonkey@3594: int (*xPagecount)(sqlite3_pcache*); skamonkey@3594: void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); skamonkey@3594: void (*xUnpin)(sqlite3_pcache*, void*, int discard); skamonkey@3594: void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); skamonkey@3594: void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); skamonkey@3594: void (*xDestroy)(sqlite3_pcache*); skamonkey@3594: }; skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Online Backup Object skamonkey@3594: ** skamonkey@3594: ** The sqlite3_backup object records state information about an ongoing skamonkey@3594: ** online backup operation. ^The sqlite3_backup object is created by skamonkey@3594: ** a call to [sqlite3_backup_init()] and is destroyed by a call to skamonkey@3594: ** [sqlite3_backup_finish()]. skamonkey@3594: ** skamonkey@3594: ** See Also: [Using the SQLite Online Backup API] skamonkey@3594: */ skamonkey@3594: typedef struct sqlite3_backup sqlite3_backup; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Online Backup API. skamonkey@3594: ** skamonkey@3594: ** The backup API copies the content of one database into another. skamonkey@3594: ** It is useful either for creating backups of databases or skamonkey@3594: ** for copying in-memory databases to or from persistent files. skamonkey@3594: ** skamonkey@3594: ** See Also: [Using the SQLite Online Backup API] skamonkey@3594: ** skamonkey@3594: ** ^SQLite holds a write transaction open on the destination database file skamonkey@3594: ** for the duration of the backup operation. skamonkey@3594: ** ^The source database is read-locked only while it is being read; skamonkey@3594: ** it is not locked continuously for the entire backup operation. skamonkey@3594: ** ^Thus, the backup may be performed on a live source database without skamonkey@3594: ** preventing other database connections from skamonkey@3594: ** reading or writing to the source database while the backup is underway. skamonkey@3594: ** skamonkey@3594: ** ^(To perform a backup operation: skamonkey@3594: **
    skamonkey@3594: **
  1. sqlite3_backup_init() is called once to initialize the skamonkey@3594: ** backup, skamonkey@3594: **
  2. sqlite3_backup_step() is called one or more times to transfer skamonkey@3594: ** the data between the two databases, and finally skamonkey@3594: **
  3. sqlite3_backup_finish() is called to release all resources skamonkey@3594: ** associated with the backup operation. skamonkey@3594: **
)^ skamonkey@3594: ** There should be exactly one call to sqlite3_backup_finish() for each skamonkey@3594: ** successful call to sqlite3_backup_init(). skamonkey@3594: ** skamonkey@3594: ** [[sqlite3_backup_init()]] sqlite3_backup_init() skamonkey@3594: ** skamonkey@3594: ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the skamonkey@3594: ** [database connection] associated with the destination database skamonkey@3594: ** and the database name, respectively. skamonkey@3594: ** ^The database name is "main" for the main database, "temp" for the skamonkey@3594: ** temporary database, or the name specified after the AS keyword in skamonkey@3594: ** an [ATTACH] statement for an attached database. skamonkey@3594: ** ^The S and M arguments passed to skamonkey@3594: ** sqlite3_backup_init(D,N,S,M) identify the [database connection] skamonkey@3594: ** and database name of the source database, respectively. skamonkey@3594: ** ^The source and destination [database connections] (parameters S and D) skamonkey@3594: ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with skamonkey@3594: ** an error. skamonkey@3594: ** skamonkey@3594: ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is skamonkey@3594: ** returned and an error code and error message are stored in the skamonkey@3594: ** destination [database connection] D. skamonkey@3594: ** ^The error code and message for the failed call to sqlite3_backup_init() skamonkey@3594: ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or skamonkey@3594: ** [sqlite3_errmsg16()] functions. skamonkey@3594: ** ^A successful call to sqlite3_backup_init() returns a pointer to an skamonkey@3594: ** [sqlite3_backup] object. skamonkey@3594: ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and skamonkey@3594: ** sqlite3_backup_finish() functions to perform the specified backup skamonkey@3594: ** operation. skamonkey@3594: ** skamonkey@3594: ** [[sqlite3_backup_step()]] sqlite3_backup_step() skamonkey@3594: ** skamonkey@3594: ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between skamonkey@3594: ** the source and destination databases specified by [sqlite3_backup] object B. skamonkey@3594: ** ^If N is negative, all remaining source pages are copied. skamonkey@3594: ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there skamonkey@3594: ** are still more pages to be copied, then the function returns [SQLITE_OK]. skamonkey@3594: ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages skamonkey@3594: ** from source to destination, then it returns [SQLITE_DONE]. skamonkey@3594: ** ^If an error occurs while running sqlite3_backup_step(B,N), skamonkey@3594: ** then an [error code] is returned. ^As well as [SQLITE_OK] and skamonkey@3594: ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], skamonkey@3594: ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an skamonkey@3594: ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. skamonkey@3594: ** skamonkey@3594: ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if skamonkey@3594: **
    skamonkey@3594: **
  1. the destination database was opened read-only, or skamonkey@3594: **
  2. the destination database is using write-ahead-log journaling skamonkey@3594: ** and the destination and source page sizes differ, or skamonkey@3594: **
  3. the destination database is an in-memory database and the skamonkey@3594: ** destination and source page sizes differ. skamonkey@3594: **
)^ skamonkey@3594: ** skamonkey@3594: ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then skamonkey@3594: ** the [sqlite3_busy_handler | busy-handler function] skamonkey@3594: ** is invoked (if one is specified). ^If the skamonkey@3594: ** busy-handler returns non-zero before the lock is available, then skamonkey@3594: ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to skamonkey@3594: ** sqlite3_backup_step() can be retried later. ^If the source skamonkey@3594: ** [database connection] skamonkey@3594: ** is being used to write to the source database when sqlite3_backup_step() skamonkey@3594: ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this skamonkey@3594: ** case the call to sqlite3_backup_step() can be retried later on. ^(If skamonkey@3594: ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or skamonkey@3594: ** [SQLITE_READONLY] is returned, then skamonkey@3594: ** there is no point in retrying the call to sqlite3_backup_step(). These skamonkey@3594: ** errors are considered fatal.)^ The application must accept skamonkey@3594: ** that the backup operation has failed and pass the backup operation handle skamonkey@3594: ** to the sqlite3_backup_finish() to release associated resources. skamonkey@3594: ** skamonkey@3594: ** ^The first call to sqlite3_backup_step() obtains an exclusive lock skamonkey@3594: ** on the destination file. ^The exclusive lock is not released until either skamonkey@3594: ** sqlite3_backup_finish() is called or the backup operation is complete skamonkey@3594: ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to skamonkey@3594: ** sqlite3_backup_step() obtains a [shared lock] on the source database that skamonkey@3594: ** lasts for the duration of the sqlite3_backup_step() call. skamonkey@3594: ** ^Because the source database is not locked between calls to skamonkey@3594: ** sqlite3_backup_step(), the source database may be modified mid-way skamonkey@3594: ** through the backup process. ^If the source database is modified by an skamonkey@3594: ** external process or via a database connection other than the one being skamonkey@3594: ** used by the backup operation, then the backup will be automatically skamonkey@3594: ** restarted by the next call to sqlite3_backup_step(). ^If the source skamonkey@3594: ** database is modified by the using the same database connection as is used skamonkey@3594: ** by the backup operation, then the backup database is automatically skamonkey@3594: ** updated at the same time. skamonkey@3594: ** skamonkey@3594: ** [[sqlite3_backup_finish()]] sqlite3_backup_finish() skamonkey@3594: ** skamonkey@3594: ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the skamonkey@3594: ** application wishes to abandon the backup operation, the application skamonkey@3594: ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). skamonkey@3594: ** ^The sqlite3_backup_finish() interfaces releases all skamonkey@3594: ** resources associated with the [sqlite3_backup] object. skamonkey@3594: ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any skamonkey@3594: ** active write-transaction on the destination database is rolled back. skamonkey@3594: ** The [sqlite3_backup] object is invalid skamonkey@3594: ** and may not be used following a call to sqlite3_backup_finish(). skamonkey@3594: ** skamonkey@3594: ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no skamonkey@3594: ** sqlite3_backup_step() errors occurred, regardless or whether or not skamonkey@3594: ** sqlite3_backup_step() completed. skamonkey@3594: ** ^If an out-of-memory condition or IO error occurred during any prior skamonkey@3594: ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then skamonkey@3594: ** sqlite3_backup_finish() returns the corresponding [error code]. skamonkey@3594: ** skamonkey@3594: ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() skamonkey@3594: ** is not a permanent error and does not affect the return value of skamonkey@3594: ** sqlite3_backup_finish(). skamonkey@3594: ** skamonkey@3594: ** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]] skamonkey@3594: ** sqlite3_backup_remaining() and sqlite3_backup_pagecount() skamonkey@3594: ** skamonkey@3594: ** ^Each call to sqlite3_backup_step() sets two values inside skamonkey@3594: ** the [sqlite3_backup] object: the number of pages still to be backed skamonkey@3594: ** up and the total number of pages in the source database file. skamonkey@3594: ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces skamonkey@3594: ** retrieve these two values, respectively. skamonkey@3594: ** skamonkey@3594: ** ^The values returned by these functions are only updated by skamonkey@3594: ** sqlite3_backup_step(). ^If the source database is modified during a backup skamonkey@3594: ** operation, then the values are not updated to account for any extra skamonkey@3594: ** pages that need to be updated or the size of the source database file skamonkey@3594: ** changing. skamonkey@3594: ** skamonkey@3594: ** Concurrent Usage of Database Handles skamonkey@3594: ** skamonkey@3594: ** ^The source [database connection] may be used by the application for other skamonkey@3594: ** purposes while a backup operation is underway or being initialized. skamonkey@3594: ** ^If SQLite is compiled and configured to support threadsafe database skamonkey@3594: ** connections, then the source database connection may be used concurrently skamonkey@3594: ** from within other threads. skamonkey@3594: ** skamonkey@3594: ** However, the application must guarantee that the destination skamonkey@3594: ** [database connection] is not passed to any other API (by any thread) after skamonkey@3594: ** sqlite3_backup_init() is called and before the corresponding call to skamonkey@3594: ** sqlite3_backup_finish(). SQLite does not currently check to see skamonkey@3594: ** if the application incorrectly accesses the destination [database connection] skamonkey@3594: ** and so no error code is reported, but the operations may malfunction skamonkey@3594: ** nevertheless. Use of the destination database connection while a skamonkey@3594: ** backup is in progress might also also cause a mutex deadlock. skamonkey@3594: ** skamonkey@3594: ** If running in [shared cache mode], the application must skamonkey@3594: ** guarantee that the shared cache used by the destination database skamonkey@3594: ** is not accessed while the backup is running. In practice this means skamonkey@3594: ** that the application must guarantee that the disk file being skamonkey@3594: ** backed up to is not accessed by any connection within the process, skamonkey@3594: ** not just the specific connection that was passed to sqlite3_backup_init(). skamonkey@3594: ** skamonkey@3594: ** The [sqlite3_backup] object itself is partially threadsafe. Multiple skamonkey@3594: ** threads may safely make multiple concurrent calls to sqlite3_backup_step(). skamonkey@3594: ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() skamonkey@3594: ** APIs are not strictly speaking threadsafe. If they are invoked at the skamonkey@3594: ** same time as another thread is invoking sqlite3_backup_step() it is skamonkey@3594: ** possible that they return invalid values. skamonkey@3594: */ skamonkey@3594: SQLITE_API sqlite3_backup *sqlite3_backup_init( skamonkey@3594: sqlite3 *pDest, /* Destination database handle */ skamonkey@3594: const char *zDestName, /* Destination database name */ skamonkey@3594: sqlite3 *pSource, /* Source database handle */ skamonkey@3594: const char *zSourceName /* Source database name */ skamonkey@3594: ); skamonkey@3594: SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); skamonkey@3594: SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); skamonkey@3594: SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); skamonkey@3594: SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Unlock Notification skamonkey@3594: ** skamonkey@3594: ** ^When running in shared-cache mode, a database operation may fail with skamonkey@3594: ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or skamonkey@3594: ** individual tables within the shared-cache cannot be obtained. See skamonkey@3594: ** [SQLite Shared-Cache Mode] for a description of shared-cache locking. skamonkey@3594: ** ^This API may be used to register a callback that SQLite will invoke skamonkey@3594: ** when the connection currently holding the required lock relinquishes it. skamonkey@3594: ** ^This API is only available if the library was compiled with the skamonkey@3594: ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. skamonkey@3594: ** skamonkey@3594: ** See Also: [Using the SQLite Unlock Notification Feature]. skamonkey@3594: ** skamonkey@3594: ** ^Shared-cache locks are released when a database connection concludes skamonkey@3594: ** its current transaction, either by committing it or rolling it back. skamonkey@3594: ** skamonkey@3594: ** ^When a connection (known as the blocked connection) fails to obtain a skamonkey@3594: ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the skamonkey@3594: ** identity of the database connection (the blocking connection) that skamonkey@3594: ** has locked the required resource is stored internally. ^After an skamonkey@3594: ** application receives an SQLITE_LOCKED error, it may call the skamonkey@3594: ** sqlite3_unlock_notify() method with the blocked connection handle as skamonkey@3594: ** the first argument to register for a callback that will be invoked skamonkey@3594: ** when the blocking connections current transaction is concluded. ^The skamonkey@3594: ** callback is invoked from within the [sqlite3_step] or [sqlite3_close] skamonkey@3594: ** call that concludes the blocking connections transaction. skamonkey@3594: ** skamonkey@3594: ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, skamonkey@3594: ** there is a chance that the blocking connection will have already skamonkey@3594: ** concluded its transaction by the time sqlite3_unlock_notify() is invoked. skamonkey@3594: ** If this happens, then the specified callback is invoked immediately, skamonkey@3594: ** from within the call to sqlite3_unlock_notify().)^ skamonkey@3594: ** skamonkey@3594: ** ^If the blocked connection is attempting to obtain a write-lock on a skamonkey@3594: ** shared-cache table, and more than one other connection currently holds skamonkey@3594: ** a read-lock on the same table, then SQLite arbitrarily selects one of skamonkey@3594: ** the other connections to use as the blocking connection. skamonkey@3594: ** skamonkey@3594: ** ^(There may be at most one unlock-notify callback registered by a skamonkey@3594: ** blocked connection. If sqlite3_unlock_notify() is called when the skamonkey@3594: ** blocked connection already has a registered unlock-notify callback, skamonkey@3594: ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is skamonkey@3594: ** called with a NULL pointer as its second argument, then any existing skamonkey@3594: ** unlock-notify callback is canceled. ^The blocked connections skamonkey@3594: ** unlock-notify callback may also be canceled by closing the blocked skamonkey@3594: ** connection using [sqlite3_close()]. skamonkey@3594: ** skamonkey@3594: ** The unlock-notify callback is not reentrant. If an application invokes skamonkey@3594: ** any sqlite3_xxx API functions from within an unlock-notify callback, a skamonkey@3594: ** crash or deadlock may be the result. skamonkey@3594: ** skamonkey@3594: ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always skamonkey@3594: ** returns SQLITE_OK. skamonkey@3594: ** skamonkey@3594: ** Callback Invocation Details skamonkey@3594: ** skamonkey@3594: ** When an unlock-notify callback is registered, the application provides a skamonkey@3594: ** single void* pointer that is passed to the callback when it is invoked. skamonkey@3594: ** However, the signature of the callback function allows SQLite to pass skamonkey@3594: ** it an array of void* context pointers. The first argument passed to skamonkey@3594: ** an unlock-notify callback is a pointer to an array of void* pointers, skamonkey@3594: ** and the second is the number of entries in the array. skamonkey@3594: ** skamonkey@3594: ** When a blocking connections transaction is concluded, there may be skamonkey@3594: ** more than one blocked connection that has registered for an unlock-notify skamonkey@3594: ** callback. ^If two or more such blocked connections have specified the skamonkey@3594: ** same callback function, then instead of invoking the callback function skamonkey@3594: ** multiple times, it is invoked once with the set of void* context pointers skamonkey@3594: ** specified by the blocked connections bundled together into an array. skamonkey@3594: ** This gives the application an opportunity to prioritize any actions skamonkey@3594: ** related to the set of unblocked database connections. skamonkey@3594: ** skamonkey@3594: ** Deadlock Detection skamonkey@3594: ** skamonkey@3594: ** Assuming that after registering for an unlock-notify callback a skamonkey@3594: ** database waits for the callback to be issued before taking any further skamonkey@3594: ** action (a reasonable assumption), then using this API may cause the skamonkey@3594: ** application to deadlock. For example, if connection X is waiting for skamonkey@3594: ** connection Y's transaction to be concluded, and similarly connection skamonkey@3594: ** Y is waiting on connection X's transaction, then neither connection skamonkey@3594: ** will proceed and the system may remain deadlocked indefinitely. skamonkey@3594: ** skamonkey@3594: ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock skamonkey@3594: ** detection. ^If a given call to sqlite3_unlock_notify() would put the skamonkey@3594: ** system in a deadlocked state, then SQLITE_LOCKED is returned and no skamonkey@3594: ** unlock-notify callback is registered. The system is said to be in skamonkey@3594: ** a deadlocked state if connection A has registered for an unlock-notify skamonkey@3594: ** callback on the conclusion of connection B's transaction, and connection skamonkey@3594: ** B has itself registered for an unlock-notify callback when connection skamonkey@3594: ** A's transaction is concluded. ^Indirect deadlock is also detected, so skamonkey@3594: ** the system is also considered to be deadlocked if connection B has skamonkey@3594: ** registered for an unlock-notify callback on the conclusion of connection skamonkey@3594: ** C's transaction, where connection C is waiting on connection A. ^Any skamonkey@3594: ** number of levels of indirection are allowed. skamonkey@3594: ** skamonkey@3594: ** The "DROP TABLE" Exception skamonkey@3594: ** skamonkey@3594: ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost skamonkey@3594: ** always appropriate to call sqlite3_unlock_notify(). There is however, skamonkey@3594: ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, skamonkey@3594: ** SQLite checks if there are any currently executing SELECT statements skamonkey@3594: ** that belong to the same connection. If there are, SQLITE_LOCKED is skamonkey@3594: ** returned. In this case there is no "blocking connection", so invoking skamonkey@3594: ** sqlite3_unlock_notify() results in the unlock-notify callback being skamonkey@3594: ** invoked immediately. If the application then re-attempts the "DROP TABLE" skamonkey@3594: ** or "DROP INDEX" query, an infinite loop might be the result. skamonkey@3594: ** skamonkey@3594: ** One way around this problem is to check the extended error code returned skamonkey@3594: ** by an sqlite3_step() call. ^(If there is a blocking connection, then the skamonkey@3594: ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in skamonkey@3594: ** the special "DROP TABLE/INDEX" case, the extended error code is just skamonkey@3594: ** SQLITE_LOCKED.)^ skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_unlock_notify( skamonkey@3594: sqlite3 *pBlocked, /* Waiting connection */ skamonkey@3594: void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ skamonkey@3594: void *pNotifyArg /* Argument to pass to xNotify */ skamonkey@3594: ); skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: String Comparison skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications skamonkey@3594: ** and extensions to compare the contents of two buffers containing UTF-8 skamonkey@3594: ** strings in a case-independent fashion, using the same definition of "case skamonkey@3594: ** independence" that SQLite uses internally when comparing identifiers. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_stricmp(const char *, const char *); skamonkey@3594: SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Error Logging Interface skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_log()] interface writes a message into the error log skamonkey@3594: ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. skamonkey@3594: ** ^If logging is enabled, the zFormat string and subsequent arguments are skamonkey@3594: ** used with [sqlite3_snprintf()] to generate the final output string. skamonkey@3594: ** skamonkey@3594: ** The sqlite3_log() interface is intended for use by extensions such as skamonkey@3594: ** virtual tables, collating functions, and SQL functions. While there is skamonkey@3594: ** nothing to prevent an application from calling sqlite3_log(), doing so skamonkey@3594: ** is considered bad form. skamonkey@3594: ** skamonkey@3594: ** The zFormat string must not be NULL. skamonkey@3594: ** skamonkey@3594: ** To avoid deadlocks and other threading problems, the sqlite3_log() routine skamonkey@3594: ** will not use dynamically allocated memory. The log message is stored in skamonkey@3594: ** a fixed-length buffer on the stack. If the log message is longer than skamonkey@3594: ** a few hundred characters, it will be truncated to the length of the skamonkey@3594: ** buffer. skamonkey@3594: */ skamonkey@3594: SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Write-Ahead Log Commit Hook skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_wal_hook()] function is used to register a callback that skamonkey@3594: ** will be invoked each time a database connection commits data to a skamonkey@3594: ** [write-ahead log] (i.e. whenever a transaction is committed in skamonkey@3594: ** [journal_mode | journal_mode=WAL mode]). skamonkey@3594: ** skamonkey@3594: ** ^The callback is invoked by SQLite after the commit has taken place and skamonkey@3594: ** the associated write-lock on the database released, so the implementation skamonkey@3594: ** may read, write or [checkpoint] the database as required. skamonkey@3594: ** skamonkey@3594: ** ^The first parameter passed to the callback function when it is invoked skamonkey@3594: ** is a copy of the third parameter passed to sqlite3_wal_hook() when skamonkey@3594: ** registering the callback. ^The second is a copy of the database handle. skamonkey@3594: ** ^The third parameter is the name of the database that was written to - skamonkey@3594: ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter skamonkey@3594: ** is the number of pages currently in the write-ahead log file, skamonkey@3594: ** including those that were just committed. skamonkey@3594: ** skamonkey@3594: ** The callback function should normally return [SQLITE_OK]. ^If an error skamonkey@3594: ** code is returned, that error will propagate back up through the skamonkey@3594: ** SQLite code base to cause the statement that provoked the callback skamonkey@3594: ** to report an error, though the commit will have still occurred. If the skamonkey@3594: ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value skamonkey@3594: ** that does not correspond to any valid SQLite error code, the results skamonkey@3594: ** are undefined. skamonkey@3594: ** skamonkey@3594: ** A single database handle may have at most a single write-ahead log callback skamonkey@3594: ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any skamonkey@3594: ** previously registered write-ahead log callback. ^Note that the skamonkey@3594: ** [sqlite3_wal_autocheckpoint()] interface and the skamonkey@3594: ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will skamonkey@3594: ** those overwrite any prior [sqlite3_wal_hook()] settings. skamonkey@3594: */ skamonkey@3594: SQLITE_API void *sqlite3_wal_hook( skamonkey@3594: sqlite3*, skamonkey@3594: int(*)(void *,sqlite3*,const char*,int), skamonkey@3594: void* skamonkey@3594: ); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Configure an auto-checkpoint skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around skamonkey@3594: ** [sqlite3_wal_hook()] that causes any database on [database connection] D skamonkey@3594: ** to automatically [checkpoint] skamonkey@3594: ** after committing a transaction if there are N or skamonkey@3594: ** more frames in the [write-ahead log] file. ^Passing zero or skamonkey@3594: ** a negative value as the nFrame parameter disables automatic skamonkey@3594: ** checkpoints entirely. skamonkey@3594: ** skamonkey@3594: ** ^The callback registered by this function replaces any existing callback skamonkey@3594: ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback skamonkey@3594: ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism skamonkey@3594: ** configured by this function. skamonkey@3594: ** skamonkey@3594: ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface skamonkey@3594: ** from SQL. skamonkey@3594: ** skamonkey@3594: ** ^Every new [database connection] defaults to having the auto-checkpoint skamonkey@3594: ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] skamonkey@3594: ** pages. The use of this interface skamonkey@3594: ** is only necessary if the default setting is found to be suboptimal skamonkey@3594: ** for a particular application. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Checkpoint a database skamonkey@3594: ** skamonkey@3594: ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X skamonkey@3594: ** on [database connection] D to be [checkpointed]. ^If X is NULL or an skamonkey@3594: ** empty string, then a checkpoint is run on all databases of skamonkey@3594: ** connection D. ^If the database connection D is not in skamonkey@3594: ** [WAL | write-ahead log mode] then this interface is a harmless no-op. skamonkey@3594: ** skamonkey@3594: ** ^The [wal_checkpoint pragma] can be used to invoke this interface skamonkey@3594: ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the skamonkey@3594: ** [wal_autocheckpoint pragma] can be used to cause this interface to be skamonkey@3594: ** run whenever the WAL reaches a certain size threshold. skamonkey@3594: ** skamonkey@3594: ** See also: [sqlite3_wal_checkpoint_v2()] skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Checkpoint a database skamonkey@3594: ** skamonkey@3594: ** Run a checkpoint operation on WAL database zDb attached to database skamonkey@3594: ** handle db. The specific operation is determined by the value of the skamonkey@3594: ** eMode parameter: skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: **
SQLITE_CHECKPOINT_PASSIVE
skamonkey@3594: ** Checkpoint as many frames as possible without waiting for any database skamonkey@3594: ** readers or writers to finish. Sync the db file if all frames in the log skamonkey@3594: ** are checkpointed. This mode is the same as calling skamonkey@3594: ** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked. skamonkey@3594: ** skamonkey@3594: **
SQLITE_CHECKPOINT_FULL
skamonkey@3594: ** This mode blocks (calls the busy-handler callback) until there is no skamonkey@3594: ** database writer and all readers are reading from the most recent database skamonkey@3594: ** snapshot. It then checkpoints all frames in the log file and syncs the skamonkey@3594: ** database file. This call blocks database writers while it is running, skamonkey@3594: ** but not database readers. skamonkey@3594: ** skamonkey@3594: **
SQLITE_CHECKPOINT_RESTART
skamonkey@3594: ** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after skamonkey@3594: ** checkpointing the log file it blocks (calls the busy-handler callback) skamonkey@3594: ** until all readers are reading from the database file only. This ensures skamonkey@3594: ** that the next client to write to the database file restarts the log file skamonkey@3594: ** from the beginning. This call blocks database writers while it is running, skamonkey@3594: ** but not database readers. skamonkey@3594: **
skamonkey@3594: ** skamonkey@3594: ** If pnLog is not NULL, then *pnLog is set to the total number of frames in skamonkey@3594: ** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to skamonkey@3594: ** the total number of checkpointed frames (including any that were already skamonkey@3594: ** checkpointed when this function is called). *pnLog and *pnCkpt may be skamonkey@3594: ** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK. skamonkey@3594: ** If no values are available because of an error, they are both set to -1 skamonkey@3594: ** before returning to communicate this to the caller. skamonkey@3594: ** skamonkey@3594: ** All calls obtain an exclusive "checkpoint" lock on the database file. If skamonkey@3594: ** any other process is running a checkpoint operation at the same time, the skamonkey@3594: ** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a skamonkey@3594: ** busy-handler configured, it will not be invoked in this case. skamonkey@3594: ** skamonkey@3594: ** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive skamonkey@3594: ** "writer" lock on the database file. If the writer lock cannot be obtained skamonkey@3594: ** immediately, and a busy-handler is configured, it is invoked and the writer skamonkey@3594: ** lock retried until either the busy-handler returns 0 or the lock is skamonkey@3594: ** successfully obtained. The busy-handler is also invoked while waiting for skamonkey@3594: ** database readers as described above. If the busy-handler returns 0 before skamonkey@3594: ** the writer lock is obtained or while waiting for database readers, the skamonkey@3594: ** checkpoint operation proceeds from that point in the same way as skamonkey@3594: ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible skamonkey@3594: ** without blocking any further. SQLITE_BUSY is returned in this case. skamonkey@3594: ** skamonkey@3594: ** If parameter zDb is NULL or points to a zero length string, then the skamonkey@3594: ** specified operation is attempted on all WAL databases. In this case the skamonkey@3594: ** values written to output parameters *pnLog and *pnCkpt are undefined. If skamonkey@3594: ** an SQLITE_BUSY error is encountered when processing one or more of the skamonkey@3594: ** attached WAL databases, the operation is still attempted on any remaining skamonkey@3594: ** attached databases and SQLITE_BUSY is returned to the caller. If any other skamonkey@3594: ** error occurs while processing an attached database, processing is abandoned skamonkey@3594: ** and the error code returned to the caller immediately. If no error skamonkey@3594: ** (SQLITE_BUSY or otherwise) is encountered while processing the attached skamonkey@3594: ** databases, SQLITE_OK is returned. skamonkey@3594: ** skamonkey@3594: ** If database zDb is the name of an attached database that is not in WAL skamonkey@3594: ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If skamonkey@3594: ** zDb is not NULL (or a zero length string) and is not the name of any skamonkey@3594: ** attached database, SQLITE_ERROR is returned to the caller. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_wal_checkpoint_v2( skamonkey@3594: sqlite3 *db, /* Database handle */ skamonkey@3594: const char *zDb, /* Name of attached database (or NULL) */ skamonkey@3594: int eMode, /* SQLITE_CHECKPOINT_* value */ skamonkey@3594: int *pnLog, /* OUT: Size of WAL log in frames */ skamonkey@3594: int *pnCkpt /* OUT: Total number of frames checkpointed */ skamonkey@3594: ); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Checkpoint operation parameters skamonkey@3594: ** skamonkey@3594: ** These constants can be used as the 3rd parameter to skamonkey@3594: ** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()] skamonkey@3594: ** documentation for additional information about the meaning and use of skamonkey@3594: ** each of these values. skamonkey@3594: */ skamonkey@3594: #define SQLITE_CHECKPOINT_PASSIVE 0 skamonkey@3594: #define SQLITE_CHECKPOINT_FULL 1 skamonkey@3594: #define SQLITE_CHECKPOINT_RESTART 2 skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Virtual Table Interface Configuration skamonkey@3594: ** skamonkey@3594: ** This function may be called by either the [xConnect] or [xCreate] method skamonkey@3594: ** of a [virtual table] implementation to configure skamonkey@3594: ** various facets of the virtual table interface. skamonkey@3594: ** skamonkey@3594: ** If this interface is invoked outside the context of an xConnect or skamonkey@3594: ** xCreate virtual table method then the behavior is undefined. skamonkey@3594: ** skamonkey@3594: ** At present, there is only one option that may be configured using skamonkey@3594: ** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options skamonkey@3594: ** may be added in the future. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Virtual Table Configuration Options skamonkey@3594: ** skamonkey@3594: ** These macros define the various options to the skamonkey@3594: ** [sqlite3_vtab_config()] interface that [virtual table] implementations skamonkey@3594: ** can use to customize and optimize their behavior. skamonkey@3594: ** skamonkey@3594: **
skamonkey@3594: **
SQLITE_VTAB_CONSTRAINT_SUPPORT skamonkey@3594: **
Calls of the form skamonkey@3594: ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, skamonkey@3594: ** where X is an integer. If X is zero, then the [virtual table] whose skamonkey@3594: ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not skamonkey@3594: ** support constraints. In this configuration (which is the default) if skamonkey@3594: ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire skamonkey@3594: ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been skamonkey@3594: ** specified as part of the users SQL statement, regardless of the actual skamonkey@3594: ** ON CONFLICT mode specified. skamonkey@3594: ** skamonkey@3594: ** If X is non-zero, then the virtual table implementation guarantees skamonkey@3594: ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before skamonkey@3594: ** any modifications to internal or persistent data structures have been made. skamonkey@3594: ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite skamonkey@3594: ** is able to roll back a statement or database transaction, and abandon skamonkey@3594: ** or continue processing the current SQL statement as appropriate. skamonkey@3594: ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns skamonkey@3594: ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode skamonkey@3594: ** had been ABORT. skamonkey@3594: ** skamonkey@3594: ** Virtual table implementations that are required to handle OR REPLACE skamonkey@3594: ** must do so within the [xUpdate] method. If a call to the skamonkey@3594: ** [sqlite3_vtab_on_conflict()] function indicates that the current ON skamonkey@3594: ** CONFLICT policy is REPLACE, the virtual table implementation should skamonkey@3594: ** silently replace the appropriate rows within the xUpdate callback and skamonkey@3594: ** return SQLITE_OK. Or, if this is not possible, it may return skamonkey@3594: ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT skamonkey@3594: ** constraint handling. skamonkey@3594: **
skamonkey@3594: */ skamonkey@3594: #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Determine The Virtual Table Conflict Policy skamonkey@3594: ** skamonkey@3594: ** This function may only be called from within a call to the [xUpdate] method skamonkey@3594: ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The skamonkey@3594: ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], skamonkey@3594: ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode skamonkey@3594: ** of the SQL statement that triggered the call to the [xUpdate] method of the skamonkey@3594: ** [virtual table]. skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *); skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** CAPI3REF: Conflict resolution modes skamonkey@3594: ** skamonkey@3594: ** These constants are returned by [sqlite3_vtab_on_conflict()] to skamonkey@3594: ** inform a [virtual table] implementation what the [ON CONFLICT] mode skamonkey@3594: ** is for the SQL statement being evaluated. skamonkey@3594: ** skamonkey@3594: ** Note that the [SQLITE_IGNORE] constant is also used as a potential skamonkey@3594: ** return value from the [sqlite3_set_authorizer()] callback and that skamonkey@3594: ** [SQLITE_ABORT] is also a [result code]. skamonkey@3594: */ skamonkey@3594: #define SQLITE_ROLLBACK 1 skamonkey@3594: /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ skamonkey@3594: #define SQLITE_FAIL 3 skamonkey@3594: /* #define SQLITE_ABORT 4 // Also an error code */ skamonkey@3594: #define SQLITE_REPLACE 5 skamonkey@3594: skamonkey@3594: ds@1952: ds@1952: /* ds@1952: ** Undo the hack that converts floating point types to integer for ds@1952: ** builds on processors without floating point support. ds@1952: */ ds@1952: #ifdef SQLITE_OMIT_FLOATING_POINT ds@1952: # undef double ds@1952: #endif ds@1952: ds@1952: #ifdef __cplusplus ds@1952: } /* End of the 'extern "C"' block */ ds@1952: #endif ds@1952: #endif skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** 2010 August 30 skamonkey@3594: ** skamonkey@3594: ** The author disclaims copyright to this source code. In place of skamonkey@3594: ** a legal notice, here is a blessing: skamonkey@3594: ** skamonkey@3594: ** May you do good and not evil. skamonkey@3594: ** May you find forgiveness for yourself and forgive others. skamonkey@3594: ** May you share freely, never taking more than you give. skamonkey@3594: ** skamonkey@3594: ************************************************************************* skamonkey@3594: */ skamonkey@3594: skamonkey@3594: #ifndef _SQLITE3RTREE_H_ skamonkey@3594: #define _SQLITE3RTREE_H_ skamonkey@3594: skamonkey@3594: skamonkey@3594: #ifdef __cplusplus skamonkey@3594: extern "C" { skamonkey@3594: #endif skamonkey@3594: skamonkey@3594: typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** Register a geometry callback named zGeom that can be used as part of an skamonkey@3594: ** R-Tree geometry query as follows: skamonkey@3594: ** skamonkey@3594: ** SELECT ... FROM WHERE MATCH $zGeom(... params ...) skamonkey@3594: */ skamonkey@3594: SQLITE_API int sqlite3_rtree_geometry_callback( skamonkey@3594: sqlite3 *db, skamonkey@3594: const char *zGeom, skamonkey@3594: #ifdef SQLITE_RTREE_INT_ONLY skamonkey@3594: int (*xGeom)(sqlite3_rtree_geometry*, int n, sqlite3_int64 *a, int *pRes), skamonkey@3594: #else skamonkey@3594: int (*xGeom)(sqlite3_rtree_geometry*, int n, double *a, int *pRes), skamonkey@3594: #endif skamonkey@3594: void *pContext skamonkey@3594: ); skamonkey@3594: skamonkey@3594: skamonkey@3594: /* skamonkey@3594: ** A pointer to a structure of the following type is passed as the first skamonkey@3594: ** argument to callbacks registered using rtree_geometry_callback(). skamonkey@3594: */ skamonkey@3594: struct sqlite3_rtree_geometry { skamonkey@3594: void *pContext; /* Copy of pContext passed to s_r_g_c() */ skamonkey@3594: int nParam; /* Size of array aParam[] */ skamonkey@3594: double *aParam; /* Parameters passed to SQL geom function */ skamonkey@3594: void *pUser; /* Callback implementation user data */ skamonkey@3594: void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ skamonkey@3594: }; skamonkey@3594: skamonkey@3594: skamonkey@3594: #ifdef __cplusplus skamonkey@3594: } /* end of the 'extern "C"' block */ skamonkey@3594: #endif skamonkey@3594: skamonkey@3594: #endif /* ifndef _SQLITE3RTREE_H_ */ skamonkey@3594: