[BACK]Return to sqlite3.h CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / elwix / files / sqlite / dist

Diff for /elwix/files/sqlite/dist/sqlite3.h between versions 1.4.2.2 and 1.4.2.3

version 1.4.2.2, 2019/09/26 13:02:52 version 1.4.2.3, 2020/08/17 12:20:36
Line 108  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] ([dateof:3.6.18]), ** Since [version 3.6.18] ([dateof:3.6.18]),
 ** SQLite source code has been stored in the  ** 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
Line 123  extern "C" { Line 123  extern "C" {
 ** [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.29.0"#define SQLITE_VERSION        "3.33.0"
#define SQLITE_VERSION_NUMBER 3029000#define SQLITE_VERSION_NUMBER 3033000
#define SQLITE_SOURCE_ID      "2019-07-10 17:32:03 fc82b73eaac8b36950e527f12c4b5dc1e147e6f4ad2217ae43ad82882a88bfa6"#define SQLITE_SOURCE_ID      "2020-08-14 13:23:32 fca8dc8b578f215a969cd899336378966156154710873e68b3d9ac5881b0ff3f"
   
 /*  /*
 ** CAPI3REF: Run-Time Library Version Numbers  ** CAPI3REF: Run-Time Library Version Numbers
Line 151  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.  Except if SQLite is built  ** [SQLITE_SOURCE_ID] C preprocessor macro.  Except if SQLite is built
 ** using an edited copy of [the amalgamation], then the last four characters  ** using an edited copy of [the amalgamation], then the last four characters
 ** of the hash might be different from [SQLITE_SOURCE_ID].)^  ** of the hash might be different from [SQLITE_SOURCE_ID].)^
Line 167  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 204  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 261  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;
 # ifdef SQLITE_UINT64_TYPE  # ifdef SQLITE_UINT64_TYPE
     typedef SQLITE_UINT64_TYPE sqlite_uint64;      typedef SQLITE_UINT64_TYPE sqlite_uint64;
# else  # else
     typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;      typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
 # endif  # endif
 #elif defined(_MSC_VER) || defined(__BORLANDC__)  #elif defined(_MSC_VER) || defined(__BORLANDC__)
Line 299  typedef sqlite_uint64 sqlite3_uint64; Line 299  typedef sqlite_uint64 sqlite3_uint64;
 ** the [sqlite3] object is successfully destroyed and all associated  ** the [sqlite3] object is successfully destroyed and all associated
 ** resources are deallocated.  ** resources are deallocated.
 **  **
   ** Ideally, applications should [sqlite3_finalize | finalize] all
   ** [prepared statements], [sqlite3_blob_close | close] all [BLOB handles], and
   ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
   ** with the [sqlite3] object prior to attempting to close the object.
 ** ^If the database connection is associated with unfinalized prepared  ** ^If the database connection is associated with unfinalized prepared
** statements or unfinished sqlite3_backup objects then sqlite3_close()** statements, BLOB handlers, and/or unfinished sqlite3_backup objects then
** will leave the database connection open and return [SQLITE_BUSY].** sqlite3_close() will leave the database connection open and return
** ^If sqlite3_close_v2() is called with unfinalized prepared statements** [SQLITE_BUSY]. ^If sqlite3_close_v2() is called with unfinalized prepared
** and/or unfinished sqlite3_backups, then the database connection becomes** statements, unclosed BLOB handlers, and/or unfinished sqlite3_backups,
** an unusable "zombie" which will automatically be deallocated when the** it returns [SQLITE_OK] regardless, but instead of deallocating the database
** last prepared statement is finalized or the last sqlite3_backup is** connection immediately, it marks the database connection as an unusable
** finished.  The sqlite3_close_v2() interface is intended for use with** "zombie" and makes arrangements to automatically deallocate the database
** host languages that are garbage collected, and where the order in which** connection after all prepared statements are finalized, all BLOB handles
** destructors are called is arbitrary.** 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.
 **  **
 ** Applications should [sqlite3_finalize | finalize] all [prepared statements],  
 ** [sqlite3_blob_close | close] all [BLOB handles], and   
 ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated  
 ** with the [sqlite3] object prior to attempting to close the object.  ^If  
 ** sqlite3_close_v2() is called on a [database connection] that still has  
 ** outstanding [prepared statements], [BLOB handles], and/or  
 ** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation  
 ** of resources is deferred until all [prepared statements], [BLOB handles],  
 ** and [sqlite3_backup] objects are also destroyed.  
 **  
 ** ^If an [sqlite3] object is destroyed 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.
 **  **
Line 348  typedef int (*sqlite3_callback)(void*,int,char**, char Line 344  typedef int (*sqlite3_callback)(void*,int,char**, char
 ** 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 388  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.
 **  **
Line 507  SQLITE_API int sqlite3_exec( Line 503  SQLITE_API int sqlite3_exec(
 #define SQLITE_IOERR_BEGIN_ATOMIC      (SQLITE_IOERR | (29<<8))  #define SQLITE_IOERR_BEGIN_ATOMIC      (SQLITE_IOERR | (29<<8))
 #define SQLITE_IOERR_COMMIT_ATOMIC     (SQLITE_IOERR | (30<<8))  #define SQLITE_IOERR_COMMIT_ATOMIC     (SQLITE_IOERR | (30<<8))
 #define SQLITE_IOERR_ROLLBACK_ATOMIC   (SQLITE_IOERR | (31<<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_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_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_ISDIR          (SQLITE_CANTOPEN | (2<<8))
 #define SQLITE_CANTOPEN_FULLPATH       (SQLITE_CANTOPEN | (3<<8))  #define SQLITE_CANTOPEN_FULLPATH       (SQLITE_CANTOPEN | (3<<8))
 #define SQLITE_CANTOPEN_CONVPATH       (SQLITE_CANTOPEN | (4<<8))  #define SQLITE_CANTOPEN_CONVPATH       (SQLITE_CANTOPEN | (4<<8))
 #define SQLITE_CANTOPEN_DIRTYWAL       (SQLITE_CANTOPEN | (5<<8)) /* Not Used */  #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_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_ROLLBACK       (SQLITE_READONLY | (3<<8))
Line 535  SQLITE_API int sqlite3_exec( Line 535  SQLITE_API int sqlite3_exec(
 #define SQLITE_CONSTRAINT_UNIQUE       (SQLITE_CONSTRAINT | (8<<8))  #define SQLITE_CONSTRAINT_UNIQUE       (SQLITE_CONSTRAINT | (8<<8))
 #define SQLITE_CONSTRAINT_VTAB         (SQLITE_CONSTRAINT | (9<<8))  #define SQLITE_CONSTRAINT_VTAB         (SQLITE_CONSTRAINT | (9<<8))
 #define SQLITE_CONSTRAINT_ROWID        (SQLITE_CONSTRAINT |(10<<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_WAL      (SQLITE_NOTICE | (1<<8))
 #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))  #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
 #define SQLITE_WARNING_AUTOINDEX       (SQLITE_WARNING | (1<<8))  #define SQLITE_WARNING_AUTOINDEX       (SQLITE_WARNING | (1<<8))
 #define SQLITE_AUTH_USER               (SQLITE_AUTH | (1<<8))  #define SQLITE_AUTH_USER               (SQLITE_AUTH | (1<<8))
 #define SQLITE_OK_LOAD_PERMANENTLY     (SQLITE_OK | (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 562  SQLITE_API int sqlite3_exec( Line 564  SQLITE_API int sqlite3_exec(
 #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
 **  **
Line 666  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 688  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 838  struct sqlite3_io_methods { Line 844  struct sqlite3_io_methods {
 ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]  ** <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
Line 861  struct sqlite3_io_methods { Line 867  struct sqlite3_io_methods {
 ** <li>[[SQLITE_FCNTL_SYNC]]  ** <li>[[SQLITE_FCNTL_SYNC]]
 ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and  ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
 ** sent to the VFS immediately before the xSync method is invoked on a  ** sent to the VFS immediately before the xSync method is invoked on a
** database file descriptor. Or, if the xSync method is not invoked ** database file descriptor. Or, if the xSync method is not invoked
** because the user has configured SQLite with ** because the user has configured SQLite with
** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place ** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
 ** of the xSync method. In most cases, the pointer argument passed with  ** 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  ** 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  ** as part of a multi-database commit, the argument points to a nul-terminated
** string containing the transactions master-journal file name. VFSes that ** string containing the transactions super-journal file name. VFSes that
** do not need this signal should silently ignore this opcode. Applications ** do not need this signal should silently ignore this opcode. Applications
** should not call [sqlite3_file_control()] with this opcode as doing so may ** should not call [sqlite3_file_control()] with this opcode as doing so may
** disrupt the operation of the specialized VFSes that do require it.  ** disrupt the operation of the specialized VFSes that do require it.
 **  **
 ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]  ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
 ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite  ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
 ** and sent to the VFS after a transaction has been committed immediately  ** 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  ** but before the database is unlocked. VFSes that do not need this signal
 ** should silently ignore this opcode. Applications should not call  ** should silently ignore this opcode. Applications should not call
** [sqlite3_file_control()] with this opcode as doing so may disrupt the ** [sqlite3_file_control()] with this opcode as doing so may disrupt the
** operation of the specialized VFSes that do require it.  ** operation of the specialized VFSes that do require it.
 **  **
 ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]  ** <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
Line 926  struct sqlite3_io_methods { Line 932  struct sqlite3_io_methods {
 ** <li>[[SQLITE_FCNTL_OVERWRITE]]  ** <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]]  ** <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 951  struct sqlite3_io_methods { Line 957  struct sqlite3_io_methods {
 ** upper-most shim only.  ** upper-most shim only.
 **  **
 ** <li>[[SQLITE_FCNTL_PRAGMA]]  ** <li>[[SQLITE_FCNTL_PRAGMA]]
** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
 ** file control is sent to the open [sqlite3_file] object corresponding  ** 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 database file to which the pragma statement refers. ^The argument
 ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of  ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
Line 962  struct sqlite3_io_methods { Line 968  struct sqlite3_io_methods {
 ** of the char** argument point to a string obtained from [sqlite3_mprintf()]  ** 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  ** or the equivalent and that string will become the result of the pragma or
 ** the error message if the pragma fails. ^If the  ** the error message if the pragma fails. ^If the
** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
 ** [PRAGMA] processing continues.  ^If the [SQLITE_FCNTL_PRAGMA]  ** [PRAGMA] processing continues.  ^If the [SQLITE_FCNTL_PRAGMA]
 ** file control returns [SQLITE_OK], then the parser assumes that the  ** file control returns [SQLITE_OK], then the parser assumes that the
 ** VFS has handled the PRAGMA itself and the parser generates a no-op  ** VFS has handled the PRAGMA itself and the parser generates a no-op
Line 979  struct sqlite3_io_methods { Line 985  struct sqlite3_io_methods {
 ** ^The [SQLITE_FCNTL_BUSYHANDLER]  ** ^The [SQLITE_FCNTL_BUSYHANDLER]
 ** file-control may be invoked by SQLite on the database file handle  ** 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  ** shortly after it is opened in order to provide a custom VFS with access
** to the connections busy-handler callback. The argument is of type (void **)** to the connection's busy-handler callback. The argument is of type (void**)
 ** - an array of two (void *) values. The first (void *) actually points  ** - an array of two (void *) values. The first (void *) actually points
** to a function of type (int (*)(void *)). In order to invoke the connections** 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  ** 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  ** 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  ** should be retried. If it returns zero, the custom VFS should abandon the
 ** current operation.  ** current operation.
 **  **
 ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]  ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
 ** to have SQLite generate a  ** to have SQLite generate a
 ** temporary filename using the same algorithm that is followed to generate  ** temporary filename using the same algorithm that is followed to generate
 ** temporary filenames for TEMP tables and other internal uses.  The  ** temporary filenames for TEMP tables and other internal uses.  The
Line 1002  struct sqlite3_io_methods { Line 1008  struct sqlite3_io_methods {
 ** The argument is a pointer to a value of type sqlite3_int64 that  ** 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  ** 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  ** 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 ** 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  ** can be queried by passing in a pointer to a negative number.  This
 ** file-control is used internally to implement [PRAGMA mmap_size].  ** file-control is used internally to implement [PRAGMA mmap_size].
 **  **
Line 1046  struct sqlite3_io_methods { Line 1052  struct sqlite3_io_methods {
 ** <li>[[SQLITE_FCNTL_RBU]]  ** <li>[[SQLITE_FCNTL_RBU]]
 ** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by  ** 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  ** the RBU extension only.  All other VFS should return SQLITE_NOTFOUND for
** this opcode.  ** this opcode.
 **  **
 ** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]]  ** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]]
 ** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then  ** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then
Line 1063  struct sqlite3_io_methods { Line 1069  struct sqlite3_io_methods {
 **  **
 ** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]]  ** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]]
 ** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write  ** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write
** operations since the previous successful call to ** operations since the previous successful call to
 ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically.  ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically.
 ** This file control returns [SQLITE_OK] if and only if the writes were  ** This file control returns [SQLITE_OK] if and only if the writes were
 ** all performed successfully and have been committed to persistent storage.  ** all performed successfully and have been committed to persistent storage.
Line 1075  struct sqlite3_io_methods { Line 1081  struct sqlite3_io_methods {
 **  **
 ** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]]  ** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]]
 ** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write  ** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write
** operations since the previous successful call to ** operations since the previous successful call to
 ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back.  ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back.
 ** ^This file control takes the file descriptor out of batch write mode  ** ^This file control takes the file descriptor out of batch write mode
 ** so that all subsequent write operations are independent.  ** so that all subsequent write operations are independent.
Line 1083  struct sqlite3_io_methods { Line 1089  struct sqlite3_io_methods {
 ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].  ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
 **  **
 ** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]]  ** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]]
** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode causes attempts to obtain** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode is used to configure a VFS
** a file lock using the xLock or xShmLock methods of the VFS to wait** to block for up to M milliseconds before failing when attempting to
** for up to M milliseconds before failing, where M is the single ** obtain a file lock using the xLock or xShmLock methods of the VFS.
** unsigned integer parameter.** 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]]  ** <li>[[SQLITE_FCNTL_DATA_VERSION]]
 ** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to  ** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to
Line 1101  struct sqlite3_io_methods { Line 1109  struct sqlite3_io_methods {
 ** not provide a mechanism to detect changes to MAIN only.  Also, the  ** not provide a mechanism to detect changes to MAIN only.  Also, the
 ** [sqlite3_total_changes()] interface responds to internal changes only and  ** [sqlite3_total_changes()] interface responds to internal changes only and
 ** omits changes made by other database connections.  The  ** omits changes made by other database connections.  The
** [PRAGMA data_version] command provide a mechanism to detect changes to** [PRAGMA data_version] command provides a mechanism to detect changes to
 ** a single attached database that occur due to other database connections,  ** a single attached database that occur due to other database connections,
 ** but omits changes implemented by the database connection on which it is  ** but omits changes implemented by the database connection on which it is
 ** called.  This file control is the only mechanism to detect changes that  ** called.  This file control is the only mechanism to detect changes that
 ** happen either internally or externally and that are associated with  ** happen either internally or externally and that are associated with
 ** a particular attached database.  ** 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>  ** </ul>
 */  */
 #define SQLITE_FCNTL_LOCKSTATE               1  #define SQLITE_FCNTL_LOCKSTATE               1
Line 1144  struct sqlite3_io_methods { Line 1163  struct sqlite3_io_methods {
 #define SQLITE_FCNTL_LOCK_TIMEOUT           34  #define SQLITE_FCNTL_LOCK_TIMEOUT           34
 #define SQLITE_FCNTL_DATA_VERSION           35  #define SQLITE_FCNTL_DATA_VERSION           35
 #define SQLITE_FCNTL_SIZE_LIMIT             36  #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 */  /* deprecated names */
 #define SQLITE_GET_LOCKPROXYFILE      SQLITE_FCNTL_GET_LOCKPROXYFILE  #define SQLITE_GET_LOCKPROXYFILE      SQLITE_FCNTL_GET_LOCKPROXYFILE
Line 1189  typedef struct sqlite3_api_routines sqlite3_api_routin Line 1211  typedef struct sqlite3_api_routines sqlite3_api_routin
 ** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6].  Additional fields  ** 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 be appended to the sqlite3_vfs object and the iVersion value
 ** may increase again in future versions of SQLite.  ** may increase again in future versions of SQLite.
** Note that the structure** Note that due to an oversight, the structure
** of the sqlite3_vfs object changes in the transition from** 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]  ** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0]
** and yet the iVersion field was not modified.** 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 1227  typedef struct sqlite3_api_routines sqlite3_api_routin Line 1249  typedef struct sqlite3_api_routines sqlite3_api_routin
 ** 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 1248  typedef struct sqlite3_api_routines sqlite3_api_routin Line 1270  typedef struct sqlite3_api_routines sqlite3_api_routin
 ** <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 1276  typedef struct sqlite3_api_routines sqlite3_api_routin Line 1298  typedef struct sqlite3_api_routines sqlite3_api_routin
 ** ^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 1303  typedef struct sqlite3_api_routines sqlite3_api_routin Line 1325  typedef struct sqlite3_api_routines sqlite3_api_routin
 ** non-zero error code if there is an I/O error or if the name of  ** 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  ** 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  ** is returned, then non-zero or zero is written into *pResOut to indicate
** whether or not the file is accessible.  ** 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 1323  typedef struct sqlite3_api_routines sqlite3_api_routin Line 1345  typedef struct sqlite3_api_routines sqlite3_api_routin
 ** 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 1379  struct sqlite3_vfs { Line 1401  struct sqlite3_vfs {
   /*    /*
   ** 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 future 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 1423  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 on 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 1568  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 1586  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 1616  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 1674  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 1709  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> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is ** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
 ** a pointer to an instance of the [sqlite3_mem_methods] structure.  ** a pointer to an instance of the [sqlite3_mem_methods] structure.
 ** The argument specifies  ** 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
Line 1742  struct sqlite3_mem_methods { Line 1764  struct sqlite3_mem_methods {
 ** memory allocation statistics. ^(When memory allocation statistics are  ** memory allocation statistics. ^(When memory allocation statistics are
 ** disabled, the 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()]
Line 1759  struct sqlite3_mem_methods { Line 1782  struct sqlite3_mem_methods {
 ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>  ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
 ** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool  ** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
 ** that SQLite can use for the database page cache with the default page  ** that SQLite can use for the database page cache with the default page
** cache implementation.  ** cache implementation.
** This configuration option is a no-op if an application-define page** This configuration option is a no-op if an application-defined page
 ** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].  ** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
 ** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to  ** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
 ** 8-byte aligned memory (pMem), the size of each page cache line (sz),  ** 8-byte aligned memory (pMem), the size of each page cache line (sz),
Line 1787  struct sqlite3_mem_methods { Line 1810  struct sqlite3_mem_methods {
 ** additional cache line. </dd>  ** additional cache line. </dd>
 **  **
 ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>  ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer ** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
 ** that SQLite will use for all of its dynamic memory allocation needs  ** that SQLite will use for all of its dynamic memory allocation needs
 ** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].  ** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].
 ** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled  ** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
Line 1842  struct sqlite3_mem_methods { Line 1865  struct sqlite3_mem_methods {
 ** 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> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is ** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
 ** a pointer to an [sqlite3_pcache_methods2] object.  This object specifies  ** a pointer to an [sqlite3_pcache_methods2] object.  This object specifies
 ** the interface to a custom page cache implementation.)^  ** the interface to a custom page cache implementation.)^
 ** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>  ** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
Line 1856  struct sqlite3_mem_methods { Line 1879  struct sqlite3_mem_methods {
 ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite  ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
 ** global [error log].  ** global [error log].
 ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a  ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
** function with a call signature of void(*)(void*,int,const char*), ** 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 1965  struct sqlite3_mem_methods { Line 1988  struct sqlite3_mem_methods {
 ** [[SQLITE_CONFIG_STMTJRNL_SPILL]]  ** [[SQLITE_CONFIG_STMTJRNL_SPILL]]
 ** <dt>SQLITE_CONFIG_STMTJRNL_SPILL  ** <dt>SQLITE_CONFIG_STMTJRNL_SPILL
 ** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which  ** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
** becomes the [statement journal] spill-to-disk threshold.  ** becomes the [statement journal] spill-to-disk threshold.
 ** [Statement journals] are held in memory until their size (in bytes)  ** [Statement journals] are held in memory until their size (in bytes)
 ** exceeds this threshold, at which point they are written to disk.  ** exceeds this threshold, at which point they are written to disk.
 ** Or if the threshold is -1, statement journals are always held  ** Or if the threshold is -1, statement journals are always held
Line 1987  struct sqlite3_mem_methods { Line 2010  struct sqlite3_mem_methods {
 ** than the configured sorter-reference size threshold - then a reference  ** than the configured sorter-reference size threshold - then a reference
 ** is stored in each sorted record and the required column values loaded  ** is stored in each sorted record and the required column values loaded
 ** from the database as records are returned in sorted order. The default  ** from the database as records are returned in sorted order. The default
** value for this option is to never use this optimization. Specifying a ** value for this option is to never use this optimization. Specifying a
 ** negative value for this option restores the default behaviour.  ** negative value for this option restores the default behaviour.
 ** This option is only available if SQLite is compiled with the  ** This option is only available if SQLite is compiled with the
 ** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option.  ** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option.
Line 2015  struct sqlite3_mem_methods { Line 2038  struct sqlite3_mem_methods {
 #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 2050  struct sqlite3_mem_methods { Line 2073  struct sqlite3_mem_methods {
 ** <dl>  ** <dl>
 ** [[SQLITE_DBCONFIG_LOOKASIDE]]  ** [[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 2068  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]]  ** [[SQLITE_DBCONFIG_ENABLE_FKEY]]
Line 2093  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]]  ** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]]
 ** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>  ** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
 ** <dd> ^This option is used to enable or disable the  ** <dd> ^This option is used to enable or disable the
Line 2134  struct sqlite3_mem_methods { Line 2168  struct sqlite3_mem_methods {
 ** until after the database connection closes.  ** until after the database connection closes.
 ** </dd>  ** </dd>
 **  **
** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]] ** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]]
 ** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>  ** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>
** <dd> Usually, when a database in wal mode is closed or detached from a ** <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 ** 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 ** connections at all to the database. If so, it performs a checkpoint
 ** operation before closing the connection. This option may be used to  ** operation before closing the connection. This option may be used to
 ** override this behaviour. The first parameter passed to this operation  ** override this behaviour. The first parameter passed to this operation
 ** is an integer - positive to disable checkpoints-on-close, or zero (the  ** is an integer - positive to disable checkpoints-on-close, or zero (the
Line 2157  struct sqlite3_mem_methods { Line 2191  struct sqlite3_mem_methods {
 ** slower.  But the QPSG has the advantage of more predictable behavior.  With  ** 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  ** the QPSG active, SQLite will always use the same query plan in the field as
 ** was used during testing in the lab.  ** was used during testing in the lab.
** The first argument to this setting is an integer which is 0 to disable ** 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  ** the QPSG, positive to enable QPSG, or negative to leave the setting
 ** unchanged. The second parameter is a pointer to an integer into which  ** 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  ** is written 0 or 1 to indicate whether the QPSG is disabled or enabled
Line 2165  struct sqlite3_mem_methods { Line 2199  struct sqlite3_mem_methods {
 ** </dd>  ** </dd>
 **  **
 ** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt>  ** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt>
** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not ** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not
 ** include output for any operations performed by trigger programs. This  ** include output for any operations performed by trigger programs. This
 ** option is used to set or clear (the default) a flag that governs 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 -  ** behavior. The first parameter passed to this operation is an integer -
 ** positive to enable output for trigger programs, or zero to disable it,  ** positive to enable output for trigger programs, or zero to disable it,
 ** or negative to leave the setting unchanged.  ** or negative to leave the setting unchanged.
** The second parameter is a pointer to an integer into which is written ** 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 ** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if
** it is not disabled, 1 if it is.  ** it is not disabled, 1 if it is.
 ** </dd>  ** </dd>
 **  **
 ** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt>  ** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt>
Line 2187  struct sqlite3_mem_methods { Line 2221  struct sqlite3_mem_methods {
 **      database, or calling sqlite3_table_column_metadata(), ignoring any  **      database, or calling sqlite3_table_column_metadata(), ignoring any
 **      errors.  This step is only necessary if the application desires to keep  **      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 database in WAL mode after the reset if it was in WAL mode before
**      the reset.  **      the reset.
 ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0);  ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0);
 ** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0);  ** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0);
 ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0);  ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0);
Line 2199  struct sqlite3_mem_methods { Line 2233  struct sqlite3_mem_methods {
 ** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt>  ** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt>
 ** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the  ** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the
 ** "defensive" flag for a database connection.  When the defensive  ** "defensive" flag for a database connection.  When the defensive
** flag is enabled, language features that allow ordinary SQL to ** flag is enabled, language features that allow ordinary SQL to
 ** deliberately corrupt the database file are disabled.  The disabled  ** deliberately corrupt the database file are disabled.  The disabled
 ** features include but are not limited to the following:  ** features include but are not limited to the following:
 ** <ul>  ** <ul>
Line 2214  struct sqlite3_mem_methods { Line 2248  struct sqlite3_mem_methods {
 ** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the  ** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the
 ** "writable_schema" flag. This has the same effect and is logically equivalent  ** "writable_schema" flag. This has the same effect and is logically equivalent
 ** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF].  ** 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 first argument to this setting is an integer which is 0 to disable
 ** the writable_schema, positive to enable writable_schema, or negative to  ** the writable_schema, positive to enable writable_schema, or negative to
 ** leave the setting unchanged. The second parameter is a pointer to an  ** 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  ** integer into which is written 0 or 1 to indicate whether the writable_schema
Line 2234  struct sqlite3_mem_methods { Line 2268  struct sqlite3_mem_methods {
 ** [[SQLITE_DBCONFIG_DQS_DML]]  ** [[SQLITE_DBCONFIG_DQS_DML]]
 ** <dt>SQLITE_DBCONFIG_DQS_DML</td>  ** <dt>SQLITE_DBCONFIG_DQS_DML</td>
 ** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates  ** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates
** the legacy [double-quoted string literal] misfeature for DML statement** the legacy [double-quoted string literal] misfeature for DML statements
 ** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The  ** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The
 ** default value of this setting is determined by the [-DSQLITE_DQS]  ** default value of this setting is determined by the [-DSQLITE_DQS]
 ** compile-time option.  ** compile-time option.
Line 2248  struct sqlite3_mem_methods { Line 2282  struct sqlite3_mem_methods {
 ** default value of this setting is determined by the [-DSQLITE_DQS]  ** default value of this setting is determined by the [-DSQLITE_DQS]
 ** compile-time option.  ** compile-time option.
 ** </dd>  ** </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_MAINDBNAME            1000 /* const char* */  #define SQLITE_DBCONFIG_MAINDBNAME            1000 /* const char* */
Line 2265  struct sqlite3_mem_methods { Line 2341  struct sqlite3_mem_methods {
 #define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE    1012 /* int int* */  #define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE    1012 /* int int* */
 #define SQLITE_DBCONFIG_DQS_DML               1013 /* int int* */  #define SQLITE_DBCONFIG_DQS_DML               1013 /* int int* */
 #define SQLITE_DBCONFIG_DQS_DDL               1014 /* int int* */  #define SQLITE_DBCONFIG_DQS_DDL               1014 /* int int* */
#define SQLITE_DBCONFIG_MAX                   1014 /* Largest DBCONFIG */#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
Line 2292  SQLITE_API int sqlite3_extended_result_codes(sqlite3*, Line 2371  SQLITE_API int sqlite3_extended_result_codes(sqlite3*,
 ** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of  ** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of
 ** the most recent successful [INSERT] into a rowid table or [virtual table]  ** the most recent successful [INSERT] into a rowid table or [virtual table]
 ** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not  ** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not
** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred ** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred
** on the database connection D, then sqlite3_last_insert_rowid(D) returns ** on the database connection D, then sqlite3_last_insert_rowid(D) returns
 ** zero.  ** zero.
 **  **
 ** As well as being set automatically as rows are inserted into database  ** As well as being set automatically as rows are inserted into database
Line 2303  SQLITE_API int sqlite3_extended_result_codes(sqlite3*, Line 2382  SQLITE_API int sqlite3_extended_result_codes(sqlite3*,
 ** Some virtual table implementations may INSERT rows into rowid tables as  ** Some virtual table implementations may INSERT rows into rowid tables as
 ** part of committing a transaction (e.g. to flush data accumulated in memory  ** 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  ** to disk). In this case subsequent calls to this function return the rowid
** associated with these internal INSERT operations, which leads to ** associated with these internal INSERT operations, which leads to
 ** unintuitive results. Virtual table implementations that do write to rowid  ** unintuitive results. Virtual table implementations that do write to rowid
** tables in this way can avoid this problem by restoring the original ** tables in this way can avoid this problem by restoring the original
** rowid value using [sqlite3_set_last_insert_rowid()] before returning ** rowid value using [sqlite3_set_last_insert_rowid()] before returning
 ** control to the user.  ** control to the user.
 **  **
** ^(If an [INSERT] occurs within a trigger then this routine will ** ^(If an [INSERT] occurs within a trigger then this routine will
** return the [rowid] of the inserted row as long as the trigger is ** return the [rowid] of the inserted row as long as the trigger is
** running. Once the trigger program ends, the value returned ** running. Once the trigger program ends, the value returned
 ** by this routine reverts to what it was before the trigger was fired.)^  ** 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
Line 2344  SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sql Line 2423  SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sql
 ** METHOD: sqlite3  ** METHOD: sqlite3
 **  **
 ** The sqlite3_set_last_insert_rowid(D, R) method allows the application to  ** 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 ** set the value returned by calling sqlite3_last_insert_rowid(D) to R
 ** without inserting a row into the database.  ** without inserting a row into the database.
 */  */
 SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);  SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);
Line 2360  SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3* Line 2439  SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*
 ** returned by this function.  ** returned by this function.
 **  **
 ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are  ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], ** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
 ** [foreign key actions] or [REPLACE] constraint resolution are not counted.  ** [foreign key actions] or [REPLACE] constraint resolution are not counted.
** **
** Changes to a view that are intercepted by ** Changes to a view that are intercepted by
** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value ** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value
** returned by sqlite3_changes() immediately after an INSERT, UPDATE or ** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
** DELETE statement run on a view is always zero. Only changes made to real ** DELETE statement run on a view is always zero. Only changes made to real
 ** tables are counted.  ** tables are counted.
 **  **
 ** Things are more complicated if the sqlite3_changes() function is  ** Things are more complicated if the sqlite3_changes() function is
 ** executed while a trigger program is running. This may happen if the  ** executed while a trigger program is running. This may happen if the
 ** program uses the [changes() SQL function], or if some other callback  ** program uses the [changes() SQL function], or if some other callback
 ** function invokes sqlite3_changes() directly. Essentially:  ** function invokes sqlite3_changes() directly. Essentially:
** **
 ** <ul>  ** <ul>
 **   <li> ^(Before entering a trigger program the value returned by  **   <li> ^(Before entering a trigger program the value returned by
**        sqlite3_changes() function is saved. After the trigger program **        sqlite3_changes() function is saved. After the trigger program
 **        has finished, the original value is restored.)^  **        has finished, the original value is restored.)^
** **
**   <li> ^(Within a trigger program each INSERT, UPDATE and DELETE **   <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
**        statement sets the value returned by sqlite3_changes() **        statement sets the value returned by sqlite3_changes()
**        upon completion as normal. Of course, this value will not include **        upon completion as normal. Of course, this value will not include
**        any changes performed by sub-triggers, as the sqlite3_changes() **        any changes performed by sub-triggers, as the sqlite3_changes()
 **        value will be saved and restored after each sub-trigger has run.)^  **        value will be saved and restored after each sub-trigger has run.)^
 ** </ul>  ** </ul>
** **
 ** ^This means that if the changes() SQL function (or similar) is used  ** ^This means that if the changes() SQL function (or similar) is used
** by the first INSERT, UPDATE or DELETE statement within a trigger, it ** by the first INSERT, UPDATE or DELETE statement within a trigger, it
 ** returns the value as set when the calling statement began executing.  ** returns the value as set when the calling statement began executing.
** ^If it is used by the second or subsequent such statement within a trigger ** ^If it is used by the second or subsequent such statement within a trigger
** program, the value returned reflects the number of rows modified by the ** program, the value returned reflects the number of rows modified by the
 ** previous INSERT, UPDATE or DELETE statement within the same trigger.  ** previous INSERT, UPDATE or DELETE statement within the same trigger.
 **  **
 ** If a separate thread makes changes on the same database connection  ** If a separate thread makes changes on the same database connection
Line 2416  SQLITE_API int sqlite3_changes(sqlite3*); Line 2495  SQLITE_API int sqlite3_changes(sqlite3*);
 ** since the database connection was opened, including those executed as  ** since the database connection was opened, including those executed as
 ** part of trigger programs. ^Executing any other type of SQL statement  ** part of trigger programs. ^Executing any other type of SQL statement
 ** does not affect the value returned by sqlite3_total_changes().  ** does not affect the value returned by sqlite3_total_changes().
** **
 ** ^Changes made as part of [foreign key actions] are included in the  ** ^Changes made as part of [foreign key actions] are included in the
 ** count, but those made as part of REPLACE constraint resolution are  ** count, but those made as part of REPLACE constraint resolution are
** not. ^Changes to a view that are intercepted by INSTEAD OF triggers ** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
 ** are not counted.  ** are not counted.
 **  **
 ** The [sqlite3_total_changes(D)] interface only reports the number  ** The [sqlite3_total_changes(D)] interface only reports the number
Line 2428  SQLITE_API int sqlite3_changes(sqlite3*); Line 2507  SQLITE_API int sqlite3_changes(sqlite3*);
 ** To detect changes against a database file from other database  ** To detect changes against a database file from other database
 ** connections use the [PRAGMA data_version] command or the  ** connections use the [PRAGMA data_version] command or the
 ** [SQLITE_FCNTL_DATA_VERSION] [file control].  ** [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.
Line 2470  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().
Line 2502  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 2547  SQLITE_API int sqlite3_complete16(const void *sql); Line 2626  SQLITE_API int sqlite3_complete16(const void *sql);
 ** 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]
** to the application instead of invoking the ** to the application instead of invoking the
 ** busy handler.  ** 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
Line 2572  SQLITE_API int sqlite3_complete16(const void *sql); Line 2651  SQLITE_API int sqlite3_complete16(const void *sql);
 ** database connection that invoked the busy handler.  In other words,  ** database connection that invoked the busy handler.  In other words,
 ** the busy handler is not reentrant.  Any such actions  ** 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.
 */  */
Line 2639  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&#91;0] = "Name";  **        azResult&#91;0] = "Name";
Line 2690  SQLITE_API void sqlite3_free_table(char **result); Line 2769  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  ** These routines understand most of the common formatting options from
** the standard library printf() ** the standard library printf()
 ** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).  ** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).
 ** See the [built-in printf()] documentation for details.  ** See the [built-in printf()] documentation for details.
 **  **
Line 2734  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 2795  SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha Line 2874  SQLITE_API char *sqlite3_vsnprintf(int,char*,const cha
 ** 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.  
 **  
 ** Prior to SQLite version 3.7.10, the Windows OS interface layer called  
 ** 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 were detected, but  
 ** they were 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 2856  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.
Line 2899  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
Line 2952  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 3100  SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sql Line 3166  SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sql
 ** execution of the prepared statement, such as at the start of each  ** execution of the prepared statement, such as at the start of each
 ** trigger subprogram. ^The P argument is a pointer to the  ** trigger subprogram. ^The P argument is a pointer to the
 ** [prepared statement]. ^The X argument is a pointer to a string which  ** [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 ** is the unexpanded SQL text of the prepared statement or an SQL comment
 ** that indicates the invocation of a trigger.  ^The callback can compute  ** that indicates the invocation of a trigger.  ^The callback can compute
 ** the same text that would have been returned by the legacy [sqlite3_trace()]  ** 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  ** interface by using the X argument when X begins with "--" and invoking
Line 3116  SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sql Line 3182  SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sql
 **  **
 ** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>  ** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>
 ** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared  ** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared
** statement generates a single row of result.  ** statement generates a single row of result.
 ** ^The P argument is a pointer to the [prepared statement] and the  ** ^The P argument is a pointer to the [prepared statement] and the
 ** X argument is unused.  ** X argument is unused.
 **  **
Line 3143  SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sql Line 3209  SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sql
 ** M argument should be the bitwise OR-ed combination of  ** M argument should be the bitwise OR-ed combination of
 ** zero or more [SQLITE_TRACE] constants.  ** zero or more [SQLITE_TRACE] constants.
 **  **
** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides ** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides
 ** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2().  ** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2().
 **  **
** ^The X callback is invoked whenever any of the events identified by ** ^The X callback is invoked whenever any of the events identified by
 ** mask M occur.  ^The integer return value from the callback is currently  ** mask M occur.  ^The integer return value from the callback is currently
 ** ignored, though this may change in future releases.  Callback  ** ignored, though this may change in future releases.  Callback
 ** implementations should return zero to ensure future compatibility.  ** implementations should return zero to ensure future compatibility.
Line 3178  SQLITE_API int sqlite3_trace_v2( Line 3244  SQLITE_API int sqlite3_trace_v2(
 ** 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 approximate 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.  ^If N is less than one then the progress  ** invocations of the callback X.  ^If N is less than one then the progress
 ** handler is disabled.  ** handler is disabled.
Line 3206  SQLITE_API void sqlite3_progress_handler(sqlite3*, int Line 3272  SQLITE_API void sqlite3_progress_handler(sqlite3*, int
 ** CAPI3REF: Opening A New Database Connection  ** CAPI3REF: Opening A New Database Connection
 ** CONSTRUCTOR: sqlite3  ** 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 3230  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 3251  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 3299  SQLITE_API void sqlite3_progress_handler(sqlite3*, int Line 3391  SQLITE_API void sqlite3_progress_handler(sqlite3*, int
 ** 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]]
Line 3329  SQLITE_API void sqlite3_progress_handler(sqlite3*, int Line 3421  SQLITE_API void sqlite3_progress_handler(sqlite3*, int
 **  **
 **   <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",  **   <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
 **     "rwc", or "memory". Attempting to set it to any other value is  **     "rwc", or "memory". Attempting to set it to any other value is
**     an error)^. **     an error)^.
**     ^If "ro" is specified, then the database is opened for read-only **     ^If "ro" is specified, then the database is opened for read-only
**     access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the **     access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
**     third argument to sqlite3_open_v2(). ^If the mode option is set to **     third argument to sqlite3_open_v2(). ^If the mode option is set to
**     "rw", then the database is opened for read-write (but not create) **     "rw", then the database is opened for read-write (but not create)
**     access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had **     access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
**     been set. ^Value "rwc" is equivalent to setting both **     been set. ^Value "rwc" is equivalent to setting both
 **     SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE.  ^If the mode option is  **     SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE.  ^If the mode option is
 **     set to "memory" then a pure [in-memory database] that never reads  **     set to "memory" then a pure [in-memory database] that never reads
 **     or writes from disk is used. ^It is an error to specify a value for  **     or writes from disk is used. ^It is an error to specify a value for
Line 3345  SQLITE_API void sqlite3_progress_handler(sqlite3*, int Line 3437  SQLITE_API void sqlite3_progress_handler(sqlite3*, int
 **   <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 behavior requested by setting  **     a URI filename, its value overrides any behavior requested by setting
Line 3371  SQLITE_API void sqlite3_progress_handler(sqlite3*, int Line 3463  SQLITE_API void sqlite3_progress_handler(sqlite3*, int
 **     property on a database file that does in fact change can result  **     property on a database file that does in fact change can result
 **     in incorrect query results and/or [SQLITE_CORRUPT] errors.  **     in incorrect query results and/or [SQLITE_CORRUPT] errors.
 **     See also: [SQLITE_IOCAP_IMMUTABLE].  **     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 3383  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-dotfile <td>  ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
 **          Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"  **          Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
 **          that uses dot-files in place of posix advisory locking.  **          that uses dot-files in place of posix advisory locking.
** <tr><td> file:data.db?mode=readonly <td> ** <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 3447  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.
 **  **
Line 3465  SQLITE_API int sqlite3_open_v2( Line 3567  SQLITE_API int sqlite3_open_v2(
 ** 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 sqlite3_uri_boolean(F,P,B) routine returns true (1) if the  ** of P.  The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
 ** value of query parameter P is one of "yes", "true", or "on" in any  ** value of query parameter P is one of "yes", "true", or "on" in any
** case or if the value begins with a non-zero number.  The ** 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  ** 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  ** 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  ** if the value begins with a numeric zero.  If P is not a query
** parameter on F or if the value of P is does not match any of the** 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).  ** 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.  ** 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  ** METHOD: sqlite3
 **  **
** ^If the most recent sqlite3_* API call associated with ** ^If the most recent sqlite3_* API call associated with
 ** [database connection] D failed, then the sqlite3_errcode(D) interface  ** [database connection] D failed, then the sqlite3_errcode(D) interface
 ** returns the numeric [result code] or [extended result code] for that  ** returns the numeric [result code] or [extended result code] for that
 ** API call.  ** API call.
 ** ^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.
 **  **
Line 3556  SQLITE_API const char *sqlite3_errstr(int); Line 3777  SQLITE_API const char *sqlite3_errstr(int);
 ** has been compiled into binary form and is ready to be evaluated.  ** has been compiled into binary form and is ready to be evaluated.
 **  **
 ** Think of each SQL statement as a separate computer program.  The  ** Think of each SQL statement as a separate computer program.  The
** original SQL text is source code.  A prepared statement object ** original SQL text is source code.  A prepared statement object
 ** is the compiled object code.  All SQL must be converted into a  ** is the compiled object code.  All SQL must be converted into a
 ** prepared statement before it can be run.  ** prepared statement before it can be run.
 **  **
Line 3586  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 3594  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 3699  SQLITE_API int sqlite3_limit(sqlite3*, int id, int new Line 3920  SQLITE_API int sqlite3_limit(sqlite3*, int id, int new
 ** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner  ** <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  ** that the prepared statement will be retained for a long time and
 ** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]  ** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]
** and [sqlite3_prepare16_v3()] assume that the prepared statement will ** and [sqlite3_prepare16_v3()] assume that the prepared statement will
 ** be used just once or at most a few times and then destroyed using  ** be used just once or at most a few times and then destroyed using
 ** [sqlite3_finalize()] relatively soon. The current implementation acts  ** [sqlite3_finalize()] relatively soon. The current implementation acts
 ** on this hint by avoiding the use of [lookaside memory] so as not to  ** on this hint by avoiding the use of [lookaside memory] so as not to
Line 3806  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.
 ** </li>  ** </li>
 ** </ol>  ** </ol>
 **  **
Line 3920  SQLITE_API const char *sqlite3_normalized_sql(sqlite3_ Line 4141  SQLITE_API const char *sqlite3_normalized_sql(sqlite3_
 ** 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 3935  SQLITE_API const char *sqlite3_normalized_sql(sqlite3_ Line 4156  SQLITE_API const char *sqlite3_normalized_sql(sqlite3_
 ** ^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  ** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since
 ** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and  ** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and
Line 3964  SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pS Line 4185  SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pS
 ** METHOD: sqlite3_stmt  ** 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 neither run to completion (returned  ** [sqlite3_step(S)] but has neither run to completion (returned
 ** [SQLITE_DONE] from [sqlite3_step(S)]) nor  ** [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 3994  SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); Line 4215  SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
 ** 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.  The  ** whether or not it requires a protected sqlite3_value.  The
** [sqlite3_value_dup()] interface can be used to construct a new ** [sqlite3_value_dup()] interface can be used to construct a new
 ** protected sqlite3_value from an unprotected sqlite3_value.  ** 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
Line 4002  SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); Line 4223  SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
 ** 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 4071  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()  ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
 ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter  ** 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().  ** 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.)^
Line 4090  typedef struct sqlite3_context sqlite3_context; Line 4329  typedef struct sqlite3_context sqlite3_context;
 ** or sqlite3_bind_text16() or sqlite3_bind_text64() then  ** or sqlite3_bind_text16() or sqlite3_bind_text64() then
 ** that parameter must be the byte offset  ** 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.
Line 4252  SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); Line 4491  SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
 ** METHOD: sqlite3_stmt  ** 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]. ^If this routine returns 0, that means the ** [prepared statement]. ^If this routine returns 0, that means the
 ** [prepared statement] returns no 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  ** ^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  ** mean that one or more rows of data will be returned.  ^A SELECT statement
Line 4320  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 4330  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 4438  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] ([dateof:3.6.23.1],  ** sqlite3_step().  But after [version 3.6.23.1] ([dateof:3.6.23.1],
 ** sqlite3_step() began  ** sqlite3_step() began
Line 4470  SQLITE_API int sqlite3_step(sqlite3_stmt*); Line 4705  SQLITE_API int sqlite3_step(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 4529  SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt) Line 4764  SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
 ** <tr><td><b>sqlite3_column_int64</b><td>&rarr;<td>64-bit INTEGER result  ** <tr><td><b>sqlite3_column_int64</b><td>&rarr;<td>64-bit INTEGER result
 ** <tr><td><b>sqlite3_column_text</b><td>&rarr;<td>UTF-8 TEXT result  ** <tr><td><b>sqlite3_column_text</b><td>&rarr;<td>UTF-8 TEXT result
 ** <tr><td><b>sqlite3_column_text16</b><td>&rarr;<td>UTF-16 TEXT result  ** <tr><td><b>sqlite3_column_text16</b><td>&rarr;<td>UTF-16 TEXT result
** <tr><td><b>sqlite3_column_value</b><td>&rarr;<td>The result as an ** <tr><td><b>sqlite3_column_value</b><td>&rarr;<td>The result as an
 ** [sqlite3_value|unprotected sqlite3_value] object.  ** [sqlite3_value|unprotected sqlite3_value] object.
 ** <tr><td>&nbsp;<td>&nbsp;<td>&nbsp;  ** <tr><td>&nbsp;<td>&nbsp;<td>&nbsp;
 ** <tr><td><b>sqlite3_column_bytes</b><td>&rarr;<td>Size of a BLOB  ** <tr><td><b>sqlite3_column_bytes</b><td>&rarr;<td>Size of a BLOB
Line 4577  SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt) Line 4812  SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
 ** The return value of sqlite3_column_type() can be used to decide which  ** The return value of sqlite3_column_type() can be used to decide which
 ** of the first six interface should be used to extract the column value.  ** of the first six interface should be used to extract the column value.
 ** The value returned by sqlite3_column_type() is only meaningful if no  ** The value returned by sqlite3_column_type() is only meaningful if no
** automatic type conversions have occurred for the value in question.  ** automatic type conversions have occurred for the value in question.
 ** After a type conversion, the result of calling sqlite3_column_type()  ** After a type conversion, the result of calling sqlite3_column_type()
 ** is undefined, though harmless.  Future  ** 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()
Line 4605  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 4624  SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt) Line 4859  SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt)
 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],  ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
 ** or [sqlite3_value_bytes()], the behavior is not threadsafe.  ** or [sqlite3_value_bytes()], the behavior is not threadsafe.
 ** Hence, the sqlite3_column_value() interface  ** Hence, the sqlite3_column_value() interface
** is normally only useful within the implementation of ** is normally only useful within the implementation of
 ** [application-defined SQL functions] or [virtual tables], not within  ** [application-defined SQL functions] or [virtual tables], not within
 ** top-level application code.  ** top-level application code.
 **  **
Line 4794  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}  
 ** KEYWORDS: {application-defined SQL functions}  
 ** METHOD: sqlite3  ** METHOD: sqlite3
 **  **
 ** ^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
** the three "sqlite3_create_function*" routines are the text encoding ** the three "sqlite3_create_function*" routines are the text encoding
** expected for the second parameter (the name of the function being ** expected for the second parameter (the name of the function being
 ** created) 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. Function sqlite3_create_window_function()  ** the application data pointer. Function sqlite3_create_window_function()
 ** is similar, but allows the user to supply the extra callback functions  ** is similar, but allows the user to supply the extra callback functions
Line 4816  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 4831  SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); Line 5064  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.  The application should set this parameter to  ** its parameters.  The application should set this parameter to
** [SQLITE_UTF16LE] if the function implementation invokes ** [SQLITE_UTF16LE] if the function implementation invokes
 ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the  ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
 ** implementation invokes [sqlite3_value_text16be()] on an input, or  ** implementation invokes [sqlite3_value_text16be()] on an input, or
 ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]  ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
Line 4849  SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); Line 5082  SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
 ** perform additional optimizations on deterministic functions, so use  ** perform additional optimizations on deterministic functions, so use
 ** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.  ** 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()].)^
 **  **
Line 4862  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.
 **  **
** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue ** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue
 ** and xInverse) passed to sqlite3_create_window_function are pointers to  ** and xInverse) passed to sqlite3_create_window_function are pointers to
 ** C-language callbacks that implement the new function. xStep and xFinal  ** C-language callbacks that implement the new function. xStep and xFinal
 ** must both be non-NULL. xValue and xInverse may either both be NULL, in  ** must both be non-NULL. xValue and xInverse may either both be NULL, in
** which case a regular aggregate function is created, or must both be ** which case a regular aggregate function is created, or must both be
 ** non-NULL, in which case the new function may be used as either an aggregate  ** non-NULL, in which case the new function may be used as either an aggregate
 ** or aggregate window function. More details regarding the implementation  ** or aggregate window function. More details regarding the implementation
** of aggregate window functions are ** of aggregate window functions are
 ** [user-defined window functions|available here].  ** [user-defined window functions|available here].
 **  **
 ** ^(If the final parameter to sqlite3_create_function_v2() or  ** ^(If the final parameter to sqlite3_create_function_v2() or
 ** sqlite3_create_window_function() is not NULL, then it is destructor for  ** sqlite3_create_window_function() is not NULL, then it is destructor for
** the application data pointer. The destructor is invoked when the function ** the application data pointer. The destructor is invoked when the function
** is deleted, either by being overloaded or when the database connection ** is deleted, either by being overloaded or when the database connection
** closes.)^ ^The destructor is also invoked if the call to ** closes.)^ ^The destructor is also invoked if the call to
 ** sqlite3_create_function_v2() fails.  ^When the destructor callback is  ** sqlite3_create_function_v2() fails.  ^When the destructor callback is
 ** invoked, it is passed a single argument which is a copy of the application  ** 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().  ** data pointer which was the fifth parameter to sqlite3_create_function_v2().
Line 4889  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 4961  SQLITE_API int sqlite3_create_window_function( Line 5211  SQLITE_API int sqlite3_create_window_function(
 /*  /*
 ** CAPI3REF: Function Flags  ** CAPI3REF: Function Flags
 **  **
** These constants may be ORed together with the ** These constants may be ORed together with the
 ** [SQLITE_UTF8 | preferred text encoding] as the fourth argument  ** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
 ** to [sqlite3_create_function()], [sqlite3_create_function16()], or  ** to [sqlite3_create_function()], [sqlite3_create_function16()], or
 ** [sqlite3_create_function_v2()].  ** [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    0x800#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 encourage programmers to avoid  ** the use of these functions.  To encourage programmers to avoid
 ** these functions, we will not explain what they do.  ** these functions, we will not explain what they do.
Line 5025  SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm( Line 5335  SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
 **  **
 ** These routines extract type, size, and content information from  ** These routines extract type, size, and content information from
 ** [protected sqlite3_value] objects.  Protected sqlite3_value objects  ** [protected sqlite3_value] objects.  Protected sqlite3_value objects
** are used to pass parameter information into implementation of** are used to pass parameter information into the functions that
** [application-defined SQL functions] and [virtual tables].** 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]
Line 5041  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 ** ^If [sqlite3_value] object V was initialized
 ** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]  ** 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),  ** 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,  ** then sqlite3_value_pointer(V,Y) will return the pointer P.  ^Otherwise,
** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer() ** 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.  ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
 **  **
 ** ^(The sqlite3_value_type(V) interface returns the  ** ^(The sqlite3_value_type(V) interface returns the
Line 5083  SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm( Line 5393  SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(
 ** ^The sqlite3_value_frombind(X) interface returns non-zero if the  ** ^The sqlite3_value_frombind(X) interface returns non-zero if the
 ** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()]  ** 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,  ** interfaces.  ^If X comes from an SQL literal value, or a table column,
** and expression, then sqlite3_value_frombind(X) returns zero.** 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
Line 5168  SQLITE_API void sqlite3_value_free(sqlite3_value*); Line 5478  SQLITE_API void sqlite3_value_free(sqlite3_value*);
 ** 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 5181  SQLITE_API void sqlite3_value_free(sqlite3_value*); Line 5491  SQLITE_API void sqlite3_value_free(sqlite3_value*);
 ** 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 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
 ** when first called if N is less than or equal to zero or if a memory  ** when first called if N is less than or equal to zero or if a memory
 ** allocate error occurs.  ** 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.)^  Within the xFinal callback, it is customary to set  ** allocation.)^  Within the xFinal callback, it is customary to set
** N=0 in calls to sqlite3_aggregate_context(C,N) so that no ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
 ** pointless memory allocations occur.  ** 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 5243  SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_ Line 5553  SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_
 ** some circumstances the associated metadata may be preserved.  An example  ** some circumstances the associated metadata may be preserved.  An example
 ** of where this might be useful is in a regular-expression matching  ** of where this might be useful is in a regular-expression matching
 ** function. The compiled version of the regular expression can be stored as  ** function. The compiled version of the regular expression can be stored as
** metadata associated with the pattern string.  ** metadata associated with the pattern string.
 ** Then as long as the pattern string remains the same,  ** Then as long as the pattern string remains the same,
 ** the compiled regular expression can be reused on multiple  ** the compiled regular expression can be reused on multiple
 ** invocations of the same function.  ** invocations of the same function.
Line 5269  SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_ Line 5579  SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_
 **      SQL statement)^, or  **      SQL statement)^, or
 ** <li> ^(when sqlite3_set_auxdata() is invoked again on the same  ** <li> ^(when sqlite3_set_auxdata() is invoked again on the same
 **       parameter)^, or  **       parameter)^, or
** <li> ^(during the original sqlite3_set_auxdata() call when a memory ** <li> ^(during the original sqlite3_set_auxdata() call when a memory
 **      allocation error occurs.)^ </ul>  **      allocation error occurs.)^ </ul>
 **  **
** Note the last bullet in particular.  The destructor X in ** Note the last bullet in particular.  The destructor X in
 ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the  ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
 ** sqlite3_set_auxdata() interface even returns.  Hence sqlite3_set_auxdata()  ** sqlite3_set_auxdata() interface even returns.  Hence sqlite3_set_auxdata()
 ** should be called near the end of the function implementation and the  ** should be called near the end of the function implementation and the
Line 5344  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 5413  typedef void (*sqlite3_destructor_type)(void*); Line 5724  typedef void (*sqlite3_destructor_type)(void*);
 ** then SQLite makes a copy of the result into space obtained  ** 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 of 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
Line 5425  typedef void (*sqlite3_destructor_type)(void*); Line 5755  typedef void (*sqlite3_destructor_type)(void*);
 **  **
 ** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an  ** ^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  ** SQL NULL value, just like [sqlite3_result_null(C)], except that it
** also associates the host-language pointer P or type T with that ** also associates the host-language pointer P or type T with that
 ** NULL value such that the pointer can be retrieved within an  ** NULL value such that the pointer can be retrieved within an
 ** [application-defined SQL function] using [sqlite3_value_pointer()].  ** [application-defined SQL function] using [sqlite3_value_pointer()].
 ** ^If the D parameter is not NULL, then it is a pointer to a destructor  ** ^If the D parameter is not NULL, then it is a pointer to a destructor
Line 5467  SQLITE_API int sqlite3_result_zeroblob64(sqlite3_conte Line 5797  SQLITE_API int sqlite3_result_zeroblob64(sqlite3_conte
 ** METHOD: sqlite3_context  ** METHOD: sqlite3_context
 **  **
 ** The sqlite3_result_subtype(C,T) function causes the subtype of  ** The sqlite3_result_subtype(C,T) function causes the subtype of
** the result from the [application-defined SQL function] with ** the result from the [application-defined SQL function] with
** [sqlite3_context] C to be the value T.  Only the lower 8 bits ** [sqlite3_context] C to be the value T.  Only the lower 8 bits
 ** of the subtype T are preserved in current versions of SQLite;  ** of the subtype T are preserved in current versions of SQLite;
 ** higher order bits are discarded.  ** higher order bits are discarded.
 ** The number of subtype bytes preserved by SQLite might increase  ** The number of subtype bytes preserved by SQLite might increase
Line 5498  SQLITE_API void sqlite3_result_subtype(sqlite3_context Line 5828  SQLITE_API void sqlite3_result_subtype(sqlite3_context
 ** <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 5507  SQLITE_API void sqlite3_result_subtype(sqlite3_context Line 5837  SQLITE_API void sqlite3_result_subtype(sqlite3_context
 ** ^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 5535  SQLITE_API void sqlite3_result_subtype(sqlite3_context Line 5866  SQLITE_API void sqlite3_result_subtype(sqlite3_context
 ** </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 5545  SQLITE_API void sqlite3_result_subtype(sqlite3_context Line 5876  SQLITE_API void sqlite3_result_subtype(sqlite3_context
 ** 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*)
 );  );
Line 5607  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 */  
 );  
 SQLITE_API int sqlite3_key_v2(  
   sqlite3 *db,                   /* Database to be rekeyed */  
   const char *zDbName,           /* Name of the database */  
   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 */  
 );  
 SQLITE_API int sqlite3_rekey_v2(  
   sqlite3 *db,                   /* Database to be rekeyed */  
   const char *zDbName,           /* Name of the database */  
   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 5720  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
Line 5777  SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; Line 6063  SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
 ** ^The [data_store_directory pragma] may modify this variable and cause  ** ^The [data_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 [data_store_directory pragma] always assumes that any string  ** the [data_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
Line 5862  SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); Line 6148  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  ** 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
 ** this function will return either a NULL pointer or an empty string.  ** 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);
   
Line 5975  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.  ** ^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
Line 6001  SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void( Line 6302  SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(
 ** and [sqlite3_preupdate_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*
 );  );
Line 6015  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] ([dateof:3.5.0]). ** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).
 ** In prior versions of SQLite,  ** 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  ** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
** and will always return SQLITE_MISUSE. On those systems, ** and will always return SQLITE_MISUSE. On those systems,
** shared cache mode should be enabled per-database connection via ** shared cache mode should be enabled per-database connection via
 ** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].  ** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
 **  **
 ** This interface is threadsafe on processors where writing a  ** This interface is threadsafe on processors where writing a
Line 6076  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 6083  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 6110  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] ([dateof:3.7.3]), ** The circumstances under which SQLite will enforce the heap limits may
** the soft heap limit is enforced 
** 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 6148  SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li Line 6467  SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
 ** interface returns SQLITE_OK and fills in the non-NULL pointers in  ** interface returns SQLITE_OK and fills in the non-NULL pointers in
 ** the final five arguments with appropriate values if the specified  ** the final five arguments with appropriate values if the specified
 ** column exists.  ^The sqlite3_table_column_metadata() interface returns  ** column exists.  ^The sqlite3_table_column_metadata() interface returns
** SQLITE_ERROR and if the specified column does not exist.** SQLITE_ERROR if the specified column does not exist.
 ** ^If the column-name parameter to sqlite3_table_column_metadata() is a  ** ^If the column-name parameter to sqlite3_table_column_metadata() is a
 ** NULL pointer, then this routine simply checks for the existence of the  ** 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  ** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
Line 6188  SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li Line 6507  SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_li
 **  **
 ** ^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 the table ** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
 ** is not a [WITHOUT ROWID] table and an  ** 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
Line 6254  SQLITE_API int sqlite3_table_column_metadata( Line 6573  SQLITE_API int sqlite3_table_column_metadata(
 ** prior to calling this API,  ** 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 ** <b>Security warning:</b> It is recommended that the
 ** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this  ** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this
 ** interface.  The use of the [sqlite3_enable_load_extension()] interface  ** interface.  The use of the [sqlite3_enable_load_extension()] interface
 ** should be avoided.  This will keep the SQL function [load_extension()]  ** should be avoided.  This will keep the SQL function [load_extension()]
Line 6290  SQLITE_API int sqlite3_load_extension( Line 6609  SQLITE_API int sqlite3_load_extension(
 ** to enable or disable only the C-API.)^  ** to enable or disable only the C-API.)^
 **  **
 ** <b>Security warning:</b> It is recommended that extension loading  ** <b>Security warning:</b> It is recommended that extension loading
** be disabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method
 ** rather than this interface, so the [load_extension()] SQL function  ** rather than this interface, so the [load_extension()] SQL function
 ** remains disabled. This will prevent SQL injections from giving attackers  ** remains disabled. This will prevent SQL injections from giving attackers
 ** access to extension loading capabilities.  ** access to extension loading capabilities.
Line 6341  SQLITE_API int sqlite3_auto_extension(void(*xEntryPoin Line 6660  SQLITE_API int sqlite3_auto_extension(void(*xEntryPoin
 ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the  ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
 ** initialization routine X that was registered using a prior call to  ** initialization routine X that was registered using a prior call to
 ** [sqlite3_auto_extension(X)].  ^The [sqlite3_cancel_auto_extension(X)]  ** [sqlite3_auto_extension(X)].  ^The [sqlite3_cancel_auto_extension(X)]
** routine returns 1 if initialization routine X was successfully ** routine returns 1 if initialization routine X was successfully
 ** unregistered and it returns 0 if X was not on the list of initialization  ** unregistered and it returns 0 if X was not on the list of initialization
 ** routines.  ** routines.
 */  */
Line 6376  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 6416  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);
Line 6466  struct sqlite3_module { Line 6785  struct sqlite3_module {
 ** required by SQLite. If the table has at least 64 columns and any column  ** 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  ** 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  ** set. In other words, column iCol may be required if the expression
** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to ** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
 ** non-zero.  ** non-zero.
 **  **
 ** The [xBestIndex] method must fill aConstraintUsage[] with information  ** The [xBestIndex] method must fill aConstraintUsage[] with information
Line 6474  struct sqlite3_module { Line 6793  struct sqlite3_module {
 ** 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 6487  struct sqlite3_module { Line 6812  struct sqlite3_module {
 **  **
 ** ^The estimatedCost value is an estimate of the cost of a particular  ** ^The estimatedCost value is an estimate of the cost of a particular
 ** strategy. A cost of N indicates that the cost of the strategy is similar  ** strategy. A cost of N indicates that the cost of the strategy is similar
** to a linear scan of an SQLite table with N rows. A cost of log(N) ** to a linear scan of an SQLite table with N rows. A cost of log(N)
 ** indicates that the expense of the operation is similar to that of a  ** 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.  ** 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  ** ^The estimatedRows value is an estimate of the number of rows that
 ** will be returned by the strategy.  ** will be returned by the strategy.
 **  **
** The xBestIndex method may optionally populate the idxFlags field with a ** The xBestIndex method may optionally populate the idxFlags field with a
 ** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -  ** 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  ** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
** assumes that the strategy may visit at most one row. ** assumes that the strategy may visit at most one row.
 **  **
 ** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then  ** 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  ** SQLite also assumes that if a call to the xUpdate() method is made as
Line 6510  struct sqlite3_module { Line 6835  struct sqlite3_module {
 ** the xUpdate method are automatically rolled back by SQLite.  ** the xUpdate method are automatically rolled back by SQLite.
 **  **
 ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info  ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
** structure for SQLite [version 3.8.2] ([dateof:3.8.2]). ** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).
 ** If a virtual table extension is  ** If a virtual table extension is
** used with an SQLite version earlier than 3.8.2, the results of attempting ** 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 read or write the estimatedRows field are undefined (but are likely
** to included crashing the application). The estimatedRows field should** to include crashing the application). The estimatedRows field should
 ** therefore only be used if [sqlite3_libversion_number()] returns a  ** therefore only be used if [sqlite3_libversion_number()] returns a
 ** value greater than or equal to 3008002. Similarly, the idxFlags field  ** value greater than or equal to 3008002. Similarly, the idxFlags field
** was added for [version 3.9.0] ([dateof:3.9.0]). ** was added for [version 3.9.0] ([dateof:3.9.0]).
 ** It may therefore only be used if  ** It may therefore only be used if
 ** sqlite3_libversion_number() returns a value greater than or equal to  ** sqlite3_libversion_number() returns a value greater than or equal to
 ** 3009000.  ** 3009000.
Line 6557  struct sqlite3_index_info { Line 6882  struct sqlite3_index_info {
 /*  /*
 ** CAPI3REF: Virtual Table Scan Flags  ** CAPI3REF: Virtual Table Scan Flags
 **  **
** Virtual table implementations are allowed to set the ** Virtual table implementations are allowed to set the
 ** [sqlite3_index_info].idxFlags field to some combination of  ** [sqlite3_index_info].idxFlags field to some combination of
 ** these bits.  ** these bits.
 */  */
Line 6566  struct sqlite3_index_info { Line 6891  struct sqlite3_index_info {
 /*  /*
 ** 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].
Line 6597  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 6612  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 6628  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 6689  SQLITE_API int sqlite3_declare_vtab(sqlite3*, const ch Line 7037  SQLITE_API int sqlite3_declare_vtab(sqlite3*, const ch
 ** METHOD: sqlite3  ** 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 6740  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 ** ^(Parameter zDb is not the filename that contains the database, but
 ** rather the symbolic name of the database. For attached databases, this is  ** rather the symbolic name of the database. For attached databases, this is
 ** the name that appears after the AS keyword in the [ATTACH] statement.  ** the name that appears after the AS keyword in the [ATTACH] statement.
 ** For the main database file, the database name is "main". For TEMP  ** For the main database file, the database name is "main". For TEMP
Line 6753  typedef struct sqlite3_blob sqlite3_blob; Line 7101  typedef struct sqlite3_blob sqlite3_blob;
 ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored  ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
 ** in *ppBlob. Otherwise an [error code] is returned and, unless the error  ** in *ppBlob. Otherwise an [error code] is returned and, unless the error
 ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided  ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
** the API is not misused, it is always safe to call [sqlite3_blob_close()] ** the API is not misused, it is always safe to call [sqlite3_blob_close()]
 ** on *ppBlob after this function it returns.  ** on *ppBlob after this function it returns.
 **  **
 ** This function fails with SQLITE_ERROR if any of the following are true:  ** This function fails with SQLITE_ERROR if any of the following are true:
 ** <ul>  ** <ul>
**   <li> ^(Database zDb does not exist)^, **   <li> ^(Database zDb does not exist)^,
**   <li> ^(Table zTable does not exist within database zDb)^, **   <li> ^(Table zTable does not exist within database zDb)^,
**   <li> ^(Table zTable is a WITHOUT ROWID table)^, **   <li> ^(Table zTable is a WITHOUT ROWID table)^,
 **   <li> ^(Column zColumn does not exist)^,  **   <li> ^(Column zColumn does not exist)^,
 **   <li> ^(Row iRow is not present in the table)^,  **   <li> ^(Row iRow is not present in the table)^,
 **   <li> ^(The specified column of row iRow contains a value that is not  **   <li> ^(The specified column of row iRow contains a value that is not
 **         a TEXT or BLOB value)^,  **         a TEXT or BLOB value)^,
**   <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE **   <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
 **         constraint and the blob is being opened for read/write access)^,  **         constraint and the blob is being opened for read/write access)^,
**   <li> ^([foreign key constraints | Foreign key constraints] are enabled, **   <li> ^([foreign key constraints | Foreign key constraints] are enabled,
 **         column zColumn is part of a [child key] definition and the blob is  **         column zColumn is part of a [child key] definition and the blob is
 **         being opened for read/write access)^.  **         being opened for read/write access)^.
 ** </ul>  ** </ul>
 **  **
** ^Unless it returns SQLITE_MISUSE, this function sets the ** ^Unless it returns SQLITE_MISUSE, this function sets the
** [database connection] error code and message accessible via ** [database connection] error code and message accessible via
** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
 **  **
 ** A BLOB referenced by sqlite3_blob_open() may be read using the  ** A BLOB referenced by sqlite3_blob_open() may be read using the
 ** [sqlite3_blob_read()] interface and modified by using  ** [sqlite3_blob_read()] interface and modified by using
Line 6800  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 may be used to create a ** and the built-in [zeroblob] SQL function may be used to create a
 ** zero-filled blob to read or write using the incremental-blob interface.  ** zero-filled blob to read or write using the incremental-blob interface.
 **  **
 ** To avoid a resource leak, every open [BLOB handle] should eventually  ** To avoid a resource leak, every open [BLOB handle] should eventually
Line 6850  SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sql Line 7198  SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sql
 ** DESTRUCTOR: sqlite3_blob  ** DESTRUCTOR: sqlite3_blob
 **  **
 ** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed  ** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
** unconditionally.  Even if this routine returns an error code, the ** unconditionally.  Even if this routine returns an error code, the
 ** handle is still closed.)^  ** handle is still closed.)^
 **  **
 ** ^If the blob handle being closed was opened for read-write access, and if  ** ^If the blob handle being closed was opened for read-write access, and if
Line 6860  SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sql Line 7208  SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sql
 ** code is returned and the transaction rolled back.  ** code is returned and the transaction rolled back.
 **  **
 ** Calling this function with an argument that is not a NULL pointer or an  ** Calling this function with an argument that is not a NULL pointer or an
** open blob handle results in undefined behaviour. ^Calling this routine ** open blob handle results in undefined behaviour. ^Calling this routine
** with a null pointer (such as would be returned by a failed call to ** with a null pointer (such as would be returned by a failed call to
 ** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function  ** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
** is passed a valid open blob handle, the values returned by the ** is passed a valid open blob handle, the values returned by the
 ** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.  ** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
 */  */
 SQLITE_API int sqlite3_blob_close(sqlite3_blob *);  SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
Line 6872  SQLITE_API int sqlite3_blob_close(sqlite3_blob *); Line 7220  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  ** 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 6923  SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void  Line 7271  SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void 
 **  **
 ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.  ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
 ** Otherwise, an  [error code] or an [extended error code] is returned.)^  ** Otherwise, an  [error code] or an [extended error code] is returned.)^
** ^Unless SQLITE_MISUSE is returned, this function sets the ** ^Unless SQLITE_MISUSE is returned, this function sets the
** [database connection] error code and message accessible via ** [database connection] error code and message accessible via
** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. ** [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),
Line 6934  SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void  Line 7282  SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void 
 ** 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. The size of the ** [SQLITE_ERROR] is returned and no data is written. The size of the
** BLOB (and hence the maximum value of N+iOffset) can be determined ** BLOB (and hence the maximum value of N+iOffset) can be determined
** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less ** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
 ** than zero [SQLITE_ERROR] is returned and no data is written.  ** 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
Line 7030  SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); Line 7378  SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
 ** <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_OPEN  ** <li>  SQLITE_MUTEX_STATIC_OPEN
 ** <li>  SQLITE_MUTEX_STATIC_PRNG  ** <li>  SQLITE_MUTEX_STATIC_PRNG
Line 7088  SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); Line 7436  SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
 ** ^(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 ** sqlite3_mutex_try() as an optimization so this is acceptable
 ** behavior.)^  ** behavior.)^
 **  **
 ** ^The sqlite3_mutex_leave() routine exits a mutex that was  ** ^The sqlite3_mutex_leave() routine exits a mutex that was
Line 7153  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).
Line 7232  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() */
Line 7247  SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); Line 7595  SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
 #define SQLITE_MUTEX_STATIC_VFS2     12  /* For use by extension VFS */  #define SQLITE_MUTEX_STATIC_VFS2     12  /* For use by extension VFS */
 #define SQLITE_MUTEX_STATIC_VFS3     13  /* For use by application 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  ** 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 7278  SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); Line 7630  SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
 ** method becomes the return value of this routine.  ** method becomes the return value of this routine.
 **  **
 ** A few opcodes for [sqlite3_file_control()] are handled directly  ** A few opcodes for [sqlite3_file_control()] are handled directly
** by the SQLite core and never invoke the ** by the SQLite core and never invoke the
 ** sqlite3_io_methods.xFileControl method.  ** sqlite3_io_methods.xFileControl method.
 ** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes  ** ^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
Line 7335  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  /* NOT USED */  #define SQLITE_TESTCTRL_ISKEYWORD               16  /* NOT USED */
 #define SQLITE_TESTCTRL_SCRATCHMALLOC           17  /* NOT USED */  #define SQLITE_TESTCTRL_SCRATCHMALLOC           17  /* NOT USED */
Line 7358  SQLITE_API int sqlite3_test_control(int op, ...); Line 7710  SQLITE_API int sqlite3_test_control(int op, ...);
 #define SQLITE_TESTCTRL_IMPOSTER                25  #define SQLITE_TESTCTRL_IMPOSTER                25
 #define SQLITE_TESTCTRL_PARSER_COVERAGE         26  #define SQLITE_TESTCTRL_PARSER_COVERAGE         26
 #define SQLITE_TESTCTRL_RESULT_INTREAL          27  #define SQLITE_TESTCTRL_RESULT_INTREAL          27
#define SQLITE_TESTCTRL_LAST                    27  /* Largest TESTCTRL */#define SQLITE_TESTCTRL_PRNG_SEED               28
 #define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS     29
 #define SQLITE_TESTCTRL_LAST                    29  /* Largest TESTCTRL */
   
 /*  /*
 ** CAPI3REF: SQL Keyword Checking  ** CAPI3REF: SQL Keyword Checking
 **  **
** These routines provide access to the set of SQL language keywords ** These routines provide access to the set of SQL language keywords
 ** recognized by SQLite.  Applications can uses these routines to determine  ** recognized by SQLite.  Applications can uses these routines to determine
 ** whether or not a specific identifier needs to be escaped (for example,  ** whether or not a specific identifier needs to be escaped (for example,
 ** by enclosing in double-quotes) so as not to confuse the parser.  ** by enclosing in double-quotes) so as not to confuse the parser.
Line 7435  typedef struct sqlite3_str sqlite3_str; Line 7789  typedef struct sqlite3_str sqlite3_str;
 **  **
 ** ^The [sqlite3_str_new(D)] interface allocates and initializes  ** ^The [sqlite3_str_new(D)] interface allocates and initializes
 ** a new [sqlite3_str] object.  To avoid memory leaks, the object returned by  ** 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_new()] must be freed by a subsequent call to
 ** [sqlite3_str_finish(X)].  ** [sqlite3_str_finish(X)].
 **  **
 ** ^The [sqlite3_str_new(D)] interface always returns a pointer to a  ** ^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  ** valid [sqlite3_str] object, though in the event of an out-of-memory
 ** error the returned object might be a special singleton that will  ** error the returned object might be a special singleton that will
** silently reject new text, always return SQLITE_NOMEM from ** silently reject new text, always return SQLITE_NOMEM from
** [sqlite3_str_errcode()], always return 0 for ** [sqlite3_str_errcode()], always return 0 for
 ** [sqlite3_str_length()], and always return NULL from  ** [sqlite3_str_length()], and always return NULL from
 ** [sqlite3_str_finish(X)].  It is always safe to use the value  ** [sqlite3_str_finish(X)].  It is always safe to use the value
 ** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter  ** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter
Line 7478  SQLITE_API char *sqlite3_str_finish(sqlite3_str*); Line 7832  SQLITE_API char *sqlite3_str_finish(sqlite3_str*);
 ** These interfaces add content to an sqlite3_str object previously obtained  ** These interfaces add content to an sqlite3_str object previously obtained
 ** from [sqlite3_str_new()].  ** from [sqlite3_str_new()].
 **  **
** ^The [sqlite3_str_appendf(X,F,...)] and ** ^The [sqlite3_str_appendf(X,F,...)] and
 ** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf]  ** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf]
** functionality of SQLite to append formatted text onto the end of ** functionality of SQLite to append formatted text onto the end of
 ** [sqlite3_str] object X.  ** [sqlite3_str] object X.
 **  **
 ** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S  ** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S
Line 7497  SQLITE_API char *sqlite3_str_finish(sqlite3_str*); Line 7851  SQLITE_API char *sqlite3_str_finish(sqlite3_str*);
 ** ^This method can be used, for example, to add whitespace indentation.  ** ^This method can be used, for example, to add whitespace indentation.
 **  **
 ** ^The [sqlite3_str_reset(X)] method resets the string under construction  ** ^The [sqlite3_str_reset(X)] method resets the string under construction
** inside [sqlite3_str] object X back to zero bytes in length.  ** 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  ** 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  ** is recorded in the [sqlite3_str] object and can be recovered by a
Line 7599  SQLITE_API int sqlite3_status64( Line 7953  SQLITE_API int sqlite3_status64(
 ** <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 7608  SQLITE_API int sqlite3_status64( Line 7962  SQLITE_API int sqlite3_status64(
 **  **
 ** [[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 7624  SQLITE_API int sqlite3_status64( Line 7978  SQLITE_API int sqlite3_status64(
 **  **
 ** [[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>
Line 7638  SQLITE_API int sqlite3_status64( Line 7992  SQLITE_API int sqlite3_status64(
 ** <dd>No longer used.</dd>  ** <dd>No longer used.</dd>
 **  **
 ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>  ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
** <dd>The *pHighwater parameter records the deepest parser stack. ** <dd>The *pHighwater parameter records the deepest parser stack.
 ** The *pCurrent value is undefined.  The *pHighwater value is only  ** 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 7660  SQLITE_API int sqlite3_status64( Line 8014  SQLITE_API int sqlite3_status64(
 ** CAPI3REF: Database Connection Status  ** CAPI3REF: Database Connection Status
 ** METHOD: sqlite3  ** 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 7700  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 7725  SQLITE_API int sqlite3_db_status(sqlite3*, int op, int Line 8079  SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
 ** 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]] ** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]
 ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>  ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>
 ** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a  ** <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  ** pager cache is shared between two or more connections the bytes of heap
Line 7740  SQLITE_API int sqlite3_db_status(sqlite3*, int op, int Line 8094  SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
 ** [[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 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.
Line 7755  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>
 **  **
Line 7782  SQLITE_API int sqlite3_db_status(sqlite3*, int op, int Line 8136  SQLITE_API int sqlite3_db_status(sqlite3*, int op, int
 ** cache overflowing. Transactions are more efficient if they are written  ** cache overflowing. Transactions are more efficient if they are written
 ** to disk all at once. When pages spill mid-transaction, that introduces  ** to disk all at once. When pages spill mid-transaction, that introduces
 ** additional overhead. This parameter can be used help identify  ** additional overhead. This parameter can be used help identify
** inefficiencies that can be resolve by increasing the cache size.** inefficiencies that can be resolved by increasing the cache size.
 ** </dd>  ** </dd>
 **  **
 ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>  ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
Line 7819  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 7846  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 7864  SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int  Line 8218  SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int 
 ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>  ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
 ** <dd>^This is the number of virtual machine operations executed  ** <dd>^This is the number of virtual machine operations executed
 ** by the prepared statement if that number is less than or equal  ** by the prepared statement if that number is less than or equal
** to 2147483647.  The number of virtual machine operations can be ** to 2147483647.  The number of virtual machine operations can be
 ** used as a proxy for the total work done by the prepared statement.  ** used as a proxy for the total work done by the prepared statement.
 ** If the number of virtual machine operations exceeds 2147483647  ** If the number of virtual machine operations exceeds 2147483647
 ** then the value returned by this statement status code is undefined.  ** then the value returned by this statement status code is undefined.
 **  **
 ** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>  ** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
 ** <dd>^This is the number of times that the prepare statement has been  ** <dd>^This is the number of times that the prepare statement has been
** automatically regenerated due to schema changes or change to ** automatically regenerated due to schema changes or changes to
 ** [bound parameters] that might affect the query plan.  ** [bound parameters] that might affect the query plan.
 **  **
 ** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>  ** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>
Line 7931  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 7952  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 7983  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 7996  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 8011  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 8042  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 8055  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 8096  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 8141  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 8152  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 ** ^A call to sqlite3_backup_init() will fail, returning NULL, if
** there is already a read or read-write transaction open on the ** there is already a read or read-write transaction open on the
 ** destination database.  ** 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
Line 8193  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 8222  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 8231  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 8248  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 8299  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 8311  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 8340  SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup Line 8694  SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup
 ** ^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 8349  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 8370  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 8391  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 8432  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 8445  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 8536  SQLITE_API void sqlite3_log(int iErrCode, const char * Line 8890  SQLITE_API void sqlite3_log(int iErrCode, const char *
 ** ^The [sqlite3_wal_hook()] function is used to register a callback that  ** ^The [sqlite3_wal_hook()] function is used to register a callback that
 ** is invoked each time data is committed to a database in wal mode.  ** is invoked each time data is committed to a database in 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 8556  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
Line 8564  SQLITE_API void sqlite3_log(int iErrCode, const char * Line 8918  SQLITE_API void sqlite3_log(int iErrCode, const char *
 ** 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*
 );  );
Line 8577  SQLITE_API void *sqlite3_wal_hook( Line 8931  SQLITE_API void *sqlite3_wal_hook(
 ** [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 8607  SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, Line 8961  SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db,
 ** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to  ** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to
 ** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^  ** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^
 **  **
** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the ** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the
 ** [write-ahead log] for database X on [database connection] D to be  ** [write-ahead log] for database X on [database connection] D to be
 ** transferred into the database file and for the write-ahead log to  ** transferred into the database file and for the write-ahead log to
 ** be reset.  See the [checkpointing] documentation for addition  ** be reset.  See the [checkpointing] documentation for addition
Line 8633  SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, con Line 8987  SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, con
 **  **
 ** <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, then sync the database file if all frames **   readers or writers to finish, then sync the database file if all frames
 **   in the log were checkpointed. ^The [busy-handler callback]  **   in the log were checkpointed. ^The [busy-handler callback]
**   is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.  **   is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.
 **   ^On the other hand, passive mode might leave the checkpoint unfinished  **   ^On the other hand, passive mode might leave the checkpoint unfinished
 **   if there are concurrent readers or writers.  **   if there are concurrent readers or writers.
 **  **
Line 8650  SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, con Line 9004  SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, con
 **  **
 ** <dt>SQLITE_CHECKPOINT_RESTART<dd>  ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
 **   ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition  **   ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition
**   that after checkpointing the log file it blocks (calls the **   that after checkpointing the log file it blocks (calls the
 **   [busy-handler callback])  **   [busy-handler callback])
**   until all readers are reading from the database file only. ^This ensures **   until all readers are reading from the database file only. ^This ensures
 **   that the next writer will restart the log file from the beginning.  **   that the next writer will restart the log file from the beginning.
 **   ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new  **   ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new
 **   database writer attempts while it is pending, but does not impede readers.  **   database writer attempts while it is pending, but does not impede readers.
Line 8674  SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, con Line 9028  SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, con
 ** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero.  ** 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, RESTART and TRUNCATE modes also obtain the ** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the
 ** exclusive "writer" lock on the database file. ^If the writer lock cannot be  ** exclusive "writer" lock on the database file. ^If the writer lock cannot be
 ** obtained immediately, and a busy-handler is configured, it is invoked and  ** obtained immediately, and a busy-handler is configured, it is invoked and
 ** the writer lock retried until either the busy-handler returns 0 or the lock  ** the writer lock retried until either the busy-handler returns 0 or the lock
 ** is 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 [attached] to ** specified operation is attempted on all WAL databases [attached] to
 ** [database connection] db.  In this case the  ** [database connection] db.  In this case the
** values written to output parameters *pnLog and *pnCkpt are undefined. ^If ** values written to output parameters *pnLog and *pnCkpt are undefined. ^If
** an SQLITE_BUSY error is encountered when processing one or more of the ** an SQLITE_BUSY error is encountered when processing one or more of the
** attached WAL databases, the operation is still attempted on any remaining ** attached WAL databases, the operation is still attempted on any remaining
** attached databases and SQLITE_BUSY is returned at the end. ^If any other ** attached databases and SQLITE_BUSY is returned at the end. ^If any other
** error occurs while processing an attached database, processing is abandoned ** error occurs while processing an attached database, processing is abandoned
** and the error code is returned to the caller immediately. ^If no error ** and the error code is returned to the caller immediately. ^If no error
** (SQLITE_BUSY or otherwise) is encountered while processing the attached ** (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
Line 8746  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
Line 8761  SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, . Line 9121  SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, .
 **  **
 ** <dl>  ** <dl>
 ** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]]  ** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]]
** <dt>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 8775  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 8829  SQLITE_API int sqlite3_vtab_nochange(sqlite3_context*) Line 9211  SQLITE_API int sqlite3_vtab_nochange(sqlite3_context*)
 ** CAPI3REF: Determine The Collation For a Virtual Table Constraint  ** CAPI3REF: Determine The Collation For a Virtual Table Constraint
 **  **
 ** This function may only be called from within a call to the [xBestIndex]  ** This function may only be called from within a call to the [xBestIndex]
** method of a [virtual table]. ** method of a [virtual table].
 **  **
 ** The first argument must be the sqlite3_index_info object that is the  ** The first argument must be the sqlite3_index_info object that is the
 ** first parameter to the xBestIndex() method. The second argument must be  ** first parameter to the xBestIndex() method. The second argument must be
 ** an index into the aConstraint[] array belonging to the sqlite3_index_info  ** an index into the aConstraint[] array belonging to the sqlite3_index_info
** structure passed to xBestIndex. This function returns a pointer to a buffer ** structure passed to xBestIndex. This function returns a pointer to a buffer
 ** containing the name of the collation sequence for the corresponding  ** containing the name of the collation sequence for the corresponding
 ** constraint.  ** constraint.
 */  */
Line 8872  SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vta Line 9254  SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vta
 **  **
 ** <dl>  ** <dl>
 ** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>  ** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>
** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be** <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>  ** set to the total number of times that the X-th loop has run.</dd>
 **  **
 ** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>  ** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>
** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set** <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>  ** to the total number of rows examined by all iterations of the X-th loop.</dd>
 **  **
 ** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>  ** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
** <dd>^The "double" variable pointed to by the T parameter will be set to the** <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  ** 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,  ** 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  ** then this value will approximate the quotient NVISIT/NLOOP and the
Line 8888  SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vta Line 9270  SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vta
 ** be the NLOOP value for the current loop.  ** be the NLOOP value for the current loop.
 **  **
 ** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>  ** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
** <dd>^The "const char *" variable pointed to by the T parameter will be set** <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  ** to a zero-terminated UTF-8 string containing the name of the index or table
 ** used for the X-th loop.  ** used for the X-th loop.
 **  **
 ** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>  ** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
** <dd>^The "const char *" variable pointed to by the T parameter will be set** <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]  ** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]
 ** description for the X-th loop.  ** description for the X-th loop.
 **  **
 ** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt>  ** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt>
** <dd>^The "int" variable pointed to by the T parameter will be set to the** <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  ** "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.  ** 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  ** The select-id is the same value as is output in the first column
Line 8948  SQLITE_API int sqlite3_stmt_scanstatus( Line 9330  SQLITE_API int sqlite3_stmt_scanstatus(
   int idx,                  /* Index of loop to report on */    int idx,                  /* Index of loop to report on */
   int iScanStatusOp,        /* Information desired.  SQLITE_SCANSTAT_* */    int iScanStatusOp,        /* Information desired.  SQLITE_SCANSTAT_* */
   void *pOut                /* Result written here */    void *pOut                /* Result written here */
);     );
   
 /*  /*
 ** CAPI3REF: Zero Scan-Status Counters  ** CAPI3REF: Zero Scan-Status Counters
Line 8966  SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_ Line 9348  SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_
 **  **
 ** ^If a write-transaction is open on [database connection] D when the  ** ^If a write-transaction is open on [database connection] D when the
 ** [sqlite3_db_cacheflush(D)] interface invoked, any dirty  ** [sqlite3_db_cacheflush(D)] interface invoked, any dirty
** pages in the pager-cache that are not currently in use are written out ** 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  ** 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  ** 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)]  ** file (page 1 is always "in use").  ^The [sqlite3_db_cacheflush(D)]
 ** interface flushes caches for all schemas - "main", "temp", and  ** interface flushes caches for all schemas - "main", "temp", and
 ** any [attached] databases.  ** any [attached] databases.
 **  **
** ^If this function needs to obtain extra database locks before dirty pages ** ^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 ** 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  ** 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  ** 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  ** the database is skipped and an attempt made to flush any dirty pages
Line 9012  SQLITE_API int sqlite3_db_cacheflush(sqlite3*); Line 9394  SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
 **  **
 ** ^The preupdate hook only fires for changes to real database tables; the  ** ^The preupdate hook only fires for changes to real database tables; the
 ** preupdate hook is not invoked for changes to [virtual tables] or to  ** preupdate hook is not invoked for changes to [virtual tables] or to
** system tables like sqlite_master or sqlite_stat1.** system tables like sqlite_sequence or sqlite_stat1.
 **  **
 ** ^The second parameter to the preupdate callback is a pointer to  ** ^The second parameter to the preupdate callback is a pointer to
 ** the [database connection] that registered the preupdate hook.  ** the [database connection] that registered the preupdate hook.
Line 9021  SQLITE_API int sqlite3_db_cacheflush(sqlite3*); Line 9403  SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
 ** kind of update operation that is about to occur.  ** kind of update operation that is about to occur.
 ** ^(The fourth parameter to the preupdate callback is the name of the  ** ^(The fourth parameter to the preupdate callback is the name of the
 ** database within the database connection that is being modified.  This  ** database within the database connection that is being modified.  This
** will be "main" for the main database or "temp" for TEMP tables or ** 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  ** the name given after the AS keyword in the [ATTACH] statement for attached
 ** databases.)^  ** databases.)^
 ** ^The fifth parameter to the preupdate callback is the name of the  ** ^The fifth parameter to the preupdate callback is the name of the
 ** table that is being modified.  ** table that is being modified.
 **  **
 ** For an UPDATE or DELETE operation on a [rowid table], the sixth  ** For an UPDATE or DELETE operation on a [rowid table], the sixth
** parameter passed to the preupdate callback is the initial [rowid] of the ** 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,  ** 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 ** 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  ** 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  ** seventh parameter is the final rowid value of the row being inserted
 ** or updated. The value of the seventh parameter passed to the callback  ** or updated. The value of the seventh parameter passed to the callback
Line 9069  SQLITE_API int sqlite3_db_cacheflush(sqlite3*); Line 9451  SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
 **  **
 ** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate  ** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate
 ** callback was invoked as a result of a direct insert, update, or delete  ** 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 ** 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; or 2 for changes resulting from triggers called by top-level
 ** triggers; and so forth.  ** triggers; and so forth.
 **  **
Line 9103  SQLITE_API int sqlite3_preupdate_new(sqlite3 *, int, s Line 9485  SQLITE_API int sqlite3_preupdate_new(sqlite3 *, int, s
 ** The return value is OS-dependent.  For example, on unix systems, after  ** The return value is OS-dependent.  For example, on unix systems, after
 ** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be  ** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be
 ** called to get back the underlying "errno" that caused the problem, such  ** called to get back the underlying "errno" that caused the problem, such
** as ENOSPC, EAUTH, EISDIR, and so forth.  ** as ENOSPC, EAUTH, EISDIR, and so forth.
 */  */
 SQLITE_API int sqlite3_system_errno(sqlite3*);  SQLITE_API int sqlite3_system_errno(sqlite3*);
   
Line 9141  typedef struct sqlite3_snapshot { Line 9523  typedef struct sqlite3_snapshot {
 ** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly  ** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly
 ** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.  ** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.
 ** If there is not already a read-transaction open on schema S when  ** If there is not already a read-transaction open on schema S when
** this function is called, one is opened automatically. ** this function is called, one is opened automatically.
 **  **
 ** The following must be true for this function to succeed. If any of  ** The following must be true for this function to succeed. If any of
 ** the following statements are false when sqlite3_snapshot_get() is  ** the following statements are false when sqlite3_snapshot_get() is
 ** called, SQLITE_ERROR is returned. The final value of *P is undefined  ** called, SQLITE_ERROR is returned. The final value of *P is undefined
** in this case. ** in this case.
 **  **
 ** <ul>  ** <ul>
 **   <li> The database handle must not be in [autocommit mode].  **   <li> The database handle must not be in [autocommit mode].
Line 9158  typedef struct sqlite3_snapshot { Line 9540  typedef struct sqlite3_snapshot {
 **  **
 **   <li> One or more transactions must have been written to the current wal  **   <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  **        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 **        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  **        file immediately after it is first opened. At least one transaction
 **        must be written to it first.  **        must be written to it first.
 ** </ul>  ** </ul>
 **  **
 ** This function may also return SQLITE_NOMEM.  If it is called with the  ** This function may also return SQLITE_NOMEM.  If it is called with the
** database handle in autocommit mode but fails for some other reason, ** database handle in autocommit mode but fails for some other reason,
 ** whether or not a read transaction is opened on schema S is undefined.  ** whether or not a read transaction is opened on schema S is undefined.
 **  **
 ** The [sqlite3_snapshot] object returned from a successful call to  ** The [sqlite3_snapshot] object returned from a successful call to
Line 9184  SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_ge Line 9566  SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_ge
 ** CAPI3REF: Start a read transaction on an historical snapshot  ** CAPI3REF: Start a read transaction on an historical snapshot
 ** METHOD: sqlite3_snapshot  ** METHOD: sqlite3_snapshot
 **  **
** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read ** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read
** transaction or upgrades an existing one for schema S of ** transaction or upgrades an existing one for schema S of
** [database connection] D such that the read transaction refers to ** [database connection] D such that the read transaction refers to
** historical [snapshot] P, rather than the most recent change to the ** historical [snapshot] P, rather than the most recent change to the
** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK ** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK
 ** on success or an appropriate [error code] if it fails.  ** on success or an appropriate [error code] if it fails.
 **  **
** ^In order to succeed, the database connection must not be in ** ^In order to succeed, the database connection must not be in
 ** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there  ** [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  ** is already a read transaction open on schema S, then the database handle
 ** must have no active statements (SELECT statements that have been passed  ** must have no active statements (SELECT statements that have been passed
** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()). ** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()).
 ** SQLITE_ERROR is returned if either of these conditions is violated, or  ** 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.  ** 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  ** ^A call to sqlite3_snapshot_open() will fail to open if the specified
** snapshot has been overwritten by a [checkpoint]. In this case ** snapshot has been overwritten by a [checkpoint]. In this case
 ** SQLITE_ERROR_SNAPSHOT is returned.  ** SQLITE_ERROR_SNAPSHOT is returned.
 **  **
** If there is already a read transaction open when this function is ** If there is already a read transaction open when this function is
 ** invoked, then the same read transaction remains open (on the same  ** invoked, then the same read transaction remains open (on the same
 ** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT  ** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT
 ** is returned. If another error code - for example SQLITE_PROTOCOL or an  ** is returned. If another error code - for example SQLITE_PROTOCOL or an
 ** SQLITE_IOERR error code - is returned, then the final state of the  ** 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 undefined. If SQLITE_OK is returned, then the
 ** read transaction is now open on database snapshot P.  ** read transaction is now open on database snapshot P.
 **  **
 ** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the  ** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the
 ** database connection D does not know that the database file for  ** database connection D does not know that the database file for
 ** schema S is in [WAL mode].  A database connection might not know  ** 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  ** 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] ** I/O on that database connection, or if the database entered [WAL mode]
 ** after the most recent I/O on the database connection.)^  ** after the most recent I/O on the database connection.)^
 ** (Hint: Run "[PRAGMA application_id]" against a newly opened  ** (Hint: Run "[PRAGMA application_id]" against a newly opened
 ** database connection in order to make it ready to use snapshots.)  ** database connection in order to make it ready to use snapshots.)
Line 9247  SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_f Line 9629  SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_f
 ** METHOD: sqlite3_snapshot  ** METHOD: sqlite3_snapshot
 **  **
 ** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages  ** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages
** of two valid snapshot handles. ** of two valid snapshot handles.
 **  **
** If the two snapshot handles are not associated with the same database ** If the two snapshot handles are not associated with the same database
** file, the result of the comparison is undefined. ** file, the result of the comparison is undefined.
 **  **
 ** Additionally, the result of the comparison is only valid if both of the  ** Additionally, the result of the comparison is only valid if both of the
 ** snapshot handles were obtained by calling sqlite3_snapshot_get() since 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  ** 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  ** 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 ** clients drops to zero. If either snapshot handle was obtained before the
** wal file was last deleted, the value returned by this function ** wal file was last deleted, the value returned by this function
 ** is undefined.  ** is undefined.
 **  **
 ** Otherwise, this API returns a negative value if P1 refers to an older  ** Otherwise, this API returns a negative value if P1 refers to an older
Line 9322  SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_re Line 9704  SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_re
 ** representation of the database will usually only exist if there has  ** representation of the database will usually only exist if there has
 ** been a prior call to [sqlite3_deserialize(D,S,...)] with the same  ** been a prior call to [sqlite3_deserialize(D,S,...)] with the same
 ** values of D and S.  ** values of D and S.
** The size of the database is written into *P even if the ** The size of the database is written into *P even if the
 ** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy  ** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy
 ** of the database exists.  ** of the database exists.
 **  **
Line 9359  SQLITE_API unsigned char *sqlite3_serialize( Line 9741  SQLITE_API unsigned char *sqlite3_serialize(
 /*  /*
 ** CAPI3REF: Deserialize a database  ** CAPI3REF: Deserialize a database
 **  **
** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the ** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the
 ** [database connection] D to disconnect from database S and then  ** [database connection] D to disconnect from database S and then
 ** reopen S as an in-memory database based on the serialization contained  ** 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  ** in P.  The serialized database P is N bytes in size.  M is the size of
Line 9378  SQLITE_API unsigned char *sqlite3_serialize( Line 9760  SQLITE_API unsigned char *sqlite3_serialize(
 ** database is currently in a read transaction or is involved in a backup  ** database is currently in a read transaction or is involved in a backup
 ** operation.  ** operation.
 **  **
** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the ** 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  ** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then
 ** [sqlite3_free()] is invoked on argument P prior to returning.  ** [sqlite3_free()] is invoked on argument P prior to returning.
 **  **
Line 9493  struct sqlite3_rtree_geometry { Line 9875  struct sqlite3_rtree_geometry {
 };  };
   
 /*  /*
** Register a 2nd-generation geometry callback named zScore that can be ** Register a 2nd-generation geometry callback named zScore that can be
 ** used as part of an R-Tree geometry query as follows:  ** used as part of an R-Tree geometry query as follows:
 **  **
 **   SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)  **   SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)
Line 9508  SQLITE_API int sqlite3_rtree_query_callback( Line 9890  SQLITE_API int sqlite3_rtree_query_callback(
   
   
 /*  /*
** A pointer to a structure of the following type is passed as the ** A pointer to a structure of the following type is passed as the
 ** argument to scored geometry callback registered using  ** argument to scored geometry callback registered using
 ** sqlite3_rtree_query_callback().  ** sqlite3_rtree_query_callback().
 **  **
Line 9603  typedef struct sqlite3_changeset_iter sqlite3_changese Line 9985  typedef struct sqlite3_changeset_iter sqlite3_changese
 ** is not possible for an application to register a pre-update hook on a  ** 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  ** 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  ** 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 ** which a pre-update hook is already defined. The results of attempting
 ** either of these things are undefined.  ** either of these things are undefined.
 **  **
 ** The session object will be used to create changesets for tables in  ** The session object will be used to create changesets for tables in
Line 9621  SQLITE_API int sqlite3session_create( Line 10003  SQLITE_API int sqlite3session_create(
 ** CAPI3REF: Delete A Session Object  ** CAPI3REF: Delete A Session Object
 ** DESTRUCTOR: sqlite3_session  ** DESTRUCTOR: sqlite3_session
 **  **
** Delete a session object previously allocated using ** Delete a session object previously allocated using
 ** [sqlite3session_create()]. Once a session object has been deleted, the  ** [sqlite3session_create()]. Once a session object has been deleted, the
 ** results of attempting to use pSession with any other session module  ** results of attempting to use pSession with any other session module
 ** function are undefined.  ** function are undefined.
 **  **
 ** Session objects must be deleted before the database handle to which they  ** Session objects must be deleted before the database handle to which they
** are attached is closed. Refer to the documentation for ** are attached is closed. Refer to the documentation for
 ** [sqlite3session_create()] for details.  ** [sqlite3session_create()] for details.
 */  */
 SQLITE_API void sqlite3session_delete(sqlite3_session *pSession);  SQLITE_API void sqlite3session_delete(sqlite3_session *pSession);
Line 9645  SQLITE_API void sqlite3session_delete(sqlite3_session  Line 10027  SQLITE_API void sqlite3session_delete(sqlite3_session 
 ** the eventual changesets.  ** the eventual changesets.
 **  **
 ** Passing zero to this function disables the session. Passing a value  ** Passing zero to this function disables the session. Passing a value
** greater than zero enables it. Passing a value less than zero is a ** 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.  ** 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 return value indicates the final state of the session object: 0 if
 ** the session is disabled, or 1 if it is enabled.  ** the session is disabled, or 1 if it is enabled.
 */  */
 SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);  SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);
Line 9663  SQLITE_API int sqlite3session_enable(sqlite3_session * Line 10045  SQLITE_API int sqlite3session_enable(sqlite3_session *
 ** <ul>  ** <ul>
 **   <li> The session object "indirect" flag is set when the change is  **   <li> The session object "indirect" flag is set when the change is
 **        made, or  **        made, or
**   <li> The change is made by an SQL trigger or foreign key action **   <li> The change is made by an SQL trigger or foreign key action
 **        instead of directly as a result of a users SQL statement.  **        instead of directly as a result of a users SQL statement.
 ** </ul>  ** </ul>
 **  **
Line 9675  SQLITE_API int sqlite3session_enable(sqlite3_session * Line 10057  SQLITE_API int sqlite3session_enable(sqlite3_session *
 ** flag.  If the second argument passed to this function is zero, then the  ** 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  ** 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  ** 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 ** of the indirect flag, and may be used to query the current state of the
 ** indirect flag for the specified session object.  ** indirect flag for the specified session object.
 **  **
** The return value indicates the final state of the indirect flag: 0 if ** The return value indicates the final state of the indirect flag: 0 if
 ** it is clear, or 1 if it is set.  ** it is clear, or 1 if it is set.
 */  */
 SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);  SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);
Line 9688  SQLITE_API int sqlite3session_indirect(sqlite3_session Line 10070  SQLITE_API int sqlite3session_indirect(sqlite3_session
 ** METHOD: sqlite3_session  ** METHOD: sqlite3_session
 **  **
 ** If argument zTab is not NULL, then it is the name of a table to attach  ** 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 ** 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 ** made to the table while the session object is enabled will be recorded. See
 ** documentation for [sqlite3session_changeset()] for further details.  ** documentation for [sqlite3session_changeset()] for further details.
 **  **
 ** Or, if argument zTab is NULL, then changes are recorded for all tables  ** 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 ** in the database. If additional tables are added to the database (by
** executing "CREATE TABLE" statements) after this call is made, changes for ** executing "CREATE TABLE" statements) after this call is made, changes for
 ** the new tables are also recorded.  ** the new tables are also recorded.
 **  **
 ** Changes can only be recorded for tables that have a PRIMARY KEY explicitly  ** 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 ** 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  ** 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.  ** 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  ** 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,  ** 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.  ** no changes will be recorded in either of these scenarios.
Line 9709  SQLITE_API int sqlite3session_indirect(sqlite3_session Line 10091  SQLITE_API int sqlite3session_indirect(sqlite3_session
 ** Changes are not recorded for individual rows that have NULL values stored  ** Changes are not recorded for individual rows that have NULL values stored
 ** in one or more of their PRIMARY KEY columns.  ** in one or more of their PRIMARY KEY columns.
 **  **
** SQLITE_OK is returned if the call completes without error. Or, if an error ** 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.  ** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
 **  **
 ** <h3>Special sqlite_stat1 Handling</h3>  ** <h3>Special sqlite_stat1 Handling</h3>
 **  **
** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to ** 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:  ** some of the rules above. In SQLite, the schema of sqlite_stat1 is:
 **  <pre>  **  <pre>
**  &nbsp;     CREATE TABLE sqlite_stat1(tbl,idx,stat)  **  &nbsp;     CREATE TABLE sqlite_stat1(tbl,idx,stat)
 **  </pre>  **  </pre>
 **  **
** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are ** 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 ** 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  ** 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  ** 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  ** patchset instead of a NULL value. This allows such changesets to be
 ** manipulated by legacy implementations of sqlite3changeset_invert(),  ** manipulated by legacy implementations of sqlite3changeset_invert(),
 ** concat() and similar.  ** concat() and similar.
 **  **
** The sqlite3changeset_apply() function automatically converts the ** The sqlite3changeset_apply() function automatically converts the
 ** zero-length blob back to a NULL value when updating the sqlite_stat1  ** zero-length blob back to a NULL value when updating the sqlite_stat1
 ** table. However, if the application calls sqlite3changeset_new(),  ** table. However, if the application calls sqlite3changeset_new(),
** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset ** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset
 ** iterator directly (including on a changeset iterator passed to a  ** iterator directly (including on a changeset iterator passed to a
 ** conflict-handler callback) then the X'' value is returned. The application  ** conflict-handler callback) then the X'' value is returned. The application
 ** must translate X'' to NULL itself if required.  ** must translate X'' to NULL itself if required.
Line 9750  SQLITE_API int sqlite3session_attach( Line 10132  SQLITE_API int sqlite3session_attach(
 ** CAPI3REF: Set a table filter on a Session Object.  ** CAPI3REF: Set a table filter on a Session Object.
 ** METHOD: sqlite3_session  ** METHOD: sqlite3_session
 **  **
** The second argument (xFilter) is the "filter callback". For changes to rows ** 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  ** 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. ** to determine whether changes to the table's rows should be tracked or not.
** If xFilter returns 0, changes is not tracked. Note that once a table is ** If xFilter returns 0, changes are not tracked. Note that once a table is
 ** attached, xFilter will not be called again.  ** attached, xFilter will not be called again.
 */  */
 SQLITE_API void sqlite3session_table_filter(  SQLITE_API void sqlite3session_table_filter(
Line 9769  SQLITE_API void sqlite3session_table_filter( Line 10151  SQLITE_API void sqlite3session_table_filter(
 ** CAPI3REF: Generate A Changeset From A Session Object  ** CAPI3REF: Generate A Changeset From A Session Object
 ** METHOD: sqlite3_session  ** METHOD: sqlite3_session
 **  **
** Obtain a changeset containing changes to the tables attached to the ** Obtain a changeset containing changes to the tables attached to the
** session object passed as the first argument. If successful, ** session object passed as the first argument. If successful,
** set *ppChangeset to point to a buffer containing the changeset ** set *ppChangeset to point to a buffer containing the changeset
 ** and *pnChangeset to the size of the changeset in bytes before returning  ** and *pnChangeset to the size of the changeset in bytes before returning
 ** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to  ** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to
 ** zero and return an SQLite error code.  ** zero and return an SQLite error code.
Line 9786  SQLITE_API void sqlite3session_table_filter( Line 10168  SQLITE_API void sqlite3session_table_filter(
 ** modifies the values of primary key columns. If such a change is made, it  ** 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.  ** 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 ** 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,  ** 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  ** no corresponding change is present in the changesets returned by this
 ** function. If an existing row with one or more NULL values stored in  ** function. If an existing row with one or more NULL values stored in
Line 9839  SQLITE_API void sqlite3session_table_filter( Line 10221  SQLITE_API void sqlite3session_table_filter(
 ** <ul>  ** <ul>
 **   <li> For each record generated by an insert, the database is queried  **   <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  **        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 **        change is added to the changeset. If no such row is found, no change
 **        is added to the changeset.  **        is added to the changeset.
 **  **
**   <li> For each record generated by an update or delete, the database is **   <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  **        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  **        found and one or more of the non-primary key fields have been
**        modified from their original values, an UPDATE change is added to **        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 **        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  **        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  **        primary key in the database, but all fields contain their original
 **        values, no change is added to the changeset.  **        values, no change is added to the changeset.
Line 9854  SQLITE_API void sqlite3session_table_filter( Line 10236  SQLITE_API void sqlite3session_table_filter(
 **  **
 ** This means, amongst other things, that if a row is inserted and then later  ** 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  ** 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 ** 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  ** row with the same primary key values inserted while a session object is
 ** active, the resulting changeset will contain an UPDATE change instead of  ** active, the resulting changeset will contain an UPDATE change instead of
 ** a DELETE and an INSERT.  ** a DELETE and an INSERT.
Line 9863  SQLITE_API void sqlite3session_table_filter( Line 10245  SQLITE_API void sqlite3session_table_filter(
 ** it does not accumulate records when rows are inserted, updated or deleted.  ** 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  ** 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 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 ** 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  ** 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.  ** 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 ** 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  ** 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.  ** resulting changeset will contain an UPDATE change that updates both fields.
 */  */
Line 9887  SQLITE_API int sqlite3session_changeset( Line 10269  SQLITE_API int sqlite3session_changeset(
 ** an error).  ** an error).
 **  **
 ** Argument zFromDb must be the name of a database ("main", "temp" etc.)  ** Argument zFromDb must be the name of a database ("main", "temp" etc.)
** attached to the same database handle as the session object that contains ** 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 compatible with the table attached to the session by this function.
 ** A table is considered compatible if it:  ** A table is considered compatible if it:
 **  **
Line 9903  SQLITE_API int sqlite3session_changeset( Line 10285  SQLITE_API int sqlite3session_changeset(
 ** APIs, tables without PRIMARY KEYs are simply ignored.  ** APIs, tables without PRIMARY KEYs are simply ignored.
 **  **
 ** This function adds a set of changes to the session object that could be  ** 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") ** 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 ** so that its content is the same as the table attached to the session
 ** object (call this the "to-table"). Specifically:  ** object (call this the "to-table"). Specifically:
 **  **
 ** <ul>  ** <ul>
**   <li> For each row (primary key) that exists in the to-table but not in **   <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.  **     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 **   <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.  **     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 **   <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  **     different non-PK values in each, an UPDATE record is added to the
**     session.  **     session.
 ** </ul>  ** </ul>
 **  **
 ** To clarify, if this function is called and then a changeset constructed  ** To clarify, if this function is called and then a changeset constructed
** using [sqlite3session_changeset()], then after applying that changeset to ** using [sqlite3session_changeset()], then after applying that changeset to
** database zFrom the contents of the two compatible tables would be ** database zFrom the contents of the two compatible tables would be
 ** identical.  ** identical.
 **  **
 ** It an error if database zFrom does not exist or does not contain the  ** It an error if database zFrom does not exist or does not contain the
 ** required compatible table.  ** required compatible table.
 **  **
** If the operation successful, SQLITE_OK is returned. Otherwise, an SQLite** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite
 ** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg  ** 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 ** 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  ** message. It is the responsibility of the caller to free this buffer using
 ** sqlite3_free().  ** sqlite3_free().
 */  */
Line 9948  SQLITE_API int sqlite3session_diff( Line 10330  SQLITE_API int sqlite3session_diff(
 ** The differences between a patchset and a changeset are that:  ** The differences between a patchset and a changeset are that:
 **  **
 ** <ul>  ** <ul>
**   <li> DELETE records consist of the primary key fields only. The **   <li> DELETE records consist of the primary key fields only. The
 **        original values of other fields are omitted.  **        original values of other fields are omitted.
**   <li> The original values of any modified fields are omitted from **   <li> The original values of any modified fields are omitted from
 **        UPDATE records.  **        UPDATE records.
 ** </ul>  ** </ul>
 **  **
** A patchset blob may be used with up to date versions of all ** A patchset blob may be used with up to date versions of all
** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(), ** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(),
 ** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,  ** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,
 ** attempting to use a patchset blob with old versions of the  ** attempting to use a patchset blob with old versions of the
** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error. ** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error.
 **  **
** Because the non-primary key "old.*" fields are omitted, no ** Because the non-primary key "old.*" fields are omitted, no
 ** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset  ** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset
 ** is passed to the sqlite3changeset_apply() API. Other conflict types work  ** is passed to the sqlite3changeset_apply() API. Other conflict types work
 ** in the same way as for changesets.  ** in the same way as for changesets.
Line 9979  SQLITE_API int sqlite3session_patchset( Line 10361  SQLITE_API int sqlite3session_patchset(
 /*  /*
 ** CAPI3REF: Test if a changeset has recorded any changes.  ** CAPI3REF: Test if a changeset has recorded any changes.
 **  **
** Return non-zero if no changes to attached tables have been recorded by ** 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 ** the session object passed as the first argument. Otherwise, if one or
 ** more changes have been recorded, return zero.  ** more changes have been recorded, return zero.
 **  **
 ** Even if this function returns zero, it is possible that calling  ** Even if this function returns zero, it is possible that calling
 ** [sqlite3session_changeset()] on the session handle may still return a  ** [sqlite3session_changeset()] on the session handle may still return a
** changeset that contains no changes. This can happen when a row in ** changeset that contains no changes. This can happen when a row in
** an attached table is modified and then later on the original values ** an attached table is modified and then later on the original values
 ** are restored. However, if this function returns non-zero, then it is  ** are restored. However, if this function returns non-zero, then it is
** guaranteed that a call to sqlite3session_changeset() will return a ** guaranteed that a call to sqlite3session_changeset() will return a
 ** changeset containing zero changes.  ** changeset containing zero changes.
 */  */
 SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession);  SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession);
   
 /*  /*
** CAPI3REF: Create An Iterator To Traverse A Changeset ** CAPI3REF: Create An Iterator To Traverse A Changeset
 ** CONSTRUCTOR: sqlite3_changeset_iter  ** CONSTRUCTOR: sqlite3_changeset_iter
 **  **
 ** Create an iterator used to iterate through the contents of a changeset.  ** Create an iterator used to iterate through the contents of a changeset.
Line 10002  SQLITE_API int sqlite3session_isempty(sqlite3_session  Line 10384  SQLITE_API int sqlite3session_isempty(sqlite3_session 
 ** is returned. Otherwise, if an error occurs, *pp is set to zero and an  ** is returned. Otherwise, if an error occurs, *pp is set to zero and an
 ** SQLite error code is returned.  ** SQLite error code is returned.
 **  **
** The following functions can be used to advance and query a changeset ** The following functions can be used to advance and query a changeset
 ** iterator created by this function:  ** iterator created by this function:
 **  **
 ** <ul>  ** <ul>
Line 10019  SQLITE_API int sqlite3session_isempty(sqlite3_session  Line 10401  SQLITE_API int sqlite3session_isempty(sqlite3_session 
 **  **
 ** Assuming the changeset blob was created by one of the  ** Assuming the changeset blob was created by one of the
 ** [sqlite3session_changeset()], [sqlite3changeset_concat()] or  ** [sqlite3session_changeset()], [sqlite3changeset_concat()] or
** [sqlite3changeset_invert()] functions, all changes within the changeset ** [sqlite3changeset_invert()] functions, all changes within the changeset
** that apply to a single table are grouped together. This means that when ** that apply to a single table are grouped together. This means that when
** an application iterates through a changeset using an iterator created by ** an application iterates through a changeset using an iterator created by
** this function, all changes that relate to a single table are visited ** this function, all changes that relate to a single table are visited
** consecutively. There is no chance that the iterator will visit a change ** 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 ** the applies to table X, then one for table Y, and then later on visit
 ** another change for table X.  ** another change for table X.
 **  **
 ** The behavior of sqlite3changeset_start_v2() and its streaming equivalent  ** The behavior of sqlite3changeset_start_v2() and its streaming equivalent
Line 10064  SQLITE_API int sqlite3changeset_start_v2( Line 10446  SQLITE_API int sqlite3changeset_start_v2(
 ** CAPI3REF: Advance A Changeset Iterator  ** CAPI3REF: Advance A Changeset Iterator
 ** METHOD: sqlite3_changeset_iter  ** METHOD: sqlite3_changeset_iter
 **  **
** This function may only be used with iterators created by function** This function may only be used with iterators created by the function
 ** [sqlite3changeset_start()]. If it is called on an iterator passed to  ** [sqlite3changeset_start()]. If it is called on an iterator passed to
 ** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE  ** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE
 ** is returned and the call has no effect.  ** is returned and the call has no effect.
Line 10075  SQLITE_API int sqlite3changeset_start_v2( Line 10457  SQLITE_API int sqlite3changeset_start_v2(
 ** point to the first change in the changeset. Each subsequent call advances  ** 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  ** 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  ** no error occurs and the iterator points to a valid change after a call
** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned. ** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.
 ** Otherwise, if all changes in the changeset have already been visited,  ** Otherwise, if all changes in the changeset have already been visited,
 ** SQLITE_DONE is returned.  ** SQLITE_DONE is returned.
 **  **
** If an error occurs, an SQLite error code is returned. Possible error ** If an error occurs, an SQLite error code is returned. Possible error
** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or ** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or
 ** SQLITE_NOMEM.  ** SQLITE_NOMEM.
 */  */
 SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter);  SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter);
Line 10098  SQLITE_API int sqlite3changeset_next(sqlite3_changeset Line 10480  SQLITE_API int sqlite3changeset_next(sqlite3_changeset
 ** If argument pzTab is not NULL, then *pzTab is set to point to a  ** 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  ** nul-terminated utf-8 encoded string containing the name of the table
 ** affected by the current change. The buffer remains valid until either  ** affected by the current change. The buffer remains valid until either
** sqlite3changeset_next() is called on the iterator or until the ** sqlite3changeset_next() is called on the iterator or until the
** conflict-handler function returns. If pnCol is not NULL, then *pnCol is ** 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  ** 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  ** 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  ** is an indirect change, or false (0) otherwise. See the documentation for
 ** [sqlite3session_indirect()] for a description of direct and indirect  ** [sqlite3session_indirect()] for a description of direct and indirect
** changes. Finally, if pOp is not NULL, then *pOp is set to one of ** changes. Finally, if pOp is not NULL, then *pOp is set to one of
** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the ** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the
 ** type of change that the iterator currently points to.  ** type of change that the iterator currently points to.
 **  **
 ** If no error occurs, SQLITE_OK is returned. If an error does occur, an  ** If no error occurs, SQLITE_OK is returned. If an error does occur, an
Line 10159  SQLITE_API int sqlite3changeset_pk( Line 10541  SQLITE_API int sqlite3changeset_pk(
 ** The pIter argument passed to this function may either be an iterator  ** The pIter argument passed to this function may either be an iterator
 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator  ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
 ** created by [sqlite3changeset_start()]. In the latter case, the most recent  ** created by [sqlite3changeset_start()]. In the latter case, the most recent
** call to [sqlite3changeset_next()] must have returned SQLITE_ROW. ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
 ** Furthermore, it may only be called if the type of change that the iterator  ** 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,  ** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise,
 ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.  ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
Line 10169  SQLITE_API int sqlite3changeset_pk( Line 10551  SQLITE_API int sqlite3changeset_pk(
 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.  ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
 **  **
 ** If successful, this function sets *ppValue to point to a protected  ** If successful, this function sets *ppValue to point to a protected
** sqlite3_value object containing the iVal'th value from the vector of ** 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  ** 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 ** 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.  ** 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  ** If some other error occurs (e.g. an OOM condition), an SQLite error code
Line 10190  SQLITE_API int sqlite3changeset_old( Line 10572  SQLITE_API int sqlite3changeset_old(
 ** The pIter argument passed to this function may either be an iterator  ** The pIter argument passed to this function may either be an iterator
 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator  ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
 ** created by [sqlite3changeset_start()]. In the latter case, the most recent  ** created by [sqlite3changeset_start()]. In the latter case, the most recent
** call to [sqlite3changeset_next()] must have returned SQLITE_ROW. ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
 ** Furthermore, it may only be called if the type of change that the iterator  ** 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,  ** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise,
 ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.  ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
Line 10200  SQLITE_API int sqlite3changeset_old( Line 10582  SQLITE_API int sqlite3changeset_old(
 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.  ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
 **  **
 ** If successful, this function sets *ppValue to point to a protected  ** If successful, this function sets *ppValue to point to a protected
** sqlite3_value object containing the iVal'th value from the vector of ** 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  ** 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  ** 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 ** 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 ** 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 ** this is similar to the "new.*" columns available to update or delete
 ** triggers.  ** triggers.
 **  **
 ** If some other error occurs (e.g. an OOM condition), an SQLite error code  ** If some other error occurs (e.g. an OOM condition), an SQLite error code
Line 10232  SQLITE_API int sqlite3changeset_new( Line 10614  SQLITE_API int sqlite3changeset_new(
 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.  ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
 **  **
 ** If successful, this function sets *ppValue to point to a protected  ** If successful, this function sets *ppValue to point to a protected
** sqlite3_value object containing the iVal'th value from the ** sqlite3_value object containing the iVal'th value from the
 ** "conflicting row" associated with the current conflict-handler callback  ** "conflicting row" associated with the current conflict-handler callback
 ** and returns SQLITE_OK.  ** and returns SQLITE_OK.
 **  **
Line 10276  SQLITE_API int sqlite3changeset_fk_conflicts( Line 10658  SQLITE_API int sqlite3changeset_fk_conflicts(
 ** call has no effect.  ** call has no effect.
 **  **
 ** If an error was encountered within a call to an sqlite3changeset_xxx()  ** If an error was encountered within a call to an sqlite3changeset_xxx()
** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an ** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an
 ** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding  ** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding
 ** to that error is returned by this function. Otherwise, SQLITE_OK is  ** to that error is returned by this function. Otherwise, SQLITE_OK is
 ** returned. This is to allow the following pattern (pseudo-code):  ** returned. This is to allow the following pattern (pseudo-code):
Line 10288  SQLITE_API int sqlite3changeset_fk_conflicts( Line 10670  SQLITE_API int sqlite3changeset_fk_conflicts(
 **   }  **   }
 **   rc = sqlite3changeset_finalize();  **   rc = sqlite3changeset_finalize();
 **   if( rc!=SQLITE_OK ){  **   if( rc!=SQLITE_OK ){
**     // An error has occurred **     // An error has occurred
 **   }  **   }
 ** </pre>  ** </pre>
 */  */
Line 10316  SQLITE_API int sqlite3changeset_finalize(sqlite3_chang Line 10698  SQLITE_API int sqlite3changeset_finalize(sqlite3_chang
 ** zeroed and an SQLite error code returned.  ** zeroed and an SQLite error code returned.
 **  **
 ** It is the responsibility of the caller to eventually call sqlite3_free()  ** It is the responsibility of the caller to eventually call sqlite3_free()
** on the *ppOut pointer to free the buffer allocation following a successful ** on the *ppOut pointer to free the buffer allocation following a successful
 ** call to this function.  ** call to this function.
 **  **
 ** WARNING/TODO: This function currently assumes that the input is a valid  ** WARNING/TODO: This function currently assumes that the input is a valid
Line 10330  SQLITE_API int sqlite3changeset_invert( Line 10712  SQLITE_API int sqlite3changeset_invert(
 /*  /*
 ** CAPI3REF: Concatenate Two Changeset Objects  ** CAPI3REF: Concatenate Two Changeset Objects
 **  **
** This function is used to concatenate two changesets, A and B, into a ** This function is used to concatenate two changesets, A and B, into a
 ** single changeset. The result is a changeset equivalent to applying  ** single changeset. The result is a changeset equivalent to applying
** changeset A followed by changeset B. ** changeset A followed by changeset B.
 **  **
** This function combines the two input changesets using an ** This function combines the two input changesets using an
 ** sqlite3_changegroup object. Calling it produces similar results as the  ** sqlite3_changegroup object. Calling it produces similar results as the
 ** following code fragment:  ** following code fragment:
 **  **
Line 10366  SQLITE_API int sqlite3changeset_concat( Line 10748  SQLITE_API int sqlite3changeset_concat(
 /*  /*
 ** CAPI3REF: Changegroup Handle  ** CAPI3REF: Changegroup Handle
 **  **
** A changegroup is an object used to combine two or more ** A changegroup is an object used to combine two or more
 ** [changesets] or [patchsets]  ** [changesets] or [patchsets]
 */  */
 typedef struct sqlite3_changegroup sqlite3_changegroup;  typedef struct sqlite3_changegroup sqlite3_changegroup;
Line 10382  typedef struct sqlite3_changegroup sqlite3_changegroup Line 10764  typedef struct sqlite3_changegroup sqlite3_changegroup
 **  **
 ** If successful, this function returns SQLITE_OK and populates (*pp) with  ** If successful, this function returns SQLITE_OK and populates (*pp) with
 ** a pointer to a new sqlite3_changegroup object before returning. The caller  ** a pointer to a new sqlite3_changegroup object before returning. The caller
** should eventually free the returned object using a call to ** should eventually free the returned object using a call to
 ** sqlite3changegroup_delete(). If an error occurs, an SQLite error code  ** sqlite3changegroup_delete(). If an error occurs, an SQLite error code
 ** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.  ** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.
 **  **
Line 10394  typedef struct sqlite3_changegroup sqlite3_changegroup Line 10776  typedef struct sqlite3_changegroup sqlite3_changegroup
 **   <li> Zero or more changesets (or patchsets) are added to the object  **   <li> Zero or more changesets (or patchsets) are added to the object
 **        by calling sqlite3changegroup_add().  **        by calling sqlite3changegroup_add().
 **  **
**   <li> The result of combining all input changesets together is obtained **   <li> The result of combining all input changesets together is obtained
 **        by the application via a call to sqlite3changegroup_output().  **        by the application via a call to sqlite3changegroup_output().
 **  **
 **   <li> The object is deleted using a call to sqlite3changegroup_delete().  **   <li> The object is deleted using a call to sqlite3changegroup_delete().
Line 10403  typedef struct sqlite3_changegroup sqlite3_changegroup Line 10785  typedef struct sqlite3_changegroup sqlite3_changegroup
 ** Any number of calls to add() and output() may be made between the calls to  ** Any number of calls to add() and output() may be made between the calls to
 ** new() and delete(), and in any order.  ** new() and delete(), and in any order.
 **  **
** As well as the regular sqlite3changegroup_add() and ** As well as the regular sqlite3changegroup_add() and
 ** sqlite3changegroup_output() functions, also available are the streaming  ** sqlite3changegroup_output() functions, also available are the streaming
 ** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().  ** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().
 */  */
Line 10414  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr Line 10796  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr
 ** METHOD: sqlite3_changegroup  ** METHOD: sqlite3_changegroup
 **  **
 ** Add all changes within the changeset (or patchset) in buffer pData (size  ** Add all changes within the changeset (or patchset) in buffer pData (size
** nData bytes) to the changegroup. ** nData bytes) to the changegroup.
 **  **
 ** If the buffer contains a patchset, then all prior calls to this function  ** 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  ** on the same changegroup object must also have specified patchsets. Or, if
Line 10441  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr Line 10823  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr
 **       changeset was recorded immediately after the changesets already  **       changeset was recorded immediately after the changesets already
 **       added to the changegroup.  **       added to the changegroup.
 **   <tr><td>INSERT <td>UPDATE <td>  **   <tr><td>INSERT <td>UPDATE <td>
**       The INSERT change remains in the changegroup. The values in the **       The INSERT change remains in the changegroup. The values in the
 **       INSERT change are modified as if the row was inserted by the  **       INSERT change are modified as if the row was inserted by the
 **       existing change and then updated according to the new change.  **       existing change and then updated according to the new change.
 **   <tr><td>INSERT <td>DELETE <td>  **   <tr><td>INSERT <td>DELETE <td>
Line 10452  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr Line 10834  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr
 **       changeset was recorded immediately after the changesets already  **       changeset was recorded immediately after the changesets already
 **       added to the changegroup.  **       added to the changegroup.
 **   <tr><td>UPDATE <td>UPDATE <td>  **   <tr><td>UPDATE <td>UPDATE <td>
**       The existing UPDATE remains within the changegroup. It is amended **       The existing UPDATE remains within the changegroup. It is amended
**       so that the accompanying values are as if the row was updated once **       so that the accompanying values are as if the row was updated once
 **       by the existing change and then again by the new change.  **       by the existing change and then again by the new change.
 **   <tr><td>UPDATE <td>DELETE <td>  **   <tr><td>UPDATE <td>DELETE <td>
 **       The existing UPDATE is replaced by the new DELETE within the  **       The existing UPDATE is replaced by the new DELETE within the
 **       changegroup.  **       changegroup.
 **   <tr><td>DELETE <td>INSERT <td>  **   <tr><td>DELETE <td>INSERT <td>
 **       If one or more of the column values in the row inserted by the  **       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 **       new change differ from those in the row deleted by the existing
 **       change, the existing DELETE is replaced by an UPDATE within the  **       change, the existing DELETE is replaced by an UPDATE within the
**       changegroup. Otherwise, if the inserted row is exactly the same **       changegroup. Otherwise, if the inserted row is exactly the same
 **       as the deleted row, the existing DELETE is simply discarded.  **       as the deleted row, the existing DELETE is simply discarded.
 **   <tr><td>DELETE <td>UPDATE <td>  **   <tr><td>DELETE <td>UPDATE <td>
 **       The new change is ignored. This case does not occur if the new  **       The new change is ignored. This case does not occur if the new
Line 10480  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr Line 10862  SQLITE_API int sqlite3changegroup_new(sqlite3_changegr
 ** case, this function fails with SQLITE_SCHEMA. If the input changeset  ** case, this function fails with SQLITE_SCHEMA. If the input changeset
 ** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is  ** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is
 ** returned. Or, if an out-of-memory condition occurs during processing, this  ** returned. Or, if an out-of-memory condition occurs during processing, this
** function returns SQLITE_NOMEM. In all cases, if an error occurs the** function returns SQLITE_NOMEM. In all cases, if an error occurs the state
** final contents of the changegroup is undefined.** of the final contents of the changegroup is undefined.
 **  **
 ** If no error occurs, SQLITE_OK is returned.  ** If no error occurs, SQLITE_OK is returned.
 */  */
Line 10507  SQLITE_API int sqlite3changegroup_add(sqlite3_changegr Line 10889  SQLITE_API int sqlite3changegroup_add(sqlite3_changegr
 **  **
 ** If an error occurs, an SQLite error code is returned and the output  ** If an error occurs, an SQLite error code is returned and the output
 ** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK  ** 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 ** 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  ** pointer to the output buffer, respectively. In this case it is the
 ** responsibility of the caller to eventually free the buffer using a  ** responsibility of the caller to eventually free the buffer using a
 ** call to sqlite3_free().  ** call to sqlite3_free().
Line 10529  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan Line 10911  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan
 **  **
 ** Apply a changeset or patchset to a database. These functions attempt to  ** 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  ** update the "main" database attached to handle db with the changes found in
** the changeset passed via the second and third arguments. ** the changeset passed via the second and third arguments.
 **  **
 ** The fourth argument (xFilter) passed to these functions is the "filter  ** 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  ** callback". If it is not NULL, then for each table affected by at least one
Line 10540  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan Line 10922  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan
 ** Otherwise, if the return value is non-zero or the xFilter argument to  ** Otherwise, if the return value is non-zero or the xFilter argument to
 ** is NULL, all changes related to the table are attempted.  ** is NULL, all changes related to the table are attempted.
 **  **
** For each table that is not excluded by the filter callback, this function ** 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 ** tests that the target database contains a compatible table. A table is
 ** considered compatible if all of the following are true:  ** considered compatible if all of the following are true:
 **  **
 ** <ul>  ** <ul>
**   <li> The table has the same name as the name recorded in the **   <li> The table has the same name as the name recorded in the
 **        changeset, and  **        changeset, and
**   <li> The table has at least as many columns as recorded in the **   <li> The table has at least as many columns as recorded in the
 **        changeset, and  **        changeset, and
**   <li> The table has primary key columns in the same position as **   <li> The table has primary key columns in the same position as
 **        recorded in the changeset.  **        recorded in the changeset.
 ** </ul>  ** </ul>
 **  **
Line 10558  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan Line 10940  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan
 ** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most  ** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most
 ** one such warning is issued for each table in the changeset.  ** 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 ** 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 ** to modify the table contents according to the UPDATE, INSERT or DELETE
** change. If a change cannot be applied cleanly, the conflict handler ** change. If a change cannot be applied cleanly, the conflict handler
** function passed as the fifth argument to sqlite3changeset_apply() may be ** function passed as the fifth argument to sqlite3changeset_apply() may be
** invoked. A description of exactly when the conflict handler is invoked for ** invoked. A description of exactly when the conflict handler is invoked for
 ** each type of change is below.  ** each type of change is below.
 **  **
 ** Unlike the xFilter argument, xConflict may not be passed NULL. The results  ** Unlike the xFilter argument, xConflict may not be passed NULL. The results
Line 10570  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan Line 10952  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan
 ** argument are undefined.  ** argument are undefined.
 **  **
 ** Each time the conflict handler function is invoked, it must return one  ** Each time the conflict handler function is invoked, it must return one
** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or ** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or
 ** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned  ** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned
 ** if the second argument passed to the conflict handler is either  ** if the second argument passed to the conflict handler is either
 ** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler  ** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler
 ** returns an illegal value, any changes already made are rolled back and  ** returns an illegal value, any changes already made are rolled back and
** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different ** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different
 ** actions are taken by sqlite3changeset_apply() depending on the value  ** actions are taken by sqlite3changeset_apply() depending on the value
 ** returned by each invocation of the conflict-handler function. Refer to  ** returned by each invocation of the conflict-handler function. Refer to
** the documentation for the three ** the documentation for the three
 ** [SQLITE_CHANGESET_OMIT|available return values] for details.  ** [SQLITE_CHANGESET_OMIT|available return values] for details.
 **  **
 ** <dl>  ** <dl>
 ** <dt>DELETE Changes<dd>  ** <dt>DELETE Changes<dd>
**   For each DELETE change, the function checks if the target database **   For each DELETE change, the function checks if the target database
**   contains a row with the same primary key value (or values) as the **   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 **   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 **   stored in all non-primary key columns also match the values stored in
 **   the changeset the row is deleted from the target database.  **   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  **   If a row with matching primary key values is found, but one or more of
Line 10615  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan Line 10997  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan
 **   database table, the trailing fields are populated with their default  **   database table, the trailing fields are populated with their default
 **   values.  **   values.
 **  **
**   If the attempt to insert the row fails because the database already **   If the attempt to insert the row fails because the database already
 **   contains a row with the same primary key values, the conflict handler  **   contains a row with the same primary key values, the conflict handler
**   function is invoked with the second argument set to **   function is invoked with the second argument set to
 **   [SQLITE_CHANGESET_CONFLICT].  **   [SQLITE_CHANGESET_CONFLICT].
 **  **
 **   If the attempt to insert the row fails because of some other constraint  **   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 **   violation (e.g. NOT NULL or UNIQUE), the conflict handler function is
 **   invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].  **   invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].
**   This includes the case where the INSERT operation is re-attempted because **   This includes the case where the INSERT operation is re-attempted because
**   an earlier call to the conflict handler function returned **   an earlier call to the conflict handler function returned
 **   [SQLITE_CHANGESET_REPLACE].  **   [SQLITE_CHANGESET_REPLACE].
 **  **
 ** <dt>UPDATE Changes<dd>  ** <dt>UPDATE Changes<dd>
**   For each UPDATE change, the function checks if the target database **   For each UPDATE change, the function checks if the target database
**   contains a row with the same primary key value (or values) as the **   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 **   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 all modified non-primary key columns also match the values
 **   stored in the changeset the row is updated within the target database.  **   stored in the changeset the row is updated within the target database.
 **  **
Line 10646  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan Line 11028  SQLITE_API void sqlite3changegroup_delete(sqlite3_chan
 **   the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]  **   the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
 **   passed as the second argument.  **   passed as the second argument.
 **  **
**   If the UPDATE operation is attempted, but SQLite returns **   If the UPDATE operation is attempted, but SQLite returns
**   SQLITE_CONSTRAINT, the conflict-handler function is invoked with **   SQLITE_CONSTRAINT, the conflict-handler function is invoked with
 **   [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.  **   [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.
**   This includes the case where the UPDATE operation is attempted after **   This includes the case where the UPDATE operation is attempted after
 **   an earlier call to the conflict handler function returned  **   an earlier call to the conflict handler function returned
**   [SQLITE_CHANGESET_REPLACE].  **   [SQLITE_CHANGESET_REPLACE].
 ** </dl>  ** </dl>
 **  **
 ** It is safe to execute SQL statements, including those that write to the  ** It is safe to execute SQL statements, including those that write to the
 ** table that the callback related to, from within the xConflict callback.  ** table that the callback related to, from within the xConflict callback.
** This can be used to further customize the applications conflict** This can be used to further customize the application's conflict
 ** resolution strategy.  ** resolution strategy.
 **  **
 ** All changes made by these functions are enclosed in a savepoint transaction.  ** All changes made by these functions are enclosed in a savepoint transaction.
 ** If any other error (aside from a constraint failure when attempting to  ** If any other error (aside from a constraint failure when attempting to
 ** write to the target database) occurs, then the savepoint transaction is  ** write to the target database) occurs, then the savepoint transaction is
** rolled back, restoring the target database to its original state, and an ** rolled back, restoring the target database to its original state, and an
 ** SQLite error code returned.  ** SQLite error code returned.
 **  **
 ** If the output parameters (ppRebase) and (pnRebase) are non-NULL and  ** If the output parameters (ppRebase) and (pnRebase) are non-NULL and
 ** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2()  ** 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 ** may set (*ppRebase) to point to a "rebase" that may be used with the
 ** sqlite3_rebaser APIs buffer before returning. In this case (*pnRebase)  ** 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  ** 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  ** caller to eventually free any such buffer using sqlite3_free(). The buffer
Line 10728  SQLITE_API int sqlite3changeset_apply_v2( Line 11110  SQLITE_API int sqlite3changeset_apply_v2(
 **   SAVEPOINT is committed if the changeset or patchset is successfully  **   SAVEPOINT is committed if the changeset or patchset is successfully
 **   applied, or rolled back if an error occurs. Specifying this flag  **   applied, or rolled back if an error occurs. Specifying this flag
 **   causes the sessions module to omit this savepoint. In this case, if the  **   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, **   caller has an open transaction or savepoint when apply_v2() is called,
 **   it may revert the partially applied changeset by rolling it back.  **   it may revert the partially applied changeset by rolling it back.
 **  **
 ** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>  ** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>
Line 10739  SQLITE_API int sqlite3changeset_apply_v2( Line 11121  SQLITE_API int sqlite3changeset_apply_v2(
 #define SQLITE_CHANGESETAPPLY_NOSAVEPOINT   0x0001  #define SQLITE_CHANGESETAPPLY_NOSAVEPOINT   0x0001
 #define SQLITE_CHANGESETAPPLY_INVERT        0x0002  #define SQLITE_CHANGESETAPPLY_INVERT        0x0002
   
/* /*
 ** CAPI3REF: Constants Passed To The Conflict Handler  ** CAPI3REF: Constants Passed To The Conflict Handler
 **  **
 ** Values that may be passed as the second argument to a conflict-handler.  ** Values that may be passed as the second argument to a conflict-handler.
Line 10748  SQLITE_API int sqlite3changeset_apply_v2( Line 11130  SQLITE_API int sqlite3changeset_apply_v2(
 ** <dt>SQLITE_CHANGESET_DATA<dd>  ** <dt>SQLITE_CHANGESET_DATA<dd>
 **   The conflict handler is invoked with CHANGESET_DATA as the second argument  **   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  **   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 **   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 **   (non primary-key) fields modified by the update do not contain the
 **   expected "before" values.  **   expected "before" values.
** **
 **   The conflicting row, in this case, is the database row with the matching  **   The conflicting row, in this case, is the database row with the matching
 **   primary key.  **   primary key.
** **
 ** <dt>SQLITE_CHANGESET_NOTFOUND<dd>  ** <dt>SQLITE_CHANGESET_NOTFOUND<dd>
 **   The conflict handler is invoked with CHANGESET_NOTFOUND as the second  **   The conflict handler is invoked with CHANGESET_NOTFOUND as the second
 **   argument when processing a DELETE or UPDATE change if a row with the  **   argument when processing a DELETE or UPDATE change if a row with the
 **   required PRIMARY KEY fields is not present in the database.  **   required PRIMARY KEY fields is not present in the database.
** **
 **   There is no conflicting row in this case. The results of invoking the  **   There is no conflicting row in this case. The results of invoking the
 **   sqlite3changeset_conflict() API are undefined.  **   sqlite3changeset_conflict() API are undefined.
** **
 ** <dt>SQLITE_CHANGESET_CONFLICT<dd>  ** <dt>SQLITE_CHANGESET_CONFLICT<dd>
 **   CHANGESET_CONFLICT is passed as the second argument to the conflict  **   CHANGESET_CONFLICT is passed as the second argument to the conflict
**   handler while processing an INSERT change if the operation would result **   handler while processing an INSERT change if the operation would result
 **   in duplicate primary key values.  **   in duplicate primary key values.
** **
 **   The conflicting row in this case is the database row with the matching  **   The conflicting row in this case is the database row with the matching
 **   primary key.  **   primary key.
 **  **
 ** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>  ** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>
 **   If foreign key handling is enabled, and applying a changeset leaves the  **   If foreign key handling is enabled, and applying a changeset leaves the
**   database in a state containing foreign key violations, the conflict **   database in a state containing foreign key violations, the conflict
 **   handler is invoked with CHANGESET_FOREIGN_KEY as the second argument  **   handler is invoked with CHANGESET_FOREIGN_KEY as the second argument
 **   exactly once before the changeset is committed. If the conflict handler  **   exactly once before the changeset is committed. If the conflict handler
 **   returns CHANGESET_OMIT, the changes, including those that caused the  **   returns CHANGESET_OMIT, the changes, including those that caused the
Line 10783  SQLITE_API int sqlite3changeset_apply_v2( Line 11165  SQLITE_API int sqlite3changeset_apply_v2(
 **   No current or conflicting row information is provided. The only function  **   No current or conflicting row information is provided. The only function
 **   it is possible to call on the supplied sqlite3_changeset_iter handle  **   it is possible to call on the supplied sqlite3_changeset_iter handle
 **   is sqlite3changeset_fk_conflicts().  **   is sqlite3changeset_fk_conflicts().
** **
 ** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>  ** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>
**   If any other constraint violation occurs while applying a change (i.e. **   If any other constraint violation occurs while applying a change (i.e.
**   a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is **   a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is
 **   invoked with CHANGESET_CONSTRAINT as the second argument.  **   invoked with CHANGESET_CONSTRAINT as the second argument.
** **
 **   There is no conflicting row in this case. The results of invoking the  **   There is no conflicting row in this case. The results of invoking the
 **   sqlite3changeset_conflict() API are undefined.  **   sqlite3changeset_conflict() API are undefined.
 **  **
Line 10800  SQLITE_API int sqlite3changeset_apply_v2( Line 11182  SQLITE_API int sqlite3changeset_apply_v2(
 #define SQLITE_CHANGESET_CONSTRAINT  4  #define SQLITE_CHANGESET_CONSTRAINT  4
 #define SQLITE_CHANGESET_FOREIGN_KEY 5  #define SQLITE_CHANGESET_FOREIGN_KEY 5
   
/* /*
 ** CAPI3REF: Constants Returned By The Conflict Handler  ** CAPI3REF: Constants Returned By The Conflict Handler
 **  **
 ** A conflict handler callback must return one of the following three values.  ** A conflict handler callback must return one of the following three values.
Line 10808  SQLITE_API int sqlite3changeset_apply_v2( Line 11190  SQLITE_API int sqlite3changeset_apply_v2(
 ** <dl>  ** <dl>
 ** <dt>SQLITE_CHANGESET_OMIT<dd>  ** <dt>SQLITE_CHANGESET_OMIT<dd>
 **   If a conflict handler returns this value no special action is taken. The  **   If a conflict handler returns this value no special action is taken. The
**   change that caused the conflict is not applied. The session module **   change that caused the conflict is not applied. The session module
 **   continues to the next change in the changeset.  **   continues to the next change in the changeset.
 **  **
 ** <dt>SQLITE_CHANGESET_REPLACE<dd>  ** <dt>SQLITE_CHANGESET_REPLACE<dd>
 **   This value may only be returned if the second argument to the conflict  **   This value may only be returned if the second argument to the conflict
 **   handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this  **   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 **   is not the case, any changes applied so far are rolled back and the
 **   call to sqlite3changeset_apply() returns SQLITE_MISUSE.  **   call to sqlite3changeset_apply() returns SQLITE_MISUSE.
 **  **
 **   If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict  **   If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict
Line 10827  SQLITE_API int sqlite3changeset_apply_v2( Line 11209  SQLITE_API int sqlite3changeset_apply_v2(
 **   the original row is restored to the database before continuing.  **   the original row is restored to the database before continuing.
 **  **
 ** <dt>SQLITE_CHANGESET_ABORT<dd>  ** <dt>SQLITE_CHANGESET_ABORT<dd>
**   If this value is returned, any changes applied so far are rolled back **   If this value is returned, any changes applied so far are rolled back
 **   and the call to sqlite3changeset_apply() returns SQLITE_ABORT.  **   and the call to sqlite3changeset_apply() returns SQLITE_ABORT.
 ** </dl>  ** </dl>
 */  */
Line 10835  SQLITE_API int sqlite3changeset_apply_v2( Line 11217  SQLITE_API int sqlite3changeset_apply_v2(
 #define SQLITE_CHANGESET_REPLACE    1  #define SQLITE_CHANGESET_REPLACE    1
 #define SQLITE_CHANGESET_ABORT      2  #define SQLITE_CHANGESET_ABORT      2
   
/* /*
 ** CAPI3REF: Rebasing changesets  ** CAPI3REF: Rebasing changesets
 ** EXPERIMENTAL  ** EXPERIMENTAL
 **  **
 ** Suppose there is a site hosting a database in state S0. And that  ** 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  ** modifications are made that move that database to state S1 and a
 ** changeset recorded (the "local" changeset). Then, a changeset based  ** changeset recorded (the "local" changeset). Then, a changeset based
** on S0 is received from another site (the "remote" changeset) and ** on S0 is received from another site (the "remote" changeset) and
** applied to the database. The database is then in state ** applied to the database. The database is then in state
 ** (S1+"remote"), where the exact state depends on any conflict  ** (S1+"remote"), where the exact state depends on any conflict
 ** resolution decisions (OMIT or REPLACE) made while applying "remote".  ** resolution decisions (OMIT or REPLACE) made while applying "remote".
** Rebasing a changeset is to update it to take those conflict ** Rebasing a changeset is to update it to take those conflict
 ** resolution decisions into account, so that the same conflicts  ** resolution decisions into account, so that the same conflicts
** do not have to be resolved elsewhere in the network. ** do not have to be resolved elsewhere in the network.
 **  **
 ** For example, if both the local and remote changesets contain an  ** For example, if both the local and remote changesets contain an
 ** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)":  ** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)":
Line 10867  SQLITE_API int sqlite3changeset_apply_v2( Line 11249  SQLITE_API int sqlite3changeset_apply_v2(
 **  **
 ** <dl>  ** <dl>
 ** <dt>Local INSERT<dd>  ** <dt>Local INSERT<dd>
**   This may only conflict with a remote INSERT. If the conflict **   This may only conflict with a remote INSERT. If the conflict
 **   resolution was OMIT, then add an UPDATE change to the rebased  **   resolution was OMIT, then add an UPDATE change to the rebased
 **   changeset. Or, if the conflict resolution was REPLACE, add  **   changeset. Or, if the conflict resolution was REPLACE, add
 **   nothing to the rebased changeset.  **   nothing to the rebased changeset.
Line 10891  SQLITE_API int sqlite3changeset_apply_v2( Line 11273  SQLITE_API int sqlite3changeset_apply_v2(
 **   the old.* values are rebased using the new.* values in the remote  **   the old.* values are rebased using the new.* values in the remote
 **   change. Or, if the resolution is REPLACE, then the change is copied  **   change. Or, if the resolution is REPLACE, then the change is copied
 **   into the rebased changeset with updates to columns also updated by  **   into the rebased changeset with updates to columns also updated by
**   the conflicting remote UPDATE removed. If this means no columns would **   the conflicting remote UPDATE removed. If this means no columns would
 **   be updated, the change is omitted.  **   be updated, the change is omitted.
 ** </dl>  ** </dl>
 **  **
** A local change may be rebased against multiple remote changes ** A local change may be rebased against multiple remote changes
** simultaneously. If a single key is modified by multiple remote ** simultaneously. If a single key is modified by multiple remote
 ** changesets, they are combined as follows before the local changeset  ** changesets, they are combined as follows before the local changeset
 ** is rebased:  ** is rebased:
 **  **
Line 10909  SQLITE_API int sqlite3changeset_apply_v2( Line 11291  SQLITE_API int sqlite3changeset_apply_v2(
 **         of the OMIT resolutions.  **         of the OMIT resolutions.
 ** </ul>  ** </ul>
 **  **
** Note that conflict resolutions from multiple remote changesets are ** Note that conflict resolutions from multiple remote changesets are
** combined on a per-field basis, not per-row. This means that in the ** 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 ** case of multiple remote UPDATE operations, some fields of a single
** local change may be rebased for REPLACE while others are rebased for ** local change may be rebased for REPLACE while others are rebased for
 ** OMIT.  ** OMIT.
 **  **
 ** In order to rebase a local changeset, the remote changeset must first  ** In order to rebase a local changeset, the remote changeset must first
Line 10920  SQLITE_API int sqlite3changeset_apply_v2( Line 11302  SQLITE_API int sqlite3changeset_apply_v2(
 ** the buffer of rebase information captured. Then:  ** the buffer of rebase information captured. Then:
 **  **
 ** <ol>  ** <ol>
**   <li> An sqlite3_rebaser object is created by calling **   <li> An sqlite3_rebaser object is created by calling
 **        sqlite3rebaser_create().  **        sqlite3rebaser_create().
 **   <li> The new object is configured with the rebase buffer obtained from  **   <li> The new object is configured with the rebase buffer obtained from
 **        sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure().  **        sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure().
Line 10941  typedef struct sqlite3_rebaser sqlite3_rebaser; Line 11323  typedef struct sqlite3_rebaser sqlite3_rebaser;
 **  **
 ** Allocate a new changeset rebaser object. If successful, set (*ppNew) to  ** Allocate a new changeset rebaser object. If successful, set (*ppNew) to
 ** point to the new object and return SQLITE_OK. Otherwise, if an error  ** 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) ** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew)
** to NULL. ** to NULL.
 */  */
 SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew);  SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew);
   
Line 10956  SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser * Line 11338  SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser *
 ** sqlite3changeset_apply_v2().  ** sqlite3changeset_apply_v2().
 */  */
 SQLITE_API int sqlite3rebaser_configure(  SQLITE_API int sqlite3rebaser_configure(
  sqlite3_rebaser*,   sqlite3_rebaser*,
   int nRebase, const void *pRebase    int nRebase, const void *pRebase
); );
   
 /*  /*
 ** CAPI3REF: Rebase a changeset  ** CAPI3REF: Rebase a changeset
Line 10966  SQLITE_API int sqlite3rebaser_configure( Line 11348  SQLITE_API int sqlite3rebaser_configure(
 **  **
 ** Argument pIn must point to a buffer containing a changeset nIn bytes  ** Argument pIn must point to a buffer containing a changeset nIn bytes
 ** in size. This function allocates and populates a buffer with a copy  ** in size. This function allocates and populates a buffer with a copy
** of the changeset rebased rebased according to the configuration of the** of the changeset rebased according to the configuration of the
 ** rebaser object passed as the first argument. If successful, (*ppOut)  ** rebaser object passed as the first argument. If successful, (*ppOut)
** is set to point to the new buffer containing the rebased changeset and ** 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  ** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the
 ** responsibility of the caller to eventually free the new buffer using  ** responsibility of the caller to eventually free the new buffer using
 ** sqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut)  ** sqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut)
Line 10976  SQLITE_API int sqlite3rebaser_configure( Line 11358  SQLITE_API int sqlite3rebaser_configure(
 */  */
 SQLITE_API int sqlite3rebaser_rebase(  SQLITE_API int sqlite3rebaser_rebase(
   sqlite3_rebaser*,    sqlite3_rebaser*,
  int nIn, const void *pIn,   int nIn, const void *pIn,
  int *pnOut, void **ppOut   int *pnOut, void **ppOut
 );  );
   
 /*  /*
Line 10988  SQLITE_API int sqlite3rebaser_rebase( Line 11370  SQLITE_API int sqlite3rebaser_rebase(
 ** should be one call to this function for each successful invocation  ** should be one call to this function for each successful invocation
 ** of sqlite3rebaser_create().  ** of sqlite3rebaser_create().
 */  */
SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p); SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p);
   
 /*  /*
 ** CAPI3REF: Streaming Versions of API functions.  ** CAPI3REF: Streaming Versions of API functions.
 **  **
** The six streaming API xxx_strm() functions serve similar purposes to the ** The six streaming API xxx_strm() functions serve similar purposes to the
 ** corresponding non-streaming API functions:  ** corresponding non-streaming API functions:
 **  **
 ** <table border=1 style="margin-left:8ex;margin-right:8ex">  ** <table border=1 style="margin-left:8ex;margin-right:8ex">
 **   <tr><th>Streaming function<th>Non-streaming equivalent</th>  **   <tr><th>Streaming function<th>Non-streaming equivalent</th>
**   <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply] **   <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply]
**   <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2] **   <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2]
**   <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat] **   <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat]
**   <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert] **   <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert]
**   <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start] **   <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start]
**   <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset] **   <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset]
**   <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset] **   <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset]
 ** </table>  ** </table>
 **  **
 ** Non-streaming functions that accept changesets (or patchsets) as input  ** Non-streaming functions that accept changesets (or patchsets) as input
** require that the entire changeset be stored in a single buffer in memory. ** 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 ** Similarly, those that return a changeset or patchset do so by returning
** a pointer to a single large buffer allocated using sqlite3_malloc(). ** a pointer to a single large buffer allocated using sqlite3_malloc().
** Normally this is convenient. However, if an application running in a ** Normally this is convenient. However, if an application running in a
 ** low-memory environment is required to handle very large changesets, the  ** low-memory environment is required to handle very large changesets, the
 ** large contiguous memory allocations required can become onerous.  ** large contiguous memory allocations required can become onerous.
 **  **
Line 11033  SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser  Line 11415  SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser 
 **  </pre>  **  </pre>
 **  **
 ** Each time the xInput callback is invoked by the sessions module, the first  ** 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 passed is a copy of the supplied pIn context pointer. The second
** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no ** 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 ** 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 ** into the buffer and set (*pnData) to the actual number of bytes copied
** before returning SQLITE_OK. If the input is completely exhausted, (*pnData) ** 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 ** 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  ** error code should be returned. In all cases, if an xInput callback returns
 ** an error, all processing is abandoned and the streaming API function  ** an error, all processing is abandoned and the streaming API function
 ** returns a copy of the error code to the caller.  ** returns a copy of the error code to the caller.
Line 11046  SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser  Line 11428  SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser 
 ** In the case of sqlite3changeset_start_strm(), the xInput callback may be  ** 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  ** 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  ** iterator. If such an xInput callback returns an error, the iterator enters
** an error state, whereby all subsequent calls to iterator functions ** an error state, whereby all subsequent calls to iterator functions
 ** immediately fail with the same error code as returned by xInput.  ** immediately fail with the same error code as returned by xInput.
 **  **
 ** Similarly, streaming API functions that return changesets (or patchsets)  ** Similarly, streaming API functions that return changesets (or patchsets)
Line 11076  SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser  Line 11458  SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser 
 ** is immediately abandoned and the streaming API function returns a copy  ** is immediately abandoned and the streaming API function returns a copy
 ** of the xOutput error code to the application.  ** of the xOutput error code to the application.
 **  **
** The sessions module never invokes an xOutput callback with the third ** 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,  ** 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.  ** no guarantees are made as to the size of the chunks of data returned.
 */  */
Line 11147  SQLITE_API int sqlite3session_patchset_strm( Line 11529  SQLITE_API int sqlite3session_patchset_strm(
   int (*xOutput)(void *pOut, const void *pData, int nData),    int (*xOutput)(void *pOut, const void *pData, int nData),
   void *pOut    void *pOut
 );  );
SQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*, SQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*,
     int (*xInput)(void *pIn, void *pData, int *pnData),      int (*xInput)(void *pIn, void *pData, int *pnData),
     void *pIn      void *pIn
 );  );
 SQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*,  SQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*,
    int (*xOutput)(void *pOut, const void *pData, int nData),     int (*xOutput)(void *pOut, const void *pData, int nData),
     void *pOut      void *pOut
 );  );
 SQLITE_API int sqlite3rebaser_rebase_strm(  SQLITE_API int sqlite3rebaser_rebase_strm(
Line 11167  SQLITE_API int sqlite3rebaser_rebase_strm( Line 11549  SQLITE_API int sqlite3rebaser_rebase_strm(
 ** CAPI3REF: Configure global parameters  ** CAPI3REF: Configure global parameters
 **  **
 ** The sqlite3session_config() interface is used to make global configuration  ** The sqlite3session_config() interface is used to make global configuration
** changes to the sessions module in order to tune it to the specific needs ** changes to the sessions module in order to tune it to the specific needs
 ** of the application.  ** of the application.
 **  **
 ** The sqlite3session_config() interface is not threadsafe. If it is invoked  ** The sqlite3session_config() interface is not threadsafe. If it is invoked
 ** while any other thread is inside any other sessions method then the  ** while any other thread is inside any other sessions method then the
 ** results are undefined. Furthermore, if it is invoked after any sessions  ** results are undefined. Furthermore, if it is invoked after any sessions
** related objects have been created, the results are also undefined. ** related objects have been created, the results are also undefined.
 **  **
 ** The first argument to the sqlite3session_config() function must be one  ** The first argument to the sqlite3session_config() function must be one
** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The ** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The
 ** interpretation of the (void*) value passed as the second parameter and  ** interpretation of the (void*) value passed as the second parameter and
 ** the effect of calling this function depends on the value of the first  ** the effect of calling this function depends on the value of the first
 ** parameter.  ** parameter.
Line 11226  SQLITE_API int sqlite3session_config(int op, void *pAr Line 11608  SQLITE_API int sqlite3session_config(int op, void *pAr
 **  **
 ******************************************************************************  ******************************************************************************
 **  **
** Interfaces to extend FTS5. Using the interfaces defined in this file, ** Interfaces to extend FTS5. Using the interfaces defined in this file,
 ** FTS5 may be extended with:  ** FTS5 may be extended with:
 **  **
 **     * custom tokenizers, and  **     * custom tokenizers, and
Line 11270  struct Fts5PhraseIter { Line 11652  struct Fts5PhraseIter {
 ** EXTENSION API FUNCTIONS  ** EXTENSION API FUNCTIONS
 **  **
 ** xUserData(pFts):  ** xUserData(pFts):
**   Return a copy of the context pointer the extension function was **   Return a copy of the context pointer the extension function was
 **   registered with.  **   registered with.
 **  **
 ** xColumnTotalSize(pFts, iCol, pnToken):  ** xColumnTotalSize(pFts, iCol, pnToken):
 **   If parameter iCol is less than zero, set output variable *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  **   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  **   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 total number of tokens in column iCol, considering all rows in
 **   the FTS5 table.  **   the FTS5 table.
 **  **
 **   If parameter iCol is greater than or equal to the number of columns  **   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.  **   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 **   an OOM condition or IO error), an appropriate SQLite error code is
 **   returned.  **   returned.
 **  **
 ** xColumnCount(pFts):  ** xColumnCount(pFts):
Line 11296  struct Fts5PhraseIter { Line 11678  struct Fts5PhraseIter {
 **  **
 **   If parameter iCol is greater than or equal to the number of columns  **   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.  **   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 **   an OOM condition or IO error), an appropriate SQLite error code is
 **   returned.  **   returned.
 **  **
 **   This function may be quite inefficient if used with an FTS5 table  **   This function may be quite inefficient if used with an FTS5 table
Line 11323  struct Fts5PhraseIter { Line 11705  struct Fts5PhraseIter {
 **   an error code (i.e. SQLITE_NOMEM) if an error occurs.  **   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  **   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 **   "detail=none" or "detail=column" option. If the FTS5 table is created
**   with either "detail=none" or "detail=column" and "content=" option **   with either "detail=none" or "detail=column" and "content=" option
 **   (i.e. if it is a contentless table), then this API always returns 0.  **   (i.e. if it is a contentless table), then this API always returns 0.
 **  **
 ** xInst:  ** xInst:
Line 11339  struct Fts5PhraseIter { Line 11721  struct Fts5PhraseIter {
 **   code (i.e. SQLITE_NOMEM) if an error occurs.  **   code (i.e. SQLITE_NOMEM) if an error occurs.
 **  **
 **   This API can be quite slow if used with an FTS5 table created with the  **   This API can be quite slow if used with an FTS5 table created with the
**   "detail=none" or "detail=column" option. **   "detail=none" or "detail=column" option.
 **  **
 ** xRowid:  ** xRowid:
 **   Returns the rowid of the current row.  **   Returns the rowid of the current row.
Line 11355  struct Fts5PhraseIter { Line 11737  struct Fts5PhraseIter {
 **  **
 **   with $p set to a phrase equivalent to the phrase iPhrase of the  **   with $p set to a phrase equivalent to the phrase iPhrase of the
 **   current query is executed. Any column filter that applies to  **   current query is executed. Any column filter that applies to
**   phrase iPhrase of the current query is included in $p. For each **   phrase iPhrase of the current query is included in $p. For each
**   row visited, the callback function passed as the fourth argument **   row visited, the callback function passed as the fourth argument
**   is invoked. The context and API objects passed to the callback **   is invoked. The context and API objects passed to the callback
 **   function may be used to access the properties of each matched row.  **   function may be used to access the properties of each matched row.
**   Invoking Api.xUserData() returns a copy of the pointer passed as **   Invoking Api.xUserData() returns a copy of the pointer passed as
 **   the third argument to pUserData.  **   the third argument to pUserData.
 **  **
 **   If the callback function returns any value other than SQLITE_OK, the  **   If the callback function returns any value other than SQLITE_OK, the
Line 11374  struct Fts5PhraseIter { Line 11756  struct Fts5PhraseIter {
 **  **
 ** xSetAuxdata(pFts5, pAux, xDelete)  ** xSetAuxdata(pFts5, pAux, xDelete)
 **  **
**   Save the pointer passed as the second argument as the extension functions **   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  **   "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  **   future invocation of the same fts5 extension function made as part of
 **   the same MATCH query using the xGetAuxdata() API.  **   the same MATCH query using the xGetAuxdata() API.
 **  **
 **   Each extension function is allocated a single auxiliary data slot for  **   Each extension function is allocated a single auxiliary data slot for
**   each FTS query (MATCH expression). If the extension function is invoked **   each FTS query (MATCH expression). If the extension function is invoked
**   more than once for a single FTS query, then all invocations share a **   more than once for a single FTS query, then all invocations share a
 **   single auxiliary data context.  **   single auxiliary data context.
 **  **
 **   If there is already an auxiliary data pointer when this function is  **   If there is already an auxiliary data pointer when this function is
Line 11400  struct Fts5PhraseIter { Line 11782  struct Fts5PhraseIter {
 **  **
 ** xGetAuxdata(pFts5, bClear)  ** xGetAuxdata(pFts5, bClear)
 **  **
**   Returns the current auxiliary data pointer for the fts5 extension **   Returns the current auxiliary data pointer for the fts5 extension
 **   function. See the xSetAuxdata() method for details.  **   function. See the xSetAuxdata() method for details.
 **  **
 **   If the bClear argument is non-zero, then the auxiliary data is cleared  **   If the bClear argument is non-zero, then the auxiliary data is cleared
Line 11420  struct Fts5PhraseIter { Line 11802  struct Fts5PhraseIter {
 **   method, to iterate through all instances of a single query phrase within  **   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  **   the current row. This is the same information as is accessible via the
 **   xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient  **   xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
**   to use, this API may be faster under some circumstances. To iterate **   to use, this API may be faster under some circumstances. To iterate
 **   through instances of phrase iPhrase, use the following code:  **   through instances of phrase iPhrase, use the following code:
 **  **
 **       Fts5PhraseIter iter;  **       Fts5PhraseIter iter;
Line 11438  struct Fts5PhraseIter { Line 11820  struct Fts5PhraseIter {
 **   xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).  **   xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
 **  **
 **   This API can be quite slow if used with an FTS5 table created with the  **   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 **   "detail=none" or "detail=column" option. If the FTS5 table is created
**   with either "detail=none" or "detail=column" and "content=" option **   with either "detail=none" or "detail=column" and "content=" option
 **   (i.e. if it is a contentless table), then this API always iterates  **   (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).  **   through an empty set (all calls to xPhraseFirst() set iCol to -1).
 **  **
Line 11463  struct Fts5PhraseIter { Line 11845  struct Fts5PhraseIter {
 **       }  **       }
 **  **
 **   This API can be quite slow if used with an FTS5 table created with the  **   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" option. If the FTS5 table is created with either
**   "detail=none" "content=" option (i.e. if it is a contentless table), **   "detail=none" "content=" option (i.e. if it is a contentless table),
**   then this API always iterates through an empty set (all calls to **   then this API always iterates through an empty set (all calls to
 **   xPhraseFirstColumn() set iCol to -1).  **   xPhraseFirstColumn() set iCol to -1).
 **  **
 **   The information accessed using this API and its companion  **   The information accessed using this API and its companion
 **   xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext  **   xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
 **   (or xInst/xInstCount). The chief advantage of this API is that it is  **   (or xInst/xInstCount). The chief advantage of this API is that it is
 **   significantly more efficient than those alternatives when used with  **   significantly more efficient than those alternatives when used with
**   "detail=column" tables.  **   "detail=column" tables.
 **  **
 ** xPhraseNextColumn()  ** xPhraseNextColumn()
 **   See xPhraseFirstColumn above.  **   See xPhraseFirstColumn above.
Line 11486  struct Fts5ExtensionApi { Line 11868  struct Fts5ExtensionApi {
   int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);    int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);
   int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);    int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);
   
  int (*xTokenize)(Fts5Context*,   int (*xTokenize)(Fts5Context*,
     const char *pText, int nText, /* Text to tokenize */      const char *pText, int nText, /* Text to tokenize */
     void *pCtx,                   /* Context passed to xToken() */      void *pCtx,                   /* Context passed to xToken() */
     int (*xToken)(void*, int, const char*, int, int, int)       /* Callback */      int (*xToken)(void*, int, const char*, int, int, int)       /* Callback */
Line 11515  struct Fts5ExtensionApi { Line 11897  struct Fts5ExtensionApi {
   void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);    void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);
 };  };
   
/* /*
 ** CUSTOM AUXILIARY FUNCTIONS  ** CUSTOM AUXILIARY FUNCTIONS
 *************************************************************************/  *************************************************************************/
   
 /*************************************************************************  /*************************************************************************
 ** CUSTOM TOKENIZERS  ** CUSTOM TOKENIZERS
 **  **
** Applications may also register custom tokenizer types. A tokenizer ** Applications may also register custom tokenizer types. A tokenizer
** is registered by providing fts5 with a populated instance of the ** is registered by providing fts5 with a populated instance of the
 ** following structure. All structure methods must be defined, setting  ** following structure. All structure methods must be defined, setting
 ** any member of the fts5_tokenizer struct to NULL leads to undefined  ** any member of the fts5_tokenizer struct to NULL leads to undefined
 ** behaviour. The structure methods are expected to function as follows:  ** behaviour. The structure methods are expected to function as follows:
Line 11534  struct Fts5ExtensionApi { Line 11916  struct Fts5ExtensionApi {
 **  **
 **   The first argument passed to this function is a copy of the (void*)  **   The first argument passed to this function is a copy of the (void*)
 **   pointer provided by the application when the fts5_tokenizer object  **   pointer provided by the application when the fts5_tokenizer object
**   was registered with FTS5 (the third argument to xCreateTokenizer()). **   was registered with FTS5 (the third argument to xCreateTokenizer()).
 **   The second and third arguments are an array of nul-terminated strings  **   The second and third arguments are an array of nul-terminated strings
 **   containing the tokenizer arguments, if any, specified following the  **   containing the tokenizer arguments, if any, specified following the
 **   tokenizer name as part of the CREATE VIRTUAL TABLE statement used  **   tokenizer name as part of the CREATE VIRTUAL TABLE statement used
 **   to create the FTS5 table.  **   to create the FTS5 table.
 **  **
**   The final argument is an output variable. If successful, (*ppOut) **   The final argument is an output variable. If successful, (*ppOut)
 **   should be set to point to the new tokenizer handle and SQLITE_OK  **   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  **   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 **   be returned. In this case, fts5 assumes that the final value of *ppOut
 **   is undefined.  **   is undefined.
 **  **
 ** xDelete:  ** xDelete:
Line 11552  struct Fts5ExtensionApi { Line 11934  struct Fts5ExtensionApi {
 **   be invoked exactly once for each successful call to xCreate().  **   be invoked exactly once for each successful call to xCreate().
 **  **
 ** xTokenize:  ** xTokenize:
**   This function is expected to tokenize the nText byte string indicated **   This function is expected to tokenize the nText byte string indicated
 **   by argument pText. pText may or may not be nul-terminated. The first  **   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  **   argument passed to this function is a pointer to an Fts5Tokenizer object
 **   returned by an earlier call to xCreate().  **   returned by an earlier call to xCreate().
Line 11566  struct Fts5ExtensionApi { Line 11948  struct Fts5ExtensionApi {
 **            determine the set of tokens to add to (or delete from) the  **            determine the set of tokens to add to (or delete from) the
 **            FTS index.  **            FTS index.
 **  **
**       <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed **       <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
**            against the FTS index. The tokenizer is being called to tokenize **            against the FTS index. The tokenizer is being called to tokenize
 **            a bareword or quoted string specified as part of the query.  **            a bareword or quoted string specified as part of the query.
 **  **
 **       <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as  **       <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as
Line 11575  struct Fts5ExtensionApi { Line 11957  struct Fts5ExtensionApi {
 **            followed by a "*" character, indicating that the last token  **            followed by a "*" character, indicating that the last token
 **            returned by the tokenizer will be treated as a token prefix.  **            returned by the tokenizer will be treated as a token prefix.
 **  **
**       <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to **       <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
 **            satisfy an fts5_api.xTokenize() request made by an auxiliary  **            satisfy an fts5_api.xTokenize() request made by an auxiliary
 **            function. Or an fts5_api.xColumnSize() request made by the same  **            function. Or an fts5_api.xColumnSize() request made by the same
**            on a columnsize=0 database.  **            on a columnsize=0 database.
 **   </ul>  **   </ul>
 **  **
 **   For each token in the input string, the supplied callback xToken() must  **   For each token in the input string, the supplied callback xToken() must
Line 11590  struct Fts5ExtensionApi { Line 11972  struct Fts5ExtensionApi {
 **   which the token is derived within the input.  **   which the token is derived within the input.
 **  **
 **   The second argument passed to the xToken() callback ("tflags") should  **   The second argument passed to the xToken() callback ("tflags") should
**   normally be set to 0. The exception is if the tokenizer supports **   normally be set to 0. The exception is if the tokenizer supports
 **   synonyms. In this case see the discussion below for details.  **   synonyms. In this case see the discussion below for details.
 **  **
**   FTS5 assumes the xToken() callback is invoked for each token in the **   FTS5 assumes the xToken() callback is invoked for each token in the
 **   order that they occur within the input text.  **   order that they occur within the input text.
 **  **
 **   If an xToken() callback returns any value other than SQLITE_OK, then  **   If an xToken() callback returns any value other than SQLITE_OK, then
Line 11607  struct Fts5ExtensionApi { Line 11989  struct Fts5ExtensionApi {
 ** SYNONYM SUPPORT  ** SYNONYM SUPPORT
 **  **
 **   Custom tokenizers may also support synonyms. Consider a case in which a  **   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 **   user wishes to query for a phrase such as "first place". Using the
 **   built-in tokenizers, the FTS5 query 'first + place' will match instances  **   built-in tokenizers, the FTS5 query 'first + place' will match instances
 **   of "first place" within the document set, but not alternative forms  **   of "first place" within the document set, but not alternative forms
 **   such as "1st place". In some applications, it would be better to match  **   such as "1st place". In some applications, it would be better to match
Line 11616  struct Fts5ExtensionApi { Line 11998  struct Fts5ExtensionApi {
 **  **
 **   There are several ways to approach this in FTS5:  **   There are several ways to approach this in FTS5:
 **  **
**   <ol><li> By mapping all synonyms to a single token. In this case, the **   <ol><li> By mapping all synonyms to a single token. In this case, using
**            In the above example, this means that the tokenizer returns the**            the above example, this means that the tokenizer returns the
 **            same token for inputs "first" and "1st". Say that token is in  **            same token for inputs "first" and "1st". Say that token is in
 **            fact "first", so that when the user inserts the document "I won  **            fact "first", so that when the user inserts the document "I won
 **            1st place" entries are added to the index for tokens "i", "won",  **            1st place" entries are added to the index for tokens "i", "won",
Line 11627  struct Fts5ExtensionApi { Line 12009  struct Fts5ExtensionApi {
 **  **
 **       <li> By querying the index for all synonyms of each query term  **       <li> By querying the index for all synonyms of each query term
 **            separately. In this case, when tokenizing query text, the  **            separately. In this case, when tokenizing query text, the
**            tokenizer may provide multiple synonyms for a single term **            tokenizer may provide multiple synonyms for a single term
**            within the document. FTS5 then queries the index for each **            within the document. FTS5 then queries the index for each
 **            synonym individually. For example, faced with the query:  **            synonym individually. For example, faced with the query:
 **  **
 **   <codeblock>  **   <codeblock>
 **     ... MATCH 'first place'</codeblock>  **     ... MATCH 'first place'</codeblock>
 **  **
 **            the tokenizer offers both "1st" and "first" as synonyms for the  **            the tokenizer offers both "1st" and "first" as synonyms for the
**            first token in the MATCH query and FTS5 effectively runs a query **            first token in the MATCH query and FTS5 effectively runs a query
 **            similar to:  **            similar to:
 **  **
 **   <codeblock>  **   <codeblock>
 **     ... MATCH '(first OR 1st) place'</codeblock>  **     ... MATCH '(first OR 1st) place'</codeblock>
 **  **
 **            except that, for the purposes of auxiliary functions, the query  **            except that, for the purposes of auxiliary functions, the query
**            still appears to contain just two phrases - "(first OR 1st)" **            still appears to contain just two phrases - "(first OR 1st)"
 **            being treated as a single phrase.  **            being treated as a single phrase.
 **  **
 **       <li> By adding multiple synonyms for a single term to the FTS index.  **       <li> By adding multiple synonyms for a single term to the FTS index.
 **            Using this method, when tokenizing document text, the tokenizer  **            Using this method, when tokenizing document text, the tokenizer
**            provides multiple synonyms for each token. So that when a **            provides multiple synonyms for each token. So that when a
 **            document such as "I won first place" is tokenized, entries are  **            document such as "I won first place" is tokenized, entries are
 **            added to the FTS index for "i", "won", "first", "1st" and  **            added to the FTS index for "i", "won", "first", "1st" and
 **            "place".  **            "place".
 **  **
 **            This way, even if the tokenizer does not provide synonyms  **            This way, even if the tokenizer does not provide synonyms
 **            when tokenizing query text (it should not - to do so would be  **            when tokenizing query text (it should not - to do so would be
**            inefficient), it doesn't matter if the user queries for **            inefficient), it doesn't matter if the user queries for
 **            'first + place' or '1st + place', as there are entries in the  **            'first + place' or '1st + place', as there are entries in the
 **            FTS index corresponding to both forms of the first token.  **            FTS index corresponding to both forms of the first token.
 **   </ol>  **   </ol>
Line 11675  struct Fts5ExtensionApi { Line 12057  struct Fts5ExtensionApi {
 **  **
 **   It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time  **   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  **   xToken() is called. Multiple synonyms may be specified for a single token
**   by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence. **   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  **   There is no limit to the number of synonyms that may be provided for a
 **   single token.  **   single token.
 **  **
**   In many cases, method (1) above is the best approach. It does not add **   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,  **   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  **   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  **   does not support prefix queries very well. If, as suggested above, the
Line 11691  struct Fts5ExtensionApi { Line 12073  struct Fts5ExtensionApi {
 **   will not match documents that contain the token "1st" (as the tokenizer  **   will not match documents that contain the token "1st" (as the tokenizer
 **   will probably not map "1s" to any prefix of "first").  **   will probably not map "1s" to any prefix of "first").
 **  **
**   For full prefix support, method (3) may be preferred. In this case, **   For full prefix support, method (3) may be preferred. In this case,
 **   because the index contains entries for both "first" and "1st", prefix  **   because the index contains entries for both "first" and "1st", prefix
 **   queries such as 'fi*' or '1s*' will match correctly. However, because  **   queries such as 'fi*' or '1s*' will match correctly. However, because
 **   extra entries are added to the FTS index, this method uses more space  **   extra entries are added to the FTS index, this method uses more space
 **   within the database.  **   within the database.
 **  **
 **   Method (2) offers a midpoint between (1) and (3). Using this method,  **   Method (2) offers a midpoint between (1) and (3). Using this method,
**   a query such as '1s*' will match documents that contain the literal **   a query such as '1s*' will match documents that contain the literal
 **   token "1st", but not "first" (assuming the tokenizer is not able to  **   token "1st", but not "first" (assuming the tokenizer is not able to
 **   provide synonyms for prefixes). However, a non-prefix query like '1st'  **   provide synonyms for prefixes). However, a non-prefix query like '1st'
 **   will match against "1st" and "first". This method does not require  **   will match against "1st" and "first". This method does not require
**   extra disk space, as no extra entries are added to the FTS index. **   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,  **   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.  **   as separate queries of the FTS index are required for each synonym.
 **  **
Line 11716  typedef struct fts5_tokenizer fts5_tokenizer; Line 12098  typedef struct fts5_tokenizer fts5_tokenizer;
 struct fts5_tokenizer {  struct fts5_tokenizer {
   int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);    int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
   void (*xDelete)(Fts5Tokenizer*);    void (*xDelete)(Fts5Tokenizer*);
  int (*xTokenize)(Fts5Tokenizer*,   int (*xTokenize)(Fts5Tokenizer*,
       void *pCtx,        void *pCtx,
       int flags,            /* Mask of FTS5_TOKENIZE_* flags */        int flags,            /* Mask of FTS5_TOKENIZE_* flags */
      const char *pText, int nText,       const char *pText, int nText,
       int (*xToken)(        int (*xToken)(
         void *pCtx,         /* Copy of 2nd argument to xTokenize() */          void *pCtx,         /* Copy of 2nd argument to xTokenize() */
         int tflags,         /* Mask of FTS5_TOKEN_* flags */          int tflags,         /* Mask of FTS5_TOKEN_* flags */
Removed from v.1.4.2.2  
changed lines
  Added in v.1.4.2.3

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>