version 1.2, 2012/10/12 08:22:47
|
version 1.5, 2021/03/11 13:59:51
|
Line 1
|
Line 1
|
/* |
/* |
** 2001 September 15 | ** 2001-09-15 |
** |
** |
** The author disclaims copyright to this source code. In place of |
** The author disclaims copyright to this source code. In place of |
** a legal notice, here is a blessing: |
** a legal notice, here is a blessing: |
Line 23
|
Line 23
|
** |
** |
** The official C-language API documentation for SQLite is derived |
** The official C-language API documentation for SQLite is derived |
** from comments in this file. This file is the authoritative source |
** from comments in this file. This file is the authoritative source |
** on how SQLite interfaces are suppose to operate. | ** on how SQLite interfaces are supposed to operate. |
** |
** |
** The name of this file under configuration management is "sqlite.h.in". |
** The name of this file under configuration management is "sqlite.h.in". |
** The makefile makes some minor changes to this file (such as inserting |
** The makefile makes some minor changes to this file (such as inserting |
** the version number) and changes its name to "sqlite3.h" as |
** the version number) and changes its name to "sqlite3.h" as |
** part of the build process. |
** part of the build process. |
*/ |
*/ |
#ifndef _SQLITE3_H_ | #ifndef SQLITE3_H |
#define _SQLITE3_H_ | #define SQLITE3_H |
#include <stdarg.h> /* Needed for the definition of va_list */ |
#include <stdarg.h> /* Needed for the definition of va_list */ |
|
|
/* |
/* |
Line 43 extern "C" {
|
Line 43 extern "C" {
|
|
|
|
|
/* |
/* |
** Add the ability to override 'extern' | ** Provide the ability to override linkage features of the interface. |
*/ |
*/ |
#ifndef SQLITE_EXTERN |
#ifndef SQLITE_EXTERN |
# define SQLITE_EXTERN extern |
# define SQLITE_EXTERN extern |
#endif |
#endif |
|
|
#ifndef SQLITE_API |
#ifndef SQLITE_API |
# define SQLITE_API |
# define SQLITE_API |
#endif |
#endif |
|
#ifndef SQLITE_CDECL |
|
# define SQLITE_CDECL |
|
#endif |
|
#ifndef SQLITE_APICALL |
|
# define SQLITE_APICALL |
|
#endif |
|
#ifndef SQLITE_STDCALL |
|
# define SQLITE_STDCALL SQLITE_APICALL |
|
#endif |
|
#ifndef SQLITE_CALLBACK |
|
# define SQLITE_CALLBACK |
|
#endif |
|
#ifndef SQLITE_SYSAPI |
|
# define SQLITE_SYSAPI |
|
#endif |
|
|
|
|
/* |
/* |
** These no-op macros are used in front of interfaces to mark those |
** These no-op macros are used in front of interfaces to mark those |
** interfaces as either deprecated or experimental. New applications |
** interfaces as either deprecated or experimental. New applications |
** should not use deprecated interfaces - they are support for backwards | ** should not use deprecated interfaces - they are supported for backwards |
** compatibility only. Application writers should be aware that |
** compatibility only. Application writers should be aware that |
** experimental interfaces are subject to change in point releases. |
** experimental interfaces are subject to change in point releases. |
** |
** |
Line 95 extern "C" {
|
Line 108 extern "C" {
|
** be held constant and Z will be incremented or else Y will be incremented |
** be held constant and Z will be incremented or else Y will be incremented |
** and Z will be reset to zero. |
** and Z will be reset to zero. |
** |
** |
** Since version 3.6.18, SQLite source code has been stored in the | ** Since [version 3.6.18] ([dateof:3.6.18]), |
| ** SQLite source code has been stored in the |
** <a href="http://www.fossil-scm.org/">Fossil configuration management |
** <a href="http://www.fossil-scm.org/">Fossil configuration management |
** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to |
** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to |
** a string which identifies a particular check-in of SQLite |
** a string which identifies a particular check-in of SQLite |
** within its configuration management system. ^The SQLITE_SOURCE_ID |
** within its configuration management system. ^The SQLITE_SOURCE_ID |
** string contains the date and time of the check-in (UTC) and an SHA1 | ** string contains the date and time of the check-in (UTC) and a SHA1 |
** hash of the entire source tree. | ** or SHA3-256 hash of the entire source tree. If the source code has |
| ** been edited in any way since it was last checked in, then the last |
| ** four hexadecimal digits of the hash may be modified. |
** |
** |
** See also: [sqlite3_libversion()], |
** See also: [sqlite3_libversion()], |
** [sqlite3_libversion_number()], [sqlite3_sourceid()], |
** [sqlite3_libversion_number()], [sqlite3_sourceid()], |
** [sqlite_version()] and [sqlite_source_id()]. |
** [sqlite_version()] and [sqlite_source_id()]. |
*/ |
*/ |
#define SQLITE_VERSION "3.7.10" | #define SQLITE_VERSION "3.33.0" |
#define SQLITE_VERSION_NUMBER 3007010 | #define SQLITE_VERSION_NUMBER 3033000 |
#define SQLITE_SOURCE_ID "2012-01-16 13:28:40 ebd01a8deffb5024a5d7494eef800d2366d97204" | #define SQLITE_SOURCE_ID "2020-08-14 13:23:32 fca8dc8b578f215a969cd899336378966156154710873e68b3d9ac5881b0ff3f" |
|
|
/* |
/* |
** CAPI3REF: Run-Time Library Version Numbers |
** CAPI3REF: Run-Time Library Version Numbers |
** KEYWORDS: sqlite3_version, sqlite3_sourceid | ** KEYWORDS: sqlite3_version sqlite3_sourceid |
** |
** |
** These interfaces provide the same information as the [SQLITE_VERSION], |
** These interfaces provide the same information as the [SQLITE_VERSION], |
** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros |
** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros |
** but are associated with the library instead of the header file. ^(Cautious |
** but are associated with the library instead of the header file. ^(Cautious |
** programmers might include assert() statements in their application to |
** programmers might include assert() statements in their application to |
** verify that values returned by these interfaces match the macros in |
** verify that values returned by these interfaces match the macros in |
** the header, and thus insure that the application is | ** the header, and thus ensure that the application is |
** compiled with matching library and header files. |
** compiled with matching library and header files. |
** |
** |
** <blockquote><pre> |
** <blockquote><pre> |
** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); |
** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); |
** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); | ** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 ); |
** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); |
** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); |
** </pre></blockquote>)^ |
** </pre></blockquote>)^ |
** |
** |
Line 135 extern "C" {
|
Line 151 extern "C" {
|
** function is provided for use in DLLs since DLL users usually do not have |
** function is provided for use in DLLs since DLL users usually do not have |
** direct access to string constants within the DLL. ^The |
** direct access to string constants within the DLL. ^The |
** sqlite3_libversion_number() function returns an integer equal to |
** sqlite3_libversion_number() function returns an integer equal to |
** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns | ** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns |
** a pointer to a string constant whose value is the same as the | ** a pointer to a string constant whose value is the same as the |
** [SQLITE_SOURCE_ID] C preprocessor macro. | ** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built |
| ** using an edited copy of [the amalgamation], then the last four characters |
| ** of the hash might be different from [SQLITE_SOURCE_ID].)^ |
** |
** |
** See also: [sqlite_version()] and [sqlite_source_id()]. |
** See also: [sqlite_version()] and [sqlite_source_id()]. |
*/ |
*/ |
Line 149 SQLITE_API int sqlite3_libversion_number(void);
|
Line 167 SQLITE_API int sqlite3_libversion_number(void);
|
/* |
/* |
** CAPI3REF: Run-Time Library Compilation Options Diagnostics |
** CAPI3REF: Run-Time Library Compilation Options Diagnostics |
** |
** |
** ^The sqlite3_compileoption_used() function returns 0 or 1 | ** ^The sqlite3_compileoption_used() function returns 0 or 1 |
** indicating whether the specified option was defined at | ** indicating whether the specified option was defined at |
** compile time. ^The SQLITE_ prefix may be omitted from the | ** compile time. ^The SQLITE_ prefix may be omitted from the |
** option name passed to sqlite3_compileoption_used(). | ** option name passed to sqlite3_compileoption_used(). |
** |
** |
** ^The sqlite3_compileoption_get() function allows iterating |
** ^The sqlite3_compileoption_get() function allows iterating |
** over the list of options that were defined at compile time by |
** over the list of options that were defined at compile time by |
** returning the N-th compile time option string. ^If N is out of range, |
** returning the N-th compile time option string. ^If N is out of range, |
** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ | ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ |
** prefix is omitted from any strings returned by | ** prefix is omitted from any strings returned by |
** sqlite3_compileoption_get(). |
** sqlite3_compileoption_get(). |
** |
** |
** ^Support for the diagnostic functions sqlite3_compileoption_used() |
** ^Support for the diagnostic functions sqlite3_compileoption_used() |
** and sqlite3_compileoption_get() may be omitted by specifying the | ** and sqlite3_compileoption_get() may be omitted by specifying the |
** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. |
** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. |
** |
** |
** See also: SQL functions [sqlite_compileoption_used()] and |
** See also: SQL functions [sqlite_compileoption_used()] and |
Line 171 SQLITE_API int sqlite3_libversion_number(void);
|
Line 189 SQLITE_API int sqlite3_libversion_number(void);
|
#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS |
#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS |
SQLITE_API int sqlite3_compileoption_used(const char *zOptName); |
SQLITE_API int sqlite3_compileoption_used(const char *zOptName); |
SQLITE_API const char *sqlite3_compileoption_get(int N); |
SQLITE_API const char *sqlite3_compileoption_get(int N); |
|
#else |
|
# define sqlite3_compileoption_used(X) 0 |
|
# define sqlite3_compileoption_get(X) ((void*)0) |
#endif |
#endif |
|
|
/* |
/* |
Line 183 SQLITE_API const char *sqlite3_compileoption_get(int N
|
Line 204 SQLITE_API const char *sqlite3_compileoption_get(int N
|
** SQLite can be compiled with or without mutexes. When |
** SQLite can be compiled with or without mutexes. When |
** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes |
** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes |
** are enabled and SQLite is threadsafe. When the |
** are enabled and SQLite is threadsafe. When the |
** [SQLITE_THREADSAFE] macro is 0, | ** [SQLITE_THREADSAFE] macro is 0, |
** the mutexes are omitted. Without the mutexes, it is not safe |
** the mutexes are omitted. Without the mutexes, it is not safe |
** to use SQLite concurrently from more than one thread. |
** to use SQLite concurrently from more than one thread. |
** |
** |
Line 201 SQLITE_API const char *sqlite3_compileoption_get(int N
|
Line 222 SQLITE_API const char *sqlite3_compileoption_get(int N
|
** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but |
** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but |
** can be fully or partially disabled using a call to [sqlite3_config()] |
** can be fully or partially disabled using a call to [sqlite3_config()] |
** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], |
** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], |
** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the | ** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the |
** sqlite3_threadsafe() function shows only the compile-time setting of |
** sqlite3_threadsafe() function shows only the compile-time setting of |
** thread safety, not any run-time changes to that setting made by |
** thread safety, not any run-time changes to that setting made by |
** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() |
** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() |
Line 219 SQLITE_API int sqlite3_threadsafe(void);
|
Line 240 SQLITE_API int sqlite3_threadsafe(void);
|
** the opaque structure named "sqlite3". It is useful to think of an sqlite3 |
** the opaque structure named "sqlite3". It is useful to think of an sqlite3 |
** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and |
** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and |
** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] |
** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] |
** is its destructor. There are many other interfaces (such as | ** and [sqlite3_close_v2()] are its destructors. There are many other |
| ** interfaces (such as |
** [sqlite3_prepare_v2()], [sqlite3_create_function()], and |
** [sqlite3_prepare_v2()], [sqlite3_create_function()], and |
** [sqlite3_busy_timeout()] to name but three) that are methods on an |
** [sqlite3_busy_timeout()] to name but three) that are methods on an |
** sqlite3 object. |
** sqlite3 object. |
Line 239 typedef struct sqlite3 sqlite3;
|
Line 261 typedef struct sqlite3 sqlite3;
|
** |
** |
** ^The sqlite3_int64 and sqlite_int64 types can store integer values |
** ^The sqlite3_int64 and sqlite_int64 types can store integer values |
** between -9223372036854775808 and +9223372036854775807 inclusive. ^The |
** between -9223372036854775808 and +9223372036854775807 inclusive. ^The |
** sqlite3_uint64 and sqlite_uint64 types can store integer values | ** sqlite3_uint64 and sqlite_uint64 types can store integer values |
** between 0 and +18446744073709551615 inclusive. |
** between 0 and +18446744073709551615 inclusive. |
*/ |
*/ |
#ifdef SQLITE_INT64_TYPE |
#ifdef SQLITE_INT64_TYPE |
typedef SQLITE_INT64_TYPE sqlite_int64; |
typedef SQLITE_INT64_TYPE sqlite_int64; |
typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; | # ifdef SQLITE_UINT64_TYPE |
| typedef SQLITE_UINT64_TYPE sqlite_uint64; |
| # else |
| typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; |
| # endif |
#elif defined(_MSC_VER) || defined(__BORLANDC__) |
#elif defined(_MSC_VER) || defined(__BORLANDC__) |
typedef __int64 sqlite_int64; |
typedef __int64 sqlite_int64; |
typedef unsigned __int64 sqlite_uint64; |
typedef unsigned __int64 sqlite_uint64; |
Line 265 typedef sqlite_uint64 sqlite3_uint64;
|
Line 291 typedef sqlite_uint64 sqlite3_uint64;
|
|
|
/* |
/* |
** CAPI3REF: Closing A Database Connection |
** CAPI3REF: Closing A Database Connection |
|
** DESTRUCTOR: sqlite3 |
** |
** |
** ^The sqlite3_close() routine is the destructor for the [sqlite3] object. | ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors |
** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is | ** for the [sqlite3] object. |
** successfully destroyed and all associated resources are deallocated. | ** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if |
| ** the [sqlite3] object is successfully destroyed and all associated |
| ** resources are deallocated. |
** |
** |
** Applications must [sqlite3_finalize | finalize] all [prepared statements] | ** Ideally, applications should [sqlite3_finalize | finalize] all |
** and [sqlite3_blob_close | close] all [BLOB handles] associated with | ** [prepared statements], [sqlite3_blob_close | close] all [BLOB handles], and |
** the [sqlite3] object prior to attempting to close the object. ^If | ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated |
** sqlite3_close() is called on a [database connection] that still has | ** with the [sqlite3] object prior to attempting to close the object. |
** outstanding [prepared statements] or [BLOB handles], then it returns | ** ^If the database connection is associated with unfinalized prepared |
** SQLITE_BUSY. | ** statements, BLOB handlers, and/or unfinished sqlite3_backup objects then |
| ** sqlite3_close() will leave the database connection open and return |
| ** [SQLITE_BUSY]. ^If sqlite3_close_v2() is called with unfinalized prepared |
| ** statements, unclosed BLOB handlers, and/or unfinished sqlite3_backups, |
| ** it returns [SQLITE_OK] regardless, but instead of deallocating the database |
| ** connection immediately, it marks the database connection as an unusable |
| ** "zombie" and makes arrangements to automatically deallocate the database |
| ** connection after all prepared statements are finalized, all BLOB handles |
| ** are closed, and all backups have finished. The sqlite3_close_v2() interface |
| ** is intended for use with host languages that are garbage collected, and |
| ** where the order in which destructors are called is arbitrary. |
** |
** |
** ^If [sqlite3_close()] is invoked while a transaction is open, | ** ^If an [sqlite3] object is destroyed while a transaction is open, |
** the transaction is automatically rolled back. |
** the transaction is automatically rolled back. |
** |
** |
** The C parameter to [sqlite3_close(C)] must be either a NULL | ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)] |
| ** must be either a NULL |
** pointer or an [sqlite3] object pointer obtained |
** pointer or an [sqlite3] object pointer obtained |
** from [sqlite3_open()], [sqlite3_open16()], or |
** from [sqlite3_open()], [sqlite3_open16()], or |
** [sqlite3_open_v2()], and not previously closed. |
** [sqlite3_open_v2()], and not previously closed. |
** ^Calling sqlite3_close() with a NULL pointer argument is a | ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer |
** harmless no-op. | ** argument is a harmless no-op. |
*/ |
*/ |
SQLITE_API int sqlite3_close(sqlite3 *); | SQLITE_API int sqlite3_close(sqlite3*); |
| SQLITE_API int sqlite3_close_v2(sqlite3*); |
|
|
/* |
/* |
** The type for a callback function. |
** The type for a callback function. |
Line 298 typedef int (*sqlite3_callback)(void*,int,char**, char
|
Line 339 typedef int (*sqlite3_callback)(void*,int,char**, char
|
|
|
/* |
/* |
** CAPI3REF: One-Step Query Execution Interface |
** CAPI3REF: One-Step Query Execution Interface |
|
** METHOD: sqlite3 |
** |
** |
** The sqlite3_exec() interface is a convenience wrapper around |
** The sqlite3_exec() interface is a convenience wrapper around |
** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], |
** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], |
** that allows an application to run multiple statements of SQL |
** that allows an application to run multiple statements of SQL |
** without having to use a lot of C code. | ** without having to use a lot of C code. |
** |
** |
** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, |
** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, |
** semicolon-separate SQL statements passed into its 2nd argument, |
** semicolon-separate SQL statements passed into its 2nd argument, |
Line 322 typedef int (*sqlite3_callback)(void*,int,char**, char
|
Line 364 typedef int (*sqlite3_callback)(void*,int,char**, char
|
** from [sqlite3_malloc()] and passed back through the 5th parameter. |
** from [sqlite3_malloc()] and passed back through the 5th parameter. |
** To avoid memory leaks, the application should invoke [sqlite3_free()] |
** To avoid memory leaks, the application should invoke [sqlite3_free()] |
** on error message strings returned through the 5th parameter of |
** on error message strings returned through the 5th parameter of |
** of sqlite3_exec() after the error message string is no longer needed. | ** sqlite3_exec() after the error message string is no longer needed. |
** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors |
** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors |
** occur, then sqlite3_exec() sets the pointer in its 5th parameter to |
** occur, then sqlite3_exec() sets the pointer in its 5th parameter to |
** NULL before returning. |
** NULL before returning. |
Line 342 typedef int (*sqlite3_callback)(void*,int,char**, char
|
Line 384 typedef int (*sqlite3_callback)(void*,int,char**, char
|
** from [sqlite3_column_name()]. |
** from [sqlite3_column_name()]. |
** |
** |
** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer |
** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer |
** to an empty string, or a pointer that contains only whitespace and/or | ** to an empty string, or a pointer that contains only whitespace and/or |
** SQL comments, then no SQL statements are evaluated and the database |
** SQL comments, then no SQL statements are evaluated and the database |
** is not changed. |
** is not changed. |
** |
** |
** Restrictions: |
** Restrictions: |
** |
** |
** <ul> |
** <ul> |
** <li> The application must insure that the 1st parameter to sqlite3_exec() | ** <li> The application must ensure that the 1st parameter to sqlite3_exec() |
** is a valid and open [database connection]. |
** is a valid and open [database connection]. |
** <li> The application must not close [database connection] specified by | ** <li> The application must not close the [database connection] specified by |
** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. |
** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. |
** <li> The application must not modify the SQL statement text passed into |
** <li> The application must not modify the SQL statement text passed into |
** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. |
** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. |
Line 367 SQLITE_API int sqlite3_exec(
|
Line 409 SQLITE_API int sqlite3_exec(
|
|
|
/* |
/* |
** CAPI3REF: Result Codes |
** CAPI3REF: Result Codes |
** KEYWORDS: SQLITE_OK {error code} {error codes} | ** KEYWORDS: {result code definitions} |
** KEYWORDS: {result code} {result codes} | |
** |
** |
** Many SQLite functions return an integer result code from the set shown |
** Many SQLite functions return an integer result code from the set shown |
** here in order to indicate success or failure. |
** here in order to indicate success or failure. |
** |
** |
** New error codes may be added in future versions of SQLite. |
** New error codes may be added in future versions of SQLite. |
** |
** |
** See also: [SQLITE_IOERR_READ | extended result codes], | ** See also: [extended result code definitions] |
** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes]. | |
*/ |
*/ |
#define SQLITE_OK 0 /* Successful result */ |
#define SQLITE_OK 0 /* Successful result */ |
/* beginning-of-error-codes */ |
/* beginning-of-error-codes */ |
#define SQLITE_ERROR 1 /* SQL error or missing database */ | #define SQLITE_ERROR 1 /* Generic error */ |
#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ |
#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ |
#define SQLITE_PERM 3 /* Access permission denied */ |
#define SQLITE_PERM 3 /* Access permission denied */ |
#define SQLITE_ABORT 4 /* Callback routine requested an abort */ |
#define SQLITE_ABORT 4 /* Callback routine requested an abort */ |
Line 395 SQLITE_API int sqlite3_exec(
|
Line 435 SQLITE_API int sqlite3_exec(
|
#define SQLITE_FULL 13 /* Insertion failed because database is full */ |
#define SQLITE_FULL 13 /* Insertion failed because database is full */ |
#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ |
#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ |
#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ |
#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ |
#define SQLITE_EMPTY 16 /* Database is empty */ | #define SQLITE_EMPTY 16 /* Internal use only */ |
#define SQLITE_SCHEMA 17 /* The database schema changed */ |
#define SQLITE_SCHEMA 17 /* The database schema changed */ |
#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ |
#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ |
#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ |
#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ |
Line 403 SQLITE_API int sqlite3_exec(
|
Line 443 SQLITE_API int sqlite3_exec(
|
#define SQLITE_MISUSE 21 /* Library used incorrectly */ |
#define SQLITE_MISUSE 21 /* Library used incorrectly */ |
#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ |
#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ |
#define SQLITE_AUTH 23 /* Authorization denied */ |
#define SQLITE_AUTH 23 /* Authorization denied */ |
#define SQLITE_FORMAT 24 /* Auxiliary database format error */ | #define SQLITE_FORMAT 24 /* Not used */ |
#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ |
#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ |
#define SQLITE_NOTADB 26 /* File opened that is not a database file */ |
#define SQLITE_NOTADB 26 /* File opened that is not a database file */ |
|
#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */ |
|
#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */ |
#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ |
#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ |
#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ |
#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ |
/* end-of-error-codes */ |
/* end-of-error-codes */ |
|
|
/* |
/* |
** CAPI3REF: Extended Result Codes |
** CAPI3REF: Extended Result Codes |
** KEYWORDS: {extended error code} {extended error codes} | ** KEYWORDS: {extended result code definitions} |
** KEYWORDS: {extended result code} {extended result codes} | |
** |
** |
** In its default configuration, SQLite API routines return one of 26 integer | ** In its default configuration, SQLite API routines return one of 30 integer |
** [SQLITE_OK | result codes]. However, experience has shown that many of | ** [result codes]. However, experience has shown that many of |
** these result codes are too coarse-grained. They do not provide as |
** these result codes are too coarse-grained. They do not provide as |
** much information about problems as programmers might like. In an effort to |
** much information about problems as programmers might like. In an effort to |
** address this, newer versions of SQLite (version 3.3.8 and later) include | ** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8] |
| ** and later) include |
** support for additional result codes that provide more detailed information |
** support for additional result codes that provide more detailed information |
** about errors. The extended result codes are enabled or disabled | ** about errors. These [extended result codes] are enabled or disabled |
** on a per database connection basis using the |
** on a per database connection basis using the |
** [sqlite3_extended_result_codes()] API. | ** [sqlite3_extended_result_codes()] API. Or, the extended code for |
** | ** the most recent error can be obtained using |
** Some of the available extended result codes are listed here. | ** [sqlite3_extended_errcode()]. |
** One may expect the number of extended result codes will be expand | |
** over time. Software that uses extended result codes should expect | |
** to see new result codes in future releases of SQLite. | |
** | |
** The SQLITE_OK result code will never be extended. It will always | |
** be exactly zero. | |
*/ |
*/ |
|
#define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8)) |
|
#define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8)) |
|
#define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR | (3<<8)) |
#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) |
#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) |
#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) |
#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) |
#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) |
#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) |
Line 455 SQLITE_API int sqlite3_exec(
|
Line 494 SQLITE_API int sqlite3_exec(
|
#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) |
#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) |
#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) |
#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) |
#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) |
#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) |
|
#define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8)) |
|
#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8)) |
|
#define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8)) |
|
#define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8)) |
|
#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8)) |
|
#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8)) |
|
#define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR | (29<<8)) |
|
#define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR | (30<<8)) |
|
#define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR | (31<<8)) |
|
#define SQLITE_IOERR_DATA (SQLITE_IOERR | (32<<8)) |
#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) |
#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) |
|
#define SQLITE_LOCKED_VTAB (SQLITE_LOCKED | (2<<8)) |
#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) |
#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) |
|
#define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8)) |
|
#define SQLITE_BUSY_TIMEOUT (SQLITE_BUSY | (3<<8)) |
#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) |
#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) |
|
#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) |
|
#define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8)) |
|
#define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8)) |
|
#define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN | (5<<8)) /* Not Used */ |
|
#define SQLITE_CANTOPEN_SYMLINK (SQLITE_CANTOPEN | (6<<8)) |
#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) |
#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) |
|
#define SQLITE_CORRUPT_SEQUENCE (SQLITE_CORRUPT | (2<<8)) |
|
#define SQLITE_CORRUPT_INDEX (SQLITE_CORRUPT | (3<<8)) |
#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) |
#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) |
#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) |
#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) |
|
#define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8)) |
|
#define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8)) |
|
#define SQLITE_READONLY_CANTINIT (SQLITE_READONLY | (5<<8)) |
|
#define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY | (6<<8)) |
|
#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) |
|
#define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8)) |
|
#define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8)) |
|
#define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8)) |
|
#define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8)) |
|
#define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8)) |
|
#define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8)) |
|
#define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8)) |
|
#define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8)) |
|
#define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8)) |
|
#define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8)) |
|
#define SQLITE_CONSTRAINT_PINNED (SQLITE_CONSTRAINT |(11<<8)) |
|
#define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8)) |
|
#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8)) |
|
#define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8)) |
|
#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8)) |
|
#define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8)) |
|
#define SQLITE_OK_SYMLINK (SQLITE_OK | (2<<8)) |
|
|
/* |
/* |
** CAPI3REF: Flags For File Open Operations |
** CAPI3REF: Flags For File Open Operations |
Line 476 SQLITE_API int sqlite3_exec(
|
Line 557 SQLITE_API int sqlite3_exec(
|
#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ |
#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ |
#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ |
#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ |
#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ |
|
#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ |
#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ |
#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ |
#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ |
#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ |
#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ |
#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ |
#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ |
#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ |
#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ |
#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ |
#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ |
#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ | #define SQLITE_OPEN_SUPER_JOURNAL 0x00004000 /* VFS only */ |
#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ |
#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ |
#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ |
|
#define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for sqlite3_open_v2() */ |
|
|
/* Reserved: 0x00F00000 */ |
/* Reserved: 0x00F00000 */ |
|
/* Legacy compatibility: */ |
|
#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ |
|
|
|
|
/* |
/* |
** CAPI3REF: Device Characteristics |
** CAPI3REF: Device Characteristics |
** |
** |
** The xDeviceCharacteristics method of the [sqlite3_io_methods] |
** The xDeviceCharacteristics method of the [sqlite3_io_methods] |
** object returns an integer which is a vector of the these | ** object returns an integer which is a vector of these |
** bit values expressing I/O characteristics of the mass storage |
** bit values expressing I/O characteristics of the mass storage |
** device that holds the file that the [sqlite3_io_methods] |
** device that holds the file that the [sqlite3_io_methods] |
** refers to. |
** refers to. |
Line 513 SQLITE_API int sqlite3_exec(
|
Line 599 SQLITE_API int sqlite3_exec(
|
** after reboot following a crash or power loss, the only bytes in a |
** after reboot following a crash or power loss, the only bytes in a |
** file that were written at the application level might have changed |
** file that were written at the application level might have changed |
** and that adjacent bytes, even bytes within the same sector are |
** and that adjacent bytes, even bytes within the same sector are |
** guaranteed to be unchanged. | ** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN |
| ** flag indicates that a file cannot be deleted when open. The |
| ** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on |
| ** read-only media and cannot be changed even by processes with |
| ** elevated privileges. |
| ** |
| ** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying |
| ** filesystem supports doing multiple write operations atomically when those |
| ** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and |
| ** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. |
*/ |
*/ |
#define SQLITE_IOCAP_ATOMIC 0x00000001 |
#define SQLITE_IOCAP_ATOMIC 0x00000001 |
#define SQLITE_IOCAP_ATOMIC512 0x00000002 |
#define SQLITE_IOCAP_ATOMIC512 0x00000002 |
Line 528 SQLITE_API int sqlite3_exec(
|
Line 623 SQLITE_API int sqlite3_exec(
|
#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 |
#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 |
#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 |
#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 |
#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 |
#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 |
|
#define SQLITE_IOCAP_IMMUTABLE 0x00002000 |
|
#define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000 |
|
|
/* |
/* |
** CAPI3REF: File Locking Levels |
** CAPI3REF: File Locking Levels |
Line 575 SQLITE_API int sqlite3_exec(
|
Line 672 SQLITE_API int sqlite3_exec(
|
/* |
/* |
** CAPI3REF: OS Interface Open File Handle |
** CAPI3REF: OS Interface Open File Handle |
** |
** |
** An [sqlite3_file] object represents an open file in the | ** An [sqlite3_file] object represents an open file in the |
** [sqlite3_vfs | OS interface layer]. Individual OS interface |
** [sqlite3_vfs | OS interface layer]. Individual OS interface |
** implementations will |
** implementations will |
** want to subclass this object by appending additional fields |
** want to subclass this object by appending additional fields |
Line 597 struct sqlite3_file {
|
Line 694 struct sqlite3_file {
|
** This object defines the methods used to perform various operations |
** This object defines the methods used to perform various operations |
** against the open file represented by the [sqlite3_file] object. |
** against the open file represented by the [sqlite3_file] object. |
** |
** |
** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element | ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element |
** to a non-NULL pointer, then the sqlite3_io_methods.xClose method |
** to a non-NULL pointer, then the sqlite3_io_methods.xClose method |
** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The |
** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The |
** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] |
** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] |
Line 634 struct sqlite3_file {
|
Line 731 struct sqlite3_file {
|
** locking strategy (for example to use dot-file locks), to inquire |
** locking strategy (for example to use dot-file locks), to inquire |
** about the status of a lock, or to break stale locks. The SQLite |
** about the status of a lock, or to break stale locks. The SQLite |
** core reserves all opcodes less than 100 for its own use. |
** core reserves all opcodes less than 100 for its own use. |
** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. | ** A [file control opcodes | list of opcodes] less than 100 is available. |
** Applications that define a custom xFileControl method should use opcodes |
** Applications that define a custom xFileControl method should use opcodes |
** greater than 100 to avoid conflicts. VFS implementations should |
** greater than 100 to avoid conflicts. VFS implementations should |
** return [SQLITE_NOTFOUND] for file control opcodes that they do not |
** return [SQLITE_NOTFOUND] for file control opcodes that they do not |
Line 659 struct sqlite3_file {
|
Line 756 struct sqlite3_file {
|
** <li> [SQLITE_IOCAP_ATOMIC64K] |
** <li> [SQLITE_IOCAP_ATOMIC64K] |
** <li> [SQLITE_IOCAP_SAFE_APPEND] |
** <li> [SQLITE_IOCAP_SAFE_APPEND] |
** <li> [SQLITE_IOCAP_SEQUENTIAL] |
** <li> [SQLITE_IOCAP_SEQUENTIAL] |
|
** <li> [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN] |
|
** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE] |
|
** <li> [SQLITE_IOCAP_IMMUTABLE] |
|
** <li> [SQLITE_IOCAP_BATCH_ATOMIC] |
** </ul> |
** </ul> |
** |
** |
** The SQLITE_IOCAP_ATOMIC property means that all writes of |
** The SQLITE_IOCAP_ATOMIC property means that all writes of |
Line 699 struct sqlite3_io_methods {
|
Line 800 struct sqlite3_io_methods {
|
void (*xShmBarrier)(sqlite3_file*); |
void (*xShmBarrier)(sqlite3_file*); |
int (*xShmUnmap)(sqlite3_file*, int deleteFlag); |
int (*xShmUnmap)(sqlite3_file*, int deleteFlag); |
/* Methods above are valid for version 2 */ |
/* Methods above are valid for version 2 */ |
|
int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp); |
|
int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p); |
|
/* Methods above are valid for version 3 */ |
/* Additional methods may be added in future releases */ |
/* Additional methods may be added in future releases */ |
}; |
}; |
|
|
/* |
/* |
** CAPI3REF: Standard File Control Opcodes |
** CAPI3REF: Standard File Control Opcodes |
|
** KEYWORDS: {file control opcodes} {file control opcode} |
** |
** |
** These integer constants are opcodes for the xFileControl method |
** These integer constants are opcodes for the xFileControl method |
** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] |
** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] |
** interface. |
** interface. |
** |
** |
|
** <ul> |
|
** <li>[[SQLITE_FCNTL_LOCKSTATE]] |
** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This |
** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This |
** opcode causes the xFileControl method to write the current state of |
** opcode causes the xFileControl method to write the current state of |
** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], |
** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], |
** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) |
** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) |
** into an integer that the pArg argument points to. This capability |
** into an integer that the pArg argument points to. This capability |
** is used during testing and only needs to be supported when SQLITE_TEST | ** is used during testing and is only available when the SQLITE_TEST |
** is defined. | ** compile-time option is used. |
** |
** |
|
** <li>[[SQLITE_FCNTL_SIZE_HINT]] |
** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS |
** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS |
** layer a hint of how large the database file will grow to be during the |
** layer a hint of how large the database file will grow to be during the |
** current transaction. This hint is not guaranteed to be accurate but it |
** current transaction. This hint is not guaranteed to be accurate but it |
Line 724 struct sqlite3_io_methods {
|
Line 832 struct sqlite3_io_methods {
|
** file space based on this hint in order to help writes to the database |
** file space based on this hint in order to help writes to the database |
** file run faster. |
** file run faster. |
** |
** |
|
** <li>[[SQLITE_FCNTL_SIZE_LIMIT]] |
|
** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that |
|
** implements [sqlite3_deserialize()] to set an upper bound on the size |
|
** of the in-memory database. The argument is a pointer to a [sqlite3_int64]. |
|
** If the integer pointed to is negative, then it is filled in with the |
|
** current limit. Otherwise the limit is set to the larger of the value |
|
** of the integer pointed to and the current database size. The integer |
|
** pointed to is set to the new limit. |
|
** |
|
** <li>[[SQLITE_FCNTL_CHUNK_SIZE]] |
** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS |
** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS |
** extends and truncates the database file in chunks of a size specified |
** extends and truncates the database file in chunks of a size specified |
** by the user. The fourth argument to [sqlite3_file_control()] should | ** by the user. The fourth argument to [sqlite3_file_control()] should |
** point to an integer (type int) containing the new chunk-size to use |
** point to an integer (type int) containing the new chunk-size to use |
** for the nominated database. Allocating database file space in large |
** for the nominated database. Allocating database file space in large |
** chunks (say 1MB at a time), may reduce file-system fragmentation and |
** chunks (say 1MB at a time), may reduce file-system fragmentation and |
** improve performance on some systems. |
** improve performance on some systems. |
** |
** |
|
** <li>[[SQLITE_FCNTL_FILE_POINTER]] |
** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer |
** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer |
** to the [sqlite3_file] object associated with a particular database |
** to the [sqlite3_file] object associated with a particular database |
** connection. See the [sqlite3_file_control()] documentation for | ** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER]. |
** additional information. | |
** |
** |
** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by | ** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]] |
** SQLite and sent to all VFSes in place of a call to the xSync method | ** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer |
** when the database connection has [PRAGMA synchronous] set to OFF.)^ | ** to the [sqlite3_file] object associated with the journal file (either |
** Some specialized VFSes need this signal in order to operate correctly | ** the [rollback journal] or the [write-ahead log]) for a particular database |
** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most | ** connection. See also [SQLITE_FCNTL_FILE_POINTER]. |
** VFSes do not need this signal and should silently ignore this opcode. | |
** Applications should not call [sqlite3_file_control()] with this | |
** opcode as doing so may disrupt the operation of the specialized VFSes | |
** that do require it. | |
** |
** |
|
** <li>[[SQLITE_FCNTL_SYNC_OMITTED]] |
|
** No longer in use. |
|
** |
|
** <li>[[SQLITE_FCNTL_SYNC]] |
|
** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and |
|
** sent to the VFS immediately before the xSync method is invoked on a |
|
** database file descriptor. Or, if the xSync method is not invoked |
|
** because the user has configured SQLite with |
|
** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place |
|
** of the xSync method. In most cases, the pointer argument passed with |
|
** this file-control is NULL. However, if the database file is being synced |
|
** as part of a multi-database commit, the argument points to a nul-terminated |
|
** string containing the transactions super-journal file name. VFSes that |
|
** do not need this signal should silently ignore this opcode. Applications |
|
** should not call [sqlite3_file_control()] with this opcode as doing so may |
|
** disrupt the operation of the specialized VFSes that do require it. |
|
** |
|
** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]] |
|
** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite |
|
** and sent to the VFS after a transaction has been committed immediately |
|
** but before the database is unlocked. VFSes that do not need this signal |
|
** should silently ignore this opcode. Applications should not call |
|
** [sqlite3_file_control()] with this opcode as doing so may disrupt the |
|
** operation of the specialized VFSes that do require it. |
|
** |
|
** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]] |
** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic |
** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic |
** retry counts and intervals for certain disk I/O operations for the |
** retry counts and intervals for certain disk I/O operations for the |
** windows [VFS] in order to provide robustness in the presence of |
** windows [VFS] in order to provide robustness in the presence of |
Line 757 struct sqlite3_io_methods {
|
Line 897 struct sqlite3_io_methods {
|
** opcode allows these two values (10 retries and 25 milliseconds of delay) |
** opcode allows these two values (10 retries and 25 milliseconds of delay) |
** to be adjusted. The values are changed for all database connections |
** to be adjusted. The values are changed for all database connections |
** within the same process. The argument is a pointer to an array of two |
** within the same process. The argument is a pointer to an array of two |
** integers where the first integer i the new retry count and the second | ** integers where the first integer is the new retry count and the second |
** integer is the delay. If either integer is negative, then the setting |
** integer is the delay. If either integer is negative, then the setting |
** is not changed but instead the prior value of that setting is written |
** is not changed but instead the prior value of that setting is written |
** into the array entry, allowing the current retry settings to be |
** into the array entry, allowing the current retry settings to be |
** interrogated. The zDbName parameter is ignored. |
** interrogated. The zDbName parameter is ignored. |
** |
** |
|
** <li>[[SQLITE_FCNTL_PERSIST_WAL]] |
** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the |
** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the |
** persistent [WAL | Write AHead Log] setting. By default, the auxiliary | ** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary |
** write ahead log and shared memory files used for transaction control | ** write ahead log ([WAL file]) and shared memory |
| ** files used for transaction control |
** are automatically deleted when the latest connection to the database |
** are automatically deleted when the latest connection to the database |
** closes. Setting persistent WAL mode causes those files to persist after |
** closes. Setting persistent WAL mode causes those files to persist after |
** close. Persisting the files is useful when other processes that do not |
** close. Persisting the files is useful when other processes that do not |
Line 777 struct sqlite3_io_methods {
|
Line 919 struct sqlite3_io_methods {
|
** WAL mode. If the integer is -1, then it is overwritten with the current |
** WAL mode. If the integer is -1, then it is overwritten with the current |
** WAL persistence setting. |
** WAL persistence setting. |
** |
** |
|
** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] |
** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the |
** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the |
** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting |
** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting |
** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the |
** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the |
Line 786 struct sqlite3_io_methods {
|
Line 929 struct sqlite3_io_methods {
|
** mode. If the integer is -1, then it is overwritten with the current |
** mode. If the integer is -1, then it is overwritten with the current |
** zero-damage mode setting. |
** zero-damage mode setting. |
** |
** |
|
** <li>[[SQLITE_FCNTL_OVERWRITE]] |
** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening |
** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening |
** a write transaction to indicate that, unless it is rolled back for some |
** a write transaction to indicate that, unless it is rolled back for some |
** reason, the entire database file will be overwritten by the current | ** reason, the entire database file will be overwritten by the current |
** transaction. This is used by VACUUM operations. |
** transaction. This is used by VACUUM operations. |
** |
** |
|
** <li>[[SQLITE_FCNTL_VFSNAME]] |
** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of |
** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of |
** all [VFSes] in the VFS stack. The names are of all VFS shims and the |
** all [VFSes] in the VFS stack. The names are of all VFS shims and the |
** final bottom-level VFS are written into memory obtained from | ** final bottom-level VFS are written into memory obtained from |
** [sqlite3_malloc()] and the result is stored in the char* variable |
** [sqlite3_malloc()] and the result is stored in the char* variable |
** that the fourth parameter of [sqlite3_file_control()] points to. |
** that the fourth parameter of [sqlite3_file_control()] points to. |
** The caller is responsible for freeing the memory when done. As with |
** The caller is responsible for freeing the memory when done. As with |
Line 801 struct sqlite3_io_methods {
|
Line 946 struct sqlite3_io_methods {
|
** do anything. Callers should initialize the char* variable to a NULL |
** do anything. Callers should initialize the char* variable to a NULL |
** pointer in case this file-control is not implemented. This file-control |
** pointer in case this file-control is not implemented. This file-control |
** is intended for diagnostic use only. |
** is intended for diagnostic use only. |
|
** |
|
** <li>[[SQLITE_FCNTL_VFS_POINTER]] |
|
** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level |
|
** [VFSes] currently in use. ^(The argument X in |
|
** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be |
|
** of type "[sqlite3_vfs] **". This opcodes will set *X |
|
** to a pointer to the top-level VFS.)^ |
|
** ^When there are multiple VFS shims in the stack, this opcode finds the |
|
** upper-most shim only. |
|
** |
|
** <li>[[SQLITE_FCNTL_PRAGMA]] |
|
** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] |
|
** file control is sent to the open [sqlite3_file] object corresponding |
|
** to the database file to which the pragma statement refers. ^The argument |
|
** to the [SQLITE_FCNTL_PRAGMA] file control is an array of |
|
** pointers to strings (char**) in which the second element of the array |
|
** is the name of the pragma and the third element is the argument to the |
|
** pragma or NULL if the pragma has no argument. ^The handler for an |
|
** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element |
|
** of the char** argument point to a string obtained from [sqlite3_mprintf()] |
|
** or the equivalent and that string will become the result of the pragma or |
|
** the error message if the pragma fails. ^If the |
|
** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal |
|
** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] |
|
** file control returns [SQLITE_OK], then the parser assumes that the |
|
** VFS has handled the PRAGMA itself and the parser generates a no-op |
|
** prepared statement if result string is NULL, or that returns a copy |
|
** of the result string if the string is non-NULL. |
|
** ^If the [SQLITE_FCNTL_PRAGMA] file control returns |
|
** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means |
|
** that the VFS encountered an error while handling the [PRAGMA] and the |
|
** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] |
|
** file control occurs at the beginning of pragma statement analysis and so |
|
** it is able to override built-in [PRAGMA] statements. |
|
** |
|
** <li>[[SQLITE_FCNTL_BUSYHANDLER]] |
|
** ^The [SQLITE_FCNTL_BUSYHANDLER] |
|
** file-control may be invoked by SQLite on the database file handle |
|
** shortly after it is opened in order to provide a custom VFS with access |
|
** to the connection's busy-handler callback. The argument is of type (void**) |
|
** - an array of two (void *) values. The first (void *) actually points |
|
** to a function of type (int (*)(void *)). In order to invoke the connection's |
|
** busy-handler, this function should be invoked with the second (void *) in |
|
** the array as the only argument. If it returns non-zero, then the operation |
|
** should be retried. If it returns zero, the custom VFS should abandon the |
|
** current operation. |
|
** |
|
** <li>[[SQLITE_FCNTL_TEMPFILENAME]] |
|
** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control |
|
** to have SQLite generate a |
|
** temporary filename using the same algorithm that is followed to generate |
|
** temporary filenames for TEMP tables and other internal uses. The |
|
** argument should be a char** which will be filled with the filename |
|
** written into memory obtained from [sqlite3_malloc()]. The caller should |
|
** invoke [sqlite3_free()] on the result to avoid a memory leak. |
|
** |
|
** <li>[[SQLITE_FCNTL_MMAP_SIZE]] |
|
** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the |
|
** maximum number of bytes that will be used for memory-mapped I/O. |
|
** The argument is a pointer to a value of type sqlite3_int64 that |
|
** is an advisory maximum number of bytes in the file to memory map. The |
|
** pointer is overwritten with the old value. The limit is not changed if |
|
** the value originally pointed to is negative, and so the current limit |
|
** can be queried by passing in a pointer to a negative number. This |
|
** file-control is used internally to implement [PRAGMA mmap_size]. |
|
** |
|
** <li>[[SQLITE_FCNTL_TRACE]] |
|
** The [SQLITE_FCNTL_TRACE] file control provides advisory information |
|
** to the VFS about what the higher layers of the SQLite stack are doing. |
|
** This file control is used by some VFS activity tracing [shims]. |
|
** The argument is a zero-terminated string. Higher layers in the |
|
** SQLite stack may generate instances of this file control if |
|
** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled. |
|
** |
|
** <li>[[SQLITE_FCNTL_HAS_MOVED]] |
|
** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a |
|
** pointer to an integer and it writes a boolean into that integer depending |
|
** on whether or not the file has been renamed, moved, or deleted since it |
|
** was first opened. |
|
** |
|
** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]] |
|
** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the |
|
** underlying native file handle associated with a file handle. This file |
|
** control interprets its argument as a pointer to a native file handle and |
|
** writes the resulting value there. |
|
** |
|
** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]] |
|
** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This |
|
** opcode causes the xFileControl method to swap the file handle with the one |
|
** pointed to by the pArg argument. This capability is used during testing |
|
** and only needs to be supported when SQLITE_TEST is defined. |
|
** |
|
** <li>[[SQLITE_FCNTL_WAL_BLOCK]] |
|
** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might |
|
** be advantageous to block on the next WAL lock if the lock is not immediately |
|
** available. The WAL subsystem issues this signal during rare |
|
** circumstances in order to fix a problem with priority inversion. |
|
** Applications should <em>not</em> use this file-control. |
|
** |
|
** <li>[[SQLITE_FCNTL_ZIPVFS]] |
|
** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other |
|
** VFS should return SQLITE_NOTFOUND for this opcode. |
|
** |
|
** <li>[[SQLITE_FCNTL_RBU]] |
|
** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by |
|
** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for |
|
** this opcode. |
|
** |
|
** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]] |
|
** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then |
|
** the file descriptor is placed in "batch write mode", which |
|
** means all subsequent write operations will be deferred and done |
|
** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems |
|
** that do not support batch atomic writes will return SQLITE_NOTFOUND. |
|
** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to |
|
** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or |
|
** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make |
|
** no VFS interface calls on the same [sqlite3_file] file descriptor |
|
** except for calls to the xWrite method and the xFileControl method |
|
** with [SQLITE_FCNTL_SIZE_HINT]. |
|
** |
|
** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]] |
|
** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write |
|
** operations since the previous successful call to |
|
** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically. |
|
** This file control returns [SQLITE_OK] if and only if the writes were |
|
** all performed successfully and have been committed to persistent storage. |
|
** ^Regardless of whether or not it is successful, this file control takes |
|
** the file descriptor out of batch write mode so that all subsequent |
|
** write operations are independent. |
|
** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without |
|
** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. |
|
** |
|
** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]] |
|
** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write |
|
** operations since the previous successful call to |
|
** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back. |
|
** ^This file control takes the file descriptor out of batch write mode |
|
** so that all subsequent write operations are independent. |
|
** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without |
|
** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. |
|
** |
|
** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]] |
|
** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode is used to configure a VFS |
|
** to block for up to M milliseconds before failing when attempting to |
|
** obtain a file lock using the xLock or xShmLock methods of the VFS. |
|
** The parameter is a pointer to a 32-bit signed integer that contains |
|
** the value that M is to be set to. Before returning, the 32-bit signed |
|
** integer is overwritten with the previous value of M. |
|
** |
|
** <li>[[SQLITE_FCNTL_DATA_VERSION]] |
|
** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to |
|
** a database file. The argument is a pointer to a 32-bit unsigned integer. |
|
** The "data version" for the pager is written into the pointer. The |
|
** "data version" changes whenever any change occurs to the corresponding |
|
** database file, either through SQL statements on the same database |
|
** connection or through transactions committed by separate database |
|
** connections possibly in other processes. The [sqlite3_total_changes()] |
|
** interface can be used to find if any database on the connection has changed, |
|
** but that interface responds to changes on TEMP as well as MAIN and does |
|
** not provide a mechanism to detect changes to MAIN only. Also, the |
|
** [sqlite3_total_changes()] interface responds to internal changes only and |
|
** omits changes made by other database connections. The |
|
** [PRAGMA data_version] command provides a mechanism to detect changes to |
|
** a single attached database that occur due to other database connections, |
|
** but omits changes implemented by the database connection on which it is |
|
** called. This file control is the only mechanism to detect changes that |
|
** happen either internally or externally and that are associated with |
|
** a particular attached database. |
|
** |
|
** <li>[[SQLITE_FCNTL_CKPT_START]] |
|
** The [SQLITE_FCNTL_CKPT_START] opcode is invoked from within a checkpoint |
|
** in wal mode before the client starts to copy pages from the wal |
|
** file to the database file. |
|
** |
|
** <li>[[SQLITE_FCNTL_CKPT_DONE]] |
|
** The [SQLITE_FCNTL_CKPT_DONE] opcode is invoked from within a checkpoint |
|
** in wal mode after the client has finished copying pages from the wal |
|
** file to the database file, but before the *-shm file is updated to |
|
** record the fact that the pages have been checkpointed. |
|
** </ul> |
*/ |
*/ |
#define SQLITE_FCNTL_LOCKSTATE 1 |
#define SQLITE_FCNTL_LOCKSTATE 1 |
#define SQLITE_GET_LOCKPROXYFILE 2 | #define SQLITE_FCNTL_GET_LOCKPROXYFILE 2 |
#define SQLITE_SET_LOCKPROXYFILE 3 | #define SQLITE_FCNTL_SET_LOCKPROXYFILE 3 |
#define SQLITE_LAST_ERRNO 4 | #define SQLITE_FCNTL_LAST_ERRNO 4 |
#define SQLITE_FCNTL_SIZE_HINT 5 |
#define SQLITE_FCNTL_SIZE_HINT 5 |
#define SQLITE_FCNTL_CHUNK_SIZE 6 |
#define SQLITE_FCNTL_CHUNK_SIZE 6 |
#define SQLITE_FCNTL_FILE_POINTER 7 |
#define SQLITE_FCNTL_FILE_POINTER 7 |
Line 815 struct sqlite3_io_methods {
|
Line 1141 struct sqlite3_io_methods {
|
#define SQLITE_FCNTL_OVERWRITE 11 |
#define SQLITE_FCNTL_OVERWRITE 11 |
#define SQLITE_FCNTL_VFSNAME 12 |
#define SQLITE_FCNTL_VFSNAME 12 |
#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 |
#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 |
|
#define SQLITE_FCNTL_PRAGMA 14 |
|
#define SQLITE_FCNTL_BUSYHANDLER 15 |
|
#define SQLITE_FCNTL_TEMPFILENAME 16 |
|
#define SQLITE_FCNTL_MMAP_SIZE 18 |
|
#define SQLITE_FCNTL_TRACE 19 |
|
#define SQLITE_FCNTL_HAS_MOVED 20 |
|
#define SQLITE_FCNTL_SYNC 21 |
|
#define SQLITE_FCNTL_COMMIT_PHASETWO 22 |
|
#define SQLITE_FCNTL_WIN32_SET_HANDLE 23 |
|
#define SQLITE_FCNTL_WAL_BLOCK 24 |
|
#define SQLITE_FCNTL_ZIPVFS 25 |
|
#define SQLITE_FCNTL_RBU 26 |
|
#define SQLITE_FCNTL_VFS_POINTER 27 |
|
#define SQLITE_FCNTL_JOURNAL_POINTER 28 |
|
#define SQLITE_FCNTL_WIN32_GET_HANDLE 29 |
|
#define SQLITE_FCNTL_PDB 30 |
|
#define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31 |
|
#define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32 |
|
#define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33 |
|
#define SQLITE_FCNTL_LOCK_TIMEOUT 34 |
|
#define SQLITE_FCNTL_DATA_VERSION 35 |
|
#define SQLITE_FCNTL_SIZE_LIMIT 36 |
|
#define SQLITE_FCNTL_CKPT_DONE 37 |
|
#define SQLITE_FCNTL_RESERVE_BYTES 38 |
|
#define SQLITE_FCNTL_CKPT_START 39 |
|
|
|
/* deprecated names */ |
|
#define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE |
|
#define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE |
|
#define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO |
|
|
|
|
/* |
/* |
** CAPI3REF: Mutex Handle |
** CAPI3REF: Mutex Handle |
** |
** |
Line 829 struct sqlite3_io_methods {
|
Line 1186 struct sqlite3_io_methods {
|
typedef struct sqlite3_mutex sqlite3_mutex; |
typedef struct sqlite3_mutex sqlite3_mutex; |
|
|
/* |
/* |
|
** CAPI3REF: Loadable Extension Thunk |
|
** |
|
** A pointer to the opaque sqlite3_api_routines structure is passed as |
|
** the third parameter to entry points of [loadable extensions]. This |
|
** structure must be typedefed in order to work around compiler warnings |
|
** on some platforms. |
|
*/ |
|
typedef struct sqlite3_api_routines sqlite3_api_routines; |
|
|
|
/* |
** CAPI3REF: OS Interface Object |
** CAPI3REF: OS Interface Object |
** |
** |
** An instance of the sqlite3_vfs object defines the interface between |
** An instance of the sqlite3_vfs object defines the interface between |
Line 836 typedef struct sqlite3_mutex sqlite3_mutex;
|
Line 1203 typedef struct sqlite3_mutex sqlite3_mutex;
|
** in the name of the object stands for "virtual file system". See |
** in the name of the object stands for "virtual file system". See |
** the [VFS | VFS documentation] for further information. |
** the [VFS | VFS documentation] for further information. |
** |
** |
** The value of the iVersion field is initially 1 but may be larger in | ** The VFS interface is sometimes extended by adding new methods onto |
** future versions of SQLite. Additional fields may be appended to this | ** the end. Each time such an extension occurs, the iVersion field |
** object when the iVersion value is increased. Note that the structure | ** is incremented. The iVersion value started out as 1 in |
** of the sqlite3_vfs object changes in the transaction between | ** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2 |
** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not | ** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased |
** modified. | ** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields |
| ** may be appended to the sqlite3_vfs object and the iVersion value |
| ** may increase again in future versions of SQLite. |
| ** Note that due to an oversight, the structure |
| ** of the sqlite3_vfs object changed in the transition from |
| ** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0] |
| ** and yet the iVersion field was not increased. |
** |
** |
** The szOsFile field is the size of the subclassed [sqlite3_file] |
** The szOsFile field is the size of the subclassed [sqlite3_file] |
** structure used by this VFS. mxPathname is the maximum length of |
** structure used by this VFS. mxPathname is the maximum length of |
Line 876 typedef struct sqlite3_mutex sqlite3_mutex;
|
Line 1249 typedef struct sqlite3_mutex sqlite3_mutex;
|
** the [sqlite3_file] can safely store a pointer to the |
** the [sqlite3_file] can safely store a pointer to the |
** filename if it needs to remember the filename for some reason. |
** filename if it needs to remember the filename for some reason. |
** If the zFilename parameter to xOpen is a NULL pointer then xOpen |
** If the zFilename parameter to xOpen is a NULL pointer then xOpen |
** must invent its own temporary name for the file. ^Whenever the | ** must invent its own temporary name for the file. ^Whenever the |
** xFilename parameter is NULL it will also be the case that the |
** xFilename parameter is NULL it will also be the case that the |
** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. |
** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. |
** |
** |
** The flags argument to xOpen() includes all bits set in |
** The flags argument to xOpen() includes all bits set in |
** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] |
** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] |
** or [sqlite3_open16()] is used, then flags includes at least |
** or [sqlite3_open16()] is used, then flags includes at least |
** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. | ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. |
** If xOpen() opens a file read-only then it sets *pOutFlags to |
** If xOpen() opens a file read-only then it sets *pOutFlags to |
** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. |
** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. |
** |
** |
Line 897 typedef struct sqlite3_mutex sqlite3_mutex;
|
Line 1270 typedef struct sqlite3_mutex sqlite3_mutex;
|
** <li> [SQLITE_OPEN_TEMP_JOURNAL] |
** <li> [SQLITE_OPEN_TEMP_JOURNAL] |
** <li> [SQLITE_OPEN_TRANSIENT_DB] |
** <li> [SQLITE_OPEN_TRANSIENT_DB] |
** <li> [SQLITE_OPEN_SUBJOURNAL] |
** <li> [SQLITE_OPEN_SUBJOURNAL] |
** <li> [SQLITE_OPEN_MASTER_JOURNAL] | ** <li> [SQLITE_OPEN_SUPER_JOURNAL] |
** <li> [SQLITE_OPEN_WAL] |
** <li> [SQLITE_OPEN_WAL] |
** </ul>)^ |
** </ul>)^ |
** |
** |
Line 925 typedef struct sqlite3_mutex sqlite3_mutex;
|
Line 1298 typedef struct sqlite3_mutex sqlite3_mutex;
|
** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction |
** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction |
** with the [SQLITE_OPEN_CREATE] flag, which are both directly |
** with the [SQLITE_OPEN_CREATE] flag, which are both directly |
** analogous to the O_EXCL and O_CREAT flags of the POSIX open() |
** analogous to the O_EXCL and O_CREAT flags of the POSIX open() |
** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the | ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the |
** SQLITE_OPEN_CREATE, is used to indicate that file should always |
** SQLITE_OPEN_CREATE, is used to indicate that file should always |
** be created, and that it is an error if it already exists. |
** be created, and that it is an error if it already exists. |
** It is <i>not</i> used to indicate the file should be opened | ** It is <i>not</i> used to indicate the file should be opened |
** for exclusive access. |
** for exclusive access. |
** |
** |
** ^At least szOsFile bytes of memory are allocated by SQLite |
** ^At least szOsFile bytes of memory are allocated by SQLite |
** to hold the [sqlite3_file] structure passed as the third | ** to hold the [sqlite3_file] structure passed as the third |
** argument to xOpen. The xOpen method does not have to |
** argument to xOpen. The xOpen method does not have to |
** allocate the structure; it should just fill it in. Note that |
** allocate the structure; it should just fill it in. Note that |
** the xOpen method must set the sqlite3_file.pMethods to either |
** the xOpen method must set the sqlite3_file.pMethods to either |
Line 945 typedef struct sqlite3_mutex sqlite3_mutex;
|
Line 1318 typedef struct sqlite3_mutex sqlite3_mutex;
|
** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] |
** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] |
** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to |
** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to |
** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] |
** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] |
** to test whether a file is at least readable. The file can be a | ** to test whether a file is at least readable. The SQLITE_ACCESS_READ |
** directory. | ** flag is never actually used and is not implemented in the built-in |
| ** VFSes of SQLite. The file is named by the second argument and can be a |
| ** directory. The xAccess method returns [SQLITE_OK] on success or some |
| ** non-zero error code if there is an I/O error or if the name of |
| ** the file given in the second argument is illegal. If SQLITE_OK |
| ** is returned, then non-zero or zero is written into *pResOut to indicate |
| ** whether or not the file is accessible. |
** |
** |
** ^SQLite will always allocate at least mxPathname+1 bytes for the |
** ^SQLite will always allocate at least mxPathname+1 bytes for the |
** output buffer xFullPathname. The exact size of the output buffer |
** output buffer xFullPathname. The exact size of the output buffer |
Line 966 typedef struct sqlite3_mutex sqlite3_mutex;
|
Line 1345 typedef struct sqlite3_mutex sqlite3_mutex;
|
** method returns a Julian Day Number for the current date and time as |
** method returns a Julian Day Number for the current date and time as |
** a floating point value. |
** a floating point value. |
** ^The xCurrentTimeInt64() method returns, as an integer, the Julian |
** ^The xCurrentTimeInt64() method returns, as an integer, the Julian |
** Day Number multiplied by 86400000 (the number of milliseconds in | ** Day Number multiplied by 86400000 (the number of milliseconds in |
** a 24-hour day). | ** a 24-hour day). |
** ^SQLite will use the xCurrentTimeInt64() method to get the current |
** ^SQLite will use the xCurrentTimeInt64() method to get the current |
** date and time if that method is available (if iVersion is 2 or | ** date and time if that method is available (if iVersion is 2 or |
** greater and the function pointer is not NULL) and will fall back |
** greater and the function pointer is not NULL) and will fall back |
** to xCurrentTime() if xCurrentTimeInt64() is unavailable. |
** to xCurrentTime() if xCurrentTimeInt64() is unavailable. |
** |
** |
** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces |
** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces |
** are not used by the SQLite core. These optional interfaces are provided |
** are not used by the SQLite core. These optional interfaces are provided |
** by some VFSes to facilitate testing of the VFS code. By overriding | ** by some VFSes to facilitate testing of the VFS code. By overriding |
** system calls with functions under its control, a test program can |
** system calls with functions under its control, a test program can |
** simulate faults and error conditions that would otherwise be difficult |
** simulate faults and error conditions that would otherwise be difficult |
** or impossible to induce. The set of system calls that can be overridden |
** or impossible to induce. The set of system calls that can be overridden |
Line 1021 struct sqlite3_vfs {
|
Line 1400 struct sqlite3_vfs {
|
const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); |
const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); |
/* |
/* |
** The methods above are in versions 1 through 3 of the sqlite_vfs object. |
** The methods above are in versions 1 through 3 of the sqlite_vfs object. |
** New fields may be appended in figure versions. The iVersion | ** New fields may be appended in future versions. The iVersion |
** value will increment whenever this happens. | ** value will increment whenever this happens. |
*/ |
*/ |
}; |
}; |
|
|
Line 1066 struct sqlite3_vfs {
|
Line 1445 struct sqlite3_vfs {
|
** </ul> |
** </ul> |
** |
** |
** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as |
** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as |
** was given no the corresponding lock. | ** was given on the corresponding lock. |
** |
** |
** The xShmLock method can transition between unlocked and SHARED or |
** The xShmLock method can transition between unlocked and SHARED or |
** between unlocked and EXCLUSIVE. It cannot transition between SHARED |
** between unlocked and EXCLUSIVE. It cannot transition between SHARED |
Line 1177 SQLITE_API int sqlite3_os_end(void);
|
Line 1556 SQLITE_API int sqlite3_os_end(void);
|
** applications and so this routine is usually not necessary. It is |
** applications and so this routine is usually not necessary. It is |
** provided to support rare applications with unusual needs. |
** provided to support rare applications with unusual needs. |
** |
** |
** The sqlite3_config() interface is not threadsafe. The application | ** <b>The sqlite3_config() interface is not threadsafe. The application |
** must insure that no other SQLite interfaces are invoked by other | ** must ensure that no other SQLite interfaces are invoked by other |
** threads while sqlite3_config() is running. Furthermore, sqlite3_config() | ** threads while sqlite3_config() is running.</b> |
| ** |
| ** The sqlite3_config() interface |
** may only be invoked prior to library initialization using |
** may only be invoked prior to library initialization using |
** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. |
** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. |
** ^If sqlite3_config() is called after [sqlite3_initialize()] and before |
** ^If sqlite3_config() is called after [sqlite3_initialize()] and before |
Line 1201 SQLITE_API int sqlite3_config(int, ...);
|
Line 1582 SQLITE_API int sqlite3_config(int, ...);
|
|
|
/* |
/* |
** CAPI3REF: Configure database connections |
** CAPI3REF: Configure database connections |
|
** METHOD: sqlite3 |
** |
** |
** The sqlite3_db_config() interface is used to make configuration |
** The sqlite3_db_config() interface is used to make configuration |
** changes to a [database connection]. The interface is similar to |
** changes to a [database connection]. The interface is similar to |
Line 1208 SQLITE_API int sqlite3_config(int, ...);
|
Line 1590 SQLITE_API int sqlite3_config(int, ...);
|
** [database connection] (specified in the first argument). |
** [database connection] (specified in the first argument). |
** |
** |
** The second argument to sqlite3_db_config(D,V,...) is the |
** The second argument to sqlite3_db_config(D,V,...) is the |
** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code | ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code |
** that indicates what aspect of the [database connection] is being configured. |
** that indicates what aspect of the [database connection] is being configured. |
** Subsequent arguments vary depending on the configuration verb. |
** Subsequent arguments vary depending on the configuration verb. |
** |
** |
Line 1226 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...
|
Line 1608 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...
|
** This object is used in only one place in the SQLite interface. |
** This object is used in only one place in the SQLite interface. |
** A pointer to an instance of this object is the argument to |
** A pointer to an instance of this object is the argument to |
** [sqlite3_config()] when the configuration option is |
** [sqlite3_config()] when the configuration option is |
** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. | ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. |
** By creating an instance of this object |
** By creating an instance of this object |
** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) |
** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) |
** during configuration, an application can specify an alternative |
** during configuration, an application can specify an alternative |
Line 1256 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...
|
Line 1638 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...
|
** allocators round up memory allocations at least to the next multiple |
** allocators round up memory allocations at least to the next multiple |
** of 8. Some allocators round up to a larger multiple or to a power of 2. |
** of 8. Some allocators round up to a larger multiple or to a power of 2. |
** Every memory allocation request coming in through [sqlite3_malloc()] |
** Every memory allocation request coming in through [sqlite3_malloc()] |
** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, | ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, |
** that causes the corresponding memory allocation to fail. |
** that causes the corresponding memory allocation to fail. |
** |
** |
** The xInit method initializes the memory allocator. (For example, | ** The xInit method initializes the memory allocator. For example, |
** it might allocate any require mutexes or initialize internal data | ** it might allocate any required mutexes or initialize internal data |
** structures. The xShutdown method is invoked (indirectly) by |
** structures. The xShutdown method is invoked (indirectly) by |
** [sqlite3_shutdown()] and should deallocate any resources acquired |
** [sqlite3_shutdown()] and should deallocate any resources acquired |
** by xInit. The pAppData pointer is used as the only parameter to |
** by xInit. The pAppData pointer is used as the only parameter to |
** xInit and xShutdown. |
** xInit and xShutdown. |
** |
** |
** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes | ** SQLite holds the [SQLITE_MUTEX_STATIC_MAIN] mutex when it invokes |
** the xInit method, so the xInit method need not be threadsafe. The |
** the xInit method, so the xInit method need not be threadsafe. The |
** xShutdown method is only called from [sqlite3_shutdown()] so it does |
** xShutdown method is only called from [sqlite3_shutdown()] so it does |
** not need to be threadsafe either. For all other methods, SQLite |
** not need to be threadsafe either. For all other methods, SQLite |
Line 1314 struct sqlite3_mem_methods {
|
Line 1696 struct sqlite3_mem_methods {
|
** by a single thread. ^If SQLite is compiled with |
** by a single thread. ^If SQLite is compiled with |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
** it is not possible to change the [threading mode] from its default |
** it is not possible to change the [threading mode] from its default |
** value of Single-thread and so [sqlite3_config()] will return | ** value of Single-thread and so [sqlite3_config()] will return |
** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD |
** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD |
** configuration option.</dd> |
** configuration option.</dd> |
** |
** |
Line 1349 struct sqlite3_mem_methods {
|
Line 1731 struct sqlite3_mem_methods {
|
** SQLITE_CONFIG_SERIALIZED configuration option.</dd> |
** SQLITE_CONFIG_SERIALIZED configuration option.</dd> |
** |
** |
** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> |
** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> |
** <dd> ^(This option takes a single argument which is a pointer to an | ** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is |
** instance of the [sqlite3_mem_methods] structure. The argument specifies | ** a pointer to an instance of the [sqlite3_mem_methods] structure. |
| ** The argument specifies |
** alternative low-level memory allocation routines to be used in place of |
** alternative low-level memory allocation routines to be used in place of |
** the memory allocation routines built into SQLite.)^ ^SQLite makes |
** the memory allocation routines built into SQLite.)^ ^SQLite makes |
** its own private copy of the content of the [sqlite3_mem_methods] structure |
** its own private copy of the content of the [sqlite3_mem_methods] structure |
** before the [sqlite3_config()] call returns.</dd> |
** before the [sqlite3_config()] call returns.</dd> |
** |
** |
** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> |
** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> |
** <dd> ^(This option takes a single argument which is a pointer to an | ** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which |
** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] | ** is a pointer to an instance of the [sqlite3_mem_methods] structure. |
| ** The [sqlite3_mem_methods] |
** structure is filled with the currently defined memory allocation routines.)^ |
** structure is filled with the currently defined memory allocation routines.)^ |
** This option can be used to overload the default memory allocation |
** This option can be used to overload the default memory allocation |
** routines with a wrapper that simulations memory allocation failure or |
** routines with a wrapper that simulations memory allocation failure or |
** tracks memory usage, for example. </dd> |
** tracks memory usage, for example. </dd> |
** |
** |
|
** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt> |
|
** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of |
|
** type int, interpreted as a boolean, which if true provides a hint to |
|
** SQLite that it should avoid large memory allocations if possible. |
|
** SQLite will run faster if it is free to make large memory allocations, |
|
** but some application might prefer to run slower in exchange for |
|
** guarantees about memory fragmentation that are possible if large |
|
** allocations are avoided. This hint is normally off. |
|
** </dd> |
|
** |
** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> |
** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> |
** <dd> ^This option takes single argument of type int, interpreted as a | ** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int, |
** boolean, which enables or disables the collection of memory allocation | ** interpreted as a boolean, which enables or disables the collection of |
** statistics. ^(When memory allocation statistics are disabled, the | ** memory allocation statistics. ^(When memory allocation statistics are |
** following SQLite interfaces become non-operational: | ** disabled, the following SQLite interfaces become non-operational: |
** <ul> |
** <ul> |
|
** <li> [sqlite3_hard_heap_limit64()] |
** <li> [sqlite3_memory_used()] |
** <li> [sqlite3_memory_used()] |
** <li> [sqlite3_memory_highwater()] |
** <li> [sqlite3_memory_highwater()] |
** <li> [sqlite3_soft_heap_limit64()] |
** <li> [sqlite3_soft_heap_limit64()] |
** <li> [sqlite3_status()] | ** <li> [sqlite3_status64()] |
** </ul>)^ |
** </ul>)^ |
** ^Memory allocation statistics are enabled by default unless SQLite is |
** ^Memory allocation statistics are enabled by default unless SQLite is |
** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory |
** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory |
Line 1381 struct sqlite3_mem_methods {
|
Line 1776 struct sqlite3_mem_methods {
|
** </dd> |
** </dd> |
** |
** |
** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> |
** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> |
** <dd> ^This option specifies a static memory buffer that SQLite can use for | ** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used. |
** scratch memory. There are three arguments: A pointer an 8-byte | ** </dd> |
** aligned memory buffer from which the scratch allocations will be | |
** drawn, the size of each scratch allocation (sz), | |
** and the maximum number of scratch allocations (N). The sz | |
** argument must be a multiple of 16. | |
** The first argument must be a pointer to an 8-byte aligned buffer | |
** of at least sz*N bytes of memory. | |
** ^SQLite will use no more than two scratch buffers per thread. So | |
** N should be set to twice the expected maximum number of threads. | |
** ^SQLite will never require a scratch buffer that is more than 6 | |
** times the database page size. ^If SQLite needs needs additional | |
** scratch memory beyond what is provided by this configuration option, then | |
** [sqlite3_malloc()] will be used to obtain the memory needed.</dd> | |
** |
** |
** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> |
** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> |
** <dd> ^This option specifies a static memory buffer that SQLite can use for | ** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool |
** the database page cache with the default page cache implementation. | ** that SQLite can use for the database page cache with the default page |
** This configuration should not be used if an application-define page | ** cache implementation. |
** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option. | ** This configuration option is a no-op if an application-defined page |
** There are three arguments to this option: A pointer to 8-byte aligned | ** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2]. |
** memory, the size of each page buffer (sz), and the number of pages (N). | ** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to |
| ** 8-byte aligned memory (pMem), the size of each page cache line (sz), |
| ** and the number of cache lines (N). |
** The sz argument should be the size of the largest database page |
** The sz argument should be the size of the largest database page |
** (a power of two between 512 and 32768) plus a little extra for each | ** (a power of two between 512 and 65536) plus some extra bytes for each |
** page header. ^The page header size is 20 to 40 bytes depending on | ** page header. ^The number of extra bytes needed by the page header |
** the host architecture. ^It is harmless, apart from the wasted memory, | ** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ]. |
** to make sz a little too large. The first | ** ^It is harmless, apart from the wasted memory, |
** argument should point to an allocation of at least sz*N bytes of memory. | ** for the sz parameter to be larger than necessary. The pMem |
** ^SQLite will use the memory provided by the first argument to satisfy its | ** argument must be either a NULL pointer or a pointer to an 8-byte |
** memory needs for the first N pages that it adds to cache. ^If additional | ** aligned block of memory of at least sz*N bytes, otherwise |
** page cache memory is needed beyond what is provided by this option, then | ** subsequent behavior is undefined. |
** SQLite goes to [sqlite3_malloc()] for the additional storage space. | ** ^When pMem is not NULL, SQLite will strive to use the memory provided |
** The pointer in the first argument must | ** to satisfy page cache needs, falling back to [sqlite3_malloc()] if |
** be aligned to an 8-byte boundary or subsequent behavior of SQLite | ** a page cache line is larger than sz bytes or if all of the pMem buffer |
** will be undefined.</dd> | ** is exhausted. |
| ** ^If pMem is NULL and N is non-zero, then each database connection |
| ** does an initial bulk allocation for page cache memory |
| ** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or |
| ** of -1024*N bytes if N is negative, . ^If additional |
| ** page cache memory is needed beyond what is provided by the initial |
| ** allocation, then SQLite goes to [sqlite3_malloc()] separately for each |
| ** additional cache line. </dd> |
** |
** |
** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> |
** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> |
** <dd> ^This option specifies a static memory buffer that SQLite will use | ** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer |
** for all of its dynamic memory allocation needs beyond those provided | ** that SQLite will use for all of its dynamic memory allocation needs |
** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. | ** beyond those provided for by [SQLITE_CONFIG_PAGECACHE]. |
** There are three arguments: An 8-byte aligned pointer to the memory, | ** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled |
| ** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns |
| ** [SQLITE_ERROR] if invoked otherwise. |
| ** ^There are three arguments to SQLITE_CONFIG_HEAP: |
| ** An 8-byte aligned pointer to the memory, |
** the number of bytes in the memory buffer, and the minimum allocation size. |
** the number of bytes in the memory buffer, and the minimum allocation size. |
** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts |
** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts |
** to using its default memory allocator (the system malloc() implementation), |
** to using its default memory allocator (the system malloc() implementation), |
** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the |
** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the |
** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or | ** memory pointer is not NULL then the alternative memory |
** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory | |
** allocator is engaged to handle all of SQLites memory allocation needs. |
** allocator is engaged to handle all of SQLites memory allocation needs. |
** The first pointer (the memory pointer) must be aligned to an 8-byte |
** The first pointer (the memory pointer) must be aligned to an 8-byte |
** boundary or subsequent behavior of SQLite will be undefined. |
** boundary or subsequent behavior of SQLite will be undefined. |
Line 1435 struct sqlite3_mem_methods {
|
Line 1830 struct sqlite3_mem_methods {
|
** for the minimum allocation size are 2**5 through 2**8.</dd> |
** for the minimum allocation size are 2**5 through 2**8.</dd> |
** |
** |
** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> |
** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> |
** <dd> ^(This option takes a single argument which is a pointer to an | ** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a |
** instance of the [sqlite3_mutex_methods] structure. The argument specifies | ** pointer to an instance of the [sqlite3_mutex_methods] structure. |
** alternative low-level mutex routines to be used in place | ** The argument specifies alternative low-level mutex routines to be used |
** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the | ** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of |
** content of the [sqlite3_mutex_methods] structure before the call to | ** the content of the [sqlite3_mutex_methods] structure before the call to |
** [sqlite3_config()] returns. ^If SQLite is compiled with |
** [sqlite3_config()] returns. ^If SQLite is compiled with |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
** the entire mutexing subsystem is omitted from the build and hence calls to |
** the entire mutexing subsystem is omitted from the build and hence calls to |
Line 1447 struct sqlite3_mem_methods {
|
Line 1842 struct sqlite3_mem_methods {
|
** return [SQLITE_ERROR].</dd> |
** return [SQLITE_ERROR].</dd> |
** |
** |
** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> |
** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> |
** <dd> ^(This option takes a single argument which is a pointer to an | ** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which |
** instance of the [sqlite3_mutex_methods] structure. The | ** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The |
** [sqlite3_mutex_methods] |
** [sqlite3_mutex_methods] |
** structure is filled with the currently defined mutex routines.)^ |
** structure is filled with the currently defined mutex routines.)^ |
** This option can be used to overload the default mutex allocation |
** This option can be used to overload the default mutex allocation |
Line 1460 struct sqlite3_mem_methods {
|
Line 1855 struct sqlite3_mem_methods {
|
** return [SQLITE_ERROR].</dd> |
** return [SQLITE_ERROR].</dd> |
** |
** |
** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> |
** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> |
** <dd> ^(This option takes two arguments that determine the default | ** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine |
** memory allocation for the lookaside memory allocator on each | ** the default size of lookaside memory on each [database connection]. |
** [database connection]. The first argument is the | ** The first argument is the |
** size of each lookaside buffer slot and the second is the number of |
** size of each lookaside buffer slot and the second is the number of |
** slots allocated to each database connection.)^ ^(This option sets the | ** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE |
** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] | ** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] |
** verb to [sqlite3_db_config()] can be used to change the lookaside | ** option to [sqlite3_db_config()] can be used to change the lookaside |
** configuration on individual connections.)^ </dd> |
** configuration on individual connections.)^ </dd> |
** |
** |
** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> |
** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> |
** <dd> ^(This option takes a single argument which is a pointer to | ** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is |
** an [sqlite3_pcache_methods2] object. This object specifies the interface | ** a pointer to an [sqlite3_pcache_methods2] object. This object specifies |
** to a custom page cache implementation.)^ ^SQLite makes a copy of the | ** the interface to a custom page cache implementation.)^ |
** object and uses it for page cache memory allocations.</dd> | ** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd> |
** |
** |
** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> |
** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> |
** <dd> ^(This option takes a single argument which is a pointer to an | ** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which |
** [sqlite3_pcache_methods2] object. SQLite copies of the current | ** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of |
** page cache implementation into that object.)^ </dd> | ** the current page cache implementation into that object.)^ </dd> |
** |
** |
** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> |
** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> |
** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a | ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite |
** function with a call signature of void(*)(void*,int,const char*), | ** global [error log]. |
| ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a |
| ** function with a call signature of void(*)(void*,int,const char*), |
** and a pointer to void. ^If the function pointer is not NULL, it is |
** and a pointer to void. ^If the function pointer is not NULL, it is |
** invoked by [sqlite3_log()] to process each logging event. ^If the |
** invoked by [sqlite3_log()] to process each logging event. ^If the |
** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. |
** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. |
Line 1499 struct sqlite3_mem_methods {
|
Line 1896 struct sqlite3_mem_methods {
|
** function must be threadsafe. </dd> |
** function must be threadsafe. </dd> |
** |
** |
** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI |
** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI |
** <dd> This option takes a single argument of type int. If non-zero, then | ** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int. |
** URI handling is globally enabled. If the parameter is zero, then URI handling | ** If non-zero, then URI handling is globally enabled. If the parameter is zero, |
** is globally disabled. If URI handling is globally enabled, all filenames | ** then URI handling is globally disabled.)^ ^If URI handling is globally |
** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or | ** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()], |
| ** [sqlite3_open16()] or |
** specified as part of [ATTACH] commands are interpreted as URIs, regardless |
** specified as part of [ATTACH] commands are interpreted as URIs, regardless |
** of whether or not the [SQLITE_OPEN_URI] flag is set when the database |
** of whether or not the [SQLITE_OPEN_URI] flag is set when the database |
** connection is opened. If it is globally disabled, filenames are | ** connection is opened. ^If it is globally disabled, filenames are |
** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the |
** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the |
** database connection is opened. By default, URI handling is globally | ** database connection is opened. ^(By default, URI handling is globally |
** disabled. The default value may be changed by compiling with the |
** disabled. The default value may be changed by compiling with the |
** [SQLITE_USE_URI] symbol defined. | ** [SQLITE_USE_URI] symbol defined.)^ |
** |
** |
|
** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN |
|
** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer |
|
** argument which is interpreted as a boolean in order to enable or disable |
|
** the use of covering indices for full table scans in the query optimizer. |
|
** ^The default setting is determined |
|
** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on" |
|
** if that compile-time option is omitted. |
|
** The ability to disable the use of covering indices for full table scans |
|
** is because some incorrectly coded legacy applications might malfunction |
|
** when the optimization is enabled. Providing the ability to |
|
** disable the optimization allows the older, buggy application code to work |
|
** without change even with newer versions of SQLite. |
|
** |
** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] |
** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] |
** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFNIG_GETPCACHE | ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE |
** <dd> These options are obsolete and should not be used by new code. |
** <dd> These options are obsolete and should not be used by new code. |
** They are retained for backwards compatibility but are now no-ops. |
** They are retained for backwards compatibility but are now no-ops. |
|
** </dd> |
|
** |
|
** [[SQLITE_CONFIG_SQLLOG]] |
|
** <dt>SQLITE_CONFIG_SQLLOG |
|
** <dd>This option is only available if sqlite is compiled with the |
|
** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should |
|
** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int). |
|
** The second should be of type (void*). The callback is invoked by the library |
|
** in three separate circumstances, identified by the value passed as the |
|
** fourth parameter. If the fourth parameter is 0, then the database connection |
|
** passed as the second argument has just been opened. The third argument |
|
** points to a buffer containing the name of the main database file. If the |
|
** fourth parameter is 1, then the SQL statement that the third parameter |
|
** points to has just been executed. Or, if the fourth parameter is 2, then |
|
** the connection being passed as the second parameter is being closed. The |
|
** third parameter is passed NULL In this case. An example of using this |
|
** configuration option can be seen in the "test_sqllog.c" source file in |
|
** the canonical SQLite source tree.</dd> |
|
** |
|
** [[SQLITE_CONFIG_MMAP_SIZE]] |
|
** <dt>SQLITE_CONFIG_MMAP_SIZE |
|
** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values |
|
** that are the default mmap size limit (the default setting for |
|
** [PRAGMA mmap_size]) and the maximum allowed mmap size limit. |
|
** ^The default setting can be overridden by each database connection using |
|
** either the [PRAGMA mmap_size] command, or by using the |
|
** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size |
|
** will be silently truncated if necessary so that it does not exceed the |
|
** compile-time maximum mmap size set by the |
|
** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^ |
|
** ^If either argument to this option is negative, then that argument is |
|
** changed to its compile-time default. |
|
** |
|
** [[SQLITE_CONFIG_WIN32_HEAPSIZE]] |
|
** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE |
|
** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is |
|
** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro |
|
** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value |
|
** that specifies the maximum size of the created heap. |
|
** |
|
** [[SQLITE_CONFIG_PCACHE_HDRSZ]] |
|
** <dt>SQLITE_CONFIG_PCACHE_HDRSZ |
|
** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which |
|
** is a pointer to an integer and writes into that integer the number of extra |
|
** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE]. |
|
** The amount of extra space required can change depending on the compiler, |
|
** target platform, and SQLite version. |
|
** |
|
** [[SQLITE_CONFIG_PMASZ]] |
|
** <dt>SQLITE_CONFIG_PMASZ |
|
** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which |
|
** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded |
|
** sorter to that integer. The default minimum PMA Size is set by the |
|
** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched |
|
** to help with sort operations when multithreaded sorting |
|
** is enabled (using the [PRAGMA threads] command) and the amount of content |
|
** to be sorted exceeds the page size times the minimum of the |
|
** [PRAGMA cache_size] setting and this value. |
|
** |
|
** [[SQLITE_CONFIG_STMTJRNL_SPILL]] |
|
** <dt>SQLITE_CONFIG_STMTJRNL_SPILL |
|
** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which |
|
** becomes the [statement journal] spill-to-disk threshold. |
|
** [Statement journals] are held in memory until their size (in bytes) |
|
** exceeds this threshold, at which point they are written to disk. |
|
** Or if the threshold is -1, statement journals are always held |
|
** exclusively in memory. |
|
** Since many statement journals never become large, setting the spill |
|
** threshold to a value such as 64KiB can greatly reduce the amount of |
|
** I/O required to support statement rollback. |
|
** The default value for this setting is controlled by the |
|
** [SQLITE_STMTJRNL_SPILL] compile-time option. |
|
** |
|
** [[SQLITE_CONFIG_SORTERREF_SIZE]] |
|
** <dt>SQLITE_CONFIG_SORTERREF_SIZE |
|
** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter |
|
** of type (int) - the new value of the sorter-reference size threshold. |
|
** Usually, when SQLite uses an external sort to order records according |
|
** to an ORDER BY clause, all fields required by the caller are present in the |
|
** sorted records. However, if SQLite determines based on the declared type |
|
** of a table column that its values are likely to be very large - larger |
|
** than the configured sorter-reference size threshold - then a reference |
|
** is stored in each sorted record and the required column values loaded |
|
** from the database as records are returned in sorted order. The default |
|
** value for this option is to never use this optimization. Specifying a |
|
** negative value for this option restores the default behaviour. |
|
** This option is only available if SQLite is compiled with the |
|
** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option. |
|
** |
|
** [[SQLITE_CONFIG_MEMDB_MAXSIZE]] |
|
** <dt>SQLITE_CONFIG_MEMDB_MAXSIZE |
|
** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter |
|
** [sqlite3_int64] parameter which is the default maximum size for an in-memory |
|
** database created using [sqlite3_deserialize()]. This default maximum |
|
** size can be adjusted up or down for individual databases using the |
|
** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control|file-control]. If this |
|
** configuration setting is never used, then the default maximum is determined |
|
** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that |
|
** compile-time option is not set, then the default maximum is 1073741824. |
** </dl> |
** </dl> |
*/ |
*/ |
#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ |
#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ |
Line 1522 struct sqlite3_mem_methods {
|
Line 2032 struct sqlite3_mem_methods {
|
#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ |
#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ |
#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ |
#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ |
#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ |
#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ |
#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ | #define SQLITE_CONFIG_SCRATCH 6 /* No longer used */ |
#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ |
#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ |
#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ |
#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ |
#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ |
#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ |
#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ |
#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ |
#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ |
#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ |
/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ | /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ |
#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ |
#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ |
#define SQLITE_CONFIG_PCACHE 14 /* no-op */ |
#define SQLITE_CONFIG_PCACHE 14 /* no-op */ |
#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ |
#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ |
Line 1536 struct sqlite3_mem_methods {
|
Line 2046 struct sqlite3_mem_methods {
|
#define SQLITE_CONFIG_URI 17 /* int */ |
#define SQLITE_CONFIG_URI 17 /* int */ |
#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ |
#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ |
#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ |
#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ |
|
#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */ |
|
#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */ |
|
#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */ |
|
#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */ |
|
#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */ |
|
#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */ |
|
#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */ |
|
#define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */ |
|
#define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */ |
|
#define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */ |
|
|
/* |
/* |
** CAPI3REF: Database Connection Configuration Options |
** CAPI3REF: Database Connection Configuration Options |
Line 1551 struct sqlite3_mem_methods {
|
Line 2071 struct sqlite3_mem_methods {
|
** is invoked. |
** is invoked. |
** |
** |
** <dl> |
** <dl> |
|
** [[SQLITE_DBCONFIG_LOOKASIDE]] |
** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> |
** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> |
** <dd> ^This option takes three additional arguments that determine the | ** <dd> ^This option takes three additional arguments that determine the |
** [lookaside memory allocator] configuration for the [database connection]. |
** [lookaside memory allocator] configuration for the [database connection]. |
** ^The first argument (the third parameter to [sqlite3_db_config()] is a |
** ^The first argument (the third parameter to [sqlite3_db_config()] is a |
** pointer to a memory buffer to use for lookaside memory. |
** pointer to a memory buffer to use for lookaside memory. |
Line 1570 struct sqlite3_mem_methods {
|
Line 2091 struct sqlite3_mem_methods {
|
** when the "current value" returned by |
** when the "current value" returned by |
** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. |
** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. |
** Any attempt to change the lookaside memory configuration when lookaside |
** Any attempt to change the lookaside memory configuration when lookaside |
** memory is in use leaves the configuration unchanged and returns | ** memory is in use leaves the configuration unchanged and returns |
** [SQLITE_BUSY].)^</dd> |
** [SQLITE_BUSY].)^</dd> |
** |
** |
|
** [[SQLITE_DBCONFIG_ENABLE_FKEY]] |
** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> |
** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> |
** <dd> ^This option is used to enable or disable the enforcement of |
** <dd> ^This option is used to enable or disable the enforcement of |
** [foreign key constraints]. There should be two additional arguments. |
** [foreign key constraints]. There should be two additional arguments. |
Line 1583 struct sqlite3_mem_methods {
|
Line 2105 struct sqlite3_mem_methods {
|
** following this call. The second parameter may be a NULL pointer, in |
** following this call. The second parameter may be a NULL pointer, in |
** which case the FK enforcement setting is not reported back. </dd> |
** which case the FK enforcement setting is not reported back. </dd> |
** |
** |
|
** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]] |
** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> |
** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> |
** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. |
** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. |
** There should be two additional arguments. |
** There should be two additional arguments. |
Line 1593 struct sqlite3_mem_methods {
|
Line 2116 struct sqlite3_mem_methods {
|
** following this call. The second parameter may be a NULL pointer, in |
** following this call. The second parameter may be a NULL pointer, in |
** which case the trigger setting is not reported back. </dd> |
** which case the trigger setting is not reported back. </dd> |
** |
** |
|
** [[SQLITE_DBCONFIG_ENABLE_VIEW]] |
|
** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt> |
|
** <dd> ^This option is used to enable or disable [CREATE VIEW | views]. |
|
** There should be two additional arguments. |
|
** The first argument is an integer which is 0 to disable views, |
|
** positive to enable views or negative to leave the setting unchanged. |
|
** The second parameter is a pointer to an integer into which |
|
** is written 0 or 1 to indicate whether views are disabled or enabled |
|
** following this call. The second parameter may be a NULL pointer, in |
|
** which case the view setting is not reported back. </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]] |
|
** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt> |
|
** <dd> ^This option is used to enable or disable the |
|
** [fts3_tokenizer()] function which is part of the |
|
** [FTS3] full-text search engine extension. |
|
** There should be two additional arguments. |
|
** The first argument is an integer which is 0 to disable fts3_tokenizer() or |
|
** positive to enable fts3_tokenizer() or negative to leave the setting |
|
** unchanged. |
|
** The second parameter is a pointer to an integer into which |
|
** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled |
|
** following this call. The second parameter may be a NULL pointer, in |
|
** which case the new setting is not reported back. </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]] |
|
** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt> |
|
** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()] |
|
** interface independently of the [load_extension()] SQL function. |
|
** The [sqlite3_enable_load_extension()] API enables or disables both the |
|
** C-API [sqlite3_load_extension()] and the SQL function [load_extension()]. |
|
** There should be two additional arguments. |
|
** When the first argument to this interface is 1, then only the C-API is |
|
** enabled and the SQL function remains disabled. If the first argument to |
|
** this interface is 0, then both the C-API and the SQL function are disabled. |
|
** If the first argument is -1, then no changes are made to state of either the |
|
** C-API or the SQL function. |
|
** The second parameter is a pointer to an integer into which |
|
** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface |
|
** is disabled or enabled following this call. The second parameter may |
|
** be a NULL pointer, in which case the new setting is not reported back. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt> |
|
** <dd> ^This option is used to change the name of the "main" database |
|
** schema. ^The sole argument is a pointer to a constant UTF8 string |
|
** which will become the new schema name in place of "main". ^SQLite |
|
** does not make a copy of the new main schema name string, so the application |
|
** must ensure that the argument passed into this DBCONFIG option is unchanged |
|
** until after the database connection closes. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]] |
|
** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt> |
|
** <dd> Usually, when a database in wal mode is closed or detached from a |
|
** database handle, SQLite checks if this will mean that there are now no |
|
** connections at all to the database. If so, it performs a checkpoint |
|
** operation before closing the connection. This option may be used to |
|
** override this behaviour. The first parameter passed to this operation |
|
** is an integer - positive to disable checkpoints-on-close, or zero (the |
|
** default) to enable them, and negative to leave the setting unchanged. |
|
** The second parameter is a pointer to an integer |
|
** into which is written 0 or 1 to indicate whether checkpoints-on-close |
|
** have been disabled - 0 if they are not disabled, 1 if they are. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_ENABLE_QPSG]] <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt> |
|
** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates |
|
** the [query planner stability guarantee] (QPSG). When the QPSG is active, |
|
** a single SQL query statement will always use the same algorithm regardless |
|
** of values of [bound parameters].)^ The QPSG disables some query optimizations |
|
** that look at the values of bound parameters, which can make some queries |
|
** slower. But the QPSG has the advantage of more predictable behavior. With |
|
** the QPSG active, SQLite will always use the same query plan in the field as |
|
** was used during testing in the lab. |
|
** The first argument to this setting is an integer which is 0 to disable |
|
** the QPSG, positive to enable QPSG, or negative to leave the setting |
|
** unchanged. The second parameter is a pointer to an integer into which |
|
** is written 0 or 1 to indicate whether the QPSG is disabled or enabled |
|
** following this call. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt> |
|
** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not |
|
** include output for any operations performed by trigger programs. This |
|
** option is used to set or clear (the default) a flag that governs this |
|
** behavior. The first parameter passed to this operation is an integer - |
|
** positive to enable output for trigger programs, or zero to disable it, |
|
** or negative to leave the setting unchanged. |
|
** The second parameter is a pointer to an integer into which is written |
|
** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if |
|
** it is not disabled, 1 if it is. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt> |
|
** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run |
|
** [VACUUM] in order to reset a database back to an empty database |
|
** with no schema and no content. The following process works even for |
|
** a badly corrupted database file: |
|
** <ol> |
|
** <li> If the database connection is newly opened, make sure it has read the |
|
** database schema by preparing then discarding some query against the |
|
** database, or calling sqlite3_table_column_metadata(), ignoring any |
|
** errors. This step is only necessary if the application desires to keep |
|
** the database in WAL mode after the reset if it was in WAL mode before |
|
** the reset. |
|
** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0); |
|
** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0); |
|
** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0); |
|
** </ol> |
|
** Because resetting a database is destructive and irreversible, the |
|
** process requires the use of this obscure API and multiple steps to help |
|
** ensure that it does not happen by accident. |
|
** |
|
** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt> |
|
** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the |
|
** "defensive" flag for a database connection. When the defensive |
|
** flag is enabled, language features that allow ordinary SQL to |
|
** deliberately corrupt the database file are disabled. The disabled |
|
** features include but are not limited to the following: |
|
** <ul> |
|
** <li> The [PRAGMA writable_schema=ON] statement. |
|
** <li> The [PRAGMA journal_mode=OFF] statement. |
|
** <li> Writes to the [sqlite_dbpage] virtual table. |
|
** <li> Direct writes to [shadow tables]. |
|
** </ul> |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]] <dt>SQLITE_DBCONFIG_WRITABLE_SCHEMA</dt> |
|
** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the |
|
** "writable_schema" flag. This has the same effect and is logically equivalent |
|
** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF]. |
|
** The first argument to this setting is an integer which is 0 to disable |
|
** the writable_schema, positive to enable writable_schema, or negative to |
|
** leave the setting unchanged. The second parameter is a pointer to an |
|
** integer into which is written 0 or 1 to indicate whether the writable_schema |
|
** is enabled or disabled following this call. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]] |
|
** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt> |
|
** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates |
|
** the legacy behavior of the [ALTER TABLE RENAME] command such it |
|
** behaves as it did prior to [version 3.24.0] (2018-06-04). See the |
|
** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for |
|
** additional information. This feature can also be turned on and off |
|
** using the [PRAGMA legacy_alter_table] statement. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_DQS_DML]] |
|
** <dt>SQLITE_DBCONFIG_DQS_DML</td> |
|
** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates |
|
** the legacy [double-quoted string literal] misfeature for DML statements |
|
** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The |
|
** default value of this setting is determined by the [-DSQLITE_DQS] |
|
** compile-time option. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_DQS_DDL]] |
|
** <dt>SQLITE_DBCONFIG_DQS_DDL</td> |
|
** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates |
|
** the legacy [double-quoted string literal] misfeature for DDL statements, |
|
** such as CREATE TABLE and CREATE INDEX. The |
|
** default value of this setting is determined by the [-DSQLITE_DQS] |
|
** compile-time option. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]] |
|
** <dt>SQLITE_DBCONFIG_TRUSTED_SCHEMA</td> |
|
** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to |
|
** assume that database schemas are untainted by malicious content. |
|
** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite |
|
** takes additional defensive steps to protect the application from harm |
|
** including: |
|
** <ul> |
|
** <li> Prohibit the use of SQL functions inside triggers, views, |
|
** CHECK constraints, DEFAULT clauses, expression indexes, |
|
** partial indexes, or generated columns |
|
** unless those functions are tagged with [SQLITE_INNOCUOUS]. |
|
** <li> Prohibit the use of virtual tables inside of triggers or views |
|
** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS]. |
|
** </ul> |
|
** This setting defaults to "on" for legacy compatibility, however |
|
** all applications are advised to turn it off if possible. This setting |
|
** can also be controlled using the [PRAGMA trusted_schema] statement. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]] |
|
** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</td> |
|
** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates |
|
** the legacy file format flag. When activated, this flag causes all newly |
|
** created database file to have a schema format version number (the 4-byte |
|
** integer found at offset 44 into the database header) of 1. This in turn |
|
** means that the resulting database file will be readable and writable by |
|
** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting, |
|
** newly created databases are generally not understandable by SQLite versions |
|
** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there |
|
** is now scarcely any need to generated database files that are compatible |
|
** all the way back to version 3.0.0, and so this setting is of little |
|
** practical use, but is provided so that SQLite can continue to claim the |
|
** ability to generate new database files that are compatible with version |
|
** 3.0.0. |
|
** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on, |
|
** the [VACUUM] command will fail with an obscure error when attempting to |
|
** process a table with generated columns and a descending index. This is |
|
** not considered a bug since SQLite versions 3.3.0 and earlier do not support |
|
** either generated columns or decending indexes. |
|
** </dd> |
** </dl> |
** </dl> |
*/ |
*/ |
#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ | #define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */ |
#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ | #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ |
#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ | #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ |
| #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ |
| #define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */ |
| #define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */ |
| #define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */ |
| #define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */ |
| #define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */ |
| #define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */ |
| #define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */ |
| #define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */ |
| #define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */ |
| #define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */ |
| #define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */ |
| #define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */ |
| #define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */ |
| #define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */ |
| #define SQLITE_DBCONFIG_MAX 1017 /* Largest DBCONFIG */ |
|
|
|
|
/* |
/* |
** CAPI3REF: Enable Or Disable Extended Result Codes |
** CAPI3REF: Enable Or Disable Extended Result Codes |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_extended_result_codes() routine enables or disables the |
** ^The sqlite3_extended_result_codes() routine enables or disables the |
** [extended result codes] feature of SQLite. ^The extended result |
** [extended result codes] feature of SQLite. ^The extended result |
Line 1611 SQLITE_API int sqlite3_extended_result_codes(sqlite3*,
|
Line 2358 SQLITE_API int sqlite3_extended_result_codes(sqlite3*,
|
|
|
/* |
/* |
** CAPI3REF: Last Insert Rowid |
** CAPI3REF: Last Insert Rowid |
|
** METHOD: sqlite3 |
** |
** |
** ^Each entry in an SQLite table has a unique 64-bit signed | ** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables) |
| ** has a unique 64-bit signed |
** integer key called the [ROWID | "rowid"]. ^The rowid is always available |
** integer key called the [ROWID | "rowid"]. ^The rowid is always available |
** as an undeclared column named ROWID, OID, or _ROWID_ as long as those |
** as an undeclared column named ROWID, OID, or _ROWID_ as long as those |
** names are not also used by explicitly declared columns. ^If |
** names are not also used by explicitly declared columns. ^If |
** the table has a column of type [INTEGER PRIMARY KEY] then that column |
** the table has a column of type [INTEGER PRIMARY KEY] then that column |
** is another alias for the rowid. |
** is another alias for the rowid. |
** |
** |
** ^This routine returns the [rowid] of the most recent | ** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of |
** successful [INSERT] into the database from the [database connection] | ** the most recent successful [INSERT] into a rowid table or [virtual table] |
** in the first argument. ^As of SQLite version 3.7.7, this routines | ** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not |
** records the last insert rowid of both ordinary tables and [virtual tables]. | ** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred |
** ^If no successful [INSERT]s | ** on the database connection D, then sqlite3_last_insert_rowid(D) returns |
** have ever occurred on that database connection, zero is returned. | ** zero. |
** |
** |
** ^(If an [INSERT] occurs within a trigger or within a [virtual table] | ** As well as being set automatically as rows are inserted into database |
** method, then this routine will return the [rowid] of the inserted | ** tables, the value returned by this function may be set explicitly by |
** row as long as the trigger or virtual table method is running. | ** [sqlite3_set_last_insert_rowid()] |
** But once the trigger or virtual table method ends, the value returned | |
** by this routine reverts to what it was before the trigger or virtual | |
** table method began.)^ | |
** |
** |
|
** Some virtual table implementations may INSERT rows into rowid tables as |
|
** part of committing a transaction (e.g. to flush data accumulated in memory |
|
** to disk). In this case subsequent calls to this function return the rowid |
|
** associated with these internal INSERT operations, which leads to |
|
** unintuitive results. Virtual table implementations that do write to rowid |
|
** tables in this way can avoid this problem by restoring the original |
|
** rowid value using [sqlite3_set_last_insert_rowid()] before returning |
|
** control to the user. |
|
** |
|
** ^(If an [INSERT] occurs within a trigger then this routine will |
|
** return the [rowid] of the inserted row as long as the trigger is |
|
** running. Once the trigger program ends, the value returned |
|
** by this routine reverts to what it was before the trigger was fired.)^ |
|
** |
** ^An [INSERT] that fails due to a constraint violation is not a |
** ^An [INSERT] that fails due to a constraint violation is not a |
** successful [INSERT] and does not change the value returned by this |
** successful [INSERT] and does not change the value returned by this |
** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, |
** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, |
Line 1659 SQLITE_API int sqlite3_extended_result_codes(sqlite3*,
|
Line 2419 SQLITE_API int sqlite3_extended_result_codes(sqlite3*,
|
SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); |
SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); |
|
|
/* |
/* |
|
** CAPI3REF: Set the Last Insert Rowid value. |
|
** METHOD: sqlite3 |
|
** |
|
** The sqlite3_set_last_insert_rowid(D, R) method allows the application to |
|
** set the value returned by calling sqlite3_last_insert_rowid(D) to R |
|
** without inserting a row into the database. |
|
*/ |
|
SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64); |
|
|
|
/* |
** CAPI3REF: Count The Number Of Rows Modified |
** CAPI3REF: Count The Number Of Rows Modified |
|
** METHOD: sqlite3 |
** |
** |
** ^This function returns the number of database rows that were changed | ** ^This function returns the number of rows modified, inserted or |
** or inserted or deleted by the most recently completed SQL statement | ** deleted by the most recently completed INSERT, UPDATE or DELETE |
** on the [database connection] specified by the first parameter. | ** statement on the database connection specified by the only parameter. |
** ^(Only changes that are directly specified by the [INSERT], [UPDATE], | ** ^Executing any other type of SQL statement does not modify the value |
** or [DELETE] statement are counted. Auxiliary changes caused by | ** returned by this function. |
** triggers or [foreign key actions] are not counted.)^ Use the | |
** [sqlite3_total_changes()] function to find the total number of changes | |
** including changes caused by triggers and foreign key actions. | |
** |
** |
** ^Changes to a view that are simulated by an [INSTEAD OF trigger] | ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are |
** are not counted. Only real table changes are counted. | ** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], |
| ** [foreign key actions] or [REPLACE] constraint resolution are not counted. |
** |
** |
** ^(A "row change" is a change to a single row of a single table | ** Changes to a view that are intercepted by |
** caused by an INSERT, DELETE, or UPDATE statement. Rows that | ** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value |
** are changed as side effects of [REPLACE] constraint resolution, | ** returned by sqlite3_changes() immediately after an INSERT, UPDATE or |
** rollback, ABORT processing, [DROP TABLE], or by any other | ** DELETE statement run on a view is always zero. Only changes made to real |
** mechanisms do not count as direct row changes.)^ | ** tables are counted. |
** |
** |
** A "trigger context" is a scope of execution that begins and | ** Things are more complicated if the sqlite3_changes() function is |
** ends with the script of a [CREATE TRIGGER | trigger]. | ** executed while a trigger program is running. This may happen if the |
** Most SQL statements are | ** program uses the [changes() SQL function], or if some other callback |
** evaluated outside of any trigger. This is the "top level" | ** function invokes sqlite3_changes() directly. Essentially: |
** trigger context. If a trigger fires from the top level, a | |
** new trigger context is entered for the duration of that one | |
** trigger. Subtriggers create subcontexts for their duration. | |
** |
** |
** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does | ** <ul> |
** not create a new trigger context. | ** <li> ^(Before entering a trigger program the value returned by |
| ** sqlite3_changes() function is saved. After the trigger program |
| ** has finished, the original value is restored.)^ |
** |
** |
** ^This function returns the number of direct row changes in the | ** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE |
** most recent INSERT, UPDATE, or DELETE statement within the same | ** statement sets the value returned by sqlite3_changes() |
** trigger context. | ** upon completion as normal. Of course, this value will not include |
| ** any changes performed by sub-triggers, as the sqlite3_changes() |
| ** value will be saved and restored after each sub-trigger has run.)^ |
| ** </ul> |
** |
** |
** ^Thus, when called from the top level, this function returns the | ** ^This means that if the changes() SQL function (or similar) is used |
** number of changes in the most recent INSERT, UPDATE, or DELETE | ** by the first INSERT, UPDATE or DELETE statement within a trigger, it |
** that also occurred at the top level. ^(Within the body of a trigger, | ** returns the value as set when the calling statement began executing. |
** the sqlite3_changes() interface can be called to find the number of | ** ^If it is used by the second or subsequent such statement within a trigger |
** changes in the most recently completed INSERT, UPDATE, or DELETE | ** program, the value returned reflects the number of rows modified by the |
** statement within the body of the same trigger. | ** previous INSERT, UPDATE or DELETE statement within the same trigger. |
** However, the number returned does not include changes | |
** caused by subtriggers since those have their own context.)^ | |
** |
** |
** See also the [sqlite3_total_changes()] interface, the |
|
** [count_changes pragma], and the [changes() SQL function]. |
|
** |
|
** If a separate thread makes changes on the same database connection |
** If a separate thread makes changes on the same database connection |
** while [sqlite3_changes()] is running then the value returned |
** while [sqlite3_changes()] is running then the value returned |
** is unpredictable and not meaningful. |
** is unpredictable and not meaningful. |
|
** |
|
** See also: |
|
** <ul> |
|
** <li> the [sqlite3_total_changes()] interface |
|
** <li> the [count_changes pragma] |
|
** <li> the [changes() SQL function] |
|
** <li> the [data_version pragma] |
|
** </ul> |
*/ |
*/ |
SQLITE_API int sqlite3_changes(sqlite3*); |
SQLITE_API int sqlite3_changes(sqlite3*); |
|
|
/* |
/* |
** CAPI3REF: Total Number Of Rows Modified |
** CAPI3REF: Total Number Of Rows Modified |
|
** METHOD: sqlite3 |
** |
** |
** ^This function returns the number of row changes caused by [INSERT], | ** ^This function returns the total number of rows inserted, modified or |
** [UPDATE] or [DELETE] statements since the [database connection] was opened. | ** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed |
** ^(The count returned by sqlite3_total_changes() includes all changes | ** since the database connection was opened, including those executed as |
** from all [CREATE TRIGGER | trigger] contexts and changes made by | ** part of trigger programs. ^Executing any other type of SQL statement |
** [foreign key actions]. However, | ** does not affect the value returned by sqlite3_total_changes(). |
** the count does not include changes used to implement [REPLACE] constraints, | |
** do rollbacks or ABORT processing, or [DROP TABLE] processing. The | |
** count does not include rows of views that fire an [INSTEAD OF trigger], | |
** though if the INSTEAD OF trigger makes changes of its own, those changes | |
** are counted.)^ | |
** ^The sqlite3_total_changes() function counts the changes as soon as | |
** the statement that makes them is completed (when the statement handle | |
** is passed to [sqlite3_reset()] or [sqlite3_finalize()]). | |
** |
** |
** See also the [sqlite3_changes()] interface, the | ** ^Changes made as part of [foreign key actions] are included in the |
** [count_changes pragma], and the [total_changes() SQL function]. | ** count, but those made as part of REPLACE constraint resolution are |
| ** not. ^Changes to a view that are intercepted by INSTEAD OF triggers |
| ** are not counted. |
** |
** |
|
** The [sqlite3_total_changes(D)] interface only reports the number |
|
** of rows that changed due to SQL statement run against database |
|
** connection D. Any changes by other database connections are ignored. |
|
** To detect changes against a database file from other database |
|
** connections use the [PRAGMA data_version] command or the |
|
** [SQLITE_FCNTL_DATA_VERSION] [file control]. |
|
** |
** If a separate thread makes changes on the same database connection |
** If a separate thread makes changes on the same database connection |
** while [sqlite3_total_changes()] is running then the value |
** while [sqlite3_total_changes()] is running then the value |
** returned is unpredictable and not meaningful. |
** returned is unpredictable and not meaningful. |
|
** |
|
** See also: |
|
** <ul> |
|
** <li> the [sqlite3_changes()] interface |
|
** <li> the [count_changes pragma] |
|
** <li> the [changes() SQL function] |
|
** <li> the [data_version pragma] |
|
** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control] |
|
** </ul> |
*/ |
*/ |
SQLITE_API int sqlite3_total_changes(sqlite3*); |
SQLITE_API int sqlite3_total_changes(sqlite3*); |
|
|
/* |
/* |
** CAPI3REF: Interrupt A Long-Running Query |
** CAPI3REF: Interrupt A Long-Running Query |
|
** METHOD: sqlite3 |
** |
** |
** ^This function causes any pending database operation to abort and |
** ^This function causes any pending database operation to abort and |
** return at its earliest opportunity. This routine is typically |
** return at its earliest opportunity. This routine is typically |
Line 1763 SQLITE_API int sqlite3_total_changes(sqlite3*);
|
Line 2549 SQLITE_API int sqlite3_total_changes(sqlite3*);
|
** |
** |
** ^The sqlite3_interrupt(D) call is in effect until all currently running |
** ^The sqlite3_interrupt(D) call is in effect until all currently running |
** SQL statements on [database connection] D complete. ^Any new SQL statements |
** SQL statements on [database connection] D complete. ^Any new SQL statements |
** that are started after the sqlite3_interrupt() call and before the | ** that are started after the sqlite3_interrupt() call and before the |
** running statements reaches zero are interrupted as if they had been | ** running statement count reaches zero are interrupted as if they had been |
** running prior to the sqlite3_interrupt() call. ^New SQL statements |
** running prior to the sqlite3_interrupt() call. ^New SQL statements |
** that are started after the running statement count reaches zero are |
** that are started after the running statement count reaches zero are |
** not effected by the sqlite3_interrupt(). |
** not effected by the sqlite3_interrupt(). |
** ^A call to sqlite3_interrupt(D) that occurs when there are no running |
** ^A call to sqlite3_interrupt(D) that occurs when there are no running |
** SQL statements is a no-op and has no effect on SQL statements |
** SQL statements is a no-op and has no effect on SQL statements |
** that are started after the sqlite3_interrupt() call returns. |
** that are started after the sqlite3_interrupt() call returns. |
** |
|
** If the database connection closes while [sqlite3_interrupt()] |
|
** is running then bad things will likely happen. |
|
*/ |
*/ |
SQLITE_API void sqlite3_interrupt(sqlite3*); |
SQLITE_API void sqlite3_interrupt(sqlite3*); |
|
|
Line 1798 SQLITE_API void sqlite3_interrupt(sqlite3*);
|
Line 2581 SQLITE_API void sqlite3_interrupt(sqlite3*);
|
** ^These routines do not parse the SQL statements thus |
** ^These routines do not parse the SQL statements thus |
** will not detect syntactically incorrect SQL. |
** will not detect syntactically incorrect SQL. |
** |
** |
** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior | ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior |
** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked |
** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked |
** automatically by sqlite3_complete16(). If that initialization fails, |
** automatically by sqlite3_complete16(). If that initialization fails, |
** then the return value from sqlite3_complete16() will be non-zero |
** then the return value from sqlite3_complete16() will be non-zero |
Line 1815 SQLITE_API int sqlite3_complete16(const void *sql);
|
Line 2598 SQLITE_API int sqlite3_complete16(const void *sql);
|
|
|
/* |
/* |
** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors |
** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors |
|
** KEYWORDS: {busy-handler callback} {busy handler} |
|
** METHOD: sqlite3 |
** |
** |
** ^This routine sets a callback function that might be invoked whenever | ** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X |
** an attempt is made to open a database table that another thread | ** that might be invoked with argument P whenever |
** or process has locked. | ** an attempt is made to access a database table associated with |
| ** [database connection] D when another thread |
| ** or process has the table locked. |
| ** The sqlite3_busy_handler() interface is used to implement |
| ** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout]. |
** |
** |
** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] | ** ^If the busy callback is NULL, then [SQLITE_BUSY] |
** is returned immediately upon encountering the lock. ^If the busy callback |
** is returned immediately upon encountering the lock. ^If the busy callback |
** is not NULL, then the callback might be invoked with two arguments. |
** is not NULL, then the callback might be invoked with two arguments. |
** |
** |
** ^The first argument to the busy handler is a copy of the void* pointer which |
** ^The first argument to the busy handler is a copy of the void* pointer which |
** is the third argument to sqlite3_busy_handler(). ^The second argument to |
** is the third argument to sqlite3_busy_handler(). ^The second argument to |
** the busy handler callback is the number of times that the busy handler has |
** the busy handler callback is the number of times that the busy handler has |
** been invoked for this locking event. ^If the | ** been invoked previously for the same locking event. ^If the |
** busy callback returns 0, then no additional attempts are made to |
** busy callback returns 0, then no additional attempts are made to |
** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. | ** access the database and [SQLITE_BUSY] is returned |
| ** to the application. |
** ^If the callback returns non-zero, then another attempt |
** ^If the callback returns non-zero, then another attempt |
** is made to open the database for reading and the cycle repeats. | ** is made to access the database and the cycle repeats. |
** |
** |
** The presence of a busy handler does not guarantee that it will be invoked |
** The presence of a busy handler does not guarantee that it will be invoked |
** when there is lock contention. ^If SQLite determines that invoking the busy |
** when there is lock contention. ^If SQLite determines that invoking the busy |
** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] |
** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] |
** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. | ** to the application instead of invoking the |
| ** busy handler. |
** Consider a scenario where one process is holding a read lock that |
** Consider a scenario where one process is holding a read lock that |
** it is trying to promote to a reserved lock and |
** it is trying to promote to a reserved lock and |
** a second process is holding a reserved lock that it is trying |
** a second process is holding a reserved lock that it is trying |
Line 1850 SQLITE_API int sqlite3_complete16(const void *sql);
|
Line 2641 SQLITE_API int sqlite3_complete16(const void *sql);
|
** |
** |
** ^The default busy callback is NULL. |
** ^The default busy callback is NULL. |
** |
** |
** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] |
|
** when SQLite is in the middle of a large transaction where all the |
|
** changes will not fit into the in-memory cache. SQLite will |
|
** already hold a RESERVED lock on the database file, but it needs |
|
** to promote this lock to EXCLUSIVE so that it can spill cache |
|
** pages into the database file without harm to concurrent |
|
** readers. ^If it is unable to promote the lock, then the in-memory |
|
** cache will be left in an inconsistent state and so the error |
|
** code is promoted from the relatively benign [SQLITE_BUSY] to |
|
** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion |
|
** forces an automatic rollback of the changes. See the |
|
** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> |
|
** CorruptionFollowingBusyError</a> wiki page for a discussion of why |
|
** this is important. |
|
** |
|
** ^(There can only be a single busy handler defined for each |
** ^(There can only be a single busy handler defined for each |
** [database connection]. Setting a new busy handler clears any |
** [database connection]. Setting a new busy handler clears any |
** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] |
** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] |
** will also set or clear the busy handler. | ** or evaluating [PRAGMA busy_timeout=N] will change the |
| ** busy handler and thus clear any previously set busy handler. |
** |
** |
** The busy callback should not take any actions which modify the |
** The busy callback should not take any actions which modify the |
** database connection that invoked the busy handler. Any such actions | ** database connection that invoked the busy handler. In other words, |
| ** the busy handler is not reentrant. Any such actions |
** result in undefined behavior. |
** result in undefined behavior. |
** | ** |
** A busy handler must not close the database connection |
** A busy handler must not close the database connection |
** or [prepared statement] that invoked the busy handler. |
** or [prepared statement] that invoked the busy handler. |
*/ |
*/ |
SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); | SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*); |
|
|
/* |
/* |
** CAPI3REF: Set A Busy Timeout |
** CAPI3REF: Set A Busy Timeout |
|
** METHOD: sqlite3 |
** |
** |
** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps |
** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps |
** for a specified amount of time when a table is locked. ^The handler |
** for a specified amount of time when a table is locked. ^The handler |
** will sleep multiple times until at least "ms" milliseconds of sleeping |
** will sleep multiple times until at least "ms" milliseconds of sleeping |
** have accumulated. ^After at least "ms" milliseconds of sleeping, |
** have accumulated. ^After at least "ms" milliseconds of sleeping, |
** the handler returns 0 which causes [sqlite3_step()] to return |
** the handler returns 0 which causes [sqlite3_step()] to return |
** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. | ** [SQLITE_BUSY]. |
** |
** |
** ^Calling this routine with an argument less than or equal to zero |
** ^Calling this routine with an argument less than or equal to zero |
** turns off all busy handlers. |
** turns off all busy handlers. |
** |
** |
** ^(There can only be a single busy handler for a particular |
** ^(There can only be a single busy handler for a particular |
** [database connection] any any given moment. If another busy handler | ** [database connection] at any given moment. If another busy handler |
** was defined (using [sqlite3_busy_handler()]) prior to calling |
** was defined (using [sqlite3_busy_handler()]) prior to calling |
** this routine, that other busy handler is cleared.)^ |
** this routine, that other busy handler is cleared.)^ |
|
** |
|
** See also: [PRAGMA busy_timeout] |
*/ |
*/ |
SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); |
SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); |
|
|
/* |
/* |
** CAPI3REF: Convenience Routines For Running Queries |
** CAPI3REF: Convenience Routines For Running Queries |
|
** METHOD: sqlite3 |
** |
** |
** This is a legacy interface that is preserved for backwards compatibility. |
** This is a legacy interface that is preserved for backwards compatibility. |
** Use of this interface is not recommended. |
** Use of this interface is not recommended. |
Line 1936 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
|
Line 2718 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
|
** Cindy | 21 |
** Cindy | 21 |
** </pre></blockquote> |
** </pre></blockquote> |
** |
** |
** There are two column (M==2) and three rows (N==3). Thus the | ** There are two columns (M==2) and three rows (N==3). Thus the |
** result table has 8 entries. Suppose the result table is stored |
** result table has 8 entries. Suppose the result table is stored |
** in an array names azResult. Then azResult holds this content: | ** in an array named azResult. Then azResult holds this content: |
** |
** |
** <blockquote><pre> |
** <blockquote><pre> |
** azResult[0] = "Name"; |
** azResult[0] = "Name"; |
Line 1986 SQLITE_API void sqlite3_free_table(char **result);
|
Line 2768 SQLITE_API void sqlite3_free_table(char **result);
|
** |
** |
** These routines are work-alikes of the "printf()" family of functions |
** These routines are work-alikes of the "printf()" family of functions |
** from the standard C library. |
** from the standard C library. |
|
** These routines understand most of the common formatting options from |
|
** the standard library printf() |
|
** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]). |
|
** See the [built-in printf()] documentation for details. |
** |
** |
** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their |
** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their |
** results into memory obtained from [sqlite3_malloc()]. | ** results into memory obtained from [sqlite3_malloc64()]. |
** The strings returned by these two routines should be |
** The strings returned by these two routines should be |
** released by [sqlite3_free()]. ^Both routines return a |
** released by [sqlite3_free()]. ^Both routines return a |
** NULL pointer if [sqlite3_malloc()] is unable to allocate enough | ** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough |
** memory to hold the resulting string. |
** memory to hold the resulting string. |
** |
** |
** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from |
** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from |
Line 2015 SQLITE_API void sqlite3_free_table(char **result);
|
Line 2801 SQLITE_API void sqlite3_free_table(char **result);
|
** |
** |
** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). |
** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). |
** |
** |
** These routines all implement some additional formatting | ** See also: [built-in printf()], [printf() SQL function] |
** options that are useful for constructing SQL statements. | |
** All of the usual printf() formatting options apply. In addition, there | |
** is are "%q", "%Q", and "%z" options. | |
** | |
** ^(The %q option works like %s in that it substitutes a nul-terminated | |
** string from the argument list. But %q also doubles every '\'' character. | |
** %q is designed for use inside a string literal.)^ By doubling each '\'' | |
** character it escapes that character and allows it to be inserted into | |
** the string. | |
** | |
** For example, assume the string variable zText contains text as follows: | |
** | |
** <blockquote><pre> | |
** char *zText = "It's a happy day!"; | |
** </pre></blockquote> | |
** | |
** One can use this text in an SQL statement as follows: | |
** | |
** <blockquote><pre> | |
** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); | |
** sqlite3_exec(db, zSQL, 0, 0, 0); | |
** sqlite3_free(zSQL); | |
** </pre></blockquote> | |
** | |
** Because the %q format string is used, the '\'' character in zText | |
** is escaped and the SQL generated is as follows: | |
** | |
** <blockquote><pre> | |
** INSERT INTO table1 VALUES('It''s a happy day!') | |
** </pre></blockquote> | |
** | |
** This is correct. Had we used %s instead of %q, the generated SQL | |
** would have looked like this: | |
** | |
** <blockquote><pre> | |
** INSERT INTO table1 VALUES('It's a happy day!'); | |
** </pre></blockquote> | |
** | |
** This second example is an SQL syntax error. As a general rule you should | |
** always use %q instead of %s when inserting text into a string literal. | |
** | |
** ^(The %Q option works like %q except it also adds single quotes around | |
** the outside of the total string. Additionally, if the parameter in the | |
** argument list is a NULL pointer, %Q substitutes the text "NULL" (without | |
** single quotes).)^ So, for example, one could say: | |
** | |
** <blockquote><pre> | |
** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); | |
** sqlite3_exec(db, zSQL, 0, 0, 0); | |
** sqlite3_free(zSQL); | |
** </pre></blockquote> | |
** | |
** The code above will render a correct SQL statement in the zSQL | |
** variable even if the zText variable is a NULL pointer. | |
** | |
** ^(The "%z" formatting option works like "%s" but with the | |
** addition that after the string has been read and copied into | |
** the result, [sqlite3_free()] is called on the input string.)^ | |
*/ |
*/ |
SQLITE_API char *sqlite3_mprintf(const char*,...); |
SQLITE_API char *sqlite3_mprintf(const char*,...); |
SQLITE_API char *sqlite3_vmprintf(const char*, va_list); |
SQLITE_API char *sqlite3_vmprintf(const char*, va_list); |
Line 2085 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
Line 2813 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
** |
** |
** The SQLite core uses these three routines for all of its own |
** The SQLite core uses these three routines for all of its own |
** internal memory allocation needs. "Core" in the previous sentence |
** internal memory allocation needs. "Core" in the previous sentence |
** does not include operating-system specific VFS implementation. The | ** does not include operating-system specific [VFS] implementation. The |
** Windows VFS uses native malloc() and free() for some operations. |
** Windows VFS uses native malloc() and free() for some operations. |
** |
** |
** ^The sqlite3_malloc() routine returns a pointer to a block |
** ^The sqlite3_malloc() routine returns a pointer to a block |
Line 2095 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
Line 2823 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns |
** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns |
** a NULL pointer. |
** a NULL pointer. |
** |
** |
|
** ^The sqlite3_malloc64(N) routine works just like |
|
** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead |
|
** of a signed 32-bit integer. |
|
** |
** ^Calling sqlite3_free() with a pointer previously returned |
** ^Calling sqlite3_free() with a pointer previously returned |
** by sqlite3_malloc() or sqlite3_realloc() releases that memory so |
** by sqlite3_malloc() or sqlite3_realloc() releases that memory so |
** that it might be reused. ^The sqlite3_free() routine is |
** that it might be reused. ^The sqlite3_free() routine is |
Line 2106 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
Line 2838 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
** might result if sqlite3_free() is called with a non-NULL pointer that |
** might result if sqlite3_free() is called with a non-NULL pointer that |
** was not obtained from sqlite3_malloc() or sqlite3_realloc(). |
** was not obtained from sqlite3_malloc() or sqlite3_realloc(). |
** |
** |
** ^(The sqlite3_realloc() interface attempts to resize a | ** ^The sqlite3_realloc(X,N) interface attempts to resize a |
** prior memory allocation to be at least N bytes, where N is the | ** prior memory allocation X to be at least N bytes. |
** second parameter. The memory allocation to be resized is the first | ** ^If the X parameter to sqlite3_realloc(X,N) |
** parameter.)^ ^ If the first parameter to sqlite3_realloc() | |
** is a NULL pointer then its behavior is identical to calling |
** is a NULL pointer then its behavior is identical to calling |
** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). | ** sqlite3_malloc(N). |
** ^If the second parameter to sqlite3_realloc() is zero or | ** ^If the N parameter to sqlite3_realloc(X,N) is zero or |
** negative then the behavior is exactly the same as calling |
** negative then the behavior is exactly the same as calling |
** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). | ** sqlite3_free(X). |
** ^sqlite3_realloc() returns a pointer to a memory allocation | ** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation |
** of at least N bytes in size or NULL if sufficient memory is unavailable. | ** of at least N bytes in size or NULL if insufficient memory is available. |
** ^If M is the size of the prior allocation, then min(N,M) bytes |
** ^If M is the size of the prior allocation, then min(N,M) bytes |
** of the prior allocation are copied into the beginning of buffer returned |
** of the prior allocation are copied into the beginning of buffer returned |
** by sqlite3_realloc() and the prior allocation is freed. | ** by sqlite3_realloc(X,N) and the prior allocation is freed. |
** ^If sqlite3_realloc() returns NULL, then the prior allocation | ** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the |
** is not freed. | ** prior allocation is not freed. |
** |
** |
** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() | ** ^The sqlite3_realloc64(X,N) interfaces works the same as |
| ** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead |
| ** of a 32-bit signed integer. |
| ** |
| ** ^If X is a memory allocation previously obtained from sqlite3_malloc(), |
| ** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then |
| ** sqlite3_msize(X) returns the size of that memory allocation in bytes. |
| ** ^The value returned by sqlite3_msize(X) might be larger than the number |
| ** of bytes requested when X was allocated. ^If X is a NULL pointer then |
| ** sqlite3_msize(X) returns zero. If X points to something that is not |
| ** the beginning of memory allocation, or if it points to a formerly |
| ** valid memory allocation that has now been freed, then the behavior |
| ** of sqlite3_msize(X) is undefined and possibly harmful. |
| ** |
| ** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(), |
| ** sqlite3_malloc64(), and sqlite3_realloc64() |
** is always aligned to at least an 8 byte boundary, or to a |
** is always aligned to at least an 8 byte boundary, or to a |
** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time |
** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time |
** option is used. |
** option is used. |
** |
** |
** In SQLite version 3.5.0 and 3.5.1, it was possible to define |
|
** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in |
|
** implementation of these routines to be omitted. That capability |
|
** is no longer provided. Only built-in memory allocators can be used. |
|
** |
|
** The Windows OS interface layer calls |
|
** the system malloc() and free() directly when converting |
|
** filenames between the UTF-8 encoding used by SQLite |
|
** and whatever filename encoding is used by the particular Windows |
|
** installation. Memory allocation errors are detected, but |
|
** they are reported back as [SQLITE_CANTOPEN] or |
|
** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. |
|
** |
|
** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] |
** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] |
** must be either NULL or else pointers obtained from a prior |
** must be either NULL or else pointers obtained from a prior |
** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have |
** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have |
Line 2151 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
Line 2884 SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
|
** [sqlite3_free()] or [sqlite3_realloc()]. |
** [sqlite3_free()] or [sqlite3_realloc()]. |
*/ |
*/ |
SQLITE_API void *sqlite3_malloc(int); |
SQLITE_API void *sqlite3_malloc(int); |
|
SQLITE_API void *sqlite3_malloc64(sqlite3_uint64); |
SQLITE_API void *sqlite3_realloc(void*, int); |
SQLITE_API void *sqlite3_realloc(void*, int); |
|
SQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64); |
SQLITE_API void sqlite3_free(void*); |
SQLITE_API void sqlite3_free(void*); |
|
SQLITE_API sqlite3_uint64 sqlite3_msize(void*); |
|
|
/* |
/* |
** CAPI3REF: Memory Allocator Statistics |
** CAPI3REF: Memory Allocator Statistics |
Line 2186 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int
|
Line 2922 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int
|
** SQLite contains a high-quality pseudo-random number generator (PRNG) used to |
** SQLite contains a high-quality pseudo-random number generator (PRNG) used to |
** select random [ROWID | ROWIDs] when inserting new records into a table that |
** select random [ROWID | ROWIDs] when inserting new records into a table that |
** already uses the largest possible [ROWID]. The PRNG is also used for |
** already uses the largest possible [ROWID]. The PRNG is also used for |
** the build-in random() and randomblob() SQL functions. This interface allows | ** the built-in random() and randomblob() SQL functions. This interface allows |
** applications to access the same PRNG for other purposes. |
** applications to access the same PRNG for other purposes. |
** |
** |
** ^A call to this routine stores N bytes of randomness into buffer P. |
** ^A call to this routine stores N bytes of randomness into buffer P. |
|
** ^The P parameter can be a NULL pointer. |
** |
** |
** ^The first time this routine is invoked (either internally or by | ** ^If this routine has not been previously called or if the previous |
** the application) the PRNG is seeded using randomness obtained | ** call had N less than one or a NULL pointer for P, then the PRNG is |
** from the xRandomness method of the default [sqlite3_vfs] object. | ** seeded using randomness obtained from the xRandomness method of |
** ^On all subsequent invocations, the pseudo-randomness is generated | ** the default [sqlite3_vfs] object. |
| ** ^If the previous call to this routine had an N of 1 or more and a |
| ** non-NULL P then the pseudo-randomness is generated |
** internally and without recourse to the [sqlite3_vfs] xRandomness |
** internally and without recourse to the [sqlite3_vfs] xRandomness |
** method. |
** method. |
*/ |
*/ |
Line 2202 SQLITE_API void sqlite3_randomness(int N, void *P);
|
Line 2941 SQLITE_API void sqlite3_randomness(int N, void *P);
|
|
|
/* |
/* |
** CAPI3REF: Compile-Time Authorization Callbacks |
** CAPI3REF: Compile-Time Authorization Callbacks |
|
** METHOD: sqlite3 |
|
** KEYWORDS: {authorizer callback} |
** |
** |
** ^This routine registers an authorizer callback with a particular |
** ^This routine registers an authorizer callback with a particular |
** [database connection], supplied in the first argument. |
** [database connection], supplied in the first argument. |
** ^The authorizer callback is invoked as SQL statements are being compiled |
** ^The authorizer callback is invoked as SQL statements are being compiled |
** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], |
** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], |
** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various | ** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()], |
| ** and [sqlite3_prepare16_v3()]. ^At various |
** points during the compilation process, as logic is being created |
** points during the compilation process, as logic is being created |
** to perform various actions, the authorizer callback is invoked to |
** to perform various actions, the authorizer callback is invoked to |
** see if those actions are allowed. ^The authorizer callback should |
** see if those actions are allowed. ^The authorizer callback should |
Line 2223 SQLITE_API void sqlite3_randomness(int N, void *P);
|
Line 2965 SQLITE_API void sqlite3_randomness(int N, void *P);
|
** requested is ok. ^When the callback returns [SQLITE_DENY], the |
** requested is ok. ^When the callback returns [SQLITE_DENY], the |
** [sqlite3_prepare_v2()] or equivalent call that triggered the |
** [sqlite3_prepare_v2()] or equivalent call that triggered the |
** authorizer will fail with an error message explaining that |
** authorizer will fail with an error message explaining that |
** access is denied. | ** access is denied. |
** |
** |
** ^The first parameter to the authorizer callback is a copy of the third |
** ^The first parameter to the authorizer callback is a copy of the third |
** parameter to the sqlite3_set_authorizer() interface. ^The second parameter |
** parameter to the sqlite3_set_authorizer() interface. ^The second parameter |
** to the callback is an integer [SQLITE_COPY | action code] that specifies |
** to the callback is an integer [SQLITE_COPY | action code] that specifies |
** the particular action to be authorized. ^The third through sixth parameters |
** the particular action to be authorized. ^The third through sixth parameters |
** to the callback are zero-terminated strings that contain additional | ** to the callback are either NULL pointers or zero-terminated strings |
** details about the action to be authorized. | ** that contain additional details about the action to be authorized. |
| ** Applications must always be prepared to encounter a NULL pointer in any |
| ** of the third through the sixth parameters of the authorization callback. |
** |
** |
** ^If the action code is [SQLITE_READ] |
** ^If the action code is [SQLITE_READ] |
** and the callback returns [SQLITE_IGNORE] then the |
** and the callback returns [SQLITE_IGNORE] then the |
Line 2239 SQLITE_API void sqlite3_randomness(int N, void *P);
|
Line 2983 SQLITE_API void sqlite3_randomness(int N, void *P);
|
** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] |
** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] |
** return can be used to deny an untrusted user access to individual |
** return can be used to deny an untrusted user access to individual |
** columns of a table. |
** columns of a table. |
|
** ^When a table is referenced by a [SELECT] but no column values are |
|
** extracted from that table (for example in a query like |
|
** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback |
|
** is invoked once for that table with a column name that is an empty string. |
** ^If the action code is [SQLITE_DELETE] and the callback returns |
** ^If the action code is [SQLITE_DELETE] and the callback returns |
** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the |
** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the |
** [truncate optimization] is disabled and all rows are deleted individually. |
** [truncate optimization] is disabled and all rows are deleted individually. |
Line 2270 SQLITE_API void sqlite3_randomness(int N, void *P);
|
Line 3018 SQLITE_API void sqlite3_randomness(int N, void *P);
|
** database connections for the meaning of "modify" in this paragraph. |
** database connections for the meaning of "modify" in this paragraph. |
** |
** |
** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the |
** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the |
** statement might be re-prepared during [sqlite3_step()] due to a | ** statement might be re-prepared during [sqlite3_step()] due to a |
** schema change. Hence, the application should ensure that the |
** schema change. Hence, the application should ensure that the |
** correct authorizer callback remains in place during the [sqlite3_step()]. |
** correct authorizer callback remains in place during the [sqlite3_step()]. |
** |
** |
Line 2295 SQLITE_API int sqlite3_set_authorizer(
|
Line 3043 SQLITE_API int sqlite3_set_authorizer(
|
** [sqlite3_set_authorizer | authorizer documentation] for additional |
** [sqlite3_set_authorizer | authorizer documentation] for additional |
** information. |
** information. |
** |
** |
** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code] | ** Note that SQLITE_IGNORE is also used as a [conflict resolution mode] |
** from the [sqlite3_vtab_on_conflict()] interface. | ** returned from the [sqlite3_vtab_on_conflict()] interface. |
*/ |
*/ |
#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ |
#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ |
#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ |
#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ |
Line 2354 SQLITE_API int sqlite3_set_authorizer(
|
Line 3102 SQLITE_API int sqlite3_set_authorizer(
|
#define SQLITE_FUNCTION 31 /* NULL Function Name */ |
#define SQLITE_FUNCTION 31 /* NULL Function Name */ |
#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ |
#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ |
#define SQLITE_COPY 0 /* No longer used */ |
#define SQLITE_COPY 0 /* No longer used */ |
|
#define SQLITE_RECURSIVE 33 /* NULL NULL */ |
|
|
/* |
/* |
** CAPI3REF: Tracing And Profiling Functions |
** CAPI3REF: Tracing And Profiling Functions |
|
** METHOD: sqlite3 |
** |
** |
|
** These routines are deprecated. Use the [sqlite3_trace_v2()] interface |
|
** instead of the routines described here. |
|
** |
** These routines register callback functions that can be used for |
** These routines register callback functions that can be used for |
** tracing and profiling the execution of SQL statements. |
** tracing and profiling the execution of SQL statements. |
** |
** |
Line 2369 SQLITE_API int sqlite3_set_authorizer(
|
Line 3122 SQLITE_API int sqlite3_set_authorizer(
|
** as each triggered subprogram is entered. The callbacks for triggers |
** as each triggered subprogram is entered. The callbacks for triggers |
** contain a UTF-8 SQL comment that identifies the trigger.)^ |
** contain a UTF-8 SQL comment that identifies the trigger.)^ |
** |
** |
|
** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit |
|
** the length of [bound parameter] expansion in the output of sqlite3_trace(). |
|
** |
** ^The callback function registered by sqlite3_profile() is invoked |
** ^The callback function registered by sqlite3_profile() is invoked |
** as each SQL statement finishes. ^The profile callback contains |
** as each SQL statement finishes. ^The profile callback contains |
** the original statement text and an estimate of wall-clock time |
** the original statement text and an estimate of wall-clock time |
Line 2376 SQLITE_API int sqlite3_set_authorizer(
|
Line 3132 SQLITE_API int sqlite3_set_authorizer(
|
** time is in units of nanoseconds, however the current implementation |
** time is in units of nanoseconds, however the current implementation |
** is only capable of millisecond resolution so the six least significant |
** is only capable of millisecond resolution so the six least significant |
** digits in the time are meaningless. Future versions of SQLite |
** digits in the time are meaningless. Future versions of SQLite |
** might provide greater resolution on the profiler callback. The | ** might provide greater resolution on the profiler callback. Invoking |
** sqlite3_profile() function is considered experimental and is | ** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the |
** subject to change in future versions of SQLite. | ** profile callback. |
*/ |
*/ |
SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); | SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*, |
SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, | void(*xTrace)(void*,const char*), void*); |
| SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*, |
void(*xProfile)(void*,const char*,sqlite3_uint64), void*); |
void(*xProfile)(void*,const char*,sqlite3_uint64), void*); |
|
|
/* |
/* |
|
** CAPI3REF: SQL Trace Event Codes |
|
** KEYWORDS: SQLITE_TRACE |
|
** |
|
** These constants identify classes of events that can be monitored |
|
** using the [sqlite3_trace_v2()] tracing logic. The M argument |
|
** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of |
|
** the following constants. ^The first argument to the trace callback |
|
** is one of the following constants. |
|
** |
|
** New tracing constants may be added in future releases. |
|
** |
|
** ^A trace callback has four arguments: xCallback(T,C,P,X). |
|
** ^The T argument is one of the integer type codes above. |
|
** ^The C argument is a copy of the context pointer passed in as the |
|
** fourth argument to [sqlite3_trace_v2()]. |
|
** The P and X arguments are pointers whose meanings depend on T. |
|
** |
|
** <dl> |
|
** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt> |
|
** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement |
|
** first begins running and possibly at other times during the |
|
** execution of the prepared statement, such as at the start of each |
|
** trigger subprogram. ^The P argument is a pointer to the |
|
** [prepared statement]. ^The X argument is a pointer to a string which |
|
** is the unexpanded SQL text of the prepared statement or an SQL comment |
|
** that indicates the invocation of a trigger. ^The callback can compute |
|
** the same text that would have been returned by the legacy [sqlite3_trace()] |
|
** interface by using the X argument when X begins with "--" and invoking |
|
** [sqlite3_expanded_sql(P)] otherwise. |
|
** |
|
** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt> |
|
** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same |
|
** information as is provided by the [sqlite3_profile()] callback. |
|
** ^The P argument is a pointer to the [prepared statement] and the |
|
** X argument points to a 64-bit integer which is the estimated of |
|
** the number of nanosecond that the prepared statement took to run. |
|
** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes. |
|
** |
|
** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt> |
|
** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared |
|
** statement generates a single row of result. |
|
** ^The P argument is a pointer to the [prepared statement] and the |
|
** X argument is unused. |
|
** |
|
** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt> |
|
** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database |
|
** connection closes. |
|
** ^The P argument is a pointer to the [database connection] object |
|
** and the X argument is unused. |
|
** </dl> |
|
*/ |
|
#define SQLITE_TRACE_STMT 0x01 |
|
#define SQLITE_TRACE_PROFILE 0x02 |
|
#define SQLITE_TRACE_ROW 0x04 |
|
#define SQLITE_TRACE_CLOSE 0x08 |
|
|
|
/* |
|
** CAPI3REF: SQL Trace Hook |
|
** METHOD: sqlite3 |
|
** |
|
** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback |
|
** function X against [database connection] D, using property mask M |
|
** and context pointer P. ^If the X callback is |
|
** NULL or if the M mask is zero, then tracing is disabled. The |
|
** M argument should be the bitwise OR-ed combination of |
|
** zero or more [SQLITE_TRACE] constants. |
|
** |
|
** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides |
|
** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2(). |
|
** |
|
** ^The X callback is invoked whenever any of the events identified by |
|
** mask M occur. ^The integer return value from the callback is currently |
|
** ignored, though this may change in future releases. Callback |
|
** implementations should return zero to ensure future compatibility. |
|
** |
|
** ^A trace callback is invoked with four arguments: callback(T,C,P,X). |
|
** ^The T argument is one of the [SQLITE_TRACE] |
|
** constants to indicate why the callback was invoked. |
|
** ^The C argument is a copy of the context pointer. |
|
** The P and X arguments are pointers whose meanings depend on T. |
|
** |
|
** The sqlite3_trace_v2() interface is intended to replace the legacy |
|
** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which |
|
** are deprecated. |
|
*/ |
|
SQLITE_API int sqlite3_trace_v2( |
|
sqlite3*, |
|
unsigned uMask, |
|
int(*xCallback)(unsigned,void*,void*,void*), |
|
void *pCtx |
|
); |
|
|
|
/* |
** CAPI3REF: Query Progress Callbacks |
** CAPI3REF: Query Progress Callbacks |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback |
** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback |
** function X to be invoked periodically during long running calls to |
** function X to be invoked periodically during long running calls to |
Line 2393 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(s
|
Line 3244 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(s
|
** database connection D. An example use for this |
** database connection D. An example use for this |
** interface is to keep a GUI updated during a large query. |
** interface is to keep a GUI updated during a large query. |
** |
** |
** ^The parameter P is passed through as the only parameter to the | ** ^The parameter P is passed through as the only parameter to the |
** callback function X. ^The parameter N is the number of | ** callback function X. ^The parameter N is the approximate number of |
** [virtual machine instructions] that are evaluated between successive |
** [virtual machine instructions] that are evaluated between successive |
** invocations of the callback X. | ** invocations of the callback X. ^If N is less than one then the progress |
| ** handler is disabled. |
** |
** |
** ^Only a single progress handler may be defined at one time per |
** ^Only a single progress handler may be defined at one time per |
** [database connection]; setting a new progress handler cancels the |
** [database connection]; setting a new progress handler cancels the |
Line 2418 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3270 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
|
|
/* |
/* |
** CAPI3REF: Opening A New Database Connection |
** CAPI3REF: Opening A New Database Connection |
|
** CONSTRUCTOR: sqlite3 |
** |
** |
** ^These routines open an SQLite database file as specified by the | ** ^These routines open an SQLite database file as specified by the |
** filename argument. ^The filename argument is interpreted as UTF-8 for |
** filename argument. ^The filename argument is interpreted as UTF-8 for |
** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte |
** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte |
** order for sqlite3_open16(). ^(A [database connection] handle is usually |
** order for sqlite3_open16(). ^(A [database connection] handle is usually |
Line 2432 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3285 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
** an English language description of the error following a failure of any |
** an English language description of the error following a failure of any |
** of the sqlite3_open() routines. |
** of the sqlite3_open() routines. |
** |
** |
** ^The default encoding for the database will be UTF-8 if | ** ^The default encoding will be UTF-8 for databases created using |
** sqlite3_open() or sqlite3_open_v2() is called and | ** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases |
** UTF-16 in the native byte order if sqlite3_open16() is used. | ** created using sqlite3_open16() will be UTF-16 in the native byte order. |
** |
** |
** Whether or not an error occurs when it is opened, resources |
** Whether or not an error occurs when it is opened, resources |
** associated with the [database connection] handle should be released by |
** associated with the [database connection] handle should be released by |
Line 2443 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3296 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
** The sqlite3_open_v2() interface works like sqlite3_open() |
** The sqlite3_open_v2() interface works like sqlite3_open() |
** except that it accepts two additional parameters for additional control |
** except that it accepts two additional parameters for additional control |
** over the new database connection. ^(The flags parameter to |
** over the new database connection. ^(The flags parameter to |
** sqlite3_open_v2() can take one of | ** sqlite3_open_v2() must include, at a minimum, one of the following |
** the following three values, optionally combined with the | ** three flag combinations:)^ |
** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], | |
** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ | |
** |
** |
** <dl> |
** <dl> |
** ^(<dt>[SQLITE_OPEN_READONLY]</dt> |
** ^(<dt>[SQLITE_OPEN_READONLY]</dt> |
Line 2464 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3315 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
** sqlite3_open() and sqlite3_open16().</dd>)^ |
** sqlite3_open() and sqlite3_open16().</dd>)^ |
** </dl> |
** </dl> |
** |
** |
|
** In addition to the required flags, the following optional flags are |
|
** also supported: |
|
** |
|
** <dl> |
|
** ^(<dt>[SQLITE_OPEN_URI]</dt> |
|
** <dd>The filename can be interpreted as a URI if this flag is set.</dd>)^ |
|
** |
|
** ^(<dt>[SQLITE_OPEN_MEMORY]</dt> |
|
** <dd>The database will be opened as an in-memory database. The database |
|
** is named by the "filename" argument for the purposes of cache-sharing, |
|
** if shared cache mode is enabled, but the "filename" is otherwise ignored. |
|
** </dd>)^ |
|
** |
|
** ^(<dt>[SQLITE_OPEN_NOMUTEX]</dt> |
|
** <dd>The new database connection will use the "multi-thread" |
|
** [threading mode].)^ This means that separate threads are allowed |
|
** to use SQLite at the same time, as long as each thread is using |
|
** a different [database connection]. |
|
** |
|
** ^(<dt>[SQLITE_OPEN_FULLMUTEX]</dt> |
|
** <dd>The new database connection will use the "serialized" |
|
** [threading mode].)^ This means the multiple threads can safely |
|
** attempt to use the same database connection at the same time. |
|
** (Mutexes will block any actual concurrency, but in this mode |
|
** there is no harm in trying.) |
|
** |
|
** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt> |
|
** <dd>The database is opened [shared cache] enabled, overriding |
|
** the default shared cache setting provided by |
|
** [sqlite3_enable_shared_cache()].)^ |
|
** |
|
** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt> |
|
** <dd>The database is opened [shared cache] disabled, overriding |
|
** the default shared cache setting provided by |
|
** [sqlite3_enable_shared_cache()].)^ |
|
** |
|
** [[OPEN_NOFOLLOW]] ^(<dt>[SQLITE_OPEN_NOFOLLOW]</dt> |
|
** <dd>The database filename is not allowed to be a symbolic link</dd> |
|
** </dl>)^ |
|
** |
** If the 3rd parameter to sqlite3_open_v2() is not one of the |
** If the 3rd parameter to sqlite3_open_v2() is not one of the |
** combinations shown above optionally combined with other | ** required combinations shown above optionally combined with other |
** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] |
** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] |
** then the behavior is undefined. |
** then the behavior is undefined. |
** |
** |
** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection |
|
** opens in the multi-thread [threading mode] as long as the single-thread |
|
** mode has not been set at compile-time or start-time. ^If the |
|
** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens |
|
** in the serialized [threading mode] unless single-thread was |
|
** previously selected at compile-time or start-time. |
|
** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be |
|
** eligible to use [shared cache mode], regardless of whether or not shared |
|
** cache is enabled using [sqlite3_enable_shared_cache()]. ^The |
|
** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not |
|
** participate in [shared cache mode] even if it is enabled. |
|
** |
|
** ^The fourth parameter to sqlite3_open_v2() is the name of the |
** ^The fourth parameter to sqlite3_open_v2() is the name of the |
** [sqlite3_vfs] object that defines the operating system interface that |
** [sqlite3_vfs] object that defines the operating system interface that |
** the new database connection should use. ^If the fourth parameter is |
** the new database connection should use. ^If the fourth parameter is |
Line 2503 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3382 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
** ^If [URI filename] interpretation is enabled, and the filename argument |
** ^If [URI filename] interpretation is enabled, and the filename argument |
** begins with "file:", then the filename is interpreted as a URI. ^URI |
** begins with "file:", then the filename is interpreted as a URI. ^URI |
** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is |
** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is |
** set in the fourth argument to sqlite3_open_v2(), or if it has | ** set in the third argument to sqlite3_open_v2(), or if it has |
** been enabled globally using the [SQLITE_CONFIG_URI] option with the |
** been enabled globally using the [SQLITE_CONFIG_URI] option with the |
** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. |
** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. |
** As of SQLite version 3.7.7, URI filename interpretation is turned off | ** URI filename interpretation is turned off |
** by default, but future releases of SQLite might enable URI filename |
** by default, but future releases of SQLite might enable URI filename |
** interpretation by default. See "[URI filenames]" for additional |
** interpretation by default. See "[URI filenames]" for additional |
** information. |
** information. |
** |
** |
** URI filenames are parsed according to RFC 3986. ^If the URI contains an |
** URI filenames are parsed according to RFC 3986. ^If the URI contains an |
** authority, then it must be either an empty string or the string | ** authority, then it must be either an empty string or the string |
** "localhost". ^If the authority is not an empty string or "localhost", an | ** "localhost". ^If the authority is not an empty string or "localhost", an |
** error is returned to the caller. ^The fragment component of a URI, if | ** error is returned to the caller. ^The fragment component of a URI, if |
** present, is ignored. |
** present, is ignored. |
** |
** |
** ^SQLite uses the path component of the URI as the name of the disk file |
** ^SQLite uses the path component of the URI as the name of the disk file |
** which contains the database. ^If the path begins with a '/' character, | ** which contains the database. ^If the path begins with a '/' character, |
** then it is interpreted as an absolute path. ^If the path does not begin | ** then it is interpreted as an absolute path. ^If the path does not begin |
** with a '/' (meaning that the authority section is omitted from the URI) |
** with a '/' (meaning that the authority section is omitted from the URI) |
** then the path is interpreted as a relative path. | ** then the path is interpreted as a relative path. |
** ^On windows, the first component of an absolute path | ** ^(On windows, the first component of an absolute path |
** is a drive specification (e.g. "C:"). | ** is a drive specification (e.g. "C:").)^ |
** |
** |
** [[core URI query parameters]] |
** [[core URI query parameters]] |
** The query component of a URI may contain parameters that are interpreted |
** The query component of a URI may contain parameters that are interpreted |
** either by SQLite itself, or by a [VFS | custom VFS implementation]. |
** either by SQLite itself, or by a [VFS | custom VFS implementation]. |
** SQLite interprets the following three query parameters: | ** SQLite and its built-in [VFSes] interpret the |
| ** following query parameters: |
** |
** |
** <ul> |
** <ul> |
** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of |
** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of |
Line 2539 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3419 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
** present, then the VFS specified by the option takes precedence over |
** present, then the VFS specified by the option takes precedence over |
** the value passed as the fourth parameter to sqlite3_open_v2(). |
** the value passed as the fourth parameter to sqlite3_open_v2(). |
** |
** |
** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw" or | ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw", |
** "rwc". Attempting to set it to any other value is an error)^. | ** "rwc", or "memory". Attempting to set it to any other value is |
** ^If "ro" is specified, then the database is opened for read-only | ** an error)^. |
** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the | ** ^If "ro" is specified, then the database is opened for read-only |
** third argument to sqlite3_prepare_v2(). ^If the mode option is set to | ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the |
** "rw", then the database is opened for read-write (but not create) | ** third argument to sqlite3_open_v2(). ^If the mode option is set to |
** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had | ** "rw", then the database is opened for read-write (but not create) |
** been set. ^Value "rwc" is equivalent to setting both | ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had |
** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If sqlite3_open_v2() is | ** been set. ^Value "rwc" is equivalent to setting both |
** used, it is an error to specify a value for the mode parameter that is | ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is |
** less restrictive than that specified by the flags passed as the third | ** set to "memory" then a pure [in-memory database] that never reads |
** parameter. | ** or writes from disk is used. ^It is an error to specify a value for |
| ** the mode parameter that is less restrictive than that specified by |
| ** the flags passed in the third parameter to sqlite3_open_v2(). |
** |
** |
** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or |
** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or |
** "private". ^Setting it to "shared" is equivalent to setting the |
** "private". ^Setting it to "shared" is equivalent to setting the |
** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to |
** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to |
** sqlite3_open_v2(). ^Setting the cache parameter to "private" is | ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is |
** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. |
** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. |
** ^If sqlite3_open_v2() is used and the "cache" parameter is present in |
** ^If sqlite3_open_v2() is used and the "cache" parameter is present in |
** a URI filename, its value overrides any behaviour requested by setting | ** a URI filename, its value overrides any behavior requested by setting |
** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. |
** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. |
|
** |
|
** <li> <b>psow</b>: ^The psow parameter indicates whether or not the |
|
** [powersafe overwrite] property does or does not apply to the |
|
** storage media on which the database file resides. |
|
** |
|
** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter |
|
** which if set disables file locking in rollback journal modes. This |
|
** is useful for accessing a database on a filesystem that does not |
|
** support locking. Caution: Database corruption might result if two |
|
** or more processes write to the same database and any one of those |
|
** processes uses nolock=1. |
|
** |
|
** <li> <b>immutable</b>: ^The immutable parameter is a boolean query |
|
** parameter that indicates that the database file is stored on |
|
** read-only media. ^When immutable is set, SQLite assumes that the |
|
** database file cannot be changed, even by a process with higher |
|
** privilege, and so the database is opened read-only and all locking |
|
** and change detection is disabled. Caution: Setting the immutable |
|
** property on a database file that does in fact change can result |
|
** in incorrect query results and/or [SQLITE_CORRUPT] errors. |
|
** See also: [SQLITE_IOCAP_IMMUTABLE]. |
|
** |
** </ul> |
** </ul> |
** |
** |
** ^Specifying an unknown parameter in the query component of a URI is not an |
** ^Specifying an unknown parameter in the query component of a URI is not an |
Line 2571 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3475 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
** |
** |
** <table border="1" align=center cellpadding=5> |
** <table border="1" align=center cellpadding=5> |
** <tr><th> URI filenames <th> Results |
** <tr><th> URI filenames <th> Results |
** <tr><td> file:data.db <td> | ** <tr><td> file:data.db <td> |
** Open the file "data.db" in the current directory. |
** Open the file "data.db" in the current directory. |
** <tr><td> file:/home/fred/data.db<br> |
** <tr><td> file:/home/fred/data.db<br> |
** file:///home/fred/data.db <br> | ** file:///home/fred/data.db <br> |
** file://localhost/home/fred/data.db <br> <td> | ** file://localhost/home/fred/data.db <br> <td> |
** Open the database file "/home/fred/data.db". |
** Open the database file "/home/fred/data.db". |
** <tr><td> file://darkstar/home/fred/data.db <td> | ** <tr><td> file://darkstar/home/fred/data.db <td> |
** An error. "darkstar" is not a recognized authority. |
** An error. "darkstar" is not a recognized authority. |
** <tr><td style="white-space:nowrap"> | ** <tr><td style="white-space:nowrap"> |
** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db |
** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db |
** <td> Windows only: Open the file "data.db" on fred's desktop on drive |
** <td> Windows only: Open the file "data.db" on fred's desktop on drive |
** C:. Note that the %20 escaping in this example is not strictly | ** C:. Note that the %20 escaping in this example is not strictly |
** necessary - space characters can be used literally |
** necessary - space characters can be used literally |
** in URI filenames. |
** in URI filenames. |
** <tr><td> file:data.db?mode=ro&cache=private <td> | ** <tr><td> file:data.db?mode=ro&cache=private <td> |
** Open file "data.db" in the current directory for read-only access. |
** Open file "data.db" in the current directory for read-only access. |
** Regardless of whether or not shared-cache mode is enabled by |
** Regardless of whether or not shared-cache mode is enabled by |
** default, use a private cache. |
** default, use a private cache. |
** <tr><td> file:/home/fred/data.db?vfs=unix-nolock <td> | ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td> |
** Open file "/home/fred/data.db". Use the special VFS "unix-nolock". | ** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile" |
** <tr><td> file:data.db?mode=readonly <td> | ** that uses dot-files in place of posix advisory locking. |
| ** <tr><td> file:data.db?mode=readonly <td> |
** An error. "readonly" is not a valid option for the "mode" parameter. |
** An error. "readonly" is not a valid option for the "mode" parameter. |
** </table> |
** </table> |
** |
** |
** ^URI hexadecimal escape sequences (%HH) are supported within the path and |
** ^URI hexadecimal escape sequences (%HH) are supported within the path and |
** query components of a URI. A hexadecimal escape sequence consists of a |
** query components of a URI. A hexadecimal escape sequence consists of a |
** percent sign - "%" - followed by exactly two hexadecimal digits | ** percent sign - "%" - followed by exactly two hexadecimal digits |
** specifying an octet value. ^Before the path or query components of a |
** specifying an octet value. ^Before the path or query components of a |
** URI filename are interpreted, they are encoded using UTF-8 and all | ** URI filename are interpreted, they are encoded using UTF-8 and all |
** hexadecimal escape sequences replaced by a single byte containing the |
** hexadecimal escape sequences replaced by a single byte containing the |
** corresponding octet. If this process generates an invalid UTF-8 encoding, |
** corresponding octet. If this process generates an invalid UTF-8 encoding, |
** the results are undefined. |
** the results are undefined. |
Line 2609 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
Line 3514 SQLITE_API void sqlite3_progress_handler(sqlite3*, int
|
** codepage is currently defined. Filenames containing international |
** codepage is currently defined. Filenames containing international |
** characters must be converted to UTF-8 prior to passing them into |
** characters must be converted to UTF-8 prior to passing them into |
** sqlite3_open() or sqlite3_open_v2(). |
** sqlite3_open() or sqlite3_open_v2(). |
|
** |
|
** <b>Note to Windows Runtime users:</b> The temporary directory must be set |
|
** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various |
|
** features that require the use of temporary files may fail. |
|
** |
|
** See also: [sqlite3_temp_directory] |
*/ |
*/ |
SQLITE_API int sqlite3_open( |
SQLITE_API int sqlite3_open( |
const char *filename, /* Database filename (UTF-8) */ |
const char *filename, /* Database filename (UTF-8) */ |
Line 2628 SQLITE_API int sqlite3_open_v2(
|
Line 3539 SQLITE_API int sqlite3_open_v2(
|
/* |
/* |
** CAPI3REF: Obtain Values For URI Parameters |
** CAPI3REF: Obtain Values For URI Parameters |
** |
** |
** These are utility routines, useful to VFS implementations, that check | ** These are utility routines, useful to [VFS|custom VFS implementations], |
** to see if a database file was a URI that contained a specific query | ** that check if a database file was a URI that contained a specific query |
** parameter, and if so obtains the value of that query parameter. |
** parameter, and if so obtains the value of that query parameter. |
** |
** |
** If F is the database filename pointer passed into the xOpen() method of | ** The first parameter to these interfaces (hereafter referred to |
** a VFS implementation when the flags parameter to xOpen() has one or | ** as F) must be one of: |
** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and | ** <ul> |
** P is the name of the query parameter, then | ** <li> A database filename pointer created by the SQLite core and |
| ** passed into the xOpen() method of a VFS implemention, or |
| ** <li> A filename obtained from [sqlite3_db_filename()], or |
| ** <li> A new filename constructed using [sqlite3_create_filename()]. |
| ** </ul> |
| ** If the F parameter is not one of the above, then the behavior is |
| ** undefined and probably undesirable. Older versions of SQLite were |
| ** more tolerant of invalid F parameters than newer versions. |
| ** |
| ** If F is a suitable filename (as described in the previous paragraph) |
| ** and if P is the name of the query parameter, then |
** sqlite3_uri_parameter(F,P) returns the value of the P |
** sqlite3_uri_parameter(F,P) returns the value of the P |
** parameter if it exists or a NULL pointer if P does not appear as a | ** parameter if it exists or a NULL pointer if P does not appear as a |
** query parameter on F. If P is a query parameter of F | ** query parameter on F. If P is a query parameter of F and it |
** has no explicit value, then sqlite3_uri_parameter(F,P) returns |
** has no explicit value, then sqlite3_uri_parameter(F,P) returns |
** a pointer to an empty string. |
** a pointer to an empty string. |
** |
** |
** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean |
** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean |
** parameter and returns true (1) or false (0) according to the value |
** parameter and returns true (1) or false (0) according to the value |
** of P. The value of P is true if it is "yes" or "true" or "on" or | ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the |
** a non-zero number and is false otherwise. If P is not a query parameter | ** value of query parameter P is one of "yes", "true", or "on" in any |
** on F then sqlite3_uri_boolean(F,P,B) returns (B!=0). | ** case or if the value begins with a non-zero number. The |
| ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of |
| ** query parameter P is one of "no", "false", or "off" in any case or |
| ** if the value begins with a numeric zero. If P is not a query |
| ** parameter on F or if the value of P does not match any of the |
| ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). |
** |
** |
** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a |
** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a |
** 64-bit signed integer and returns that integer, or D if P does not |
** 64-bit signed integer and returns that integer, or D if P does not |
** exist. If the value of P is something other than an integer, then |
** exist. If the value of P is something other than an integer, then |
** zero is returned. |
** zero is returned. |
** | ** |
| ** The sqlite3_uri_key(F,N) returns a pointer to the name (not |
| ** the value) of the N-th query parameter for filename F, or a NULL |
| ** pointer if N is less than zero or greater than the number of query |
| ** parameters minus 1. The N value is zero-based so N should be 0 to obtain |
| ** the name of the first query parameter, 1 for the second parameter, and |
| ** so forth. |
| ** |
** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and |
** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and |
** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and |
** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and |
** is not a database file pathname pointer that SQLite passed into the xOpen | ** is not a database file pathname pointer that the SQLite core passed |
** VFS method, then the behavior of this routine is undefined and probably | ** into the xOpen VFS method, then the behavior of this routine is undefined |
** undesirable. | ** and probably undesirable. |
| ** |
| ** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F |
| ** parameter can also be the name of a rollback journal file or WAL file |
| ** in addition to the main database file. Prior to version 3.31.0, these |
| ** routines would only work if F was the name of the main database file. |
| ** When the F parameter is the name of the rollback journal or WAL file, |
| ** it has access to all the same query parameters as were found on the |
| ** main database file. |
| ** |
| ** See the [URI filename] documentation for additional information. |
*/ |
*/ |
SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); |
SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); |
SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); |
SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); |
SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); |
SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); |
|
SQLITE_API const char *sqlite3_uri_key(const char *zFilename, int N); |
|
|
|
/* |
|
** CAPI3REF: Translate filenames |
|
** |
|
** These routines are available to [VFS|custom VFS implementations] for |
|
** translating filenames between the main database file, the journal file, |
|
** and the WAL file. |
|
** |
|
** If F is the name of an sqlite database file, journal file, or WAL file |
|
** passed by the SQLite core into the VFS, then sqlite3_filename_database(F) |
|
** returns the name of the corresponding database file. |
|
** |
|
** If F is the name of an sqlite database file, journal file, or WAL file |
|
** passed by the SQLite core into the VFS, or if F is a database filename |
|
** obtained from [sqlite3_db_filename()], then sqlite3_filename_journal(F) |
|
** returns the name of the corresponding rollback journal file. |
|
** |
|
** If F is the name of an sqlite database file, journal file, or WAL file |
|
** that was passed by the SQLite core into the VFS, or if F is a database |
|
** filename obtained from [sqlite3_db_filename()], then |
|
** sqlite3_filename_wal(F) returns the name of the corresponding |
|
** WAL file. |
|
** |
|
** In all of the above, if F is not the name of a database, journal or WAL |
|
** filename passed into the VFS from the SQLite core and F is not the |
|
** return value from [sqlite3_db_filename()], then the result is |
|
** undefined and is likely a memory access violation. |
|
*/ |
|
SQLITE_API const char *sqlite3_filename_database(const char*); |
|
SQLITE_API const char *sqlite3_filename_journal(const char*); |
|
SQLITE_API const char *sqlite3_filename_wal(const char*); |
|
|
/* |
/* |
|
** CAPI3REF: Database File Corresponding To A Journal |
|
** |
|
** ^If X is the name of a rollback or WAL-mode journal file that is |
|
** passed into the xOpen method of [sqlite3_vfs], then |
|
** sqlite3_database_file_object(X) returns a pointer to the [sqlite3_file] |
|
** object that represents the main database file. |
|
** |
|
** This routine is intended for use in custom [VFS] implementations |
|
** only. It is not a general-purpose interface. |
|
** The argument sqlite3_file_object(X) must be a filename pointer that |
|
** has been passed into [sqlite3_vfs].xOpen method where the |
|
** flags parameter to xOpen contains one of the bits |
|
** [SQLITE_OPEN_MAIN_JOURNAL] or [SQLITE_OPEN_WAL]. Any other use |
|
** of this routine results in undefined and probably undesirable |
|
** behavior. |
|
*/ |
|
SQLITE_API sqlite3_file *sqlite3_database_file_object(const char*); |
|
|
|
/* |
|
** CAPI3REF: Create and Destroy VFS Filenames |
|
** |
|
** These interfces are provided for use by [VFS shim] implementations and |
|
** are not useful outside of that context. |
|
** |
|
** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of |
|
** database filename D with corresponding journal file J and WAL file W and |
|
** with N URI parameters key/values pairs in the array P. The result from |
|
** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that |
|
** is safe to pass to routines like: |
|
** <ul> |
|
** <li> [sqlite3_uri_parameter()], |
|
** <li> [sqlite3_uri_boolean()], |
|
** <li> [sqlite3_uri_int64()], |
|
** <li> [sqlite3_uri_key()], |
|
** <li> [sqlite3_filename_database()], |
|
** <li> [sqlite3_filename_journal()], or |
|
** <li> [sqlite3_filename_wal()]. |
|
** </ul> |
|
** If a memory allocation error occurs, sqlite3_create_filename() might |
|
** return a NULL pointer. The memory obtained from sqlite3_create_filename(X) |
|
** must be released by a corresponding call to sqlite3_free_filename(Y). |
|
** |
|
** The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array |
|
** of 2*N pointers to strings. Each pair of pointers in this array corresponds |
|
** to a key and value for a query parameter. The P parameter may be a NULL |
|
** pointer if N is zero. None of the 2*N pointers in the P array may be |
|
** NULL pointers and key pointers should not be empty strings. |
|
** None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may |
|
** be NULL pointers, though they can be empty strings. |
|
** |
|
** The sqlite3_free_filename(Y) routine releases a memory allocation |
|
** previously obtained from sqlite3_create_filename(). Invoking |
|
** sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op. |
|
** |
|
** If the Y parameter to sqlite3_free_filename(Y) is anything other |
|
** than a NULL pointer or a pointer previously acquired from |
|
** sqlite3_create_filename(), then bad things such as heap |
|
** corruption or segfaults may occur. The value Y should be |
|
** used again after sqlite3_free_filename(Y) has been called. This means |
|
** that if the [sqlite3_vfs.xOpen()] method of a VFS has been called using Y, |
|
** then the corresponding [sqlite3_module.xClose() method should also be |
|
** invoked prior to calling sqlite3_free_filename(Y). |
|
*/ |
|
SQLITE_API char *sqlite3_create_filename( |
|
const char *zDatabase, |
|
const char *zJournal, |
|
const char *zWal, |
|
int nParam, |
|
const char **azParam |
|
); |
|
SQLITE_API void sqlite3_free_filename(char*); |
|
|
|
/* |
** CAPI3REF: Error Codes And Messages |
** CAPI3REF: Error Codes And Messages |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_errcode() interface returns the numeric [result code] or | ** ^If the most recent sqlite3_* API call associated with |
** [extended result code] for the most recent failed sqlite3_* API call | ** [database connection] D failed, then the sqlite3_errcode(D) interface |
** associated with a [database connection]. If a prior API call failed | ** returns the numeric [result code] or [extended result code] for that |
** but the most recent API call succeeded, the return value from | ** API call. |
** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() | ** ^The sqlite3_extended_errcode() |
** interface is the same except that it always returns the | ** interface is the same except that it always returns the |
** [extended result code] even when extended result codes are |
** [extended result code] even when extended result codes are |
** disabled. |
** disabled. |
** |
** |
|
** The values returned by sqlite3_errcode() and/or |
|
** sqlite3_extended_errcode() might change with each API call. |
|
** Except, there are some interfaces that are guaranteed to never |
|
** change the value of the error code. The error-code preserving |
|
** interfaces are: |
|
** |
|
** <ul> |
|
** <li> sqlite3_errcode() |
|
** <li> sqlite3_extended_errcode() |
|
** <li> sqlite3_errmsg() |
|
** <li> sqlite3_errmsg16() |
|
** </ul> |
|
** |
** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language |
** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language |
** text that describes the error, as either UTF-8 or UTF-16 respectively. |
** text that describes the error, as either UTF-8 or UTF-16 respectively. |
** ^(Memory to hold the error message string is managed internally. |
** ^(Memory to hold the error message string is managed internally. |
Line 2683 SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*
|
Line 3744 SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*
|
** However, the error string might be overwritten or deallocated by |
** However, the error string might be overwritten or deallocated by |
** subsequent calls to other SQLite interface functions.)^ |
** subsequent calls to other SQLite interface functions.)^ |
** |
** |
|
** ^The sqlite3_errstr() interface returns the English-language text |
|
** that describes the [result code], as UTF-8. |
|
** ^(Memory to hold the error message string is managed internally |
|
** and must not be freed by the application)^. |
|
** |
** When the serialized [threading mode] is in use, it might be the |
** When the serialized [threading mode] is in use, it might be the |
** case that a second error occurs on a separate thread in between |
** case that a second error occurs on a separate thread in between |
** the time of the first error and the call to these interfaces. |
** the time of the first error and the call to these interfaces. |
Line 2701 SQLITE_API int sqlite3_errcode(sqlite3 *db);
|
Line 3767 SQLITE_API int sqlite3_errcode(sqlite3 *db);
|
SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); |
SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); |
SQLITE_API const char *sqlite3_errmsg(sqlite3*); |
SQLITE_API const char *sqlite3_errmsg(sqlite3*); |
SQLITE_API const void *sqlite3_errmsg16(sqlite3*); |
SQLITE_API const void *sqlite3_errmsg16(sqlite3*); |
|
SQLITE_API const char *sqlite3_errstr(int); |
|
|
/* |
/* |
** CAPI3REF: SQL Statement Object | ** CAPI3REF: Prepared Statement Object |
** KEYWORDS: {prepared statement} {prepared statements} |
** KEYWORDS: {prepared statement} {prepared statements} |
** |
** |
** An instance of this object represents a single SQL statement. | ** An instance of this object represents a single SQL statement that |
** This object is variously known as a "prepared statement" or a | ** has been compiled into binary form and is ready to be evaluated. |
** "compiled SQL statement" or simply as a "statement". | |
** |
** |
** The life of a statement object goes something like this: | ** Think of each SQL statement as a separate computer program. The |
| ** original SQL text is source code. A prepared statement object |
| ** is the compiled object code. All SQL must be converted into a |
| ** prepared statement before it can be run. |
** |
** |
|
** The life-cycle of a prepared statement object usually goes like this: |
|
** |
** <ol> |
** <ol> |
** <li> Create the object using [sqlite3_prepare_v2()] or a related | ** <li> Create the prepared statement object using [sqlite3_prepare_v2()]. |
** function. | ** <li> Bind values to [parameters] using the sqlite3_bind_*() |
** <li> Bind values to [host parameters] using the sqlite3_bind_*() | |
** interfaces. |
** interfaces. |
** <li> Run the SQL by calling [sqlite3_step()] one or more times. |
** <li> Run the SQL by calling [sqlite3_step()] one or more times. |
** <li> Reset the statement using [sqlite3_reset()] then go back | ** <li> Reset the prepared statement using [sqlite3_reset()] then go back |
** to step 2. Do this zero or more times. |
** to step 2. Do this zero or more times. |
** <li> Destroy the object using [sqlite3_finalize()]. |
** <li> Destroy the object using [sqlite3_finalize()]. |
** </ol> |
** </ol> |
** |
|
** Refer to documentation on individual methods above for additional |
|
** information. |
|
*/ |
*/ |
typedef struct sqlite3_stmt sqlite3_stmt; |
typedef struct sqlite3_stmt sqlite3_stmt; |
|
|
/* |
/* |
** CAPI3REF: Run-time Limits |
** CAPI3REF: Run-time Limits |
|
** METHOD: sqlite3 |
** |
** |
** ^(This interface allows the size of various constructs to be limited |
** ^(This interface allows the size of various constructs to be limited |
** on a connection by connection basis. The first parameter is the |
** on a connection by connection basis. The first parameter is the |
Line 2739 typedef struct sqlite3_stmt sqlite3_stmt;
|
Line 3807 typedef struct sqlite3_stmt sqlite3_stmt;
|
** new limit for that construct.)^ |
** new limit for that construct.)^ |
** |
** |
** ^If the new limit is a negative number, the limit is unchanged. |
** ^If the new limit is a negative number, the limit is unchanged. |
** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a | ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a |
** [limits | hard upper bound] |
** [limits | hard upper bound] |
** set at compile-time by a C preprocessor macro called |
** set at compile-time by a C preprocessor macro called |
** [limits | SQLITE_MAX_<i>NAME</i>]. |
** [limits | SQLITE_MAX_<i>NAME</i>]. |
Line 2747 typedef struct sqlite3_stmt sqlite3_stmt;
|
Line 3815 typedef struct sqlite3_stmt sqlite3_stmt;
|
** ^Attempts to increase a limit above its hard upper bound are |
** ^Attempts to increase a limit above its hard upper bound are |
** silently truncated to the hard upper bound. |
** silently truncated to the hard upper bound. |
** |
** |
** ^Regardless of whether or not the limit was changed, the | ** ^Regardless of whether or not the limit was changed, the |
** [sqlite3_limit()] interface returns the prior value of the limit. |
** [sqlite3_limit()] interface returns the prior value of the limit. |
** ^Hence, to find the current value of a limit without changing it, |
** ^Hence, to find the current value of a limit without changing it, |
** simply invoke this interface with the third parameter set to -1. |
** simply invoke this interface with the third parameter set to -1. |
Line 2798 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
Line 3866 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
** |
** |
** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> |
** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> |
** <dd>The maximum number of instructions in a virtual machine program |
** <dd>The maximum number of instructions in a virtual machine program |
** used to implement an SQL statement. This limit is not currently | ** used to implement an SQL statement. If [sqlite3_prepare_v2()] or |
** enforced, though that might be added in some future release of | ** the equivalent tries to allocate space for more than this many opcodes |
** SQLite.</dd>)^ | ** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^ |
** |
** |
** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> |
** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> |
** <dd>The maximum number of arguments on a function.</dd>)^ |
** <dd>The maximum number of arguments on a function.</dd>)^ |
Line 2819 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
Line 3887 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
** |
** |
** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> |
** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> |
** <dd>The maximum depth of recursion for triggers.</dd>)^ |
** <dd>The maximum depth of recursion for triggers.</dd>)^ |
|
** |
|
** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt> |
|
** <dd>The maximum number of auxiliary worker threads that a single |
|
** [prepared statement] may start.</dd>)^ |
** </dl> |
** </dl> |
*/ |
*/ |
#define SQLITE_LIMIT_LENGTH 0 |
#define SQLITE_LIMIT_LENGTH 0 |
Line 2832 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
Line 3904 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 |
#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 |
#define SQLITE_LIMIT_VARIABLE_NUMBER 9 |
#define SQLITE_LIMIT_VARIABLE_NUMBER 9 |
#define SQLITE_LIMIT_TRIGGER_DEPTH 10 |
#define SQLITE_LIMIT_TRIGGER_DEPTH 10 |
|
#define SQLITE_LIMIT_WORKER_THREADS 11 |
|
|
/* |
/* |
|
** CAPI3REF: Prepare Flags |
|
** |
|
** These constants define various flags that can be passed into |
|
** "prepFlags" parameter of the [sqlite3_prepare_v3()] and |
|
** [sqlite3_prepare16_v3()] interfaces. |
|
** |
|
** New flags may be added in future releases of SQLite. |
|
** |
|
** <dl> |
|
** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt> |
|
** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner |
|
** that the prepared statement will be retained for a long time and |
|
** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()] |
|
** and [sqlite3_prepare16_v3()] assume that the prepared statement will |
|
** be used just once or at most a few times and then destroyed using |
|
** [sqlite3_finalize()] relatively soon. The current implementation acts |
|
** on this hint by avoiding the use of [lookaside memory] so as not to |
|
** deplete the limited store of lookaside memory. Future versions of |
|
** SQLite may act on this hint differently. |
|
** |
|
** [[SQLITE_PREPARE_NORMALIZE]] <dt>SQLITE_PREPARE_NORMALIZE</dt> |
|
** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used |
|
** to be required for any prepared statement that wanted to use the |
|
** [sqlite3_normalized_sql()] interface. However, the |
|
** [sqlite3_normalized_sql()] interface is now available to all |
|
** prepared statements, regardless of whether or not they use this |
|
** flag. |
|
** |
|
** [[SQLITE_PREPARE_NO_VTAB]] <dt>SQLITE_PREPARE_NO_VTAB</dt> |
|
** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler |
|
** to return an error (error code SQLITE_ERROR) if the statement uses |
|
** any virtual tables. |
|
** </dl> |
|
*/ |
|
#define SQLITE_PREPARE_PERSISTENT 0x01 |
|
#define SQLITE_PREPARE_NORMALIZE 0x02 |
|
#define SQLITE_PREPARE_NO_VTAB 0x04 |
|
|
|
/* |
** CAPI3REF: Compiling An SQL Statement |
** CAPI3REF: Compiling An SQL Statement |
** KEYWORDS: {SQL statement compiler} |
** KEYWORDS: {SQL statement compiler} |
|
** METHOD: sqlite3 |
|
** CONSTRUCTOR: sqlite3_stmt |
** |
** |
** To execute an SQL query, it must first be compiled into a byte-code | ** To execute an SQL statement, it must first be compiled into a byte-code |
** program using one of these routines. | ** program using one of these routines. Or, in other words, these routines |
| ** are constructors for the [prepared statement] object. |
** |
** |
|
** The preferred routine to use is [sqlite3_prepare_v2()]. The |
|
** [sqlite3_prepare()] interface is legacy and should be avoided. |
|
** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used |
|
** for special purposes. |
|
** |
|
** The use of the UTF-8 interfaces is preferred, as SQLite currently |
|
** does all parsing using UTF-8. The UTF-16 interfaces are provided |
|
** as a convenience. The UTF-16 interfaces work by converting the |
|
** input text into UTF-8, then invoking the corresponding UTF-8 interface. |
|
** |
** The first argument, "db", is a [database connection] obtained from a |
** The first argument, "db", is a [database connection] obtained from a |
** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or |
** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or |
** [sqlite3_open16()]. The database connection must not have been closed. |
** [sqlite3_open16()]. The database connection must not have been closed. |
** |
** |
** The second argument, "zSql", is the statement to be compiled, encoded |
** The second argument, "zSql", is the statement to be compiled, encoded |
** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() | ** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(), |
** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() | ** and sqlite3_prepare_v3() |
** use UTF-16. | ** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(), |
| ** and sqlite3_prepare16_v3() use UTF-16. |
** |
** |
** ^If the nByte argument is less than zero, then zSql is read up to the | ** ^If the nByte argument is negative, then zSql is read up to the |
** first zero terminator. ^If nByte is non-negative, then it is the maximum | ** first zero terminator. ^If nByte is positive, then it is the |
** number of bytes read from zSql. ^When nByte is non-negative, the | ** number of bytes read from zSql. ^If nByte is zero, then no prepared |
** zSql string ends at either the first '\000' or '\u0000' character or | ** statement is generated. |
** the nByte-th byte, whichever comes first. If the caller knows | ** If the caller knows that the supplied string is nul-terminated, then |
** that the supplied string is nul-terminated, then there is a small | ** there is a small performance advantage to passing an nByte parameter that |
** performance advantage to be gained by passing an nByte parameter that | ** is the number of bytes in the input string <i>including</i> |
** is equal to the number of bytes in the input string <i>including</i> | ** the nul-terminator. |
** the nul-terminator bytes as this saves SQLite from having to | |
** make a copy of the input string. | |
** |
** |
** ^If pzTail is not NULL then *pzTail is made to point to the first byte |
** ^If pzTail is not NULL then *pzTail is made to point to the first byte |
** past the end of the first SQL statement in zSql. These routines only |
** past the end of the first SQL statement in zSql. These routines only |
Line 2876 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
Line 4000 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; |
** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; |
** otherwise an [error code] is returned. |
** otherwise an [error code] is returned. |
** |
** |
** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are | ** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(), |
** recommended for all new programs. The two older interfaces are retained | ** and sqlite3_prepare16_v3() interfaces are recommended for all new programs. |
** for backwards compatibility, but their use is discouraged. | ** The older interfaces (sqlite3_prepare() and sqlite3_prepare16()) |
** ^In the "v2" interfaces, the prepared statement | ** are retained for backwards compatibility, but their use is discouraged. |
| ** ^In the "vX" interfaces, the prepared statement |
** that is returned (the [sqlite3_stmt] object) contains a copy of the |
** that is returned (the [sqlite3_stmt] object) contains a copy of the |
** original SQL text. This causes the [sqlite3_step()] interface to |
** original SQL text. This causes the [sqlite3_step()] interface to |
** behave differently in three ways: |
** behave differently in three ways: |
Line 2888 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
Line 4013 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
** <li> |
** <li> |
** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it |
** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it |
** always used to do, [sqlite3_step()] will automatically recompile the SQL |
** always used to do, [sqlite3_step()] will automatically recompile the SQL |
** statement and try to run it again. | ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY] |
| ** retries will occur before sqlite3_step() gives up and returns an error. |
** </li> |
** </li> |
** |
** |
** <li> |
** <li> |
Line 2901 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
Line 4027 SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
|
** </li> |
** </li> |
** |
** |
** <li> |
** <li> |
** ^If the specific value bound to [parameter | host parameter] in the | ** ^If the specific value bound to a [parameter | host parameter] in the |
** WHERE clause might influence the choice of query plan for a statement, |
** WHERE clause might influence the choice of query plan for a statement, |
** then the statement will be automatically recompiled, as if there had been | ** then the statement will be automatically recompiled, as if there had been |
** a schema change, on the first [sqlite3_step()] call following any change | ** a schema change, on the first [sqlite3_step()] call following any change |
** to the [sqlite3_bind_text | bindings] of that [parameter]. | ** to the [sqlite3_bind_text | bindings] of that [parameter]. |
** ^The specific value of WHERE-clause [parameter] might influence the | ** ^The specific value of a WHERE-clause [parameter] might influence the |
** choice of query plan if the parameter is the left-hand side of a [LIKE] |
** choice of query plan if the parameter is the left-hand side of a [LIKE] |
** or [GLOB] operator or if the parameter is compared to an indexed column |
** or [GLOB] operator or if the parameter is compared to an indexed column |
** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled. | ** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled. |
** the | |
** </li> |
** </li> |
** </ol> |
** </ol> |
|
** |
|
** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having |
|
** the extra prepFlags parameter, which is a bit array consisting of zero or |
|
** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The |
|
** sqlite3_prepare_v2() interface works exactly the same as |
|
** sqlite3_prepare_v3() with a zero prepFlags parameter. |
*/ |
*/ |
SQLITE_API int sqlite3_prepare( |
SQLITE_API int sqlite3_prepare( |
sqlite3 *db, /* Database handle */ |
sqlite3 *db, /* Database handle */ |
Line 2928 SQLITE_API int sqlite3_prepare_v2(
|
Line 4059 SQLITE_API int sqlite3_prepare_v2(
|
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
const char **pzTail /* OUT: Pointer to unused portion of zSql */ |
const char **pzTail /* OUT: Pointer to unused portion of zSql */ |
); |
); |
|
SQLITE_API int sqlite3_prepare_v3( |
|
sqlite3 *db, /* Database handle */ |
|
const char *zSql, /* SQL statement, UTF-8 encoded */ |
|
int nByte, /* Maximum length of zSql in bytes. */ |
|
unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ |
|
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
|
const char **pzTail /* OUT: Pointer to unused portion of zSql */ |
|
); |
SQLITE_API int sqlite3_prepare16( |
SQLITE_API int sqlite3_prepare16( |
sqlite3 *db, /* Database handle */ |
sqlite3 *db, /* Database handle */ |
const void *zSql, /* SQL statement, UTF-16 encoded */ |
const void *zSql, /* SQL statement, UTF-16 encoded */ |
Line 2942 SQLITE_API int sqlite3_prepare16_v2(
|
Line 4081 SQLITE_API int sqlite3_prepare16_v2(
|
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
); |
); |
|
SQLITE_API int sqlite3_prepare16_v3( |
|
sqlite3 *db, /* Database handle */ |
|
const void *zSql, /* SQL statement, UTF-16 encoded */ |
|
int nByte, /* Maximum length of zSql in bytes. */ |
|
unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ |
|
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
|
const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
|
); |
|
|
/* |
/* |
** CAPI3REF: Retrieving Statement SQL |
** CAPI3REF: Retrieving Statement SQL |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^This interface can be used to retrieve a saved copy of the original | ** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8 |
** SQL text used to create a [prepared statement] if that statement was | ** SQL text used to create [prepared statement] P if P was |
** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. | ** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], |
| ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()]. |
| ** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8 |
| ** string containing the SQL text of prepared statement P with |
| ** [bound parameters] expanded. |
| ** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8 |
| ** string containing the normalized SQL text of prepared statement P. The |
| ** semantics used to normalize a SQL statement are unspecified and subject |
| ** to change. At a minimum, literal values will be replaced with suitable |
| ** placeholders. |
| ** |
| ** ^(For example, if a prepared statement is created using the SQL |
| ** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345 |
| ** and parameter :xyz is unbound, then sqlite3_sql() will return |
| ** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql() |
| ** will return "SELECT 2345,NULL".)^ |
| ** |
| ** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory |
| ** is available to hold the result, or if the result would exceed the |
| ** the maximum string length determined by the [SQLITE_LIMIT_LENGTH]. |
| ** |
| ** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of |
| ** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time |
| ** option causes sqlite3_expanded_sql() to always return NULL. |
| ** |
| ** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P) |
| ** are managed by SQLite and are automatically freed when the prepared |
| ** statement is finalized. |
| ** ^The string returned by sqlite3_expanded_sql(P), on the other hand, |
| ** is obtained from [sqlite3_malloc()] and must be free by the application |
| ** by passing it to [sqlite3_free()]. |
*/ |
*/ |
SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); |
SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); |
|
SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt); |
|
SQLITE_API const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt); |
|
|
/* |
/* |
** CAPI3REF: Determine If An SQL Statement Writes The Database |
** CAPI3REF: Determine If An SQL Statement Writes The Database |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if |
** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if |
** and only if the [prepared statement] X makes no direct changes to |
** and only if the [prepared statement] X makes no direct changes to |
** the content of the database file. |
** the content of the database file. |
** |
** |
** Note that [application-defined SQL functions] or |
** Note that [application-defined SQL functions] or |
** [virtual tables] might change the database indirectly as a side effect. | ** [virtual tables] might change the database indirectly as a side effect. |
** ^(For example, if an application defines a function "eval()" that | ** ^(For example, if an application defines a function "eval()" that |
** calls [sqlite3_exec()], then the following SQL statement would |
** calls [sqlite3_exec()], then the following SQL statement would |
** change the database file through side-effects: |
** change the database file through side-effects: |
** |
** |
Line 2975 SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt
|
Line 4156 SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt
|
** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], |
** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], |
** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, |
** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, |
** since the statements themselves do not actually modify the database but |
** since the statements themselves do not actually modify the database but |
** rather they control the timing of when other statements modify the | ** rather they control the timing of when other statements modify the |
** database. ^The [ATTACH] and [DETACH] statements also cause |
** database. ^The [ATTACH] and [DETACH] statements also cause |
** sqlite3_stmt_readonly() to return true since, while those statements |
** sqlite3_stmt_readonly() to return true since, while those statements |
** change the configuration of a database connection, they do not make | ** change the configuration of a database connection, they do not make |
** changes to the content of the database files on disk. |
** changes to the content of the database files on disk. |
|
** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since |
|
** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and |
|
** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so |
|
** sqlite3_stmt_readonly() returns false for those commands. |
*/ |
*/ |
SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); |
SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); |
|
|
/* |
/* |
|
** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement |
|
** METHOD: sqlite3_stmt |
|
** |
|
** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the |
|
** prepared statement S is an EXPLAIN statement, or 2 if the |
|
** statement S is an EXPLAIN QUERY PLAN. |
|
** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is |
|
** an ordinary statement or a NULL pointer. |
|
*/ |
|
SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt); |
|
|
|
/* |
** CAPI3REF: Determine If A Prepared Statement Has Been Reset |
** CAPI3REF: Determine If A Prepared Statement Has Been Reset |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the |
** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the |
** [prepared statement] S has been stepped at least once using | ** [prepared statement] S has been stepped at least once using |
** [sqlite3_step(S)] but has not run to completion and/or has not | ** [sqlite3_step(S)] but has neither run to completion (returned |
| ** [SQLITE_DONE] from [sqlite3_step(S)]) nor |
** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) |
** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) |
** interface returns false if S is a NULL pointer. If S is not a | ** interface returns false if S is a NULL pointer. If S is not a |
** NULL pointer and is not a pointer to a valid [prepared statement] |
** NULL pointer and is not a pointer to a valid [prepared statement] |
** object, then the behavior is undefined and probably undesirable. |
** object, then the behavior is undefined and probably undesirable. |
** |
** |
** This interface can be used in combination [sqlite3_next_stmt()] |
** This interface can be used in combination [sqlite3_next_stmt()] |
** to locate all prepared statements associated with a database | ** to locate all prepared statements associated with a database |
** connection that are in need of being reset. This can be used, |
** connection that are in need of being reset. This can be used, |
** for example, in diagnostic routines to search for prepared | ** for example, in diagnostic routines to search for prepared |
** statements that are holding a transaction open. |
** statements that are holding a transaction open. |
*/ |
*/ |
SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); |
SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); |
Line 3015 SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
|
Line 4214 SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
|
** Some interfaces require a protected sqlite3_value. Other interfaces |
** Some interfaces require a protected sqlite3_value. Other interfaces |
** will accept either a protected or an unprotected sqlite3_value. |
** will accept either a protected or an unprotected sqlite3_value. |
** Every interface that accepts sqlite3_value arguments specifies |
** Every interface that accepts sqlite3_value arguments specifies |
** whether or not it requires a protected sqlite3_value. | ** whether or not it requires a protected sqlite3_value. The |
| ** [sqlite3_value_dup()] interface can be used to construct a new |
| ** protected sqlite3_value from an unprotected sqlite3_value. |
** |
** |
** The terms "protected" and "unprotected" refer to whether or not |
** The terms "protected" and "unprotected" refer to whether or not |
** a mutex is held. An internal mutex is held for a protected |
** a mutex is held. An internal mutex is held for a protected |
** sqlite3_value object but no mutex is held for an unprotected |
** sqlite3_value object but no mutex is held for an unprotected |
** sqlite3_value object. If SQLite is compiled to be single-threaded |
** sqlite3_value object. If SQLite is compiled to be single-threaded |
** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) |
** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) |
** or if SQLite is run in one of reduced mutex modes | ** or if SQLite is run in one of reduced mutex modes |
** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] |
** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] |
** then there is no distinction between protected and unprotected |
** then there is no distinction between protected and unprotected |
** sqlite3_value objects and they can be used interchangeably. However, |
** sqlite3_value objects and they can be used interchangeably. However, |
Line 3034 SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
|
Line 4235 SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
|
** implementation of [application-defined SQL functions] are protected. |
** implementation of [application-defined SQL functions] are protected. |
** ^The sqlite3_value object returned by |
** ^The sqlite3_value object returned by |
** [sqlite3_column_value()] is unprotected. |
** [sqlite3_column_value()] is unprotected. |
** Unprotected sqlite3_value objects may only be used with | ** Unprotected sqlite3_value objects may only be used as arguments |
** [sqlite3_result_value()] and [sqlite3_bind_value()]. | ** to [sqlite3_result_value()], [sqlite3_bind_value()], and |
| ** [sqlite3_value_dup()]. |
** The [sqlite3_value_blob | sqlite3_value_type()] family of |
** The [sqlite3_value_blob | sqlite3_value_type()] family of |
** interfaces require protected sqlite3_value objects. |
** interfaces require protected sqlite3_value objects. |
*/ |
*/ |
typedef struct Mem sqlite3_value; | typedef struct sqlite3_value sqlite3_value; |
|
|
/* |
/* |
** CAPI3REF: SQL Function Context Object |
** CAPI3REF: SQL Function Context Object |
Line 3059 typedef struct sqlite3_context sqlite3_context;
|
Line 4261 typedef struct sqlite3_context sqlite3_context;
|
** CAPI3REF: Binding Values To Prepared Statements |
** CAPI3REF: Binding Values To Prepared Statements |
** KEYWORDS: {host parameter} {host parameters} {host parameter name} |
** KEYWORDS: {host parameter} {host parameters} {host parameter name} |
** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} |
** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, |
** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, |
** literals may be replaced by a [parameter] that matches one of following |
** literals may be replaced by a [parameter] that matches one of following |
Line 3089 typedef struct sqlite3_context sqlite3_context;
|
Line 4292 typedef struct sqlite3_context sqlite3_context;
|
** [sqlite3_bind_parameter_index()] API if desired. ^The index |
** [sqlite3_bind_parameter_index()] API if desired. ^The index |
** for "?NNN" parameters is the value of NNN. |
** for "?NNN" parameters is the value of NNN. |
** ^The NNN value must be between 1 and the [sqlite3_limit()] |
** ^The NNN value must be between 1 and the [sqlite3_limit()] |
** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). | ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 32766). |
** |
** |
** ^The third argument is the value to bind to the parameter. |
** ^The third argument is the value to bind to the parameter. |
|
** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16() |
|
** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter |
|
** is ignored and the end result is the same as sqlite3_bind_null(). |
|
** ^If the third parameter to sqlite3_bind_text() is not NULL, then |
|
** it should be a pointer to well-formed UTF8 text. |
|
** ^If the third parameter to sqlite3_bind_text16() is not NULL, then |
|
** it should be a pointer to well-formed UTF16 text. |
|
** ^If the third parameter to sqlite3_bind_text64() is not NULL, then |
|
** it should be a pointer to a well-formed unicode string that is |
|
** either UTF8 if the sixth parameter is SQLITE_UTF8, or UTF16 |
|
** otherwise. |
** |
** |
|
** [[byte-order determination rules]] ^The byte-order of |
|
** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF) |
|
** found in first character, which is removed, or in the absence of a BOM |
|
** the byte order is the native byte order of the host |
|
** machine for sqlite3_bind_text16() or the byte order specified in |
|
** the 6th parameter for sqlite3_bind_text64().)^ |
|
** ^If UTF16 input text contains invalid unicode |
|
** characters, then SQLite might change those invalid characters |
|
** into the unicode replacement character: U+FFFD. |
|
** |
** ^(In those routines that have a fourth argument, its value is the |
** ^(In those routines that have a fourth argument, its value is the |
** number of bytes in the parameter. To be clear: the value is the |
** number of bytes in the parameter. To be clear: the value is the |
** number of <u>bytes</u> in the value, not the number of characters.)^ |
** number of <u>bytes</u> in the value, not the number of characters.)^ |
** ^If the fourth parameter is negative, the length of the string is | ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16() |
| ** is negative, then the length of the string is |
** the number of bytes up to the first zero terminator. |
** the number of bytes up to the first zero terminator. |
|
** If the fourth parameter to sqlite3_bind_blob() is negative, then |
|
** the behavior is undefined. |
** If a non-negative fourth parameter is provided to sqlite3_bind_text() |
** If a non-negative fourth parameter is provided to sqlite3_bind_text() |
** or sqlite3_bind_text16() then that parameter must be the byte offset | ** or sqlite3_bind_text16() or sqlite3_bind_text64() then |
| ** that parameter must be the byte offset |
** where the NUL terminator would occur assuming the string were NUL |
** where the NUL terminator would occur assuming the string were NUL |
** terminated. If any NUL characters occur at byte offsets less than | ** terminated. If any NUL characters occurs at byte offsets less than |
** the value of the fourth parameter then the resulting string value will |
** the value of the fourth parameter then the resulting string value will |
** contain embedded NULs. The result of expressions involving strings |
** contain embedded NULs. The result of expressions involving strings |
** with embedded NULs is undefined. |
** with embedded NULs is undefined. |
** |
** |
** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and | ** ^The fifth argument to the BLOB and string binding interfaces |
** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or | ** is a destructor used to dispose of the BLOB or |
** string after SQLite has finished with it. ^The destructor is called |
** string after SQLite has finished with it. ^The destructor is called |
** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(), | ** to dispose of the BLOB or string even if the call to the bind API fails, |
** sqlite3_bind_text(), or sqlite3_bind_text16() fails. | ** except the destructor is not called if the third parameter is a NULL |
| ** pointer or the fourth parameter is negative. |
** ^If the fifth argument is |
** ^If the fifth argument is |
** the special value [SQLITE_STATIC], then SQLite assumes that the |
** the special value [SQLITE_STATIC], then SQLite assumes that the |
** information is in static, unmanaged space and does not need to be freed. |
** information is in static, unmanaged space and does not need to be freed. |
Line 3118 typedef struct sqlite3_context sqlite3_context;
|
Line 4347 typedef struct sqlite3_context sqlite3_context;
|
** SQLite makes its own private copy of the data immediately, before |
** SQLite makes its own private copy of the data immediately, before |
** the sqlite3_bind_*() routine returns. |
** the sqlite3_bind_*() routine returns. |
** |
** |
|
** ^The sixth argument to sqlite3_bind_text64() must be one of |
|
** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE] |
|
** to specify the encoding of the text in the third parameter. If |
|
** the sixth argument to sqlite3_bind_text64() is not one of the |
|
** allowed values shown above, or if the text encoding is different |
|
** from the encoding specified by the sixth parameter, then the behavior |
|
** is undefined. |
|
** |
** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that |
** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that |
** is filled with zeroes. ^A zeroblob uses a fixed amount of memory |
** is filled with zeroes. ^A zeroblob uses a fixed amount of memory |
** (just an integer to hold its size) while it is being processed. |
** (just an integer to hold its size) while it is being processed. |
Line 3126 typedef struct sqlite3_context sqlite3_context;
|
Line 4363 typedef struct sqlite3_context sqlite3_context;
|
** [sqlite3_blob_open | incremental BLOB I/O] routines. |
** [sqlite3_blob_open | incremental BLOB I/O] routines. |
** ^A negative value for the zeroblob results in a zero-length BLOB. |
** ^A negative value for the zeroblob results in a zero-length BLOB. |
** |
** |
|
** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in |
|
** [prepared statement] S to have an SQL value of NULL, but to also be |
|
** associated with the pointer P of type T. ^D is either a NULL pointer or |
|
** a pointer to a destructor function for P. ^SQLite will invoke the |
|
** destructor D with a single argument of P when it is finished using |
|
** P. The T parameter should be a static string, preferably a string |
|
** literal. The sqlite3_bind_pointer() routine is part of the |
|
** [pointer passing interface] added for SQLite 3.20.0. |
|
** |
** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer |
** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer |
** for the [prepared statement] or with a prepared statement for which |
** for the [prepared statement] or with a prepared statement for which |
** [sqlite3_step()] has been called more recently than [sqlite3_reset()], |
** [sqlite3_step()] has been called more recently than [sqlite3_reset()], |
Line 3138 typedef struct sqlite3_context sqlite3_context;
|
Line 4384 typedef struct sqlite3_context sqlite3_context;
|
** |
** |
** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an |
** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an |
** [error code] if anything goes wrong. |
** [error code] if anything goes wrong. |
|
** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB |
|
** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or |
|
** [SQLITE_MAX_LENGTH]. |
** ^[SQLITE_RANGE] is returned if the parameter |
** ^[SQLITE_RANGE] is returned if the parameter |
** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. |
** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. |
** |
** |
Line 3145 typedef struct sqlite3_context sqlite3_context;
|
Line 4394 typedef struct sqlite3_context sqlite3_context;
|
** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. |
** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. |
*/ |
*/ |
SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); |
SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); |
|
SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64, |
|
void(*)(void*)); |
SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); |
SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); |
SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); |
SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); |
SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); |
SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); |
SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); |
SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); |
SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); | SQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*)); |
SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); |
SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); |
|
SQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64, |
|
void(*)(void*), unsigned char encoding); |
SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); |
SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); |
|
SQLITE_API int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*)); |
SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); |
SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); |
|
SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64); |
|
|
/* |
/* |
** CAPI3REF: Number Of SQL Parameters |
** CAPI3REF: Number Of SQL Parameters |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^This routine can be used to find the number of [SQL parameters] |
** ^This routine can be used to find the number of [SQL parameters] |
** in a [prepared statement]. SQL parameters are tokens of the |
** in a [prepared statement]. SQL parameters are tokens of the |
Line 3176 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_st
|
Line 4432 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_st
|
|
|
/* |
/* |
** CAPI3REF: Name Of A Host Parameter |
** CAPI3REF: Name Of A Host Parameter |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^The sqlite3_bind_parameter_name(P,N) interface returns |
** ^The sqlite3_bind_parameter_name(P,N) interface returns |
** the name of the N-th [SQL parameter] in the [prepared statement] P. |
** the name of the N-th [SQL parameter] in the [prepared statement] P. |
Line 3192 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_st
|
Line 4449 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_st
|
** ^If the value N is out of range or if the N-th parameter is |
** ^If the value N is out of range or if the N-th parameter is |
** nameless, then NULL is returned. ^The returned string is |
** nameless, then NULL is returned. ^The returned string is |
** always in UTF-8 encoding even if the named parameter was |
** always in UTF-8 encoding even if the named parameter was |
** originally specified as UTF-16 in [sqlite3_prepare16()] or | ** originally specified as UTF-16 in [sqlite3_prepare16()], |
** [sqlite3_prepare16_v2()]. | ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()]. |
** |
** |
** See also: [sqlite3_bind_blob|sqlite3_bind()], |
** See also: [sqlite3_bind_blob|sqlite3_bind()], |
** [sqlite3_bind_parameter_count()], and |
** [sqlite3_bind_parameter_count()], and |
Line 3203 SQLITE_API const char *sqlite3_bind_parameter_name(sql
|
Line 4460 SQLITE_API const char *sqlite3_bind_parameter_name(sql
|
|
|
/* |
/* |
** CAPI3REF: Index Of A Parameter With A Given Name |
** CAPI3REF: Index Of A Parameter With A Given Name |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^Return the index of an SQL parameter given its name. ^The |
** ^Return the index of an SQL parameter given its name. ^The |
** index value returned is suitable for use as the second |
** index value returned is suitable for use as the second |
** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero |
** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero |
** is returned if no matching parameter is found. ^The parameter |
** is returned if no matching parameter is found. ^The parameter |
** name must be given in UTF-8 even if the original statement |
** name must be given in UTF-8 even if the original statement |
** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. | ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or |
| ** [sqlite3_prepare16_v3()]. |
** |
** |
** See also: [sqlite3_bind_blob|sqlite3_bind()], |
** See also: [sqlite3_bind_blob|sqlite3_bind()], |
** [sqlite3_bind_parameter_count()], and |
** [sqlite3_bind_parameter_count()], and |
** [sqlite3_bind_parameter_index()]. | ** [sqlite3_bind_parameter_name()]. |
*/ |
*/ |
SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); |
SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); |
|
|
/* |
/* |
** CAPI3REF: Reset All Bindings On A Prepared Statement |
** CAPI3REF: Reset All Bindings On A Prepared Statement |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset |
** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset |
** the [sqlite3_bind_blob | bindings] on a [prepared statement]. |
** the [sqlite3_bind_blob | bindings] on a [prepared statement]. |
Line 3228 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
|
Line 4488 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
|
|
|
/* |
/* |
** CAPI3REF: Number Of Columns In A Result Set |
** CAPI3REF: Number Of Columns In A Result Set |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^Return the number of columns in the result set returned by the |
** ^Return the number of columns in the result set returned by the |
** [prepared statement]. ^This routine returns 0 if pStmt is an SQL | ** [prepared statement]. ^If this routine returns 0, that means the |
** statement that does not return data (for example an [UPDATE]). | ** [prepared statement] returns no data (for example an [UPDATE]). |
| ** ^However, just because this routine returns a positive number does not |
| ** mean that one or more rows of data will be returned. ^A SELECT statement |
| ** will always have a positive sqlite3_column_count() but depending on the |
| ** WHERE clause constraints and the table content, it might return no rows. |
** |
** |
** See also: [sqlite3_data_count()] |
** See also: [sqlite3_data_count()] |
*/ |
*/ |
Line 3239 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStm
|
Line 4504 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStm
|
|
|
/* |
/* |
** CAPI3REF: Column Names In A Result Set |
** CAPI3REF: Column Names In A Result Set |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^These routines return the name assigned to a particular column |
** ^These routines return the name assigned to a particular column |
** in the result set of a [SELECT] statement. ^The sqlite3_column_name() |
** in the result set of a [SELECT] statement. ^The sqlite3_column_name() |
Line 3268 SQLITE_API const void *sqlite3_column_name16(sqlite3_s
|
Line 4534 SQLITE_API const void *sqlite3_column_name16(sqlite3_s
|
|
|
/* |
/* |
** CAPI3REF: Source Of Data In A Query Result |
** CAPI3REF: Source Of Data In A Query Result |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^These routines provide a means to determine the database, table, and |
** ^These routines provide a means to determine the database, table, and |
** table column that is the origin of a particular result column in |
** table column that is the origin of a particular result column in |
Line 3292 SQLITE_API const void *sqlite3_column_name16(sqlite3_s
|
Line 4559 SQLITE_API const void *sqlite3_column_name16(sqlite3_s
|
** |
** |
** ^If the Nth column returned by the statement is an expression or |
** ^If the Nth column returned by the statement is an expression or |
** subquery and is not a column value, then all of these functions return |
** subquery and is not a column value, then all of these functions return |
** NULL. ^These routine might also return NULL if a memory allocation error | ** NULL. ^These routines might also return NULL if a memory allocation error |
** occurs. ^Otherwise, they return the name of the attached database, table, |
** occurs. ^Otherwise, they return the name of the attached database, table, |
** or column that query result column was extracted from. |
** or column that query result column was extracted from. |
** |
** |
Line 3302 SQLITE_API const void *sqlite3_column_name16(sqlite3_s
|
Line 4569 SQLITE_API const void *sqlite3_column_name16(sqlite3_s
|
** ^These APIs are only available if the library was compiled with the |
** ^These APIs are only available if the library was compiled with the |
** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. |
** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. |
** |
** |
** If two or more threads call one or more of these routines against the same |
|
** prepared statement and column at the same time then the results are |
|
** undefined. |
|
** |
|
** If two or more threads call one or more |
** If two or more threads call one or more |
** [sqlite3_column_database_name | column metadata interfaces] |
** [sqlite3_column_database_name | column metadata interfaces] |
** for the same [prepared statement] and result column |
** for the same [prepared statement] and result column |
Line 3320 SQLITE_API const void *sqlite3_column_origin_name16(sq
|
Line 4583 SQLITE_API const void *sqlite3_column_origin_name16(sq
|
|
|
/* |
/* |
** CAPI3REF: Declared Datatype Of A Query Result |
** CAPI3REF: Declared Datatype Of A Query Result |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^(The first parameter is a [prepared statement]. |
** ^(The first parameter is a [prepared statement]. |
** If this statement is a [SELECT] statement and the Nth column of the |
** If this statement is a [SELECT] statement and the Nth column of the |
Line 3352 SQLITE_API const void *sqlite3_column_decltype16(sqlit
|
Line 4616 SQLITE_API const void *sqlite3_column_decltype16(sqlit
|
|
|
/* |
/* |
** CAPI3REF: Evaluate An SQL Statement |
** CAPI3REF: Evaluate An SQL Statement |
|
** METHOD: sqlite3_stmt |
** |
** |
** After a [prepared statement] has been prepared using either | ** After a [prepared statement] has been prepared using any of |
** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy | ** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()], |
| ** or [sqlite3_prepare16_v3()] or one of the legacy |
** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function |
** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function |
** must be called one or more times to evaluate the statement. |
** must be called one or more times to evaluate the statement. |
** |
** |
** The details of the behavior of the sqlite3_step() interface depend |
** The details of the behavior of the sqlite3_step() interface depend |
** on whether the statement was prepared using the newer "v2" interface | ** on whether the statement was prepared using the newer "vX" interfaces |
** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy | ** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()], |
** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the | ** [sqlite3_prepare16_v2()] or the older legacy |
** new "v2" interface is recommended for new applications but the legacy | ** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the |
| ** new "vX" interface is recommended for new applications but the legacy |
** interface will continue to be supported. |
** interface will continue to be supported. |
** |
** |
** ^In the legacy interface, the return value will be either [SQLITE_BUSY], |
** ^In the legacy interface, the return value will be either [SQLITE_BUSY], |
Line 3406 SQLITE_API const void *sqlite3_column_decltype16(sqlit
|
Line 4673 SQLITE_API const void *sqlite3_column_decltype16(sqlit
|
** For all versions of SQLite up to and including 3.6.23.1, a call to |
** For all versions of SQLite up to and including 3.6.23.1, a call to |
** [sqlite3_reset()] was required after sqlite3_step() returned anything |
** [sqlite3_reset()] was required after sqlite3_step() returned anything |
** other than [SQLITE_ROW] before any subsequent invocation of |
** other than [SQLITE_ROW] before any subsequent invocation of |
** sqlite3_step(). Failure to reset the prepared statement using | ** sqlite3_step(). Failure to reset the prepared statement using |
** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from |
** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from |
** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began | ** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1], |
| ** sqlite3_step() began |
** calling [sqlite3_reset()] automatically in this circumstance rather |
** calling [sqlite3_reset()] automatically in this circumstance rather |
** than returning [SQLITE_MISUSE]. This is not considered a compatibility |
** than returning [SQLITE_MISUSE]. This is not considered a compatibility |
** break because any application that ever receives an SQLITE_MISUSE error |
** break because any application that ever receives an SQLITE_MISUSE error |
Line 3422 SQLITE_API const void *sqlite3_column_decltype16(sqlit
|
Line 4690 SQLITE_API const void *sqlite3_column_decltype16(sqlit
|
** specific [error codes] that better describes the error. |
** specific [error codes] that better describes the error. |
** We admit that this is a goofy design. The problem has been fixed |
** We admit that this is a goofy design. The problem has been fixed |
** with the "v2" interface. If you prepare all of your SQL statements |
** with the "v2" interface. If you prepare all of your SQL statements |
** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead | ** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()] |
| ** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead |
** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, |
** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, |
** then the more specific [error codes] are returned directly |
** then the more specific [error codes] are returned directly |
** by sqlite3_step(). The use of the "v2" interface is recommended. | ** by sqlite3_step(). The use of the "vX" interfaces is recommended. |
*/ |
*/ |
SQLITE_API int sqlite3_step(sqlite3_stmt*); |
SQLITE_API int sqlite3_step(sqlite3_stmt*); |
|
|
/* |
/* |
** CAPI3REF: Number of columns in a result set |
** CAPI3REF: Number of columns in a result set |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^The sqlite3_data_count(P) interface returns the number of columns in the |
** ^The sqlite3_data_count(P) interface returns the number of columns in the |
** current row of the result set of [prepared statement] P. |
** current row of the result set of [prepared statement] P. |
** ^If prepared statement P does not have results ready to return |
** ^If prepared statement P does not have results ready to return |
** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of | ** (via calls to the [sqlite3_column_int | sqlite3_column()] family of |
** interfaces) then sqlite3_data_count(P) returns 0. |
** interfaces) then sqlite3_data_count(P) returns 0. |
** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. |
** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. |
** ^The sqlite3_data_count(P) routine returns 0 if the previous call to |
** ^The sqlite3_data_count(P) routine returns 0 if the previous call to |
Line 3484 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
Line 4754 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
/* |
/* |
** CAPI3REF: Result Values From A Query |
** CAPI3REF: Result Values From A Query |
** KEYWORDS: {column access functions} |
** KEYWORDS: {column access functions} |
|
** METHOD: sqlite3_stmt |
** |
** |
** These routines form the "result set" interface. | ** <b>Summary:</b> |
| ** <blockquote><table border=0 cellpadding=0 cellspacing=0> |
| ** <tr><td><b>sqlite3_column_blob</b><td>→<td>BLOB result |
| ** <tr><td><b>sqlite3_column_double</b><td>→<td>REAL result |
| ** <tr><td><b>sqlite3_column_int</b><td>→<td>32-bit INTEGER result |
| ** <tr><td><b>sqlite3_column_int64</b><td>→<td>64-bit INTEGER result |
| ** <tr><td><b>sqlite3_column_text</b><td>→<td>UTF-8 TEXT result |
| ** <tr><td><b>sqlite3_column_text16</b><td>→<td>UTF-16 TEXT result |
| ** <tr><td><b>sqlite3_column_value</b><td>→<td>The result as an |
| ** [sqlite3_value|unprotected sqlite3_value] object. |
| ** <tr><td> <td> <td> |
| ** <tr><td><b>sqlite3_column_bytes</b><td>→<td>Size of a BLOB |
| ** or a UTF-8 TEXT result in bytes |
| ** <tr><td><b>sqlite3_column_bytes16 </b> |
| ** <td>→ <td>Size of UTF-16 |
| ** TEXT in bytes |
| ** <tr><td><b>sqlite3_column_type</b><td>→<td>Default |
| ** datatype of the result |
| ** </table></blockquote> |
** |
** |
|
** <b>Details:</b> |
|
** |
** ^These routines return information about a single column of the current |
** ^These routines return information about a single column of the current |
** result row of a query. ^In every case the first argument is a pointer |
** result row of a query. ^In every case the first argument is a pointer |
** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] |
** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] |
Line 3508 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
Line 4799 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
** are called from a different thread while any of these routines |
** are called from a different thread while any of these routines |
** are pending, then the results are undefined. |
** are pending, then the results are undefined. |
** |
** |
|
** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16) |
|
** each return the value of a result column in a specific data format. If |
|
** the result column is not initially in the requested format (for example, |
|
** if the query returns an integer but the sqlite3_column_text() interface |
|
** is used to extract the value) then an automatic type conversion is performed. |
|
** |
** ^The sqlite3_column_type() routine returns the |
** ^The sqlite3_column_type() routine returns the |
** [SQLITE_INTEGER | datatype code] for the initial data type |
** [SQLITE_INTEGER | datatype code] for the initial data type |
** of the result column. ^The returned value is one of [SQLITE_INTEGER], |
** of the result column. ^The returned value is one of [SQLITE_INTEGER], |
** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value | ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. |
** returned by sqlite3_column_type() is only meaningful if no type | ** The return value of sqlite3_column_type() can be used to decide which |
** conversions have occurred as described below. After a type conversion, | ** of the first six interface should be used to extract the column value. |
** the value returned by sqlite3_column_type() is undefined. Future | ** The value returned by sqlite3_column_type() is only meaningful if no |
| ** automatic type conversions have occurred for the value in question. |
| ** After a type conversion, the result of calling sqlite3_column_type() |
| ** is undefined, though harmless. Future |
** versions of SQLite may change the behavior of sqlite3_column_type() |
** versions of SQLite may change the behavior of sqlite3_column_type() |
** following a type conversion. |
** following a type conversion. |
** |
** |
|
** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes() |
|
** or sqlite3_column_bytes16() interfaces can be used to determine the size |
|
** of that BLOB or string. |
|
** |
** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() |
** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() |
** routine returns the number of bytes in that BLOB or string. |
** routine returns the number of bytes in that BLOB or string. |
** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts |
** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts |
Line 3536 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
Line 4840 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
** the number of bytes in that string. |
** the number of bytes in that string. |
** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. |
** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. |
** |
** |
** ^The values returned by [sqlite3_column_bytes()] and | ** ^The values returned by [sqlite3_column_bytes()] and |
** [sqlite3_column_bytes16()] do not include the zero terminators at the end |
** [sqlite3_column_bytes16()] do not include the zero terminators at the end |
** of the string. ^For clarity: the values returned by |
** of the string. ^For clarity: the values returned by |
** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of |
** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of |
Line 3546 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
Line 4850 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
** even empty strings, are always zero-terminated. ^The return |
** even empty strings, are always zero-terminated. ^The return |
** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. |
** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. |
** |
** |
** ^The object returned by [sqlite3_column_value()] is an | ** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an |
** [unprotected sqlite3_value] object. An unprotected sqlite3_value object | ** [unprotected sqlite3_value] object. In a multithreaded environment, |
** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. | ** an unprotected sqlite3_value object may only be used safely with |
| ** [sqlite3_bind_value()] and [sqlite3_result_value()]. |
** If the [unprotected sqlite3_value] object returned by |
** If the [unprotected sqlite3_value] object returned by |
** [sqlite3_column_value()] is used in any other way, including calls |
** [sqlite3_column_value()] is used in any other way, including calls |
** to routines like [sqlite3_value_int()], [sqlite3_value_text()], |
** to routines like [sqlite3_value_int()], [sqlite3_value_text()], |
** or [sqlite3_value_bytes()], then the behavior is undefined. | ** or [sqlite3_value_bytes()], the behavior is not threadsafe. |
| ** Hence, the sqlite3_column_value() interface |
| ** is normally only useful within the implementation of |
| ** [application-defined SQL functions] or [virtual tables], not within |
| ** top-level application code. |
** |
** |
** These routines attempt to convert the value where appropriate. ^For | ** The these routines may attempt to convert the datatype of the result. |
** example, if the internal representation is FLOAT and a text result | ** ^For example, if the internal representation is FLOAT and a text result |
** is requested, [sqlite3_snprintf()] is used internally to perform the |
** is requested, [sqlite3_snprintf()] is used internally to perform the |
** conversion automatically. ^(The following table details the conversions |
** conversion automatically. ^(The following table details the conversions |
** that are applied: |
** that are applied: |
Line 3566 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
Line 4875 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
** |
** |
** <tr><td> NULL <td> INTEGER <td> Result is 0 |
** <tr><td> NULL <td> INTEGER <td> Result is 0 |
** <tr><td> NULL <td> FLOAT <td> Result is 0.0 |
** <tr><td> NULL <td> FLOAT <td> Result is 0.0 |
** <tr><td> NULL <td> TEXT <td> Result is NULL pointer | ** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer |
** <tr><td> NULL <td> BLOB <td> Result is NULL pointer | ** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer |
** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float |
** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float |
** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer |
** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer |
** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT |
** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT |
** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer | ** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER |
** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float |
** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float |
** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT | ** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB |
** <tr><td> TEXT <td> INTEGER <td> Use atoi() | ** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER |
** <tr><td> TEXT <td> FLOAT <td> Use atof() | ** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL |
** <tr><td> TEXT <td> BLOB <td> No change |
** <tr><td> TEXT <td> BLOB <td> No change |
** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() | ** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER |
** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() | ** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL |
** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed |
** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed |
** </table> |
** </table> |
** </blockquote>)^ |
** </blockquote>)^ |
** |
** |
** The table above makes reference to standard C library functions atoi() |
|
** and atof(). SQLite does not really use these functions. It has its |
|
** own equivalent internal routines. The atoi() and atof() names are |
|
** used in the table for brevity and because they are familiar to most |
|
** C programmers. |
|
** |
|
** Note that when type conversions occur, pointers returned by prior |
** Note that when type conversions occur, pointers returned by prior |
** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or |
** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or |
** sqlite3_column_text16() may be invalidated. |
** sqlite3_column_text16() may be invalidated. |
Line 3613 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
Line 4916 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
** of conversion are done in place when it is possible, but sometimes they |
** of conversion are done in place when it is possible, but sometimes they |
** are not possible and in those cases prior pointers are invalidated. |
** are not possible and in those cases prior pointers are invalidated. |
** |
** |
** The safest and easiest to remember policy is to invoke these routines | ** The safest policy is to invoke these routines |
** in one of the following ways: |
** in one of the following ways: |
** |
** |
** <ul> |
** <ul> |
Line 3633 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
Line 4936 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
|
** ^The pointers returned are valid until a type conversion occurs as |
** ^The pointers returned are valid until a type conversion occurs as |
** described above, or until [sqlite3_step()] or [sqlite3_reset()] or |
** described above, or until [sqlite3_step()] or [sqlite3_reset()] or |
** [sqlite3_finalize()] is called. ^The memory space used to hold strings |
** [sqlite3_finalize()] is called. ^The memory space used to hold strings |
** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned | ** and BLOBs is freed automatically. Do not pass the pointers returned |
** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into | ** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into |
** [sqlite3_free()]. |
** [sqlite3_free()]. |
** |
** |
** ^(If a memory allocation error occurs during the evaluation of any | ** As long as the input parameters are correct, these routines will only |
** of these routines, a default value is returned. The default value | ** fail if an out-of-memory error occurs during a format conversion. |
** is either the integer 0, the floating point number 0.0, or a NULL | ** Only the following subset of interfaces are subject to out-of-memory |
** pointer. Subsequent calls to [sqlite3_errcode()] will return | ** errors: |
** [SQLITE_NOMEM].)^ | ** |
| ** <ul> |
| ** <li> sqlite3_column_blob() |
| ** <li> sqlite3_column_text() |
| ** <li> sqlite3_column_text16() |
| ** <li> sqlite3_column_bytes() |
| ** <li> sqlite3_column_bytes16() |
| ** </ul> |
| ** |
| ** If an out-of-memory error occurs, then the return value from these |
| ** routines is the same as if the column had contained an SQL NULL value. |
| ** Valid SQL NULL returns can be distinguished from out-of-memory errors |
| ** by invoking the [sqlite3_errcode()] immediately after the suspect |
| ** return value is obtained and before any |
| ** other SQLite interface is called on the same [database connection]. |
*/ |
*/ |
SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); |
SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); |
SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); |
|
SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); |
|
SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); |
SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); |
SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); |
SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); |
SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); |
SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); |
SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); |
SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); |
SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); |
SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); |
SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); |
|
SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); |
SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); |
|
SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); |
|
SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); |
|
SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); |
|
|
/* |
/* |
** CAPI3REF: Destroy A Prepared Statement Object |
** CAPI3REF: Destroy A Prepared Statement Object |
|
** DESTRUCTOR: sqlite3_stmt |
** |
** |
** ^The sqlite3_finalize() function is called to delete a [prepared statement]. |
** ^The sqlite3_finalize() function is called to delete a [prepared statement]. |
** ^If the most recent evaluation of the statement encountered no errors |
** ^If the most recent evaluation of the statement encountered no errors |
Line 3683 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
|
Line 5001 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
|
|
|
/* |
/* |
** CAPI3REF: Reset A Prepared Statement Object |
** CAPI3REF: Reset A Prepared Statement Object |
|
** METHOD: sqlite3_stmt |
** |
** |
** The sqlite3_reset() function is called to reset a [prepared statement] |
** The sqlite3_reset() function is called to reset a [prepared statement] |
** object back to its initial state, ready to be re-executed. |
** object back to its initial state, ready to be re-executed. |
Line 3710 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
Line 5029 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
/* |
/* |
** CAPI3REF: Create Or Redefine SQL Functions |
** CAPI3REF: Create Or Redefine SQL Functions |
** KEYWORDS: {function creation routines} |
** KEYWORDS: {function creation routines} |
** KEYWORDS: {application-defined SQL function} | ** METHOD: sqlite3 |
** KEYWORDS: {application-defined SQL functions} | |
** |
** |
** ^These functions (collectively known as "function creation routines") |
** ^These functions (collectively known as "function creation routines") |
** are used to add SQL functions or aggregates or to redefine the behavior |
** are used to add SQL functions or aggregates or to redefine the behavior |
** of existing SQL functions or aggregates. The only differences between | ** of existing SQL functions or aggregates. The only differences between |
** these routines are the text encoding expected for | ** the three "sqlite3_create_function*" routines are the text encoding |
** the second parameter (the name of the function being created) | ** expected for the second parameter (the name of the function being |
** and the presence or absence of a destructor callback for | ** created) and the presence or absence of a destructor callback for |
** the application data pointer. | ** the application data pointer. Function sqlite3_create_window_function() |
| ** is similar, but allows the user to supply the extra callback functions |
| ** needed by [aggregate window functions]. |
** |
** |
** ^The first parameter is the [database connection] to which the SQL |
** ^The first parameter is the [database connection] to which the SQL |
** function is to be added. ^If an application uses more than one database |
** function is to be added. ^If an application uses more than one database |
Line 3729 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
Line 5049 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
** ^The second parameter is the name of the SQL function to be created or |
** ^The second parameter is the name of the SQL function to be created or |
** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 |
** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 |
** representation, exclusive of the zero-terminator. ^Note that the name |
** representation, exclusive of the zero-terminator. ^Note that the name |
** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. | ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. |
** ^Any attempt to create a function with a longer name |
** ^Any attempt to create a function with a longer name |
** will result in [SQLITE_MISUSE] being returned. |
** will result in [SQLITE_MISUSE] being returned. |
** |
** |
Line 3743 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
Line 5063 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
** |
** |
** ^The fourth parameter, eTextRep, specifies what |
** ^The fourth parameter, eTextRep, specifies what |
** [SQLITE_UTF8 | text encoding] this SQL function prefers for |
** [SQLITE_UTF8 | text encoding] this SQL function prefers for |
** its parameters. Every SQL function implementation must be able to work | ** its parameters. The application should set this parameter to |
** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be | ** [SQLITE_UTF16LE] if the function implementation invokes |
** more efficient with one encoding than another. ^An application may | ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the |
** invoke sqlite3_create_function() or sqlite3_create_function16() multiple | ** implementation invokes [sqlite3_value_text16be()] on an input, or |
** times with the same function but with different values of eTextRep. | ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8] |
| ** otherwise. ^The same SQL function may be registered multiple times using |
| ** different preferred text encodings, with different implementations for |
| ** each encoding. |
** ^When multiple implementations of the same function are available, SQLite |
** ^When multiple implementations of the same function are available, SQLite |
** will pick the one that involves the least amount of data conversion. |
** will pick the one that involves the least amount of data conversion. |
** If there is only a single implementation which does not care what text |
|
** encoding is used, then the fourth argument should be [SQLITE_ANY]. |
|
** |
** |
|
** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC] |
|
** to signal that the function will always return the same result given |
|
** the same inputs within a single SQL statement. Most SQL functions are |
|
** deterministic. The built-in [random()] SQL function is an example of a |
|
** function that is not deterministic. The SQLite query planner is able to |
|
** perform additional optimizations on deterministic functions, so use |
|
** of the [SQLITE_DETERMINISTIC] flag is recommended where possible. |
|
** |
|
** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY] |
|
** flag, which if present prevents the function from being invoked from |
|
** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions, |
|
** index expressions, or the WHERE clause of partial indexes. |
|
** |
|
** <span style="background-color:#ffff90;"> |
|
** For best security, the [SQLITE_DIRECTONLY] flag is recommended for |
|
** all application-defined SQL functions that do not need to be |
|
** used inside of triggers, view, CHECK constraints, or other elements of |
|
** the database schema. This flags is especially recommended for SQL |
|
** functions that have side effects or reveal internal application state. |
|
** Without this flag, an attacker might be able to modify the schema of |
|
** a database file to include invocations of the function with parameters |
|
** chosen by the attacker, which the application will then execute when |
|
** the database file is opened and read. |
|
** </span> |
|
** |
** ^(The fifth parameter is an arbitrary pointer. The implementation of the |
** ^(The fifth parameter is an arbitrary pointer. The implementation of the |
** function can gain access to this pointer using [sqlite3_user_data()].)^ |
** function can gain access to this pointer using [sqlite3_user_data()].)^ |
** |
** |
** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are | ** ^The sixth, seventh and eighth parameters passed to the three |
| ** "sqlite3_create_function*" functions, xFunc, xStep and xFinal, are |
** pointers to C-language functions that implement the SQL function or |
** pointers to C-language functions that implement the SQL function or |
** aggregate. ^A scalar SQL function requires an implementation of the xFunc |
** aggregate. ^A scalar SQL function requires an implementation of the xFunc |
** callback only; NULL pointers must be passed as the xStep and xFinal |
** callback only; NULL pointers must be passed as the xStep and xFinal |
Line 3765 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
Line 5112 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
** SQL function or aggregate, pass NULL pointers for all three function |
** SQL function or aggregate, pass NULL pointers for all three function |
** callbacks. |
** callbacks. |
** |
** |
** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, | ** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue |
** then it is destructor for the application data pointer. | ** and xInverse) passed to sqlite3_create_window_function are pointers to |
** The destructor is invoked when the function is deleted, either by being | ** C-language callbacks that implement the new function. xStep and xFinal |
** overloaded or when the database connection closes.)^ | ** must both be non-NULL. xValue and xInverse may either both be NULL, in |
** ^The destructor is also invoked if the call to | ** which case a regular aggregate function is created, or must both be |
** sqlite3_create_function_v2() fails. | ** non-NULL, in which case the new function may be used as either an aggregate |
** ^When the destructor callback of the tenth parameter is invoked, it | ** or aggregate window function. More details regarding the implementation |
** is passed a single argument which is a copy of the application data | ** of aggregate window functions are |
** pointer which was the fifth parameter to sqlite3_create_function_v2(). | ** [user-defined window functions|available here]. |
** |
** |
|
** ^(If the final parameter to sqlite3_create_function_v2() or |
|
** sqlite3_create_window_function() is not NULL, then it is destructor for |
|
** the application data pointer. The destructor is invoked when the function |
|
** is deleted, either by being overloaded or when the database connection |
|
** closes.)^ ^The destructor is also invoked if the call to |
|
** sqlite3_create_function_v2() fails. ^When the destructor callback is |
|
** invoked, it is passed a single argument which is a copy of the application |
|
** data pointer which was the fifth parameter to sqlite3_create_function_v2(). |
|
** |
** ^It is permitted to register multiple implementations of the same |
** ^It is permitted to register multiple implementations of the same |
** functions with the same name but with either differing numbers of |
** functions with the same name but with either differing numbers of |
** arguments or differing preferred text encodings. ^SQLite will use |
** arguments or differing preferred text encodings. ^SQLite will use |
Line 3783 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
Line 5139 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
** nArg parameter is a better match than a function implementation with |
** nArg parameter is a better match than a function implementation with |
** a negative nArg. ^A function where the preferred text encoding |
** a negative nArg. ^A function where the preferred text encoding |
** matches the database encoding is a better |
** matches the database encoding is a better |
** match than a function where the encoding is different. | ** match than a function where the encoding is different. |
** ^A function where the encoding difference is between UTF16le and UTF16be |
** ^A function where the encoding difference is between UTF16le and UTF16be |
** is a closer match than a function where the encoding difference is |
** is a closer match than a function where the encoding difference is |
** between UTF8 and UTF16. |
** between UTF8 and UTF16. |
Line 3826 SQLITE_API int sqlite3_create_function_v2(
|
Line 5182 SQLITE_API int sqlite3_create_function_v2(
|
void (*xFinal)(sqlite3_context*), |
void (*xFinal)(sqlite3_context*), |
void(*xDestroy)(void*) |
void(*xDestroy)(void*) |
); |
); |
|
SQLITE_API int sqlite3_create_window_function( |
|
sqlite3 *db, |
|
const char *zFunctionName, |
|
int nArg, |
|
int eTextRep, |
|
void *pApp, |
|
void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
|
void (*xFinal)(sqlite3_context*), |
|
void (*xValue)(sqlite3_context*), |
|
void (*xInverse)(sqlite3_context*,int,sqlite3_value**), |
|
void(*xDestroy)(void*) |
|
); |
|
|
/* |
/* |
** CAPI3REF: Text Encodings |
** CAPI3REF: Text Encodings |
Line 3833 SQLITE_API int sqlite3_create_function_v2(
|
Line 5201 SQLITE_API int sqlite3_create_function_v2(
|
** These constant define integer codes that represent the various |
** These constant define integer codes that represent the various |
** text encodings supported by SQLite. |
** text encodings supported by SQLite. |
*/ |
*/ |
#define SQLITE_UTF8 1 | #define SQLITE_UTF8 1 /* IMP: R-37514-35566 */ |
#define SQLITE_UTF16LE 2 | #define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */ |
#define SQLITE_UTF16BE 3 | #define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */ |
#define SQLITE_UTF16 4 /* Use native byte order */ |
#define SQLITE_UTF16 4 /* Use native byte order */ |
#define SQLITE_ANY 5 /* sqlite3_create_function only */ | #define SQLITE_ANY 5 /* Deprecated */ |
#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ |
#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ |
|
|
/* |
/* |
|
** CAPI3REF: Function Flags |
|
** |
|
** These constants may be ORed together with the |
|
** [SQLITE_UTF8 | preferred text encoding] as the fourth argument |
|
** to [sqlite3_create_function()], [sqlite3_create_function16()], or |
|
** [sqlite3_create_function_v2()]. |
|
** |
|
** <dl> |
|
** [[SQLITE_DETERMINISTIC]] <dt>SQLITE_DETERMINISTIC</dt><dd> |
|
** The SQLITE_DETERMINISTIC flag means that the new function always gives |
|
** the same output when the input parameters are the same. |
|
** The [abs|abs() function] is deterministic, for example, but |
|
** [randomblob|randomblob()] is not. Functions must |
|
** be deterministic in order to be used in certain contexts such as |
|
** with the WHERE clause of [partial indexes] or in [generated columns]. |
|
** SQLite might also optimize deterministic functions by factoring them |
|
** out of inner loops. |
|
** </dd> |
|
** |
|
** [[SQLITE_DIRECTONLY]] <dt>SQLITE_DIRECTONLY</dt><dd> |
|
** The SQLITE_DIRECTONLY flag means that the function may only be invoked |
|
** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in |
|
** schema structures such as [CHECK constraints], [DEFAULT clauses], |
|
** [expression indexes], [partial indexes], or [generated columns]. |
|
** The SQLITE_DIRECTONLY flags is a security feature which is recommended |
|
** for all [application-defined SQL functions], and especially for functions |
|
** that have side-effects or that could potentially leak sensitive |
|
** information. |
|
** </dd> |
|
** |
|
** [[SQLITE_INNOCUOUS]] <dt>SQLITE_INNOCUOUS</dt><dd> |
|
** The SQLITE_INNOCUOUS flag means that the function is unlikely |
|
** to cause problems even if misused. An innocuous function should have |
|
** no side effects and should not depend on any values other than its |
|
** input parameters. The [abs|abs() function] is an example of an |
|
** innocuous function. |
|
** The [load_extension() SQL function] is not innocuous because of its |
|
** side effects. |
|
** <p> SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not |
|
** exactly the same. The [random|random() function] is an example of a |
|
** function that is innocuous but not deterministic. |
|
** <p>Some heightened security settings |
|
** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF]) |
|
** disable the use of SQL functions inside views and triggers and in |
|
** schema structures such as [CHECK constraints], [DEFAULT clauses], |
|
** [expression indexes], [partial indexes], and [generated columns] unless |
|
** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions |
|
** are innocuous. Developers are advised to avoid using the |
|
** SQLITE_INNOCUOUS flag for application-defined functions unless the |
|
** function has been carefully audited and found to be free of potentially |
|
** security-adverse side-effects and information-leaks. |
|
** </dd> |
|
** |
|
** [[SQLITE_SUBTYPE]] <dt>SQLITE_SUBTYPE</dt><dd> |
|
** The SQLITE_SUBTYPE flag indicates to SQLite that a function may call |
|
** [sqlite3_value_subtype()] to inspect the sub-types of its arguments. |
|
** Specifying this flag makes no difference for scalar or aggregate user |
|
** functions. However, if it is not specified for a user-defined window |
|
** function, then any sub-types belonging to arguments passed to the window |
|
** function may be discarded before the window function is called (i.e. |
|
** sqlite3_value_subtype() will always return 0). |
|
** </dd> |
|
** </dl> |
|
*/ |
|
#define SQLITE_DETERMINISTIC 0x000000800 |
|
#define SQLITE_DIRECTONLY 0x000080000 |
|
#define SQLITE_SUBTYPE 0x000100000 |
|
#define SQLITE_INNOCUOUS 0x000200000 |
|
|
|
/* |
** CAPI3REF: Deprecated Functions |
** CAPI3REF: Deprecated Functions |
** DEPRECATED |
** DEPRECATED |
** |
** |
** These functions are [deprecated]. In order to maintain |
** These functions are [deprecated]. In order to maintain |
** backwards compatibility with older code, these functions continue | ** backwards compatibility with older code, these functions continue |
** to be supported. However, new applications should avoid |
** to be supported. However, new applications should avoid |
** the use of these functions. To help encourage people to avoid | ** the use of these functions. To encourage programmers to avoid |
** using these functions, we are not going to tell you what they do. | ** these functions, we will not explain what they do. |
*/ |
*/ |
#ifndef SQLITE_OMIT_DEPRECATED |
#ifndef SQLITE_OMIT_DEPRECATED |
SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); |
SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); |
Line 3856 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlit
|
Line 5294 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlit
|
SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); |
SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); |
SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); |
SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); |
SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); |
SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); |
SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); | SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int), |
| void*,sqlite3_int64); |
#endif |
#endif |
|
|
/* |
/* |
** CAPI3REF: Obtaining SQL Function Parameter Values | ** CAPI3REF: Obtaining SQL Values |
| ** METHOD: sqlite3_value |
** |
** |
** The C-language implementation of SQL functions and aggregates uses | ** <b>Summary:</b> |
** this set of interface routines to access the parameter values on | ** <blockquote><table border=0 cellpadding=0 cellspacing=0> |
** the function or aggregate. | ** <tr><td><b>sqlite3_value_blob</b><td>→<td>BLOB value |
| ** <tr><td><b>sqlite3_value_double</b><td>→<td>REAL value |
| ** <tr><td><b>sqlite3_value_int</b><td>→<td>32-bit INTEGER value |
| ** <tr><td><b>sqlite3_value_int64</b><td>→<td>64-bit INTEGER value |
| ** <tr><td><b>sqlite3_value_pointer</b><td>→<td>Pointer value |
| ** <tr><td><b>sqlite3_value_text</b><td>→<td>UTF-8 TEXT value |
| ** <tr><td><b>sqlite3_value_text16</b><td>→<td>UTF-16 TEXT value in |
| ** the native byteorder |
| ** <tr><td><b>sqlite3_value_text16be</b><td>→<td>UTF-16be TEXT value |
| ** <tr><td><b>sqlite3_value_text16le</b><td>→<td>UTF-16le TEXT value |
| ** <tr><td> <td> <td> |
| ** <tr><td><b>sqlite3_value_bytes</b><td>→<td>Size of a BLOB |
| ** or a UTF-8 TEXT in bytes |
| ** <tr><td><b>sqlite3_value_bytes16 </b> |
| ** <td>→ <td>Size of UTF-16 |
| ** TEXT in bytes |
| ** <tr><td><b>sqlite3_value_type</b><td>→<td>Default |
| ** datatype of the value |
| ** <tr><td><b>sqlite3_value_numeric_type </b> |
| ** <td>→ <td>Best numeric datatype of the value |
| ** <tr><td><b>sqlite3_value_nochange </b> |
| ** <td>→ <td>True if the column is unchanged in an UPDATE |
| ** against a virtual table. |
| ** <tr><td><b>sqlite3_value_frombind </b> |
| ** <td>→ <td>True if value originated from a [bound parameter] |
| ** </table></blockquote> |
** |
** |
** The xFunc (for scalar functions) or xStep (for aggregates) parameters | ** <b>Details:</b> |
** to [sqlite3_create_function()] and [sqlite3_create_function16()] | |
** define callbacks that implement the SQL functions and aggregates. | |
** The 3rd parameter to these callbacks is an array of pointers to | |
** [protected sqlite3_value] objects. There is one [sqlite3_value] object for | |
** each parameter to the SQL function. These routines are used to | |
** extract values from the [sqlite3_value] objects. | |
** |
** |
|
** These routines extract type, size, and content information from |
|
** [protected sqlite3_value] objects. Protected sqlite3_value objects |
|
** are used to pass parameter information into the functions that |
|
** implement [application-defined SQL functions] and [virtual tables]. |
|
** |
** These routines work only with [protected sqlite3_value] objects. |
** These routines work only with [protected sqlite3_value] objects. |
** Any attempt to use these routines on an [unprotected sqlite3_value] |
** Any attempt to use these routines on an [unprotected sqlite3_value] |
** object results in undefined behavior. | ** is not threadsafe. |
** |
** |
** ^These routines work just like the corresponding [column access functions] |
** ^These routines work just like the corresponding [column access functions] |
** except that these routines take a single [protected sqlite3_value] object | ** except that these routines take a single [protected sqlite3_value] object |
** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. |
** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. |
** |
** |
** ^The sqlite3_value_text16() interface extracts a UTF-16 string |
** ^The sqlite3_value_text16() interface extracts a UTF-16 string |
Line 3887 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
|
Line 5351 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
|
** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces |
** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces |
** extract UTF-16 strings as big-endian and little-endian respectively. |
** extract UTF-16 strings as big-endian and little-endian respectively. |
** |
** |
|
** ^If [sqlite3_value] object V was initialized |
|
** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)] |
|
** and if X and Y are strings that compare equal according to strcmp(X,Y), |
|
** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise, |
|
** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer() |
|
** routine is part of the [pointer passing interface] added for SQLite 3.20.0. |
|
** |
|
** ^(The sqlite3_value_type(V) interface returns the |
|
** [SQLITE_INTEGER | datatype code] for the initial datatype of the |
|
** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER], |
|
** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^ |
|
** Other interfaces might change the datatype for an sqlite3_value object. |
|
** For example, if the datatype is initially SQLITE_INTEGER and |
|
** sqlite3_value_text(V) is called to extract a text value for that |
|
** integer, then subsequent calls to sqlite3_value_type(V) might return |
|
** SQLITE_TEXT. Whether or not a persistent internal datatype conversion |
|
** occurs is undefined and may change from one release of SQLite to the next. |
|
** |
** ^(The sqlite3_value_numeric_type() interface attempts to apply |
** ^(The sqlite3_value_numeric_type() interface attempts to apply |
** numeric affinity to the value. This means that an attempt is |
** numeric affinity to the value. This means that an attempt is |
** made to convert the value to an integer or floating point. If |
** made to convert the value to an integer or floating point. If |
Line 3895 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
|
Line 5377 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
|
** then the conversion is performed. Otherwise no conversion occurs. |
** then the conversion is performed. Otherwise no conversion occurs. |
** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ |
** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ |
** |
** |
|
** ^Within the [xUpdate] method of a [virtual table], the |
|
** sqlite3_value_nochange(X) interface returns true if and only if |
|
** the column corresponding to X is unchanged by the UPDATE operation |
|
** that the xUpdate method call was invoked to implement and if |
|
** and the prior [xColumn] method call that was invoked to extracted |
|
** the value for that column returned without setting a result (probably |
|
** because it queried [sqlite3_vtab_nochange()] and found that the column |
|
** was unchanging). ^Within an [xUpdate] method, any value for which |
|
** sqlite3_value_nochange(X) is true will in all other respects appear |
|
** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other |
|
** than within an [xUpdate] method call for an UPDATE statement, then |
|
** the return value is arbitrary and meaningless. |
|
** |
|
** ^The sqlite3_value_frombind(X) interface returns non-zero if the |
|
** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()] |
|
** interfaces. ^If X comes from an SQL literal value, or a table column, |
|
** or an expression, then sqlite3_value_frombind(X) returns zero. |
|
** |
** Please pay particular attention to the fact that the pointer returned |
** Please pay particular attention to the fact that the pointer returned |
** from [sqlite3_value_blob()], [sqlite3_value_text()], or |
** from [sqlite3_value_blob()], [sqlite3_value_text()], or |
** [sqlite3_value_text16()] can be invalidated by a subsequent call to |
** [sqlite3_value_text16()] can be invalidated by a subsequent call to |
Line 3903 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
|
Line 5403 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
|
** |
** |
** These routines must be called from the same thread as |
** These routines must be called from the same thread as |
** the SQL function that supplied the [sqlite3_value*] parameters. |
** the SQL function that supplied the [sqlite3_value*] parameters. |
|
** |
|
** As long as the input parameter is correct, these routines can only |
|
** fail if an out-of-memory error occurs during a format conversion. |
|
** Only the following subset of interfaces are subject to out-of-memory |
|
** errors: |
|
** |
|
** <ul> |
|
** <li> sqlite3_value_blob() |
|
** <li> sqlite3_value_text() |
|
** <li> sqlite3_value_text16() |
|
** <li> sqlite3_value_text16le() |
|
** <li> sqlite3_value_text16be() |
|
** <li> sqlite3_value_bytes() |
|
** <li> sqlite3_value_bytes16() |
|
** </ul> |
|
** |
|
** If an out-of-memory error occurs, then the return value from these |
|
** routines is the same as if the column had contained an SQL NULL value. |
|
** Valid SQL NULL returns can be distinguished from out-of-memory errors |
|
** by invoking the [sqlite3_errcode()] immediately after the suspect |
|
** return value is obtained and before any |
|
** other SQLite interface is called on the same [database connection]. |
*/ |
*/ |
SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); |
SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); |
SQLITE_API int sqlite3_value_bytes(sqlite3_value*); |
|
SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); |
|
SQLITE_API double sqlite3_value_double(sqlite3_value*); |
SQLITE_API double sqlite3_value_double(sqlite3_value*); |
SQLITE_API int sqlite3_value_int(sqlite3_value*); |
SQLITE_API int sqlite3_value_int(sqlite3_value*); |
SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); |
SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); |
|
SQLITE_API void *sqlite3_value_pointer(sqlite3_value*, const char*); |
SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); |
SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); |
SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); |
SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); |
SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); |
SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); |
SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); |
SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); |
|
SQLITE_API int sqlite3_value_bytes(sqlite3_value*); |
|
SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); |
SQLITE_API int sqlite3_value_type(sqlite3_value*); |
SQLITE_API int sqlite3_value_type(sqlite3_value*); |
SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); |
SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); |
|
SQLITE_API int sqlite3_value_nochange(sqlite3_value*); |
|
SQLITE_API int sqlite3_value_frombind(sqlite3_value*); |
|
|
/* |
/* |
|
** CAPI3REF: Finding The Subtype Of SQL Values |
|
** METHOD: sqlite3_value |
|
** |
|
** The sqlite3_value_subtype(V) function returns the subtype for |
|
** an [application-defined SQL function] argument V. The subtype |
|
** information can be used to pass a limited amount of context from |
|
** one SQL function to another. Use the [sqlite3_result_subtype()] |
|
** routine to set the subtype for the return value of an SQL function. |
|
*/ |
|
SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*); |
|
|
|
/* |
|
** CAPI3REF: Copy And Free SQL Values |
|
** METHOD: sqlite3_value |
|
** |
|
** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value] |
|
** object D and returns a pointer to that copy. ^The [sqlite3_value] returned |
|
** is a [protected sqlite3_value] object even if the input is not. |
|
** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a |
|
** memory allocation fails. |
|
** |
|
** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object |
|
** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer |
|
** then sqlite3_value_free(V) is a harmless no-op. |
|
*/ |
|
SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*); |
|
SQLITE_API void sqlite3_value_free(sqlite3_value*); |
|
|
|
/* |
** CAPI3REF: Obtain Aggregate Function Context |
** CAPI3REF: Obtain Aggregate Function Context |
|
** METHOD: sqlite3_context |
** |
** |
** Implementations of aggregate SQL functions use this |
** Implementations of aggregate SQL functions use this |
** routine to allocate memory for storing their state. |
** routine to allocate memory for storing their state. |
** |
** |
** ^The first time the sqlite3_aggregate_context(C,N) routine is called | ** ^The first time the sqlite3_aggregate_context(C,N) routine is called |
** for a particular aggregate function, SQLite | ** for a particular aggregate function, SQLite allocates |
** allocates N of memory, zeroes out that memory, and returns a pointer | ** N bytes of memory, zeroes out that memory, and returns a pointer |
** to the new memory. ^On second and subsequent calls to |
** to the new memory. ^On second and subsequent calls to |
** sqlite3_aggregate_context() for the same aggregate function instance, |
** sqlite3_aggregate_context() for the same aggregate function instance, |
** the same buffer is returned. Sqlite3_aggregate_context() is normally |
** the same buffer is returned. Sqlite3_aggregate_context() is normally |
Line 3936 SQLITE_API int sqlite3_value_numeric_type(sqlite3_valu
|
Line 5491 SQLITE_API int sqlite3_value_numeric_type(sqlite3_valu
|
** In those cases, sqlite3_aggregate_context() might be called for the |
** In those cases, sqlite3_aggregate_context() might be called for the |
** first time from within xFinal().)^ |
** first time from within xFinal().)^ |
** |
** |
** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is | ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer |
** less than or equal to zero or if a memory allocate error occurs. | ** when first called if N is less than or equal to zero or if a memory |
| ** allocate error occurs. |
** |
** |
** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is |
** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is |
** determined by the N parameter on first successful call. Changing the |
** determined by the N parameter on first successful call. Changing the |
** value of N in subsequent call to sqlite3_aggregate_context() within | ** value of N in any subsequent call to sqlite3_aggregate_context() within |
** the same aggregate function instance will not resize the memory |
** the same aggregate function instance will not resize the memory |
** allocation.)^ | ** allocation.)^ Within the xFinal callback, it is customary to set |
| ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no |
| ** pointless memory allocations occur. |
** |
** |
** ^SQLite automatically frees the memory allocated by | ** ^SQLite automatically frees the memory allocated by |
** sqlite3_aggregate_context() when the aggregate query concludes. |
** sqlite3_aggregate_context() when the aggregate query concludes. |
** |
** |
** The first parameter must be a copy of the |
** The first parameter must be a copy of the |
Line 3960 SQLITE_API void *sqlite3_aggregate_context(sqlite3_con
|
Line 5518 SQLITE_API void *sqlite3_aggregate_context(sqlite3_con
|
|
|
/* |
/* |
** CAPI3REF: User Data For Functions |
** CAPI3REF: User Data For Functions |
|
** METHOD: sqlite3_context |
** |
** |
** ^The sqlite3_user_data() interface returns a copy of |
** ^The sqlite3_user_data() interface returns a copy of |
** the pointer that was the pUserData parameter (the 5th parameter) |
** the pointer that was the pUserData parameter (the 5th parameter) |
Line 3974 SQLITE_API void *sqlite3_user_data(sqlite3_context*);
|
Line 5533 SQLITE_API void *sqlite3_user_data(sqlite3_context*);
|
|
|
/* |
/* |
** CAPI3REF: Database Connection For Functions |
** CAPI3REF: Database Connection For Functions |
|
** METHOD: sqlite3_context |
** |
** |
** ^The sqlite3_context_db_handle() interface returns a copy of |
** ^The sqlite3_context_db_handle() interface returns a copy of |
** the pointer to the [database connection] (the 1st parameter) |
** the pointer to the [database connection] (the 1st parameter) |
Line 3985 SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_
|
Line 5545 SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_
|
|
|
/* |
/* |
** CAPI3REF: Function Auxiliary Data |
** CAPI3REF: Function Auxiliary Data |
|
** METHOD: sqlite3_context |
** |
** |
** The following two functions may be used by scalar SQL functions to | ** These functions may be used by (non-aggregate) SQL functions to |
** associate metadata with argument values. If the same value is passed to |
** associate metadata with argument values. If the same value is passed to |
** multiple invocations of the same SQL function during query execution, under |
** multiple invocations of the same SQL function during query execution, under |
** some circumstances the associated metadata may be preserved. This may | ** some circumstances the associated metadata may be preserved. An example |
** be used, for example, to add a regular-expression matching scalar | ** of where this might be useful is in a regular-expression matching |
** function. The compiled version of the regular expression is stored as | ** function. The compiled version of the regular expression can be stored as |
** metadata associated with the SQL value passed as the regular expression | ** metadata associated with the pattern string. |
** pattern. The compiled regular expression can be reused on multiple | ** Then as long as the pattern string remains the same, |
** invocations of the same function so that the original pattern string | ** the compiled regular expression can be reused on multiple |
** does not need to be recompiled on each invocation. | ** invocations of the same function. |
** |
** |
** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata | ** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the metadata |
** associated by the sqlite3_set_auxdata() function with the Nth argument | ** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument |
** value to the application-defined function. ^If no metadata has been ever | ** value to the application-defined function. ^N is zero for the left-most |
** been set for the Nth argument of the function, or if the corresponding | ** function argument. ^If there is no metadata |
** function parameter has changed since the meta-data was set, | ** associated with the function argument, the sqlite3_get_auxdata(C,N) interface |
** then sqlite3_get_auxdata() returns a NULL pointer. | ** returns a NULL pointer. |
** |
** |
** ^The sqlite3_set_auxdata() interface saves the metadata | ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th |
** pointed to by its 3rd parameter as the metadata for the N-th | ** argument of the application-defined function. ^Subsequent |
** argument of the application-defined function. Subsequent | ** calls to sqlite3_get_auxdata(C,N) return P from the most recent |
** calls to sqlite3_get_auxdata() might return this data, if it has | ** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or |
** not been destroyed. | ** NULL if the metadata has been discarded. |
** ^If it is not NULL, SQLite will invoke the destructor | ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL, |
** function given by the 4th parameter to sqlite3_set_auxdata() on | ** SQLite will invoke the destructor function X with parameter P exactly |
** the metadata when the corresponding function parameter changes | ** once, when the metadata is discarded. |
** or when the SQL statement completes, whichever comes first. | ** SQLite is free to discard the metadata at any time, including: <ul> |
| ** <li> ^(when the corresponding function parameter changes)^, or |
| ** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the |
| ** SQL statement)^, or |
| ** <li> ^(when sqlite3_set_auxdata() is invoked again on the same |
| ** parameter)^, or |
| ** <li> ^(during the original sqlite3_set_auxdata() call when a memory |
| ** allocation error occurs.)^ </ul> |
** |
** |
** SQLite is free to call the destructor and drop metadata on any | ** Note the last bullet in particular. The destructor X in |
** parameter of any function at any time. ^The only guarantee is that | ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the |
** the destructor will be called before the metadata is dropped. | ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata() |
| ** should be called near the end of the function implementation and the |
| ** function implementation should not make any use of P after |
| ** sqlite3_set_auxdata() has been called. |
** |
** |
** ^(In practice, metadata is preserved between function calls for |
** ^(In practice, metadata is preserved between function calls for |
** expressions that are constant at compile time. This includes literal | ** function parameters that are compile-time constants, including literal |
** values and [parameters].)^ | ** values and [parameters] and expressions composed from the same.)^ |
** |
** |
|
** The value of the N parameter to these interfaces should be non-negative. |
|
** Future enhancements may make use of negative N values to define new |
|
** kinds of function caching behavior. |
|
** |
** These routines must be called from the same thread in which |
** These routines must be called from the same thread in which |
** the SQL function is running. |
** the SQL function is running. |
*/ |
*/ |
Line 4041 SQLITE_API void sqlite3_set_auxdata(sqlite3_context*,
|
Line 5616 SQLITE_API void sqlite3_set_auxdata(sqlite3_context*,
|
** the content before returning. |
** the content before returning. |
** |
** |
** The typedef is necessary to work around problems in certain |
** The typedef is necessary to work around problems in certain |
** C++ compilers. See ticket #2191. | ** C++ compilers. |
*/ |
*/ |
typedef void (*sqlite3_destructor_type)(void*); |
typedef void (*sqlite3_destructor_type)(void*); |
#define SQLITE_STATIC ((sqlite3_destructor_type)0) |
#define SQLITE_STATIC ((sqlite3_destructor_type)0) |
Line 4049 typedef void (*sqlite3_destructor_type)(void*);
|
Line 5624 typedef void (*sqlite3_destructor_type)(void*);
|
|
|
/* |
/* |
** CAPI3REF: Setting The Result Of An SQL Function |
** CAPI3REF: Setting The Result Of An SQL Function |
|
** METHOD: sqlite3_context |
** |
** |
** These routines are used by the xFunc or xFinal callbacks that |
** These routines are used by the xFunc or xFinal callbacks that |
** implement SQL functions and aggregates. See |
** implement SQL functions and aggregates. See |
Line 4064 typedef void (*sqlite3_destructor_type)(void*);
|
Line 5640 typedef void (*sqlite3_destructor_type)(void*);
|
** to by the second parameter and which is N bytes long where N is the |
** to by the second parameter and which is N bytes long where N is the |
** third parameter. |
** third parameter. |
** |
** |
** ^The sqlite3_result_zeroblob() interfaces set the result of | ** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N) |
** the application-defined function to be a BLOB containing all zero | ** interfaces set the result of the application-defined function to be |
** bytes and N bytes in size, where N is the value of the 2nd parameter. | ** a BLOB containing all zero bytes and N bytes in size. |
** |
** |
** ^The sqlite3_result_double() interface sets the result from |
** ^The sqlite3_result_double() interface sets the result from |
** an application-defined function to be a floating point value specified |
** an application-defined function to be a floating point value specified |
Line 4078 typedef void (*sqlite3_destructor_type)(void*);
|
Line 5654 typedef void (*sqlite3_destructor_type)(void*);
|
** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() |
** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() |
** as the text of an error message. ^SQLite interprets the error |
** as the text of an error message. ^SQLite interprets the error |
** message string from sqlite3_result_error() as UTF-8. ^SQLite |
** message string from sqlite3_result_error() as UTF-8. ^SQLite |
** interprets the string from sqlite3_result_error16() as UTF-16 in native | ** interprets the string from sqlite3_result_error16() as UTF-16 using |
** byte order. ^If the third parameter to sqlite3_result_error() | ** the same [byte-order determination rules] as [sqlite3_bind_text16()]. |
| ** ^If the third parameter to sqlite3_result_error() |
** or sqlite3_result_error16() is negative then SQLite takes as the error |
** or sqlite3_result_error16() is negative then SQLite takes as the error |
** message all text up through the first zero character. |
** message all text up through the first zero character. |
** ^If the third parameter to sqlite3_result_error() or |
** ^If the third parameter to sqlite3_result_error() or |
Line 4094 typedef void (*sqlite3_destructor_type)(void*);
|
Line 5671 typedef void (*sqlite3_destructor_type)(void*);
|
** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() |
** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() |
** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. |
** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. |
** |
** |
** ^The sqlite3_result_toobig() interface causes SQLite to throw an error | ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an |
** indicating that a string or BLOB is too long to represent. | ** error indicating that a string or BLOB is too long to represent. |
** |
** |
** ^The sqlite3_result_nomem() interface causes SQLite to throw an error | ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an |
** indicating that a memory allocation failed. | ** error indicating that a memory allocation failed. |
** |
** |
** ^The sqlite3_result_int() interface sets the return value |
** ^The sqlite3_result_int() interface sets the return value |
** of the application-defined function to be the 32-bit signed integer |
** of the application-defined function to be the 32-bit signed integer |
Line 4115 typedef void (*sqlite3_destructor_type)(void*);
|
Line 5692 typedef void (*sqlite3_destructor_type)(void*);
|
** set the return value of the application-defined function to be |
** set the return value of the application-defined function to be |
** a text string which is represented as UTF-8, UTF-16 native byte order, |
** a text string which is represented as UTF-8, UTF-16 native byte order, |
** UTF-16 little endian, or UTF-16 big endian, respectively. |
** UTF-16 little endian, or UTF-16 big endian, respectively. |
|
** ^The sqlite3_result_text64() interface sets the return value of an |
|
** application-defined function to be a text string in an encoding |
|
** specified by the fifth (and last) parameter, which must be one |
|
** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]. |
** ^SQLite takes the text result from the application from |
** ^SQLite takes the text result from the application from |
** the 2nd parameter of the sqlite3_result_text* interfaces. |
** the 2nd parameter of the sqlite3_result_text* interfaces. |
** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
Line 4140 typedef void (*sqlite3_destructor_type)(void*);
|
Line 5721 typedef void (*sqlite3_destructor_type)(void*);
|
** when it has finished using that result. |
** when it has finished using that result. |
** ^If the 4th parameter to the sqlite3_result_text* interfaces |
** ^If the 4th parameter to the sqlite3_result_text* interfaces |
** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT |
** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT |
** then SQLite makes a copy of the result into space obtained from | ** then SQLite makes a copy of the result into space obtained |
** from [sqlite3_malloc()] before it returns. |
** from [sqlite3_malloc()] before it returns. |
** |
** |
|
** ^For the sqlite3_result_text16(), sqlite3_result_text16le(), and |
|
** sqlite3_result_text16be() routines, and for sqlite3_result_text64() |
|
** when the encoding is not UTF8, if the input UTF16 begins with a |
|
** byte-order mark (BOM, U+FEFF) then the BOM is removed from the |
|
** string and the rest of the string is interpreted according to the |
|
** byte-order specified by the BOM. ^The byte-order specified by |
|
** the BOM at the beginning of the text overrides the byte-order |
|
** specified by the interface procedure. ^So, for example, if |
|
** sqlite3_result_text16le() is invoked with text that begins |
|
** with bytes 0xfe, 0xff (a big-endian byte-order mark) then the |
|
** first two bytes of input are skipped and the remaining input |
|
** is interpreted as UTF16BE text. |
|
** |
|
** ^For UTF16 input text to the sqlite3_result_text16(), |
|
** sqlite3_result_text16be(), sqlite3_result_text16le(), and |
|
** sqlite3_result_text64() routines, if the text contains invalid |
|
** UTF16 characters, the invalid characters might be converted |
|
** into the unicode replacement character, U+FFFD. |
|
** |
** ^The sqlite3_result_value() interface sets the result of |
** ^The sqlite3_result_value() interface sets the result of |
** the application-defined function to be a copy the | ** the application-defined function to be a copy of the |
** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The |
** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The |
** sqlite3_result_value() interface makes a copy of the [sqlite3_value] |
** sqlite3_result_value() interface makes a copy of the [sqlite3_value] |
** so that the [sqlite3_value] specified in the parameter may change or |
** so that the [sqlite3_value] specified in the parameter may change or |
Line 4153 typedef void (*sqlite3_destructor_type)(void*);
|
Line 5753 typedef void (*sqlite3_destructor_type)(void*);
|
** [unprotected sqlite3_value] object is required, so either |
** [unprotected sqlite3_value] object is required, so either |
** kind of [sqlite3_value] object can be used with this interface. |
** kind of [sqlite3_value] object can be used with this interface. |
** |
** |
|
** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an |
|
** SQL NULL value, just like [sqlite3_result_null(C)], except that it |
|
** also associates the host-language pointer P or type T with that |
|
** NULL value such that the pointer can be retrieved within an |
|
** [application-defined SQL function] using [sqlite3_value_pointer()]. |
|
** ^If the D parameter is not NULL, then it is a pointer to a destructor |
|
** for the P parameter. ^SQLite invokes D with P as its only argument |
|
** when SQLite is finished with P. The T parameter should be a static |
|
** string and preferably a string literal. The sqlite3_result_pointer() |
|
** routine is part of the [pointer passing interface] added for SQLite 3.20.0. |
|
** |
** If these routines are called from within the different thread |
** If these routines are called from within the different thread |
** than the one containing the application-defined function that received |
** than the one containing the application-defined function that received |
** the [sqlite3_context] pointer, the results are undefined. |
** the [sqlite3_context] pointer, the results are undefined. |
*/ |
*/ |
SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); |
SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); |
|
SQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*, |
|
sqlite3_uint64,void(*)(void*)); |
SQLITE_API void sqlite3_result_double(sqlite3_context*, double); |
SQLITE_API void sqlite3_result_double(sqlite3_context*, double); |
SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); |
SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); |
SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); |
SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); |
Line 4168 SQLITE_API void sqlite3_result_int(sqlite3_context*, i
|
Line 5781 SQLITE_API void sqlite3_result_int(sqlite3_context*, i
|
SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); |
SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); |
SQLITE_API void sqlite3_result_null(sqlite3_context*); |
SQLITE_API void sqlite3_result_null(sqlite3_context*); |
SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); |
SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); |
|
SQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64, |
|
void(*)(void*), unsigned char encoding); |
SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); |
SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); |
SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); |
SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); |
SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); |
SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); |
SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); |
SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); |
|
SQLITE_API void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*)); |
SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); |
SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); |
|
SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n); |
|
|
|
|
/* |
/* |
|
** CAPI3REF: Setting The Subtype Of An SQL Function |
|
** METHOD: sqlite3_context |
|
** |
|
** The sqlite3_result_subtype(C,T) function causes the subtype of |
|
** the result from the [application-defined SQL function] with |
|
** [sqlite3_context] C to be the value T. Only the lower 8 bits |
|
** of the subtype T are preserved in current versions of SQLite; |
|
** higher order bits are discarded. |
|
** The number of subtype bytes preserved by SQLite might increase |
|
** in future releases of SQLite. |
|
*/ |
|
SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int); |
|
|
|
/* |
** CAPI3REF: Define New Collating Sequences |
** CAPI3REF: Define New Collating Sequences |
|
** METHOD: sqlite3 |
** |
** |
** ^These functions add, remove, or modify a [collation] associated |
** ^These functions add, remove, or modify a [collation] associated |
** with the [database connection] specified as the first argument. |
** with the [database connection] specified as the first argument. |
Line 4195 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
Line 5828 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
** <li> [SQLITE_UTF16_ALIGNED]. |
** <li> [SQLITE_UTF16_ALIGNED]. |
** </ul>)^ |
** </ul>)^ |
** ^The eTextRep argument determines the encoding of strings passed |
** ^The eTextRep argument determines the encoding of strings passed |
** to the collating function callback, xCallback. | ** to the collating function callback, xCompare. |
** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep |
** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep |
** force strings to be UTF16 with native byte order. |
** force strings to be UTF16 with native byte order. |
** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin |
** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin |
Line 4204 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
Line 5837 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
** ^The fourth argument, pArg, is an application data pointer that is passed |
** ^The fourth argument, pArg, is an application data pointer that is passed |
** through as the first argument to the collating function callback. |
** through as the first argument to the collating function callback. |
** |
** |
** ^The fifth argument, xCallback, is a pointer to the collating function. | ** ^The fifth argument, xCompare, is a pointer to the collating function. |
** ^Multiple collating functions can be registered using the same name but |
** ^Multiple collating functions can be registered using the same name but |
** with different eTextRep parameters and SQLite will use whichever |
** with different eTextRep parameters and SQLite will use whichever |
** function requires the least amount of data transformation. |
** function requires the least amount of data transformation. |
** ^If the xCallback argument is NULL then the collating function is | ** ^If the xCompare argument is NULL then the collating function is |
** deleted. ^When all collating functions having the same name are deleted, |
** deleted. ^When all collating functions having the same name are deleted, |
** that collation is no longer usable. |
** that collation is no longer usable. |
** |
** |
** ^The collating function callback is invoked with a copy of the pArg | ** ^The collating function callback is invoked with a copy of the pArg |
** application data pointer and with two strings in the encoding specified |
** application data pointer and with two strings in the encoding specified |
** by the eTextRep argument. The collating function must return an | ** by the eTextRep argument. The two integer parameters to the collating |
** integer that is negative, zero, or positive | ** function callback are the length of the two strings, in bytes. The collating |
| ** function must return an integer that is negative, zero, or positive |
** if the first string is less than, equal to, or greater than the second, |
** if the first string is less than, equal to, or greater than the second, |
** respectively. A collating function must always return the same answer |
** respectively. A collating function must always return the same answer |
** given the same inputs. If two or more collating functions are registered |
** given the same inputs. If two or more collating functions are registered |
Line 4232 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
Line 5866 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
** </ol> |
** </ol> |
** |
** |
** If a collating function fails any of the above constraints and that |
** If a collating function fails any of the above constraints and that |
** collating function is registered and used, then the behavior of SQLite | ** collating function is registered and used, then the behavior of SQLite |
** is undefined. |
** is undefined. |
** |
** |
** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() |
** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() |
Line 4242 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
Line 5876 SQLITE_API void sqlite3_result_zeroblob(sqlite3_contex
|
** calls to the collation creation functions or when the |
** calls to the collation creation functions or when the |
** [database connection] is closed using [sqlite3_close()]. |
** [database connection] is closed using [sqlite3_close()]. |
** |
** |
** ^The xDestroy callback is <u>not</u> called if the | ** ^The xDestroy callback is <u>not</u> called if the |
** sqlite3_create_collation_v2() function fails. Applications that invoke |
** sqlite3_create_collation_v2() function fails. Applications that invoke |
** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should | ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should |
** check the return code and dispose of the application data pointer |
** check the return code and dispose of the application data pointer |
** themselves rather than expecting SQLite to deal with it for them. |
** themselves rather than expecting SQLite to deal with it for them. |
** This is different from every other SQLite interface. The inconsistency | ** This is different from every other SQLite interface. The inconsistency |
** is unfortunate but cannot be changed without breaking backwards | ** is unfortunate but cannot be changed without breaking backwards |
** compatibility. |
** compatibility. |
** |
** |
** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. |
** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. |
*/ |
*/ |
SQLITE_API int sqlite3_create_collation( |
SQLITE_API int sqlite3_create_collation( |
sqlite3*, | sqlite3*, |
const char *zName, | const char *zName, |
int eTextRep, | int eTextRep, |
void *pArg, |
void *pArg, |
int(*xCompare)(void*,int,const void*,int,const void*) |
int(*xCompare)(void*,int,const void*,int,const void*) |
); |
); |
SQLITE_API int sqlite3_create_collation_v2( |
SQLITE_API int sqlite3_create_collation_v2( |
sqlite3*, | sqlite3*, |
const char *zName, | const char *zName, |
int eTextRep, | int eTextRep, |
void *pArg, |
void *pArg, |
int(*xCompare)(void*,int,const void*,int,const void*), |
int(*xCompare)(void*,int,const void*,int,const void*), |
void(*xDestroy)(void*) |
void(*xDestroy)(void*) |
); |
); |
SQLITE_API int sqlite3_create_collation16( |
SQLITE_API int sqlite3_create_collation16( |
sqlite3*, | sqlite3*, |
const void *zName, |
const void *zName, |
int eTextRep, | int eTextRep, |
void *pArg, |
void *pArg, |
int(*xCompare)(void*,int,const void*,int,const void*) |
int(*xCompare)(void*,int,const void*,int,const void*) |
); |
); |
|
|
/* |
/* |
** CAPI3REF: Collation Needed Callbacks |
** CAPI3REF: Collation Needed Callbacks |
|
** METHOD: sqlite3 |
** |
** |
** ^To avoid having to register all collation sequences before a database |
** ^To avoid having to register all collation sequences before a database |
** can be used, a single callback function may be registered with the |
** can be used, a single callback function may be registered with the |
Line 4303 SQLITE_API int sqlite3_create_collation16(
|
Line 5938 SQLITE_API int sqlite3_create_collation16(
|
** [sqlite3_create_collation_v2()]. |
** [sqlite3_create_collation_v2()]. |
*/ |
*/ |
SQLITE_API int sqlite3_collation_needed( |
SQLITE_API int sqlite3_collation_needed( |
sqlite3*, | sqlite3*, |
void*, | void*, |
void(*)(void*,sqlite3*,int eTextRep,const char*) |
void(*)(void*,sqlite3*,int eTextRep,const char*) |
); |
); |
SQLITE_API int sqlite3_collation_needed16( |
SQLITE_API int sqlite3_collation_needed16( |
sqlite3*, | sqlite3*, |
void*, |
void*, |
void(*)(void*,sqlite3*,int eTextRep,const void*) |
void(*)(void*,sqlite3*,int eTextRep,const void*) |
); |
); |
|
|
#ifdef SQLITE_HAS_CODEC |
|
/* |
|
** Specify the key for an encrypted database. This routine should be |
|
** called right after sqlite3_open(). |
|
** |
|
** The code to implement this API is not available in the public release |
|
** of SQLite. |
|
*/ |
|
SQLITE_API int sqlite3_key( |
|
sqlite3 *db, /* Database to be rekeyed */ |
|
const void *pKey, int nKey /* The key */ |
|
); |
|
|
|
/* |
|
** Change the key on an open database. If the current database is not |
|
** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the |
|
** database is decrypted. |
|
** |
|
** The code to implement this API is not available in the public release |
|
** of SQLite. |
|
*/ |
|
SQLITE_API int sqlite3_rekey( |
|
sqlite3 *db, /* Database to be rekeyed */ |
|
const void *pKey, int nKey /* The new key */ |
|
); |
|
|
|
/* |
|
** Specify the activation key for a SEE database. Unless |
|
** activated, none of the SEE routines will work. |
|
*/ |
|
SQLITE_API void sqlite3_activate_see( |
|
const char *zPassPhrase /* Activation phrase */ |
|
); |
|
#endif |
|
|
|
#ifdef SQLITE_ENABLE_CEROD |
#ifdef SQLITE_ENABLE_CEROD |
/* |
/* |
** Specify the activation key for a CEROD database. Unless | ** Specify the activation key for a CEROD database. Unless |
** activated, none of the CEROD routines will work. |
** activated, none of the CEROD routines will work. |
*/ |
*/ |
SQLITE_API void sqlite3_activate_cerod( |
SQLITE_API void sqlite3_activate_cerod( |
Line 4387 SQLITE_API int sqlite3_sleep(int);
|
Line 5987 SQLITE_API int sqlite3_sleep(int);
|
** is a NULL pointer, then SQLite performs a search for an appropriate |
** is a NULL pointer, then SQLite performs a search for an appropriate |
** temporary file directory. |
** temporary file directory. |
** |
** |
|
** Applications are strongly discouraged from using this global variable. |
|
** It is required to set a temporary folder on Windows Runtime (WinRT). |
|
** But for all other platforms, it is highly recommended that applications |
|
** neither read nor write this variable. This global variable is a relic |
|
** that exists for backwards compatibility of legacy applications and should |
|
** be avoided in new projects. |
|
** |
** It is not safe to read or modify this variable in more than one |
** It is not safe to read or modify this variable in more than one |
** thread at a time. It is not safe to read or modify this variable |
** thread at a time. It is not safe to read or modify this variable |
** if a [database connection] is being used at the same time in a separate |
** if a [database connection] is being used at the same time in a separate |
Line 4399 SQLITE_API int sqlite3_sleep(int);
|
Line 6006 SQLITE_API int sqlite3_sleep(int);
|
** ^The [temp_store_directory pragma] may modify this variable and cause |
** ^The [temp_store_directory pragma] may modify this variable and cause |
** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, |
** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, |
** the [temp_store_directory pragma] always assumes that any string |
** the [temp_store_directory pragma] always assumes that any string |
** that this variable points to is held in memory obtained from | ** that this variable points to is held in memory obtained from |
** [sqlite3_malloc] and the pragma may attempt to free that memory |
** [sqlite3_malloc] and the pragma may attempt to free that memory |
** using [sqlite3_free]. |
** using [sqlite3_free]. |
** Hence, if this variable is modified directly, either it should be |
** Hence, if this variable is modified directly, either it should be |
** made NULL or made to point to memory obtained from [sqlite3_malloc] |
** made NULL or made to point to memory obtained from [sqlite3_malloc] |
** or else the use of the [temp_store_directory pragma] should be avoided. |
** or else the use of the [temp_store_directory pragma] should be avoided. |
|
** Except when requested by the [temp_store_directory pragma], SQLite |
|
** does not free the memory that sqlite3_temp_directory points to. If |
|
** the application wants that memory to be freed, it must do |
|
** so itself, taking care to only do so after all [database connection] |
|
** objects have been destroyed. |
|
** |
|
** <b>Note to Windows Runtime users:</b> The temporary directory must be set |
|
** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various |
|
** features that require the use of temporary files may fail. Here is an |
|
** example of how to do this using C++ with the Windows Runtime: |
|
** |
|
** <blockquote><pre> |
|
** LPCWSTR zPath = Windows::Storage::ApplicationData::Current-> |
|
** TemporaryFolder->Path->Data(); |
|
** char zPathBuf[MAX_PATH + 1]; |
|
** memset(zPathBuf, 0, sizeof(zPathBuf)); |
|
** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf), |
|
** NULL, NULL); |
|
** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf); |
|
** </pre></blockquote> |
*/ |
*/ |
SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; |
SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; |
|
|
/* |
/* |
|
** CAPI3REF: Name Of The Folder Holding Database Files |
|
** |
|
** ^(If this global variable is made to point to a string which is |
|
** the name of a folder (a.k.a. directory), then all database files |
|
** specified with a relative pathname and created or accessed by |
|
** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed |
|
** to be relative to that directory.)^ ^If this variable is a NULL |
|
** pointer, then SQLite assumes that all database files specified |
|
** with a relative pathname are relative to the current directory |
|
** for the process. Only the windows VFS makes use of this global |
|
** variable; it is ignored by the unix VFS. |
|
** |
|
** Changing the value of this variable while a database connection is |
|
** open can result in a corrupt database. |
|
** |
|
** It is not safe to read or modify this variable in more than one |
|
** thread at a time. It is not safe to read or modify this variable |
|
** if a [database connection] is being used at the same time in a separate |
|
** thread. |
|
** It is intended that this variable be set once |
|
** as part of process initialization and before any SQLite interface |
|
** routines have been called and that this variable remain unchanged |
|
** thereafter. |
|
** |
|
** ^The [data_store_directory pragma] may modify this variable and cause |
|
** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, |
|
** the [data_store_directory pragma] always assumes that any string |
|
** that this variable points to is held in memory obtained from |
|
** [sqlite3_malloc] and the pragma may attempt to free that memory |
|
** using [sqlite3_free]. |
|
** Hence, if this variable is modified directly, either it should be |
|
** made NULL or made to point to memory obtained from [sqlite3_malloc] |
|
** or else the use of the [data_store_directory pragma] should be avoided. |
|
*/ |
|
SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory; |
|
|
|
/* |
|
** CAPI3REF: Win32 Specific Interface |
|
** |
|
** These interfaces are available only on Windows. The |
|
** [sqlite3_win32_set_directory] interface is used to set the value associated |
|
** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to |
|
** zValue, depending on the value of the type parameter. The zValue parameter |
|
** should be NULL to cause the previous value to be freed via [sqlite3_free]; |
|
** a non-NULL value will be copied into memory obtained from [sqlite3_malloc] |
|
** prior to being used. The [sqlite3_win32_set_directory] interface returns |
|
** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported, |
|
** or [SQLITE_NOMEM] if memory could not be allocated. The value of the |
|
** [sqlite3_data_directory] variable is intended to act as a replacement for |
|
** the current directory on the sub-platforms of Win32 where that concept is |
|
** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and |
|
** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the |
|
** sqlite3_win32_set_directory interface except the string parameter must be |
|
** UTF-8 or UTF-16, respectively. |
|
*/ |
|
SQLITE_API int sqlite3_win32_set_directory( |
|
unsigned long type, /* Identifier for directory being set or reset */ |
|
void *zValue /* New value for directory being set or reset */ |
|
); |
|
SQLITE_API int sqlite3_win32_set_directory8(unsigned long type, const char *zValue); |
|
SQLITE_API int sqlite3_win32_set_directory16(unsigned long type, const void *zValue); |
|
|
|
/* |
|
** CAPI3REF: Win32 Directory Types |
|
** |
|
** These macros are only available on Windows. They define the allowed values |
|
** for the type argument to the [sqlite3_win32_set_directory] interface. |
|
*/ |
|
#define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1 |
|
#define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2 |
|
|
|
/* |
** CAPI3REF: Test For Auto-Commit Mode |
** CAPI3REF: Test For Auto-Commit Mode |
** KEYWORDS: {autocommit mode} |
** KEYWORDS: {autocommit mode} |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_get_autocommit() interface returns non-zero or |
** ^The sqlite3_get_autocommit() interface returns non-zero or |
** zero if the given database connection is or is not in autocommit mode, |
** zero if the given database connection is or is not in autocommit mode, |
Line 4433 SQLITE_API int sqlite3_get_autocommit(sqlite3*);
|
Line 6133 SQLITE_API int sqlite3_get_autocommit(sqlite3*);
|
|
|
/* |
/* |
** CAPI3REF: Find The Database Handle Of A Prepared Statement |
** CAPI3REF: Find The Database Handle Of A Prepared Statement |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^The sqlite3_db_handle interface returns the [database connection] handle |
** ^The sqlite3_db_handle interface returns the [database connection] handle |
** to which a [prepared statement] belongs. ^The [database connection] |
** to which a [prepared statement] belongs. ^The [database connection] |
Line 4445 SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
|
Line 6146 SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
|
|
|
/* |
/* |
** CAPI3REF: Return The Filename For A Database Connection |
** CAPI3REF: Return The Filename For A Database Connection |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename | ** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename |
** associated with database N of connection D. ^The main database file | ** associated with database N of connection D. |
** has the name "main". If there is no attached database N on the database | ** ^If there is no attached database N on the database |
** connection D, or if database N is a temporary or in-memory database, then |
** connection D, or if database N is a temporary or in-memory database, then |
** a NULL pointer is returned. | ** this function will return either a NULL pointer or an empty string. |
** |
** |
|
** ^The string value returned by this routine is owned and managed by |
|
** the database connection. ^The value will be valid until the database N |
|
** is [DETACH]-ed or until the database connection closes. |
|
** |
** ^The filename returned by this function is the output of the |
** ^The filename returned by this function is the output of the |
** xFullPathname method of the [VFS]. ^In other words, the filename |
** xFullPathname method of the [VFS]. ^In other words, the filename |
** will be an absolute pathname, even if the filename used |
** will be an absolute pathname, even if the filename used |
** to open the database originally was a URI or relative pathname. |
** to open the database originally was a URI or relative pathname. |
|
** |
|
** If the filename pointer returned by this routine is not NULL, then it |
|
** can be used as the filename input parameter to these routines: |
|
** <ul> |
|
** <li> [sqlite3_uri_parameter()] |
|
** <li> [sqlite3_uri_boolean()] |
|
** <li> [sqlite3_uri_int64()] |
|
** <li> [sqlite3_filename_database()] |
|
** <li> [sqlite3_filename_journal()] |
|
** <li> [sqlite3_filename_wal()] |
|
** </ul> |
*/ |
*/ |
SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); |
SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); |
|
|
/* |
/* |
|
** CAPI3REF: Determine if a database is read-only |
|
** METHOD: sqlite3 |
|
** |
|
** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N |
|
** of connection D is read-only, 0 if it is read/write, or -1 if N is not |
|
** the name of a database on connection D. |
|
*/ |
|
SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName); |
|
|
|
/* |
** CAPI3REF: Find the next prepared statement |
** CAPI3REF: Find the next prepared statement |
|
** METHOD: sqlite3 |
** |
** |
** ^This interface returns a pointer to the next [prepared statement] after |
** ^This interface returns a pointer to the next [prepared statement] after |
** pStmt associated with the [database connection] pDb. ^If pStmt is NULL |
** pStmt associated with the [database connection] pDb. ^If pStmt is NULL |
Line 4476 SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pD
|
Line 6204 SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pD
|
|
|
/* |
/* |
** CAPI3REF: Commit And Rollback Notification Callbacks |
** CAPI3REF: Commit And Rollback Notification Callbacks |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_commit_hook() interface registers a callback |
** ^The sqlite3_commit_hook() interface registers a callback |
** function to be invoked whenever a transaction is [COMMIT | committed]. |
** function to be invoked whenever a transaction is [COMMIT | committed]. |
Line 4525 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(
|
Line 6254 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(
|
|
|
/* |
/* |
** CAPI3REF: Data Change Notification Callbacks |
** CAPI3REF: Data Change Notification Callbacks |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_update_hook() interface registers a callback function |
** ^The sqlite3_update_hook() interface registers a callback function |
** with the [database connection] identified by the first argument |
** with the [database connection] identified by the first argument |
** to be invoked whenever a row is updated, inserted or deleted. | ** to be invoked whenever a row is updated, inserted or deleted in |
| ** a [rowid table]. |
** ^Any callback set by a previous call to this function |
** ^Any callback set by a previous call to this function |
** for the same database connection is overridden. |
** for the same database connection is overridden. |
** |
** |
** ^The second argument is a pointer to the function to invoke when a |
** ^The second argument is a pointer to the function to invoke when a |
** row is updated, inserted or deleted. | ** row is updated, inserted or deleted in a rowid table. |
** ^The first argument to the callback is a copy of the third argument |
** ^The first argument to the callback is a copy of the third argument |
** to sqlite3_update_hook(). |
** to sqlite3_update_hook(). |
** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], |
** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], |
Line 4545 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(
|
Line 6276 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(
|
** ^In the case of an update, this is the [rowid] after the update takes place. |
** ^In the case of an update, this is the [rowid] after the update takes place. |
** |
** |
** ^(The update hook is not invoked when internal system tables are |
** ^(The update hook is not invoked when internal system tables are |
** modified (i.e. sqlite_master and sqlite_sequence).)^ | ** modified (i.e. sqlite_sequence).)^ |
| ** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified. |
** |
** |
** ^In the current implementation, the update hook |
** ^In the current implementation, the update hook |
** is not invoked when duplication rows are deleted because of an | ** is not invoked when conflicting rows are deleted because of an |
** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook |
** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook |
** invoked when rows are deleted using the [truncate optimization]. |
** invoked when rows are deleted using the [truncate optimization]. |
** The exceptions defined in this paragraph might change in a future |
** The exceptions defined in this paragraph might change in a future |
Line 4566 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(
|
Line 6298 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(
|
** on the same [database connection] D, or NULL for |
** on the same [database connection] D, or NULL for |
** the first call on D. |
** the first call on D. |
** |
** |
** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] | ** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()], |
** interfaces. | ** and [sqlite3_preupdate_hook()] interfaces. |
*/ |
*/ |
SQLITE_API void *sqlite3_update_hook( |
SQLITE_API void *sqlite3_update_hook( |
sqlite3*, | sqlite3*, |
void(*)(void *,int ,char const *,char const *,sqlite3_int64), |
void(*)(void *,int ,char const *,char const *,sqlite3_int64), |
void* |
void* |
); |
); |
|
|
/* |
/* |
** CAPI3REF: Enable Or Disable Shared Pager Cache |
** CAPI3REF: Enable Or Disable Shared Pager Cache |
** KEYWORDS: {shared cache} |
|
** |
** |
** ^(This routine enables or disables the sharing of the database cache |
** ^(This routine enables or disables the sharing of the database cache |
** and schema data structures between [database connection | connections] |
** and schema data structures between [database connection | connections] |
Line 4585 SQLITE_API void *sqlite3_update_hook(
|
Line 6316 SQLITE_API void *sqlite3_update_hook(
|
** and disabled if the argument is false.)^ |
** and disabled if the argument is false.)^ |
** |
** |
** ^Cache sharing is enabled and disabled for an entire process. |
** ^Cache sharing is enabled and disabled for an entire process. |
** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, | ** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]). |
| ** In prior versions of SQLite, |
** sharing was enabled or disabled for each thread separately. |
** sharing was enabled or disabled for each thread separately. |
** |
** |
** ^(The cache sharing mode set by this interface effects all subsequent |
** ^(The cache sharing mode set by this interface effects all subsequent |
** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. |
** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. |
** Existing database connections continue use the sharing mode | ** Existing database connections continue to use the sharing mode |
** that was in effect at the time they were opened.)^ |
** that was in effect at the time they were opened.)^ |
** |
** |
** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled |
** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled |
** successfully. An [error code] is returned otherwise.)^ |
** successfully. An [error code] is returned otherwise.)^ |
** |
** |
** ^Shared cache is disabled by default. But this might change in | ** ^Shared cache is disabled by default. It is recommended that it stay |
** future releases of SQLite. Applications that care about shared | ** that way. In other words, do not use this routine. This interface |
** cache setting should set it explicitly. | ** continues to be provided for historical compatibility, but its use is |
| ** discouraged. Any use of shared cache is discouraged. If shared cache |
| ** must be used, it is recommended that shared cache only be enabled for |
| ** individual database connections using the [sqlite3_open_v2()] interface |
| ** with the [SQLITE_OPEN_SHAREDCACHE] flag. |
** |
** |
|
** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0 |
|
** and will always return SQLITE_MISUSE. On those systems, |
|
** shared cache mode should be enabled per-database connection via |
|
** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE]. |
|
** |
|
** This interface is threadsafe on processors where writing a |
|
** 32-bit integer is atomic. |
|
** |
** See Also: [SQLite Shared-Cache Mode] |
** See Also: [SQLite Shared-Cache Mode] |
*/ |
*/ |
SQLITE_API int sqlite3_enable_shared_cache(int); |
SQLITE_API int sqlite3_enable_shared_cache(int); |
Line 4622 SQLITE_API int sqlite3_release_memory(int);
|
Line 6366 SQLITE_API int sqlite3_release_memory(int);
|
|
|
/* |
/* |
** CAPI3REF: Free Memory Used By A Database Connection |
** CAPI3REF: Free Memory Used By A Database Connection |
|
** METHOD: sqlite3 |
** |
** |
** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap |
** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap |
** memory as possible from database connection D. Unlike the |
** memory as possible from database connection D. Unlike the |
** [sqlite3_release_memory()] interface, this interface is effect even | ** [sqlite3_release_memory()] interface, this interface is in effect even |
** when then [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is | ** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is |
** omitted. |
** omitted. |
** |
** |
** See also: [sqlite3_release_memory()] |
** See also: [sqlite3_release_memory()] |
Line 4636 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
|
Line 6381 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
|
/* |
/* |
** CAPI3REF: Impose A Limit On Heap Size |
** CAPI3REF: Impose A Limit On Heap Size |
** |
** |
|
** These interfaces impose limits on the amount of heap memory that will be |
|
** by all database connections within a single process. |
|
** |
** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the |
** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the |
** soft limit on the amount of heap memory that may be allocated by SQLite. |
** soft limit on the amount of heap memory that may be allocated by SQLite. |
** ^SQLite strives to keep heap memory utilization below the soft heap |
** ^SQLite strives to keep heap memory utilization below the soft heap |
Line 4643 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
|
Line 6391 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
|
** as heap memory usages approaches the limit. |
** as heap memory usages approaches the limit. |
** ^The soft heap limit is "soft" because even though SQLite strives to stay |
** ^The soft heap limit is "soft" because even though SQLite strives to stay |
** below the limit, it will exceed the limit rather than generate |
** below the limit, it will exceed the limit rather than generate |
** an [SQLITE_NOMEM] error. In other words, the soft heap limit | ** an [SQLITE_NOMEM] error. In other words, the soft heap limit |
** is advisory only. |
** is advisory only. |
** |
** |
** ^The return value from sqlite3_soft_heap_limit64() is the size of | ** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of |
** the soft heap limit prior to the call, or negative in the case of an | ** N bytes on the amount of memory that will be allocated. ^The |
| ** sqlite3_hard_heap_limit64(N) interface is similar to |
| ** sqlite3_soft_heap_limit64(N) except that memory allocations will fail |
| ** when the hard heap limit is reached. |
| ** |
| ** ^The return value from both sqlite3_soft_heap_limit64() and |
| ** sqlite3_hard_heap_limit64() is the size of |
| ** the heap limit prior to the call, or negative in the case of an |
** error. ^If the argument N is negative |
** error. ^If the argument N is negative |
** then no change is made to the soft heap limit. Hence, the current | ** then no change is made to the heap limit. Hence, the current |
** size of the soft heap limit can be determined by invoking | ** size of heap limits can be determined by invoking |
** sqlite3_soft_heap_limit64() with a negative argument. | ** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1). |
** |
** |
** ^If the argument N is zero then the soft heap limit is disabled. | ** ^Setting the heap limits to zero disables the heap limiter mechanism. |
** |
** |
** ^(The soft heap limit is not enforced in the current implementation | ** ^The soft heap limit may not be greater than the hard heap limit. |
| ** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N) |
| ** is invoked with a value of N that is greater than the hard heap limit, |
| ** the the soft heap limit is set to the value of the hard heap limit. |
| ** ^The soft heap limit is automatically enabled whenever the hard heap |
| ** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and |
| ** the soft heap limit is outside the range of 1..N, then the soft heap |
| ** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the |
| ** hard heap limit is enabled makes the soft heap limit equal to the |
| ** hard heap limit. |
| ** |
| ** The memory allocation limits can also be adjusted using |
| ** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit]. |
| ** |
| ** ^(The heap limits are not enforced in the current implementation |
** if one or more of following conditions are true: |
** if one or more of following conditions are true: |
** |
** |
** <ul> |
** <ul> |
** <li> The soft heap limit is set to zero. | ** <li> The limit value is set to zero. |
** <li> Memory accounting is disabled using a combination of the |
** <li> Memory accounting is disabled using a combination of the |
** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and |
** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and |
** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. |
** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. |
Line 4670 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
|
Line 6439 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
|
** from the heap. |
** from the heap. |
** </ul>)^ |
** </ul>)^ |
** |
** |
** Beginning with SQLite version 3.7.3, the soft heap limit is enforced | ** The circumstances under which SQLite will enforce the heap limits may |
** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] | |
** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], | |
** the soft heap limit is enforced on every memory allocation. Without | |
** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced | |
** when memory is allocated by the page cache. Testing suggests that because | |
** the page cache is the predominate memory user in SQLite, most | |
** applications will achieve adequate soft heap limit enforcement without | |
** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. | |
** | |
** The circumstances under which SQLite will enforce the soft heap limit may | |
** changes in future releases of SQLite. |
** changes in future releases of SQLite. |
*/ |
*/ |
SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); |
SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); |
|
SQLITE_API sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N); |
|
|
/* |
/* |
** CAPI3REF: Deprecated Soft Heap Limit Interface |
** CAPI3REF: Deprecated Soft Heap Limit Interface |
Line 4699 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
|
Line 6459 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
|
|
|
/* |
/* |
** CAPI3REF: Extract Metadata About A Column Of A Table |
** CAPI3REF: Extract Metadata About A Column Of A Table |
|
** METHOD: sqlite3 |
** |
** |
** ^This routine returns metadata about a specific column of a specific | ** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns |
** database table accessible using the [database connection] handle | ** information about column C of table T in database D |
** passed as the first function argument. | ** on [database connection] X.)^ ^The sqlite3_table_column_metadata() |
| ** interface returns SQLITE_OK and fills in the non-NULL pointers in |
| ** the final five arguments with appropriate values if the specified |
| ** column exists. ^The sqlite3_table_column_metadata() interface returns |
| ** SQLITE_ERROR if the specified column does not exist. |
| ** ^If the column-name parameter to sqlite3_table_column_metadata() is a |
| ** NULL pointer, then this routine simply checks for the existence of the |
| ** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it |
| ** does not. If the table name parameter T in a call to |
| ** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is |
| ** undefined behavior. |
** |
** |
** ^The column is identified by the second, third and fourth parameters to |
** ^The column is identified by the second, third and fourth parameters to |
** this function. ^The second parameter is either the name of the database | ** this function. ^(The second parameter is either the name of the database |
** (i.e. "main", "temp", or an attached database) containing the specified |
** (i.e. "main", "temp", or an attached database) containing the specified |
** table or NULL. ^If it is NULL, then all attached databases are searched | ** table or NULL.)^ ^If it is NULL, then all attached databases are searched |
** for the table using the same algorithm used by the database engine to |
** for the table using the same algorithm used by the database engine to |
** resolve unqualified table references. |
** resolve unqualified table references. |
** |
** |
** ^The third and fourth parameters to this function are the table and column |
** ^The third and fourth parameters to this function are the table and column |
** name of the desired column, respectively. Neither of these parameters | ** name of the desired column, respectively. |
** may be NULL. | |
** |
** |
** ^Metadata is returned by writing to the memory locations passed as the 5th |
** ^Metadata is returned by writing to the memory locations passed as the 5th |
** and subsequent parameters to this function. ^Any of these arguments may be |
** and subsequent parameters to this function. ^Any of these arguments may be |
Line 4732 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
|
Line 6502 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
|
** </blockquote>)^ |
** </blockquote>)^ |
** |
** |
** ^The memory pointed to by the character pointers returned for the |
** ^The memory pointed to by the character pointers returned for the |
** declaration type and collation sequence is valid only until the next | ** declaration type and collation sequence is valid until the next |
** call to any SQLite API function. |
** call to any SQLite API function. |
** |
** |
** ^If the specified table is actually a view, an [error code] is returned. |
** ^If the specified table is actually a view, an [error code] is returned. |
** |
** |
** ^If the specified column is "rowid", "oid" or "_rowid_" and an | ** ^If the specified column is "rowid", "oid" or "_rowid_" and the table |
| ** is not a [WITHOUT ROWID] table and an |
** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output |
** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output |
** parameters are set for the explicitly declared column. ^(If there is no |
** parameters are set for the explicitly declared column. ^(If there is no |
** explicitly declared [INTEGER PRIMARY KEY] column, then the output | ** [INTEGER PRIMARY KEY] column, then the outputs |
** parameters are set as follows: | ** for the [rowid] are set as follows: |
** |
** |
** <pre> |
** <pre> |
** data type: "INTEGER" |
** data type: "INTEGER" |
Line 4751 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
|
Line 6522 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
|
** auto increment: 0 |
** auto increment: 0 |
** </pre>)^ |
** </pre>)^ |
** |
** |
** ^(This function may load one or more schemas from database files. If an | ** ^This function causes all database schemas to be read from disk and |
** error occurs during this process, or if the requested table or column | ** parsed, if that has not already been done, and returns an error if |
** cannot be found, an [error code] is returned and an error message left | ** any errors are encountered while loading the schema. |
** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^ | |
** | |
** ^This API is only available if the library was compiled with the | |
** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. | |
*/ |
*/ |
SQLITE_API int sqlite3_table_column_metadata( |
SQLITE_API int sqlite3_table_column_metadata( |
sqlite3 *db, /* Connection handle */ |
sqlite3 *db, /* Connection handle */ |
Line 4773 SQLITE_API int sqlite3_table_column_metadata(
|
Line 6540 SQLITE_API int sqlite3_table_column_metadata(
|
|
|
/* |
/* |
** CAPI3REF: Load An Extension |
** CAPI3REF: Load An Extension |
|
** METHOD: sqlite3 |
** |
** |
** ^This interface loads an SQLite extension library from the named file. |
** ^This interface loads an SQLite extension library from the named file. |
** |
** |
** ^The sqlite3_load_extension() interface attempts to load an |
** ^The sqlite3_load_extension() interface attempts to load an |
** SQLite extension library contained in the file zFile. | ** [SQLite extension] library contained in the file zFile. If |
| ** the file cannot be loaded directly, attempts are made to load |
| ** with various operating-system specific extensions added. |
| ** So for example, if "samplelib" cannot be loaded, then names like |
| ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might |
| ** be tried also. |
** |
** |
** ^The entry point is zProc. |
** ^The entry point is zProc. |
** ^zProc may be 0, in which case the name of the entry point | ** ^(zProc may be 0, in which case SQLite will try to come up with an |
** defaults to "sqlite3_extension_init". | ** entry point name on its own. It first tries "sqlite3_extension_init". |
| ** If that does not work, it constructs a name "sqlite3_X_init" where the |
| ** X is consists of the lower-case equivalent of all ASCII alphabetic |
| ** characters in the filename from the last "/" to the first following |
| ** "." and omitting any initial "lib".)^ |
** ^The sqlite3_load_extension() interface returns |
** ^The sqlite3_load_extension() interface returns |
** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. |
** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. |
** ^If an error occurs and pzErrMsg is not 0, then the |
** ^If an error occurs and pzErrMsg is not 0, then the |
Line 4791 SQLITE_API int sqlite3_table_column_metadata(
|
Line 6568 SQLITE_API int sqlite3_table_column_metadata(
|
** should free this memory by calling [sqlite3_free()]. |
** should free this memory by calling [sqlite3_free()]. |
** |
** |
** ^Extension loading must be enabled using |
** ^Extension loading must be enabled using |
** [sqlite3_enable_load_extension()] prior to calling this API, | ** [sqlite3_enable_load_extension()] or |
| ** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL) |
| ** prior to calling this API, |
** otherwise an error will be returned. |
** otherwise an error will be returned. |
** |
** |
|
** <b>Security warning:</b> It is recommended that the |
|
** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this |
|
** interface. The use of the [sqlite3_enable_load_extension()] interface |
|
** should be avoided. This will keep the SQL function [load_extension()] |
|
** disabled and prevent SQL injections from giving attackers |
|
** access to extension loading capabilities. |
|
** |
** See also the [load_extension() SQL function]. |
** See also the [load_extension() SQL function]. |
*/ |
*/ |
SQLITE_API int sqlite3_load_extension( |
SQLITE_API int sqlite3_load_extension( |
Line 4805 SQLITE_API int sqlite3_load_extension(
|
Line 6591 SQLITE_API int sqlite3_load_extension(
|
|
|
/* |
/* |
** CAPI3REF: Enable Or Disable Extension Loading |
** CAPI3REF: Enable Or Disable Extension Loading |
|
** METHOD: sqlite3 |
** |
** |
** ^So as not to open security holes in older applications that are |
** ^So as not to open security holes in older applications that are |
** unprepared to deal with extension loading, and as a means of disabling | ** unprepared to deal with [extension loading], and as a means of disabling |
** extension loading while evaluating user-entered SQL, the following API | ** [extension loading] while evaluating user-entered SQL, the following API |
** is provided to turn the [sqlite3_load_extension()] mechanism on and off. |
** is provided to turn the [sqlite3_load_extension()] mechanism on and off. |
** |
** |
** ^Extension loading is off by default. See ticket #1863. | ** ^Extension loading is off by default. |
** ^Call the sqlite3_enable_load_extension() routine with onoff==1 |
** ^Call the sqlite3_enable_load_extension() routine with onoff==1 |
** to turn extension loading on and call it with onoff==0 to turn |
** to turn extension loading on and call it with onoff==0 to turn |
** it back off again. |
** it back off again. |
|
** |
|
** ^This interface enables or disables both the C-API |
|
** [sqlite3_load_extension()] and the SQL function [load_extension()]. |
|
** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..) |
|
** to enable or disable only the C-API.)^ |
|
** |
|
** <b>Security warning:</b> It is recommended that extension loading |
|
** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method |
|
** rather than this interface, so the [load_extension()] SQL function |
|
** remains disabled. This will prevent SQL injections from giving attackers |
|
** access to extension loading capabilities. |
*/ |
*/ |
SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); |
SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); |
|
|
Line 4823 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *
|
Line 6621 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *
|
** |
** |
** ^This interface causes the xEntryPoint() function to be invoked for |
** ^This interface causes the xEntryPoint() function to be invoked for |
** each new [database connection] that is created. The idea here is that |
** each new [database connection] that is created. The idea here is that |
** xEntryPoint() is the entry point for a statically linked SQLite extension | ** xEntryPoint() is the entry point for a statically linked [SQLite extension] |
** that is to be automatically loaded into all new database connections. |
** that is to be automatically loaded into all new database connections. |
** |
** |
** ^(Even though the function prototype shows that xEntryPoint() takes |
** ^(Even though the function prototype shows that xEntryPoint() takes |
** no arguments and returns void, SQLite invokes xEntryPoint() with three |
** no arguments and returns void, SQLite invokes xEntryPoint() with three |
** arguments and expects and integer result as if the signature of the | ** arguments and expects an integer result as if the signature of the |
** entry point where as follows: |
** entry point where as follows: |
** |
** |
** <blockquote><pre> |
** <blockquote><pre> |
Line 4851 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *
|
Line 6649 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *
|
** on the list of automatic extensions is a harmless no-op. ^No entry point |
** on the list of automatic extensions is a harmless no-op. ^No entry point |
** will be called more than once for each database connection that is opened. |
** will be called more than once for each database connection that is opened. |
** |
** |
** See also: [sqlite3_reset_auto_extension()]. | ** See also: [sqlite3_reset_auto_extension()] |
| ** and [sqlite3_cancel_auto_extension()] |
*/ |
*/ |
SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); | SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void)); |
|
|
/* |
/* |
|
** CAPI3REF: Cancel Automatic Extension Loading |
|
** |
|
** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the |
|
** initialization routine X that was registered using a prior call to |
|
** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)] |
|
** routine returns 1 if initialization routine X was successfully |
|
** unregistered and it returns 0 if X was not on the list of initialization |
|
** routines. |
|
*/ |
|
SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void)); |
|
|
|
/* |
** CAPI3REF: Reset Automatic Extension Loading |
** CAPI3REF: Reset Automatic Extension Loading |
** |
** |
** ^This interface disables all automatic extensions previously |
** ^This interface disables all automatic extensions previously |
Line 4884 typedef struct sqlite3_module sqlite3_module;
|
Line 6695 typedef struct sqlite3_module sqlite3_module;
|
** CAPI3REF: Virtual Table Object |
** CAPI3REF: Virtual Table Object |
** KEYWORDS: sqlite3_module {virtual table module} |
** KEYWORDS: sqlite3_module {virtual table module} |
** |
** |
** This structure, sometimes called a "virtual table module", | ** This structure, sometimes called a "virtual table module", |
** defines the implementation of a [virtual tables]. | ** defines the implementation of a [virtual table]. |
** This structure consists mostly of methods for the module. |
** This structure consists mostly of methods for the module. |
** |
** |
** ^A virtual table module is created by filling in a persistent |
** ^A virtual table module is created by filling in a persistent |
Line 4924 struct sqlite3_module {
|
Line 6735 struct sqlite3_module {
|
void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), |
void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), |
void **ppArg); |
void **ppArg); |
int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); |
int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); |
/* The methods above are in version 1 of the sqlite_module object. Those | /* The methods above are in version 1 of the sqlite_module object. Those |
** below are for version 2 and greater. */ |
** below are for version 2 and greater. */ |
int (*xSavepoint)(sqlite3_vtab *pVTab, int); |
int (*xSavepoint)(sqlite3_vtab *pVTab, int); |
int (*xRelease)(sqlite3_vtab *pVTab, int); |
int (*xRelease)(sqlite3_vtab *pVTab, int); |
int (*xRollbackTo)(sqlite3_vtab *pVTab, int); |
int (*xRollbackTo)(sqlite3_vtab *pVTab, int); |
|
/* The methods above are in versions 1 and 2 of the sqlite_module object. |
|
** Those below are for version 3 and greater. */ |
|
int (*xShadowName)(const char*); |
}; |
}; |
|
|
/* |
/* |
Line 4963 struct sqlite3_module {
|
Line 6777 struct sqlite3_module {
|
** ^Information about the ORDER BY clause is stored in aOrderBy[]. |
** ^Information about the ORDER BY clause is stored in aOrderBy[]. |
** ^Each term of aOrderBy records a column of the ORDER BY clause. |
** ^Each term of aOrderBy records a column of the ORDER BY clause. |
** |
** |
|
** The colUsed field indicates which columns of the virtual table may be |
|
** required by the current scan. Virtual table columns are numbered from |
|
** zero in the order in which they appear within the CREATE TABLE statement |
|
** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), |
|
** the corresponding bit is set within the colUsed mask if the column may be |
|
** required by SQLite. If the table has at least 64 columns and any column |
|
** to the right of the first 63 is required, then bit 63 of colUsed is also |
|
** set. In other words, column iCol may be required if the expression |
|
** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to |
|
** non-zero. |
|
** |
** The [xBestIndex] method must fill aConstraintUsage[] with information |
** The [xBestIndex] method must fill aConstraintUsage[] with information |
** about what parameters to pass to xFilter. ^If argvIndex>0 then |
** about what parameters to pass to xFilter. ^If argvIndex>0 then |
** the right-hand side of the corresponding aConstraint[] is evaluated |
** the right-hand side of the corresponding aConstraint[] is evaluated |
** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit |
** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit |
** is true, then the constraint is assumed to be fully handled by the |
** is true, then the constraint is assumed to be fully handled by the |
** virtual table and is not checked again by SQLite.)^ | ** virtual table and might not be checked again by the byte code.)^ ^(The |
| ** aConstraintUsage[].omit flag is an optimization hint. When the omit flag |
| ** is left in its default setting of false, the constraint will always be |
| ** checked separately in byte code. If the omit flag is change to true, then |
| ** the constraint may or may not be checked in byte code. In other words, |
| ** when the omit flag is true there is no guarantee that the constraint will |
| ** not be checked again using byte code.)^ |
** |
** |
** ^The idxNum and idxPtr values are recorded and passed into the |
** ^The idxNum and idxPtr values are recorded and passed into the |
** [xFilter] method. |
** [xFilter] method. |
Line 4979 struct sqlite3_module {
|
Line 6810 struct sqlite3_module {
|
** the correct order to satisfy the ORDER BY clause so that no separate |
** the correct order to satisfy the ORDER BY clause so that no separate |
** sorting step is required. |
** sorting step is required. |
** |
** |
** ^The estimatedCost value is an estimate of the cost of doing the | ** ^The estimatedCost value is an estimate of the cost of a particular |
** particular lookup. A full scan of a table with N entries should have | ** strategy. A cost of N indicates that the cost of the strategy is similar |
** a cost of N. A binary search of a table of N entries should have a | ** to a linear scan of an SQLite table with N rows. A cost of log(N) |
** cost of approximately log(N). | ** indicates that the expense of the operation is similar to that of a |
| ** binary search on a unique indexed field of an SQLite table with N rows. |
| ** |
| ** ^The estimatedRows value is an estimate of the number of rows that |
| ** will be returned by the strategy. |
| ** |
| ** The xBestIndex method may optionally populate the idxFlags field with a |
| ** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag - |
| ** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite |
| ** assumes that the strategy may visit at most one row. |
| ** |
| ** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then |
| ** SQLite also assumes that if a call to the xUpdate() method is made as |
| ** part of the same statement to delete or update a virtual table row and the |
| ** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback |
| ** any database changes. In other words, if the xUpdate() returns |
| ** SQLITE_CONSTRAINT, the database contents must be exactly as they were |
| ** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not |
| ** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by |
| ** the xUpdate method are automatically rolled back by SQLite. |
| ** |
| ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info |
| ** structure for SQLite [version 3.8.2] ([dateof:3.8.2]). |
| ** If a virtual table extension is |
| ** used with an SQLite version earlier than 3.8.2, the results of attempting |
| ** to read or write the estimatedRows field are undefined (but are likely |
| ** to include crashing the application). The estimatedRows field should |
| ** therefore only be used if [sqlite3_libversion_number()] returns a |
| ** value greater than or equal to 3008002. Similarly, the idxFlags field |
| ** was added for [version 3.9.0] ([dateof:3.9.0]). |
| ** It may therefore only be used if |
| ** sqlite3_libversion_number() returns a value greater than or equal to |
| ** 3009000. |
*/ |
*/ |
struct sqlite3_index_info { |
struct sqlite3_index_info { |
/* Inputs */ |
/* Inputs */ |
int nConstraint; /* Number of entries in aConstraint */ |
int nConstraint; /* Number of entries in aConstraint */ |
struct sqlite3_index_constraint { |
struct sqlite3_index_constraint { |
int iColumn; /* Column on left-hand side of constraint */ | int iColumn; /* Column constrained. -1 for ROWID */ |
unsigned char op; /* Constraint operator */ |
unsigned char op; /* Constraint operator */ |
unsigned char usable; /* True if this constraint is usable */ |
unsigned char usable; /* True if this constraint is usable */ |
int iTermOffset; /* Used internally - xBestIndex should ignore */ |
int iTermOffset; /* Used internally - xBestIndex should ignore */ |
Line 5007 struct sqlite3_index_info {
|
Line 6870 struct sqlite3_index_info {
|
char *idxStr; /* String, possibly obtained from sqlite3_malloc */ |
char *idxStr; /* String, possibly obtained from sqlite3_malloc */ |
int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ |
int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ |
int orderByConsumed; /* True if output is already ordered */ |
int orderByConsumed; /* True if output is already ordered */ |
double estimatedCost; /* Estimated cost of using this index */ | double estimatedCost; /* Estimated cost of using this index */ |
| /* Fields below are only available in SQLite 3.8.2 and later */ |
| sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ |
| /* Fields below are only available in SQLite 3.9.0 and later */ |
| int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ |
| /* Fields below are only available in SQLite 3.10.0 and later */ |
| sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ |
}; |
}; |
|
|
/* |
/* |
|
** CAPI3REF: Virtual Table Scan Flags |
|
** |
|
** Virtual table implementations are allowed to set the |
|
** [sqlite3_index_info].idxFlags field to some combination of |
|
** these bits. |
|
*/ |
|
#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ |
|
|
|
/* |
** CAPI3REF: Virtual Table Constraint Operator Codes |
** CAPI3REF: Virtual Table Constraint Operator Codes |
** |
** |
** These macros defined the allowed values for the | ** These macros define the allowed values for the |
** [sqlite3_index_info].aConstraint[].op field. Each value represents |
** [sqlite3_index_info].aConstraint[].op field. Each value represents |
** an operator that is part of a constraint term in the wHERE clause of |
** an operator that is part of a constraint term in the wHERE clause of |
** a query that uses a [virtual table]. |
** a query that uses a [virtual table]. |
*/ |
*/ |
#define SQLITE_INDEX_CONSTRAINT_EQ 2 | #define SQLITE_INDEX_CONSTRAINT_EQ 2 |
#define SQLITE_INDEX_CONSTRAINT_GT 4 | #define SQLITE_INDEX_CONSTRAINT_GT 4 |
#define SQLITE_INDEX_CONSTRAINT_LE 8 | #define SQLITE_INDEX_CONSTRAINT_LE 8 |
#define SQLITE_INDEX_CONSTRAINT_LT 16 | #define SQLITE_INDEX_CONSTRAINT_LT 16 |
#define SQLITE_INDEX_CONSTRAINT_GE 32 | #define SQLITE_INDEX_CONSTRAINT_GE 32 |
#define SQLITE_INDEX_CONSTRAINT_MATCH 64 | #define SQLITE_INDEX_CONSTRAINT_MATCH 64 |
| #define SQLITE_INDEX_CONSTRAINT_LIKE 65 |
| #define SQLITE_INDEX_CONSTRAINT_GLOB 66 |
| #define SQLITE_INDEX_CONSTRAINT_REGEXP 67 |
| #define SQLITE_INDEX_CONSTRAINT_NE 68 |
| #define SQLITE_INDEX_CONSTRAINT_ISNOT 69 |
| #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 |
| #define SQLITE_INDEX_CONSTRAINT_ISNULL 71 |
| #define SQLITE_INDEX_CONSTRAINT_IS 72 |
| #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 |
|
|
/* |
/* |
** CAPI3REF: Register A Virtual Table Implementation |
** CAPI3REF: Register A Virtual Table Implementation |
|
** METHOD: sqlite3 |
** |
** |
** ^These routines are used to register a new [virtual table module] name. |
** ^These routines are used to register a new [virtual table module] name. |
** ^Module names must be registered before |
** ^Module names must be registered before |
Line 5034 struct sqlite3_index_info {
|
Line 6922 struct sqlite3_index_info {
|
** preexisting [virtual table] for the module. |
** preexisting [virtual table] for the module. |
** |
** |
** ^The module name is registered on the [database connection] specified |
** ^The module name is registered on the [database connection] specified |
** by the first parameter. ^The name of the module is given by the | ** by the first parameter. ^The name of the module is given by the |
** second parameter. ^The third parameter is a pointer to |
** second parameter. ^The third parameter is a pointer to |
** the implementation of the [virtual table module]. ^The fourth |
** the implementation of the [virtual table module]. ^The fourth |
** parameter is an arbitrary client data pointer that is passed through |
** parameter is an arbitrary client data pointer that is passed through |
Line 5049 struct sqlite3_index_info {
|
Line 6937 struct sqlite3_index_info {
|
** ^The sqlite3_create_module() |
** ^The sqlite3_create_module() |
** interface is equivalent to sqlite3_create_module_v2() with a NULL |
** interface is equivalent to sqlite3_create_module_v2() with a NULL |
** destructor. |
** destructor. |
|
** |
|
** ^If the third parameter (the pointer to the sqlite3_module object) is |
|
** NULL then no new module is create and any existing modules with the |
|
** same name are dropped. |
|
** |
|
** See also: [sqlite3_drop_modules()] |
*/ |
*/ |
SQLITE_API int sqlite3_create_module( |
SQLITE_API int sqlite3_create_module( |
sqlite3 *db, /* SQLite connection to register module with */ |
sqlite3 *db, /* SQLite connection to register module with */ |
Line 5065 SQLITE_API int sqlite3_create_module_v2(
|
Line 6959 SQLITE_API int sqlite3_create_module_v2(
|
); |
); |
|
|
/* |
/* |
|
** CAPI3REF: Remove Unnecessary Virtual Table Implementations |
|
** METHOD: sqlite3 |
|
** |
|
** ^The sqlite3_drop_modules(D,L) interface removes all virtual |
|
** table modules from database connection D except those named on list L. |
|
** The L parameter must be either NULL or a pointer to an array of pointers |
|
** to strings where the array is terminated by a single NULL pointer. |
|
** ^If the L parameter is NULL, then all virtual table modules are removed. |
|
** |
|
** See also: [sqlite3_create_module()] |
|
*/ |
|
SQLITE_API int sqlite3_drop_modules( |
|
sqlite3 *db, /* Remove modules from this connection */ |
|
const char **azKeep /* Except, do not remove the ones named here */ |
|
); |
|
|
|
/* |
** CAPI3REF: Virtual Table Instance Object |
** CAPI3REF: Virtual Table Instance Object |
** KEYWORDS: sqlite3_vtab |
** KEYWORDS: sqlite3_vtab |
** |
** |
Line 5084 SQLITE_API int sqlite3_create_module_v2(
|
Line 6995 SQLITE_API int sqlite3_create_module_v2(
|
*/ |
*/ |
struct sqlite3_vtab { |
struct sqlite3_vtab { |
const sqlite3_module *pModule; /* The module for this virtual table */ |
const sqlite3_module *pModule; /* The module for this virtual table */ |
int nRef; /* NO LONGER USED */ | int nRef; /* Number of open cursors */ |
char *zErrMsg; /* Error message from sqlite3_mprintf() */ |
char *zErrMsg; /* Error message from sqlite3_mprintf() */ |
/* Virtual table implementations will typically add additional fields */ |
/* Virtual table implementations will typically add additional fields */ |
}; |
}; |
Line 5123 SQLITE_API int sqlite3_declare_vtab(sqlite3*, const ch
|
Line 7034 SQLITE_API int sqlite3_declare_vtab(sqlite3*, const ch
|
|
|
/* |
/* |
** CAPI3REF: Overload A Function For A Virtual Table |
** CAPI3REF: Overload A Function For A Virtual Table |
|
** METHOD: sqlite3 |
** |
** |
** ^(Virtual tables can provide alternative implementations of functions |
** ^(Virtual tables can provide alternative implementations of functions |
** using the [xFindFunction] method of the [virtual table module]. | ** using the [xFindFunction] method of the [virtual table module]. |
** But global versions of those functions |
** But global versions of those functions |
** must exist in order to be overloaded.)^ |
** must exist in order to be overloaded.)^ |
** |
** |
Line 5165 typedef struct sqlite3_blob sqlite3_blob;
|
Line 7077 typedef struct sqlite3_blob sqlite3_blob;
|
|
|
/* |
/* |
** CAPI3REF: Open A BLOB For Incremental I/O |
** CAPI3REF: Open A BLOB For Incremental I/O |
|
** METHOD: sqlite3 |
|
** CONSTRUCTOR: sqlite3_blob |
** |
** |
** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located |
** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located |
** in row iRow, column zColumn, table zTable in database zDb; |
** in row iRow, column zColumn, table zTable in database zDb; |
Line 5174 typedef struct sqlite3_blob sqlite3_blob;
|
Line 7088 typedef struct sqlite3_blob sqlite3_blob;
|
** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; |
** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; |
** </pre>)^ |
** </pre>)^ |
** |
** |
|
** ^(Parameter zDb is not the filename that contains the database, but |
|
** rather the symbolic name of the database. For attached databases, this is |
|
** the name that appears after the AS keyword in the [ATTACH] statement. |
|
** For the main database file, the database name is "main". For TEMP |
|
** tables, the database name is "temp".)^ |
|
** |
** ^If the flags parameter is non-zero, then the BLOB is opened for read |
** ^If the flags parameter is non-zero, then the BLOB is opened for read |
** and write access. ^If it is zero, the BLOB is opened for read access. | ** and write access. ^If the flags parameter is zero, the BLOB is opened for |
** ^It is not possible to open a column that is part of an index or primary | ** read-only access. |
** key for writing. ^If [foreign key constraints] are enabled, it is | |
** not possible to open a column that is part of a [child key] for writing. | |
** |
** |
** ^Note that the database name is not the filename that contains | ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored |
** the database but rather the symbolic name of the database that | ** in *ppBlob. Otherwise an [error code] is returned and, unless the error |
** appears after the AS keyword when the database is connected using [ATTACH]. | ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided |
** ^For the main database file, the database name is "main". | ** the API is not misused, it is always safe to call [sqlite3_blob_close()] |
** ^For TEMP tables, the database name is "temp". | ** on *ppBlob after this function it returns. |
** |
** |
** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written | ** This function fails with SQLITE_ERROR if any of the following are true: |
** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set | ** <ul> |
** to be a null pointer.)^ | ** <li> ^(Database zDb does not exist)^, |
** ^This function sets the [database connection] error code and message | ** <li> ^(Table zTable does not exist within database zDb)^, |
** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related | ** <li> ^(Table zTable is a WITHOUT ROWID table)^, |
** functions. ^Note that the *ppBlob variable is always initialized in a | ** <li> ^(Column zColumn does not exist)^, |
** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob | ** <li> ^(Row iRow is not present in the table)^, |
** regardless of the success or failure of this routine. | ** <li> ^(The specified column of row iRow contains a value that is not |
| ** a TEXT or BLOB value)^, |
| ** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE |
| ** constraint and the blob is being opened for read/write access)^, |
| ** <li> ^([foreign key constraints | Foreign key constraints] are enabled, |
| ** column zColumn is part of a [child key] definition and the blob is |
| ** being opened for read/write access)^. |
| ** </ul> |
** |
** |
|
** ^Unless it returns SQLITE_MISUSE, this function sets the |
|
** [database connection] error code and message accessible via |
|
** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. |
|
** |
|
** A BLOB referenced by sqlite3_blob_open() may be read using the |
|
** [sqlite3_blob_read()] interface and modified by using |
|
** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a |
|
** different row of the same table using the [sqlite3_blob_reopen()] |
|
** interface. However, the column, table, or database of a [BLOB handle] |
|
** cannot be changed after the [BLOB handle] is opened. |
|
** |
** ^(If the row that a BLOB handle points to is modified by an |
** ^(If the row that a BLOB handle points to is modified by an |
** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects |
** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects |
** then the BLOB handle is marked as "expired". |
** then the BLOB handle is marked as "expired". |
Line 5212 typedef struct sqlite3_blob sqlite3_blob;
|
Line 7148 typedef struct sqlite3_blob sqlite3_blob;
|
** blob. |
** blob. |
** |
** |
** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces |
** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces |
** and the built-in [zeroblob] SQL function can be used, if desired, | ** and the built-in [zeroblob] SQL function may be used to create a |
** to create an empty, zero-filled blob in which to read or write using | ** zero-filled blob to read or write using the incremental-blob interface. |
** this interface. | |
** |
** |
** To avoid a resource leak, every open [BLOB handle] should eventually |
** To avoid a resource leak, every open [BLOB handle] should eventually |
** be released by a call to [sqlite3_blob_close()]. |
** be released by a call to [sqlite3_blob_close()]. |
|
** |
|
** See also: [sqlite3_blob_close()], |
|
** [sqlite3_blob_reopen()], [sqlite3_blob_read()], |
|
** [sqlite3_blob_bytes()], [sqlite3_blob_write()]. |
*/ |
*/ |
SQLITE_API int sqlite3_blob_open( |
SQLITE_API int sqlite3_blob_open( |
sqlite3*, |
sqlite3*, |
Line 5231 SQLITE_API int sqlite3_blob_open(
|
Line 7170 SQLITE_API int sqlite3_blob_open(
|
|
|
/* |
/* |
** CAPI3REF: Move a BLOB Handle to a New Row |
** CAPI3REF: Move a BLOB Handle to a New Row |
|
** METHOD: sqlite3_blob |
** |
** |
** ^This function is used to move an existing blob handle so that it points | ** ^This function is used to move an existing [BLOB handle] so that it points |
** to a different row of the same database table. ^The new row is identified |
** to a different row of the same database table. ^The new row is identified |
** by the rowid value passed as the second argument. Only the row can be |
** by the rowid value passed as the second argument. Only the row can be |
** changed. ^The database, table and column on which the blob handle is open |
** changed. ^The database, table and column on which the blob handle is open |
** remain the same. Moving an existing blob handle to a new row can be | ** remain the same. Moving an existing [BLOB handle] to a new row is |
** faster than closing the existing handle and opening a new one. |
** faster than closing the existing handle and opening a new one. |
** |
** |
** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - |
** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - |
Line 5251 SQLITE_API int sqlite3_blob_open(
|
Line 7191 SQLITE_API int sqlite3_blob_open(
|
** |
** |
** ^This function sets the database handle error code and message. |
** ^This function sets the database handle error code and message. |
*/ |
*/ |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); | SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); |
|
|
/* |
/* |
** CAPI3REF: Close A BLOB Handle |
** CAPI3REF: Close A BLOB Handle |
|
** DESTRUCTOR: sqlite3_blob |
** |
** |
** ^Closes an open [BLOB handle]. | ** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed |
| ** unconditionally. Even if this routine returns an error code, the |
| ** handle is still closed.)^ |
** |
** |
** ^Closing a BLOB shall cause the current transaction to commit | ** ^If the blob handle being closed was opened for read-write access, and if |
** if there are no other BLOBs, no pending prepared statements, and the | ** the database is in auto-commit mode and there are no other open read-write |
** database connection is in [autocommit mode]. | ** blob handles or active write statements, the current transaction is |
** ^If any writes were made to the BLOB, they might be held in cache | ** committed. ^If an error occurs while committing the transaction, an error |
** until the close operation if they will fit. | ** code is returned and the transaction rolled back. |
** |
** |
** ^(Closing the BLOB often forces the changes | ** Calling this function with an argument that is not a NULL pointer or an |
** out to disk and so if any I/O errors occur, they will likely occur | ** open blob handle results in undefined behaviour. ^Calling this routine |
** at the time when the BLOB is closed. Any errors that occur during | ** with a null pointer (such as would be returned by a failed call to |
** closing are reported as a non-zero return value.)^ | ** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function |
** | ** is passed a valid open blob handle, the values returned by the |
** ^(The BLOB is closed unconditionally. Even if this routine returns | ** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning. |
** an error code, the BLOB is still closed.)^ | |
** | |
** ^Calling this routine with a null pointer (such as would be returned | |
** by a failed call to [sqlite3_blob_open()]) is a harmless no-op. | |
*/ |
*/ |
SQLITE_API int sqlite3_blob_close(sqlite3_blob *); |
SQLITE_API int sqlite3_blob_close(sqlite3_blob *); |
|
|
/* |
/* |
** CAPI3REF: Return The Size Of An Open BLOB |
** CAPI3REF: Return The Size Of An Open BLOB |
|
** METHOD: sqlite3_blob |
** |
** |
** ^Returns the size in bytes of the BLOB accessible via the | ** ^Returns the size in bytes of the BLOB accessible via the |
** successfully opened [BLOB handle] in its only argument. ^The |
** successfully opened [BLOB handle] in its only argument. ^The |
** incremental blob I/O routines can only read or overwriting existing |
** incremental blob I/O routines can only read or overwriting existing |
** blob content; they cannot change the size of a blob. |
** blob content; they cannot change the size of a blob. |
Line 5294 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
|
Line 7234 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
|
|
|
/* |
/* |
** CAPI3REF: Read Data From A BLOB Incrementally |
** CAPI3REF: Read Data From A BLOB Incrementally |
|
** METHOD: sqlite3_blob |
** |
** |
** ^(This function is used to read data from an open [BLOB handle] into a |
** ^(This function is used to read data from an open [BLOB handle] into a |
** caller-supplied buffer. N bytes of data are copied into buffer Z |
** caller-supplied buffer. N bytes of data are copied into buffer Z |
Line 5322 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void
|
Line 7263 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void
|
|
|
/* |
/* |
** CAPI3REF: Write Data Into A BLOB Incrementally |
** CAPI3REF: Write Data Into A BLOB Incrementally |
|
** METHOD: sqlite3_blob |
** |
** |
** ^This function is used to write data into an open [BLOB handle] from a | ** ^(This function is used to write data into an open [BLOB handle] from a |
** caller-supplied buffer. ^N bytes of data are copied from the buffer Z | ** caller-supplied buffer. N bytes of data are copied from the buffer Z |
** into the open BLOB, starting at offset iOffset. | ** into the open BLOB, starting at offset iOffset.)^ |
** |
** |
|
** ^(On success, sqlite3_blob_write() returns SQLITE_OK. |
|
** Otherwise, an [error code] or an [extended error code] is returned.)^ |
|
** ^Unless SQLITE_MISUSE is returned, this function sets the |
|
** [database connection] error code and message accessible via |
|
** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. |
|
** |
** ^If the [BLOB handle] passed as the first argument was not opened for |
** ^If the [BLOB handle] passed as the first argument was not opened for |
** writing (the flags parameter to [sqlite3_blob_open()] was zero), |
** writing (the flags parameter to [sqlite3_blob_open()] was zero), |
** this function returns [SQLITE_READONLY]. |
** this function returns [SQLITE_READONLY]. |
** |
** |
** ^This function may only modify the contents of the BLOB; it is | ** This function may only modify the contents of the BLOB; it is |
** not possible to increase the size of a BLOB using this API. |
** not possible to increase the size of a BLOB using this API. |
** ^If offset iOffset is less than N bytes from the end of the BLOB, |
** ^If offset iOffset is less than N bytes from the end of the BLOB, |
** [SQLITE_ERROR] is returned and no data is written. ^If N is | ** [SQLITE_ERROR] is returned and no data is written. The size of the |
** less than zero [SQLITE_ERROR] is returned and no data is written. | ** BLOB (and hence the maximum value of N+iOffset) can be determined |
** The size of the BLOB (and hence the maximum value of N+iOffset) | ** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less |
** can be determined using the [sqlite3_blob_bytes()] interface. | ** than zero [SQLITE_ERROR] is returned and no data is written. |
** |
** |
** ^An attempt to write to an expired [BLOB handle] fails with an |
** ^An attempt to write to an expired [BLOB handle] fails with an |
** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred |
** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred |
Line 5346 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void
|
Line 7294 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void
|
** have been overwritten by the statement that expired the BLOB handle |
** have been overwritten by the statement that expired the BLOB handle |
** or by other independent statements. |
** or by other independent statements. |
** |
** |
** ^(On success, sqlite3_blob_write() returns SQLITE_OK. |
|
** Otherwise, an [error code] or an [extended error code] is returned.)^ |
|
** |
|
** This routine only works on a [BLOB handle] which has been created |
** This routine only works on a [BLOB handle] which has been created |
** by a prior successful call to [sqlite3_blob_open()] and which has not |
** by a prior successful call to [sqlite3_blob_open()] and which has not |
** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
Line 5401 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
Line 7346 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
** |
** |
** The SQLite source code contains multiple implementations |
** The SQLite source code contains multiple implementations |
** of these mutex routines. An appropriate implementation |
** of these mutex routines. An appropriate implementation |
** is selected automatically at compile-time. ^(The following | ** is selected automatically at compile-time. The following |
** implementations are available in the SQLite core: |
** implementations are available in the SQLite core: |
** |
** |
** <ul> |
** <ul> |
** <li> SQLITE_MUTEX_OS2 |
|
** <li> SQLITE_MUTEX_PTHREADS |
** <li> SQLITE_MUTEX_PTHREADS |
** <li> SQLITE_MUTEX_W32 |
** <li> SQLITE_MUTEX_W32 |
** <li> SQLITE_MUTEX_NOOP |
** <li> SQLITE_MUTEX_NOOP |
** </ul>)^ | ** </ul> |
** |
** |
** ^The SQLITE_MUTEX_NOOP implementation is a set of routines | ** The SQLITE_MUTEX_NOOP implementation is a set of routines |
** that does no real locking and is appropriate for use in |
** that does no real locking and is appropriate for use in |
** a single-threaded application. ^The SQLITE_MUTEX_OS2, | ** a single-threaded application. The SQLITE_MUTEX_PTHREADS and |
** SQLITE_MUTEX_PTHREADS, and SQLITE_MUTEX_W32 implementations | ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix |
** are appropriate for use on OS/2, Unix, and Windows. | ** and Windows. |
** |
** |
** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor | ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor |
** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex |
** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex |
** implementation is included with the library. In this case the |
** implementation is included with the library. In this case the |
** application must supply a custom mutex implementation using the |
** application must supply a custom mutex implementation using the |
** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function |
** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function |
** before calling sqlite3_initialize() or any other public sqlite3_ |
** before calling sqlite3_initialize() or any other public sqlite3_ |
** function that calls sqlite3_initialize().)^ | ** function that calls sqlite3_initialize(). |
** |
** |
** ^The sqlite3_mutex_alloc() routine allocates a new |
** ^The sqlite3_mutex_alloc() routine allocates a new |
** mutex and returns a pointer to it. ^If it returns NULL | ** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc() |
** that means that a mutex could not be allocated. ^SQLite | ** routine returns NULL if it is unable to allocate the requested |
** will unwind its stack and return an error. ^(The argument | ** mutex. The argument to sqlite3_mutex_alloc() must one of these |
** to sqlite3_mutex_alloc() is one of these integer constants: | ** integer constants: |
** |
** |
** <ul> |
** <ul> |
** <li> SQLITE_MUTEX_FAST |
** <li> SQLITE_MUTEX_FAST |
** <li> SQLITE_MUTEX_RECURSIVE |
** <li> SQLITE_MUTEX_RECURSIVE |
** <li> SQLITE_MUTEX_STATIC_MASTER | ** <li> SQLITE_MUTEX_STATIC_MAIN |
** <li> SQLITE_MUTEX_STATIC_MEM |
** <li> SQLITE_MUTEX_STATIC_MEM |
** <li> SQLITE_MUTEX_STATIC_MEM2 | ** <li> SQLITE_MUTEX_STATIC_OPEN |
** <li> SQLITE_MUTEX_STATIC_PRNG |
** <li> SQLITE_MUTEX_STATIC_PRNG |
** <li> SQLITE_MUTEX_STATIC_LRU |
** <li> SQLITE_MUTEX_STATIC_LRU |
** <li> SQLITE_MUTEX_STATIC_LRU2 | ** <li> SQLITE_MUTEX_STATIC_PMEM |
** </ul>)^ | ** <li> SQLITE_MUTEX_STATIC_APP1 |
| ** <li> SQLITE_MUTEX_STATIC_APP2 |
| ** <li> SQLITE_MUTEX_STATIC_APP3 |
| ** <li> SQLITE_MUTEX_STATIC_VFS1 |
| ** <li> SQLITE_MUTEX_STATIC_VFS2 |
| ** <li> SQLITE_MUTEX_STATIC_VFS3 |
| ** </ul> |
** |
** |
** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) |
** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) |
** cause sqlite3_mutex_alloc() to create |
** cause sqlite3_mutex_alloc() to create |
Line 5448 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
Line 7398 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
** is used but not necessarily so when SQLITE_MUTEX_FAST is used. |
** is used but not necessarily so when SQLITE_MUTEX_FAST is used. |
** The mutex implementation does not need to make a distinction |
** The mutex implementation does not need to make a distinction |
** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does |
** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does |
** not want to. ^SQLite will only request a recursive mutex in | ** not want to. SQLite will only request a recursive mutex in |
** cases where it really needs one. ^If a faster non-recursive mutex | ** cases where it really needs one. If a faster non-recursive mutex |
** implementation is available on the host platform, the mutex subsystem |
** implementation is available on the host platform, the mutex subsystem |
** might return such a mutex in response to SQLITE_MUTEX_FAST. |
** might return such a mutex in response to SQLITE_MUTEX_FAST. |
** |
** |
** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other |
** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other |
** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return |
** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return |
** a pointer to a static preexisting mutex. ^Six static mutexes are | ** a pointer to a static preexisting mutex. ^Nine static mutexes are |
** used by the current version of SQLite. Future versions of SQLite |
** used by the current version of SQLite. Future versions of SQLite |
** may add additional static mutexes. Static mutexes are for internal |
** may add additional static mutexes. Static mutexes are for internal |
** use by SQLite only. Applications that use SQLite mutexes should |
** use by SQLite only. Applications that use SQLite mutexes should |
Line 5464 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
Line 7414 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
** |
** |
** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST |
** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST |
** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() |
** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() |
** returns a different mutex on every call. ^But for the static | ** returns a different mutex on every call. ^For the static |
** mutex types, the same mutex is returned on every call that has |
** mutex types, the same mutex is returned on every call that has |
** the same type number. |
** the same type number. |
** |
** |
** ^The sqlite3_mutex_free() routine deallocates a previously |
** ^The sqlite3_mutex_free() routine deallocates a previously |
** allocated dynamic mutex. ^SQLite is careful to deallocate every | ** allocated dynamic mutex. Attempting to deallocate a static |
** dynamic mutex that it allocates. The dynamic mutexes must not be in | ** mutex results in undefined behavior. |
** use when they are deallocated. Attempting to deallocate a static | |
** mutex results in undefined behavior. ^SQLite never deallocates | |
** a static mutex. | |
** |
** |
** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt |
** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt |
** to enter a mutex. ^If another thread is already within the mutex, |
** to enter a mutex. ^If another thread is already within the mutex, |
Line 5481 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
Line 7428 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] |
** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] |
** upon successful entry. ^(Mutexes created using |
** upon successful entry. ^(Mutexes created using |
** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. |
** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. |
** In such cases the, | ** In such cases, the |
** mutex must be exited an equal number of times before another thread |
** mutex must be exited an equal number of times before another thread |
** can enter.)^ ^(If the same thread tries to enter any other | ** can enter.)^ If the same thread tries to enter any mutex other |
** kind of mutex more than once, the behavior is undefined. | ** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined. |
** SQLite will never exhibit | |
** such behavior in its own use of mutexes.)^ | |
** |
** |
** ^(Some systems (for example, Windows 95) do not support the operation |
** ^(Some systems (for example, Windows 95) do not support the operation |
** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() |
** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() |
** will always return SQLITE_BUSY. The SQLite core only ever uses | ** will always return SQLITE_BUSY. The SQLite core only ever uses |
** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^ | ** sqlite3_mutex_try() as an optimization so this is acceptable |
| ** behavior.)^ |
** |
** |
** ^The sqlite3_mutex_leave() routine exits a mutex that was |
** ^The sqlite3_mutex_leave() routine exits a mutex that was |
** previously entered by the same thread. ^(The behavior | ** previously entered by the same thread. The behavior |
** is undefined if the mutex is not currently entered by the |
** is undefined if the mutex is not currently entered by the |
** calling thread or is not currently allocated. SQLite will | ** calling thread or is not currently allocated. |
** never do either.)^ | |
** |
** |
** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or |
** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or |
** sqlite3_mutex_leave() is a NULL pointer, then all three routines |
** sqlite3_mutex_leave() is a NULL pointer, then all three routines |
Line 5518 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
|
Line 7463 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
|
** used to allocate and use mutexes. |
** used to allocate and use mutexes. |
** |
** |
** Usually, the default mutex implementations provided by SQLite are |
** Usually, the default mutex implementations provided by SQLite are |
** sufficient, however the user has the option of substituting a custom | ** sufficient, however the application has the option of substituting a custom |
** implementation for specialized deployments or systems for which SQLite |
** implementation for specialized deployments or systems for which SQLite |
** does not provide a suitable implementation. In this case, the user | ** does not provide a suitable implementation. In this case, the application |
** creates and populates an instance of this structure to pass |
** creates and populates an instance of this structure to pass |
** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. |
** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. |
** Additionally, an instance of this structure can be used as an |
** Additionally, an instance of this structure can be used as an |
Line 5556 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
|
Line 7501 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
|
** The only difference is that the public sqlite3_XXX functions enumerated |
** The only difference is that the public sqlite3_XXX functions enumerated |
** above silently ignore any invocations that pass a NULL pointer instead |
** above silently ignore any invocations that pass a NULL pointer instead |
** of a valid mutex handle. The implementations of the methods defined |
** of a valid mutex handle. The implementations of the methods defined |
** by this structure are not required to handle this case, the results | ** by this structure are not required to handle this case. The results |
** of passing a NULL pointer instead of a valid mutex handle are undefined |
** of passing a NULL pointer instead of a valid mutex handle are undefined |
** (i.e. it is acceptable to provide an implementation that segfaults if |
** (i.e. it is acceptable to provide an implementation that segfaults if |
** it is passed a NULL pointer). |
** it is passed a NULL pointer). |
** |
** |
** The xMutexInit() method must be threadsafe. ^It must be harmless to | ** The xMutexInit() method must be threadsafe. It must be harmless to |
** invoke xMutexInit() multiple times within the same process and without |
** invoke xMutexInit() multiple times within the same process and without |
** intervening calls to xMutexEnd(). Second and subsequent calls to |
** intervening calls to xMutexEnd(). Second and subsequent calls to |
** xMutexInit() must be no-ops. |
** xMutexInit() must be no-ops. |
** |
** |
** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] | ** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] |
** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory | ** and its associates). Similarly, xMutexAlloc() must not use SQLite memory |
** allocation for a static mutex. ^However xMutexAlloc() may use SQLite |
** allocation for a static mutex. ^However xMutexAlloc() may use SQLite |
** memory allocation for a fast or recursive mutex. |
** memory allocation for a fast or recursive mutex. |
** |
** |
Line 5593 struct sqlite3_mutex_methods {
|
Line 7538 struct sqlite3_mutex_methods {
|
** CAPI3REF: Mutex Verification Routines |
** CAPI3REF: Mutex Verification Routines |
** |
** |
** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines |
** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines |
** are intended for use inside assert() statements. ^The SQLite core | ** are intended for use inside assert() statements. The SQLite core |
** never uses these routines except inside an assert() and applications |
** never uses these routines except inside an assert() and applications |
** are advised to follow the lead of the core. ^The SQLite core only | ** are advised to follow the lead of the core. The SQLite core only |
** provides implementations for these routines when it is compiled |
** provides implementations for these routines when it is compiled |
** with the SQLITE_DEBUG flag. ^External mutex implementations | ** with the SQLITE_DEBUG flag. External mutex implementations |
** are only required to provide these routines if SQLITE_DEBUG is |
** are only required to provide these routines if SQLITE_DEBUG is |
** defined and if NDEBUG is not defined. |
** defined and if NDEBUG is not defined. |
** |
** |
** ^These routines should return true if the mutex in their argument | ** These routines should return true if the mutex in their argument |
** is held or not held, respectively, by the calling thread. |
** is held or not held, respectively, by the calling thread. |
** |
** |
** ^The implementation is not required to provide versions of these | ** The implementation is not required to provide versions of these |
** routines that actually work. If the implementation does not provide working |
** routines that actually work. If the implementation does not provide working |
** versions of these routines, it should at least provide stubs that always |
** versions of these routines, it should at least provide stubs that always |
** return true so that one does not get spurious assertion failures. |
** return true so that one does not get spurious assertion failures. |
** |
** |
** ^If the argument to sqlite3_mutex_held() is a NULL pointer then | ** If the argument to sqlite3_mutex_held() is a NULL pointer then |
** the routine should return 1. This seems counter-intuitive since |
** the routine should return 1. This seems counter-intuitive since |
** clearly the mutex cannot be held if it does not exist. But |
** clearly the mutex cannot be held if it does not exist. But |
** the reason the mutex does not exist is because the build is not |
** the reason the mutex does not exist is because the build is not |
** using mutexes. And we do not want the assert() containing the |
** using mutexes. And we do not want the assert() containing the |
** call to sqlite3_mutex_held() to fail, so a non-zero return is |
** call to sqlite3_mutex_held() to fail, so a non-zero return is |
** the appropriate thing to do. ^The sqlite3_mutex_notheld() | ** the appropriate thing to do. The sqlite3_mutex_notheld() |
** interface should also return 1 when given a NULL pointer. |
** interface should also return 1 when given a NULL pointer. |
*/ |
*/ |
#ifndef NDEBUG |
#ifndef NDEBUG |
Line 5635 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
|
Line 7580 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
|
*/ |
*/ |
#define SQLITE_MUTEX_FAST 0 |
#define SQLITE_MUTEX_FAST 0 |
#define SQLITE_MUTEX_RECURSIVE 1 |
#define SQLITE_MUTEX_RECURSIVE 1 |
#define SQLITE_MUTEX_STATIC_MASTER 2 | #define SQLITE_MUTEX_STATIC_MAIN 2 |
#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ |
#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ |
#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ |
#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ |
#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ |
#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ |
#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ | #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */ |
#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ |
#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ |
#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ |
#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ |
#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ |
#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ |
|
#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */ |
|
#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */ |
|
#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */ |
|
#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */ |
|
#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */ |
|
#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */ |
|
|
|
/* Legacy compatibility: */ |
|
#define SQLITE_MUTEX_STATIC_MASTER 2 |
|
|
|
|
/* |
/* |
** CAPI3REF: Retrieve the mutex for a database connection |
** CAPI3REF: Retrieve the mutex for a database connection |
|
** METHOD: sqlite3 |
** |
** |
** ^This interface returns a pointer the [sqlite3_mutex] object that | ** ^This interface returns a pointer the [sqlite3_mutex] object that |
** serializes access to the [database connection] given in the argument |
** serializes access to the [database connection] given in the argument |
** when the [threading mode] is Serialized. |
** when the [threading mode] is Serialized. |
** ^If the [threading mode] is Single-thread or Multi-thread then this |
** ^If the [threading mode] is Single-thread or Multi-thread then this |
Line 5657 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
|
Line 7613 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
|
|
|
/* |
/* |
** CAPI3REF: Low-Level Control Of Database Files |
** CAPI3REF: Low-Level Control Of Database Files |
|
** METHOD: sqlite3 |
|
** KEYWORDS: {file control} |
** |
** |
** ^The [sqlite3_file_control()] interface makes a direct call to the |
** ^The [sqlite3_file_control()] interface makes a direct call to the |
** xFileControl method for the [sqlite3_io_methods] object associated |
** xFileControl method for the [sqlite3_io_methods] object associated |
Line 5671 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
|
Line 7629 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
|
** the xFileControl method. ^The return value of the xFileControl |
** the xFileControl method. ^The return value of the xFileControl |
** method becomes the return value of this routine. |
** method becomes the return value of this routine. |
** |
** |
** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes | ** A few opcodes for [sqlite3_file_control()] are handled directly |
| ** by the SQLite core and never invoke the |
| ** sqlite3_io_methods.xFileControl method. |
| ** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes |
** a pointer to the underlying [sqlite3_file] object to be written into |
** a pointer to the underlying [sqlite3_file] object to be written into |
** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER | ** the space pointed to by the 4th parameter. The |
** case is a short-circuit path which does not actually invoke the | ** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns |
** underlying sqlite3_io_methods.xFileControl method. | ** the [sqlite3_file] object associated with the journal file instead of |
| ** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns |
| ** a pointer to the underlying [sqlite3_vfs] object for the file. |
| ** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter |
| ** from the pager. |
** |
** |
** ^If the second parameter (zDbName) does not match the name of any |
** ^If the second parameter (zDbName) does not match the name of any |
** open database file, then SQLITE_ERROR is returned. ^This error |
** open database file, then SQLITE_ERROR is returned. ^This error |
Line 5685 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
|
Line 7650 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
|
** an incorrect zDbName and an SQLITE_ERROR return from the underlying |
** an incorrect zDbName and an SQLITE_ERROR return from the underlying |
** xFileControl method. |
** xFileControl method. |
** |
** |
** See also: [SQLITE_FCNTL_LOCKSTATE] | ** See also: [file control opcodes] |
*/ |
*/ |
SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); |
SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); |
|
|
Line 5722 SQLITE_API int sqlite3_test_control(int op, ...);
|
Line 7687 SQLITE_API int sqlite3_test_control(int op, ...);
|
#define SQLITE_TESTCTRL_FIRST 5 |
#define SQLITE_TESTCTRL_FIRST 5 |
#define SQLITE_TESTCTRL_PRNG_SAVE 5 |
#define SQLITE_TESTCTRL_PRNG_SAVE 5 |
#define SQLITE_TESTCTRL_PRNG_RESTORE 6 |
#define SQLITE_TESTCTRL_PRNG_RESTORE 6 |
#define SQLITE_TESTCTRL_PRNG_RESET 7 | #define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */ |
#define SQLITE_TESTCTRL_BITVEC_TEST 8 |
#define SQLITE_TESTCTRL_BITVEC_TEST 8 |
#define SQLITE_TESTCTRL_FAULT_INSTALL 9 |
#define SQLITE_TESTCTRL_FAULT_INSTALL 9 |
#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 |
#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 |
#define SQLITE_TESTCTRL_PENDING_BYTE 11 |
#define SQLITE_TESTCTRL_PENDING_BYTE 11 |
#define SQLITE_TESTCTRL_ASSERT 12 |
#define SQLITE_TESTCTRL_ASSERT 12 |
#define SQLITE_TESTCTRL_ALWAYS 13 |
#define SQLITE_TESTCTRL_ALWAYS 13 |
#define SQLITE_TESTCTRL_RESERVE 14 | #define SQLITE_TESTCTRL_RESERVE 14 /* NOT USED */ |
#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 |
#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 |
#define SQLITE_TESTCTRL_ISKEYWORD 16 | #define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */ |
#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 | #define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */ |
| #define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17 |
#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 |
#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 |
#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 | #define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */ |
#define SQLITE_TESTCTRL_LAST 19 | #define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19 |
| #define SQLITE_TESTCTRL_NEVER_CORRUPT 20 |
| #define SQLITE_TESTCTRL_VDBE_COVERAGE 21 |
| #define SQLITE_TESTCTRL_BYTEORDER 22 |
| #define SQLITE_TESTCTRL_ISINIT 23 |
| #define SQLITE_TESTCTRL_SORTER_MMAP 24 |
| #define SQLITE_TESTCTRL_IMPOSTER 25 |
| #define SQLITE_TESTCTRL_PARSER_COVERAGE 26 |
| #define SQLITE_TESTCTRL_RESULT_INTREAL 27 |
| #define SQLITE_TESTCTRL_PRNG_SEED 28 |
| #define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29 |
| #define SQLITE_TESTCTRL_LAST 29 /* Largest TESTCTRL */ |
|
|
/* |
/* |
|
** CAPI3REF: SQL Keyword Checking |
|
** |
|
** These routines provide access to the set of SQL language keywords |
|
** recognized by SQLite. Applications can uses these routines to determine |
|
** whether or not a specific identifier needs to be escaped (for example, |
|
** by enclosing in double-quotes) so as not to confuse the parser. |
|
** |
|
** The sqlite3_keyword_count() interface returns the number of distinct |
|
** keywords understood by SQLite. |
|
** |
|
** The sqlite3_keyword_name(N,Z,L) interface finds the N-th keyword and |
|
** makes *Z point to that keyword expressed as UTF8 and writes the number |
|
** of bytes in the keyword into *L. The string that *Z points to is not |
|
** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns |
|
** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z |
|
** or L are NULL or invalid pointers then calls to |
|
** sqlite3_keyword_name(N,Z,L) result in undefined behavior. |
|
** |
|
** The sqlite3_keyword_check(Z,L) interface checks to see whether or not |
|
** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero |
|
** if it is and zero if not. |
|
** |
|
** The parser used by SQLite is forgiving. It is often possible to use |
|
** a keyword as an identifier as long as such use does not result in a |
|
** parsing ambiguity. For example, the statement |
|
** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and |
|
** creates a new table named "BEGIN" with three columns named |
|
** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid |
|
** using keywords as identifiers. Common techniques used to avoid keyword |
|
** name collisions include: |
|
** <ul> |
|
** <li> Put all identifier names inside double-quotes. This is the official |
|
** SQL way to escape identifier names. |
|
** <li> Put identifier names inside [...]. This is not standard SQL, |
|
** but it is what SQL Server does and so lots of programmers use this |
|
** technique. |
|
** <li> Begin every identifier with the letter "Z" as no SQL keywords start |
|
** with "Z". |
|
** <li> Include a digit somewhere in every identifier name. |
|
** </ul> |
|
** |
|
** Note that the number of keywords understood by SQLite can depend on |
|
** compile-time options. For example, "VACUUM" is not a keyword if |
|
** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also, |
|
** new keywords may be added to future releases of SQLite. |
|
*/ |
|
SQLITE_API int sqlite3_keyword_count(void); |
|
SQLITE_API int sqlite3_keyword_name(int,const char**,int*); |
|
SQLITE_API int sqlite3_keyword_check(const char*,int); |
|
|
|
/* |
|
** CAPI3REF: Dynamic String Object |
|
** KEYWORDS: {dynamic string} |
|
** |
|
** An instance of the sqlite3_str object contains a dynamically-sized |
|
** string under construction. |
|
** |
|
** The lifecycle of an sqlite3_str object is as follows: |
|
** <ol> |
|
** <li> ^The sqlite3_str object is created using [sqlite3_str_new()]. |
|
** <li> ^Text is appended to the sqlite3_str object using various |
|
** methods, such as [sqlite3_str_appendf()]. |
|
** <li> ^The sqlite3_str object is destroyed and the string it created |
|
** is returned using the [sqlite3_str_finish()] interface. |
|
** </ol> |
|
*/ |
|
typedef struct sqlite3_str sqlite3_str; |
|
|
|
/* |
|
** CAPI3REF: Create A New Dynamic String Object |
|
** CONSTRUCTOR: sqlite3_str |
|
** |
|
** ^The [sqlite3_str_new(D)] interface allocates and initializes |
|
** a new [sqlite3_str] object. To avoid memory leaks, the object returned by |
|
** [sqlite3_str_new()] must be freed by a subsequent call to |
|
** [sqlite3_str_finish(X)]. |
|
** |
|
** ^The [sqlite3_str_new(D)] interface always returns a pointer to a |
|
** valid [sqlite3_str] object, though in the event of an out-of-memory |
|
** error the returned object might be a special singleton that will |
|
** silently reject new text, always return SQLITE_NOMEM from |
|
** [sqlite3_str_errcode()], always return 0 for |
|
** [sqlite3_str_length()], and always return NULL from |
|
** [sqlite3_str_finish(X)]. It is always safe to use the value |
|
** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter |
|
** to any of the other [sqlite3_str] methods. |
|
** |
|
** The D parameter to [sqlite3_str_new(D)] may be NULL. If the |
|
** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum |
|
** length of the string contained in the [sqlite3_str] object will be |
|
** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead |
|
** of [SQLITE_MAX_LENGTH]. |
|
*/ |
|
SQLITE_API sqlite3_str *sqlite3_str_new(sqlite3*); |
|
|
|
/* |
|
** CAPI3REF: Finalize A Dynamic String |
|
** DESTRUCTOR: sqlite3_str |
|
** |
|
** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X |
|
** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()] |
|
** that contains the constructed string. The calling application should |
|
** pass the returned value to [sqlite3_free()] to avoid a memory leak. |
|
** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any |
|
** errors were encountered during construction of the string. ^The |
|
** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the |
|
** string in [sqlite3_str] object X is zero bytes long. |
|
*/ |
|
SQLITE_API char *sqlite3_str_finish(sqlite3_str*); |
|
|
|
/* |
|
** CAPI3REF: Add Content To A Dynamic String |
|
** METHOD: sqlite3_str |
|
** |
|
** These interfaces add content to an sqlite3_str object previously obtained |
|
** from [sqlite3_str_new()]. |
|
** |
|
** ^The [sqlite3_str_appendf(X,F,...)] and |
|
** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf] |
|
** functionality of SQLite to append formatted text onto the end of |
|
** [sqlite3_str] object X. |
|
** |
|
** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S |
|
** onto the end of the [sqlite3_str] object X. N must be non-negative. |
|
** S must contain at least N non-zero bytes of content. To append a |
|
** zero-terminated string in its entirety, use the [sqlite3_str_appendall()] |
|
** method instead. |
|
** |
|
** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of |
|
** zero-terminated string S onto the end of [sqlite3_str] object X. |
|
** |
|
** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the |
|
** single-byte character C onto the end of [sqlite3_str] object X. |
|
** ^This method can be used, for example, to add whitespace indentation. |
|
** |
|
** ^The [sqlite3_str_reset(X)] method resets the string under construction |
|
** inside [sqlite3_str] object X back to zero bytes in length. |
|
** |
|
** These methods do not return a result code. ^If an error occurs, that fact |
|
** is recorded in the [sqlite3_str] object and can be recovered by a |
|
** subsequent call to [sqlite3_str_errcode(X)]. |
|
*/ |
|
SQLITE_API void sqlite3_str_appendf(sqlite3_str*, const char *zFormat, ...); |
|
SQLITE_API void sqlite3_str_vappendf(sqlite3_str*, const char *zFormat, va_list); |
|
SQLITE_API void sqlite3_str_append(sqlite3_str*, const char *zIn, int N); |
|
SQLITE_API void sqlite3_str_appendall(sqlite3_str*, const char *zIn); |
|
SQLITE_API void sqlite3_str_appendchar(sqlite3_str*, int N, char C); |
|
SQLITE_API void sqlite3_str_reset(sqlite3_str*); |
|
|
|
/* |
|
** CAPI3REF: Status Of A Dynamic String |
|
** METHOD: sqlite3_str |
|
** |
|
** These interfaces return the current status of an [sqlite3_str] object. |
|
** |
|
** ^If any prior errors have occurred while constructing the dynamic string |
|
** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return |
|
** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns |
|
** [SQLITE_NOMEM] following any out-of-memory error, or |
|
** [SQLITE_TOOBIG] if the size of the dynamic string exceeds |
|
** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors. |
|
** |
|
** ^The [sqlite3_str_length(X)] method returns the current length, in bytes, |
|
** of the dynamic string under construction in [sqlite3_str] object X. |
|
** ^The length returned by [sqlite3_str_length(X)] does not include the |
|
** zero-termination byte. |
|
** |
|
** ^The [sqlite3_str_value(X)] method returns a pointer to the current |
|
** content of the dynamic string under construction in X. The value |
|
** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X |
|
** and might be freed or altered by any subsequent method on the same |
|
** [sqlite3_str] object. Applications must not used the pointer returned |
|
** [sqlite3_str_value(X)] after any subsequent method call on the same |
|
** object. ^Applications may change the content of the string returned |
|
** by [sqlite3_str_value(X)] as long as they do not write into any bytes |
|
** outside the range of 0 to [sqlite3_str_length(X)] and do not read or |
|
** write any byte after any subsequent sqlite3_str method call. |
|
*/ |
|
SQLITE_API int sqlite3_str_errcode(sqlite3_str*); |
|
SQLITE_API int sqlite3_str_length(sqlite3_str*); |
|
SQLITE_API char *sqlite3_str_value(sqlite3_str*); |
|
|
|
/* |
** CAPI3REF: SQLite Runtime Status |
** CAPI3REF: SQLite Runtime Status |
** |
** |
** ^This interface is used to retrieve runtime status information | ** ^These interfaces are used to retrieve runtime status information |
** about the performance of SQLite, and optionally to reset various |
** about the performance of SQLite, and optionally to reset various |
** highwater marks. ^The first argument is an integer code for |
** highwater marks. ^The first argument is an integer code for |
** the specific parameter to measure. ^(Recognized integer codes |
** the specific parameter to measure. ^(Recognized integer codes |
Line 5754 SQLITE_API int sqlite3_test_control(int op, ...);
|
Line 7914 SQLITE_API int sqlite3_test_control(int op, ...);
|
** ^(Other parameters record only the highwater mark and not the current |
** ^(Other parameters record only the highwater mark and not the current |
** value. For these latter parameters nothing is written into *pCurrent.)^ |
** value. For these latter parameters nothing is written into *pCurrent.)^ |
** |
** |
** ^The sqlite3_status() routine returns SQLITE_OK on success and a | ** ^The sqlite3_status() and sqlite3_status64() routines return |
** non-zero [error code] on failure. | ** SQLITE_OK on success and a non-zero [error code] on failure. |
** |
** |
** This routine is threadsafe but is not atomic. This routine can be | ** If either the current value or the highwater mark is too large to |
** called while other threads are running the same or different SQLite | ** be represented by a 32-bit integer, then the values returned by |
** interfaces. However the values returned in *pCurrent and | ** sqlite3_status() are undefined. |
** *pHighwater reflect the status of SQLite at different points in time | |
** and it is possible that another thread might change the parameter | |
** in between the times when *pCurrent and *pHighwater are written. | |
** |
** |
** See also: [sqlite3_db_status()] |
** See also: [sqlite3_db_status()] |
*/ |
*/ |
SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); |
SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); |
|
SQLITE_API int sqlite3_status64( |
|
int op, |
|
sqlite3_int64 *pCurrent, |
|
sqlite3_int64 *pHighwater, |
|
int resetFlag |
|
); |
|
|
|
|
/* |
/* |
Line 5781 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
Line 7944 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
** <dd>This parameter is the current amount of memory checked out |
** <dd>This parameter is the current amount of memory checked out |
** using [sqlite3_malloc()], either directly or indirectly. The |
** using [sqlite3_malloc()], either directly or indirectly. The |
** figure includes calls made to [sqlite3_malloc()] by the application |
** figure includes calls made to [sqlite3_malloc()] by the application |
** and internal memory usage by the SQLite library. Scratch memory | ** and internal memory usage by the SQLite library. Auxiliary page-cache |
** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache | |
** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in |
** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in |
** this parameter. The amount returned is the sum of the allocation |
** this parameter. The amount returned is the sum of the allocation |
** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ |
** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ |
Line 5791 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
Line 7953 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
** <dd>This parameter records the largest memory allocation request |
** <dd>This parameter records the largest memory allocation request |
** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their |
** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their |
** internal equivalents). Only the value returned in the |
** internal equivalents). Only the value returned in the |
** *pHighwater parameter to [sqlite3_status()] is of interest. | ** *pHighwater parameter to [sqlite3_status()] is of interest. |
** The value written into the *pCurrent parameter is undefined.</dd>)^ |
** The value written into the *pCurrent parameter is undefined.</dd>)^ |
** |
** |
** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> |
** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> |
Line 5800 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
Line 7962 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
** |
** |
** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> |
** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> |
** <dd>This parameter returns the number of pages used out of the |
** <dd>This parameter returns the number of pages used out of the |
** [pagecache memory allocator] that was configured using | ** [pagecache memory allocator] that was configured using |
** [SQLITE_CONFIG_PAGECACHE]. The |
** [SQLITE_CONFIG_PAGECACHE]. The |
** value returned is in pages, not in bytes.</dd>)^ |
** value returned is in pages, not in bytes.</dd>)^ |
** |
** |
** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] | ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] |
** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> |
** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> |
** <dd>This parameter returns the number of bytes of page cache |
** <dd>This parameter returns the number of bytes of page cache |
** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] |
** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] |
Line 5816 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
Line 7978 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
** |
** |
** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> |
** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> |
** <dd>This parameter records the largest memory allocation request |
** <dd>This parameter records the largest memory allocation request |
** handed to [pagecache memory allocator]. Only the value returned in the | ** handed to the [pagecache memory allocator]. Only the value returned in the |
** *pHighwater parameter to [sqlite3_status()] is of interest. | ** *pHighwater parameter to [sqlite3_status()] is of interest. |
** The value written into the *pCurrent parameter is undefined.</dd>)^ |
** The value written into the *pCurrent parameter is undefined.</dd>)^ |
** |
** |
** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> | ** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt> |
** <dd>This parameter returns the number of allocations used out of the | ** <dd>No longer used.</dd> |
** [scratch memory allocator] configured using | |
** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not | |
** in bytes. Since a single thread may only have one scratch allocation | |
** outstanding at time, this parameter also reports the number of threads | |
** using scratch memory at the same time.</dd>)^ | |
** |
** |
** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> |
** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> |
** <dd>This parameter returns the number of bytes of scratch memory | ** <dd>No longer used.</dd> |
** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] | |
** buffer and where forced to overflow to [sqlite3_malloc()]. The values | |
** returned include overflows because the requested allocation was too | |
** larger (that is, because the requested allocation was larger than the | |
** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer | |
** slots were available. | |
** </dd>)^ | |
** |
** |
** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> | ** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt> |
** <dd>This parameter records the largest memory allocation request | ** <dd>No longer used.</dd> |
** handed to [scratch memory allocator]. Only the value returned in the | |
** *pHighwater parameter to [sqlite3_status()] is of interest. | |
** The value written into the *pCurrent parameter is undefined.</dd>)^ | |
** |
** |
** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> |
** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> |
** <dd>This parameter records the deepest parser stack. It is only | ** <dd>The *pHighwater parameter records the deepest parser stack. |
| ** The *pCurrent value is undefined. The *pHighwater value is only |
** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ |
** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ |
** </dl> |
** </dl> |
** |
** |
Line 5854 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
Line 8002 SQLITE_API int sqlite3_status(int op, int *pCurrent, i
|
#define SQLITE_STATUS_MEMORY_USED 0 |
#define SQLITE_STATUS_MEMORY_USED 0 |
#define SQLITE_STATUS_PAGECACHE_USED 1 |
#define SQLITE_STATUS_PAGECACHE_USED 1 |
#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 |
#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 |
#define SQLITE_STATUS_SCRATCH_USED 3 | #define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */ |
#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 | #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */ |
#define SQLITE_STATUS_MALLOC_SIZE 5 |
#define SQLITE_STATUS_MALLOC_SIZE 5 |
#define SQLITE_STATUS_PARSER_STACK 6 |
#define SQLITE_STATUS_PARSER_STACK 6 |
#define SQLITE_STATUS_PAGECACHE_SIZE 7 |
#define SQLITE_STATUS_PAGECACHE_SIZE 7 |
#define SQLITE_STATUS_SCRATCH_SIZE 8 | #define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */ |
#define SQLITE_STATUS_MALLOC_COUNT 9 |
#define SQLITE_STATUS_MALLOC_COUNT 9 |
|
|
/* |
/* |
** CAPI3REF: Database Connection Status |
** CAPI3REF: Database Connection Status |
|
** METHOD: sqlite3 |
** |
** |
** ^This interface is used to retrieve runtime status information | ** ^This interface is used to retrieve runtime status information |
** about a single [database connection]. ^The first argument is the |
** about a single [database connection]. ^The first argument is the |
** database connection object to be interrogated. ^The second argument |
** database connection object to be interrogated. ^The second argument |
** is an integer constant, taken from the set of |
** is an integer constant, taken from the set of |
** [SQLITE_DBSTATUS options], that |
** [SQLITE_DBSTATUS options], that |
** determines the parameter to interrogate. The set of | ** determines the parameter to interrogate. The set of |
** [SQLITE_DBSTATUS options] is likely |
** [SQLITE_DBSTATUS options] is likely |
** to grow in future releases of SQLite. |
** to grow in future releases of SQLite. |
** |
** |
Line 5905 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
Line 8054 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
** checked out.</dd>)^ |
** checked out.</dd>)^ |
** |
** |
** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> |
** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> |
** <dd>This parameter returns the number malloc attempts that were | ** <dd>This parameter returns the number of malloc attempts that were |
** satisfied using lookaside memory. Only the high-water value is meaningful; |
** satisfied using lookaside memory. Only the high-water value is meaningful; |
** the current value is always zero.)^ |
** the current value is always zero.)^ |
** |
** |
Line 5926 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
Line 8075 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
** the current value is always zero.)^ |
** the current value is always zero.)^ |
** |
** |
** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> |
** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> |
** <dd>This parameter returns the approximate number of of bytes of heap | ** <dd>This parameter returns the approximate number of bytes of heap |
** memory used by all pager caches associated with the database connection.)^ |
** memory used by all pager caches associated with the database connection.)^ |
** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. |
** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. |
** |
** |
|
** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]] |
|
** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt> |
|
** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a |
|
** pager cache is shared between two or more connections the bytes of heap |
|
** memory used by that pager cache is divided evenly between the attached |
|
** connections.)^ In other words, if none of the pager caches associated |
|
** with the database connection are shared, this request returns the same |
|
** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are |
|
** shared, the value returned by this call will be smaller than that returned |
|
** by DBSTATUS_CACHE_USED. ^The highwater mark associated with |
|
** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. |
|
** |
** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> |
** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> |
** <dd>This parameter returns the approximate number of of bytes of heap | ** <dd>This parameter returns the approximate number of bytes of heap |
** memory used to store the schema for all databases associated |
** memory used to store the schema for all databases associated |
** with the connection - main, temp, and any [ATTACH]-ed databases.)^ | ** with the connection - main, temp, and any [ATTACH]-ed databases.)^ |
** ^The full amount of memory used by the schemas is reported, even if the |
** ^The full amount of memory used by the schemas is reported, even if the |
** schema memory is shared with other database connections due to |
** schema memory is shared with other database connections due to |
** [shared cache mode] being enabled. |
** [shared cache mode] being enabled. |
** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. |
** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. |
** |
** |
** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> |
** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> |
** <dd>This parameter returns the approximate number of of bytes of heap | ** <dd>This parameter returns the approximate number of bytes of heap |
** and lookaside memory used by all prepared statements associated with |
** and lookaside memory used by all prepared statements associated with |
** the database connection.)^ |
** the database connection.)^ |
** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. |
** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. |
Line 5948 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
Line 8109 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
** |
** |
** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> |
** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> |
** <dd>This parameter returns the number of pager cache hits that have |
** <dd>This parameter returns the number of pager cache hits that have |
** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT | ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT |
** is always 0. |
** is always 0. |
** </dd> |
** </dd> |
** |
** |
** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> |
** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> |
** <dd>This parameter returns the number of pager cache misses that have |
** <dd>This parameter returns the number of pager cache misses that have |
** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS | ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS |
** is always 0. |
** is always 0. |
** </dd> |
** </dd> |
|
** |
|
** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt> |
|
** <dd>This parameter returns the number of dirty cache entries that have |
|
** been written to disk. Specifically, the number of pages written to the |
|
** wal file in wal mode databases, or the number of pages written to the |
|
** database file in rollback mode databases. Any pages written as part of |
|
** transaction rollback or database recovery operations are not included. |
|
** If an IO or other error occurs while writing a page to disk, the effect |
|
** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The |
|
** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt> |
|
** <dd>This parameter returns the number of dirty cache entries that have |
|
** been written to disk in the middle of a transaction due to the page |
|
** cache overflowing. Transactions are more efficient if they are written |
|
** to disk all at once. When pages spill mid-transaction, that introduces |
|
** additional overhead. This parameter can be used help identify |
|
** inefficiencies that can be resolved by increasing the cache size. |
|
** </dd> |
|
** |
|
** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt> |
|
** <dd>This parameter returns zero for the current value if and only if |
|
** all foreign key constraints (deferred or immediate) have been |
|
** resolved.)^ ^The highwater mark is always 0. |
|
** </dd> |
** </dl> |
** </dl> |
*/ |
*/ |
#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 |
#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 |
Line 5968 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
Line 8155 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 |
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 |
#define SQLITE_DBSTATUS_CACHE_HIT 7 |
#define SQLITE_DBSTATUS_CACHE_HIT 7 |
#define SQLITE_DBSTATUS_CACHE_MISS 8 |
#define SQLITE_DBSTATUS_CACHE_MISS 8 |
#define SQLITE_DBSTATUS_MAX 8 /* Largest defined DBSTATUS */ | #define SQLITE_DBSTATUS_CACHE_WRITE 9 |
| #define SQLITE_DBSTATUS_DEFERRED_FKS 10 |
| #define SQLITE_DBSTATUS_CACHE_USED_SHARED 11 |
| #define SQLITE_DBSTATUS_CACHE_SPILL 12 |
| #define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */ |
|
|
|
|
/* |
/* |
** CAPI3REF: Prepared Statement Status |
** CAPI3REF: Prepared Statement Status |
|
** METHOD: sqlite3_stmt |
** |
** |
** ^(Each prepared statement maintains various |
** ^(Each prepared statement maintains various |
** [SQLITE_STMTSTATUS counters] that measure the number |
** [SQLITE_STMTSTATUS counters] that measure the number |
Line 5981 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
Line 8173 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
|
** statements. For example, if the number of table steps greatly exceeds |
** statements. For example, if the number of table steps greatly exceeds |
** the number of table searches or result rows, that would tend to indicate |
** the number of table searches or result rows, that would tend to indicate |
** that the prepared statement is using a full table scan rather than |
** that the prepared statement is using a full table scan rather than |
** an index. | ** an index. |
** |
** |
** ^(This interface is used to retrieve and reset counter values from |
** ^(This interface is used to retrieve and reset counter values from |
** a [prepared statement]. The first argument is the prepared statement |
** a [prepared statement]. The first argument is the prepared statement |
Line 6008 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int
|
Line 8200 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int
|
** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> |
** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> |
** <dd>^This is the number of times that SQLite has stepped forward in |
** <dd>^This is the number of times that SQLite has stepped forward in |
** a table as part of a full table scan. Large numbers for this counter |
** a table as part of a full table scan. Large numbers for this counter |
** may indicate opportunities for performance improvement through | ** may indicate opportunities for performance improvement through |
** careful use of indices.</dd> |
** careful use of indices.</dd> |
** |
** |
** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> |
** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> |
Line 6022 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int
|
Line 8214 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int
|
** A non-zero value in this counter may indicate an opportunity to |
** A non-zero value in this counter may indicate an opportunity to |
** improvement performance by adding permanent indices that do not |
** improvement performance by adding permanent indices that do not |
** need to be reinitialized each time the statement is run.</dd> |
** need to be reinitialized each time the statement is run.</dd> |
|
** |
|
** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt> |
|
** <dd>^This is the number of virtual machine operations executed |
|
** by the prepared statement if that number is less than or equal |
|
** to 2147483647. The number of virtual machine operations can be |
|
** used as a proxy for the total work done by the prepared statement. |
|
** If the number of virtual machine operations exceeds 2147483647 |
|
** then the value returned by this statement status code is undefined. |
|
** |
|
** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt> |
|
** <dd>^This is the number of times that the prepare statement has been |
|
** automatically regenerated due to schema changes or changes to |
|
** [bound parameters] that might affect the query plan. |
|
** |
|
** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt> |
|
** <dd>^This is the number of times that the prepared statement has |
|
** been run. A single "run" for the purposes of this counter is one |
|
** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()]. |
|
** The counter is incremented on the first [sqlite3_step()] call of each |
|
** cycle. |
|
** |
|
** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt> |
|
** <dd>^This is the approximate number of bytes of heap memory |
|
** used to store the prepared statement. ^This value is not actually |
|
** a counter, and so the resetFlg parameter to sqlite3_stmt_status() |
|
** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED. |
|
** </dd> |
** </dl> |
** </dl> |
*/ |
*/ |
#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 |
#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 |
#define SQLITE_STMTSTATUS_SORT 2 |
#define SQLITE_STMTSTATUS_SORT 2 |
#define SQLITE_STMTSTATUS_AUTOINDEX 3 |
#define SQLITE_STMTSTATUS_AUTOINDEX 3 |
|
#define SQLITE_STMTSTATUS_VM_STEP 4 |
|
#define SQLITE_STMTSTATUS_REPREPARE 5 |
|
#define SQLITE_STMTSTATUS_RUN 6 |
|
#define SQLITE_STMTSTATUS_MEMUSED 99 |
|
|
/* |
/* |
** CAPI3REF: Custom Page Cache Object |
** CAPI3REF: Custom Page Cache Object |
Line 6062 struct sqlite3_pcache_page {
|
Line 8285 struct sqlite3_pcache_page {
|
** KEYWORDS: {page cache} |
** KEYWORDS: {page cache} |
** |
** |
** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can |
** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can |
** register an alternative page cache implementation by passing in an | ** register an alternative page cache implementation by passing in an |
** instance of the sqlite3_pcache_methods2 structure.)^ |
** instance of the sqlite3_pcache_methods2 structure.)^ |
** In many applications, most of the heap memory allocated by | ** In many applications, most of the heap memory allocated by |
** SQLite is used for the page cache. |
** SQLite is used for the page cache. |
** By implementing a | ** By implementing a |
** custom page cache using this API, an application can better control |
** custom page cache using this API, an application can better control |
** the amount of memory consumed by SQLite, the way in which | ** the amount of memory consumed by SQLite, the way in which |
** that memory is allocated and released, and the policies used to | ** that memory is allocated and released, and the policies used to |
** determine exactly which parts of a database file are cached and for | ** determine exactly which parts of a database file are cached and for |
** how long. |
** how long. |
** |
** |
** The alternative page cache mechanism is an |
** The alternative page cache mechanism is an |
Line 6083 struct sqlite3_pcache_page {
|
Line 8306 struct sqlite3_pcache_page {
|
** [sqlite3_config()] returns.)^ |
** [sqlite3_config()] returns.)^ |
** |
** |
** [[the xInit() page cache method]] |
** [[the xInit() page cache method]] |
** ^(The xInit() method is called once for each effective | ** ^(The xInit() method is called once for each effective |
** call to [sqlite3_initialize()])^ |
** call to [sqlite3_initialize()])^ |
** (usually only once during the lifetime of the process). ^(The xInit() |
** (usually only once during the lifetime of the process). ^(The xInit() |
** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ |
** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ |
** The intent of the xInit() method is to set up global data structures | ** The intent of the xInit() method is to set up global data structures |
** required by the custom page cache implementation. | ** required by the custom page cache implementation. |
** ^(If the xInit() method is NULL, then the | ** ^(If the xInit() method is NULL, then the |
** built-in default page cache is used instead of the application defined |
** built-in default page cache is used instead of the application defined |
** page cache.)^ |
** page cache.)^ |
** |
** |
** [[the xShutdown() page cache method]] |
** [[the xShutdown() page cache method]] |
** ^The xShutdown() method is called by [sqlite3_shutdown()]. |
** ^The xShutdown() method is called by [sqlite3_shutdown()]. |
** It can be used to clean up | ** It can be used to clean up |
** any outstanding resources before process shutdown, if required. |
** any outstanding resources before process shutdown, if required. |
** ^The xShutdown() method may be NULL. |
** ^The xShutdown() method may be NULL. |
** |
** |
Line 6114 struct sqlite3_pcache_page {
|
Line 8337 struct sqlite3_pcache_page {
|
** though this is not guaranteed. ^The |
** though this is not guaranteed. ^The |
** first parameter, szPage, is the size in bytes of the pages that must |
** first parameter, szPage, is the size in bytes of the pages that must |
** be allocated by the cache. ^szPage will always a power of two. ^The |
** be allocated by the cache. ^szPage will always a power of two. ^The |
** second parameter szExtra is a number of bytes of extra storage | ** second parameter szExtra is a number of bytes of extra storage |
** associated with each page cache entry. ^The szExtra parameter will |
** associated with each page cache entry. ^The szExtra parameter will |
** a number less than 250. SQLite will use the |
** a number less than 250. SQLite will use the |
** extra szExtra bytes on each page to store metadata about the underlying |
** extra szExtra bytes on each page to store metadata about the underlying |
Line 6127 struct sqlite3_pcache_page {
|
Line 8350 struct sqlite3_pcache_page {
|
** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will |
** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will |
** never invoke xUnpin() except to deliberately delete a page. |
** never invoke xUnpin() except to deliberately delete a page. |
** ^In other words, calls to xUnpin() on a cache with bPurgeable set to |
** ^In other words, calls to xUnpin() on a cache with bPurgeable set to |
** false will always have the "discard" flag set to true. | ** false will always have the "discard" flag set to true. |
** ^Hence, a cache created with bPurgeable false will |
** ^Hence, a cache created with bPurgeable false will |
** never contain any unpinned pages. |
** never contain any unpinned pages. |
** |
** |
Line 6142 struct sqlite3_pcache_page {
|
Line 8365 struct sqlite3_pcache_page {
|
** [[the xPagecount() page cache methods]] |
** [[the xPagecount() page cache methods]] |
** The xPagecount() method must return the number of pages currently |
** The xPagecount() method must return the number of pages currently |
** stored in the cache, both pinned and unpinned. |
** stored in the cache, both pinned and unpinned. |
** | ** |
** [[the xFetch() page cache methods]] |
** [[the xFetch() page cache methods]] |
** The xFetch() method locates a page in the cache and returns a pointer to | ** The xFetch() method locates a page in the cache and returns a pointer to |
** an sqlite3_pcache_page object associated with that page, or a NULL pointer. |
** an sqlite3_pcache_page object associated with that page, or a NULL pointer. |
** The pBuf element of the returned sqlite3_pcache_page object will be a |
** The pBuf element of the returned sqlite3_pcache_page object will be a |
** pointer to a buffer of szPage bytes used to store the content of a | ** pointer to a buffer of szPage bytes used to store the content of a |
** single database page. The pExtra element of sqlite3_pcache_page will be |
** single database page. The pExtra element of sqlite3_pcache_page will be |
** a pointer to the szExtra bytes of extra storage that SQLite has requested |
** a pointer to the szExtra bytes of extra storage that SQLite has requested |
** for each entry in the page cache. |
** for each entry in the page cache. |
Line 6163 struct sqlite3_pcache_page {
|
Line 8386 struct sqlite3_pcache_page {
|
** parameter to help it determined what action to take: |
** parameter to help it determined what action to take: |
** |
** |
** <table border=1 width=85% align=center> |
** <table border=1 width=85% align=center> |
** <tr><th> createFlag <th> Behaviour when page is not already in cache | ** <tr><th> createFlag <th> Behavior when page is not already in cache |
** <tr><td> 0 <td> Do not allocate a new page. Return NULL. |
** <tr><td> 0 <td> Do not allocate a new page. Return NULL. |
** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. |
** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. |
** Otherwise return NULL. |
** Otherwise return NULL. |
Line 6173 struct sqlite3_pcache_page {
|
Line 8396 struct sqlite3_pcache_page {
|
** |
** |
** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite |
** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite |
** will only use a createFlag of 2 after a prior call with a createFlag of 1 |
** will only use a createFlag of 2 after a prior call with a createFlag of 1 |
** failed.)^ In between the to xFetch() calls, SQLite may | ** failed.)^ In between the xFetch() calls, SQLite may |
** attempt to unpin one or more cache pages by spilling the content of |
** attempt to unpin one or more cache pages by spilling the content of |
** pinned pages to disk and synching the operating system disk cache. |
** pinned pages to disk and synching the operating system disk cache. |
** |
** |
Line 6186 struct sqlite3_pcache_page {
|
Line 8409 struct sqlite3_pcache_page {
|
** page cache implementation. ^The page cache implementation |
** page cache implementation. ^The page cache implementation |
** may choose to evict unpinned pages at any time. |
** may choose to evict unpinned pages at any time. |
** |
** |
** The cache must not perform any reference counting. A single | ** The cache must not perform any reference counting. A single |
** call to xUnpin() unpins the page regardless of the number of prior calls | ** call to xUnpin() unpins the page regardless of the number of prior calls |
** to xFetch(). |
** to xFetch(). |
** |
** |
** [[the xRekey() page cache methods]] |
** [[the xRekey() page cache methods]] |
Line 6227 struct sqlite3_pcache_methods2 {
|
Line 8450 struct sqlite3_pcache_methods2 {
|
int (*xPagecount)(sqlite3_pcache*); |
int (*xPagecount)(sqlite3_pcache*); |
sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); |
sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); |
void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); |
void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); |
void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, | void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, |
unsigned oldKey, unsigned newKey); |
unsigned oldKey, unsigned newKey); |
void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); |
void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); |
void (*xDestroy)(sqlite3_pcache*); |
void (*xDestroy)(sqlite3_pcache*); |
Line 6272 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8495 typedef struct sqlite3_backup sqlite3_backup;
|
** |
** |
** The backup API copies the content of one database into another. |
** The backup API copies the content of one database into another. |
** It is useful either for creating backups of databases or |
** It is useful either for creating backups of databases or |
** for copying in-memory databases to or from persistent files. | ** for copying in-memory databases to or from persistent files. |
** |
** |
** See Also: [Using the SQLite Online Backup API] |
** See Also: [Using the SQLite Online Backup API] |
** |
** |
Line 6283 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8506 typedef struct sqlite3_backup sqlite3_backup;
|
** ^Thus, the backup may be performed on a live source database without |
** ^Thus, the backup may be performed on a live source database without |
** preventing other database connections from |
** preventing other database connections from |
** reading or writing to the source database while the backup is underway. |
** reading or writing to the source database while the backup is underway. |
** | ** |
** ^(To perform a backup operation: | ** ^(To perform a backup operation: |
** <ol> |
** <ol> |
** <li><b>sqlite3_backup_init()</b> is called once to initialize the |
** <li><b>sqlite3_backup_init()</b> is called once to initialize the |
** backup, | ** backup, |
** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer | ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer |
** the data between the two databases, and finally |
** the data between the two databases, and finally |
** <li><b>sqlite3_backup_finish()</b> is called to release all resources | ** <li><b>sqlite3_backup_finish()</b> is called to release all resources |
** associated with the backup operation. | ** associated with the backup operation. |
** </ol>)^ |
** </ol>)^ |
** There should be exactly one call to sqlite3_backup_finish() for each |
** There should be exactly one call to sqlite3_backup_finish() for each |
** successful call to sqlite3_backup_init(). |
** successful call to sqlite3_backup_init(). |
** |
** |
** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> |
** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> |
** |
** |
** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the | ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the |
** [database connection] associated with the destination database | ** [database connection] associated with the destination database |
** and the database name, respectively. |
** and the database name, respectively. |
** ^The database name is "main" for the main database, "temp" for the |
** ^The database name is "main" for the main database, "temp" for the |
** temporary database, or the name specified after the AS keyword in |
** temporary database, or the name specified after the AS keyword in |
** an [ATTACH] statement for an attached database. |
** an [ATTACH] statement for an attached database. |
** ^The S and M arguments passed to | ** ^The S and M arguments passed to |
** sqlite3_backup_init(D,N,S,M) identify the [database connection] |
** sqlite3_backup_init(D,N,S,M) identify the [database connection] |
** and database name of the source database, respectively. |
** and database name of the source database, respectively. |
** ^The source and destination [database connections] (parameters S and D) |
** ^The source and destination [database connections] (parameters S and D) |
** must be different or else sqlite3_backup_init(D,N,S,M) will fail with |
** must be different or else sqlite3_backup_init(D,N,S,M) will fail with |
** an error. |
** an error. |
** |
** |
|
** ^A call to sqlite3_backup_init() will fail, returning NULL, if |
|
** there is already a read or read-write transaction open on the |
|
** destination database. |
|
** |
** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is |
** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is |
** returned and an error code and error message are stored in the |
** returned and an error code and error message are stored in the |
** destination [database connection] D. |
** destination [database connection] D. |
Line 6320 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8547 typedef struct sqlite3_backup sqlite3_backup;
|
** ^A successful call to sqlite3_backup_init() returns a pointer to an |
** ^A successful call to sqlite3_backup_init() returns a pointer to an |
** [sqlite3_backup] object. |
** [sqlite3_backup] object. |
** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and |
** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and |
** sqlite3_backup_finish() functions to perform the specified backup | ** sqlite3_backup_finish() functions to perform the specified backup |
** operation. |
** operation. |
** |
** |
** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> |
** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> |
** |
** |
** ^Function sqlite3_backup_step(B,N) will copy up to N pages between | ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between |
** the source and destination databases specified by [sqlite3_backup] object B. |
** the source and destination databases specified by [sqlite3_backup] object B. |
** ^If N is negative, all remaining source pages are copied. | ** ^If N is negative, all remaining source pages are copied. |
** ^If sqlite3_backup_step(B,N) successfully copies N pages and there |
** ^If sqlite3_backup_step(B,N) successfully copies N pages and there |
** are still more pages to be copied, then the function returns [SQLITE_OK]. |
** are still more pages to be copied, then the function returns [SQLITE_OK]. |
** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages |
** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages |
Line 6349 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8576 typedef struct sqlite3_backup sqlite3_backup;
|
** |
** |
** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then |
** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then |
** the [sqlite3_busy_handler | busy-handler function] |
** the [sqlite3_busy_handler | busy-handler function] |
** is invoked (if one is specified). ^If the | ** is invoked (if one is specified). ^If the |
** busy-handler returns non-zero before the lock is available, then | ** busy-handler returns non-zero before the lock is available, then |
** [SQLITE_BUSY] is returned to the caller. ^In this case the call to |
** [SQLITE_BUSY] is returned to the caller. ^In this case the call to |
** sqlite3_backup_step() can be retried later. ^If the source |
** sqlite3_backup_step() can be retried later. ^If the source |
** [database connection] |
** [database connection] |
Line 6358 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8585 typedef struct sqlite3_backup sqlite3_backup;
|
** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this |
** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this |
** case the call to sqlite3_backup_step() can be retried later on. ^(If |
** case the call to sqlite3_backup_step() can be retried later on. ^(If |
** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or |
** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or |
** [SQLITE_READONLY] is returned, then | ** [SQLITE_READONLY] is returned, then |
** there is no point in retrying the call to sqlite3_backup_step(). These | ** there is no point in retrying the call to sqlite3_backup_step(). These |
** errors are considered fatal.)^ The application must accept | ** errors are considered fatal.)^ The application must accept |
** that the backup operation has failed and pass the backup operation handle | ** that the backup operation has failed and pass the backup operation handle |
** to the sqlite3_backup_finish() to release associated resources. |
** to the sqlite3_backup_finish() to release associated resources. |
** |
** |
** ^The first call to sqlite3_backup_step() obtains an exclusive lock |
** ^The first call to sqlite3_backup_step() obtains an exclusive lock |
** on the destination file. ^The exclusive lock is not released until either | ** on the destination file. ^The exclusive lock is not released until either |
** sqlite3_backup_finish() is called or the backup operation is complete | ** sqlite3_backup_finish() is called or the backup operation is complete |
** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to |
** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to |
** sqlite3_backup_step() obtains a [shared lock] on the source database that |
** sqlite3_backup_step() obtains a [shared lock] on the source database that |
** lasts for the duration of the sqlite3_backup_step() call. |
** lasts for the duration of the sqlite3_backup_step() call. |
Line 6375 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8602 typedef struct sqlite3_backup sqlite3_backup;
|
** through the backup process. ^If the source database is modified by an |
** through the backup process. ^If the source database is modified by an |
** external process or via a database connection other than the one being |
** external process or via a database connection other than the one being |
** used by the backup operation, then the backup will be automatically |
** used by the backup operation, then the backup will be automatically |
** restarted by the next call to sqlite3_backup_step(). ^If the source | ** restarted by the next call to sqlite3_backup_step(). ^If the source |
** database is modified by the using the same database connection as is used |
** database is modified by the using the same database connection as is used |
** by the backup operation, then the backup database is automatically |
** by the backup operation, then the backup database is automatically |
** updated at the same time. |
** updated at the same time. |
** |
** |
** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> |
** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> |
** |
** |
** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the | ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the |
** application wishes to abandon the backup operation, the application |
** application wishes to abandon the backup operation, the application |
** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). |
** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). |
** ^The sqlite3_backup_finish() interfaces releases all |
** ^The sqlite3_backup_finish() interfaces releases all |
** resources associated with the [sqlite3_backup] object. | ** resources associated with the [sqlite3_backup] object. |
** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any |
** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any |
** active write-transaction on the destination database is rolled back. |
** active write-transaction on the destination database is rolled back. |
** The [sqlite3_backup] object is invalid |
** The [sqlite3_backup] object is invalid |
Line 6403 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8630 typedef struct sqlite3_backup sqlite3_backup;
|
** is not a permanent error and does not affect the return value of |
** is not a permanent error and does not affect the return value of |
** sqlite3_backup_finish(). |
** sqlite3_backup_finish(). |
** |
** |
** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]] | ** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]] |
** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> |
** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> |
** |
** |
** ^Each call to sqlite3_backup_step() sets two values inside | ** ^The sqlite3_backup_remaining() routine returns the number of pages still |
** the [sqlite3_backup] object: the number of pages still to be backed | ** to be backed up at the conclusion of the most recent sqlite3_backup_step(). |
** up and the total number of pages in the source database file. | ** ^The sqlite3_backup_pagecount() routine returns the total number of pages |
** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces | ** in the source database at the conclusion of the most recent |
** retrieve these two values, respectively. | ** sqlite3_backup_step(). |
| ** ^(The values returned by these functions are only updated by |
| ** sqlite3_backup_step(). If the source database is modified in a way that |
| ** changes the size of the source database or the number of pages remaining, |
| ** those changes are not reflected in the output of sqlite3_backup_pagecount() |
| ** and sqlite3_backup_remaining() until after the next |
| ** sqlite3_backup_step().)^ |
** |
** |
** ^The values returned by these functions are only updated by |
|
** sqlite3_backup_step(). ^If the source database is modified during a backup |
|
** operation, then the values are not updated to account for any extra |
|
** pages that need to be updated or the size of the source database file |
|
** changing. |
|
** |
|
** <b>Concurrent Usage of Database Handles</b> |
** <b>Concurrent Usage of Database Handles</b> |
** |
** |
** ^The source [database connection] may be used by the application for other |
** ^The source [database connection] may be used by the application for other |
Line 6426 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8653 typedef struct sqlite3_backup sqlite3_backup;
|
** connections, then the source database connection may be used concurrently |
** connections, then the source database connection may be used concurrently |
** from within other threads. |
** from within other threads. |
** |
** |
** However, the application must guarantee that the destination | ** However, the application must guarantee that the destination |
** [database connection] is not passed to any other API (by any thread) after | ** [database connection] is not passed to any other API (by any thread) after |
** sqlite3_backup_init() is called and before the corresponding call to |
** sqlite3_backup_init() is called and before the corresponding call to |
** sqlite3_backup_finish(). SQLite does not currently check to see |
** sqlite3_backup_finish(). SQLite does not currently check to see |
** if the application incorrectly accesses the destination [database connection] |
** if the application incorrectly accesses the destination [database connection] |
Line 6438 typedef struct sqlite3_backup sqlite3_backup;
|
Line 8665 typedef struct sqlite3_backup sqlite3_backup;
|
** If running in [shared cache mode], the application must |
** If running in [shared cache mode], the application must |
** guarantee that the shared cache used by the destination database |
** guarantee that the shared cache used by the destination database |
** is not accessed while the backup is running. In practice this means |
** is not accessed while the backup is running. In practice this means |
** that the application must guarantee that the disk file being | ** that the application must guarantee that the disk file being |
** backed up to is not accessed by any connection within the process, |
** backed up to is not accessed by any connection within the process, |
** not just the specific connection that was passed to sqlite3_backup_init(). |
** not just the specific connection that was passed to sqlite3_backup_init(). |
** |
** |
** The [sqlite3_backup] object itself is partially threadsafe. Multiple | ** The [sqlite3_backup] object itself is partially threadsafe. Multiple |
** threads may safely make multiple concurrent calls to sqlite3_backup_step(). |
** threads may safely make multiple concurrent calls to sqlite3_backup_step(). |
** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() |
** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() |
** APIs are not strictly speaking threadsafe. If they are invoked at the |
** APIs are not strictly speaking threadsafe. If they are invoked at the |
Line 6462 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
Line 8689 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
|
|
/* |
/* |
** CAPI3REF: Unlock Notification |
** CAPI3REF: Unlock Notification |
|
** METHOD: sqlite3 |
** |
** |
** ^When running in shared-cache mode, a database operation may fail with |
** ^When running in shared-cache mode, a database operation may fail with |
** an [SQLITE_LOCKED] error if the required locks on the shared-cache or |
** an [SQLITE_LOCKED] error if the required locks on the shared-cache or |
** individual tables within the shared-cache cannot be obtained. See |
** individual tables within the shared-cache cannot be obtained. See |
** [SQLite Shared-Cache Mode] for a description of shared-cache locking. | ** [SQLite Shared-Cache Mode] for a description of shared-cache locking. |
** ^This API may be used to register a callback that SQLite will invoke | ** ^This API may be used to register a callback that SQLite will invoke |
** when the connection currently holding the required lock relinquishes it. |
** when the connection currently holding the required lock relinquishes it. |
** ^This API is only available if the library was compiled with the |
** ^This API is only available if the library was compiled with the |
** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. |
** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. |
Line 6475 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
Line 8703 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
** See Also: [Using the SQLite Unlock Notification Feature]. |
** See Also: [Using the SQLite Unlock Notification Feature]. |
** |
** |
** ^Shared-cache locks are released when a database connection concludes |
** ^Shared-cache locks are released when a database connection concludes |
** its current transaction, either by committing it or rolling it back. | ** its current transaction, either by committing it or rolling it back. |
** |
** |
** ^When a connection (known as the blocked connection) fails to obtain a |
** ^When a connection (known as the blocked connection) fails to obtain a |
** shared-cache lock and SQLITE_LOCKED is returned to the caller, the |
** shared-cache lock and SQLITE_LOCKED is returned to the caller, the |
** identity of the database connection (the blocking connection) that |
** identity of the database connection (the blocking connection) that |
** has locked the required resource is stored internally. ^After an | ** has locked the required resource is stored internally. ^After an |
** application receives an SQLITE_LOCKED error, it may call the |
** application receives an SQLITE_LOCKED error, it may call the |
** sqlite3_unlock_notify() method with the blocked connection handle as | ** sqlite3_unlock_notify() method with the blocked connection handle as |
** the first argument to register for a callback that will be invoked |
** the first argument to register for a callback that will be invoked |
** when the blocking connections current transaction is concluded. ^The |
** when the blocking connections current transaction is concluded. ^The |
** callback is invoked from within the [sqlite3_step] or [sqlite3_close] |
** callback is invoked from within the [sqlite3_step] or [sqlite3_close] |
** call that concludes the blocking connections transaction. | ** call that concludes the blocking connection's transaction. |
** |
** |
** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, |
** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, |
** there is a chance that the blocking connection will have already |
** there is a chance that the blocking connection will have already |
Line 6496 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
Line 8724 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
** |
** |
** ^If the blocked connection is attempting to obtain a write-lock on a |
** ^If the blocked connection is attempting to obtain a write-lock on a |
** shared-cache table, and more than one other connection currently holds |
** shared-cache table, and more than one other connection currently holds |
** a read-lock on the same table, then SQLite arbitrarily selects one of | ** a read-lock on the same table, then SQLite arbitrarily selects one of |
** the other connections to use as the blocking connection. |
** the other connections to use as the blocking connection. |
** |
** |
** ^(There may be at most one unlock-notify callback registered by a | ** ^(There may be at most one unlock-notify callback registered by a |
** blocked connection. If sqlite3_unlock_notify() is called when the |
** blocked connection. If sqlite3_unlock_notify() is called when the |
** blocked connection already has a registered unlock-notify callback, |
** blocked connection already has a registered unlock-notify callback, |
** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is |
** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is |
** called with a NULL pointer as its second argument, then any existing |
** called with a NULL pointer as its second argument, then any existing |
** unlock-notify callback is canceled. ^The blocked connections | ** unlock-notify callback is canceled. ^The blocked connections |
** unlock-notify callback may also be canceled by closing the blocked |
** unlock-notify callback may also be canceled by closing the blocked |
** connection using [sqlite3_close()]. |
** connection using [sqlite3_close()]. |
** |
** |
Line 6517 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
Line 8745 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
** |
** |
** <b>Callback Invocation Details</b> |
** <b>Callback Invocation Details</b> |
** |
** |
** When an unlock-notify callback is registered, the application provides a | ** When an unlock-notify callback is registered, the application provides a |
** single void* pointer that is passed to the callback when it is invoked. |
** single void* pointer that is passed to the callback when it is invoked. |
** However, the signature of the callback function allows SQLite to pass |
** However, the signature of the callback function allows SQLite to pass |
** it an array of void* context pointers. The first argument passed to |
** it an array of void* context pointers. The first argument passed to |
** an unlock-notify callback is a pointer to an array of void* pointers, |
** an unlock-notify callback is a pointer to an array of void* pointers, |
** and the second is the number of entries in the array. |
** and the second is the number of entries in the array. |
** |
** |
** When a blocking connections transaction is concluded, there may be | ** When a blocking connection's transaction is concluded, there may be |
** more than one blocked connection that has registered for an unlock-notify |
** more than one blocked connection that has registered for an unlock-notify |
** callback. ^If two or more such blocked connections have specified the |
** callback. ^If two or more such blocked connections have specified the |
** same callback function, then instead of invoking the callback function |
** same callback function, then instead of invoking the callback function |
** multiple times, it is invoked once with the set of void* context pointers |
** multiple times, it is invoked once with the set of void* context pointers |
** specified by the blocked connections bundled together into an array. |
** specified by the blocked connections bundled together into an array. |
** This gives the application an opportunity to prioritize any actions | ** This gives the application an opportunity to prioritize any actions |
** related to the set of unblocked database connections. |
** related to the set of unblocked database connections. |
** |
** |
** <b>Deadlock Detection</b> |
** <b>Deadlock Detection</b> |
** |
** |
** Assuming that after registering for an unlock-notify callback a | ** Assuming that after registering for an unlock-notify callback a |
** database waits for the callback to be issued before taking any further |
** database waits for the callback to be issued before taking any further |
** action (a reasonable assumption), then using this API may cause the |
** action (a reasonable assumption), then using this API may cause the |
** application to deadlock. For example, if connection X is waiting for |
** application to deadlock. For example, if connection X is waiting for |
Line 6558 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
Line 8786 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
** |
** |
** <b>The "DROP TABLE" Exception</b> |
** <b>The "DROP TABLE" Exception</b> |
** |
** |
** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost | ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost |
** always appropriate to call sqlite3_unlock_notify(). There is however, |
** always appropriate to call sqlite3_unlock_notify(). There is however, |
** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, |
** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, |
** SQLite checks if there are any currently executing SELECT statements |
** SQLite checks if there are any currently executing SELECT statements |
Line 6571 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
Line 8799 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
|
** One way around this problem is to check the extended error code returned |
** One way around this problem is to check the extended error code returned |
** by an sqlite3_step() call. ^(If there is a blocking connection, then the |
** by an sqlite3_step() call. ^(If there is a blocking connection, then the |
** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in |
** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in |
** the special "DROP TABLE/INDEX" case, the extended error code is just | ** the special "DROP TABLE/INDEX" case, the extended error code is just |
** SQLITE_LOCKED.)^ |
** SQLITE_LOCKED.)^ |
*/ |
*/ |
SQLITE_API int sqlite3_unlock_notify( |
SQLITE_API int sqlite3_unlock_notify( |
Line 6584 SQLITE_API int sqlite3_unlock_notify(
|
Line 8812 SQLITE_API int sqlite3_unlock_notify(
|
/* |
/* |
** CAPI3REF: String Comparison |
** CAPI3REF: String Comparison |
** |
** |
** ^The [sqlite3_strnicmp()] API allows applications and extensions to | ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications |
** compare the contents of two buffers containing UTF-8 strings in a | ** and extensions to compare the contents of two buffers containing UTF-8 |
** case-independent fashion, using the same definition of case independence | ** strings in a case-independent fashion, using the same definition of "case |
** that SQLite uses internally when comparing identifiers. | ** independence" that SQLite uses internally when comparing identifiers. |
*/ |
*/ |
|
SQLITE_API int sqlite3_stricmp(const char *, const char *); |
SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); |
SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); |
|
|
/* |
/* |
|
** CAPI3REF: String Globbing |
|
* |
|
** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if |
|
** string X matches the [GLOB] pattern P. |
|
** ^The definition of [GLOB] pattern matching used in |
|
** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the |
|
** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function |
|
** is case sensitive. |
|
** |
|
** Note that this routine returns zero on a match and non-zero if the strings |
|
** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. |
|
** |
|
** See also: [sqlite3_strlike()]. |
|
*/ |
|
SQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr); |
|
|
|
/* |
|
** CAPI3REF: String LIKE Matching |
|
* |
|
** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if |
|
** string X matches the [LIKE] pattern P with escape character E. |
|
** ^The definition of [LIKE] pattern matching used in |
|
** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E" |
|
** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without |
|
** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0. |
|
** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case |
|
** insensitive - equivalent upper and lower case ASCII characters match |
|
** one another. |
|
** |
|
** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though |
|
** only ASCII characters are case folded. |
|
** |
|
** Note that this routine returns zero on a match and non-zero if the strings |
|
** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. |
|
** |
|
** See also: [sqlite3_strglob()]. |
|
*/ |
|
SQLITE_API int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc); |
|
|
|
/* |
** CAPI3REF: Error Logging Interface |
** CAPI3REF: Error Logging Interface |
** |
** |
** ^The [sqlite3_log()] interface writes a message into the error log | ** ^The [sqlite3_log()] interface writes a message into the [error log] |
** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. |
** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. |
** ^If logging is enabled, the zFormat string and subsequent arguments are |
** ^If logging is enabled, the zFormat string and subsequent arguments are |
** used with [sqlite3_snprintf()] to generate the final output string. |
** used with [sqlite3_snprintf()] to generate the final output string. |
Line 6616 SQLITE_API void sqlite3_log(int iErrCode, const char *
|
Line 8885 SQLITE_API void sqlite3_log(int iErrCode, const char *
|
|
|
/* |
/* |
** CAPI3REF: Write-Ahead Log Commit Hook |
** CAPI3REF: Write-Ahead Log Commit Hook |
|
** METHOD: sqlite3 |
** |
** |
** ^The [sqlite3_wal_hook()] function is used to register a callback that |
** ^The [sqlite3_wal_hook()] function is used to register a callback that |
** will be invoked each time a database connection commits data to a | ** is invoked each time data is committed to a database in wal mode. |
** [write-ahead log] (i.e. whenever a transaction is committed in | |
** [journal_mode | journal_mode=WAL mode]). | |
** |
** |
** ^The callback is invoked by SQLite after the commit has taken place and | ** ^(The callback is invoked by SQLite after the commit has taken place and |
** the associated write-lock on the database released, so the implementation | ** the associated write-lock on the database released)^, so the implementation |
** may read, write or [checkpoint] the database as required. |
** may read, write or [checkpoint] the database as required. |
** |
** |
** ^The first parameter passed to the callback function when it is invoked |
** ^The first parameter passed to the callback function when it is invoked |
Line 6642 SQLITE_API void sqlite3_log(int iErrCode, const char *
|
Line 8910 SQLITE_API void sqlite3_log(int iErrCode, const char *
|
** that does not correspond to any valid SQLite error code, the results |
** that does not correspond to any valid SQLite error code, the results |
** are undefined. |
** are undefined. |
** |
** |
** A single database handle may have at most a single write-ahead log callback | ** A single database handle may have at most a single write-ahead log callback |
** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any |
** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any |
** previously registered write-ahead log callback. ^Note that the |
** previously registered write-ahead log callback. ^Note that the |
** [sqlite3_wal_autocheckpoint()] interface and the |
** [sqlite3_wal_autocheckpoint()] interface and the |
** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will |
** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will |
** those overwrite any prior [sqlite3_wal_hook()] settings. | ** overwrite any prior [sqlite3_wal_hook()] settings. |
*/ |
*/ |
SQLITE_API void *sqlite3_wal_hook( |
SQLITE_API void *sqlite3_wal_hook( |
sqlite3*, | sqlite3*, |
int(*)(void *,sqlite3*,const char*,int), |
int(*)(void *,sqlite3*,const char*,int), |
void* |
void* |
); |
); |
|
|
/* |
/* |
** CAPI3REF: Configure an auto-checkpoint |
** CAPI3REF: Configure an auto-checkpoint |
|
** METHOD: sqlite3 |
** |
** |
** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around |
** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around |
** [sqlite3_wal_hook()] that causes any database on [database connection] D |
** [sqlite3_wal_hook()] that causes any database on [database connection] D |
** to automatically [checkpoint] |
** to automatically [checkpoint] |
** after committing a transaction if there are N or |
** after committing a transaction if there are N or |
** more frames in the [write-ahead log] file. ^Passing zero or | ** more frames in the [write-ahead log] file. ^Passing zero or |
** a negative value as the nFrame parameter disables automatic |
** a negative value as the nFrame parameter disables automatic |
** checkpoints entirely. |
** checkpoints entirely. |
** |
** |
Line 6674 SQLITE_API void *sqlite3_wal_hook(
|
Line 8943 SQLITE_API void *sqlite3_wal_hook(
|
** ^The [wal_autocheckpoint pragma] can be used to invoke this interface |
** ^The [wal_autocheckpoint pragma] can be used to invoke this interface |
** from SQL. |
** from SQL. |
** |
** |
|
** ^Checkpoints initiated by this mechanism are |
|
** [sqlite3_wal_checkpoint_v2|PASSIVE]. |
|
** |
** ^Every new [database connection] defaults to having the auto-checkpoint |
** ^Every new [database connection] defaults to having the auto-checkpoint |
** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] |
** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] |
** pages. The use of this interface |
** pages. The use of this interface |
Line 6684 SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db,
|
Line 8956 SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db,
|
|
|
/* |
/* |
** CAPI3REF: Checkpoint a database |
** CAPI3REF: Checkpoint a database |
|
** METHOD: sqlite3 |
** |
** |
** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X | ** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to |
** on [database connection] D to be [checkpointed]. ^If X is NULL or an | ** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^ |
** empty string, then a checkpoint is run on all databases of | |
** connection D. ^If the database connection D is not in | |
** [WAL | write-ahead log mode] then this interface is a harmless no-op. | |
** |
** |
** ^The [wal_checkpoint pragma] can be used to invoke this interface | ** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the |
** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the | ** [write-ahead log] for database X on [database connection] D to be |
** [wal_autocheckpoint pragma] can be used to cause this interface to be | ** transferred into the database file and for the write-ahead log to |
** run whenever the WAL reaches a certain size threshold. | ** be reset. See the [checkpointing] documentation for addition |
| ** information. |
** |
** |
** See also: [sqlite3_wal_checkpoint_v2()] | ** This interface used to be the only way to cause a checkpoint to |
| ** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()] |
| ** interface was added. This interface is retained for backwards |
| ** compatibility and as a convenience for applications that need to manually |
| ** start a callback but which do not need the full power (and corresponding |
| ** complication) of [sqlite3_wal_checkpoint_v2()]. |
*/ |
*/ |
SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); |
SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); |
|
|
/* |
/* |
** CAPI3REF: Checkpoint a database |
** CAPI3REF: Checkpoint a database |
|
** METHOD: sqlite3 |
** |
** |
** Run a checkpoint operation on WAL database zDb attached to database | ** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint |
** handle db. The specific operation is determined by the value of the | ** operation on database X of [database connection] D in mode M. Status |
** eMode parameter: | ** information is written back into integers pointed to by L and C.)^ |
| ** ^(The M parameter must be a valid [checkpoint mode]:)^ |
** |
** |
** <dl> |
** <dl> |
** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> |
** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> |
** Checkpoint as many frames as possible without waiting for any database | ** ^Checkpoint as many frames as possible without waiting for any database |
** readers or writers to finish. Sync the db file if all frames in the log | ** readers or writers to finish, then sync the database file if all frames |
** are checkpointed. This mode is the same as calling | ** in the log were checkpointed. ^The [busy-handler callback] |
** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked. | ** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode. |
| ** ^On the other hand, passive mode might leave the checkpoint unfinished |
| ** if there are concurrent readers or writers. |
** |
** |
** <dt>SQLITE_CHECKPOINT_FULL<dd> |
** <dt>SQLITE_CHECKPOINT_FULL<dd> |
** This mode blocks (calls the busy-handler callback) until there is no | ** ^This mode blocks (it invokes the |
| ** [sqlite3_busy_handler|busy-handler callback]) until there is no |
** database writer and all readers are reading from the most recent database |
** database writer and all readers are reading from the most recent database |
** snapshot. It then checkpoints all frames in the log file and syncs the | ** snapshot. ^It then checkpoints all frames in the log file and syncs the |
** database file. This call blocks database writers while it is running, | ** database file. ^This mode blocks new database writers while it is pending, |
** but not database readers. | ** but new database readers are allowed to continue unimpeded. |
** |
** |
** <dt>SQLITE_CHECKPOINT_RESTART<dd> |
** <dt>SQLITE_CHECKPOINT_RESTART<dd> |
** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after | ** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition |
** checkpointing the log file it blocks (calls the busy-handler callback) | ** that after checkpointing the log file it blocks (calls the |
** until all readers are reading from the database file only. This ensures | ** [busy-handler callback]) |
** that the next client to write to the database file restarts the log file | ** until all readers are reading from the database file only. ^This ensures |
** from the beginning. This call blocks database writers while it is running, | ** that the next writer will restart the log file from the beginning. |
** but not database readers. | ** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new |
| ** database writer attempts while it is pending, but does not impede readers. |
| ** |
| ** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd> |
| ** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the |
| ** addition that it also truncates the log file to zero bytes just prior |
| ** to a successful return. |
** </dl> |
** </dl> |
** |
** |
** If pnLog is not NULL, then *pnLog is set to the total number of frames in | ** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in |
** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to | ** the log file or to -1 if the checkpoint could not run because |
** the total number of checkpointed frames (including any that were already | ** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not |
** checkpointed when this function is called). *pnLog and *pnCkpt may be | ** NULL,then *pnCkpt is set to the total number of checkpointed frames in the |
** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK. | ** log file (including any that were already checkpointed before the function |
** If no values are available because of an error, they are both set to -1 | ** was called) or to -1 if the checkpoint could not run due to an error or |
** before returning to communicate this to the caller. | ** because the database is not in WAL mode. ^Note that upon successful |
| ** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been |
| ** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero. |
** |
** |
** All calls obtain an exclusive "checkpoint" lock on the database file. If | ** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If |
** any other process is running a checkpoint operation at the same time, the | ** any other process is running a checkpoint operation at the same time, the |
** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a | ** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a |
** busy-handler configured, it will not be invoked in this case. |
** busy-handler configured, it will not be invoked in this case. |
** |
** |
** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive | ** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the |
** "writer" lock on the database file. If the writer lock cannot be obtained | ** exclusive "writer" lock on the database file. ^If the writer lock cannot be |
** immediately, and a busy-handler is configured, it is invoked and the writer | ** obtained immediately, and a busy-handler is configured, it is invoked and |
** lock retried until either the busy-handler returns 0 or the lock is | ** the writer lock retried until either the busy-handler returns 0 or the lock |
** successfully obtained. The busy-handler is also invoked while waiting for | ** is successfully obtained. ^The busy-handler is also invoked while waiting for |
** database readers as described above. If the busy-handler returns 0 before | ** database readers as described above. ^If the busy-handler returns 0 before |
** the writer lock is obtained or while waiting for database readers, the |
** the writer lock is obtained or while waiting for database readers, the |
** checkpoint operation proceeds from that point in the same way as | ** checkpoint operation proceeds from that point in the same way as |
** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible | ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible |
** without blocking any further. SQLITE_BUSY is returned in this case. | ** without blocking any further. ^SQLITE_BUSY is returned in this case. |
** |
** |
** If parameter zDb is NULL or points to a zero length string, then the | ** ^If parameter zDb is NULL or points to a zero length string, then the |
** specified operation is attempted on all WAL databases. In this case the | ** specified operation is attempted on all WAL databases [attached] to |
** values written to output parameters *pnLog and *pnCkpt are undefined. If | ** [database connection] db. In this case the |
** an SQLITE_BUSY error is encountered when processing one or more of the | ** values written to output parameters *pnLog and *pnCkpt are undefined. ^If |
** attached WAL databases, the operation is still attempted on any remaining | ** an SQLITE_BUSY error is encountered when processing one or more of the |
** attached databases and SQLITE_BUSY is returned to the caller. If any other | ** attached WAL databases, the operation is still attempted on any remaining |
** error occurs while processing an attached database, processing is abandoned | ** attached databases and SQLITE_BUSY is returned at the end. ^If any other |
** and the error code returned to the caller immediately. If no error | ** error occurs while processing an attached database, processing is abandoned |
** (SQLITE_BUSY or otherwise) is encountered while processing the attached | ** and the error code is returned to the caller immediately. ^If no error |
| ** (SQLITE_BUSY or otherwise) is encountered while processing the attached |
** databases, SQLITE_OK is returned. |
** databases, SQLITE_OK is returned. |
** |
** |
** If database zDb is the name of an attached database that is not in WAL | ** ^If database zDb is the name of an attached database that is not in WAL |
** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If | ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If |
** zDb is not NULL (or a zero length string) and is not the name of any |
** zDb is not NULL (or a zero length string) and is not the name of any |
** attached database, SQLITE_ERROR is returned to the caller. |
** attached database, SQLITE_ERROR is returned to the caller. |
|
** |
|
** ^Unless it returns SQLITE_MISUSE, |
|
** the sqlite3_wal_checkpoint_v2() interface |
|
** sets the error information that is queried by |
|
** [sqlite3_errcode()] and [sqlite3_errmsg()]. |
|
** |
|
** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface |
|
** from SQL. |
*/ |
*/ |
SQLITE_API int sqlite3_wal_checkpoint_v2( |
SQLITE_API int sqlite3_wal_checkpoint_v2( |
sqlite3 *db, /* Database handle */ |
sqlite3 *db, /* Database handle */ |
Line 6779 SQLITE_API int sqlite3_wal_checkpoint_v2(
|
Line 9077 SQLITE_API int sqlite3_wal_checkpoint_v2(
|
); |
); |
|
|
/* |
/* |
** CAPI3REF: Checkpoint operation parameters | ** CAPI3REF: Checkpoint Mode Values |
| ** KEYWORDS: {checkpoint mode} |
** |
** |
** These constants can be used as the 3rd parameter to | ** These constants define all valid values for the "checkpoint mode" passed |
** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()] | ** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface. |
** documentation for additional information about the meaning and use of | ** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the |
** each of these values. | ** meaning of each of these checkpoint modes. |
*/ |
*/ |
#define SQLITE_CHECKPOINT_PASSIVE 0 | #define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */ |
#define SQLITE_CHECKPOINT_FULL 1 | #define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */ |
#define SQLITE_CHECKPOINT_RESTART 2 | #define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */ |
| #define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */ |
|
|
/* |
/* |
** CAPI3REF: Virtual Table Interface Configuration |
** CAPI3REF: Virtual Table Interface Configuration |
Line 6800 SQLITE_API int sqlite3_wal_checkpoint_v2(
|
Line 9100 SQLITE_API int sqlite3_wal_checkpoint_v2(
|
** If this interface is invoked outside the context of an xConnect or |
** If this interface is invoked outside the context of an xConnect or |
** xCreate virtual table method then the behavior is undefined. |
** xCreate virtual table method then the behavior is undefined. |
** |
** |
** At present, there is only one option that may be configured using | ** In the call sqlite3_vtab_config(D,C,...) the D parameter is the |
** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options | ** [database connection] in which the virtual table is being created and |
** may be added in the future. | ** which is passed in as the first argument to the [xConnect] or [xCreate] |
| ** method that is invoking sqlite3_vtab_config(). The C parameter is one |
| ** of the [virtual table configuration options]. The presence and meaning |
| ** of parameters after C depend on which [virtual table configuration option] |
| ** is used. |
*/ |
*/ |
SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...); |
SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...); |
|
|
/* |
/* |
** CAPI3REF: Virtual Table Configuration Options |
** CAPI3REF: Virtual Table Configuration Options |
|
** KEYWORDS: {virtual table configuration options} |
|
** KEYWORDS: {virtual table configuration option} |
** |
** |
** These macros define the various options to the |
** These macros define the various options to the |
** [sqlite3_vtab_config()] interface that [virtual table] implementations |
** [sqlite3_vtab_config()] interface that [virtual table] implementations |
** can use to customize and optimize their behavior. |
** can use to customize and optimize their behavior. |
** |
** |
** <dl> |
** <dl> |
** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT | ** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]] |
| ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt> |
** <dd>Calls of the form |
** <dd>Calls of the form |
** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, |
** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, |
** where X is an integer. If X is zero, then the [virtual table] whose |
** where X is an integer. If X is zero, then the [virtual table] whose |
Line 6828 SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, .
|
Line 9135 SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, .
|
** If X is non-zero, then the virtual table implementation guarantees |
** If X is non-zero, then the virtual table implementation guarantees |
** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before |
** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before |
** any modifications to internal or persistent data structures have been made. |
** any modifications to internal or persistent data structures have been made. |
** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite | ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite |
** is able to roll back a statement or database transaction, and abandon |
** is able to roll back a statement or database transaction, and abandon |
** or continue processing the current SQL statement as appropriate. | ** or continue processing the current SQL statement as appropriate. |
** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns |
** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns |
** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode |
** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode |
** had been ABORT. |
** had been ABORT. |
** |
** |
** Virtual table implementations that are required to handle OR REPLACE |
** Virtual table implementations that are required to handle OR REPLACE |
** must do so within the [xUpdate] method. If a call to the | ** must do so within the [xUpdate] method. If a call to the |
** [sqlite3_vtab_on_conflict()] function indicates that the current ON | ** [sqlite3_vtab_on_conflict()] function indicates that the current ON |
** CONFLICT policy is REPLACE, the virtual table implementation should | ** CONFLICT policy is REPLACE, the virtual table implementation should |
** silently replace the appropriate rows within the xUpdate callback and |
** silently replace the appropriate rows within the xUpdate callback and |
** return SQLITE_OK. Or, if this is not possible, it may return |
** return SQLITE_OK. Or, if this is not possible, it may return |
** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT | ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT |
** constraint handling. |
** constraint handling. |
|
** </dd> |
|
** |
|
** [[SQLITE_VTAB_DIRECTONLY]]<dt>SQLITE_VTAB_DIRECTONLY</dt> |
|
** <dd>Calls of the form |
|
** [sqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the |
|
** the [xConnect] or [xCreate] methods of a [virtual table] implmentation |
|
** prohibits that virtual table from being used from within triggers and |
|
** views. |
|
** </dd> |
|
** |
|
** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt> |
|
** <dd>Calls of the form |
|
** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the |
|
** the [xConnect] or [xCreate] methods of a [virtual table] implmentation |
|
** identify that virtual table as being safe to use from within triggers |
|
** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the |
|
** virtual table can do no serious harm even if it is controlled by a |
|
** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS |
|
** flag unless absolutely necessary. |
|
** </dd> |
** </dl> |
** </dl> |
*/ |
*/ |
#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 |
#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 |
|
#define SQLITE_VTAB_INNOCUOUS 2 |
|
#define SQLITE_VTAB_DIRECTONLY 3 |
|
|
/* |
/* |
** CAPI3REF: Determine The Virtual Table Conflict Policy |
** CAPI3REF: Determine The Virtual Table Conflict Policy |
Line 6860 SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, .
|
Line 9189 SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, .
|
SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *); |
SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *); |
|
|
/* |
/* |
|
** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE |
|
** |
|
** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn] |
|
** method of a [virtual table], then it returns true if and only if the |
|
** column is being fetched as part of an UPDATE operation during which the |
|
** column value will not change. Applications might use this to substitute |
|
** a return value that is less expensive to compute and that the corresponding |
|
** [xUpdate] method understands as a "no-change" value. |
|
** |
|
** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that |
|
** the column is not changed by the UPDATE statement, then the xColumn |
|
** method can optionally return without setting a result, without calling |
|
** any of the [sqlite3_result_int|sqlite3_result_xxxxx() interfaces]. |
|
** In that case, [sqlite3_value_nochange(X)] will return true for the |
|
** same column in the [xUpdate] method. |
|
*/ |
|
SQLITE_API int sqlite3_vtab_nochange(sqlite3_context*); |
|
|
|
/* |
|
** CAPI3REF: Determine The Collation For a Virtual Table Constraint |
|
** |
|
** This function may only be called from within a call to the [xBestIndex] |
|
** method of a [virtual table]. |
|
** |
|
** The first argument must be the sqlite3_index_info object that is the |
|
** first parameter to the xBestIndex() method. The second argument must be |
|
** an index into the aConstraint[] array belonging to the sqlite3_index_info |
|
** structure passed to xBestIndex. This function returns a pointer to a buffer |
|
** containing the name of the collation sequence for the corresponding |
|
** constraint. |
|
*/ |
|
SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vtab_collation(sqlite3_index_info*,int); |
|
|
|
/* |
** CAPI3REF: Conflict resolution modes |
** CAPI3REF: Conflict resolution modes |
|
** KEYWORDS: {conflict resolution mode} |
** |
** |
** These constants are returned by [sqlite3_vtab_on_conflict()] to |
** These constants are returned by [sqlite3_vtab_on_conflict()] to |
** inform a [virtual table] implementation what the [ON CONFLICT] mode |
** inform a [virtual table] implementation what the [ON CONFLICT] mode |
Line 6876 SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
|
Line 9240 SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
|
/* #define SQLITE_ABORT 4 // Also an error code */ |
/* #define SQLITE_ABORT 4 // Also an error code */ |
#define SQLITE_REPLACE 5 |
#define SQLITE_REPLACE 5 |
|
|
|
/* |
|
** CAPI3REF: Prepared Statement Scan Status Opcodes |
|
** KEYWORDS: {scanstatus options} |
|
** |
|
** The following constants can be used for the T parameter to the |
|
** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a |
|
** different metric for sqlite3_stmt_scanstatus() to return. |
|
** |
|
** When the value returned to V is a string, space to hold that string is |
|
** managed by the prepared statement S and will be automatically freed when |
|
** S is finalized. |
|
** |
|
** <dl> |
|
** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt> |
|
** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be |
|
** set to the total number of times that the X-th loop has run.</dd> |
|
** |
|
** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt> |
|
** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be set |
|
** to the total number of rows examined by all iterations of the X-th loop.</dd> |
|
** |
|
** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt> |
|
** <dd>^The "double" variable pointed to by the V parameter will be set to the |
|
** query planner's estimate for the average number of rows output from each |
|
** iteration of the X-th loop. If the query planner's estimates was accurate, |
|
** then this value will approximate the quotient NVISIT/NLOOP and the |
|
** product of this value for all prior loops with the same SELECTID will |
|
** be the NLOOP value for the current loop. |
|
** |
|
** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt> |
|
** <dd>^The "const char *" variable pointed to by the V parameter will be set |
|
** to a zero-terminated UTF-8 string containing the name of the index or table |
|
** used for the X-th loop. |
|
** |
|
** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt> |
|
** <dd>^The "const char *" variable pointed to by the V parameter will be set |
|
** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] |
|
** description for the X-th loop. |
|
** |
|
** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt> |
|
** <dd>^The "int" variable pointed to by the V parameter will be set to the |
|
** "select-id" for the X-th loop. The select-id identifies which query or |
|
** subquery the loop is part of. The main query has a select-id of zero. |
|
** The select-id is the same value as is output in the first column |
|
** of an [EXPLAIN QUERY PLAN] query. |
|
** </dl> |
|
*/ |
|
#define SQLITE_SCANSTAT_NLOOP 0 |
|
#define SQLITE_SCANSTAT_NVISIT 1 |
|
#define SQLITE_SCANSTAT_EST 2 |
|
#define SQLITE_SCANSTAT_NAME 3 |
|
#define SQLITE_SCANSTAT_EXPLAIN 4 |
|
#define SQLITE_SCANSTAT_SELECTID 5 |
|
|
|
/* |
|
** CAPI3REF: Prepared Statement Scan Status |
|
** METHOD: sqlite3_stmt |
|
** |
|
** This interface returns information about the predicted and measured |
|
** performance for pStmt. Advanced applications can use this |
|
** interface to compare the predicted and the measured performance and |
|
** issue warnings and/or rerun [ANALYZE] if discrepancies are found. |
|
** |
|
** Since this interface is expected to be rarely used, it is only |
|
** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS] |
|
** compile-time option. |
|
** |
|
** The "iScanStatusOp" parameter determines which status information to return. |
|
** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior |
|
** of this interface is undefined. |
|
** ^The requested measurement is written into a variable pointed to by |
|
** the "pOut" parameter. |
|
** Parameter "idx" identifies the specific loop to retrieve statistics for. |
|
** Loops are numbered starting from zero. ^If idx is out of range - less than |
|
** zero or greater than or equal to the total number of loops used to implement |
|
** the statement - a non-zero value is returned and the variable that pOut |
|
** points to is unchanged. |
|
** |
|
** ^Statistics might not be available for all loops in all statements. ^In cases |
|
** where there exist loops with no available statistics, this function behaves |
|
** as if the loop did not exist - it returns non-zero and leave the variable |
|
** that pOut points to unchanged. |
|
** |
|
** See also: [sqlite3_stmt_scanstatus_reset()] |
|
*/ |
|
SQLITE_API int sqlite3_stmt_scanstatus( |
|
sqlite3_stmt *pStmt, /* Prepared statement for which info desired */ |
|
int idx, /* Index of loop to report on */ |
|
int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */ |
|
void *pOut /* Result written here */ |
|
); |
|
|
/* |
/* |
|
** CAPI3REF: Zero Scan-Status Counters |
|
** METHOD: sqlite3_stmt |
|
** |
|
** ^Zero all [sqlite3_stmt_scanstatus()] related event counters. |
|
** |
|
** This API is only available if the library is built with pre-processor |
|
** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined. |
|
*/ |
|
SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*); |
|
|
|
/* |
|
** CAPI3REF: Flush caches to disk mid-transaction |
|
** |
|
** ^If a write-transaction is open on [database connection] D when the |
|
** [sqlite3_db_cacheflush(D)] interface invoked, any dirty |
|
** pages in the pager-cache that are not currently in use are written out |
|
** to disk. A dirty page may be in use if a database cursor created by an |
|
** active SQL statement is reading from it, or if it is page 1 of a database |
|
** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)] |
|
** interface flushes caches for all schemas - "main", "temp", and |
|
** any [attached] databases. |
|
** |
|
** ^If this function needs to obtain extra database locks before dirty pages |
|
** can be flushed to disk, it does so. ^If those locks cannot be obtained |
|
** immediately and there is a busy-handler callback configured, it is invoked |
|
** in the usual manner. ^If the required lock still cannot be obtained, then |
|
** the database is skipped and an attempt made to flush any dirty pages |
|
** belonging to the next (if any) database. ^If any databases are skipped |
|
** because locks cannot be obtained, but no other error occurs, this |
|
** function returns SQLITE_BUSY. |
|
** |
|
** ^If any other error occurs while flushing dirty pages to disk (for |
|
** example an IO error or out-of-memory condition), then processing is |
|
** abandoned and an SQLite [error code] is returned to the caller immediately. |
|
** |
|
** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK. |
|
** |
|
** ^This function does not set the database handle error code or message |
|
** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions. |
|
*/ |
|
SQLITE_API int sqlite3_db_cacheflush(sqlite3*); |
|
|
|
/* |
|
** CAPI3REF: The pre-update hook. |
|
** |
|
** ^These interfaces are only available if SQLite is compiled using the |
|
** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option. |
|
** |
|
** ^The [sqlite3_preupdate_hook()] interface registers a callback function |
|
** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation |
|
** on a database table. |
|
** ^At most one preupdate hook may be registered at a time on a single |
|
** [database connection]; each call to [sqlite3_preupdate_hook()] overrides |
|
** the previous setting. |
|
** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()] |
|
** with a NULL pointer as the second parameter. |
|
** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as |
|
** the first parameter to callbacks. |
|
** |
|
** ^The preupdate hook only fires for changes to real database tables; the |
|
** preupdate hook is not invoked for changes to [virtual tables] or to |
|
** system tables like sqlite_sequence or sqlite_stat1. |
|
** |
|
** ^The second parameter to the preupdate callback is a pointer to |
|
** the [database connection] that registered the preupdate hook. |
|
** ^The third parameter to the preupdate callback is one of the constants |
|
** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the |
|
** kind of update operation that is about to occur. |
|
** ^(The fourth parameter to the preupdate callback is the name of the |
|
** database within the database connection that is being modified. This |
|
** will be "main" for the main database or "temp" for TEMP tables or |
|
** the name given after the AS keyword in the [ATTACH] statement for attached |
|
** databases.)^ |
|
** ^The fifth parameter to the preupdate callback is the name of the |
|
** table that is being modified. |
|
** |
|
** For an UPDATE or DELETE operation on a [rowid table], the sixth |
|
** parameter passed to the preupdate callback is the initial [rowid] of the |
|
** row being modified or deleted. For an INSERT operation on a rowid table, |
|
** or any operation on a WITHOUT ROWID table, the value of the sixth |
|
** parameter is undefined. For an INSERT or UPDATE on a rowid table the |
|
** seventh parameter is the final rowid value of the row being inserted |
|
** or updated. The value of the seventh parameter passed to the callback |
|
** function is not defined for operations on WITHOUT ROWID tables, or for |
|
** INSERT operations on rowid tables. |
|
** |
|
** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()], |
|
** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces |
|
** provide additional information about a preupdate event. These routines |
|
** may only be called from within a preupdate callback. Invoking any of |
|
** these routines from outside of a preupdate callback or with a |
|
** [database connection] pointer that is different from the one supplied |
|
** to the preupdate callback results in undefined and probably undesirable |
|
** behavior. |
|
** |
|
** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns |
|
** in the row that is being inserted, updated, or deleted. |
|
** |
|
** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to |
|
** a [protected sqlite3_value] that contains the value of the Nth column of |
|
** the table row before it is updated. The N parameter must be between 0 |
|
** and one less than the number of columns or the behavior will be |
|
** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE |
|
** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the |
|
** behavior is undefined. The [sqlite3_value] that P points to |
|
** will be destroyed when the preupdate callback returns. |
|
** |
|
** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to |
|
** a [protected sqlite3_value] that contains the value of the Nth column of |
|
** the table row after it is updated. The N parameter must be between 0 |
|
** and one less than the number of columns or the behavior will be |
|
** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE |
|
** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the |
|
** behavior is undefined. The [sqlite3_value] that P points to |
|
** will be destroyed when the preupdate callback returns. |
|
** |
|
** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate |
|
** callback was invoked as a result of a direct insert, update, or delete |
|
** operation; or 1 for inserts, updates, or deletes invoked by top-level |
|
** triggers; or 2 for changes resulting from triggers called by top-level |
|
** triggers; and so forth. |
|
** |
|
** See also: [sqlite3_update_hook()] |
|
*/ |
|
#if defined(SQLITE_ENABLE_PREUPDATE_HOOK) |
|
SQLITE_API void *sqlite3_preupdate_hook( |
|
sqlite3 *db, |
|
void(*xPreUpdate)( |
|
void *pCtx, /* Copy of third arg to preupdate_hook() */ |
|
sqlite3 *db, /* Database handle */ |
|
int op, /* SQLITE_UPDATE, DELETE or INSERT */ |
|
char const *zDb, /* Database name */ |
|
char const *zName, /* Table name */ |
|
sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */ |
|
sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */ |
|
), |
|
void* |
|
); |
|
SQLITE_API int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **); |
|
SQLITE_API int sqlite3_preupdate_count(sqlite3 *); |
|
SQLITE_API int sqlite3_preupdate_depth(sqlite3 *); |
|
SQLITE_API int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **); |
|
#endif |
|
|
|
/* |
|
** CAPI3REF: Low-level system error code |
|
** |
|
** ^Attempt to return the underlying operating system error code or error |
|
** number that caused the most recent I/O error or failure to open a file. |
|
** The return value is OS-dependent. For example, on unix systems, after |
|
** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be |
|
** called to get back the underlying "errno" that caused the problem, such |
|
** as ENOSPC, EAUTH, EISDIR, and so forth. |
|
*/ |
|
SQLITE_API int sqlite3_system_errno(sqlite3*); |
|
|
|
/* |
|
** CAPI3REF: Database Snapshot |
|
** KEYWORDS: {snapshot} {sqlite3_snapshot} |
|
** |
|
** An instance of the snapshot object records the state of a [WAL mode] |
|
** database for some specific point in history. |
|
** |
|
** In [WAL mode], multiple [database connections] that are open on the |
|
** same database file can each be reading a different historical version |
|
** of the database file. When a [database connection] begins a read |
|
** transaction, that connection sees an unchanging copy of the database |
|
** as it existed for the point in time when the transaction first started. |
|
** Subsequent changes to the database from other connections are not seen |
|
** by the reader until a new read transaction is started. |
|
** |
|
** The sqlite3_snapshot object records state information about an historical |
|
** version of the database file so that it is possible to later open a new read |
|
** transaction that sees that historical version of the database rather than |
|
** the most recent version. |
|
*/ |
|
typedef struct sqlite3_snapshot { |
|
unsigned char hidden[48]; |
|
} sqlite3_snapshot; |
|
|
|
/* |
|
** CAPI3REF: Record A Database Snapshot |
|
** CONSTRUCTOR: sqlite3_snapshot |
|
** |
|
** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a |
|
** new [sqlite3_snapshot] object that records the current state of |
|
** schema S in database connection D. ^On success, the |
|
** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly |
|
** created [sqlite3_snapshot] object into *P and returns SQLITE_OK. |
|
** If there is not already a read-transaction open on schema S when |
|
** this function is called, one is opened automatically. |
|
** |
|
** The following must be true for this function to succeed. If any of |
|
** the following statements are false when sqlite3_snapshot_get() is |
|
** called, SQLITE_ERROR is returned. The final value of *P is undefined |
|
** in this case. |
|
** |
|
** <ul> |
|
** <li> The database handle must not be in [autocommit mode]. |
|
** |
|
** <li> Schema S of [database connection] D must be a [WAL mode] database. |
|
** |
|
** <li> There must not be a write transaction open on schema S of database |
|
** connection D. |
|
** |
|
** <li> One or more transactions must have been written to the current wal |
|
** file since it was created on disk (by any connection). This means |
|
** that a snapshot cannot be taken on a wal mode database with no wal |
|
** file immediately after it is first opened. At least one transaction |
|
** must be written to it first. |
|
** </ul> |
|
** |
|
** This function may also return SQLITE_NOMEM. If it is called with the |
|
** database handle in autocommit mode but fails for some other reason, |
|
** whether or not a read transaction is opened on schema S is undefined. |
|
** |
|
** The [sqlite3_snapshot] object returned from a successful call to |
|
** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()] |
|
** to avoid a memory leak. |
|
** |
|
** The [sqlite3_snapshot_get()] interface is only available when the |
|
** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. |
|
*/ |
|
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get( |
|
sqlite3 *db, |
|
const char *zSchema, |
|
sqlite3_snapshot **ppSnapshot |
|
); |
|
|
|
/* |
|
** CAPI3REF: Start a read transaction on an historical snapshot |
|
** METHOD: sqlite3_snapshot |
|
** |
|
** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read |
|
** transaction or upgrades an existing one for schema S of |
|
** [database connection] D such that the read transaction refers to |
|
** historical [snapshot] P, rather than the most recent change to the |
|
** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK |
|
** on success or an appropriate [error code] if it fails. |
|
** |
|
** ^In order to succeed, the database connection must not be in |
|
** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there |
|
** is already a read transaction open on schema S, then the database handle |
|
** must have no active statements (SELECT statements that have been passed |
|
** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()). |
|
** SQLITE_ERROR is returned if either of these conditions is violated, or |
|
** if schema S does not exist, or if the snapshot object is invalid. |
|
** |
|
** ^A call to sqlite3_snapshot_open() will fail to open if the specified |
|
** snapshot has been overwritten by a [checkpoint]. In this case |
|
** SQLITE_ERROR_SNAPSHOT is returned. |
|
** |
|
** If there is already a read transaction open when this function is |
|
** invoked, then the same read transaction remains open (on the same |
|
** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT |
|
** is returned. If another error code - for example SQLITE_PROTOCOL or an |
|
** SQLITE_IOERR error code - is returned, then the final state of the |
|
** read transaction is undefined. If SQLITE_OK is returned, then the |
|
** read transaction is now open on database snapshot P. |
|
** |
|
** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the |
|
** database connection D does not know that the database file for |
|
** schema S is in [WAL mode]. A database connection might not know |
|
** that the database file is in [WAL mode] if there has been no prior |
|
** I/O on that database connection, or if the database entered [WAL mode] |
|
** after the most recent I/O on the database connection.)^ |
|
** (Hint: Run "[PRAGMA application_id]" against a newly opened |
|
** database connection in order to make it ready to use snapshots.) |
|
** |
|
** The [sqlite3_snapshot_open()] interface is only available when the |
|
** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. |
|
*/ |
|
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open( |
|
sqlite3 *db, |
|
const char *zSchema, |
|
sqlite3_snapshot *pSnapshot |
|
); |
|
|
|
/* |
|
** CAPI3REF: Destroy a snapshot |
|
** DESTRUCTOR: sqlite3_snapshot |
|
** |
|
** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P. |
|
** The application must eventually free every [sqlite3_snapshot] object |
|
** using this routine to avoid a memory leak. |
|
** |
|
** The [sqlite3_snapshot_free()] interface is only available when the |
|
** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. |
|
*/ |
|
SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*); |
|
|
|
/* |
|
** CAPI3REF: Compare the ages of two snapshot handles. |
|
** METHOD: sqlite3_snapshot |
|
** |
|
** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages |
|
** of two valid snapshot handles. |
|
** |
|
** If the two snapshot handles are not associated with the same database |
|
** file, the result of the comparison is undefined. |
|
** |
|
** Additionally, the result of the comparison is only valid if both of the |
|
** snapshot handles were obtained by calling sqlite3_snapshot_get() since the |
|
** last time the wal file was deleted. The wal file is deleted when the |
|
** database is changed back to rollback mode or when the number of database |
|
** clients drops to zero. If either snapshot handle was obtained before the |
|
** wal file was last deleted, the value returned by this function |
|
** is undefined. |
|
** |
|
** Otherwise, this API returns a negative value if P1 refers to an older |
|
** snapshot than P2, zero if the two handles refer to the same database |
|
** snapshot, and a positive value if P1 is a newer snapshot than P2. |
|
** |
|
** This interface is only available if SQLite is compiled with the |
|
** [SQLITE_ENABLE_SNAPSHOT] option. |
|
*/ |
|
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp( |
|
sqlite3_snapshot *p1, |
|
sqlite3_snapshot *p2 |
|
); |
|
|
|
/* |
|
** CAPI3REF: Recover snapshots from a wal file |
|
** METHOD: sqlite3_snapshot |
|
** |
|
** If a [WAL file] remains on disk after all database connections close |
|
** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control] |
|
** or because the last process to have the database opened exited without |
|
** calling [sqlite3_close()]) and a new connection is subsequently opened |
|
** on that database and [WAL file], the [sqlite3_snapshot_open()] interface |
|
** will only be able to open the last transaction added to the WAL file |
|
** even though the WAL file contains other valid transactions. |
|
** |
|
** This function attempts to scan the WAL file associated with database zDb |
|
** of database handle db and make all valid snapshots available to |
|
** sqlite3_snapshot_open(). It is an error if there is already a read |
|
** transaction open on the database, or if the database is not a WAL mode |
|
** database. |
|
** |
|
** SQLITE_OK is returned if successful, or an SQLite error code otherwise. |
|
** |
|
** This interface is only available if SQLite is compiled with the |
|
** [SQLITE_ENABLE_SNAPSHOT] option. |
|
*/ |
|
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb); |
|
|
|
/* |
|
** CAPI3REF: Serialize a database |
|
** |
|
** The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory |
|
** that is a serialization of the S database on [database connection] D. |
|
** If P is not a NULL pointer, then the size of the database in bytes |
|
** is written into *P. |
|
** |
|
** For an ordinary on-disk database file, the serialization is just a |
|
** copy of the disk file. For an in-memory database or a "TEMP" database, |
|
** the serialization is the same sequence of bytes which would be written |
|
** to disk if that database where backed up to disk. |
|
** |
|
** The usual case is that sqlite3_serialize() copies the serialization of |
|
** the database into memory obtained from [sqlite3_malloc64()] and returns |
|
** a pointer to that memory. The caller is responsible for freeing the |
|
** returned value to avoid a memory leak. However, if the F argument |
|
** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations |
|
** are made, and the sqlite3_serialize() function will return a pointer |
|
** to the contiguous memory representation of the database that SQLite |
|
** is currently using for that database, or NULL if the no such contiguous |
|
** memory representation of the database exists. A contiguous memory |
|
** representation of the database will usually only exist if there has |
|
** been a prior call to [sqlite3_deserialize(D,S,...)] with the same |
|
** values of D and S. |
|
** The size of the database is written into *P even if the |
|
** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy |
|
** of the database exists. |
|
** |
|
** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the |
|
** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory |
|
** allocation error occurs. |
|
** |
|
** This interface is only available if SQLite is compiled with the |
|
** [SQLITE_ENABLE_DESERIALIZE] option. |
|
*/ |
|
SQLITE_API unsigned char *sqlite3_serialize( |
|
sqlite3 *db, /* The database connection */ |
|
const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */ |
|
sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */ |
|
unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Flags for sqlite3_serialize |
|
** |
|
** Zero or more of the following constants can be OR-ed together for |
|
** the F argument to [sqlite3_serialize(D,S,P,F)]. |
|
** |
|
** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return |
|
** a pointer to contiguous in-memory database that it is currently using, |
|
** without making a copy of the database. If SQLite is not currently using |
|
** a contiguous in-memory database, then this option causes |
|
** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be |
|
** using a contiguous in-memory database if it has been initialized by a |
|
** prior call to [sqlite3_deserialize()]. |
|
*/ |
|
#define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */ |
|
|
|
/* |
|
** CAPI3REF: Deserialize a database |
|
** |
|
** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the |
|
** [database connection] D to disconnect from database S and then |
|
** reopen S as an in-memory database based on the serialization contained |
|
** in P. The serialized database P is N bytes in size. M is the size of |
|
** the buffer P, which might be larger than N. If M is larger than N, and |
|
** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is |
|
** permitted to add content to the in-memory database as long as the total |
|
** size does not exceed M bytes. |
|
** |
|
** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will |
|
** invoke sqlite3_free() on the serialization buffer when the database |
|
** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then |
|
** SQLite will try to increase the buffer size using sqlite3_realloc64() |
|
** if writes on the database cause it to grow larger than M bytes. |
|
** |
|
** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the |
|
** database is currently in a read transaction or is involved in a backup |
|
** operation. |
|
** |
|
** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the |
|
** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then |
|
** [sqlite3_free()] is invoked on argument P prior to returning. |
|
** |
|
** This interface is only available if SQLite is compiled with the |
|
** [SQLITE_ENABLE_DESERIALIZE] option. |
|
*/ |
|
SQLITE_API int sqlite3_deserialize( |
|
sqlite3 *db, /* The database connection */ |
|
const char *zSchema, /* Which DB to reopen with the deserialization */ |
|
unsigned char *pData, /* The serialized database content */ |
|
sqlite3_int64 szDb, /* Number bytes in the deserialization */ |
|
sqlite3_int64 szBuf, /* Total size of buffer pData[] */ |
|
unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Flags for sqlite3_deserialize() |
|
** |
|
** The following are allowed values for 6th argument (the F argument) to |
|
** the [sqlite3_deserialize(D,S,P,N,M,F)] interface. |
|
** |
|
** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization |
|
** in the P argument is held in memory obtained from [sqlite3_malloc64()] |
|
** and that SQLite should take ownership of this memory and automatically |
|
** free it when it has finished using it. Without this flag, the caller |
|
** is responsible for freeing any dynamically allocated memory. |
|
** |
|
** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to |
|
** grow the size of the database using calls to [sqlite3_realloc64()]. This |
|
** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used. |
|
** Without this flag, the deserialized database cannot increase in size beyond |
|
** the number of bytes specified by the M parameter. |
|
** |
|
** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database |
|
** should be treated as read-only. |
|
*/ |
|
#define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */ |
|
#define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */ |
|
#define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */ |
|
|
|
/* |
** Undo the hack that converts floating point types to integer for |
** Undo the hack that converts floating point types to integer for |
** builds on processors without floating point support. |
** builds on processors without floating point support. |
*/ |
*/ |
Line 6889 SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
|
Line 9812 SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
|
#ifdef __cplusplus |
#ifdef __cplusplus |
} /* End of the 'extern "C"' block */ |
} /* End of the 'extern "C"' block */ |
#endif |
#endif |
#endif | #endif /* SQLITE3_H */ |
|
|
|
/******** Begin file sqlite3rtree.h *********/ |
/* |
/* |
** 2010 August 30 |
** 2010 August 30 |
** |
** |
Line 6913 extern "C" {
|
Line 9837 extern "C" {
|
#endif |
#endif |
|
|
typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; |
typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; |
|
typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info; |
|
|
|
/* The double-precision datatype used by RTree depends on the |
|
** SQLITE_RTREE_INT_ONLY compile-time option. |
|
*/ |
|
#ifdef SQLITE_RTREE_INT_ONLY |
|
typedef sqlite3_int64 sqlite3_rtree_dbl; |
|
#else |
|
typedef double sqlite3_rtree_dbl; |
|
#endif |
|
|
/* |
/* |
** Register a geometry callback named zGeom that can be used as part of an |
** Register a geometry callback named zGeom that can be used as part of an |
** R-Tree geometry query as follows: |
** R-Tree geometry query as follows: |
Line 6923 typedef struct sqlite3_rtree_geometry sqlite3_rtree_ge
|
Line 9857 typedef struct sqlite3_rtree_geometry sqlite3_rtree_ge
|
SQLITE_API int sqlite3_rtree_geometry_callback( |
SQLITE_API int sqlite3_rtree_geometry_callback( |
sqlite3 *db, |
sqlite3 *db, |
const char *zGeom, |
const char *zGeom, |
int (*xGeom)(sqlite3_rtree_geometry *, int nCoord, double *aCoord, int *pRes), | int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*), |
void *pContext |
void *pContext |
); |
); |
|
|
Line 6935 SQLITE_API int sqlite3_rtree_geometry_callback(
|
Line 9869 SQLITE_API int sqlite3_rtree_geometry_callback(
|
struct sqlite3_rtree_geometry { |
struct sqlite3_rtree_geometry { |
void *pContext; /* Copy of pContext passed to s_r_g_c() */ |
void *pContext; /* Copy of pContext passed to s_r_g_c() */ |
int nParam; /* Size of array aParam[] */ |
int nParam; /* Size of array aParam[] */ |
double *aParam; /* Parameters passed to SQL geom function */ | sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */ |
void *pUser; /* Callback implementation user data */ |
void *pUser; /* Callback implementation user data */ |
void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ |
void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ |
}; |
}; |
|
|
|
/* |
|
** Register a 2nd-generation geometry callback named zScore that can be |
|
** used as part of an R-Tree geometry query as follows: |
|
** |
|
** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...) |
|
*/ |
|
SQLITE_API int sqlite3_rtree_query_callback( |
|
sqlite3 *db, |
|
const char *zQueryFunc, |
|
int (*xQueryFunc)(sqlite3_rtree_query_info*), |
|
void *pContext, |
|
void (*xDestructor)(void*) |
|
); |
|
|
|
|
|
/* |
|
** A pointer to a structure of the following type is passed as the |
|
** argument to scored geometry callback registered using |
|
** sqlite3_rtree_query_callback(). |
|
** |
|
** Note that the first 5 fields of this structure are identical to |
|
** sqlite3_rtree_geometry. This structure is a subclass of |
|
** sqlite3_rtree_geometry. |
|
*/ |
|
struct sqlite3_rtree_query_info { |
|
void *pContext; /* pContext from when function registered */ |
|
int nParam; /* Number of function parameters */ |
|
sqlite3_rtree_dbl *aParam; /* value of function parameters */ |
|
void *pUser; /* callback can use this, if desired */ |
|
void (*xDelUser)(void*); /* function to free pUser */ |
|
sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */ |
|
unsigned int *anQueue; /* Number of pending entries in the queue */ |
|
int nCoord; /* Number of coordinates */ |
|
int iLevel; /* Level of current node or entry */ |
|
int mxLevel; /* The largest iLevel value in the tree */ |
|
sqlite3_int64 iRowid; /* Rowid for current entry */ |
|
sqlite3_rtree_dbl rParentScore; /* Score of parent node */ |
|
int eParentWithin; /* Visibility of parent node */ |
|
int eWithin; /* OUT: Visibility */ |
|
sqlite3_rtree_dbl rScore; /* OUT: Write the score here */ |
|
/* The following fields are only available in 3.8.11 and later */ |
|
sqlite3_value **apSqlParam; /* Original SQL values of parameters */ |
|
}; |
|
|
|
/* |
|
** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin. |
|
*/ |
|
#define NOT_WITHIN 0 /* Object completely outside of query region */ |
|
#define PARTLY_WITHIN 1 /* Object partially overlaps query region */ |
|
#define FULLY_WITHIN 2 /* Object fully contained within query region */ |
|
|
|
|
#ifdef __cplusplus |
#ifdef __cplusplus |
} /* end of the 'extern "C"' block */ |
} /* end of the 'extern "C"' block */ |
#endif |
#endif |
|
|
#endif /* ifndef _SQLITE3RTREE_H_ */ |
#endif /* ifndef _SQLITE3RTREE_H_ */ |
|
|
|
/******** End of sqlite3rtree.h *********/ |
|
/******** Begin file sqlite3session.h *********/ |
|
|
|
#if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) |
|
#define __SQLITESESSION_H_ 1 |
|
|
|
/* |
|
** Make sure we can call this stuff from C++. |
|
*/ |
|
#ifdef __cplusplus |
|
extern "C" { |
|
#endif |
|
|
|
|
|
/* |
|
** CAPI3REF: Session Object Handle |
|
** |
|
** An instance of this object is a [session] that can be used to |
|
** record changes to a database. |
|
*/ |
|
typedef struct sqlite3_session sqlite3_session; |
|
|
|
/* |
|
** CAPI3REF: Changeset Iterator Handle |
|
** |
|
** An instance of this object acts as a cursor for iterating |
|
** over the elements of a [changeset] or [patchset]. |
|
*/ |
|
typedef struct sqlite3_changeset_iter sqlite3_changeset_iter; |
|
|
|
/* |
|
** CAPI3REF: Create A New Session Object |
|
** CONSTRUCTOR: sqlite3_session |
|
** |
|
** Create a new session object attached to database handle db. If successful, |
|
** a pointer to the new object is written to *ppSession and SQLITE_OK is |
|
** returned. If an error occurs, *ppSession is set to NULL and an SQLite |
|
** error code (e.g. SQLITE_NOMEM) is returned. |
|
** |
|
** It is possible to create multiple session objects attached to a single |
|
** database handle. |
|
** |
|
** Session objects created using this function should be deleted using the |
|
** [sqlite3session_delete()] function before the database handle that they |
|
** are attached to is itself closed. If the database handle is closed before |
|
** the session object is deleted, then the results of calling any session |
|
** module function, including [sqlite3session_delete()] on the session object |
|
** are undefined. |
|
** |
|
** Because the session module uses the [sqlite3_preupdate_hook()] API, it |
|
** is not possible for an application to register a pre-update hook on a |
|
** database handle that has one or more session objects attached. Nor is |
|
** it possible to create a session object attached to a database handle for |
|
** which a pre-update hook is already defined. The results of attempting |
|
** either of these things are undefined. |
|
** |
|
** The session object will be used to create changesets for tables in |
|
** database zDb, where zDb is either "main", or "temp", or the name of an |
|
** attached database. It is not an error if database zDb is not attached |
|
** to the database when the session object is created. |
|
*/ |
|
SQLITE_API int sqlite3session_create( |
|
sqlite3 *db, /* Database handle */ |
|
const char *zDb, /* Name of db (e.g. "main") */ |
|
sqlite3_session **ppSession /* OUT: New session object */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Delete A Session Object |
|
** DESTRUCTOR: sqlite3_session |
|
** |
|
** Delete a session object previously allocated using |
|
** [sqlite3session_create()]. Once a session object has been deleted, the |
|
** results of attempting to use pSession with any other session module |
|
** function are undefined. |
|
** |
|
** Session objects must be deleted before the database handle to which they |
|
** are attached is closed. Refer to the documentation for |
|
** [sqlite3session_create()] for details. |
|
*/ |
|
SQLITE_API void sqlite3session_delete(sqlite3_session *pSession); |
|
|
|
|
|
/* |
|
** CAPI3REF: Enable Or Disable A Session Object |
|
** METHOD: sqlite3_session |
|
** |
|
** Enable or disable the recording of changes by a session object. When |
|
** enabled, a session object records changes made to the database. When |
|
** disabled - it does not. A newly created session object is enabled. |
|
** Refer to the documentation for [sqlite3session_changeset()] for further |
|
** details regarding how enabling and disabling a session object affects |
|
** the eventual changesets. |
|
** |
|
** Passing zero to this function disables the session. Passing a value |
|
** greater than zero enables it. Passing a value less than zero is a |
|
** no-op, and may be used to query the current state of the session. |
|
** |
|
** The return value indicates the final state of the session object: 0 if |
|
** the session is disabled, or 1 if it is enabled. |
|
*/ |
|
SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable); |
|
|
|
/* |
|
** CAPI3REF: Set Or Clear the Indirect Change Flag |
|
** METHOD: sqlite3_session |
|
** |
|
** Each change recorded by a session object is marked as either direct or |
|
** indirect. A change is marked as indirect if either: |
|
** |
|
** <ul> |
|
** <li> The session object "indirect" flag is set when the change is |
|
** made, or |
|
** <li> The change is made by an SQL trigger or foreign key action |
|
** instead of directly as a result of a users SQL statement. |
|
** </ul> |
|
** |
|
** If a single row is affected by more than one operation within a session, |
|
** then the change is considered indirect if all operations meet the criteria |
|
** for an indirect change above, or direct otherwise. |
|
** |
|
** This function is used to set, clear or query the session object indirect |
|
** flag. If the second argument passed to this function is zero, then the |
|
** indirect flag is cleared. If it is greater than zero, the indirect flag |
|
** is set. Passing a value less than zero does not modify the current value |
|
** of the indirect flag, and may be used to query the current state of the |
|
** indirect flag for the specified session object. |
|
** |
|
** The return value indicates the final state of the indirect flag: 0 if |
|
** it is clear, or 1 if it is set. |
|
*/ |
|
SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect); |
|
|
|
/* |
|
** CAPI3REF: Attach A Table To A Session Object |
|
** METHOD: sqlite3_session |
|
** |
|
** If argument zTab is not NULL, then it is the name of a table to attach |
|
** to the session object passed as the first argument. All subsequent changes |
|
** made to the table while the session object is enabled will be recorded. See |
|
** documentation for [sqlite3session_changeset()] for further details. |
|
** |
|
** Or, if argument zTab is NULL, then changes are recorded for all tables |
|
** in the database. If additional tables are added to the database (by |
|
** executing "CREATE TABLE" statements) after this call is made, changes for |
|
** the new tables are also recorded. |
|
** |
|
** Changes can only be recorded for tables that have a PRIMARY KEY explicitly |
|
** defined as part of their CREATE TABLE statement. It does not matter if the |
|
** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY |
|
** KEY may consist of a single column, or may be a composite key. |
|
** |
|
** It is not an error if the named table does not exist in the database. Nor |
|
** is it an error if the named table does not have a PRIMARY KEY. However, |
|
** no changes will be recorded in either of these scenarios. |
|
** |
|
** Changes are not recorded for individual rows that have NULL values stored |
|
** in one or more of their PRIMARY KEY columns. |
|
** |
|
** SQLITE_OK is returned if the call completes without error. Or, if an error |
|
** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned. |
|
** |
|
** <h3>Special sqlite_stat1 Handling</h3> |
|
** |
|
** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to |
|
** some of the rules above. In SQLite, the schema of sqlite_stat1 is: |
|
** <pre> |
|
** CREATE TABLE sqlite_stat1(tbl,idx,stat) |
|
** </pre> |
|
** |
|
** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are |
|
** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes |
|
** are recorded for rows for which (idx IS NULL) is true. However, for such |
|
** rows a zero-length blob (SQL value X'') is stored in the changeset or |
|
** patchset instead of a NULL value. This allows such changesets to be |
|
** manipulated by legacy implementations of sqlite3changeset_invert(), |
|
** concat() and similar. |
|
** |
|
** The sqlite3changeset_apply() function automatically converts the |
|
** zero-length blob back to a NULL value when updating the sqlite_stat1 |
|
** table. However, if the application calls sqlite3changeset_new(), |
|
** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset |
|
** iterator directly (including on a changeset iterator passed to a |
|
** conflict-handler callback) then the X'' value is returned. The application |
|
** must translate X'' to NULL itself if required. |
|
** |
|
** Legacy (older than 3.22.0) versions of the sessions module cannot capture |
|
** changes made to the sqlite_stat1 table. Legacy versions of the |
|
** sqlite3changeset_apply() function silently ignore any modifications to the |
|
** sqlite_stat1 table that are part of a changeset or patchset. |
|
*/ |
|
SQLITE_API int sqlite3session_attach( |
|
sqlite3_session *pSession, /* Session object */ |
|
const char *zTab /* Table name */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Set a table filter on a Session Object. |
|
** METHOD: sqlite3_session |
|
** |
|
** The second argument (xFilter) is the "filter callback". For changes to rows |
|
** in tables that are not attached to the Session object, the filter is called |
|
** to determine whether changes to the table's rows should be tracked or not. |
|
** If xFilter returns 0, changes are not tracked. Note that once a table is |
|
** attached, xFilter will not be called again. |
|
*/ |
|
SQLITE_API void sqlite3session_table_filter( |
|
sqlite3_session *pSession, /* Session object */ |
|
int(*xFilter)( |
|
void *pCtx, /* Copy of third arg to _filter_table() */ |
|
const char *zTab /* Table name */ |
|
), |
|
void *pCtx /* First argument passed to xFilter */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Generate A Changeset From A Session Object |
|
** METHOD: sqlite3_session |
|
** |
|
** Obtain a changeset containing changes to the tables attached to the |
|
** session object passed as the first argument. If successful, |
|
** set *ppChangeset to point to a buffer containing the changeset |
|
** and *pnChangeset to the size of the changeset in bytes before returning |
|
** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to |
|
** zero and return an SQLite error code. |
|
** |
|
** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes, |
|
** each representing a change to a single row of an attached table. An INSERT |
|
** change contains the values of each field of a new database row. A DELETE |
|
** contains the original values of each field of a deleted database row. An |
|
** UPDATE change contains the original values of each field of an updated |
|
** database row along with the updated values for each updated non-primary-key |
|
** column. It is not possible for an UPDATE change to represent a change that |
|
** modifies the values of primary key columns. If such a change is made, it |
|
** is represented in a changeset as a DELETE followed by an INSERT. |
|
** |
|
** Changes are not recorded for rows that have NULL values stored in one or |
|
** more of their PRIMARY KEY columns. If such a row is inserted or deleted, |
|
** no corresponding change is present in the changesets returned by this |
|
** function. If an existing row with one or more NULL values stored in |
|
** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL, |
|
** only an INSERT is appears in the changeset. Similarly, if an existing row |
|
** with non-NULL PRIMARY KEY values is updated so that one or more of its |
|
** PRIMARY KEY columns are set to NULL, the resulting changeset contains a |
|
** DELETE change only. |
|
** |
|
** The contents of a changeset may be traversed using an iterator created |
|
** using the [sqlite3changeset_start()] API. A changeset may be applied to |
|
** a database with a compatible schema using the [sqlite3changeset_apply()] |
|
** API. |
|
** |
|
** Within a changeset generated by this function, all changes related to a |
|
** single table are grouped together. In other words, when iterating through |
|
** a changeset or when applying a changeset to a database, all changes related |
|
** to a single table are processed before moving on to the next table. Tables |
|
** are sorted in the same order in which they were attached (or auto-attached) |
|
** to the sqlite3_session object. The order in which the changes related to |
|
** a single table are stored is undefined. |
|
** |
|
** Following a successful call to this function, it is the responsibility of |
|
** the caller to eventually free the buffer that *ppChangeset points to using |
|
** [sqlite3_free()]. |
|
** |
|
** <h3>Changeset Generation</h3> |
|
** |
|
** Once a table has been attached to a session object, the session object |
|
** records the primary key values of all new rows inserted into the table. |
|
** It also records the original primary key and other column values of any |
|
** deleted or updated rows. For each unique primary key value, data is only |
|
** recorded once - the first time a row with said primary key is inserted, |
|
** updated or deleted in the lifetime of the session. |
|
** |
|
** There is one exception to the previous paragraph: when a row is inserted, |
|
** updated or deleted, if one or more of its primary key columns contain a |
|
** NULL value, no record of the change is made. |
|
** |
|
** The session object therefore accumulates two types of records - those |
|
** that consist of primary key values only (created when the user inserts |
|
** a new record) and those that consist of the primary key values and the |
|
** original values of other table columns (created when the users deletes |
|
** or updates a record). |
|
** |
|
** When this function is called, the requested changeset is created using |
|
** both the accumulated records and the current contents of the database |
|
** file. Specifically: |
|
** |
|
** <ul> |
|
** <li> For each record generated by an insert, the database is queried |
|
** for a row with a matching primary key. If one is found, an INSERT |
|
** change is added to the changeset. If no such row is found, no change |
|
** is added to the changeset. |
|
** |
|
** <li> For each record generated by an update or delete, the database is |
|
** queried for a row with a matching primary key. If such a row is |
|
** found and one or more of the non-primary key fields have been |
|
** modified from their original values, an UPDATE change is added to |
|
** the changeset. Or, if no such row is found in the table, a DELETE |
|
** change is added to the changeset. If there is a row with a matching |
|
** primary key in the database, but all fields contain their original |
|
** values, no change is added to the changeset. |
|
** </ul> |
|
** |
|
** This means, amongst other things, that if a row is inserted and then later |
|
** deleted while a session object is active, neither the insert nor the delete |
|
** will be present in the changeset. Or if a row is deleted and then later a |
|
** row with the same primary key values inserted while a session object is |
|
** active, the resulting changeset will contain an UPDATE change instead of |
|
** a DELETE and an INSERT. |
|
** |
|
** When a session object is disabled (see the [sqlite3session_enable()] API), |
|
** it does not accumulate records when rows are inserted, updated or deleted. |
|
** This may appear to have some counter-intuitive effects if a single row |
|
** is written to more than once during a session. For example, if a row |
|
** is inserted while a session object is enabled, then later deleted while |
|
** the same session object is disabled, no INSERT record will appear in the |
|
** changeset, even though the delete took place while the session was disabled. |
|
** Or, if one field of a row is updated while a session is disabled, and |
|
** another field of the same row is updated while the session is enabled, the |
|
** resulting changeset will contain an UPDATE change that updates both fields. |
|
*/ |
|
SQLITE_API int sqlite3session_changeset( |
|
sqlite3_session *pSession, /* Session object */ |
|
int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */ |
|
void **ppChangeset /* OUT: Buffer containing changeset */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Load The Difference Between Tables Into A Session |
|
** METHOD: sqlite3_session |
|
** |
|
** If it is not already attached to the session object passed as the first |
|
** argument, this function attaches table zTbl in the same manner as the |
|
** [sqlite3session_attach()] function. If zTbl does not exist, or if it |
|
** does not have a primary key, this function is a no-op (but does not return |
|
** an error). |
|
** |
|
** Argument zFromDb must be the name of a database ("main", "temp" etc.) |
|
** attached to the same database handle as the session object that contains |
|
** a table compatible with the table attached to the session by this function. |
|
** A table is considered compatible if it: |
|
** |
|
** <ul> |
|
** <li> Has the same name, |
|
** <li> Has the same set of columns declared in the same order, and |
|
** <li> Has the same PRIMARY KEY definition. |
|
** </ul> |
|
** |
|
** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables |
|
** are compatible but do not have any PRIMARY KEY columns, it is not an error |
|
** but no changes are added to the session object. As with other session |
|
** APIs, tables without PRIMARY KEYs are simply ignored. |
|
** |
|
** This function adds a set of changes to the session object that could be |
|
** used to update the table in database zFrom (call this the "from-table") |
|
** so that its content is the same as the table attached to the session |
|
** object (call this the "to-table"). Specifically: |
|
** |
|
** <ul> |
|
** <li> For each row (primary key) that exists in the to-table but not in |
|
** the from-table, an INSERT record is added to the session object. |
|
** |
|
** <li> For each row (primary key) that exists in the to-table but not in |
|
** the from-table, a DELETE record is added to the session object. |
|
** |
|
** <li> For each row (primary key) that exists in both tables, but features |
|
** different non-PK values in each, an UPDATE record is added to the |
|
** session. |
|
** </ul> |
|
** |
|
** To clarify, if this function is called and then a changeset constructed |
|
** using [sqlite3session_changeset()], then after applying that changeset to |
|
** database zFrom the contents of the two compatible tables would be |
|
** identical. |
|
** |
|
** It an error if database zFrom does not exist or does not contain the |
|
** required compatible table. |
|
** |
|
** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite |
|
** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg |
|
** may be set to point to a buffer containing an English language error |
|
** message. It is the responsibility of the caller to free this buffer using |
|
** sqlite3_free(). |
|
*/ |
|
SQLITE_API int sqlite3session_diff( |
|
sqlite3_session *pSession, |
|
const char *zFromDb, |
|
const char *zTbl, |
|
char **pzErrMsg |
|
); |
|
|
|
|
|
/* |
|
** CAPI3REF: Generate A Patchset From A Session Object |
|
** METHOD: sqlite3_session |
|
** |
|
** The differences between a patchset and a changeset are that: |
|
** |
|
** <ul> |
|
** <li> DELETE records consist of the primary key fields only. The |
|
** original values of other fields are omitted. |
|
** <li> The original values of any modified fields are omitted from |
|
** UPDATE records. |
|
** </ul> |
|
** |
|
** A patchset blob may be used with up to date versions of all |
|
** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(), |
|
** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly, |
|
** attempting to use a patchset blob with old versions of the |
|
** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error. |
|
** |
|
** Because the non-primary key "old.*" fields are omitted, no |
|
** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset |
|
** is passed to the sqlite3changeset_apply() API. Other conflict types work |
|
** in the same way as for changesets. |
|
** |
|
** Changes within a patchset are ordered in the same way as for changesets |
|
** generated by the sqlite3session_changeset() function (i.e. all changes for |
|
** a single table are grouped together, tables appear in the order in which |
|
** they were attached to the session object). |
|
*/ |
|
SQLITE_API int sqlite3session_patchset( |
|
sqlite3_session *pSession, /* Session object */ |
|
int *pnPatchset, /* OUT: Size of buffer at *ppPatchset */ |
|
void **ppPatchset /* OUT: Buffer containing patchset */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Test if a changeset has recorded any changes. |
|
** |
|
** Return non-zero if no changes to attached tables have been recorded by |
|
** the session object passed as the first argument. Otherwise, if one or |
|
** more changes have been recorded, return zero. |
|
** |
|
** Even if this function returns zero, it is possible that calling |
|
** [sqlite3session_changeset()] on the session handle may still return a |
|
** changeset that contains no changes. This can happen when a row in |
|
** an attached table is modified and then later on the original values |
|
** are restored. However, if this function returns non-zero, then it is |
|
** guaranteed that a call to sqlite3session_changeset() will return a |
|
** changeset containing zero changes. |
|
*/ |
|
SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession); |
|
|
|
/* |
|
** CAPI3REF: Create An Iterator To Traverse A Changeset |
|
** CONSTRUCTOR: sqlite3_changeset_iter |
|
** |
|
** Create an iterator used to iterate through the contents of a changeset. |
|
** If successful, *pp is set to point to the iterator handle and SQLITE_OK |
|
** is returned. Otherwise, if an error occurs, *pp is set to zero and an |
|
** SQLite error code is returned. |
|
** |
|
** The following functions can be used to advance and query a changeset |
|
** iterator created by this function: |
|
** |
|
** <ul> |
|
** <li> [sqlite3changeset_next()] |
|
** <li> [sqlite3changeset_op()] |
|
** <li> [sqlite3changeset_new()] |
|
** <li> [sqlite3changeset_old()] |
|
** </ul> |
|
** |
|
** It is the responsibility of the caller to eventually destroy the iterator |
|
** by passing it to [sqlite3changeset_finalize()]. The buffer containing the |
|
** changeset (pChangeset) must remain valid until after the iterator is |
|
** destroyed. |
|
** |
|
** Assuming the changeset blob was created by one of the |
|
** [sqlite3session_changeset()], [sqlite3changeset_concat()] or |
|
** [sqlite3changeset_invert()] functions, all changes within the changeset |
|
** that apply to a single table are grouped together. This means that when |
|
** an application iterates through a changeset using an iterator created by |
|
** this function, all changes that relate to a single table are visited |
|
** consecutively. There is no chance that the iterator will visit a change |
|
** the applies to table X, then one for table Y, and then later on visit |
|
** another change for table X. |
|
** |
|
** The behavior of sqlite3changeset_start_v2() and its streaming equivalent |
|
** may be modified by passing a combination of |
|
** [SQLITE_CHANGESETSTART_INVERT | supported flags] as the 4th parameter. |
|
** |
|
** Note that the sqlite3changeset_start_v2() API is still <b>experimental</b> |
|
** and therefore subject to change. |
|
*/ |
|
SQLITE_API int sqlite3changeset_start( |
|
sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */ |
|
int nChangeset, /* Size of changeset blob in bytes */ |
|
void *pChangeset /* Pointer to blob containing changeset */ |
|
); |
|
SQLITE_API int sqlite3changeset_start_v2( |
|
sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */ |
|
int nChangeset, /* Size of changeset blob in bytes */ |
|
void *pChangeset, /* Pointer to blob containing changeset */ |
|
int flags /* SESSION_CHANGESETSTART_* flags */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Flags for sqlite3changeset_start_v2 |
|
** |
|
** The following flags may passed via the 4th parameter to |
|
** [sqlite3changeset_start_v2] and [sqlite3changeset_start_v2_strm]: |
|
** |
|
** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd> |
|
** Invert the changeset while iterating through it. This is equivalent to |
|
** inverting a changeset using sqlite3changeset_invert() before applying it. |
|
** It is an error to specify this flag with a patchset. |
|
*/ |
|
#define SQLITE_CHANGESETSTART_INVERT 0x0002 |
|
|
|
|
|
/* |
|
** CAPI3REF: Advance A Changeset Iterator |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** This function may only be used with iterators created by the function |
|
** [sqlite3changeset_start()]. If it is called on an iterator passed to |
|
** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE |
|
** is returned and the call has no effect. |
|
** |
|
** Immediately after an iterator is created by sqlite3changeset_start(), it |
|
** does not point to any change in the changeset. Assuming the changeset |
|
** is not empty, the first call to this function advances the iterator to |
|
** point to the first change in the changeset. Each subsequent call advances |
|
** the iterator to point to the next change in the changeset (if any). If |
|
** no error occurs and the iterator points to a valid change after a call |
|
** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned. |
|
** Otherwise, if all changes in the changeset have already been visited, |
|
** SQLITE_DONE is returned. |
|
** |
|
** If an error occurs, an SQLite error code is returned. Possible error |
|
** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or |
|
** SQLITE_NOMEM. |
|
*/ |
|
SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter); |
|
|
|
/* |
|
** CAPI3REF: Obtain The Current Operation From A Changeset Iterator |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** The pIter argument passed to this function may either be an iterator |
|
** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator |
|
** created by [sqlite3changeset_start()]. In the latter case, the most recent |
|
** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this |
|
** is not the case, this function returns [SQLITE_MISUSE]. |
|
** |
|
** If argument pzTab is not NULL, then *pzTab is set to point to a |
|
** nul-terminated utf-8 encoded string containing the name of the table |
|
** affected by the current change. The buffer remains valid until either |
|
** sqlite3changeset_next() is called on the iterator or until the |
|
** conflict-handler function returns. If pnCol is not NULL, then *pnCol is |
|
** set to the number of columns in the table affected by the change. If |
|
** pbIndirect is not NULL, then *pbIndirect is set to true (1) if the change |
|
** is an indirect change, or false (0) otherwise. See the documentation for |
|
** [sqlite3session_indirect()] for a description of direct and indirect |
|
** changes. Finally, if pOp is not NULL, then *pOp is set to one of |
|
** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the |
|
** type of change that the iterator currently points to. |
|
** |
|
** If no error occurs, SQLITE_OK is returned. If an error does occur, an |
|
** SQLite error code is returned. The values of the output variables may not |
|
** be trusted in this case. |
|
*/ |
|
SQLITE_API int sqlite3changeset_op( |
|
sqlite3_changeset_iter *pIter, /* Iterator object */ |
|
const char **pzTab, /* OUT: Pointer to table name */ |
|
int *pnCol, /* OUT: Number of columns in table */ |
|
int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */ |
|
int *pbIndirect /* OUT: True for an 'indirect' change */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Obtain The Primary Key Definition Of A Table |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** For each modified table, a changeset includes the following: |
|
** |
|
** <ul> |
|
** <li> The number of columns in the table, and |
|
** <li> Which of those columns make up the tables PRIMARY KEY. |
|
** </ul> |
|
** |
|
** This function is used to find which columns comprise the PRIMARY KEY of |
|
** the table modified by the change that iterator pIter currently points to. |
|
** If successful, *pabPK is set to point to an array of nCol entries, where |
|
** nCol is the number of columns in the table. Elements of *pabPK are set to |
|
** 0x01 if the corresponding column is part of the tables primary key, or |
|
** 0x00 if it is not. |
|
** |
|
** If argument pnCol is not NULL, then *pnCol is set to the number of columns |
|
** in the table. |
|
** |
|
** If this function is called when the iterator does not point to a valid |
|
** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise, |
|
** SQLITE_OK is returned and the output variables populated as described |
|
** above. |
|
*/ |
|
SQLITE_API int sqlite3changeset_pk( |
|
sqlite3_changeset_iter *pIter, /* Iterator object */ |
|
unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */ |
|
int *pnCol /* OUT: Number of entries in output array */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Obtain old.* Values From A Changeset Iterator |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** The pIter argument passed to this function may either be an iterator |
|
** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator |
|
** created by [sqlite3changeset_start()]. In the latter case, the most recent |
|
** call to [sqlite3changeset_next()] must have returned SQLITE_ROW. |
|
** Furthermore, it may only be called if the type of change that the iterator |
|
** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise, |
|
** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. |
|
** |
|
** Argument iVal must be greater than or equal to 0, and less than the number |
|
** of columns in the table affected by the current change. Otherwise, |
|
** [SQLITE_RANGE] is returned and *ppValue is set to NULL. |
|
** |
|
** If successful, this function sets *ppValue to point to a protected |
|
** sqlite3_value object containing the iVal'th value from the vector of |
|
** original row values stored as part of the UPDATE or DELETE change and |
|
** returns SQLITE_OK. The name of the function comes from the fact that this |
|
** is similar to the "old.*" columns available to update or delete triggers. |
|
** |
|
** If some other error occurs (e.g. an OOM condition), an SQLite error code |
|
** is returned and *ppValue is set to NULL. |
|
*/ |
|
SQLITE_API int sqlite3changeset_old( |
|
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
|
int iVal, /* Column number */ |
|
sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Obtain new.* Values From A Changeset Iterator |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** The pIter argument passed to this function may either be an iterator |
|
** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator |
|
** created by [sqlite3changeset_start()]. In the latter case, the most recent |
|
** call to [sqlite3changeset_next()] must have returned SQLITE_ROW. |
|
** Furthermore, it may only be called if the type of change that the iterator |
|
** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise, |
|
** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. |
|
** |
|
** Argument iVal must be greater than or equal to 0, and less than the number |
|
** of columns in the table affected by the current change. Otherwise, |
|
** [SQLITE_RANGE] is returned and *ppValue is set to NULL. |
|
** |
|
** If successful, this function sets *ppValue to point to a protected |
|
** sqlite3_value object containing the iVal'th value from the vector of |
|
** new row values stored as part of the UPDATE or INSERT change and |
|
** returns SQLITE_OK. If the change is an UPDATE and does not include |
|
** a new value for the requested column, *ppValue is set to NULL and |
|
** SQLITE_OK returned. The name of the function comes from the fact that |
|
** this is similar to the "new.*" columns available to update or delete |
|
** triggers. |
|
** |
|
** If some other error occurs (e.g. an OOM condition), an SQLite error code |
|
** is returned and *ppValue is set to NULL. |
|
*/ |
|
SQLITE_API int sqlite3changeset_new( |
|
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
|
int iVal, /* Column number */ |
|
sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** This function should only be used with iterator objects passed to a |
|
** conflict-handler callback by [sqlite3changeset_apply()] with either |
|
** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function |
|
** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue |
|
** is set to NULL. |
|
** |
|
** Argument iVal must be greater than or equal to 0, and less than the number |
|
** of columns in the table affected by the current change. Otherwise, |
|
** [SQLITE_RANGE] is returned and *ppValue is set to NULL. |
|
** |
|
** If successful, this function sets *ppValue to point to a protected |
|
** sqlite3_value object containing the iVal'th value from the |
|
** "conflicting row" associated with the current conflict-handler callback |
|
** and returns SQLITE_OK. |
|
** |
|
** If some other error occurs (e.g. an OOM condition), an SQLite error code |
|
** is returned and *ppValue is set to NULL. |
|
*/ |
|
SQLITE_API int sqlite3changeset_conflict( |
|
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
|
int iVal, /* Column number */ |
|
sqlite3_value **ppValue /* OUT: Value from conflicting row */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** This function may only be called with an iterator passed to an |
|
** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case |
|
** it sets the output variable to the total number of known foreign key |
|
** violations in the destination database and returns SQLITE_OK. |
|
** |
|
** In all other cases this function returns SQLITE_MISUSE. |
|
*/ |
|
SQLITE_API int sqlite3changeset_fk_conflicts( |
|
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
|
int *pnOut /* OUT: Number of FK violations */ |
|
); |
|
|
|
|
|
/* |
|
** CAPI3REF: Finalize A Changeset Iterator |
|
** METHOD: sqlite3_changeset_iter |
|
** |
|
** This function is used to finalize an iterator allocated with |
|
** [sqlite3changeset_start()]. |
|
** |
|
** This function should only be called on iterators created using the |
|
** [sqlite3changeset_start()] function. If an application calls this |
|
** function with an iterator passed to a conflict-handler by |
|
** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the |
|
** call has no effect. |
|
** |
|
** If an error was encountered within a call to an sqlite3changeset_xxx() |
|
** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an |
|
** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding |
|
** to that error is returned by this function. Otherwise, SQLITE_OK is |
|
** returned. This is to allow the following pattern (pseudo-code): |
|
** |
|
** <pre> |
|
** sqlite3changeset_start(); |
|
** while( SQLITE_ROW==sqlite3changeset_next() ){ |
|
** // Do something with change. |
|
** } |
|
** rc = sqlite3changeset_finalize(); |
|
** if( rc!=SQLITE_OK ){ |
|
** // An error has occurred |
|
** } |
|
** </pre> |
|
*/ |
|
SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter); |
|
|
|
/* |
|
** CAPI3REF: Invert A Changeset |
|
** |
|
** This function is used to "invert" a changeset object. Applying an inverted |
|
** changeset to a database reverses the effects of applying the uninverted |
|
** changeset. Specifically: |
|
** |
|
** <ul> |
|
** <li> Each DELETE change is changed to an INSERT, and |
|
** <li> Each INSERT change is changed to a DELETE, and |
|
** <li> For each UPDATE change, the old.* and new.* values are exchanged. |
|
** </ul> |
|
** |
|
** This function does not change the order in which changes appear within |
|
** the changeset. It merely reverses the sense of each individual change. |
|
** |
|
** If successful, a pointer to a buffer containing the inverted changeset |
|
** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and |
|
** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are |
|
** zeroed and an SQLite error code returned. |
|
** |
|
** It is the responsibility of the caller to eventually call sqlite3_free() |
|
** on the *ppOut pointer to free the buffer allocation following a successful |
|
** call to this function. |
|
** |
|
** WARNING/TODO: This function currently assumes that the input is a valid |
|
** changeset. If it is not, the results are undefined. |
|
*/ |
|
SQLITE_API int sqlite3changeset_invert( |
|
int nIn, const void *pIn, /* Input changeset */ |
|
int *pnOut, void **ppOut /* OUT: Inverse of input */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Concatenate Two Changeset Objects |
|
** |
|
** This function is used to concatenate two changesets, A and B, into a |
|
** single changeset. The result is a changeset equivalent to applying |
|
** changeset A followed by changeset B. |
|
** |
|
** This function combines the two input changesets using an |
|
** sqlite3_changegroup object. Calling it produces similar results as the |
|
** following code fragment: |
|
** |
|
** <pre> |
|
** sqlite3_changegroup *pGrp; |
|
** rc = sqlite3_changegroup_new(&pGrp); |
|
** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA); |
|
** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB); |
|
** if( rc==SQLITE_OK ){ |
|
** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut); |
|
** }else{ |
|
** *ppOut = 0; |
|
** *pnOut = 0; |
|
** } |
|
** </pre> |
|
** |
|
** Refer to the sqlite3_changegroup documentation below for details. |
|
*/ |
|
SQLITE_API int sqlite3changeset_concat( |
|
int nA, /* Number of bytes in buffer pA */ |
|
void *pA, /* Pointer to buffer containing changeset A */ |
|
int nB, /* Number of bytes in buffer pB */ |
|
void *pB, /* Pointer to buffer containing changeset B */ |
|
int *pnOut, /* OUT: Number of bytes in output changeset */ |
|
void **ppOut /* OUT: Buffer containing output changeset */ |
|
); |
|
|
|
|
|
/* |
|
** CAPI3REF: Changegroup Handle |
|
** |
|
** A changegroup is an object used to combine two or more |
|
** [changesets] or [patchsets] |
|
*/ |
|
typedef struct sqlite3_changegroup sqlite3_changegroup; |
|
|
|
/* |
|
** CAPI3REF: Create A New Changegroup Object |
|
** CONSTRUCTOR: sqlite3_changegroup |
|
** |
|
** An sqlite3_changegroup object is used to combine two or more changesets |
|
** (or patchsets) into a single changeset (or patchset). A single changegroup |
|
** object may combine changesets or patchsets, but not both. The output is |
|
** always in the same format as the input. |
|
** |
|
** If successful, this function returns SQLITE_OK and populates (*pp) with |
|
** a pointer to a new sqlite3_changegroup object before returning. The caller |
|
** should eventually free the returned object using a call to |
|
** sqlite3changegroup_delete(). If an error occurs, an SQLite error code |
|
** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL. |
|
** |
|
** The usual usage pattern for an sqlite3_changegroup object is as follows: |
|
** |
|
** <ul> |
|
** <li> It is created using a call to sqlite3changegroup_new(). |
|
** |
|
** <li> Zero or more changesets (or patchsets) are added to the object |
|
** by calling sqlite3changegroup_add(). |
|
** |
|
** <li> The result of combining all input changesets together is obtained |
|
** by the application via a call to sqlite3changegroup_output(). |
|
** |
|
** <li> The object is deleted using a call to sqlite3changegroup_delete(). |
|
** </ul> |
|
** |
|
** Any number of calls to add() and output() may be made between the calls to |
|
** new() and delete(), and in any order. |
|
** |
|
** As well as the regular sqlite3changegroup_add() and |
|
** sqlite3changegroup_output() functions, also available are the streaming |
|
** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm(). |
|
*/ |
|
SQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp); |
|
|
|
/* |
|
** CAPI3REF: Add A Changeset To A Changegroup |
|
** METHOD: sqlite3_changegroup |
|
** |
|
** Add all changes within the changeset (or patchset) in buffer pData (size |
|
** nData bytes) to the changegroup. |
|
** |
|
** If the buffer contains a patchset, then all prior calls to this function |
|
** on the same changegroup object must also have specified patchsets. Or, if |
|
** the buffer contains a changeset, so must have the earlier calls to this |
|
** function. Otherwise, SQLITE_ERROR is returned and no changes are added |
|
** to the changegroup. |
|
** |
|
** Rows within the changeset and changegroup are identified by the values in |
|
** their PRIMARY KEY columns. A change in the changeset is considered to |
|
** apply to the same row as a change already present in the changegroup if |
|
** the two rows have the same primary key. |
|
** |
|
** Changes to rows that do not already appear in the changegroup are |
|
** simply copied into it. Or, if both the new changeset and the changegroup |
|
** contain changes that apply to a single row, the final contents of the |
|
** changegroup depends on the type of each change, as follows: |
|
** |
|
** <table border=1 style="margin-left:8ex;margin-right:8ex"> |
|
** <tr><th style="white-space:pre">Existing Change </th> |
|
** <th style="white-space:pre">New Change </th> |
|
** <th>Output Change |
|
** <tr><td>INSERT <td>INSERT <td> |
|
** The new change is ignored. This case does not occur if the new |
|
** changeset was recorded immediately after the changesets already |
|
** added to the changegroup. |
|
** <tr><td>INSERT <td>UPDATE <td> |
|
** The INSERT change remains in the changegroup. The values in the |
|
** INSERT change are modified as if the row was inserted by the |
|
** existing change and then updated according to the new change. |
|
** <tr><td>INSERT <td>DELETE <td> |
|
** The existing INSERT is removed from the changegroup. The DELETE is |
|
** not added. |
|
** <tr><td>UPDATE <td>INSERT <td> |
|
** The new change is ignored. This case does not occur if the new |
|
** changeset was recorded immediately after the changesets already |
|
** added to the changegroup. |
|
** <tr><td>UPDATE <td>UPDATE <td> |
|
** The existing UPDATE remains within the changegroup. It is amended |
|
** so that the accompanying values are as if the row was updated once |
|
** by the existing change and then again by the new change. |
|
** <tr><td>UPDATE <td>DELETE <td> |
|
** The existing UPDATE is replaced by the new DELETE within the |
|
** changegroup. |
|
** <tr><td>DELETE <td>INSERT <td> |
|
** If one or more of the column values in the row inserted by the |
|
** new change differ from those in the row deleted by the existing |
|
** change, the existing DELETE is replaced by an UPDATE within the |
|
** changegroup. Otherwise, if the inserted row is exactly the same |
|
** as the deleted row, the existing DELETE is simply discarded. |
|
** <tr><td>DELETE <td>UPDATE <td> |
|
** The new change is ignored. This case does not occur if the new |
|
** changeset was recorded immediately after the changesets already |
|
** added to the changegroup. |
|
** <tr><td>DELETE <td>DELETE <td> |
|
** The new change is ignored. This case does not occur if the new |
|
** changeset was recorded immediately after the changesets already |
|
** added to the changegroup. |
|
** </table> |
|
** |
|
** If the new changeset contains changes to a table that is already present |
|
** in the changegroup, then the number of columns and the position of the |
|
** primary key columns for the table must be consistent. If this is not the |
|
** case, this function fails with SQLITE_SCHEMA. If the input changeset |
|
** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is |
|
** returned. Or, if an out-of-memory condition occurs during processing, this |
|
** function returns SQLITE_NOMEM. In all cases, if an error occurs the state |
|
** of the final contents of the changegroup is undefined. |
|
** |
|
** If no error occurs, SQLITE_OK is returned. |
|
*/ |
|
SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData); |
|
|
|
/* |
|
** CAPI3REF: Obtain A Composite Changeset From A Changegroup |
|
** METHOD: sqlite3_changegroup |
|
** |
|
** Obtain a buffer containing a changeset (or patchset) representing the |
|
** current contents of the changegroup. If the inputs to the changegroup |
|
** were themselves changesets, the output is a changeset. Or, if the |
|
** inputs were patchsets, the output is also a patchset. |
|
** |
|
** As with the output of the sqlite3session_changeset() and |
|
** sqlite3session_patchset() functions, all changes related to a single |
|
** table are grouped together in the output of this function. Tables appear |
|
** in the same order as for the very first changeset added to the changegroup. |
|
** If the second or subsequent changesets added to the changegroup contain |
|
** changes for tables that do not appear in the first changeset, they are |
|
** appended onto the end of the output changeset, again in the order in |
|
** which they are first encountered. |
|
** |
|
** If an error occurs, an SQLite error code is returned and the output |
|
** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK |
|
** is returned and the output variables are set to the size of and a |
|
** pointer to the output buffer, respectively. In this case it is the |
|
** responsibility of the caller to eventually free the buffer using a |
|
** call to sqlite3_free(). |
|
*/ |
|
SQLITE_API int sqlite3changegroup_output( |
|
sqlite3_changegroup*, |
|
int *pnData, /* OUT: Size of output buffer in bytes */ |
|
void **ppData /* OUT: Pointer to output buffer */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Delete A Changegroup Object |
|
** DESTRUCTOR: sqlite3_changegroup |
|
*/ |
|
SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*); |
|
|
|
/* |
|
** CAPI3REF: Apply A Changeset To A Database |
|
** |
|
** Apply a changeset or patchset to a database. These functions attempt to |
|
** update the "main" database attached to handle db with the changes found in |
|
** the changeset passed via the second and third arguments. |
|
** |
|
** The fourth argument (xFilter) passed to these functions is the "filter |
|
** callback". If it is not NULL, then for each table affected by at least one |
|
** change in the changeset, the filter callback is invoked with |
|
** the table name as the second argument, and a copy of the context pointer |
|
** passed as the sixth argument as the first. If the "filter callback" |
|
** returns zero, then no attempt is made to apply any changes to the table. |
|
** Otherwise, if the return value is non-zero or the xFilter argument to |
|
** is NULL, all changes related to the table are attempted. |
|
** |
|
** For each table that is not excluded by the filter callback, this function |
|
** tests that the target database contains a compatible table. A table is |
|
** considered compatible if all of the following are true: |
|
** |
|
** <ul> |
|
** <li> The table has the same name as the name recorded in the |
|
** changeset, and |
|
** <li> The table has at least as many columns as recorded in the |
|
** changeset, and |
|
** <li> The table has primary key columns in the same position as |
|
** recorded in the changeset. |
|
** </ul> |
|
** |
|
** If there is no compatible table, it is not an error, but none of the |
|
** changes associated with the table are applied. A warning message is issued |
|
** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most |
|
** one such warning is issued for each table in the changeset. |
|
** |
|
** For each change for which there is a compatible table, an attempt is made |
|
** to modify the table contents according to the UPDATE, INSERT or DELETE |
|
** change. If a change cannot be applied cleanly, the conflict handler |
|
** function passed as the fifth argument to sqlite3changeset_apply() may be |
|
** invoked. A description of exactly when the conflict handler is invoked for |
|
** each type of change is below. |
|
** |
|
** Unlike the xFilter argument, xConflict may not be passed NULL. The results |
|
** of passing anything other than a valid function pointer as the xConflict |
|
** argument are undefined. |
|
** |
|
** Each time the conflict handler function is invoked, it must return one |
|
** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or |
|
** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned |
|
** if the second argument passed to the conflict handler is either |
|
** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler |
|
** returns an illegal value, any changes already made are rolled back and |
|
** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different |
|
** actions are taken by sqlite3changeset_apply() depending on the value |
|
** returned by each invocation of the conflict-handler function. Refer to |
|
** the documentation for the three |
|
** [SQLITE_CHANGESET_OMIT|available return values] for details. |
|
** |
|
** <dl> |
|
** <dt>DELETE Changes<dd> |
|
** For each DELETE change, the function checks if the target database |
|
** contains a row with the same primary key value (or values) as the |
|
** original row values stored in the changeset. If it does, and the values |
|
** stored in all non-primary key columns also match the values stored in |
|
** the changeset the row is deleted from the target database. |
|
** |
|
** If a row with matching primary key values is found, but one or more of |
|
** the non-primary key fields contains a value different from the original |
|
** row value stored in the changeset, the conflict-handler function is |
|
** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the |
|
** database table has more columns than are recorded in the changeset, |
|
** only the values of those non-primary key fields are compared against |
|
** the current database contents - any trailing database table columns |
|
** are ignored. |
|
** |
|
** If no row with matching primary key values is found in the database, |
|
** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] |
|
** passed as the second argument. |
|
** |
|
** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT |
|
** (which can only happen if a foreign key constraint is violated), the |
|
** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT] |
|
** passed as the second argument. This includes the case where the DELETE |
|
** operation is attempted because an earlier call to the conflict handler |
|
** function returned [SQLITE_CHANGESET_REPLACE]. |
|
** |
|
** <dt>INSERT Changes<dd> |
|
** For each INSERT change, an attempt is made to insert the new row into |
|
** the database. If the changeset row contains fewer fields than the |
|
** database table, the trailing fields are populated with their default |
|
** values. |
|
** |
|
** If the attempt to insert the row fails because the database already |
|
** contains a row with the same primary key values, the conflict handler |
|
** function is invoked with the second argument set to |
|
** [SQLITE_CHANGESET_CONFLICT]. |
|
** |
|
** If the attempt to insert the row fails because of some other constraint |
|
** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is |
|
** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT]. |
|
** This includes the case where the INSERT operation is re-attempted because |
|
** an earlier call to the conflict handler function returned |
|
** [SQLITE_CHANGESET_REPLACE]. |
|
** |
|
** <dt>UPDATE Changes<dd> |
|
** For each UPDATE change, the function checks if the target database |
|
** contains a row with the same primary key value (or values) as the |
|
** original row values stored in the changeset. If it does, and the values |
|
** stored in all modified non-primary key columns also match the values |
|
** stored in the changeset the row is updated within the target database. |
|
** |
|
** If a row with matching primary key values is found, but one or more of |
|
** the modified non-primary key fields contains a value different from an |
|
** original row value stored in the changeset, the conflict-handler function |
|
** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since |
|
** UPDATE changes only contain values for non-primary key fields that are |
|
** to be modified, only those fields need to match the original values to |
|
** avoid the SQLITE_CHANGESET_DATA conflict-handler callback. |
|
** |
|
** If no row with matching primary key values is found in the database, |
|
** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] |
|
** passed as the second argument. |
|
** |
|
** If the UPDATE operation is attempted, but SQLite returns |
|
** SQLITE_CONSTRAINT, the conflict-handler function is invoked with |
|
** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument. |
|
** This includes the case where the UPDATE operation is attempted after |
|
** an earlier call to the conflict handler function returned |
|
** [SQLITE_CHANGESET_REPLACE]. |
|
** </dl> |
|
** |
|
** It is safe to execute SQL statements, including those that write to the |
|
** table that the callback related to, from within the xConflict callback. |
|
** This can be used to further customize the application's conflict |
|
** resolution strategy. |
|
** |
|
** All changes made by these functions are enclosed in a savepoint transaction. |
|
** If any other error (aside from a constraint failure when attempting to |
|
** write to the target database) occurs, then the savepoint transaction is |
|
** rolled back, restoring the target database to its original state, and an |
|
** SQLite error code returned. |
|
** |
|
** If the output parameters (ppRebase) and (pnRebase) are non-NULL and |
|
** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2() |
|
** may set (*ppRebase) to point to a "rebase" that may be used with the |
|
** sqlite3_rebaser APIs buffer before returning. In this case (*pnRebase) |
|
** is set to the size of the buffer in bytes. It is the responsibility of the |
|
** caller to eventually free any such buffer using sqlite3_free(). The buffer |
|
** is only allocated and populated if one or more conflicts were encountered |
|
** while applying the patchset. See comments surrounding the sqlite3_rebaser |
|
** APIs for further details. |
|
** |
|
** The behavior of sqlite3changeset_apply_v2() and its streaming equivalent |
|
** may be modified by passing a combination of |
|
** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT | supported flags] as the 9th parameter. |
|
** |
|
** Note that the sqlite3changeset_apply_v2() API is still <b>experimental</b> |
|
** and therefore subject to change. |
|
*/ |
|
SQLITE_API int sqlite3changeset_apply( |
|
sqlite3 *db, /* Apply change to "main" db of this handle */ |
|
int nChangeset, /* Size of changeset in bytes */ |
|
void *pChangeset, /* Changeset blob */ |
|
int(*xFilter)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
const char *zTab /* Table name */ |
|
), |
|
int(*xConflict)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ |
|
sqlite3_changeset_iter *p /* Handle describing change and conflict */ |
|
), |
|
void *pCtx /* First argument passed to xConflict */ |
|
); |
|
SQLITE_API int sqlite3changeset_apply_v2( |
|
sqlite3 *db, /* Apply change to "main" db of this handle */ |
|
int nChangeset, /* Size of changeset in bytes */ |
|
void *pChangeset, /* Changeset blob */ |
|
int(*xFilter)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
const char *zTab /* Table name */ |
|
), |
|
int(*xConflict)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ |
|
sqlite3_changeset_iter *p /* Handle describing change and conflict */ |
|
), |
|
void *pCtx, /* First argument passed to xConflict */ |
|
void **ppRebase, int *pnRebase, /* OUT: Rebase data */ |
|
int flags /* SESSION_CHANGESETAPPLY_* flags */ |
|
); |
|
|
|
/* |
|
** CAPI3REF: Flags for sqlite3changeset_apply_v2 |
|
** |
|
** The following flags may passed via the 9th parameter to |
|
** [sqlite3changeset_apply_v2] and [sqlite3changeset_apply_v2_strm]: |
|
** |
|
** <dl> |
|
** <dt>SQLITE_CHANGESETAPPLY_NOSAVEPOINT <dd> |
|
** Usually, the sessions module encloses all operations performed by |
|
** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The |
|
** SAVEPOINT is committed if the changeset or patchset is successfully |
|
** applied, or rolled back if an error occurs. Specifying this flag |
|
** causes the sessions module to omit this savepoint. In this case, if the |
|
** caller has an open transaction or savepoint when apply_v2() is called, |
|
** it may revert the partially applied changeset by rolling it back. |
|
** |
|
** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd> |
|
** Invert the changeset before applying it. This is equivalent to inverting |
|
** a changeset using sqlite3changeset_invert() before applying it. It is |
|
** an error to specify this flag with a patchset. |
|
*/ |
|
#define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001 |
|
#define SQLITE_CHANGESETAPPLY_INVERT 0x0002 |
|
|
|
/* |
|
** CAPI3REF: Constants Passed To The Conflict Handler |
|
** |
|
** Values that may be passed as the second argument to a conflict-handler. |
|
** |
|
** <dl> |
|
** <dt>SQLITE_CHANGESET_DATA<dd> |
|
** The conflict handler is invoked with CHANGESET_DATA as the second argument |
|
** when processing a DELETE or UPDATE change if a row with the required |
|
** PRIMARY KEY fields is present in the database, but one or more other |
|
** (non primary-key) fields modified by the update do not contain the |
|
** expected "before" values. |
|
** |
|
** The conflicting row, in this case, is the database row with the matching |
|
** primary key. |
|
** |
|
** <dt>SQLITE_CHANGESET_NOTFOUND<dd> |
|
** The conflict handler is invoked with CHANGESET_NOTFOUND as the second |
|
** argument when processing a DELETE or UPDATE change if a row with the |
|
** required PRIMARY KEY fields is not present in the database. |
|
** |
|
** There is no conflicting row in this case. The results of invoking the |
|
** sqlite3changeset_conflict() API are undefined. |
|
** |
|
** <dt>SQLITE_CHANGESET_CONFLICT<dd> |
|
** CHANGESET_CONFLICT is passed as the second argument to the conflict |
|
** handler while processing an INSERT change if the operation would result |
|
** in duplicate primary key values. |
|
** |
|
** The conflicting row in this case is the database row with the matching |
|
** primary key. |
|
** |
|
** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd> |
|
** If foreign key handling is enabled, and applying a changeset leaves the |
|
** database in a state containing foreign key violations, the conflict |
|
** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument |
|
** exactly once before the changeset is committed. If the conflict handler |
|
** returns CHANGESET_OMIT, the changes, including those that caused the |
|
** foreign key constraint violation, are committed. Or, if it returns |
|
** CHANGESET_ABORT, the changeset is rolled back. |
|
** |
|
** No current or conflicting row information is provided. The only function |
|
** it is possible to call on the supplied sqlite3_changeset_iter handle |
|
** is sqlite3changeset_fk_conflicts(). |
|
** |
|
** <dt>SQLITE_CHANGESET_CONSTRAINT<dd> |
|
** If any other constraint violation occurs while applying a change (i.e. |
|
** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is |
|
** invoked with CHANGESET_CONSTRAINT as the second argument. |
|
** |
|
** There is no conflicting row in this case. The results of invoking the |
|
** sqlite3changeset_conflict() API are undefined. |
|
** |
|
** </dl> |
|
*/ |
|
#define SQLITE_CHANGESET_DATA 1 |
|
#define SQLITE_CHANGESET_NOTFOUND 2 |
|
#define SQLITE_CHANGESET_CONFLICT 3 |
|
#define SQLITE_CHANGESET_CONSTRAINT 4 |
|
#define SQLITE_CHANGESET_FOREIGN_KEY 5 |
|
|
|
/* |
|
** CAPI3REF: Constants Returned By The Conflict Handler |
|
** |
|
** A conflict handler callback must return one of the following three values. |
|
** |
|
** <dl> |
|
** <dt>SQLITE_CHANGESET_OMIT<dd> |
|
** If a conflict handler returns this value no special action is taken. The |
|
** change that caused the conflict is not applied. The session module |
|
** continues to the next change in the changeset. |
|
** |
|
** <dt>SQLITE_CHANGESET_REPLACE<dd> |
|
** This value may only be returned if the second argument to the conflict |
|
** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this |
|
** is not the case, any changes applied so far are rolled back and the |
|
** call to sqlite3changeset_apply() returns SQLITE_MISUSE. |
|
** |
|
** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict |
|
** handler, then the conflicting row is either updated or deleted, depending |
|
** on the type of change. |
|
** |
|
** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict |
|
** handler, then the conflicting row is removed from the database and a |
|
** second attempt to apply the change is made. If this second attempt fails, |
|
** the original row is restored to the database before continuing. |
|
** |
|
** <dt>SQLITE_CHANGESET_ABORT<dd> |
|
** If this value is returned, any changes applied so far are rolled back |
|
** and the call to sqlite3changeset_apply() returns SQLITE_ABORT. |
|
** </dl> |
|
*/ |
|
#define SQLITE_CHANGESET_OMIT 0 |
|
#define SQLITE_CHANGESET_REPLACE 1 |
|
#define SQLITE_CHANGESET_ABORT 2 |
|
|
|
/* |
|
** CAPI3REF: Rebasing changesets |
|
** EXPERIMENTAL |
|
** |
|
** Suppose there is a site hosting a database in state S0. And that |
|
** modifications are made that move that database to state S1 and a |
|
** changeset recorded (the "local" changeset). Then, a changeset based |
|
** on S0 is received from another site (the "remote" changeset) and |
|
** applied to the database. The database is then in state |
|
** (S1+"remote"), where the exact state depends on any conflict |
|
** resolution decisions (OMIT or REPLACE) made while applying "remote". |
|
** Rebasing a changeset is to update it to take those conflict |
|
** resolution decisions into account, so that the same conflicts |
|
** do not have to be resolved elsewhere in the network. |
|
** |
|
** For example, if both the local and remote changesets contain an |
|
** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)": |
|
** |
|
** local: INSERT INTO t1 VALUES(1, 'v1'); |
|
** remote: INSERT INTO t1 VALUES(1, 'v2'); |
|
** |
|
** and the conflict resolution is REPLACE, then the INSERT change is |
|
** removed from the local changeset (it was overridden). Or, if the |
|
** conflict resolution was "OMIT", then the local changeset is modified |
|
** to instead contain: |
|
** |
|
** UPDATE t1 SET b = 'v2' WHERE a=1; |
|
** |
|
** Changes within the local changeset are rebased as follows: |
|
** |
|
** <dl> |
|
** <dt>Local INSERT<dd> |
|
** This may only conflict with a remote INSERT. If the conflict |
|
** resolution was OMIT, then add an UPDATE change to the rebased |
|
** changeset. Or, if the conflict resolution was REPLACE, add |
|
** nothing to the rebased changeset. |
|
** |
|
** <dt>Local DELETE<dd> |
|
** This may conflict with a remote UPDATE or DELETE. In both cases the |
|
** only possible resolution is OMIT. If the remote operation was a |
|
** DELETE, then add no change to the rebased changeset. If the remote |
|
** operation was an UPDATE, then the old.* fields of change are updated |
|
** to reflect the new.* values in the UPDATE. |
|
** |
|
** <dt>Local UPDATE<dd> |
|
** This may conflict with a remote UPDATE or DELETE. If it conflicts |
|
** with a DELETE, and the conflict resolution was OMIT, then the update |
|
** is changed into an INSERT. Any undefined values in the new.* record |
|
** from the update change are filled in using the old.* values from |
|
** the conflicting DELETE. Or, if the conflict resolution was REPLACE, |
|
** the UPDATE change is simply omitted from the rebased changeset. |
|
** |
|
** If conflict is with a remote UPDATE and the resolution is OMIT, then |
|
** the old.* values are rebased using the new.* values in the remote |
|
** change. Or, if the resolution is REPLACE, then the change is copied |
|
** into the rebased changeset with updates to columns also updated by |
|
** the conflicting remote UPDATE removed. If this means no columns would |
|
** be updated, the change is omitted. |
|
** </dl> |
|
** |
|
** A local change may be rebased against multiple remote changes |
|
** simultaneously. If a single key is modified by multiple remote |
|
** changesets, they are combined as follows before the local changeset |
|
** is rebased: |
|
** |
|
** <ul> |
|
** <li> If there has been one or more REPLACE resolutions on a |
|
** key, it is rebased according to a REPLACE. |
|
** |
|
** <li> If there have been no REPLACE resolutions on a key, then |
|
** the local changeset is rebased according to the most recent |
|
** of the OMIT resolutions. |
|
** </ul> |
|
** |
|
** Note that conflict resolutions from multiple remote changesets are |
|
** combined on a per-field basis, not per-row. This means that in the |
|
** case of multiple remote UPDATE operations, some fields of a single |
|
** local change may be rebased for REPLACE while others are rebased for |
|
** OMIT. |
|
** |
|
** In order to rebase a local changeset, the remote changeset must first |
|
** be applied to the local database using sqlite3changeset_apply_v2() and |
|
** the buffer of rebase information captured. Then: |
|
** |
|
** <ol> |
|
** <li> An sqlite3_rebaser object is created by calling |
|
** sqlite3rebaser_create(). |
|
** <li> The new object is configured with the rebase buffer obtained from |
|
** sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure(). |
|
** If the local changeset is to be rebased against multiple remote |
|
** changesets, then sqlite3rebaser_configure() should be called |
|
** multiple times, in the same order that the multiple |
|
** sqlite3changeset_apply_v2() calls were made. |
|
** <li> Each local changeset is rebased by calling sqlite3rebaser_rebase(). |
|
** <li> The sqlite3_rebaser object is deleted by calling |
|
** sqlite3rebaser_delete(). |
|
** </ol> |
|
*/ |
|
typedef struct sqlite3_rebaser sqlite3_rebaser; |
|
|
|
/* |
|
** CAPI3REF: Create a changeset rebaser object. |
|
** EXPERIMENTAL |
|
** |
|
** Allocate a new changeset rebaser object. If successful, set (*ppNew) to |
|
** point to the new object and return SQLITE_OK. Otherwise, if an error |
|
** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew) |
|
** to NULL. |
|
*/ |
|
SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew); |
|
|
|
/* |
|
** CAPI3REF: Configure a changeset rebaser object. |
|
** EXPERIMENTAL |
|
** |
|
** Configure the changeset rebaser object to rebase changesets according |
|
** to the conflict resolutions described by buffer pRebase (size nRebase |
|
** bytes), which must have been obtained from a previous call to |
|
** sqlite3changeset_apply_v2(). |
|
*/ |
|
SQLITE_API int sqlite3rebaser_configure( |
|
sqlite3_rebaser*, |
|
int nRebase, const void *pRebase |
|
); |
|
|
|
/* |
|
** CAPI3REF: Rebase a changeset |
|
** EXPERIMENTAL |
|
** |
|
** Argument pIn must point to a buffer containing a changeset nIn bytes |
|
** in size. This function allocates and populates a buffer with a copy |
|
** of the changeset rebased according to the configuration of the |
|
** rebaser object passed as the first argument. If successful, (*ppOut) |
|
** is set to point to the new buffer containing the rebased changeset and |
|
** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the |
|
** responsibility of the caller to eventually free the new buffer using |
|
** sqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut) |
|
** are set to zero and an SQLite error code returned. |
|
*/ |
|
SQLITE_API int sqlite3rebaser_rebase( |
|
sqlite3_rebaser*, |
|
int nIn, const void *pIn, |
|
int *pnOut, void **ppOut |
|
); |
|
|
|
/* |
|
** CAPI3REF: Delete a changeset rebaser object. |
|
** EXPERIMENTAL |
|
** |
|
** Delete the changeset rebaser object and all associated resources. There |
|
** should be one call to this function for each successful invocation |
|
** of sqlite3rebaser_create(). |
|
*/ |
|
SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p); |
|
|
|
/* |
|
** CAPI3REF: Streaming Versions of API functions. |
|
** |
|
** The six streaming API xxx_strm() functions serve similar purposes to the |
|
** corresponding non-streaming API functions: |
|
** |
|
** <table border=1 style="margin-left:8ex;margin-right:8ex"> |
|
** <tr><th>Streaming function<th>Non-streaming equivalent</th> |
|
** <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply] |
|
** <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2] |
|
** <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat] |
|
** <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert] |
|
** <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start] |
|
** <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset] |
|
** <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset] |
|
** </table> |
|
** |
|
** Non-streaming functions that accept changesets (or patchsets) as input |
|
** require that the entire changeset be stored in a single buffer in memory. |
|
** Similarly, those that return a changeset or patchset do so by returning |
|
** a pointer to a single large buffer allocated using sqlite3_malloc(). |
|
** Normally this is convenient. However, if an application running in a |
|
** low-memory environment is required to handle very large changesets, the |
|
** large contiguous memory allocations required can become onerous. |
|
** |
|
** In order to avoid this problem, instead of a single large buffer, input |
|
** is passed to a streaming API functions by way of a callback function that |
|
** the sessions module invokes to incrementally request input data as it is |
|
** required. In all cases, a pair of API function parameters such as |
|
** |
|
** <pre> |
|
** int nChangeset, |
|
** void *pChangeset, |
|
** </pre> |
|
** |
|
** Is replaced by: |
|
** |
|
** <pre> |
|
** int (*xInput)(void *pIn, void *pData, int *pnData), |
|
** void *pIn, |
|
** </pre> |
|
** |
|
** Each time the xInput callback is invoked by the sessions module, the first |
|
** argument passed is a copy of the supplied pIn context pointer. The second |
|
** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no |
|
** error occurs the xInput method should copy up to (*pnData) bytes of data |
|
** into the buffer and set (*pnData) to the actual number of bytes copied |
|
** before returning SQLITE_OK. If the input is completely exhausted, (*pnData) |
|
** should be set to zero to indicate this. Or, if an error occurs, an SQLite |
|
** error code should be returned. In all cases, if an xInput callback returns |
|
** an error, all processing is abandoned and the streaming API function |
|
** returns a copy of the error code to the caller. |
|
** |
|
** In the case of sqlite3changeset_start_strm(), the xInput callback may be |
|
** invoked by the sessions module at any point during the lifetime of the |
|
** iterator. If such an xInput callback returns an error, the iterator enters |
|
** an error state, whereby all subsequent calls to iterator functions |
|
** immediately fail with the same error code as returned by xInput. |
|
** |
|
** Similarly, streaming API functions that return changesets (or patchsets) |
|
** return them in chunks by way of a callback function instead of via a |
|
** pointer to a single large buffer. In this case, a pair of parameters such |
|
** as: |
|
** |
|
** <pre> |
|
** int *pnChangeset, |
|
** void **ppChangeset, |
|
** </pre> |
|
** |
|
** Is replaced by: |
|
** |
|
** <pre> |
|
** int (*xOutput)(void *pOut, const void *pData, int nData), |
|
** void *pOut |
|
** </pre> |
|
** |
|
** The xOutput callback is invoked zero or more times to return data to |
|
** the application. The first parameter passed to each call is a copy of the |
|
** pOut pointer supplied by the application. The second parameter, pData, |
|
** points to a buffer nData bytes in size containing the chunk of output |
|
** data being returned. If the xOutput callback successfully processes the |
|
** supplied data, it should return SQLITE_OK to indicate success. Otherwise, |
|
** it should return some other SQLite error code. In this case processing |
|
** is immediately abandoned and the streaming API function returns a copy |
|
** of the xOutput error code to the application. |
|
** |
|
** The sessions module never invokes an xOutput callback with the third |
|
** parameter set to a value less than or equal to zero. Other than this, |
|
** no guarantees are made as to the size of the chunks of data returned. |
|
*/ |
|
SQLITE_API int sqlite3changeset_apply_strm( |
|
sqlite3 *db, /* Apply change to "main" db of this handle */ |
|
int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */ |
|
void *pIn, /* First arg for xInput */ |
|
int(*xFilter)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
const char *zTab /* Table name */ |
|
), |
|
int(*xConflict)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ |
|
sqlite3_changeset_iter *p /* Handle describing change and conflict */ |
|
), |
|
void *pCtx /* First argument passed to xConflict */ |
|
); |
|
SQLITE_API int sqlite3changeset_apply_v2_strm( |
|
sqlite3 *db, /* Apply change to "main" db of this handle */ |
|
int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */ |
|
void *pIn, /* First arg for xInput */ |
|
int(*xFilter)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
const char *zTab /* Table name */ |
|
), |
|
int(*xConflict)( |
|
void *pCtx, /* Copy of sixth arg to _apply() */ |
|
int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ |
|
sqlite3_changeset_iter *p /* Handle describing change and conflict */ |
|
), |
|
void *pCtx, /* First argument passed to xConflict */ |
|
void **ppRebase, int *pnRebase, |
|
int flags |
|
); |
|
SQLITE_API int sqlite3changeset_concat_strm( |
|
int (*xInputA)(void *pIn, void *pData, int *pnData), |
|
void *pInA, |
|
int (*xInputB)(void *pIn, void *pData, int *pnData), |
|
void *pInB, |
|
int (*xOutput)(void *pOut, const void *pData, int nData), |
|
void *pOut |
|
); |
|
SQLITE_API int sqlite3changeset_invert_strm( |
|
int (*xInput)(void *pIn, void *pData, int *pnData), |
|
void *pIn, |
|
int (*xOutput)(void *pOut, const void *pData, int nData), |
|
void *pOut |
|
); |
|
SQLITE_API int sqlite3changeset_start_strm( |
|
sqlite3_changeset_iter **pp, |
|
int (*xInput)(void *pIn, void *pData, int *pnData), |
|
void *pIn |
|
); |
|
SQLITE_API int sqlite3changeset_start_v2_strm( |
|
sqlite3_changeset_iter **pp, |
|
int (*xInput)(void *pIn, void *pData, int *pnData), |
|
void *pIn, |
|
int flags |
|
); |
|
SQLITE_API int sqlite3session_changeset_strm( |
|
sqlite3_session *pSession, |
|
int (*xOutput)(void *pOut, const void *pData, int nData), |
|
void *pOut |
|
); |
|
SQLITE_API int sqlite3session_patchset_strm( |
|
sqlite3_session *pSession, |
|
int (*xOutput)(void *pOut, const void *pData, int nData), |
|
void *pOut |
|
); |
|
SQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*, |
|
int (*xInput)(void *pIn, void *pData, int *pnData), |
|
void *pIn |
|
); |
|
SQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*, |
|
int (*xOutput)(void *pOut, const void *pData, int nData), |
|
void *pOut |
|
); |
|
SQLITE_API int sqlite3rebaser_rebase_strm( |
|
sqlite3_rebaser *pRebaser, |
|
int (*xInput)(void *pIn, void *pData, int *pnData), |
|
void *pIn, |
|
int (*xOutput)(void *pOut, const void *pData, int nData), |
|
void *pOut |
|
); |
|
|
|
/* |
|
** CAPI3REF: Configure global parameters |
|
** |
|
** The sqlite3session_config() interface is used to make global configuration |
|
** changes to the sessions module in order to tune it to the specific needs |
|
** of the application. |
|
** |
|
** The sqlite3session_config() interface is not threadsafe. If it is invoked |
|
** while any other thread is inside any other sessions method then the |
|
** results are undefined. Furthermore, if it is invoked after any sessions |
|
** related objects have been created, the results are also undefined. |
|
** |
|
** The first argument to the sqlite3session_config() function must be one |
|
** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The |
|
** interpretation of the (void*) value passed as the second parameter and |
|
** the effect of calling this function depends on the value of the first |
|
** parameter. |
|
** |
|
** <dl> |
|
** <dt>SQLITE_SESSION_CONFIG_STRMSIZE<dd> |
|
** By default, the sessions module streaming interfaces attempt to input |
|
** and output data in approximately 1 KiB chunks. This operand may be used |
|
** to set and query the value of this configuration setting. The pointer |
|
** passed as the second argument must point to a value of type (int). |
|
** If this value is greater than 0, it is used as the new streaming data |
|
** chunk size for both input and output. Before returning, the (int) value |
|
** pointed to by pArg is set to the final value of the streaming interface |
|
** chunk size. |
|
** </dl> |
|
** |
|
** This function returns SQLITE_OK if successful, or an SQLite error code |
|
** otherwise. |
|
*/ |
|
SQLITE_API int sqlite3session_config(int op, void *pArg); |
|
|
|
/* |
|
** CAPI3REF: Values for sqlite3session_config(). |
|
*/ |
|
#define SQLITE_SESSION_CONFIG_STRMSIZE 1 |
|
|
|
/* |
|
** Make sure we can call this stuff from C++. |
|
*/ |
|
#ifdef __cplusplus |
|
} |
|
#endif |
|
|
|
#endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */ |
|
|
|
/******** End of sqlite3session.h *********/ |
|
/******** Begin file fts5.h *********/ |
|
/* |
|
** 2014 May 31 |
|
** |
|
** The author disclaims copyright to this source code. In place of |
|
** a legal notice, here is a blessing: |
|
** |
|
** May you do good and not evil. |
|
** May you find forgiveness for yourself and forgive others. |
|
** May you share freely, never taking more than you give. |
|
** |
|
****************************************************************************** |
|
** |
|
** Interfaces to extend FTS5. Using the interfaces defined in this file, |
|
** FTS5 may be extended with: |
|
** |
|
** * custom tokenizers, and |
|
** * custom auxiliary functions. |
|
*/ |
|
|
|
|
|
#ifndef _FTS5_H |
|
#define _FTS5_H |
|
|
|
|
|
#ifdef __cplusplus |
|
extern "C" { |
|
#endif |
|
|
|
/************************************************************************* |
|
** CUSTOM AUXILIARY FUNCTIONS |
|
** |
|
** Virtual table implementations may overload SQL functions by implementing |
|
** the sqlite3_module.xFindFunction() method. |
|
*/ |
|
|
|
typedef struct Fts5ExtensionApi Fts5ExtensionApi; |
|
typedef struct Fts5Context Fts5Context; |
|
typedef struct Fts5PhraseIter Fts5PhraseIter; |
|
|
|
typedef void (*fts5_extension_function)( |
|
const Fts5ExtensionApi *pApi, /* API offered by current FTS version */ |
|
Fts5Context *pFts, /* First arg to pass to pApi functions */ |
|
sqlite3_context *pCtx, /* Context for returning result/error */ |
|
int nVal, /* Number of values in apVal[] array */ |
|
sqlite3_value **apVal /* Array of trailing arguments */ |
|
); |
|
|
|
struct Fts5PhraseIter { |
|
const unsigned char *a; |
|
const unsigned char *b; |
|
}; |
|
|
|
/* |
|
** EXTENSION API FUNCTIONS |
|
** |
|
** xUserData(pFts): |
|
** Return a copy of the context pointer the extension function was |
|
** registered with. |
|
** |
|
** xColumnTotalSize(pFts, iCol, pnToken): |
|
** If parameter iCol is less than zero, set output variable *pnToken |
|
** to the total number of tokens in the FTS5 table. Or, if iCol is |
|
** non-negative but less than the number of columns in the table, return |
|
** the total number of tokens in column iCol, considering all rows in |
|
** the FTS5 table. |
|
** |
|
** If parameter iCol is greater than or equal to the number of columns |
|
** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g. |
|
** an OOM condition or IO error), an appropriate SQLite error code is |
|
** returned. |
|
** |
|
** xColumnCount(pFts): |
|
** Return the number of columns in the table. |
|
** |
|
** xColumnSize(pFts, iCol, pnToken): |
|
** If parameter iCol is less than zero, set output variable *pnToken |
|
** to the total number of tokens in the current row. Or, if iCol is |
|
** non-negative but less than the number of columns in the table, set |
|
** *pnToken to the number of tokens in column iCol of the current row. |
|
** |
|
** If parameter iCol is greater than or equal to the number of columns |
|
** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g. |
|
** an OOM condition or IO error), an appropriate SQLite error code is |
|
** returned. |
|
** |
|
** This function may be quite inefficient if used with an FTS5 table |
|
** created with the "columnsize=0" option. |
|
** |
|
** xColumnText: |
|
** This function attempts to retrieve the text of column iCol of the |
|
** current document. If successful, (*pz) is set to point to a buffer |
|
** containing the text in utf-8 encoding, (*pn) is set to the size in bytes |
|
** (not characters) of the buffer and SQLITE_OK is returned. Otherwise, |
|
** if an error occurs, an SQLite error code is returned and the final values |
|
** of (*pz) and (*pn) are undefined. |
|
** |
|
** xPhraseCount: |
|
** Returns the number of phrases in the current query expression. |
|
** |
|
** xPhraseSize: |
|
** Returns the number of tokens in phrase iPhrase of the query. Phrases |
|
** are numbered starting from zero. |
|
** |
|
** xInstCount: |
|
** Set *pnInst to the total number of occurrences of all phrases within |
|
** the query within the current row. Return SQLITE_OK if successful, or |
|
** an error code (i.e. SQLITE_NOMEM) if an error occurs. |
|
** |
|
** This API can be quite slow if used with an FTS5 table created with the |
|
** "detail=none" or "detail=column" option. If the FTS5 table is created |
|
** with either "detail=none" or "detail=column" and "content=" option |
|
** (i.e. if it is a contentless table), then this API always returns 0. |
|
** |
|
** xInst: |
|
** Query for the details of phrase match iIdx within the current row. |
|
** Phrase matches are numbered starting from zero, so the iIdx argument |
|
** should be greater than or equal to zero and smaller than the value |
|
** output by xInstCount(). |
|
** |
|
** Usually, output parameter *piPhrase is set to the phrase number, *piCol |
|
** to the column in which it occurs and *piOff the token offset of the |
|
** first token of the phrase. Returns SQLITE_OK if successful, or an error |
|
** code (i.e. SQLITE_NOMEM) if an error occurs. |
|
** |
|
** This API can be quite slow if used with an FTS5 table created with the |
|
** "detail=none" or "detail=column" option. |
|
** |
|
** xRowid: |
|
** Returns the rowid of the current row. |
|
** |
|
** xTokenize: |
|
** Tokenize text using the tokenizer belonging to the FTS5 table. |
|
** |
|
** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback): |
|
** This API function is used to query the FTS table for phrase iPhrase |
|
** of the current query. Specifically, a query equivalent to: |
|
** |
|
** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid |
|
** |
|
** with $p set to a phrase equivalent to the phrase iPhrase of the |
|
** current query is executed. Any column filter that applies to |
|
** phrase iPhrase of the current query is included in $p. For each |
|
** row visited, the callback function passed as the fourth argument |
|
** is invoked. The context and API objects passed to the callback |
|
** function may be used to access the properties of each matched row. |
|
** Invoking Api.xUserData() returns a copy of the pointer passed as |
|
** the third argument to pUserData. |
|
** |
|
** If the callback function returns any value other than SQLITE_OK, the |
|
** query is abandoned and the xQueryPhrase function returns immediately. |
|
** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK. |
|
** Otherwise, the error code is propagated upwards. |
|
** |
|
** If the query runs to completion without incident, SQLITE_OK is returned. |
|
** Or, if some error occurs before the query completes or is aborted by |
|
** the callback, an SQLite error code is returned. |
|
** |
|
** |
|
** xSetAuxdata(pFts5, pAux, xDelete) |
|
** |
|
** Save the pointer passed as the second argument as the extension function's |
|
** "auxiliary data". The pointer may then be retrieved by the current or any |
|
** future invocation of the same fts5 extension function made as part of |
|
** the same MATCH query using the xGetAuxdata() API. |
|
** |
|
** Each extension function is allocated a single auxiliary data slot for |
|
** each FTS query (MATCH expression). If the extension function is invoked |
|
** more than once for a single FTS query, then all invocations share a |
|
** single auxiliary data context. |
|
** |
|
** If there is already an auxiliary data pointer when this function is |
|
** invoked, then it is replaced by the new pointer. If an xDelete callback |
|
** was specified along with the original pointer, it is invoked at this |
|
** point. |
|
** |
|
** The xDelete callback, if one is specified, is also invoked on the |
|
** auxiliary data pointer after the FTS5 query has finished. |
|
** |
|
** If an error (e.g. an OOM condition) occurs within this function, |
|
** the auxiliary data is set to NULL and an error code returned. If the |
|
** xDelete parameter was not NULL, it is invoked on the auxiliary data |
|
** pointer before returning. |
|
** |
|
** |
|
** xGetAuxdata(pFts5, bClear) |
|
** |
|
** Returns the current auxiliary data pointer for the fts5 extension |
|
** function. See the xSetAuxdata() method for details. |
|
** |
|
** If the bClear argument is non-zero, then the auxiliary data is cleared |
|
** (set to NULL) before this function returns. In this case the xDelete, |
|
** if any, is not invoked. |
|
** |
|
** |
|
** xRowCount(pFts5, pnRow) |
|
** |
|
** This function is used to retrieve the total number of rows in the table. |
|
** In other words, the same value that would be returned by: |
|
** |
|
** SELECT count(*) FROM ftstable; |
|
** |
|
** xPhraseFirst() |
|
** This function is used, along with type Fts5PhraseIter and the xPhraseNext |
|
** method, to iterate through all instances of a single query phrase within |
|
** the current row. This is the same information as is accessible via the |
|
** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient |
|
** to use, this API may be faster under some circumstances. To iterate |
|
** through instances of phrase iPhrase, use the following code: |
|
** |
|
** Fts5PhraseIter iter; |
|
** int iCol, iOff; |
|
** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff); |
|
** iCol>=0; |
|
** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff) |
|
** ){ |
|
** // An instance of phrase iPhrase at offset iOff of column iCol |
|
** } |
|
** |
|
** The Fts5PhraseIter structure is defined above. Applications should not |
|
** modify this structure directly - it should only be used as shown above |
|
** with the xPhraseFirst() and xPhraseNext() API methods (and by |
|
** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below). |
|
** |
|
** This API can be quite slow if used with an FTS5 table created with the |
|
** "detail=none" or "detail=column" option. If the FTS5 table is created |
|
** with either "detail=none" or "detail=column" and "content=" option |
|
** (i.e. if it is a contentless table), then this API always iterates |
|
** through an empty set (all calls to xPhraseFirst() set iCol to -1). |
|
** |
|
** xPhraseNext() |
|
** See xPhraseFirst above. |
|
** |
|
** xPhraseFirstColumn() |
|
** This function and xPhraseNextColumn() are similar to the xPhraseFirst() |
|
** and xPhraseNext() APIs described above. The difference is that instead |
|
** of iterating through all instances of a phrase in the current row, these |
|
** APIs are used to iterate through the set of columns in the current row |
|
** that contain one or more instances of a specified phrase. For example: |
|
** |
|
** Fts5PhraseIter iter; |
|
** int iCol; |
|
** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol); |
|
** iCol>=0; |
|
** pApi->xPhraseNextColumn(pFts, &iter, &iCol) |
|
** ){ |
|
** // Column iCol contains at least one instance of phrase iPhrase |
|
** } |
|
** |
|
** This API can be quite slow if used with an FTS5 table created with the |
|
** "detail=none" option. If the FTS5 table is created with either |
|
** "detail=none" "content=" option (i.e. if it is a contentless table), |
|
** then this API always iterates through an empty set (all calls to |
|
** xPhraseFirstColumn() set iCol to -1). |
|
** |
|
** The information accessed using this API and its companion |
|
** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext |
|
** (or xInst/xInstCount). The chief advantage of this API is that it is |
|
** significantly more efficient than those alternatives when used with |
|
** "detail=column" tables. |
|
** |
|
** xPhraseNextColumn() |
|
** See xPhraseFirstColumn above. |
|
*/ |
|
struct Fts5ExtensionApi { |
|
int iVersion; /* Currently always set to 3 */ |
|
|
|
void *(*xUserData)(Fts5Context*); |
|
|
|
int (*xColumnCount)(Fts5Context*); |
|
int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow); |
|
int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken); |
|
|
|
int (*xTokenize)(Fts5Context*, |
|
const char *pText, int nText, /* Text to tokenize */ |
|
void *pCtx, /* Context passed to xToken() */ |
|
int (*xToken)(void*, int, const char*, int, int, int) /* Callback */ |
|
); |
|
|
|
int (*xPhraseCount)(Fts5Context*); |
|
int (*xPhraseSize)(Fts5Context*, int iPhrase); |
|
|
|
int (*xInstCount)(Fts5Context*, int *pnInst); |
|
int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff); |
|
|
|
sqlite3_int64 (*xRowid)(Fts5Context*); |
|
int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn); |
|
int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken); |
|
|
|
int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData, |
|
int(*)(const Fts5ExtensionApi*,Fts5Context*,void*) |
|
); |
|
int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*)); |
|
void *(*xGetAuxdata)(Fts5Context*, int bClear); |
|
|
|
int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*); |
|
void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff); |
|
|
|
int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*); |
|
void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol); |
|
}; |
|
|
|
/* |
|
** CUSTOM AUXILIARY FUNCTIONS |
|
*************************************************************************/ |
|
|
|
/************************************************************************* |
|
** CUSTOM TOKENIZERS |
|
** |
|
** Applications may also register custom tokenizer types. A tokenizer |
|
** is registered by providing fts5 with a populated instance of the |
|
** following structure. All structure methods must be defined, setting |
|
** any member of the fts5_tokenizer struct to NULL leads to undefined |
|
** behaviour. The structure methods are expected to function as follows: |
|
** |
|
** xCreate: |
|
** This function is used to allocate and initialize a tokenizer instance. |
|
** A tokenizer instance is required to actually tokenize text. |
|
** |
|
** The first argument passed to this function is a copy of the (void*) |
|
** pointer provided by the application when the fts5_tokenizer object |
|
** was registered with FTS5 (the third argument to xCreateTokenizer()). |
|
** The second and third arguments are an array of nul-terminated strings |
|
** containing the tokenizer arguments, if any, specified following the |
|
** tokenizer name as part of the CREATE VIRTUAL TABLE statement used |
|
** to create the FTS5 table. |
|
** |
|
** The final argument is an output variable. If successful, (*ppOut) |
|
** should be set to point to the new tokenizer handle and SQLITE_OK |
|
** returned. If an error occurs, some value other than SQLITE_OK should |
|
** be returned. In this case, fts5 assumes that the final value of *ppOut |
|
** is undefined. |
|
** |
|
** xDelete: |
|
** This function is invoked to delete a tokenizer handle previously |
|
** allocated using xCreate(). Fts5 guarantees that this function will |
|
** be invoked exactly once for each successful call to xCreate(). |
|
** |
|
** xTokenize: |
|
** This function is expected to tokenize the nText byte string indicated |
|
** by argument pText. pText may or may not be nul-terminated. The first |
|
** argument passed to this function is a pointer to an Fts5Tokenizer object |
|
** returned by an earlier call to xCreate(). |
|
** |
|
** The second argument indicates the reason that FTS5 is requesting |
|
** tokenization of the supplied text. This is always one of the following |
|
** four values: |
|
** |
|
** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into |
|
** or removed from the FTS table. The tokenizer is being invoked to |
|
** determine the set of tokens to add to (or delete from) the |
|
** FTS index. |
|
** |
|
** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed |
|
** against the FTS index. The tokenizer is being called to tokenize |
|
** a bareword or quoted string specified as part of the query. |
|
** |
|
** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as |
|
** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is |
|
** followed by a "*" character, indicating that the last token |
|
** returned by the tokenizer will be treated as a token prefix. |
|
** |
|
** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to |
|
** satisfy an fts5_api.xTokenize() request made by an auxiliary |
|
** function. Or an fts5_api.xColumnSize() request made by the same |
|
** on a columnsize=0 database. |
|
** </ul> |
|
** |
|
** For each token in the input string, the supplied callback xToken() must |
|
** be invoked. The first argument to it should be a copy of the pointer |
|
** passed as the second argument to xTokenize(). The third and fourth |
|
** arguments are a pointer to a buffer containing the token text, and the |
|
** size of the token in bytes. The 4th and 5th arguments are the byte offsets |
|
** of the first byte of and first byte immediately following the text from |
|
** which the token is derived within the input. |
|
** |
|
** The second argument passed to the xToken() callback ("tflags") should |
|
** normally be set to 0. The exception is if the tokenizer supports |
|
** synonyms. In this case see the discussion below for details. |
|
** |
|
** FTS5 assumes the xToken() callback is invoked for each token in the |
|
** order that they occur within the input text. |
|
** |
|
** If an xToken() callback returns any value other than SQLITE_OK, then |
|
** the tokenization should be abandoned and the xTokenize() method should |
|
** immediately return a copy of the xToken() return value. Or, if the |
|
** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally, |
|
** if an error occurs with the xTokenize() implementation itself, it |
|
** may abandon the tokenization and return any error code other than |
|
** SQLITE_OK or SQLITE_DONE. |
|
** |
|
** SYNONYM SUPPORT |
|
** |
|
** Custom tokenizers may also support synonyms. Consider a case in which a |
|
** user wishes to query for a phrase such as "first place". Using the |
|
** built-in tokenizers, the FTS5 query 'first + place' will match instances |
|
** of "first place" within the document set, but not alternative forms |
|
** such as "1st place". In some applications, it would be better to match |
|
** all instances of "first place" or "1st place" regardless of which form |
|
** the user specified in the MATCH query text. |
|
** |
|
** There are several ways to approach this in FTS5: |
|
** |
|
** <ol><li> By mapping all synonyms to a single token. In this case, using |
|
** the above example, this means that the tokenizer returns the |
|
** same token for inputs "first" and "1st". Say that token is in |
|
** fact "first", so that when the user inserts the document "I won |
|
** 1st place" entries are added to the index for tokens "i", "won", |
|
** "first" and "place". If the user then queries for '1st + place', |
|
** the tokenizer substitutes "first" for "1st" and the query works |
|
** as expected. |
|
** |
|
** <li> By querying the index for all synonyms of each query term |
|
** separately. In this case, when tokenizing query text, the |
|
** tokenizer may provide multiple synonyms for a single term |
|
** within the document. FTS5 then queries the index for each |
|
** synonym individually. For example, faced with the query: |
|
** |
|
** <codeblock> |
|
** ... MATCH 'first place'</codeblock> |
|
** |
|
** the tokenizer offers both "1st" and "first" as synonyms for the |
|
** first token in the MATCH query and FTS5 effectively runs a query |
|
** similar to: |
|
** |
|
** <codeblock> |
|
** ... MATCH '(first OR 1st) place'</codeblock> |
|
** |
|
** except that, for the purposes of auxiliary functions, the query |
|
** still appears to contain just two phrases - "(first OR 1st)" |
|
** being treated as a single phrase. |
|
** |
|
** <li> By adding multiple synonyms for a single term to the FTS index. |
|
** Using this method, when tokenizing document text, the tokenizer |
|
** provides multiple synonyms for each token. So that when a |
|
** document such as "I won first place" is tokenized, entries are |
|
** added to the FTS index for "i", "won", "first", "1st" and |
|
** "place". |
|
** |
|
** This way, even if the tokenizer does not provide synonyms |
|
** when tokenizing query text (it should not - to do so would be |
|
** inefficient), it doesn't matter if the user queries for |
|
** 'first + place' or '1st + place', as there are entries in the |
|
** FTS index corresponding to both forms of the first token. |
|
** </ol> |
|
** |
|
** Whether it is parsing document or query text, any call to xToken that |
|
** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit |
|
** is considered to supply a synonym for the previous token. For example, |
|
** when parsing the document "I won first place", a tokenizer that supports |
|
** synonyms would call xToken() 5 times, as follows: |
|
** |
|
** <codeblock> |
|
** xToken(pCtx, 0, "i", 1, 0, 1); |
|
** xToken(pCtx, 0, "won", 3, 2, 5); |
|
** xToken(pCtx, 0, "first", 5, 6, 11); |
|
** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11); |
|
** xToken(pCtx, 0, "place", 5, 12, 17); |
|
**</codeblock> |
|
** |
|
** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time |
|
** xToken() is called. Multiple synonyms may be specified for a single token |
|
** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence. |
|
** There is no limit to the number of synonyms that may be provided for a |
|
** single token. |
|
** |
|
** In many cases, method (1) above is the best approach. It does not add |
|
** extra data to the FTS index or require FTS5 to query for multiple terms, |
|
** so it is efficient in terms of disk space and query speed. However, it |
|
** does not support prefix queries very well. If, as suggested above, the |
|
** token "first" is substituted for "1st" by the tokenizer, then the query: |
|
** |
|
** <codeblock> |
|
** ... MATCH '1s*'</codeblock> |
|
** |
|
** will not match documents that contain the token "1st" (as the tokenizer |
|
** will probably not map "1s" to any prefix of "first"). |
|
** |
|
** For full prefix support, method (3) may be preferred. In this case, |
|
** because the index contains entries for both "first" and "1st", prefix |
|
** queries such as 'fi*' or '1s*' will match correctly. However, because |
|
** extra entries are added to the FTS index, this method uses more space |
|
** within the database. |
|
** |
|
** Method (2) offers a midpoint between (1) and (3). Using this method, |
|
** a query such as '1s*' will match documents that contain the literal |
|
** token "1st", but not "first" (assuming the tokenizer is not able to |
|
** provide synonyms for prefixes). However, a non-prefix query like '1st' |
|
** will match against "1st" and "first". This method does not require |
|
** extra disk space, as no extra entries are added to the FTS index. |
|
** On the other hand, it may require more CPU cycles to run MATCH queries, |
|
** as separate queries of the FTS index are required for each synonym. |
|
** |
|
** When using methods (2) or (3), it is important that the tokenizer only |
|
** provide synonyms when tokenizing document text (method (2)) or query |
|
** text (method (3)), not both. Doing so will not cause any errors, but is |
|
** inefficient. |
|
*/ |
|
typedef struct Fts5Tokenizer Fts5Tokenizer; |
|
typedef struct fts5_tokenizer fts5_tokenizer; |
|
struct fts5_tokenizer { |
|
int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut); |
|
void (*xDelete)(Fts5Tokenizer*); |
|
int (*xTokenize)(Fts5Tokenizer*, |
|
void *pCtx, |
|
int flags, /* Mask of FTS5_TOKENIZE_* flags */ |
|
const char *pText, int nText, |
|
int (*xToken)( |
|
void *pCtx, /* Copy of 2nd argument to xTokenize() */ |
|
int tflags, /* Mask of FTS5_TOKEN_* flags */ |
|
const char *pToken, /* Pointer to buffer containing token */ |
|
int nToken, /* Size of token in bytes */ |
|
int iStart, /* Byte offset of token within input text */ |
|
int iEnd /* Byte offset of end of token within input text */ |
|
) |
|
); |
|
}; |
|
|
|
/* Flags that may be passed as the third argument to xTokenize() */ |
|
#define FTS5_TOKENIZE_QUERY 0x0001 |
|
#define FTS5_TOKENIZE_PREFIX 0x0002 |
|
#define FTS5_TOKENIZE_DOCUMENT 0x0004 |
|
#define FTS5_TOKENIZE_AUX 0x0008 |
|
|
|
/* Flags that may be passed by the tokenizer implementation back to FTS5 |
|
** as the third argument to the supplied xToken callback. */ |
|
#define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */ |
|
|
|
/* |
|
** END OF CUSTOM TOKENIZERS |
|
*************************************************************************/ |
|
|
|
/************************************************************************* |
|
** FTS5 EXTENSION REGISTRATION API |
|
*/ |
|
typedef struct fts5_api fts5_api; |
|
struct fts5_api { |
|
int iVersion; /* Currently always set to 2 */ |
|
|
|
/* Create a new tokenizer */ |
|
int (*xCreateTokenizer)( |
|
fts5_api *pApi, |
|
const char *zName, |
|
void *pContext, |
|
fts5_tokenizer *pTokenizer, |
|
void (*xDestroy)(void*) |
|
); |
|
|
|
/* Find an existing tokenizer */ |
|
int (*xFindTokenizer)( |
|
fts5_api *pApi, |
|
const char *zName, |
|
void **ppContext, |
|
fts5_tokenizer *pTokenizer |
|
); |
|
|
|
/* Create a new auxiliary function */ |
|
int (*xCreateFunction)( |
|
fts5_api *pApi, |
|
const char *zName, |
|
void *pContext, |
|
fts5_extension_function xFunction, |
|
void (*xDestroy)(void*) |
|
); |
|
}; |
|
|
|
/* |
|
** END OF REGISTRATION API |
|
*************************************************************************/ |
|
|
|
#ifdef __cplusplus |
|
} /* end of the 'extern "C"' block */ |
|
#endif |
|
|
|
#endif /* _FTS5_H */ |
|
|
|
/******** End of fts5.h *********/ |