/home/mrjunejune/zenbu: third_party/sqlite3/sqlite3.h annotate

annotate third_party/sqlite3/sqlite3.h @ 200:90dfcef375fb

Added my own s3 bucket uploader url to mrjunejune.

author	MrJuneJune <me@mrjunejune.com>
date	Sat, 14 Feb 2026 16:32:24 -0800
parents	589bab390fb4
children

rev	line source
167 589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2 ** 2001-09-15
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4 ** The author disclaims copyright to this source code. In place of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5 ** a legal notice, here is a blessing:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7 ** May you do good and not evil.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8 ** May you find forgiveness for yourself and forgive others.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9 ** May you share freely, never taking more than you give.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11 *************************************************************************
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12 ** This header file defines the interface that the SQLite library
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13 ** presents to client programs. If a C-function, structure, datatype,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	14 ** or constant definition does not appear in this file, then it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	15 ** not a published API of SQLite, is subject to change without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	16 ** notice, and should not be referenced by programs that use SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	17 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	18 ** Some of the definitions that are in this file are marked as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	19 ** "experimental". Experimental interfaces are normally new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	20 ** features recently added to SQLite. We do not anticipate changes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	21 ** to experimental interfaces but reserve the right to make minor changes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	22 ** if experience from use "in the wild" suggest such changes are prudent.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	23 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	24 ** The official C-language API documentation for SQLite is derived
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	25 ** from comments in this file. This file is the authoritative source
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	26 ** on how SQLite interfaces are supposed to operate.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	27 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	28 ** The name of this file under configuration management is "sqlite.h.in".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	29 ** The makefile makes some minor changes to this file (such as inserting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	30 ** the version number) and changes its name to "sqlite3.h" as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	31 ** part of the build process.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	32 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	33 #ifndef SQLITE3_H
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	34 #define SQLITE3_H
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	35 #include <stdarg.h> /* Needed for the definition of va_list */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	36
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	37 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	38 ** Make sure we can call this stuff from C++.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	39 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	40 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	41 extern "C" {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	42 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	43
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	44
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	45 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	46 ** Facilitate override of interface linkage and calling conventions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	47 ** Be aware that these macros may not be used within this particular
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	48 ** translation of the amalgamation and its associated header file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	49 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	50 ** The SQLITE_EXTERN and SQLITE_API macros are used to instruct the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	51 ** compiler that the target identifier should have external linkage.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	52 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	53 ** The SQLITE_CDECL macro is used to set the calling convention for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	54 ** public functions that accept a variable number of arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	55 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	56 ** The SQLITE_APICALL macro is used to set the calling convention for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	57 ** public functions that accept a fixed number of arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	58 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	59 ** The SQLITE_STDCALL macro is no longer used and is now deprecated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	60 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	61 ** The SQLITE_CALLBACK macro is used to set the calling convention for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	62 ** function pointers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	63 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	64 ** The SQLITE_SYSAPI macro is used to set the calling convention for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	65 ** functions provided by the operating system.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	66 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	67 ** Currently, the SQLITE_CDECL, SQLITE_APICALL, SQLITE_CALLBACK, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	68 ** SQLITE_SYSAPI macros are used only when building for environments
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	69 ** that require non-default calling conventions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	70 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	71 #ifndef SQLITE_EXTERN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	72 # define SQLITE_EXTERN extern
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	73 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	74 #ifndef SQLITE_API
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	75 # define SQLITE_API
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	76 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	77 #ifndef SQLITE_CDECL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	78 # define SQLITE_CDECL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	79 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	80 #ifndef SQLITE_APICALL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	81 # define SQLITE_APICALL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	82 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	83 #ifndef SQLITE_STDCALL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	84 # define SQLITE_STDCALL SQLITE_APICALL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	85 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	86 #ifndef SQLITE_CALLBACK
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	87 # define SQLITE_CALLBACK
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	88 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	89 #ifndef SQLITE_SYSAPI
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	90 # define SQLITE_SYSAPI
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	91 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	92
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	93 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	94 ** These no-op macros are used in front of interfaces to mark those
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	95 ** interfaces as either deprecated or experimental. New applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	96 ** should not use deprecated interfaces - they are supported for backwards
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	97 ** compatibility only. Application writers should be aware that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	98 ** experimental interfaces are subject to change in point releases.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	99 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	100 ** These macros used to resolve to various kinds of compiler magic that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	101 ** would generate warning messages when they were used. But that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	102 ** compiler magic ended up generating such a flurry of bug reports
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	103 ** that we have taken it all out and gone back to using simple
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	104 ** noop macros.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	105 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	106 #define SQLITE_DEPRECATED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	107 #define SQLITE_EXPERIMENTAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	108
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	109 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	110 ** Ensure these symbols were not defined by some previous header file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	111 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	112 #ifdef SQLITE_VERSION
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	113 # undef SQLITE_VERSION
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	114 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	115 #ifdef SQLITE_VERSION_NUMBER
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	116 # undef SQLITE_VERSION_NUMBER
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	117 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	118
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	119 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	120 ** CAPI3REF: Compile-Time Library Version Numbers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	121 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	122 ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	123 ** evaluates to a string literal that is the SQLite version in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	124 ** format "X.Y.Z" where X is the major version number (always 3 for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	125 ** SQLite3) and Y is the minor version number and Z is the release number.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	126 ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	127 ** with the value (X1000000 + Y1000 + Z) where X, Y, and Z are the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	128 ** numbers used in [SQLITE_VERSION].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	129 ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	130 ** be larger than the release from which it is derived. Either Y will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	131 ** be held constant and Z will be incremented or else Y will be incremented
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	132 ** and Z will be reset to zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	133 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	134 ** Since [version 3.6.18] ([dateof:3.6.18]),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	135 ** SQLite source code has been stored in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	136 ** <a href="http://fossil-scm.org/">Fossil configuration management
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	137 ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	138 ** a string which identifies a particular check-in of SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	139 ** within its configuration management system. ^The SQLITE_SOURCE_ID
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	140 ** string contains the date and time of the check-in (UTC) and a SHA1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	141 ** or SHA3-256 hash of the entire source tree. If the source code has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	142 ** been edited in any way since it was last checked in, then the last
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	143 ** four hexadecimal digits of the hash may be modified.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	144 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	145 ** See also: [sqlite3_libversion()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	146 ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	147 ** [sqlite_version()] and [sqlite_source_id()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	148 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	149 #define SQLITE_VERSION "3.51.2"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	150 #define SQLITE_VERSION_NUMBER 3051002
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	151 #define SQLITE_SOURCE_ID "2026-01-09 17:27:48 b270f8339eb13b504d0b2ba154ebca966b7dde08e40c3ed7d559749818cb2075"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	152 #define SQLITE_SCM_BRANCH "branch-3.51"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	153 #define SQLITE_SCM_TAGS "release version-3.51.2"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	154 #define SQLITE_SCM_DATETIME "2026-01-09T17:27:48.405Z"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	155
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	156 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	157 ** CAPI3REF: Run-Time Library Version Numbers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	158 ** KEYWORDS: sqlite3_version sqlite3_sourceid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	159 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	160 ** These interfaces provide the same information as the [SQLITE_VERSION],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	161 ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	162 ** but are associated with the library instead of the header file. ^(Cautious
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	163 ** programmers might include assert() statements in their application to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	164 ** verify that values returned by these interfaces match the macros in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	165 ** the header, and thus ensure that the application is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	166 ** compiled with matching library and header files.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	167 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	168 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	169 ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	170 ** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	171 ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	172 ** </pre></blockquote>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	173 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	174 ** ^The sqlite3_version[] string constant contains the text of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	175 ** [SQLITE_VERSION] macro. ^The sqlite3_libversion() function returns a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	176 ** pointer to the sqlite3_version[] string constant. The sqlite3_libversion()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	177 ** function is provided for use in DLLs since DLL users usually do not have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	178 ** direct access to string constants within the DLL. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	179 ** sqlite3_libversion_number() function returns an integer equal to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	180 ** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	181 ** a pointer to a string constant whose value is the same as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	182 ** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	183 ** using an edited copy of [the amalgamation], then the last four characters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	184 ** of the hash might be different from [SQLITE_SOURCE_ID].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	185 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	186 ** See also: [sqlite_version()] and [sqlite_source_id()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	187 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	188 SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	189 SQLITE_API const char *sqlite3_libversion(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	190 SQLITE_API const char *sqlite3_sourceid(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	191 SQLITE_API int sqlite3_libversion_number(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	192
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	193 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	194 ** CAPI3REF: Run-Time Library Compilation Options Diagnostics
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	195 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	196 ** ^The sqlite3_compileoption_used() function returns 0 or 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	197 ** indicating whether the specified option was defined at
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	198 ** compile time. ^The SQLITE_ prefix may be omitted from the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	199 ** option name passed to sqlite3_compileoption_used().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	200 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	201 ** ^The sqlite3_compileoption_get() function allows iterating
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	202 ** over the list of options that were defined at compile time by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	203 ** returning the N-th compile time option string. ^If N is out of range,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	204 ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	205 ** prefix is omitted from any strings returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	206 ** sqlite3_compileoption_get().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	207 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	208 ** ^Support for the diagnostic functions sqlite3_compileoption_used()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	209 ** and sqlite3_compileoption_get() may be omitted by specifying the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	210 ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	211 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	212 ** See also: SQL functions [sqlite_compileoption_used()] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	213 ** [sqlite_compileoption_get()] and the [compile_options pragma].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	214 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	215 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	216 SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	217 SQLITE_API const char *sqlite3_compileoption_get(int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	218 #else
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	219 # define sqlite3_compileoption_used(X) 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	220 # define sqlite3_compileoption_get(X) ((void*)0)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	221 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	222
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	223 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	224 ** CAPI3REF: Test To See If The Library Is Threadsafe
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	225 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	226 ** ^The sqlite3_threadsafe() function returns zero if and only if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	227 ** SQLite was compiled with mutexing code omitted due to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	228 ** [SQLITE_THREADSAFE] compile-time option being set to 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	229 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	230 ** SQLite can be compiled with or without mutexes. When
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	231 ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	232 ** are enabled and SQLite is threadsafe. When the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	233 ** [SQLITE_THREADSAFE] macro is 0,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	234 ** the mutexes are omitted. Without the mutexes, it is not safe
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	235 ** to use SQLite concurrently from more than one thread.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	236 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	237 ** Enabling mutexes incurs a measurable performance penalty.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	238 ** So if speed is of utmost importance, it makes sense to disable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	239 ** the mutexes. But for maximum safety, mutexes should be enabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	240 ** ^The default behavior is for mutexes to be enabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	241 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	242 ** This interface can be used by an application to make sure that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	243 ** version of SQLite that it is linking against was compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	244 ** the desired setting of the [SQLITE_THREADSAFE] macro.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	245 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	246 ** This interface only reports on the compile-time mutex setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	247 ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	248 ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	249 ** can be fully or partially disabled using a call to [sqlite3_config()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	250 ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	251 ** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	252 ** sqlite3_threadsafe() function shows only the compile-time setting of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	253 ** thread safety, not any run-time changes to that setting made by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	254 ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	255 ** is unchanged by calls to sqlite3_config().)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	256 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	257 ** See the [threading mode] documentation for additional information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	258 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	259 SQLITE_API int sqlite3_threadsafe(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	260
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	261 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	262 ** CAPI3REF: Database Connection Handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	263 ** KEYWORDS: {database connection} {database connections}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	264 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	265 ** Each open SQLite database is represented by a pointer to an instance of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	266 ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	267 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	268 ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	269 ** and [sqlite3_close_v2()] are its destructors. There are many other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	270 ** interfaces (such as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	271 ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	272 ** [sqlite3_busy_timeout()] to name but three) that are methods on an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	273 ** sqlite3 object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	274 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	275 typedef struct sqlite3 sqlite3;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	276
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	277 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	278 ** CAPI3REF: 64-Bit Integer Types
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	279 ** KEYWORDS: sqlite_int64 sqlite_uint64
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	280 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	281 ** Because there is no cross-platform way to specify 64-bit integer types
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	282 ** SQLite includes typedefs for 64-bit signed and unsigned integers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	283 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	284 ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	285 ** The sqlite_int64 and sqlite_uint64 types are supported for backwards
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	286 ** compatibility only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	287 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	288 ** ^The sqlite3_int64 and sqlite_int64 types can store integer values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	289 ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	290 ** sqlite3_uint64 and sqlite_uint64 types can store integer values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	291 ** between 0 and +18446744073709551615 inclusive.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	292 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	293 #ifdef SQLITE_INT64_TYPE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	294 typedef SQLITE_INT64_TYPE sqlite_int64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	295 # ifdef SQLITE_UINT64_TYPE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	296 typedef SQLITE_UINT64_TYPE sqlite_uint64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	297 # else
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	298 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	299 # endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	300 #elif defined(_MSC_VER) \|\| defined(__BORLANDC__)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	301 typedef __int64 sqlite_int64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	302 typedef unsigned __int64 sqlite_uint64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	303 #else
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	304 typedef long long int sqlite_int64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	305 typedef unsigned long long int sqlite_uint64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	306 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	307 typedef sqlite_int64 sqlite3_int64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	308 typedef sqlite_uint64 sqlite3_uint64;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	309
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	310 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	311 ** If compiling for a processor that lacks floating point support,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	312 ** substitute integer for floating-point.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	313 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	314 #ifdef SQLITE_OMIT_FLOATING_POINT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	315 # define double sqlite3_int64
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	316 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	317
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	318 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	319 ** CAPI3REF: Closing A Database Connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	320 ** DESTRUCTOR: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	321 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	322 ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	323 ** for the [sqlite3] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	324 ** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	325 ** the [sqlite3] object is successfully destroyed and all associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	326 ** resources are deallocated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	327 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	328 ** Ideally, applications should [sqlite3_finalize \| finalize] all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	329 ** [prepared statements], [sqlite3_blob_close \| close] all [BLOB handles], and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	330 ** [sqlite3_backup_finish \| finish] all [sqlite3_backup] objects associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	331 ** with the [sqlite3] object prior to attempting to close the object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	332 ** ^If the database connection is associated with unfinalized prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	333 ** statements, BLOB handlers, and/or unfinished sqlite3_backup objects then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	334 ** sqlite3_close() will leave the database connection open and return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	335 ** [SQLITE_BUSY]. ^If sqlite3_close_v2() is called with unfinalized prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	336 ** statements, unclosed BLOB handlers, and/or unfinished sqlite3_backups,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	337 ** it returns [SQLITE_OK] regardless, but instead of deallocating the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	338 ** connection immediately, it marks the database connection as an unusable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	339 ** "zombie" and makes arrangements to automatically deallocate the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	340 ** connection after all prepared statements are finalized, all BLOB handles
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	341 ** are closed, and all backups have finished. The sqlite3_close_v2() interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	342 ** is intended for use with host languages that are garbage collected, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	343 ** where the order in which destructors are called is arbitrary.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	344 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	345 ** ^If an [sqlite3] object is destroyed while a transaction is open,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	346 ** the transaction is automatically rolled back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	347 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	348 ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	349 ** must be either a NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	350 ** pointer or an [sqlite3] object pointer obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	351 ** from [sqlite3_open()], [sqlite3_open16()], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	352 ** [sqlite3_open_v2()], and not previously closed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	353 ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	354 ** argument is a harmless no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	355 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	356 SQLITE_API int sqlite3_close(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	357 SQLITE_API int sqlite3_close_v2(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	358
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	359 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	360 ** The type for a callback function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	361 ** This is legacy and deprecated. It is included for historical
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	362 ** compatibility and is not documented.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	363 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	364 typedef int (sqlite3_callback)(void,int,char, char);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	365
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	366 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	367 ** CAPI3REF: One-Step Query Execution Interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	368 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	369 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	370 ** The sqlite3_exec() interface is a convenience wrapper around
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	371 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	372 ** that allows an application to run multiple statements of SQL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	373 ** without having to use a lot of C code.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	374 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	375 ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	376 ** semicolon-separated SQL statements passed into its 2nd argument,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	377 ** in the context of the [database connection] passed in as its 1st
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	378 ** argument. ^If the callback function of the 3rd argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	379 ** sqlite3_exec() is not NULL, then it is invoked for each result row
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	380 ** coming out of the evaluated SQL statements. ^The 4th argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	381 ** sqlite3_exec() is relayed through to the 1st argument of each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	382 ** callback invocation. ^If the callback pointer to sqlite3_exec()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	383 ** is NULL, then no callback is ever invoked and result rows are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	384 ** ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	385 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	386 ** ^If an error occurs while evaluating the SQL statements passed into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	387 ** sqlite3_exec(), then execution of the current statement stops and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	388 ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	389 ** is not NULL then any error message is written into memory obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	390 ** from [sqlite3_malloc()] and passed back through the 5th parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	391 ** To avoid memory leaks, the application should invoke [sqlite3_free()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	392 ** on error message strings returned through the 5th parameter of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	393 ** sqlite3_exec() after the error message string is no longer needed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	394 ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	395 ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	396 ** NULL before returning.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	397 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	398 ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	399 ** routine returns SQLITE_ABORT without invoking the callback again and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	400 ** without running any subsequent SQL statements.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	401 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	402 ** ^The 2nd argument to the sqlite3_exec() callback function is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	403 ** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	404 ** callback is an array of pointers to strings obtained as if from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	405 ** [sqlite3_column_text()], one for each column. ^If an element of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	406 ** result row is NULL then the corresponding string pointer for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	407 ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	408 ** sqlite3_exec() callback is an array of pointers to strings where each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	409 ** entry represents the name of a corresponding result column as obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	410 ** from [sqlite3_column_name()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	411 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	412 ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	413 ** to an empty string, or a pointer that contains only whitespace and/or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	414 ** SQL comments, then no SQL statements are evaluated and the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	415 ** is not changed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	416 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	417 ** Restrictions:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	418 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	419 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	420 ** <li> The application must ensure that the 1st parameter to sqlite3_exec()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	421 ** is a valid and open [database connection].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	422 ** <li> The application must not close the [database connection] specified by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	423 ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	424 ** <li> The application must not modify the SQL statement text passed into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	425 ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	426 ** <li> The application must not dereference the arrays or string pointers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	427 ** passed as the 3rd and 4th callback parameters after it returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	428 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	429 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	430 SQLITE_API int sqlite3_exec(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	431 sqlite3, / An open database */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	432 const char sql, / SQL to be evaluated */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	433 int (callback)(void,int,char,char), /* Callback function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	434 void , / 1st argument to callback */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	435 char *errmsg / Error msg written here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	436 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	437
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	438 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	439 ** CAPI3REF: Result Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	440 ** KEYWORDS: {result code definitions}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	441 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	442 ** Many SQLite functions return an integer result code from the set shown
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	443 ** here in order to indicate success or failure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	444 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	445 ** New error codes may be added in future versions of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	446 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	447 ** See also: [extended result code definitions]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	448 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	449 #define SQLITE_OK 0 /* Successful result */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	450 /* beginning-of-error-codes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	451 #define SQLITE_ERROR 1 /* Generic error */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	452 #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	453 #define SQLITE_PERM 3 /* Access permission denied */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	454 #define SQLITE_ABORT 4 /* Callback routine requested an abort */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	455 #define SQLITE_BUSY 5 /* The database file is locked */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	456 #define SQLITE_LOCKED 6 /* A table in the database is locked */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	457 #define SQLITE_NOMEM 7 /* A malloc() failed */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	458 #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	459 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	460 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	461 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	462 #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	463 #define SQLITE_FULL 13 /* Insertion failed because database is full */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	464 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	465 #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	466 #define SQLITE_EMPTY 16 /* Internal use only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	467 #define SQLITE_SCHEMA 17 /* The database schema changed */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	468 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	469 #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	470 #define SQLITE_MISMATCH 20 /* Data type mismatch */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	471 #define SQLITE_MISUSE 21 /* Library used incorrectly */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	472 #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	473 #define SQLITE_AUTH 23 /* Authorization denied */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	474 #define SQLITE_FORMAT 24 /* Not used */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	475 #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	476 #define SQLITE_NOTADB 26 /* File opened that is not a database file */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	477 #define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	478 #define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	479 #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	480 #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	481 /* end-of-error-codes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	482
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	483 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	484 ** CAPI3REF: Extended Result Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	485 ** KEYWORDS: {extended result code definitions}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	486 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	487 ** In its default configuration, SQLite API routines return one of 30 integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	488 ** [result codes]. However, experience has shown that many of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	489 ** these result codes are too coarse-grained. They do not provide as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	490 ** much information about problems as programmers might like. In an effort to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	491 ** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	492 ** and later) include
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	493 ** support for additional result codes that provide more detailed information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	494 ** about errors. These [extended result codes] are enabled or disabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	495 ** on a per database connection basis using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	496 ** [sqlite3_extended_result_codes()] API. Or, the extended code for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	497 ** the most recent error can be obtained using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	498 ** [sqlite3_extended_errcode()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	499 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	500 #define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	501 #define SQLITE_ERROR_RETRY (SQLITE_ERROR \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	502 #define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	503 #define SQLITE_ERROR_RESERVESIZE (SQLITE_ERROR \| (4<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	504 #define SQLITE_ERROR_KEY (SQLITE_ERROR \| (5<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	505 #define SQLITE_ERROR_UNABLE (SQLITE_ERROR \| (6<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	506 #define SQLITE_IOERR_READ (SQLITE_IOERR \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	507 #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	508 #define SQLITE_IOERR_WRITE (SQLITE_IOERR \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	509 #define SQLITE_IOERR_FSYNC (SQLITE_IOERR \| (4<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	510 #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR \| (5<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	511 #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR \| (6<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	512 #define SQLITE_IOERR_FSTAT (SQLITE_IOERR \| (7<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	513 #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR \| (8<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	514 #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR \| (9<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	515 #define SQLITE_IOERR_DELETE (SQLITE_IOERR \| (10<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	516 #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR \| (11<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	517 #define SQLITE_IOERR_NOMEM (SQLITE_IOERR \| (12<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	518 #define SQLITE_IOERR_ACCESS (SQLITE_IOERR \| (13<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	519 #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR \| (14<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	520 #define SQLITE_IOERR_LOCK (SQLITE_IOERR \| (15<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	521 #define SQLITE_IOERR_CLOSE (SQLITE_IOERR \| (16<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	522 #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR \| (17<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	523 #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR \| (18<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	524 #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR \| (19<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	525 #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR \| (20<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	526 #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR \| (21<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	527 #define SQLITE_IOERR_SEEK (SQLITE_IOERR \| (22<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	528 #define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR \| (23<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	529 #define SQLITE_IOERR_MMAP (SQLITE_IOERR \| (24<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	530 #define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR \| (25<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	531 #define SQLITE_IOERR_CONVPATH (SQLITE_IOERR \| (26<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	532 #define SQLITE_IOERR_VNODE (SQLITE_IOERR \| (27<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	533 #define SQLITE_IOERR_AUTH (SQLITE_IOERR \| (28<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	534 #define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR \| (29<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	535 #define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR \| (30<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	536 #define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR \| (31<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	537 #define SQLITE_IOERR_DATA (SQLITE_IOERR \| (32<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	538 #define SQLITE_IOERR_CORRUPTFS (SQLITE_IOERR \| (33<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	539 #define SQLITE_IOERR_IN_PAGE (SQLITE_IOERR \| (34<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	540 #define SQLITE_IOERR_BADKEY (SQLITE_IOERR \| (35<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	541 #define SQLITE_IOERR_CODEC (SQLITE_IOERR \| (36<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	542 #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	543 #define SQLITE_LOCKED_VTAB (SQLITE_LOCKED \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	544 #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	545 #define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	546 #define SQLITE_BUSY_TIMEOUT (SQLITE_BUSY \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	547 #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	548 #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	549 #define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	550 #define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN \| (4<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	551 #define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN \| (5<<8)) /* Not Used */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	552 #define SQLITE_CANTOPEN_SYMLINK (SQLITE_CANTOPEN \| (6<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	553 #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	554 #define SQLITE_CORRUPT_SEQUENCE (SQLITE_CORRUPT \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	555 #define SQLITE_CORRUPT_INDEX (SQLITE_CORRUPT \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	556 #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	557 #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	558 #define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	559 #define SQLITE_READONLY_DBMOVED (SQLITE_READONLY \| (4<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	560 #define SQLITE_READONLY_CANTINIT (SQLITE_READONLY \| (5<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	561 #define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY \| (6<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	562 #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	563 #define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	564 #define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	565 #define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	566 #define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT \| (4<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	567 #define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT \| (5<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	568 #define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT \| (6<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	569 #define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT \| (7<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	570 #define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT \| (8<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	571 #define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT \| (9<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	572 #define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT \|(10<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	573 #define SQLITE_CONSTRAINT_PINNED (SQLITE_CONSTRAINT \|(11<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	574 #define SQLITE_CONSTRAINT_DATATYPE (SQLITE_CONSTRAINT \|(12<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	575 #define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	576 #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE \| (2<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	577 #define SQLITE_NOTICE_RBU (SQLITE_NOTICE \| (3<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	578 #define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	579 #define SQLITE_AUTH_USER (SQLITE_AUTH \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	580 #define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK \| (1<<8))
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	581 #define SQLITE_OK_SYMLINK (SQLITE_OK \| (2<<8)) /* internal use only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	582
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	583 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	584 ** CAPI3REF: Flags For File Open Operations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	585 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	586 ** These bit values are intended for use in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	587 ** 3rd parameter to the [sqlite3_open_v2()] interface and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	588 ** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	589 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	590 ** Only those flags marked as "Ok for sqlite3_open_v2()" may be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	591 ** used as the third argument to the [sqlite3_open_v2()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	592 ** The other flags have historically been ignored by sqlite3_open_v2(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	593 ** though future versions of SQLite might change so that an error is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	594 ** raised if any of the disallowed bits are passed into sqlite3_open_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	595 ** Applications should not depend on the historical behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	596 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	597 ** Note in particular that passing the SQLITE_OPEN_EXCLUSIVE flag into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	598 ** [sqlite3_open_v2()] does not cause the underlying database file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	599 ** to be opened using O_EXCL. Passing SQLITE_OPEN_EXCLUSIVE into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	600 ** [sqlite3_open_v2()] has historically been a no-op and might become an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	601 ** error in future versions of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	602 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	603 #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	604 #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	605 #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	606 #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	607 #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	608 #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	609 #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	610 #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	611 #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	612 #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	613 #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	614 #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	615 #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	616 #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	617 #define SQLITE_OPEN_SUPER_JOURNAL 0x00004000 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	618 #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	619 #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	620 #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	621 #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	622 #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	623 #define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for sqlite3_open_v2() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	624 #define SQLITE_OPEN_EXRESCODE 0x02000000 /* Extended result codes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	625
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	626 /* Reserved: 0x00F00000 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	627 /* Legacy compatibility: */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	628 #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	629
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	630
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	631 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	632 ** CAPI3REF: Device Characteristics
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	633 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	634 ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	635 ** object returns an integer which is a vector of these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	636 ** bit values expressing I/O characteristics of the mass storage
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	637 ** device that holds the file that the [sqlite3_io_methods]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	638 ** refers to.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	639 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	640 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	641 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	642 ** mean that writes of blocks that are nnn bytes in size and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	643 ** are aligned to an address which is an integer multiple of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	644 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	645 ** that when data is appended to a file, the data is appended
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	646 ** first then the size of the file is extended, never the other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	647 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	648 ** information is written to disk in the same order as calls
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	649 ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	650 ** after reboot following a crash or power loss, the only bytes in a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	651 ** file that were written at the application level might have changed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	652 ** and that adjacent bytes, even bytes within the same sector are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	653 ** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	654 ** flag indicates that a file cannot be deleted when open. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	655 ** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	656 ** read-only media and cannot be changed even by processes with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	657 ** elevated privileges.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	658 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	659 ** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	660 ** filesystem supports doing multiple write operations atomically when those
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	661 ** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	662 ** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	663 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	664 ** The SQLITE_IOCAP_SUBPAGE_READ property means that it is ok to read
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	665 ** from the database file in amounts that are not a multiple of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	666 ** page size and that do not begin at a page boundary. Without this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	667 ** property, SQLite is careful to only do full-page reads and write
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	668 ** on aligned pages, with the one exception that it will do a sub-page
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	669 ** read of the first page to access the database header.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	670 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	671 #define SQLITE_IOCAP_ATOMIC 0x00000001
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	672 #define SQLITE_IOCAP_ATOMIC512 0x00000002
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	673 #define SQLITE_IOCAP_ATOMIC1K 0x00000004
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	674 #define SQLITE_IOCAP_ATOMIC2K 0x00000008
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	675 #define SQLITE_IOCAP_ATOMIC4K 0x00000010
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	676 #define SQLITE_IOCAP_ATOMIC8K 0x00000020
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	677 #define SQLITE_IOCAP_ATOMIC16K 0x00000040
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	678 #define SQLITE_IOCAP_ATOMIC32K 0x00000080
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	679 #define SQLITE_IOCAP_ATOMIC64K 0x00000100
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	680 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	681 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	682 #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	683 #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	684 #define SQLITE_IOCAP_IMMUTABLE 0x00002000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	685 #define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	686 #define SQLITE_IOCAP_SUBPAGE_READ 0x00008000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	687
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	688 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	689 ** CAPI3REF: File Locking Levels
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	690 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	691 ** SQLite uses one of these integer values as the second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	692 ** argument to calls it makes to the xLock() and xUnlock() methods
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	693 ** of an [sqlite3_io_methods] object. These values are ordered from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	694 ** least restrictive to most restrictive.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	695 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	696 ** The argument to xLock() is always SHARED or higher. The argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	697 ** xUnlock is either SHARED or NONE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	698 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	699 #define SQLITE_LOCK_NONE 0 /* xUnlock() only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	700 #define SQLITE_LOCK_SHARED 1 /* xLock() or xUnlock() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	701 #define SQLITE_LOCK_RESERVED 2 /* xLock() only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	702 #define SQLITE_LOCK_PENDING 3 /* xLock() only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	703 #define SQLITE_LOCK_EXCLUSIVE 4 /* xLock() only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	704
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	705 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	706 ** CAPI3REF: Synchronization Type Flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	707 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	708 ** When SQLite invokes the xSync() method of an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	709 ** [sqlite3_io_methods] object it uses a combination of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	710 ** these integer values as the second argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	711 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	712 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	713 ** sync operation only needs to flush data to mass storage. Inode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	714 ** information need not be flushed. If the lower four bits of the flag
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	715 ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	716 ** If the lower four bits equal SQLITE_SYNC_FULL, that means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	717 ** to use Mac OS X style fullsync instead of fsync().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	718 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	719 ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	720 ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	721 ** settings. The [synchronous pragma] determines when calls to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	722 ** xSync VFS method occur and applies uniformly across all platforms.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	723 ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	724 ** energetic or rigorous or forceful the sync operations are and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	725 ** only make a difference on Mac OSX for the default SQLite code.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	726 ** (Third-party VFS implementations might also make the distinction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	727 ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	728 ** operating systems natively supported by SQLite, only Mac OSX
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	729 ** cares about the difference.)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	730 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	731 #define SQLITE_SYNC_NORMAL 0x00002
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	732 #define SQLITE_SYNC_FULL 0x00003
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	733 #define SQLITE_SYNC_DATAONLY 0x00010
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	734
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	735 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	736 ** CAPI3REF: OS Interface Open File Handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	737 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	738 ** An [sqlite3_file] object represents an open file in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	739 ** [sqlite3_vfs \| OS interface layer]. Individual OS interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	740 ** implementations will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	741 ** want to subclass this object by appending additional fields
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	742 ** for their own use. The pMethods entry is a pointer to an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	743 ** [sqlite3_io_methods] object that defines methods for performing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	744 ** I/O operations on the open file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	745 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	746 typedef struct sqlite3_file sqlite3_file;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	747 struct sqlite3_file {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	748 const struct sqlite3_io_methods pMethods; / Methods for an open file */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	749 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	750
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	751 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	752 ** CAPI3REF: OS Interface File Virtual Methods Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	753 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	754 ** Every file opened by the [sqlite3_vfs.xOpen] method populates an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	755 ** [sqlite3_file] object (or, more commonly, a subclass of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	756 ** [sqlite3_file] object) with a pointer to an instance of this object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	757 ** This object defines the methods used to perform various operations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	758 ** against the open file represented by the [sqlite3_file] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	759 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	760 ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	761 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	762 ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	763 ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	764 ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	765 ** to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	766 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	767 ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	768 ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	769 ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	770 ** flag may be ORed in to indicate that only the data of the file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	771 ** and not its inode needs to be synced.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	772 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	773 ** The integer values to xLock() and xUnlock() are one of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	774 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	775 ** <li> [SQLITE_LOCK_NONE],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	776 ** <li> [SQLITE_LOCK_SHARED],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	777 ** <li> [SQLITE_LOCK_RESERVED],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	778 ** <li> [SQLITE_LOCK_PENDING], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	779 ** <li> [SQLITE_LOCK_EXCLUSIVE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	780 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	781 ** xLock() upgrades the database file lock. In other words, xLock() moves the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	782 ** database file lock in the direction NONE toward EXCLUSIVE. The argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	783 ** xLock() is always one of SHARED, RESERVED, PENDING, or EXCLUSIVE, never
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	784 ** SQLITE_LOCK_NONE. If the database file lock is already at or above the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	785 ** requested lock, then the call to xLock() is a no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	786 ** xUnlock() downgrades the database file lock to either SHARED or NONE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	787 ** If the lock is already at or below the requested lock state, then the call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	788 ** to xUnlock() is a no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	789 ** The xCheckReservedLock() method checks whether any database connection,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	790 ** either in this process or in some other process, is holding a RESERVED,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	791 ** PENDING, or EXCLUSIVE lock on the file. It returns, via its output
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	792 ** pointer parameter, true if such a lock exists and false otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	793 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	794 ** The xFileControl() method is a generic interface that allows custom
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	795 ** VFS implementations to directly control an open file using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	796 ** [sqlite3_file_control()] interface. The second "op" argument is an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	797 ** integer opcode. The third argument is a generic pointer intended to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	798 ** point to a structure that may contain arguments or space in which to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	799 ** write return values. Potential uses for xFileControl() might be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	800 ** functions to enable blocking locks with timeouts, to change the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	801 ** locking strategy (for example to use dot-file locks), to inquire
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	802 ** about the status of a lock, or to break stale locks. The SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	803 ** core reserves all opcodes less than 100 for its own use.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	804 ** A [file control opcodes \| list of opcodes] less than 100 is available.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	805 ** Applications that define a custom xFileControl method should use opcodes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	806 ** greater than 100 to avoid conflicts. VFS implementations should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	807 ** return [SQLITE_NOTFOUND] for file control opcodes that they do not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	808 ** recognize.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	809 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	810 ** The xSectorSize() method returns the sector size of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	811 ** device that underlies the file. The sector size is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	812 ** minimum write that can be performed without disturbing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	813 ** other bytes in the file. The xDeviceCharacteristics()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	814 ** method returns a bit vector describing behaviors of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	815 ** underlying device:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	816 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	817 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	818 ** <li> [SQLITE_IOCAP_ATOMIC]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	819 ** <li> [SQLITE_IOCAP_ATOMIC512]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	820 ** <li> [SQLITE_IOCAP_ATOMIC1K]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	821 ** <li> [SQLITE_IOCAP_ATOMIC2K]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	822 ** <li> [SQLITE_IOCAP_ATOMIC4K]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	823 ** <li> [SQLITE_IOCAP_ATOMIC8K]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	824 ** <li> [SQLITE_IOCAP_ATOMIC16K]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	825 ** <li> [SQLITE_IOCAP_ATOMIC32K]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	826 ** <li> [SQLITE_IOCAP_ATOMIC64K]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	827 ** <li> [SQLITE_IOCAP_SAFE_APPEND]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	828 ** <li> [SQLITE_IOCAP_SEQUENTIAL]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	829 ** <li> [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	830 ** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	831 ** <li> [SQLITE_IOCAP_IMMUTABLE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	832 ** <li> [SQLITE_IOCAP_BATCH_ATOMIC]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	833 ** <li> [SQLITE_IOCAP_SUBPAGE_READ]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	834 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	835 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	836 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	837 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	838 ** mean that writes of blocks that are nnn bytes in size and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	839 ** are aligned to an address which is an integer multiple of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	840 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	841 ** that when data is appended to a file, the data is appended
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	842 ** first then the size of the file is extended, never the other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	843 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	844 ** information is written to disk in the same order as calls
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	845 ** to xWrite().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	846 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	847 ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	848 ** in the unread portions of the buffer with zeros. A VFS that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	849 ** fails to zero-fill short reads might seem to work. However,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	850 ** failure to zero-fill short reads will eventually lead to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	851 ** database corruption.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	852 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	853 typedef struct sqlite3_io_methods sqlite3_io_methods;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	854 struct sqlite3_io_methods {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	855 int iVersion;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	856 int (xClose)(sqlite3_file);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	857 int (xRead)(sqlite3_file, void*, int iAmt, sqlite3_int64 iOfst);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	858 int (xWrite)(sqlite3_file, const void*, int iAmt, sqlite3_int64 iOfst);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	859 int (xTruncate)(sqlite3_file, sqlite3_int64 size);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	860 int (xSync)(sqlite3_file, int flags);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	861 int (xFileSize)(sqlite3_file, sqlite3_int64 *pSize);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	862 int (xLock)(sqlite3_file, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	863 int (xUnlock)(sqlite3_file, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	864 int (xCheckReservedLock)(sqlite3_file, int *pResOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	865 int (xFileControl)(sqlite3_file, int op, void *pArg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	866 int (xSectorSize)(sqlite3_file);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	867 int (xDeviceCharacteristics)(sqlite3_file);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	868 /* Methods above are valid for version 1 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	869 int (xShmMap)(sqlite3_file, int iPg, int pgsz, int, void volatile**);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	870 int (xShmLock)(sqlite3_file, int offset, int n, int flags);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	871 void (xShmBarrier)(sqlite3_file);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	872 int (xShmUnmap)(sqlite3_file, int deleteFlag);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	873 /* Methods above are valid for version 2 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	874 int (xFetch)(sqlite3_file, sqlite3_int64 iOfst, int iAmt, void **pp);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	875 int (xUnfetch)(sqlite3_file, sqlite3_int64 iOfst, void *p);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	876 /* Methods above are valid for version 3 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	877 /* Additional methods may be added in future releases */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	878 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	879
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	880 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	881 ** CAPI3REF: Standard File Control Opcodes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	882 ** KEYWORDS: {file control opcodes} {file control opcode}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	883 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	884 ** These integer constants are opcodes for the xFileControl method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	885 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	886 ** interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	887 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	888 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	889 ** <li>[[SQLITE_FCNTL_LOCKSTATE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	890 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	891 ** opcode causes the xFileControl method to write the current state of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	892 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	893 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	894 ** into an integer that the pArg argument points to.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	895 ** This capability is only available if SQLite is compiled with [SQLITE_DEBUG].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	896 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	897 ** <li>[[SQLITE_FCNTL_SIZE_HINT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	898 ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	899 ** layer a hint of how large the database file will grow to be during the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	900 ** current transaction. This hint is not guaranteed to be accurate but it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	901 ** is often close. The underlying VFS might choose to preallocate database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	902 ** file space based on this hint in order to help writes to the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	903 ** file run faster.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	904 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	905 ** <li>[[SQLITE_FCNTL_SIZE_LIMIT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	906 ** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	907 ** implements [sqlite3_deserialize()] to set an upper bound on the size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	908 ** of the in-memory database. The argument is a pointer to a [sqlite3_int64].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	909 ** If the integer pointed to is negative, then it is filled in with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	910 ** current limit. Otherwise the limit is set to the larger of the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	911 ** of the integer pointed to and the current database size. The integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	912 ** pointed to is set to the new limit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	913 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	914 ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	915 ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	916 ** extends and truncates the database file in chunks of a size specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	917 ** by the user. The fourth argument to [sqlite3_file_control()] should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	918 ** point to an integer (type int) containing the new chunk-size to use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	919 ** for the nominated database. Allocating database file space in large
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	920 ** chunks (say 1MB at a time), may reduce file-system fragmentation and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	921 ** improve performance on some systems.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	922 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	923 ** <li>[[SQLITE_FCNTL_FILE_POINTER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	924 ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	925 ** to the [sqlite3_file] object associated with a particular database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	926 ** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	927 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	928 ** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	929 ** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	930 ** to the [sqlite3_file] object associated with the journal file (either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	931 ** the [rollback journal] or the [write-ahead log]) for a particular database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	932 ** connection. See also [SQLITE_FCNTL_FILE_POINTER].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	933 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	934 ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	935 ** The SQLITE_FCNTL_SYNC_OMITTED file-control is no longer used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	936 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	937 ** <li>[[SQLITE_FCNTL_SYNC]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	938 ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	939 ** sent to the VFS immediately before the xSync method is invoked on a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	940 ** database file descriptor. Or, if the xSync method is not invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	941 ** because the user has configured SQLite with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	942 ** [PRAGMA synchronous \| PRAGMA synchronous=OFF] it is invoked in place
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	943 ** of the xSync method. In most cases, the pointer argument passed with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	944 ** this file-control is NULL. However, if the database file is being synced
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	945 ** as part of a multi-database commit, the argument points to a nul-terminated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	946 ** string containing the transactions super-journal file name. VFSes that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	947 ** do not need this signal should silently ignore this opcode. Applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	948 ** should not call [sqlite3_file_control()] with this opcode as doing so may
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	949 ** disrupt the operation of the specialized VFSes that do require it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	950 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	951 ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	952 ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	953 ** and sent to the VFS after a transaction has been committed immediately
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	954 ** but before the database is unlocked. VFSes that do not need this signal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	955 ** should silently ignore this opcode. Applications should not call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	956 ** [sqlite3_file_control()] with this opcode as doing so may disrupt the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	957 ** operation of the specialized VFSes that do require it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	958 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	959 ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	960 ** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	961 ** retry counts and intervals for certain disk I/O operations for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	962 ** windows [VFS] in order to provide robustness in the presence of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	963 ** anti-virus programs. By default, the windows VFS will retry file read,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	964 ** file write, and file delete operations up to 10 times, with a delay
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	965 ** of 25 milliseconds before the first retry and with the delay increasing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	966 ** by an additional 25 milliseconds with each subsequent retry. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	967 ** opcode allows these two values (10 retries and 25 milliseconds of delay)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	968 ** to be adjusted. The values are changed for all database connections
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	969 ** within the same process. The argument is a pointer to an array of two
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	970 ** integers where the first integer is the new retry count and the second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	971 ** integer is the delay. If either integer is negative, then the setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	972 ** is not changed but instead the prior value of that setting is written
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	973 ** into the array entry, allowing the current retry settings to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	974 ** interrogated. The zDbName parameter is ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	975 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	976 ** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	977 ** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	978 ** persistent [WAL \| Write Ahead Log] setting. By default, the auxiliary
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	979 ** write ahead log ([WAL file]) and shared memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	980 ** files used for transaction control
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	981 ** are automatically deleted when the latest connection to the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	982 ** closes. Setting persistent WAL mode causes those files to persist after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	983 ** close. Persisting the files is useful when other processes that do not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	984 ** have write permission on the directory containing the database file want
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	985 ** to read the database file, as the WAL and shared memory files must exist
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	986 ** in order for the database to be readable. The fourth parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	987 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	988 ** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	989 ** WAL mode. If the integer is -1, then it is overwritten with the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	990 ** WAL persistence setting.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	991 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	992 ** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	993 ** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	994 ** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	995 ** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	996 ** xDeviceCharacteristics methods. The fourth parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	997 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	998 ** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	999 ** mode. If the integer is -1, then it is overwritten with the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1000 ** zero-damage mode setting.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1001 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1002 ** <li>[[SQLITE_FCNTL_OVERWRITE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1003 ** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1004 ** a write transaction to indicate that, unless it is rolled back for some
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1005 ** reason, the entire database file will be overwritten by the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1006 ** transaction. This is used by VACUUM operations.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1007 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1008 ** <li>[[SQLITE_FCNTL_VFSNAME]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1009 ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1010 ** all [VFSes] in the VFS stack. The names of all VFS shims and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1011 ** final bottom-level VFS are written into memory obtained from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1012 ** [sqlite3_malloc()] and the result is stored in the char* variable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1013 ** that the fourth parameter of [sqlite3_file_control()] points to.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1014 ** The caller is responsible for freeing the memory when done. As with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1015 ** all file-control actions, there is no guarantee that this will actually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1016 ** do anything. Callers should initialize the char* variable to a NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1017 ** pointer in case this file-control is not implemented. This file-control
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1018 ** is intended for diagnostic use only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1019 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1020 ** <li>[[SQLITE_FCNTL_VFS_POINTER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1021 ** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1022 ** [VFSes] currently in use. ^(The argument X in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1023 ** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1024 of type "[sqlite3_vfs] ". This opcode will set *X
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1025 ** to a pointer to the top-level VFS.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1026 ** ^When there are multiple VFS shims in the stack, this opcode finds the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1027 ** upper-most shim only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1028 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1029 ** <li>[[SQLITE_FCNTL_PRAGMA]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1030 ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1031 ** file control is sent to the open [sqlite3_file] object corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1032 ** to the database file to which the pragma statement refers. ^The argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1033 ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1034 pointers to strings (char) in which the second element of the array
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1035 ** is the name of the pragma and the third element is the argument to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1036 ** pragma or NULL if the pragma has no argument. ^The handler for an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1037 ** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1038 of the char argument point to a string obtained from [sqlite3_mprintf()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1039 ** or the equivalent and that string will become the result of the pragma or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1040 ** the error message if the pragma fails. ^If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1041 ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1042 ** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1043 ** file control returns [SQLITE_OK], then the parser assumes that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1044 ** VFS has handled the PRAGMA itself and the parser generates a no-op
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1045 ** prepared statement if result string is NULL, or that returns a copy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1046 ** of the result string if the string is non-NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1047 ** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1048 ** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1049 ** that the VFS encountered an error while handling the [PRAGMA] and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1050 ** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1051 ** file control occurs at the beginning of pragma statement analysis and so
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1052 ** it is able to override built-in [PRAGMA] statements.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1053 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1054 ** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1055 ** ^The [SQLITE_FCNTL_BUSYHANDLER]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1056 ** file-control may be invoked by SQLite on the database file handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1057 ** shortly after it is opened in order to provide a custom VFS with access
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1058 to the connection's busy-handler callback. The argument is of type (void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1059 ** - an array of two (void ) values. The first (void ) actually points
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1060 ** to a function of type (int ()(void )). In order to invoke the connection's
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1061 ** busy-handler, this function should be invoked with the second (void *) in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1062 ** the array as the only argument. If it returns non-zero, then the operation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1063 ** should be retried. If it returns zero, the custom VFS should abandon the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1064 ** current operation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1065 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1066 ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1067 ** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1068 ** to have SQLite generate a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1069 ** temporary filename using the same algorithm that is followed to generate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1070 ** temporary filenames for TEMP tables and other internal uses. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1071 argument should be a char which will be filled with the filename
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1072 ** written into memory obtained from [sqlite3_malloc()]. The caller should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1073 ** invoke [sqlite3_free()] on the result to avoid a memory leak.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1074 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1075 ** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1076 ** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1077 ** maximum number of bytes that will be used for memory-mapped I/O.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1078 ** The argument is a pointer to a value of type sqlite3_int64 that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1079 ** is an advisory maximum number of bytes in the file to memory map. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1080 ** pointer is overwritten with the old value. The limit is not changed if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1081 ** the value originally pointed to is negative, and so the current limit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1082 ** can be queried by passing in a pointer to a negative number. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1083 ** file-control is used internally to implement [PRAGMA mmap_size].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1084 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1085 ** <li>[[SQLITE_FCNTL_TRACE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1086 ** The [SQLITE_FCNTL_TRACE] file control provides advisory information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1087 ** to the VFS about what the higher layers of the SQLite stack are doing.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1088 ** This file control is used by some VFS activity tracing [shims].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1089 ** The argument is a zero-terminated string. Higher layers in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1090 ** SQLite stack may generate instances of this file control if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1091 ** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1092 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1093 ** <li>[[SQLITE_FCNTL_HAS_MOVED]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1094 ** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1095 ** pointer to an integer and it writes a boolean into that integer depending
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1096 ** on whether or not the file has been renamed, moved, or deleted since it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1097 ** was first opened.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1098 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1099 ** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1100 ** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1101 ** underlying native file handle associated with a file handle. This file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1102 ** control interprets its argument as a pointer to a native file handle and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1103 ** writes the resulting value there.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1104 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1105 ** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1106 ** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1107 ** opcode causes the xFileControl method to swap the file handle with the one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1108 ** pointed to by the pArg argument. This capability is used during testing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1109 ** and only needs to be supported when SQLITE_TEST is defined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1110 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1111 ** <li>[[SQLITE_FCNTL_NULL_IO]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1112 ** The [SQLITE_FCNTL_NULL_IO] opcode sets the low-level file descriptor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1113 ** or file handle for the [sqlite3_file] object such that it will no longer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1114 ** read or write to the database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1115 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1116 ** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1117 ** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1118 ** be advantageous to block on the next WAL lock if the lock is not immediately
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1119 ** available. The WAL subsystem issues this signal during rare
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1120 ** circumstances in order to fix a problem with priority inversion.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1121 ** Applications should <em>not</em> use this file-control.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1122 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1123 ** <li>[[SQLITE_FCNTL_ZIPVFS]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1124 ** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1125 ** VFS should return SQLITE_NOTFOUND for this opcode.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1126 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1127 ** <li>[[SQLITE_FCNTL_RBU]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1128 ** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1129 ** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1130 ** this opcode.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1131 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1132 ** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1133 ** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1134 ** the file descriptor is placed in "batch write mode", which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1135 ** means all subsequent write operations will be deferred and done
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1136 ** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1137 ** that do not support batch atomic writes will return SQLITE_NOTFOUND.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1138 ** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1139 ** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1140 ** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1141 ** no VFS interface calls on the same [sqlite3_file] file descriptor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1142 ** except for calls to the xWrite method and the xFileControl method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1143 ** with [SQLITE_FCNTL_SIZE_HINT].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1144 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1145 ** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1146 ** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1147 ** operations since the previous successful call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1148 ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1149 ** This file control returns [SQLITE_OK] if and only if the writes were
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1150 ** all performed successfully and have been committed to persistent storage.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1151 ** ^Regardless of whether or not it is successful, this file control takes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1152 ** the file descriptor out of batch write mode so that all subsequent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1153 ** write operations are independent.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1154 ** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1155 ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1156 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1157 ** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1158 ** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1159 ** operations since the previous successful call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1160 ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1161 ** ^This file control takes the file descriptor out of batch write mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1162 ** so that all subsequent write operations are independent.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1163 ** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1164 ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1165 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1166 ** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1167 ** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode is used to configure a VFS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1168 ** to block for up to M milliseconds before failing when attempting to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1169 ** obtain a file lock using the xLock or xShmLock methods of the VFS.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1170 ** The parameter is a pointer to a 32-bit signed integer that contains
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1171 ** the value that M is to be set to. Before returning, the 32-bit signed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1172 ** integer is overwritten with the previous value of M.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1173 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1174 ** <li>[[SQLITE_FCNTL_BLOCK_ON_CONNECT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1175 ** The [SQLITE_FCNTL_BLOCK_ON_CONNECT] opcode is used to configure the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1176 ** VFS to block when taking a SHARED lock to connect to a wal mode database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1177 ** This is used to implement the functionality associated with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1178 ** SQLITE_SETLK_BLOCK_ON_CONNECT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1179 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1180 ** <li>[[SQLITE_FCNTL_DATA_VERSION]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1181 ** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1182 ** a database file. The argument is a pointer to a 32-bit unsigned integer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1183 ** The "data version" for the pager is written into the pointer. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1184 ** "data version" changes whenever any change occurs to the corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1185 ** database file, either through SQL statements on the same database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1186 ** connection or through transactions committed by separate database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1187 ** connections possibly in other processes. The [sqlite3_total_changes()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1188 ** interface can be used to find if any database on the connection has changed,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1189 ** but that interface responds to changes on TEMP as well as MAIN and does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1190 ** not provide a mechanism to detect changes to MAIN only. Also, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1191 ** [sqlite3_total_changes()] interface responds to internal changes only and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1192 ** omits changes made by other database connections. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1193 ** [PRAGMA data_version] command provides a mechanism to detect changes to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1194 ** a single attached database that occur due to other database connections,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1195 ** but omits changes implemented by the database connection on which it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1196 ** called. This file control is the only mechanism to detect changes that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1197 ** happen either internally or externally and that are associated with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1198 ** a particular attached database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1199 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1200 ** <li>[[SQLITE_FCNTL_CKPT_START]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1201 ** The [SQLITE_FCNTL_CKPT_START] opcode is invoked from within a checkpoint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1202 ** in wal mode before the client starts to copy pages from the wal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1203 ** file to the database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1204 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1205 ** <li>[[SQLITE_FCNTL_CKPT_DONE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1206 ** The [SQLITE_FCNTL_CKPT_DONE] opcode is invoked from within a checkpoint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1207 ** in wal mode after the client has finished copying pages from the wal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1208 ** file to the database file, but before the *-shm file is updated to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1209 ** record the fact that the pages have been checkpointed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1210 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1211 ** <li>[[SQLITE_FCNTL_EXTERNAL_READER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1212 ** The EXPERIMENTAL [SQLITE_FCNTL_EXTERNAL_READER] opcode is used to detect
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1213 ** whether or not there is a database client in another process with a wal-mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1214 ** transaction open on the database or not. It is only available on unix. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1215 ** (void*) argument passed with this file-control should be a pointer to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1216 ** value of type (int). The integer value is set to 1 if the database is a wal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1217 ** mode database and there exists at least one client in another process that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1218 ** currently has an SQL transaction open on the database. It is set to 0 if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1219 ** the database is not a wal-mode db, or if there is no such connection in any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1220 ** other process. This opcode cannot be used to detect transactions opened
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1221 ** by clients within the current process, only within other processes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1222 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1223 ** <li>[[SQLITE_FCNTL_CKSM_FILE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1224 ** The [SQLITE_FCNTL_CKSM_FILE] opcode is for use internally by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1225 ** [checksum VFS shim] only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1226 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1227 ** <li>[[SQLITE_FCNTL_RESET_CACHE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1228 ** If there is currently no transaction open on the database, and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1229 ** database is not a temp db, then the [SQLITE_FCNTL_RESET_CACHE] file-control
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1230 ** purges the contents of the in-memory page cache. If there is an open
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1231 ** transaction, or if the db is a temp-db, this opcode is a no-op, not an error.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1232 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1233 ** <li>[[SQLITE_FCNTL_FILESTAT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1234 ** The [SQLITE_FCNTL_FILESTAT] opcode returns low-level diagnostic information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1235 ** about the [sqlite3_file] objects used access the database and journal files
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1236 ** for the given schema. The fourth parameter to [sqlite3_file_control()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1237 ** should be an initialized [sqlite3_str] pointer. JSON text describing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1238 ** various aspects of the sqlite3_file object is appended to the sqlite3_str.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1239 ** The SQLITE_FCNTL_FILESTAT opcode is usually a no-op, unless compile-time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1240 ** options are used to enable it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1241 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1242 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1243 #define SQLITE_FCNTL_LOCKSTATE 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1244 #define SQLITE_FCNTL_GET_LOCKPROXYFILE 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1245 #define SQLITE_FCNTL_SET_LOCKPROXYFILE 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1246 #define SQLITE_FCNTL_LAST_ERRNO 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1247 #define SQLITE_FCNTL_SIZE_HINT 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1248 #define SQLITE_FCNTL_CHUNK_SIZE 6
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1249 #define SQLITE_FCNTL_FILE_POINTER 7
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1250 #define SQLITE_FCNTL_SYNC_OMITTED 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1251 #define SQLITE_FCNTL_WIN32_AV_RETRY 9
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1252 #define SQLITE_FCNTL_PERSIST_WAL 10
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1253 #define SQLITE_FCNTL_OVERWRITE 11
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1254 #define SQLITE_FCNTL_VFSNAME 12
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1255 #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1256 #define SQLITE_FCNTL_PRAGMA 14
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1257 #define SQLITE_FCNTL_BUSYHANDLER 15
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1258 #define SQLITE_FCNTL_TEMPFILENAME 16
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1259 #define SQLITE_FCNTL_MMAP_SIZE 18
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1260 #define SQLITE_FCNTL_TRACE 19
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1261 #define SQLITE_FCNTL_HAS_MOVED 20
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1262 #define SQLITE_FCNTL_SYNC 21
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1263 #define SQLITE_FCNTL_COMMIT_PHASETWO 22
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1264 #define SQLITE_FCNTL_WIN32_SET_HANDLE 23
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1265 #define SQLITE_FCNTL_WAL_BLOCK 24
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1266 #define SQLITE_FCNTL_ZIPVFS 25
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1267 #define SQLITE_FCNTL_RBU 26
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1268 #define SQLITE_FCNTL_VFS_POINTER 27
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1269 #define SQLITE_FCNTL_JOURNAL_POINTER 28
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1270 #define SQLITE_FCNTL_WIN32_GET_HANDLE 29
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1271 #define SQLITE_FCNTL_PDB 30
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1272 #define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1273 #define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1274 #define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1275 #define SQLITE_FCNTL_LOCK_TIMEOUT 34
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1276 #define SQLITE_FCNTL_DATA_VERSION 35
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1277 #define SQLITE_FCNTL_SIZE_LIMIT 36
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1278 #define SQLITE_FCNTL_CKPT_DONE 37
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1279 #define SQLITE_FCNTL_RESERVE_BYTES 38
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1280 #define SQLITE_FCNTL_CKPT_START 39
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1281 #define SQLITE_FCNTL_EXTERNAL_READER 40
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1282 #define SQLITE_FCNTL_CKSM_FILE 41
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1283 #define SQLITE_FCNTL_RESET_CACHE 42
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1284 #define SQLITE_FCNTL_NULL_IO 43
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1285 #define SQLITE_FCNTL_BLOCK_ON_CONNECT 44
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1286 #define SQLITE_FCNTL_FILESTAT 45
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1287
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1288 /* deprecated names */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1289 #define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1290 #define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1291 #define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1292
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1293
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1294 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1295 ** CAPI3REF: Mutex Handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1296 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1297 ** The mutex module within SQLite defines [sqlite3_mutex] to be an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1298 ** abstract type for a mutex object. The SQLite core never looks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1299 ** at the internal representation of an [sqlite3_mutex]. It only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1300 ** deals with pointers to the [sqlite3_mutex] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1301 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1302 ** Mutexes are created using [sqlite3_mutex_alloc()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1303 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1304 typedef struct sqlite3_mutex sqlite3_mutex;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1305
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1306 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1307 ** CAPI3REF: Loadable Extension Thunk
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1308 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1309 ** A pointer to the opaque sqlite3_api_routines structure is passed as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1310 ** the third parameter to entry points of [loadable extensions]. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1311 ** structure must be typedefed in order to work around compiler warnings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1312 ** on some platforms.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1313 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1314 typedef struct sqlite3_api_routines sqlite3_api_routines;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1315
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1316 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1317 ** CAPI3REF: File Name
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1318 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1319 ** Type [sqlite3_filename] is used by SQLite to pass filenames to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1320 ** xOpen method of a [VFS]. It may be cast to (const char*) and treated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1321 ** as a normal, nul-terminated, UTF-8 buffer containing the filename, but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1322 ** may also be passed to special APIs such as:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1323 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1324 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1325 ** <li> sqlite3_filename_database()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1326 ** <li> sqlite3_filename_journal()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1327 ** <li> sqlite3_filename_wal()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1328 ** <li> sqlite3_uri_parameter()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1329 ** <li> sqlite3_uri_boolean()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1330 ** <li> sqlite3_uri_int64()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1331 ** <li> sqlite3_uri_key()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1332 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1333 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1334 typedef const char *sqlite3_filename;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1335
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1336 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1337 ** CAPI3REF: OS Interface Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1338 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1339 ** An instance of the sqlite3_vfs object defines the interface between
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1340 ** the SQLite core and the underlying operating system. The "vfs"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1341 ** in the name of the object stands for "virtual file system". See
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1342 ** the [VFS \| VFS documentation] for further information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1343 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1344 ** The VFS interface is sometimes extended by adding new methods onto
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1345 ** the end. Each time such an extension occurs, the iVersion field
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1346 ** is incremented. The iVersion value started out as 1 in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1347 ** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1348 ** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1349 ** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1350 ** may be appended to the sqlite3_vfs object and the iVersion value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1351 ** may increase again in future versions of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1352 ** Note that due to an oversight, the structure
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1353 ** of the sqlite3_vfs object changed in the transition from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1354 ** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1355 ** and yet the iVersion field was not increased.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1356 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1357 ** The szOsFile field is the size of the subclassed [sqlite3_file]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1358 ** structure used by this VFS. mxPathname is the maximum length of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1359 ** a pathname in this VFS.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1360 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1361 ** Registered sqlite3_vfs objects are kept on a linked list formed by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1362 ** the pNext pointer. The [sqlite3_vfs_register()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1363 ** and [sqlite3_vfs_unregister()] interfaces manage this list
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1364 ** in a thread-safe way. The [sqlite3_vfs_find()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1365 ** searches the list. Neither the application code nor the VFS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1366 ** implementation should use the pNext pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1367 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1368 ** The pNext field is the only field in the sqlite3_vfs
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1369 ** structure that SQLite will ever modify. SQLite will only access
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1370 ** or modify this field while holding a particular static mutex.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1371 ** The application should never modify anything within the sqlite3_vfs
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1372 ** object once the object has been registered.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1373 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1374 ** The zName field holds the name of the VFS module. The name must
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1375 ** be unique across all VFS modules.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1376 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1377 ** [[sqlite3_vfs.xOpen]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1378 ** ^SQLite guarantees that the zFilename parameter to xOpen
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1379 ** is either a NULL pointer or string obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1380 ** from xFullPathname() with an optional suffix added.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1381 ** ^If a suffix is added to the zFilename parameter, it will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1382 ** consist of a single "-" character followed by no more than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1383 ** 11 alphanumeric and/or "-" characters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1384 ** ^SQLite further guarantees that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1385 ** the string will be valid and unchanged until xClose() is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1386 ** called. Because of the previous sentence,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1387 ** the [sqlite3_file] can safely store a pointer to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1388 ** filename if it needs to remember the filename for some reason.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1389 ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1390 ** must invent its own temporary name for the file. ^Whenever the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1391 ** xFilename parameter is NULL it will also be the case that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1392 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1393 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1394 ** The flags argument to xOpen() includes all bits set in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1395 ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1396 ** or [sqlite3_open16()] is used, then flags includes at least
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1397 ** [SQLITE_OPEN_READWRITE] \| [SQLITE_OPEN_CREATE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1398 ** If xOpen() opens a file read-only then it sets *pOutFlags to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1399 ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1400 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1401 ** ^(SQLite will also add one of the following flags to the xOpen()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1402 ** call, depending on the object being opened:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1403 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1404 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1405 ** <li> [SQLITE_OPEN_MAIN_DB]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1406 ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1407 ** <li> [SQLITE_OPEN_TEMP_DB]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1408 ** <li> [SQLITE_OPEN_TEMP_JOURNAL]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1409 ** <li> [SQLITE_OPEN_TRANSIENT_DB]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1410 ** <li> [SQLITE_OPEN_SUBJOURNAL]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1411 ** <li> [SQLITE_OPEN_SUPER_JOURNAL]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1412 ** <li> [SQLITE_OPEN_WAL]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1413 ** </ul>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1414 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1415 ** The file I/O implementation can use the object type flags to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1416 ** change the way it deals with files. For example, an application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1417 ** that does not care about crash recovery or rollback might make
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1418 ** the open of a journal file a no-op. Writes to this journal would
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1419 ** also be no-ops, and any attempt to read the journal would return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1420 ** SQLITE_IOERR. Or the implementation might recognize that a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1421 ** file will be doing page-aligned sector reads and writes in a random
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1422 ** order and set up its I/O subsystem accordingly.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1423 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1424 ** SQLite might also add one of the following flags to the xOpen method:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1425 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1426 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1427 ** <li> [SQLITE_OPEN_DELETEONCLOSE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1428 ** <li> [SQLITE_OPEN_EXCLUSIVE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1429 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1430 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1431 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1432 ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1433 ** will be set for TEMP databases and their journals, transient
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1434 ** databases, and subjournals.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1435 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1436 ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1437 ** with the [SQLITE_OPEN_CREATE] flag, which are both directly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1438 ** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1439 ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1440 ** SQLITE_OPEN_CREATE, is used to indicate that file should always
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1441 ** be created, and that it is an error if it already exists.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1442 ** It is <i>not</i> used to indicate the file should be opened
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1443 ** for exclusive access.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1444 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1445 ** ^At least szOsFile bytes of memory are allocated by SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1446 ** to hold the [sqlite3_file] structure passed as the third
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1447 ** argument to xOpen. The xOpen method does not have to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1448 ** allocate the structure; it should just fill it in. Note that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1449 ** the xOpen method must set the sqlite3_file.pMethods to either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1450 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1451 ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1452 ** element will be valid after xOpen returns regardless of the success
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1453 ** or failure of the xOpen call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1454 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1455 ** [[sqlite3_vfs.xAccess]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1456 ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1457 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1458 ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1459 ** to test whether a file is at least readable. The SQLITE_ACCESS_READ
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1460 ** flag is never actually used and is not implemented in the built-in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1461 ** VFSes of SQLite. The file is named by the second argument and can be a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1462 ** directory. The xAccess method returns [SQLITE_OK] on success or some
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1463 ** non-zero error code if there is an I/O error or if the name of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1464 ** the file given in the second argument is illegal. If SQLITE_OK
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1465 ** is returned, then non-zero or zero is written into *pResOut to indicate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1466 ** whether or not the file is accessible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1467 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1468 ** ^SQLite will always allocate at least mxPathname+1 bytes for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1469 ** output buffer xFullPathname. The exact size of the output buffer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1470 ** is also passed as a parameter to both methods. If the output buffer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1471 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1472 ** handled as a fatal error by SQLite, vfs implementations should endeavor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1473 ** to prevent this by setting mxPathname to a sufficiently large value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1474 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1475 ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1476 ** interfaces are not strictly a part of the filesystem, but they are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1477 ** included in the VFS structure for completeness.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1478 ** The xRandomness() function attempts to return nBytes bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1479 ** of good-quality randomness into zOut. The return value is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1480 ** the actual number of bytes of randomness obtained.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1481 ** The xSleep() method causes the calling thread to sleep for at
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1482 ** least the number of microseconds given. ^The xCurrentTime()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1483 ** method returns a Julian Day Number for the current date and time as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1484 ** a floating point value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1485 ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1486 ** Day Number multiplied by 86400000 (the number of milliseconds in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1487 ** a 24-hour day).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1488 ** ^SQLite will use the xCurrentTimeInt64() method to get the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1489 ** date and time if that method is available (if iVersion is 2 or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1490 ** greater and the function pointer is not NULL) and will fall back
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1491 ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1492 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1493 ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1494 ** are not used by the SQLite core. These optional interfaces are provided
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1495 ** by some VFSes to facilitate testing of the VFS code. By overriding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1496 ** system calls with functions under its control, a test program can
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1497 ** simulate faults and error conditions that would otherwise be difficult
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1498 ** or impossible to induce. The set of system calls that can be overridden
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1499 ** varies from one VFS to another, and from one version of the same VFS to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1500 ** next. Applications that use these interfaces must be prepared for any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1501 ** or all of these interfaces to be NULL or for their behavior to change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1502 ** from one release to the next. Applications must not attempt to access
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1503 ** any of these methods if the iVersion of the VFS is less than 3.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1504 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1505 typedef struct sqlite3_vfs sqlite3_vfs;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1506 typedef void (*sqlite3_syscall_ptr)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1507 struct sqlite3_vfs {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1508 int iVersion; /* Structure version number (currently 3) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1509 int szOsFile; /* Size of subclassed sqlite3_file */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1510 int mxPathname; /* Maximum file pathname length */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1511 sqlite3_vfs pNext; / Next registered VFS */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1512 const char zName; / Name of this virtual file system */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1513 void pAppData; / Pointer to application-specific data */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1514 int (xOpen)(sqlite3_vfs, sqlite3_filename zName, sqlite3_file*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1515 int flags, int *pOutFlags);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1516 int (xDelete)(sqlite3_vfs, const char *zName, int syncDir);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1517 int (xAccess)(sqlite3_vfs, const char zName, int flags, int pResOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1518 int (xFullPathname)(sqlite3_vfs, const char zName, int nOut, char zOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1519 void (xDlOpen)(sqlite3_vfs, const char zFilename);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1520 void (xDlError)(sqlite3_vfs, int nByte, char *zErrMsg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1521 void ((xDlSym)(sqlite3_vfs,void, const char *zSymbol))(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1522 void (xDlClose)(sqlite3_vfs, void*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1523 int (xRandomness)(sqlite3_vfs, int nByte, char *zOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1524 int (xSleep)(sqlite3_vfs, int microseconds);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1525 int (xCurrentTime)(sqlite3_vfs, double*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1526 int (xGetLastError)(sqlite3_vfs, int, char *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1527 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1528 ** The methods above are in version 1 of the sqlite_vfs object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1529 ** definition. Those that follow are added in version 2 or later
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1530 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1531 int (xCurrentTimeInt64)(sqlite3_vfs, sqlite3_int64*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1532 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1533 ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1534 ** Those below are for version 3 and greater.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1535 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1536 int (xSetSystemCall)(sqlite3_vfs, const char *zName, sqlite3_syscall_ptr);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1537 sqlite3_syscall_ptr (xGetSystemCall)(sqlite3_vfs, const char *zName);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1538 const char (xNextSystemCall)(sqlite3_vfs, const char zName);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1539 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1540 ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1541 ** New fields may be appended in future versions. The iVersion
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1542 ** value will increment whenever this happens.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1543 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1544 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1545
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1546 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1547 ** CAPI3REF: Flags for the xAccess VFS method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1548 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1549 ** These integer constants can be used as the third parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1550 ** the xAccess method of an [sqlite3_vfs] object. They determine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1551 ** what kind of permissions the xAccess method is looking for.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1552 ** With SQLITE_ACCESS_EXISTS, the xAccess method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1553 ** simply checks whether the file exists.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1554 ** With SQLITE_ACCESS_READWRITE, the xAccess method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1555 ** checks whether the named directory is both readable and writable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1556 ** (in other words, if files can be added, removed, and renamed within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1557 ** the directory).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1558 ** The SQLITE_ACCESS_READWRITE constant is currently used only by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1559 ** [temp_store_directory pragma], though this could change in a future
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1560 ** release of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1561 ** With SQLITE_ACCESS_READ, the xAccess method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1562 ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1563 ** currently unused, though it might be used in a future release of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1564 ** SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1565 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1566 #define SQLITE_ACCESS_EXISTS 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1567 #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1568 #define SQLITE_ACCESS_READ 2 /* Unused */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1569
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1570 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1571 ** CAPI3REF: Flags for the xShmLock VFS method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1572 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1573 ** These integer constants define the various locking operations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1574 ** allowed by the xShmLock method of [sqlite3_io_methods]. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1575 ** following are the only legal combinations of flags to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1576 ** xShmLock method:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1577 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1578 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1579 ** <li> SQLITE_SHM_LOCK \| SQLITE_SHM_SHARED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1580 ** <li> SQLITE_SHM_LOCK \| SQLITE_SHM_EXCLUSIVE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1581 ** <li> SQLITE_SHM_UNLOCK \| SQLITE_SHM_SHARED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1582 ** <li> SQLITE_SHM_UNLOCK \| SQLITE_SHM_EXCLUSIVE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1583 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1584 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1585 ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1586 ** was given on the corresponding lock.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1587 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1588 ** The xShmLock method can transition between unlocked and SHARED or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1589 ** between unlocked and EXCLUSIVE. It cannot transition between SHARED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1590 ** and EXCLUSIVE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1591 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1592 #define SQLITE_SHM_UNLOCK 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1593 #define SQLITE_SHM_LOCK 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1594 #define SQLITE_SHM_SHARED 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1595 #define SQLITE_SHM_EXCLUSIVE 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1596
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1597 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1598 ** CAPI3REF: Maximum xShmLock index
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1599 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1600 ** The xShmLock method on [sqlite3_io_methods] may use values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1601 ** between 0 and this upper bound as its "offset" argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1602 ** The SQLite core will never attempt to acquire or release a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1603 ** lock outside of this range
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1604 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1605 #define SQLITE_SHM_NLOCK 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1606
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1607
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1608 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1609 ** CAPI3REF: Initialize The SQLite Library
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1610 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1611 ** ^The sqlite3_initialize() routine initializes the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1612 ** SQLite library. ^The sqlite3_shutdown() routine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1613 ** deallocates any resources that were allocated by sqlite3_initialize().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1614 ** These routines are designed to aid in process initialization and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1615 ** shutdown on embedded systems. Workstation applications using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1616 ** SQLite normally do not need to invoke either of these routines.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1617 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1618 ** A call to sqlite3_initialize() is an "effective" call if it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1619 ** the first time sqlite3_initialize() is invoked during the lifetime of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1620 ** the process, or if it is the first time sqlite3_initialize() is invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1621 ** following a call to sqlite3_shutdown(). ^(Only an effective call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1622 ** of sqlite3_initialize() does any initialization. All other calls
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1623 ** are harmless no-ops.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1624 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1625 ** A call to sqlite3_shutdown() is an "effective" call if it is the first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1626 ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1627 ** an effective call to sqlite3_shutdown() does any deinitialization.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1628 ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1629 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1630 ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1631 ** is not. The sqlite3_shutdown() interface must only be called from a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1632 ** single thread. All open [database connections] must be closed and all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1633 ** other SQLite resources must be deallocated prior to invoking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1634 ** sqlite3_shutdown().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1635 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1636 ** Among other things, ^sqlite3_initialize() will invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1637 ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1638 ** will invoke sqlite3_os_end().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1639 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1640 ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1641 ** ^If for some reason, sqlite3_initialize() is unable to initialize
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1642 ** the library (perhaps it is unable to allocate a needed resource such
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1643 ** as a mutex) it returns an [error code] other than [SQLITE_OK].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1644 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1645 ** ^The sqlite3_initialize() routine is called internally by many other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1646 ** SQLite interfaces so that an application usually does not need to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1647 ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1648 ** calls sqlite3_initialize() so the SQLite library will be automatically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1649 ** initialized when [sqlite3_open()] is called if it has not been initialized
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1650 ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1651 ** compile-time option, then the automatic calls to sqlite3_initialize()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1652 ** are omitted and the application must call sqlite3_initialize() directly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1653 ** prior to using any other SQLite interface. For maximum portability,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1654 ** it is recommended that applications always invoke sqlite3_initialize()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1655 ** directly prior to using any other SQLite interface. Future releases
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1656 ** of SQLite may require this. In other words, the behavior exhibited
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1657 ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1658 ** default behavior in some future release of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1659 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1660 ** The sqlite3_os_init() routine does operating-system specific
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1661 ** initialization of the SQLite library. The sqlite3_os_end()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1662 ** routine undoes the effect of sqlite3_os_init(). Typical tasks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1663 ** performed by these routines include allocation or deallocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1664 ** of static resources, initialization of global variables,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1665 ** setting up a default [sqlite3_vfs] module, or setting up
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1666 ** a default configuration using [sqlite3_config()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1667 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1668 ** The application should never invoke either sqlite3_os_init()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1669 ** or sqlite3_os_end() directly. The application should only invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1670 ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1671 ** interface is called automatically by sqlite3_initialize() and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1672 ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1673 ** implementations for sqlite3_os_init() and sqlite3_os_end()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1674 ** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1675 ** When [custom builds \| built for other platforms]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1676 ** (using the [SQLITE_OS_OTHER=1] compile-time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1677 ** option) the application must supply a suitable implementation for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1678 ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1679 ** implementation of sqlite3_os_init() or sqlite3_os_end()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1680 ** must return [SQLITE_OK] on success and some other [error code] upon
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1681 ** failure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1682 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1683 SQLITE_API int sqlite3_initialize(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1684 SQLITE_API int sqlite3_shutdown(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1685 SQLITE_API int sqlite3_os_init(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1686 SQLITE_API int sqlite3_os_end(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1687
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1688 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1689 ** CAPI3REF: Configuring The SQLite Library
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1690 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1691 ** The sqlite3_config() interface is used to make global configuration
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1692 ** changes to SQLite in order to tune SQLite to the specific needs of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1693 ** the application. The default configuration is recommended for most
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1694 ** applications and so this routine is usually not necessary. It is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1695 ** provided to support rare applications with unusual needs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1696 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1697 ** <b>The sqlite3_config() interface is not threadsafe. The application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1698 ** must ensure that no other SQLite interfaces are invoked by other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1699 ** threads while sqlite3_config() is running.</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1700 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1701 ** The first argument to sqlite3_config() is an integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1702 ** [configuration option] that determines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1703 ** what property of SQLite is to be configured. Subsequent arguments
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1704 ** vary depending on the [configuration option]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1705 ** in the first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1706 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1707 ** For most configuration options, the sqlite3_config() interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1708 ** may only be invoked prior to library initialization using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1709 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1710 ** The exceptional configuration options that may be invoked at any time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1711 ** are called "anytime configuration options".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1712 ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1713 ** [sqlite3_shutdown()] with a first argument that is not an anytime
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1714 ** configuration option, then the sqlite3_config() call will return SQLITE_MISUSE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1715 ** Note, however, that ^sqlite3_config() can be called as part of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1716 ** implementation of an application-defined [sqlite3_os_init()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1717 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1718 ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1719 ** ^If the option is unknown or SQLite is unable to set the option
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1720 ** then this routine returns a non-zero [error code].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1721 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1722 SQLITE_API int sqlite3_config(int, ...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1723
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1724 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1725 ** CAPI3REF: Configure database connections
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1726 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1727 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1728 ** The sqlite3_db_config() interface is used to make configuration
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1729 ** changes to a [database connection]. The interface is similar to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1730 ** [sqlite3_config()] except that the changes apply to a single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1731 ** [database connection] (specified in the first argument).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1732 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1733 ** The second argument to sqlite3_db_config(D,V,...) is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1734 ** [SQLITE_DBCONFIG_LOOKASIDE \| configuration verb] - an integer code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1735 ** that indicates what aspect of the [database connection] is being configured.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1736 ** Subsequent arguments vary depending on the configuration verb.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1737 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1738 ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1739 ** the call is considered successful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1740 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1741 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1742
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1743 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1744 ** CAPI3REF: Memory Allocation Routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1745 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1746 ** An instance of this object defines the interface between SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1747 ** and low-level memory allocation routines.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1748 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1749 ** This object is used in only one place in the SQLite interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1750 ** A pointer to an instance of this object is the argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1751 ** [sqlite3_config()] when the configuration option is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1752 ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1753 ** By creating an instance of this object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1754 ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1755 ** during configuration, an application can specify an alternative
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1756 ** memory allocation subsystem for SQLite to use for all of its
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1757 ** dynamic memory needs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1758 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1759 ** Note that SQLite comes with several [built-in memory allocators]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1760 ** that are perfectly adequate for the overwhelming majority of applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1761 ** and that this object is only useful to a tiny minority of applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1762 ** with specialized memory allocation requirements. This object is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1763 ** also used during testing of SQLite in order to specify an alternative
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1764 ** memory allocator that simulates memory out-of-memory conditions in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1765 ** order to verify that SQLite recovers gracefully from such
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1766 ** conditions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1767 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1768 ** The xMalloc, xRealloc, and xFree methods must work like the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1769 ** malloc(), realloc() and free() functions from the standard C library.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1770 ** ^SQLite guarantees that the second argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1771 ** xRealloc is always a value returned by a prior call to xRoundup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1772 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1773 ** xSize should return the allocated size of a memory allocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1774 ** previously obtained from xMalloc or xRealloc. The allocated size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1775 ** is always at least as big as the requested size but may be larger.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1776 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1777 ** The xRoundup method returns what would be the allocated size of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1778 ** a memory allocation given a particular requested size. Most memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1779 ** allocators round up memory allocations at least to the next multiple
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1780 ** of 8. Some allocators round up to a larger multiple or to a power of 2.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1781 ** Every memory allocation request coming in through [sqlite3_malloc()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1782 ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1783 ** that causes the corresponding memory allocation to fail.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1784 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1785 ** The xInit method initializes the memory allocator. For example,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1786 ** it might allocate any required mutexes or initialize internal data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1787 ** structures. The xShutdown method is invoked (indirectly) by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1788 ** [sqlite3_shutdown()] and should deallocate any resources acquired
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1789 ** by xInit. The pAppData pointer is used as the only parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1790 ** xInit and xShutdown.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1791 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1792 ** SQLite holds the [SQLITE_MUTEX_STATIC_MAIN] mutex when it invokes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1793 ** the xInit method, so the xInit method need not be threadsafe. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1794 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1795 ** not need to be threadsafe either. For all other methods, SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1796 ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1797 ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1798 ** it is by default) and so the methods are automatically serialized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1799 ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1800 ** methods must be threadsafe or else make their own arrangements for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1801 ** serialization.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1802 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1803 ** SQLite will never invoke xInit() more than once without an intervening
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1804 ** call to xShutdown().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1805 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1806 typedef struct sqlite3_mem_methods sqlite3_mem_methods;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1807 struct sqlite3_mem_methods {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1808 void (xMalloc)(int); /* Memory allocation function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1809 void (xFree)(void); /* Free a prior allocation */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1810 void (xRealloc)(void,int); / Resize an allocation */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1811 int (xSize)(void); /* Return the size of an allocation */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1812 int (xRoundup)(int); / Round up request size to allocation size */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1813 int (xInit)(void); /* Initialize the memory allocator */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1814 void (xShutdown)(void); /* Deinitialize the memory allocator */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1815 void pAppData; / Argument to xInit() and xShutdown() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1816 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1817
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1818 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1819 ** CAPI3REF: Configuration Options
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1820 ** KEYWORDS: {configuration option}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1821 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1822 ** These constants are the available integer configuration options that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1823 ** can be passed as the first argument to the [sqlite3_config()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1824 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1825 ** Most of the configuration options for sqlite3_config()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1826 ** will only work if invoked prior to [sqlite3_initialize()] or after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1827 ** [sqlite3_shutdown()]. The few exceptions to this rule are called
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1828 ** "anytime configuration options".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1829 ** ^Calling [sqlite3_config()] with a first argument that is not an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1830 ** anytime configuration option in between calls to [sqlite3_initialize()] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1831 ** [sqlite3_shutdown()] is a no-op that returns SQLITE_MISUSE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1832 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1833 ** The set of anytime configuration options can change (by insertions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1834 ** and/or deletions) from one release of SQLite to the next.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1835 ** As of SQLite version 3.42.0, the complete set of anytime configuration
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1836 ** options is:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1837 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1838 ** <li> SQLITE_CONFIG_LOG
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1839 ** <li> SQLITE_CONFIG_PCACHE_HDRSZ
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1840 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1841 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1842 ** New configuration options may be added in future releases of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1843 ** Existing configuration options might be discontinued. Applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1844 ** should check the return code from [sqlite3_config()] to make sure that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1845 ** the call worked. The [sqlite3_config()] interface will return a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1846 ** non-zero [error code] if a discontinued or unsupported configuration option
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1847 ** is invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1848 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1849 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1850 ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1851 ** <dd>There are no arguments to this option. ^This option sets the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1852 ** [threading mode] to Single-thread. In other words, it disables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1853 ** all mutexing and puts SQLite into a mode where it can only be used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1854 ** by a single thread. ^If SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1855 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1856 ** it is not possible to change the [threading mode] from its default
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1857 ** value of Single-thread and so [sqlite3_config()] will return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1858 ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1859 ** configuration option.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1860 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1861 ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1862 ** <dd>There are no arguments to this option. ^This option sets the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1863 ** [threading mode] to Multi-thread. In other words, it disables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1864 ** mutexing on [database connection] and [prepared statement] objects.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1865 ** The application is responsible for serializing access to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1866 ** [database connections] and [prepared statements]. But other mutexes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1867 ** are enabled so that SQLite will be safe to use in a multi-threaded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1868 ** environment as long as no two threads attempt to use the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1869 ** [database connection] at the same time. ^If SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1870 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1871 ** it is not possible to set the Multi-thread [threading mode] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1872 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1873 ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1874 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1875 ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1876 ** <dd>There are no arguments to this option. ^This option sets the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1877 ** [threading mode] to Serialized. In other words, this option enables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1878 ** all mutexes including the recursive
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1879 ** mutexes on [database connection] and [prepared statement] objects.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1880 ** In this mode (which is the default when SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1881 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1882 ** to [database connections] and [prepared statements] so that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1883 ** application is free to use the same [database connection] or the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1884 ** same [prepared statement] in different threads at the same time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1885 ** ^If SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1886 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1887 ** it is not possible to set the Serialized [threading mode] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1888 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1889 ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1890 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1891 ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1892 ** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1893 ** a pointer to an instance of the [sqlite3_mem_methods] structure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1894 ** The argument specifies
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1895 ** alternative low-level memory allocation routines to be used in place of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1896 ** the memory allocation routines built into SQLite.)^ ^SQLite makes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1897 ** its own private copy of the content of the [sqlite3_mem_methods] structure
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1898 ** before the [sqlite3_config()] call returns.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1899 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1900 ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1901 ** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1902 ** is a pointer to an instance of the [sqlite3_mem_methods] structure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1903 ** The [sqlite3_mem_methods]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1904 ** structure is filled with the currently defined memory allocation routines.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1905 ** This option can be used to overload the default memory allocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1906 ** routines with a wrapper that simulates memory allocation failure or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1907 ** tracks memory usage, for example. </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1908 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1909 ** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1910 ** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes a single argument of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1911 ** type int, interpreted as a boolean, which if true provides a hint to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1912 ** SQLite that it should avoid large memory allocations if possible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1913 ** SQLite will run faster if it is free to make large memory allocations,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1914 ** but some applications might prefer to run slower in exchange for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1915 ** guarantees about memory fragmentation that are possible if large
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1916 ** allocations are avoided. This hint is normally off.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1917 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1918 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1919 ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1920 ** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes a single argument of type int,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1921 ** interpreted as a boolean, which enables or disables the collection of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1922 ** memory allocation statistics. ^(When memory allocation statistics are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1923 ** disabled, the following SQLite interfaces become non-operational:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1924 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1925 ** <li> [sqlite3_hard_heap_limit64()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1926 ** <li> [sqlite3_memory_used()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1927 ** <li> [sqlite3_memory_highwater()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1928 ** <li> [sqlite3_soft_heap_limit64()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1929 ** <li> [sqlite3_status64()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1930 ** </ul>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1931 ** ^Memory allocation statistics are enabled by default unless SQLite is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1932 ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1933 ** allocation statistics are disabled by default.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1934 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1935 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1936 ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1937 ** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1938 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1939 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1940 ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1941 ** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1942 ** that SQLite can use for the database page cache with the default page
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1943 ** cache implementation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1944 ** This configuration option is a no-op if an application-defined page
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1945 ** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1946 ** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1947 ** 8-byte aligned memory (pMem), the size of each page cache line (sz),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1948 ** and the number of cache lines (N).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1949 ** The sz argument should be the size of the largest database page
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1950 ** (a power of two between 512 and 65536) plus some extra bytes for each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1951 ** page header. ^The number of extra bytes needed by the page header
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1952 ** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1953 ** ^It is harmless, apart from the wasted memory,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1954 ** for the sz parameter to be larger than necessary. The pMem
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1955 ** argument must be either a NULL pointer or a pointer to an 8-byte
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1956 ** aligned block of memory of at least sz*N bytes, otherwise
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1957 ** subsequent behavior is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1958 ** ^When pMem is not NULL, SQLite will strive to use the memory provided
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1959 ** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1960 ** a page cache line is larger than sz bytes or if all of the pMem buffer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1961 ** is exhausted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1962 ** ^If pMem is NULL and N is non-zero, then each database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1963 ** does an initial bulk allocation for page cache memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1964 ** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1965 ** of -1024*N bytes if N is negative. ^If additional
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1966 ** page cache memory is needed beyond what is provided by the initial
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1967 ** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1968 ** additional cache line. </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1969 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1970 ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1971 ** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1972 ** that SQLite will use for all of its dynamic memory allocation needs
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1973 ** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1974 ** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1975 ** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1976 ** [SQLITE_ERROR] if invoked otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1977 ** ^There are three arguments to SQLITE_CONFIG_HEAP:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1978 ** An 8-byte aligned pointer to the memory,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1979 ** the number of bytes in the memory buffer, and the minimum allocation size.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1980 ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1981 ** to using its default memory allocator (the system malloc() implementation),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1982 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1983 ** memory pointer is not NULL then the alternative memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1984 ** allocator is engaged to handle all of SQLites memory allocation needs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1985 ** The first pointer (the memory pointer) must be aligned to an 8-byte
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1986 ** boundary or subsequent behavior of SQLite will be undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1987 The minimum allocation size is capped at 212. Reasonable values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1988 for the minimum allocation size are 25 through 2**8.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1989 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1990 ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1991 ** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1992 ** pointer to an instance of the [sqlite3_mutex_methods] structure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1993 ** The argument specifies alternative low-level mutex routines to be used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1994 ** in place of the mutex routines built into SQLite.)^ ^SQLite makes a copy of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1995 ** the content of the [sqlite3_mutex_methods] structure before the call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1996 ** [sqlite3_config()] returns. ^If SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1997 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1998 ** the entire mutexing subsystem is omitted from the build and hence calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	1999 ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2000 ** return [SQLITE_ERROR].</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2001 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2002 ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2003 ** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2004 ** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2005 ** [sqlite3_mutex_methods]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2006 ** structure is filled with the currently defined mutex routines.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2007 ** This option can be used to overload the default mutex allocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2008 ** routines with a wrapper used to track mutex usage for performance
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2009 ** profiling or testing, for example. ^If SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2010 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2011 ** the entire mutexing subsystem is omitted from the build and hence calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2012 ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2013 ** return [SQLITE_ERROR].</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2014 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2015 ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2016 ** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2017 ** the default size of [lookaside memory] on each [database connection].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2018 ** The first argument is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2019 ** size of each lookaside buffer slot ("sz") and the second is the number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2020 ** slots allocated to each database connection ("cnt").)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2021 ** ^(SQLITE_CONFIG_LOOKASIDE sets the <i>default</i> lookaside size.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2022 ** The [SQLITE_DBCONFIG_LOOKASIDE] option to [sqlite3_db_config()] can
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2023 ** be used to change the lookaside configuration on individual connections.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2024 ** The [-DSQLITE_DEFAULT_LOOKASIDE] option can be used to change the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2025 ** default lookaside configuration at compile-time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2026 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2027 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2028 ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2029 ** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2030 ** a pointer to an [sqlite3_pcache_methods2] object. This object specifies
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2031 ** the interface to a custom page cache implementation.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2032 ** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2033 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2034 ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2035 ** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2036 ** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies off
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2037 ** the current page cache implementation into that object.)^ </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2038 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2039 ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2040 ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2041 ** global [error log].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2042 ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2043 ** function with a call signature of void()(void,int,const char*),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2044 ** and a pointer to void. ^If the function pointer is not NULL, it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2045 ** invoked by [sqlite3_log()] to process each logging event. ^If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2046 ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2047 ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2048 ** passed through as the first parameter to the application-defined logger
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2049 ** function whenever that function is invoked. ^The second parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2050 ** the logger function is a copy of the first parameter to the corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2051 ** [sqlite3_log()] call and is intended to be a [result code] or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2052 ** [extended result code]. ^The third parameter passed to the logger is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2053 ** a log message after formatting via [sqlite3_snprintf()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2054 ** The SQLite logging interface is not reentrant; the logger function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2055 ** supplied by the application must not invoke any SQLite interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2056 ** In a multi-threaded application, the application-defined logger
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2057 ** function must be threadsafe. </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2058 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2059 ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2060 ** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2061 ** If non-zero, then URI handling is globally enabled. If the parameter is zero,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2062 ** then URI handling is globally disabled.)^ ^If URI handling is globally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2063 ** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2064 ** [sqlite3_open16()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2065 ** specified as part of [ATTACH] commands are interpreted as URIs, regardless
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2066 ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2067 ** connection is opened. ^If it is globally disabled, filenames are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2068 ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2069 ** database connection is opened. ^(By default, URI handling is globally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2070 ** disabled. The default value may be changed by compiling with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2071 ** [SQLITE_USE_URI] symbol defined.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2072 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2073 ** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2074 ** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2075 ** argument which is interpreted as a boolean in order to enable or disable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2076 ** the use of covering indices for full table scans in the query optimizer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2077 ** ^The default setting is determined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2078 ** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2079 ** if that compile-time option is omitted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2080 ** The ability to disable the use of covering indices for full table scans
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2081 ** is because some incorrectly coded legacy applications might malfunction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2082 ** when the optimization is enabled. Providing the ability to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2083 ** disable the optimization allows the older, buggy application code to work
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2084 ** without change even with newer versions of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2085 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2086 ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2087 ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2088 ** <dd> These options are obsolete and should not be used by new code.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2089 ** They are retained for backwards compatibility but are now no-ops.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2090 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2091 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2092 ** [[SQLITE_CONFIG_SQLLOG]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2093 ** <dt>SQLITE_CONFIG_SQLLOG
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2094 ** <dd>This option is only available if sqlite is compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2095 ** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2096 ** be a pointer to a function of type void()(void,sqlite3,const char, int).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2097 ** The second should be of type (void*). The callback is invoked by the library
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2098 ** in three separate circumstances, identified by the value passed as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2099 ** fourth parameter. If the fourth parameter is 0, then the database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2100 ** passed as the second argument has just been opened. The third argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2101 ** points to a buffer containing the name of the main database file. If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2102 ** fourth parameter is 1, then the SQL statement that the third parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2103 ** points to has just been executed. Or, if the fourth parameter is 2, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2104 ** the connection being passed as the second parameter is being closed. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2105 ** third parameter is passed NULL In this case. An example of using this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2106 ** configuration option can be seen in the "test_sqllog.c" source file in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2107 ** the canonical SQLite source tree.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2108 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2109 ** [[SQLITE_CONFIG_MMAP_SIZE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2110 ** <dt>SQLITE_CONFIG_MMAP_SIZE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2111 ** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2112 ** that are the default mmap size limit (the default setting for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2113 ** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2114 ** ^The default setting can be overridden by each database connection using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2115 ** either the [PRAGMA mmap_size] command, or by using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2116 ** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2117 ** will be silently truncated if necessary so that it does not exceed the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2118 ** compile-time maximum mmap size set by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2119 ** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2120 ** ^If either argument to this option is negative, then that argument is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2121 ** changed to its compile-time default.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2122 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2123 ** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2124 ** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2125 ** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2126 ** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2127 ** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2128 ** that specifies the maximum size of the created heap.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2129 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2130 ** [[SQLITE_CONFIG_PCACHE_HDRSZ]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2131 ** <dt>SQLITE_CONFIG_PCACHE_HDRSZ
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2132 ** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2133 ** is a pointer to an integer and writes into that integer the number of extra
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2134 ** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2135 ** The amount of extra space required can change depending on the compiler,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2136 ** target platform, and SQLite version.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2137 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2138 ** [[SQLITE_CONFIG_PMASZ]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2139 ** <dt>SQLITE_CONFIG_PMASZ
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2140 ** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2141 ** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2142 ** sorter to that integer. The default minimum PMA Size is set by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2143 ** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2144 ** to help with sort operations when multithreaded sorting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2145 ** is enabled (using the [PRAGMA threads] command) and the amount of content
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2146 ** to be sorted exceeds the page size times the minimum of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2147 ** [PRAGMA cache_size] setting and this value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2148 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2149 ** [[SQLITE_CONFIG_STMTJRNL_SPILL]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2150 ** <dt>SQLITE_CONFIG_STMTJRNL_SPILL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2151 ** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2152 ** becomes the [statement journal] spill-to-disk threshold.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2153 ** [Statement journals] are held in memory until their size (in bytes)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2154 ** exceeds this threshold, at which point they are written to disk.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2155 ** Or if the threshold is -1, statement journals are always held
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2156 ** exclusively in memory.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2157 ** Since many statement journals never become large, setting the spill
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2158 ** threshold to a value such as 64KiB can greatly reduce the amount of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2159 ** I/O required to support statement rollback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2160 ** The default value for this setting is controlled by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2161 ** [SQLITE_STMTJRNL_SPILL] compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2162 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2163 ** [[SQLITE_CONFIG_SORTERREF_SIZE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2164 ** <dt>SQLITE_CONFIG_SORTERREF_SIZE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2165 ** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2166 ** of type (int) - the new value of the sorter-reference size threshold.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2167 ** Usually, when SQLite uses an external sort to order records according
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2168 ** to an ORDER BY clause, all fields required by the caller are present in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2169 ** sorted records. However, if SQLite determines based on the declared type
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2170 ** of a table column that its values are likely to be very large - larger
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2171 ** than the configured sorter-reference size threshold - then a reference
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2172 ** is stored in each sorted record and the required column values loaded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2173 ** from the database as records are returned in sorted order. The default
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2174 ** value for this option is to never use this optimization. Specifying a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2175 ** negative value for this option restores the default behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2176 ** This option is only available if SQLite is compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2177 ** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2178 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2179 ** [[SQLITE_CONFIG_MEMDB_MAXSIZE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2180 ** <dt>SQLITE_CONFIG_MEMDB_MAXSIZE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2181 ** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2182 ** [sqlite3_int64] parameter which is the default maximum size for an in-memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2183 ** database created using [sqlite3_deserialize()]. This default maximum
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2184 ** size can be adjusted up or down for individual databases using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2185 ** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control\|file-control]. If this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2186 ** configuration setting is never used, then the default maximum is determined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2187 ** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2188 ** compile-time option is not set, then the default maximum is 1073741824.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2189 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2190 ** [[SQLITE_CONFIG_ROWID_IN_VIEW]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2191 ** <dt>SQLITE_CONFIG_ROWID_IN_VIEW
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2192 ** <dd>The SQLITE_CONFIG_ROWID_IN_VIEW option enables or disables the ability
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2193 ** for VIEWs to have a ROWID. The capability can only be enabled if SQLite is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2194 ** compiled with -DSQLITE_ALLOW_ROWID_IN_VIEW, in which case the capability
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2195 ** defaults to on. This configuration option queries the current setting or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2196 ** changes the setting to off or on. The argument is a pointer to an integer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2197 ** If that integer initially holds a value of 1, then the ability for VIEWs to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2198 ** have ROWIDs is activated. If the integer initially holds zero, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2199 ** ability is deactivated. Any other initial value for the integer leaves the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2200 ** setting unchanged. After changes, if any, the integer is written with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2201 ** a 1 or 0, if the ability for VIEWs to have ROWIDs is on or off. If SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2202 ** is compiled without -DSQLITE_ALLOW_ROWID_IN_VIEW (which is the usual and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2203 ** recommended case) then the integer is always filled with zero, regardless
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2204 ** if its initial value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2205 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2206 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2207 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2208 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2209 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2210 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2211 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2212 #define SQLITE_CONFIG_SCRATCH 6 /* No longer used */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2213 #define SQLITE_CONFIG_PAGECACHE 7 /* void, int sz, int N /
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2214 #define SQLITE_CONFIG_HEAP 8 /* void, int nByte, int min /
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2215 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2216 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2217 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2218 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2219 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2220 #define SQLITE_CONFIG_PCACHE 14 /* no-op */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2221 #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2222 #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2223 #define SQLITE_CONFIG_URI 17 /* int */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2224 #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2225 #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2226 #define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2227 #define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2228 #define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2229 #define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2230 #define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int psz /
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2231 #define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2232 #define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2233 #define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2234 #define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2235 #define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2236 #define SQLITE_CONFIG_ROWID_IN_VIEW 30 /* int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2237
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2238 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2239 ** CAPI3REF: Database Connection Configuration Options
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2240 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2241 ** These constants are the available integer configuration options that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2242 ** can be passed as the second parameter to the [sqlite3_db_config()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2243 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2244 ** The [sqlite3_db_config()] interface is a var-args function. It takes a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2245 ** variable number of parameters, though always at least two. The number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2246 ** parameters passed into sqlite3_db_config() depends on which of these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2247 ** constants is given as the second parameter. This documentation page
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2248 ** refers to parameters beyond the second as "arguments". Thus, when this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2249 ** page says "the N-th argument" it means "the N-th parameter past the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2250 ** configuration option" or "the (N+2)-th parameter to sqlite3_db_config()".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2251 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2252 ** New configuration options may be added in future releases of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2253 ** Existing configuration options might be discontinued. Applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2254 ** should check the return code from [sqlite3_db_config()] to make sure that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2255 ** the call worked. ^The [sqlite3_db_config()] interface will return a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2256 ** non-zero [error code] if a discontinued or unsupported configuration option
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2257 ** is invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2258 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2259 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2260 ** [[SQLITE_DBCONFIG_LOOKASIDE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2261 ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2262 ** <dd> The SQLITE_DBCONFIG_LOOKASIDE option is used to adjust the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2263 ** configuration of the [lookaside memory allocator] within a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2264 ** connection.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2265 ** The arguments to the SQLITE_DBCONFIG_LOOKASIDE option are <i>not</i>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2266 ** in the [DBCONFIG arguments\|usual format].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2267 ** The SQLITE_DBCONFIG_LOOKASIDE option takes three arguments, not two,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2268 ** so that a call to [sqlite3_db_config()] that uses SQLITE_DBCONFIG_LOOKASIDE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2269 ** should have a total of five parameters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2270 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2271 ** <li><p>The first argument ("buf") is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2272 ** pointer to a memory buffer to use for lookaside memory.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2273 ** The first argument may be NULL in which case SQLite will allocate the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2274 ** lookaside buffer itself using [sqlite3_malloc()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2275 ** <li><P>The second argument ("sz") is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2276 ** size of each lookaside buffer slot. Lookaside is disabled if "sz"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2277 ** is less than 8. The "sz" argument should be a multiple of 8 less than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2278 ** 65536. If "sz" does not meet this constraint, it is reduced in size until
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2279 ** it does.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2280 ** <li><p>The third argument ("cnt") is the number of slots. Lookaside is disabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2281 ** if "cnt"is less than 1. The "cnt" value will be reduced, if necessary, so
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2282 ** that the product of "sz" and "cnt" does not exceed 2,147,418,112. The "cnt"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2283 ** parameter is usually chosen so that the product of "sz" and "cnt" is less
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2284 ** than 1,000,000.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2285 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2286 ** <p>If the "buf" argument is not NULL, then it must
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2287 ** point to a memory buffer with a size that is greater than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2288 ** or equal to the product of "sz" and "cnt".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2289 ** The buffer must be aligned to an 8-byte boundary.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2290 ** The lookaside memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2291 ** configuration for a database connection can only be changed when that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2292 ** connection is not currently using lookaside memory, or in other words
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2293 ** when the value returned by [SQLITE_DBSTATUS_LOOKASIDE_USED] is zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2294 ** Any attempt to change the lookaside memory configuration when lookaside
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2295 ** memory is in use leaves the configuration unchanged and returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2296 ** [SQLITE_BUSY].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2297 ** If the "buf" argument is NULL and an attempt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2298 ** to allocate memory based on "sz" and "cnt" fails, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2299 ** lookaside is silently disabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2300 ** <p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2301 ** The [SQLITE_CONFIG_LOOKASIDE] configuration option can be used to set the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2302 ** default lookaside configuration at initialization. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2303 ** [-DSQLITE_DEFAULT_LOOKASIDE] option can be used to set the default lookaside
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2304 ** configuration at compile-time. Typical values for lookaside are 1200 for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2305 ** "sz" and 40 to 100 for "cnt".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2306 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2307 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2308 ** [[SQLITE_DBCONFIG_ENABLE_FKEY]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2309 ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2310 ** <dd> ^This option is used to enable or disable the enforcement of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2311 ** [foreign key constraints]. This is the same setting that is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2312 ** enabled or disabled by the [PRAGMA foreign_keys] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2313 ** The first argument is an integer which is 0 to disable FK enforcement,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2314 ** positive to enable FK enforcement or negative to leave FK enforcement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2315 ** unchanged. The second parameter is a pointer to an integer into which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2316 ** is written 0 or 1 to indicate whether FK enforcement is off or on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2317 ** following this call. The second parameter may be a NULL pointer, in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2318 ** which case the FK enforcement setting is not reported back. </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2319 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2320 ** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2321 ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2322 ** <dd> ^This option is used to enable or disable [CREATE TRIGGER \| triggers].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2323 ** There should be two additional arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2324 ** The first argument is an integer which is 0 to disable triggers,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2325 ** positive to enable triggers or negative to leave the setting unchanged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2326 ** The second parameter is a pointer to an integer into which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2327 ** is written 0 or 1 to indicate whether triggers are disabled or enabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2328 ** following this call. The second parameter may be a NULL pointer, in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2329 ** which case the trigger setting is not reported back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2330 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2331 ** <p>Originally this option disabled all triggers. ^(However, since
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2332 ** SQLite version 3.35.0, TEMP triggers are still allowed even if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2333 ** this option is off. So, in other words, this option now only disables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2334 ** triggers in the main database schema or in the schemas of [ATTACH]-ed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2335 ** databases.)^ </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2336 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2337 ** [[SQLITE_DBCONFIG_ENABLE_VIEW]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2338 ** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2339 ** <dd> ^This option is used to enable or disable [CREATE VIEW \| views].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2340 ** There must be two additional arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2341 ** The first argument is an integer which is 0 to disable views,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2342 ** positive to enable views or negative to leave the setting unchanged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2343 ** The second parameter is a pointer to an integer into which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2344 ** is written 0 or 1 to indicate whether views are disabled or enabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2345 ** following this call. The second parameter may be a NULL pointer, in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2346 ** which case the view setting is not reported back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2347 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2348 ** <p>Originally this option disabled all views. ^(However, since
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2349 ** SQLite version 3.35.0, TEMP views are still allowed even if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2350 ** this option is off. So, in other words, this option now only disables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2351 ** views in the main database schema or in the schemas of ATTACH-ed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2352 ** databases.)^ </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2353 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2354 ** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2355 ** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2356 ** <dd> ^This option is used to enable or disable using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2357 ** [fts3_tokenizer()] function - part of the [FTS3] full-text search engine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2358 ** extension - without using bound parameters as the parameters. Doing so
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2359 ** is disabled by default. There must be two additional arguments. The first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2360 ** argument is an integer. If it is passed 0, then using fts3_tokenizer()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2361 ** without bound parameters is disabled. If it is passed a positive value,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2362 ** then calling fts3_tokenizer without bound parameters is enabled. If it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2363 ** is passed a negative value, this setting is not modified - this can be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2364 ** used to query for the current setting. The second parameter is a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2365 ** to an integer into which is written 0 or 1 to indicate the current value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2366 ** of this setting (after it is modified, if applicable). The second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2367 ** parameter may be a NULL pointer, in which case the value of the setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2368 ** is not reported back. Refer to [FTS3] documentation for further details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2369 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2370 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2371 ** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2372 ** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2373 ** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2374 ** interface independently of the [load_extension()] SQL function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2375 ** The [sqlite3_enable_load_extension()] API enables or disables both the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2376 ** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2377 ** There must be two additional arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2378 ** When the first argument to this interface is 1, then only the C-API is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2379 ** enabled and the SQL function remains disabled. If the first argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2380 ** this interface is 0, then both the C-API and the SQL function are disabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2381 ** If the first argument is -1, then no changes are made to the state of either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2382 ** the C-API or the SQL function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2383 ** The second parameter is a pointer to an integer into which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2384 ** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2385 ** is disabled or enabled following this call. The second parameter may
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2386 ** be a NULL pointer, in which case the new setting is not reported back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2387 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2388 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2389 ** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2390 ** <dd> ^This option is used to change the name of the "main" database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2391 ** schema. This option does not follow the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2392 ** [DBCONFIG arguments\|usual SQLITE_DBCONFIG argument format].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2393 ** This option takes exactly one additional argument so that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2394 ** [sqlite3_db_config()] call has a total of three parameters. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2395 ** extra argument must be a pointer to a constant UTF8 string which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2396 ** will become the new schema name in place of "main". ^SQLite does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2397 ** not make a copy of the new main schema name string, so the application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2398 ** must ensure that the argument passed into SQLITE_DBCONFIG MAINDBNAME
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2399 ** is unchanged until after the database connection closes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2400 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2401 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2402 ** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2403 ** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2404 ** <dd> Usually, when a database in [WAL mode] is closed or detached from a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2405 ** database handle, SQLite checks if if there are other connections to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2406 ** same database, and if there are no other database connection (if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2407 ** connection being closed is the last open connection to the database),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2408 ** then SQLite performs a [checkpoint] before closing the connection and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2409 ** deletes the WAL file. The SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE option can
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2410 ** be used to override that behavior. The first argument passed to this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2411 ** operation (the third parameter to [sqlite3_db_config()]) is an integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2412 ** which is positive to disable checkpoints-on-close, or zero (the default)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2413 ** to enable them, and negative to leave the setting unchanged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2414 ** The second argument (the fourth parameter) is a pointer to an integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2415 ** into which is written 0 or 1 to indicate whether checkpoints-on-close
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2416 ** have been disabled - 0 if they are not disabled, 1 if they are.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2417 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2418 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2419 ** [[SQLITE_DBCONFIG_ENABLE_QPSG]] <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2420 ** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2421 ** the [query planner stability guarantee] (QPSG). When the QPSG is active,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2422 ** a single SQL query statement will always use the same algorithm regardless
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2423 ** of values of [bound parameters].)^ The QPSG disables some query optimizations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2424 ** that look at the values of bound parameters, which can make some queries
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2425 ** slower. But the QPSG has the advantage of more predictable behavior. With
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2426 ** the QPSG active, SQLite will always use the same query plan in the field as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2427 ** was used during testing in the lab.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2428 ** The first argument to this setting is an integer which is 0 to disable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2429 ** the QPSG, positive to enable QPSG, or negative to leave the setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2430 ** unchanged. The second parameter is a pointer to an integer into which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2431 ** is written 0 or 1 to indicate whether the QPSG is disabled or enabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2432 ** following this call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2433 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2434 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2435 ** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2436 ** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2437 ** include output for any operations performed by trigger programs. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2438 ** option is used to set or clear (the default) a flag that governs this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2439 ** behavior. The first parameter passed to this operation is an integer -
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2440 ** positive to enable output for trigger programs, or zero to disable it,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2441 ** or negative to leave the setting unchanged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2442 ** The second parameter is a pointer to an integer into which is written
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2443 ** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2444 ** it is not disabled, 1 if it is.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2445 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2446 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2447 ** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2448 ** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2449 ** [VACUUM] in order to reset a database back to an empty database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2450 ** with no schema and no content. The following process works even for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2451 ** a badly corrupted database file:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2452 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2453 ** <li> If the database connection is newly opened, make sure it has read the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2454 ** database schema by preparing then discarding some query against the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2455 ** database, or calling sqlite3_table_column_metadata(), ignoring any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2456 ** errors. This step is only necessary if the application desires to keep
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2457 ** the database in WAL mode after the reset if it was in WAL mode before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2458 ** the reset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2459 ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2460 ** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2461 ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2462 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2463 ** Because resetting a database is destructive and irreversible, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2464 ** process requires the use of this obscure API and multiple steps to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2465 ** help ensure that it does not happen by accident. Because this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2466 ** feature must be capable of resetting corrupt databases, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2467 ** shutting down virtual tables may require access to that corrupt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2468 ** storage, the library must abandon any installed virtual tables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2469 ** without calling their xDestroy() methods.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2470 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2471 ** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2472 ** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2473 ** "defensive" flag for a database connection. When the defensive
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2474 ** flag is enabled, language features that allow ordinary SQL to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2475 ** deliberately corrupt the database file are disabled. The disabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2476 ** features include but are not limited to the following:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2477 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2478 ** <li> The [PRAGMA writable_schema=ON] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2479 ** <li> The [PRAGMA journal_mode=OFF] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2480 ** <li> The [PRAGMA schema_version=N] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2481 ** <li> Writes to the [sqlite_dbpage] virtual table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2482 ** <li> Direct writes to [shadow tables].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2483 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2484 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2485 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2486 ** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]] <dt>SQLITE_DBCONFIG_WRITABLE_SCHEMA</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2487 ** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2488 ** "writable_schema" flag. This has the same effect and is logically equivalent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2489 ** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2490 ** The first argument to this setting is an integer which is 0 to disable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2491 ** the writable_schema, positive to enable writable_schema, or negative to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2492 ** leave the setting unchanged. The second parameter is a pointer to an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2493 ** integer into which is written 0 or 1 to indicate whether the writable_schema
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2494 ** is enabled or disabled following this call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2495 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2496 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2497 ** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2498 ** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2499 ** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2500 ** the legacy behavior of the [ALTER TABLE RENAME] command such that it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2501 ** behaves as it did prior to [version 3.24.0] (2018-06-04). See the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2502 ** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2503 ** additional information. This feature can also be turned on and off
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2504 ** using the [PRAGMA legacy_alter_table] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2505 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2506 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2507 ** [[SQLITE_DBCONFIG_DQS_DML]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2508 ** <dt>SQLITE_DBCONFIG_DQS_DML</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2509 ** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2510 ** the legacy [double-quoted string literal] misfeature for DML statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2511 ** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2512 ** default value of this setting is determined by the [-DSQLITE_DQS]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2513 ** compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2514 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2515 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2516 ** [[SQLITE_DBCONFIG_DQS_DDL]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2517 ** <dt>SQLITE_DBCONFIG_DQS_DDL</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2518 ** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2519 ** the legacy [double-quoted string literal] misfeature for DDL statements,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2520 ** such as CREATE TABLE and CREATE INDEX. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2521 ** default value of this setting is determined by the [-DSQLITE_DQS]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2522 ** compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2523 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2524 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2525 ** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2526 ** <dt>SQLITE_DBCONFIG_TRUSTED_SCHEMA</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2527 ** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2528 ** assume that database schemas are untainted by malicious content.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2529 ** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2530 ** takes additional defensive steps to protect the application from harm
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2531 ** including:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2532 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2533 ** <li> Prohibit the use of SQL functions inside triggers, views,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2534 ** CHECK constraints, DEFAULT clauses, expression indexes,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2535 ** partial indexes, or generated columns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2536 ** unless those functions are tagged with [SQLITE_INNOCUOUS].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2537 ** <li> Prohibit the use of virtual tables inside of triggers or views
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2538 ** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2539 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2540 ** This setting defaults to "on" for legacy compatibility, however
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2541 ** all applications are advised to turn it off if possible. This setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2542 ** can also be controlled using the [PRAGMA trusted_schema] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2543 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2544 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2545 ** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2546 ** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2547 ** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2548 ** the legacy file format flag. When activated, this flag causes all newly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2549 ** created database files to have a schema format version number (the 4-byte
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2550 ** integer found at offset 44 into the database header) of 1. This in turn
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2551 ** means that the resulting database file will be readable and writable by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2552 ** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2553 ** newly created databases are generally not understandable by SQLite versions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2554 ** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2555 ** is now scarcely any need to generate database files that are compatible
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2556 ** all the way back to version 3.0.0, and so this setting is of little
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2557 ** practical use, but is provided so that SQLite can continue to claim the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2558 ** ability to generate new database files that are compatible with version
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2559 ** 3.0.0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2560 ** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2561 ** the [VACUUM] command will fail with an obscure error when attempting to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2562 ** process a table with generated columns and a descending index. This is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2563 ** not considered a bug since SQLite versions 3.3.0 and earlier do not support
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2564 ** either generated columns or descending indexes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2565 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2566 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2567 ** [[SQLITE_DBCONFIG_STMT_SCANSTATUS]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2568 ** <dt>SQLITE_DBCONFIG_STMT_SCANSTATUS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2569 ** <dd>The SQLITE_DBCONFIG_STMT_SCANSTATUS option is only useful in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2570 ** SQLITE_ENABLE_STMT_SCANSTATUS builds. In this case, it sets or clears
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2571 ** a flag that enables collection of the sqlite3_stmt_scanstatus_v2()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2572 ** statistics. For statistics to be collected, the flag must be set on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2573 ** the database handle both when the SQL statement is prepared and when it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2574 ** is stepped. The flag is set (collection of statistics is enabled)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2575 ** by default. <p>This option takes two arguments: an integer and a pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2576 ** an integer. The first argument is 1, 0, or -1 to enable, disable, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2577 ** leave unchanged the statement scanstatus option. If the second argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2578 ** is not NULL, then the value of the statement scanstatus setting after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2579 ** processing the first argument is written into the integer that the second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2580 ** argument points to.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2581 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2582 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2583 ** [[SQLITE_DBCONFIG_REVERSE_SCANORDER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2584 ** <dt>SQLITE_DBCONFIG_REVERSE_SCANORDER</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2585 ** <dd>The SQLITE_DBCONFIG_REVERSE_SCANORDER option changes the default order
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2586 ** in which tables and indexes are scanned so that the scans start at the end
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2587 ** and work toward the beginning rather than starting at the beginning and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2588 ** working toward the end. Setting SQLITE_DBCONFIG_REVERSE_SCANORDER is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2589 ** same as setting [PRAGMA reverse_unordered_selects]. <p>This option takes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2590 ** two arguments which are an integer and a pointer to an integer. The first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2591 ** argument is 1, 0, or -1 to enable, disable, or leave unchanged the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2592 ** reverse scan order flag, respectively. If the second argument is not NULL,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2593 ** then 0 or 1 is written into the integer that the second argument points to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2594 ** depending on if the reverse scan order flag is set after processing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2595 ** first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2596 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2597 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2598 ** [[SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2599 ** <dt>SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2600 ** <dd>The SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE option enables or disables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2601 ** the ability of the [ATTACH DATABASE] SQL command to create a new database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2602 ** file if the database filed named in the ATTACH command does not already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2603 ** exist. This ability of ATTACH to create a new database is enabled by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2604 ** default. Applications can disable or reenable the ability for ATTACH to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2605 ** create new database files using this DBCONFIG option.<p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2606 ** This option takes two arguments which are an integer and a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2607 ** to an integer. The first argument is 1, 0, or -1 to enable, disable, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2608 ** leave unchanged the attach-create flag, respectively. If the second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2609 ** argument is not NULL, then 0 or 1 is written into the integer that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2610 ** second argument points to depending on if the attach-create flag is set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2611 ** after processing the first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2612 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2613 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2614 ** [[SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2615 ** <dt>SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2616 ** <dd>The SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE option enables or disables the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2617 ** ability of the [ATTACH DATABASE] SQL command to open a database for writing.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2618 ** This capability is enabled by default. Applications can disable or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2619 ** reenable this capability using the current DBCONFIG option. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2620 ** this capability is disabled, the [ATTACH] command will still work,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2621 ** but the database will be opened read-only. If this option is disabled,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2622 ** then the ability to create a new database using [ATTACH] is also disabled,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2623 ** regardless of the value of the [SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2624 ** option.<p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2625 ** This option takes two arguments which are an integer and a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2626 ** to an integer. The first argument is 1, 0, or -1 to enable, disable, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2627 ** leave unchanged the ability to ATTACH another database for writing,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2628 ** respectively. If the second argument is not NULL, then 0 or 1 is written
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2629 ** into the integer to which the second argument points, depending on whether
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2630 ** the ability to ATTACH a read/write database is enabled or disabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2631 ** after processing the first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2632 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2633 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2634 ** [[SQLITE_DBCONFIG_ENABLE_COMMENTS]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2635 ** <dt>SQLITE_DBCONFIG_ENABLE_COMMENTS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2636 ** <dd>The SQLITE_DBCONFIG_ENABLE_COMMENTS option enables or disables the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2637 ** ability to include comments in SQL text. Comments are enabled by default.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2638 ** An application can disable or reenable comments in SQL text using this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2639 ** DBCONFIG option.<p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2640 ** This option takes two arguments which are an integer and a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2641 ** to an integer. The first argument is 1, 0, or -1 to enable, disable, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2642 ** leave unchanged the ability to use comments in SQL text,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2643 ** respectively. If the second argument is not NULL, then 0 or 1 is written
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2644 ** into the integer that the second argument points to depending on if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2645 ** comments are allowed in SQL text after processing the first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2646 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2647 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2648 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2649 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2650 ** [[DBCONFIG arguments]] <h3>Arguments To SQLITE_DBCONFIG Options</h3>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2651 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2652 ** <p>Most of the SQLITE_DBCONFIG options take two arguments, so that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2653 ** overall call to [sqlite3_db_config()] has a total of four parameters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2654 ** The first argument (the third parameter to sqlite3_db_config()) is an integer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2655 ** The second argument is a pointer to an integer. If the first argument is 1,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2656 ** then the option becomes enabled. If the first integer argument is 0, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2657 ** option is disabled. If the first argument is -1, then the option setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2658 ** is unchanged. The second argument, the pointer to an integer, may be NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2659 ** If the second argument is not NULL, then a value of 0 or 1 is written into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2660 ** the integer to which the second argument points, depending on whether the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2661 ** setting is disabled or enabled after applying any changes specified by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2662 ** the first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2663 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2664 ** <p>While most SQLITE_DBCONFIG options use the argument format
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2665 ** described in the previous paragraph, the [SQLITE_DBCONFIG_MAINDBNAME]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2666 ** and [SQLITE_DBCONFIG_LOOKASIDE] options are different. See the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2667 ** documentation of those exceptional options for details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2668 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2669 #define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2670 #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2671 #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2672 #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2673 #define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2674 #define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2675 #define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2676 #define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2677 #define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2678 #define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2679 #define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2680 #define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2681 #define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2682 #define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2683 #define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2684 #define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2685 #define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2686 #define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2687 #define SQLITE_DBCONFIG_STMT_SCANSTATUS 1018 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2688 #define SQLITE_DBCONFIG_REVERSE_SCANORDER 1019 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2689 #define SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE 1020 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2690 #define SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE 1021 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2691 #define SQLITE_DBCONFIG_ENABLE_COMMENTS 1022 /* int int* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2692 #define SQLITE_DBCONFIG_MAX 1022 /* Largest DBCONFIG */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2693
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2694 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2695 ** CAPI3REF: Enable Or Disable Extended Result Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2696 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2697 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2698 ** ^The sqlite3_extended_result_codes() routine enables or disables the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2699 ** [extended result codes] feature of SQLite. ^The extended result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2700 ** codes are disabled by default for historical compatibility.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2701 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2702 SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2703
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2704 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2705 ** CAPI3REF: Last Insert Rowid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2706 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2707 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2708 ** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2709 ** has a unique 64-bit signed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2710 ** integer key called the [ROWID \| "rowid"]. ^The rowid is always available
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2711 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2712 ** names are not also used by explicitly declared columns. ^If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2713 ** the table has a column of type [INTEGER PRIMARY KEY] then that column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2714 ** is another alias for the rowid.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2715 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2716 ** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2717 ** the most recent successful [INSERT] into a rowid table or [virtual table]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2718 ** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2719 ** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2720 ** on the database connection D, then sqlite3_last_insert_rowid(D) returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2721 ** zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2722 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2723 ** As well as being set automatically as rows are inserted into database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2724 ** tables, the value returned by this function may be set explicitly by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2725 ** [sqlite3_set_last_insert_rowid()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2726 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2727 ** Some virtual table implementations may INSERT rows into rowid tables as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2728 ** part of committing a transaction (e.g. to flush data accumulated in memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2729 ** to disk). In this case subsequent calls to this function return the rowid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2730 ** associated with these internal INSERT operations, which leads to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2731 ** unintuitive results. Virtual table implementations that do write to rowid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2732 ** tables in this way can avoid this problem by restoring the original
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2733 ** rowid value using [sqlite3_set_last_insert_rowid()] before returning
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2734 ** control to the user.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2735 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2736 ** ^(If an [INSERT] occurs within a trigger then this routine will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2737 ** return the [rowid] of the inserted row as long as the trigger is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2738 ** running. Once the trigger program ends, the value returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2739 ** by this routine reverts to what it was before the trigger was fired.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2740 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2741 ** ^An [INSERT] that fails due to a constraint violation is not a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2742 ** successful [INSERT] and does not change the value returned by this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2743 ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2744 ** and INSERT OR ABORT make no changes to the return value of this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2745 ** routine when their insertion fails. ^(When INSERT OR REPLACE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2746 ** encounters a constraint violation, it does not fail. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2747 ** INSERT continues to completion after deleting rows that caused
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2748 ** the constraint problem so INSERT OR REPLACE will always change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2749 ** the return value of this interface.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2750 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2751 ** ^For the purposes of this routine, an [INSERT] is considered to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2752 ** be successful even if it is subsequently rolled back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2753 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2754 ** This function is accessible to SQL statements via the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2755 ** [last_insert_rowid() SQL function].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2756 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2757 ** If a separate thread performs a new [INSERT] on the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2758 ** database connection while the [sqlite3_last_insert_rowid()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2759 ** function is running and thus changes the last insert [rowid],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2760 ** then the value returned by [sqlite3_last_insert_rowid()] is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2761 ** unpredictable and might not equal either the old or the new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2762 ** last insert [rowid].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2763 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2764 SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2765
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2766 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2767 ** CAPI3REF: Set the Last Insert Rowid value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2768 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2769 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2770 ** The sqlite3_set_last_insert_rowid(D, R) method allows the application to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2771 ** set the value returned by calling sqlite3_last_insert_rowid(D) to R
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2772 ** without inserting a row into the database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2773 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2774 SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2775
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2776 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2777 ** CAPI3REF: Count The Number Of Rows Modified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2778 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2779 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2780 ** ^These functions return the number of rows modified, inserted or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2781 ** deleted by the most recently completed INSERT, UPDATE or DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2782 ** statement on the database connection specified by the only parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2783 ** The two functions are identical except for the type of the return value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2784 ** and that if the number of rows modified by the most recent INSERT, UPDATE,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2785 ** or DELETE is greater than the maximum value supported by type "int", then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2786 ** the return value of sqlite3_changes() is undefined. ^Executing any other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2787 ** type of SQL statement does not modify the value returned by these functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2788 ** For the purposes of this interface, a CREATE TABLE AS SELECT statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2789 ** does not count as an INSERT, UPDATE or DELETE statement and hence the rows
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2790 ** added to the new table by the CREATE TABLE AS SELECT statement are not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2791 ** counted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2792 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2793 ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2794 ** considered - auxiliary changes caused by [CREATE TRIGGER \| triggers],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2795 ** [foreign key actions] or [REPLACE] constraint resolution are not counted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2796 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2797 ** Changes to a view that are intercepted by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2798 ** [INSTEAD OF trigger \| INSTEAD OF triggers] are not counted. ^The value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2799 ** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2800 ** DELETE statement run on a view is always zero. Only changes made to real
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2801 ** tables are counted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2802 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2803 ** Things are more complicated if the sqlite3_changes() function is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2804 ** executed while a trigger program is running. This may happen if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2805 ** program uses the [changes() SQL function], or if some other callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2806 ** function invokes sqlite3_changes() directly. Essentially:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2807 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2808 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2809 ** <li> ^(Before entering a trigger program the value returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2810 ** sqlite3_changes() function is saved. After the trigger program
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2811 ** has finished, the original value is restored.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2812 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2813 ** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2814 ** statement sets the value returned by sqlite3_changes()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2815 ** upon completion as normal. Of course, this value will not include
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2816 ** any changes performed by sub-triggers, as the sqlite3_changes()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2817 ** value will be saved and restored after each sub-trigger has run.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2818 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2819 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2820 ** ^This means that if the changes() SQL function (or similar) is used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2821 ** by the first INSERT, UPDATE or DELETE statement within a trigger, it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2822 ** returns the value as set when the calling statement began executing.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2823 ** ^If it is used by the second or subsequent such statement within a trigger
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2824 ** program, the value returned reflects the number of rows modified by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2825 ** previous INSERT, UPDATE or DELETE statement within the same trigger.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2826 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2827 ** If a separate thread makes changes on the same database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2828 ** while [sqlite3_changes()] is running then the value returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2829 ** is unpredictable and not meaningful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2830 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2831 ** See also:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2832 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2833 ** <li> the [sqlite3_total_changes()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2834 ** <li> the [count_changes pragma]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2835 ** <li> the [changes() SQL function]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2836 ** <li> the [data_version pragma]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2837 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2838 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2839 SQLITE_API int sqlite3_changes(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2840 SQLITE_API sqlite3_int64 sqlite3_changes64(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2841
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2842 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2843 ** CAPI3REF: Total Number Of Rows Modified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2844 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2845 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2846 ** ^These functions return the total number of rows inserted, modified or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2847 ** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2848 ** since the database connection was opened, including those executed as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2849 ** part of trigger programs. The two functions are identical except for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2850 ** type of the return value and that if the number of rows modified by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2851 ** connection exceeds the maximum value supported by type "int", then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2852 ** the return value of sqlite3_total_changes() is undefined. ^Executing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2853 ** any other type of SQL statement does not affect the value returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2854 ** sqlite3_total_changes().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2855 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2856 ** ^Changes made as part of [foreign key actions] are included in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2857 ** count, but those made as part of REPLACE constraint resolution are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2858 ** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2859 ** are not counted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2860 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2861 ** The [sqlite3_total_changes(D)] interface only reports the number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2862 ** of rows that changed due to SQL statement run against database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2863 ** connection D. Any changes by other database connections are ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2864 ** To detect changes against a database file from other database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2865 ** connections use the [PRAGMA data_version] command or the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2866 ** [SQLITE_FCNTL_DATA_VERSION] [file control].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2867 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2868 ** If a separate thread makes changes on the same database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2869 ** while [sqlite3_total_changes()] is running then the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2870 ** returned is unpredictable and not meaningful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2871 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2872 ** See also:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2873 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2874 ** <li> the [sqlite3_changes()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2875 ** <li> the [count_changes pragma]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2876 ** <li> the [changes() SQL function]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2877 ** <li> the [data_version pragma]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2878 ** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2879 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2880 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2881 SQLITE_API int sqlite3_total_changes(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2882 SQLITE_API sqlite3_int64 sqlite3_total_changes64(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2883
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2884 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2885 ** CAPI3REF: Interrupt A Long-Running Query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2886 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2887 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2888 ** ^This function causes any pending database operation to abort and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2889 ** return at its earliest opportunity. This routine is typically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2890 ** called in response to a user action such as pressing "Cancel"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2891 ** or Ctrl-C where the user wants a long query operation to halt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2892 ** immediately.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2893 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2894 ** ^It is safe to call this routine from a thread different from the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2895 ** thread that is currently running the database operation. But it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2896 ** is not safe to call this routine with a [database connection] that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2897 ** is closed or might close before sqlite3_interrupt() returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2898 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2899 ** ^If an SQL operation is very nearly finished at the time when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2900 ** sqlite3_interrupt() is called, then it might not have an opportunity
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2901 ** to be interrupted and might continue to completion.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2902 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2903 ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2904 ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2905 ** that is inside an explicit transaction, then the entire transaction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2906 ** will be rolled back automatically.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2907 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2908 ** ^The sqlite3_interrupt(D) call is in effect until all currently running
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2909 ** SQL statements on [database connection] D complete. ^Any new SQL statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2910 ** that are started after the sqlite3_interrupt() call and before the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2911 ** running statement count reaches zero are interrupted as if they had been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2912 ** running prior to the sqlite3_interrupt() call. ^New SQL statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2913 ** that are started after the running statement count reaches zero are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2914 ** not effected by the sqlite3_interrupt().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2915 ** ^A call to sqlite3_interrupt(D) that occurs when there are no running
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2916 ** SQL statements is a no-op and has no effect on SQL statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2917 ** that are started after the sqlite3_interrupt() call returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2918 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2919 ** ^The [sqlite3_is_interrupted(D)] interface can be used to determine whether
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2920 ** or not an interrupt is currently in effect for [database connection] D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2921 ** It returns 1 if an interrupt is currently in effect, or 0 otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2922 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2923 SQLITE_API void sqlite3_interrupt(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2924 SQLITE_API int sqlite3_is_interrupted(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2925
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2926 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2927 ** CAPI3REF: Determine If An SQL Statement Is Complete
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2928 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2929 ** These routines are useful during command-line input to determine if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2930 ** currently entered text seems to form a complete SQL statement or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2931 ** if additional input is needed before sending the text into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2932 ** SQLite for parsing. ^These routines return 1 if the input string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2933 ** appears to be a complete SQL statement. ^A statement is judged to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2934 ** complete if it ends with a semicolon token and is not a prefix of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2935 ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2936 ** string literals or quoted identifier names or comments are not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2937 ** independent tokens (they are part of the token in which they are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2938 ** embedded) and thus do not count as a statement terminator. ^Whitespace
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2939 ** and comments that follow the final semicolon are ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2940 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2941 ** ^These routines return 0 if the statement is incomplete. ^If a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2942 ** memory allocation fails, then SQLITE_NOMEM is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2943 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2944 ** ^These routines do not parse the SQL statements and thus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2945 ** will not detect syntactically incorrect SQL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2946 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2947 ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2948 ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2949 ** automatically by sqlite3_complete16(). If that initialization fails,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2950 ** then the return value from sqlite3_complete16() will be non-zero
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2951 ** regardless of whether or not the input SQL is complete.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2952 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2953 ** The input to [sqlite3_complete()] must be a zero-terminated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2954 ** UTF-8 string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2955 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2956 ** The input to [sqlite3_complete16()] must be a zero-terminated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2957 ** UTF-16 string in native byte order.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2958 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2959 SQLITE_API int sqlite3_complete(const char *sql);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2960 SQLITE_API int sqlite3_complete16(const void *sql);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2961
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2962 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2963 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2964 ** KEYWORDS: {busy-handler callback} {busy handler}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2965 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2966 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2967 ** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2968 ** that might be invoked with argument P whenever
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2969 ** an attempt is made to access a database table associated with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2970 ** [database connection] D when another thread
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2971 ** or process has the table locked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2972 ** The sqlite3_busy_handler() interface is used to implement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2973 ** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2974 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2975 ** ^If the busy callback is NULL, then [SQLITE_BUSY]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2976 ** is returned immediately upon encountering the lock. ^If the busy callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2977 ** is not NULL, then the callback might be invoked with two arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2978 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2979 ** ^The first argument to the busy handler is a copy of the void* pointer which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2980 ** is the third argument to sqlite3_busy_handler(). ^The second argument to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2981 ** the busy handler callback is the number of times that the busy handler has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2982 ** been invoked previously for the same locking event. ^If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2983 ** busy callback returns 0, then no additional attempts are made to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2984 ** access the database and [SQLITE_BUSY] is returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2985 ** to the application.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2986 ** ^If the callback returns non-zero, then another attempt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2987 ** is made to access the database and the cycle repeats.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2988 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2989 ** The presence of a busy handler does not guarantee that it will be invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2990 ** when there is lock contention. ^If SQLite determines that invoking the busy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2991 ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2992 ** to the application instead of invoking the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2993 ** busy handler.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2994 ** Consider a scenario where one process is holding a read lock that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2995 ** it is trying to promote to a reserved lock and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2996 ** a second process is holding a reserved lock that it is trying
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2997 ** to promote to an exclusive lock. The first process cannot proceed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2998 ** because it is blocked by the second and the second process cannot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	2999 ** proceed because it is blocked by the first. If both processes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3000 ** invoke the busy handlers, neither will make any progress. Therefore,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3001 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3002 ** will induce the first process to release its read lock and allow
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3003 ** the second process to proceed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3004 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3005 ** ^The default busy callback is NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3006 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3007 ** ^(There can only be a single busy handler defined for each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3008 ** [database connection]. Setting a new busy handler clears any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3009 ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3010 ** or evaluating [PRAGMA busy_timeout=N] will change the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3011 ** busy handler and thus clear any previously set busy handler.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3012 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3013 ** The busy callback should not take any actions which modify the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3014 ** database connection that invoked the busy handler. In other words,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3015 ** the busy handler is not reentrant. Any such actions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3016 ** result in undefined behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3017 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3018 ** A busy handler must not close the database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3019 ** or [prepared statement] that invoked the busy handler.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3020 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3021 SQLITE_API int sqlite3_busy_handler(sqlite3,int()(void,int),void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3022
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3023 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3024 ** CAPI3REF: Set A Busy Timeout
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3025 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3026 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3027 ** ^This routine sets a [sqlite3_busy_handler \| busy handler] that sleeps
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3028 ** for a specified amount of time when a table is locked. ^The handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3029 ** will sleep multiple times until at least "ms" milliseconds of sleeping
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3030 ** have accumulated. ^After at least "ms" milliseconds of sleeping,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3031 ** the handler returns 0 which causes [sqlite3_step()] to return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3032 ** [SQLITE_BUSY].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3033 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3034 ** ^Calling this routine with an argument less than or equal to zero
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3035 ** turns off all busy handlers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3036 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3037 ** ^(There can only be a single busy handler for a particular
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3038 ** [database connection] at any given moment. If another busy handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3039 ** was defined (using [sqlite3_busy_handler()]) prior to calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3040 ** this routine, that other busy handler is cleared.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3041 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3042 ** See also: [PRAGMA busy_timeout]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3043 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3044 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3045
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3046 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3047 ** CAPI3REF: Set the Setlk Timeout
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3048 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3049 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3050 ** This routine is only useful in SQLITE_ENABLE_SETLK_TIMEOUT builds. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3051 ** the VFS supports blocking locks, it sets the timeout in ms used by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3052 ** eligible locks taken on wal mode databases by the specified database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3053 ** handle. In non-SQLITE_ENABLE_SETLK_TIMEOUT builds, or if the VFS does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3054 ** not support blocking locks, this function is a no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3055 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3056 ** Passing 0 to this function disables blocking locks altogether. Passing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3057 ** -1 to this function requests that the VFS blocks for a long time -
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3058 ** indefinitely if possible. The results of passing any other negative value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3059 ** are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3060 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3061 ** Internally, each SQLite database handle stores two timeout values - the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3062 ** busy-timeout (used for rollback mode databases, or if the VFS does not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3063 ** support blocking locks) and the setlk-timeout (used for blocking locks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3064 ** on wal-mode databases). The sqlite3_busy_timeout() method sets both
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3065 ** values, this function sets only the setlk-timeout value. Therefore,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3066 ** to configure separate busy-timeout and setlk-timeout values for a single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3067 ** database handle, call sqlite3_busy_timeout() followed by this function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3068 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3069 ** Whenever the number of connections to a wal mode database falls from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3070 ** 1 to 0, the last connection takes an exclusive lock on the database,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3071 ** then checkpoints and deletes the wal file. While it is doing this, any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3072 ** new connection that tries to read from the database fails with an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3073 ** SQLITE_BUSY error. Or, if the SQLITE_SETLK_BLOCK_ON_CONNECT flag is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3074 ** passed to this API, the new connection blocks until the exclusive lock
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3075 ** has been released.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3076 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3077 SQLITE_API int sqlite3_setlk_timeout(sqlite3*, int ms, int flags);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3078
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3079 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3080 ** CAPI3REF: Flags for sqlite3_setlk_timeout()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3081 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3082 #define SQLITE_SETLK_BLOCK_ON_CONNECT 0x01
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3083
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3084 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3085 ** CAPI3REF: Convenience Routines For Running Queries
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3086 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3087 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3088 ** This is a legacy interface that is preserved for backwards compatibility.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3089 ** Use of this interface is not recommended.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3090 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3091 ** Definition: A <b>result table</b> is a memory data structure created by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3092 ** [sqlite3_get_table()] interface. A result table records the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3093 ** complete query results from one or more queries.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3094 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3095 ** The table conceptually has a number of rows and columns. But
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3096 ** these numbers are not part of the result table itself. These
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3097 ** numbers are obtained separately. Let N be the number of rows
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3098 ** and M be the number of columns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3099 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3100 ** A result table is an array of pointers to zero-terminated UTF-8 strings.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3101 ** There are (N+1)*M elements in the array. The first M pointers point
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3102 ** to zero-terminated strings that contain the names of the columns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3103 ** The remaining entries all point to query results. NULL values result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3104 ** in NULL pointers. All other values are in their UTF-8 zero-terminated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3105 ** string representation as returned by [sqlite3_column_text()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3106 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3107 ** A result table might consist of one or more memory allocations.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3108 ** It is not safe to pass a result table directly to [sqlite3_free()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3109 ** A result table should be deallocated using [sqlite3_free_table()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3110 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3111 ** ^(As an example of the result table format, suppose a query result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3112 ** is as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3113 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3114 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3115 ** Name \| Age
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3116 ** -----------------------
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3117 ** Alice \| 43
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3118 ** Bob \| 28
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3119 ** Cindy \| 21
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3120 ** </pre></blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3121 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3122 ** There are two columns (M==2) and three rows (N==3). Thus the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3123 ** result table has 8 entries. Suppose the result table is stored
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3124 ** in an array named azResult. Then azResult holds this content:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3125 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3126 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3127 ** azResult[0] = "Name";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3128 ** azResult[1] = "Age";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3129 ** azResult[2] = "Alice";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3130 ** azResult[3] = "43";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3131 ** azResult[4] = "Bob";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3132 ** azResult[5] = "28";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3133 ** azResult[6] = "Cindy";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3134 ** azResult[7] = "21";
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3135 ** </pre></blockquote>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3136 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3137 ** ^The sqlite3_get_table() function evaluates one or more
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3138 ** semicolon-separated SQL statements in the zero-terminated UTF-8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3139 ** string of its 2nd parameter and returns a result table to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3140 ** pointer given in its 3rd parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3141 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3142 ** After the application has finished with the result from sqlite3_get_table(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3143 ** it must pass the result table pointer to sqlite3_free_table() in order to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3144 ** release the memory that was malloced. Because of the way the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3145 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3146 ** function must not try to call [sqlite3_free()] directly. Only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3147 ** [sqlite3_free_table()] is able to release the memory properly and safely.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3148 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3149 ** The sqlite3_get_table() interface is implemented as a wrapper around
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3150 ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3151 ** to any internal data structures of SQLite. It uses only the public
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3152 ** interface defined here. As a consequence, errors that occur in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3153 ** wrapper layer outside of the internal [sqlite3_exec()] call are not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3154 ** reflected in subsequent calls to [sqlite3_errcode()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3155 ** [sqlite3_errmsg()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3156 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3157 SQLITE_API int sqlite3_get_table(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3158 sqlite3 db, / An open database */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3159 const char zSql, / SQL to be evaluated */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3160 char **pazResult, / Results of the query */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3161 int pnRow, / Number of result rows written here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3162 int pnColumn, / Number of result columns written here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3163 char *pzErrmsg / Error msg written here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3164 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3165 SQLITE_API void sqlite3_free_table(char **result);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3166
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3167 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3168 ** CAPI3REF: Formatted String Printing Functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3169 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3170 ** These routines are work-alikes of the "printf()" family of functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3171 ** from the standard C library.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3172 ** These routines understand most of the common formatting options from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3173 ** the standard library printf()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3174 ** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3175 ** See the [built-in printf()] documentation for details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3176 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3177 ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3178 ** results into memory obtained from [sqlite3_malloc64()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3179 ** The strings returned by these two routines should be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3180 ** released by [sqlite3_free()]. ^Both routines return a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3181 ** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3182 ** memory to hold the resulting string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3183 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3184 ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3185 ** the standard C library. The result is written into the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3186 ** buffer supplied as the second parameter whose size is given by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3187 ** the first parameter. Note that the order of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3188 ** first two parameters is reversed from snprintf().)^ This is an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3189 ** historical accident that cannot be fixed without breaking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3190 ** backwards compatibility. ^(Note also that sqlite3_snprintf()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3191 ** returns a pointer to its buffer instead of the number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3192 ** characters actually written into the buffer.)^ We admit that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3193 ** the number of characters written would be a more useful return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3194 ** value but we cannot change the implementation of sqlite3_snprintf()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3195 ** now without breaking compatibility.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3196 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3197 ** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3198 ** guarantees that the buffer is always zero-terminated. ^The first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3199 ** parameter "n" is the total size of the buffer, including space for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3200 ** the zero terminator. So the longest string that can be completely
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3201 ** written will be n-1 characters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3202 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3203 ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3204 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3205 ** See also: [built-in printf()], [printf() SQL function]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3206 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3207 SQLITE_API char sqlite3_mprintf(const char,...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3208 SQLITE_API char sqlite3_vmprintf(const char, va_list);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3209 SQLITE_API char sqlite3_snprintf(int,char,const char*, ...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3210 SQLITE_API char sqlite3_vsnprintf(int,char,const char*, va_list);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3211
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3212 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3213 ** CAPI3REF: Memory Allocation Subsystem
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3214 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3215 ** The SQLite core uses these three routines for all of its own
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3216 ** internal memory allocation needs. "Core" in the previous sentence
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3217 ** does not include operating-system specific [VFS] implementation. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3218 ** Windows VFS uses native malloc() and free() for some operations.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3219 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3220 ** ^The sqlite3_malloc() routine returns a pointer to a block
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3221 ** of memory at least N bytes in length, where N is the parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3222 ** ^If sqlite3_malloc() is unable to obtain sufficient free
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3223 ** memory, it returns a NULL pointer. ^If the parameter N to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3224 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3225 ** a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3226 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3227 ** ^The sqlite3_malloc64(N) routine works just like
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3228 ** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3229 ** of a signed 32-bit integer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3230 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3231 ** ^Calling sqlite3_free() with a pointer previously returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3232 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3233 ** that it might be reused. ^The sqlite3_free() routine is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3234 ** a no-op if it is called with a NULL pointer. Passing a NULL pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3235 ** to sqlite3_free() is harmless. After being freed, memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3236 ** should neither be read nor written. Even reading previously freed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3237 ** memory might result in a segmentation fault or other severe error.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3238 ** Memory corruption, a segmentation fault, or other severe error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3239 ** might result if sqlite3_free() is called with a non-NULL pointer that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3240 ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3241 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3242 ** ^The sqlite3_realloc(X,N) interface attempts to resize a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3243 ** prior memory allocation X to be at least N bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3244 ** ^If the X parameter to sqlite3_realloc(X,N)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3245 ** is a NULL pointer then its behavior is identical to calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3246 ** sqlite3_malloc(N).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3247 ** ^If the N parameter to sqlite3_realloc(X,N) is zero or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3248 ** negative then the behavior is exactly the same as calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3249 ** sqlite3_free(X).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3250 ** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3251 ** of at least N bytes in size or NULL if insufficient memory is available.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3252 ** ^If M is the size of the prior allocation, then min(N,M) bytes of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3253 ** prior allocation are copied into the beginning of the buffer returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3254 ** by sqlite3_realloc(X,N) and the prior allocation is freed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3255 ** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3256 ** prior allocation is not freed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3257 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3258 ** ^The sqlite3_realloc64(X,N) interface works the same as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3259 ** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3260 ** of a 32-bit signed integer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3261 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3262 ** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3263 ** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3264 ** sqlite3_msize(X) returns the size of that memory allocation in bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3265 ** ^The value returned by sqlite3_msize(X) might be larger than the number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3266 ** of bytes requested when X was allocated. ^If X is a NULL pointer then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3267 ** sqlite3_msize(X) returns zero. If X points to something that is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3268 ** the beginning of memory allocation, or if it points to a formerly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3269 ** valid memory allocation that has now been freed, then the behavior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3270 ** of sqlite3_msize(X) is undefined and possibly harmful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3271 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3272 ** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3273 ** sqlite3_malloc64(), and sqlite3_realloc64()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3274 ** is always aligned to at least an 8 byte boundary, or to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3275 ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3276 ** option is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3277 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3278 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3279 ** must be either NULL or else pointers obtained from a prior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3280 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3281 ** not yet been released.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3282 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3283 ** The application must not read or write any part of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3284 ** a block of memory after it has been released using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3285 ** [sqlite3_free()] or [sqlite3_realloc()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3286 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3287 SQLITE_API void *sqlite3_malloc(int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3288 SQLITE_API void *sqlite3_malloc64(sqlite3_uint64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3289 SQLITE_API void sqlite3_realloc(void, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3290 SQLITE_API void sqlite3_realloc64(void, sqlite3_uint64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3291 SQLITE_API void sqlite3_free(void*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3292 SQLITE_API sqlite3_uint64 sqlite3_msize(void*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3293
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3294 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3295 ** CAPI3REF: Memory Allocator Statistics
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3296 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3297 ** SQLite provides these two interfaces for reporting on the status
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3298 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3299 ** routines, which form the built-in memory allocation subsystem.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3300 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3301 ** ^The [sqlite3_memory_used()] routine returns the number of bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3302 ** of memory currently outstanding (malloced but not freed).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3303 ** ^The [sqlite3_memory_highwater()] routine returns the maximum
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3304 ** value of [sqlite3_memory_used()] since the high-water mark
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3305 ** was last reset. ^The values returned by [sqlite3_memory_used()] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3306 ** [sqlite3_memory_highwater()] include any overhead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3307 ** added by SQLite in its implementation of [sqlite3_malloc()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3308 ** but not overhead added by any underlying system library
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3309 ** routines that [sqlite3_malloc()] may call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3310 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3311 ** ^The memory high-water mark is reset to the current value of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3312 ** [sqlite3_memory_used()] if and only if the parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3313 ** [sqlite3_memory_highwater()] is true. ^The value returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3314 ** by [sqlite3_memory_highwater(1)] is the high-water mark
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3315 ** prior to the reset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3316 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3317 SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3318 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3319
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3320 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3321 ** CAPI3REF: Pseudo-Random Number Generator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3322 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3323 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3324 ** select random [ROWID \| ROWIDs] when inserting new records into a table that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3325 ** already uses the largest possible [ROWID]. The PRNG is also used for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3326 ** the built-in random() and randomblob() SQL functions. This interface allows
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3327 ** applications to access the same PRNG for other purposes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3328 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3329 ** ^A call to this routine stores N bytes of randomness into buffer P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3330 ** ^The P parameter can be a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3331 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3332 ** ^If this routine has not been previously called or if the previous
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3333 ** call had N less than one or a NULL pointer for P, then the PRNG is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3334 ** seeded using randomness obtained from the xRandomness method of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3335 ** the default [sqlite3_vfs] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3336 ** ^If the previous call to this routine had an N of 1 or more and a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3337 ** non-NULL P then the pseudo-randomness is generated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3338 ** internally and without recourse to the [sqlite3_vfs] xRandomness
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3339 ** method.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3340 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3341 SQLITE_API void sqlite3_randomness(int N, void *P);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3342
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3343 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3344 ** CAPI3REF: Compile-Time Authorization Callbacks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3345 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3346 ** KEYWORDS: {authorizer callback}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3347 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3348 ** ^This routine registers an authorizer callback with a particular
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3349 ** [database connection], supplied in the first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3350 ** ^The authorizer callback is invoked as SQL statements are being compiled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3351 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3352 ** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3353 ** and [sqlite3_prepare16_v3()]. ^At various
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3354 ** points during the compilation process, as logic is being created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3355 ** to perform various actions, the authorizer callback is invoked to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3356 ** see if those actions are allowed. ^The authorizer callback should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3357 ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3358 ** specific action but allow the SQL statement to continue to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3359 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3360 ** rejected with an error. ^If the authorizer callback returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3361 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3362 ** then the [sqlite3_prepare_v2()] or equivalent call that triggered
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3363 ** the authorizer will fail with an error message.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3364 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3365 ** When the callback returns [SQLITE_OK], that means the operation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3366 ** requested is ok. ^When the callback returns [SQLITE_DENY], the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3367 ** [sqlite3_prepare_v2()] or equivalent call that triggered the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3368 ** authorizer will fail with an error message explaining that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3369 ** access is denied.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3370 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3371 ** ^The first parameter to the authorizer callback is a copy of the third
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3372 ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3373 ** to the callback is an integer [SQLITE_COPY \| action code] that specifies
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3374 ** the particular action to be authorized. ^The third through sixth parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3375 ** to the callback are either NULL pointers or zero-terminated strings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3376 ** that contain additional details about the action to be authorized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3377 ** Applications must always be prepared to encounter a NULL pointer in any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3378 ** of the third through the sixth parameters of the authorization callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3379 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3380 ** ^If the action code is [SQLITE_READ]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3381 ** and the callback returns [SQLITE_IGNORE] then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3382 ** [prepared statement] statement is constructed to substitute
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3383 ** a NULL value in place of the table column that would have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3384 ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3385 ** return can be used to deny an untrusted user access to individual
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3386 ** columns of a table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3387 ** ^When a table is referenced by a [SELECT] but no column values are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3388 ** extracted from that table (for example in a query like
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3389 ** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3390 ** is invoked once for that table with a column name that is an empty string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3391 ** ^If the action code is [SQLITE_DELETE] and the callback returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3392 ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3393 ** [truncate optimization] is disabled and all rows are deleted individually.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3394 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3395 ** An authorizer is used when [sqlite3_prepare \| preparing]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3396 ** SQL statements from an untrusted source, to ensure that the SQL statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3397 ** do not try to access data they are not allowed to see, or that they do not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3398 ** try to execute malicious statements that damage the database. For
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3399 ** example, an application may allow a user to enter arbitrary
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3400 ** SQL queries for evaluation by a database. But the application does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3401 ** not want the user to be able to make arbitrary changes to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3402 ** database. An authorizer could then be put in place while the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3403 ** user-entered SQL is being [sqlite3_prepare \| prepared] that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3404 ** disallows everything except [SELECT] statements.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3405 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3406 ** Applications that need to process SQL from untrusted sources
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3407 ** might also consider lowering resource limits using [sqlite3_limit()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3408 ** and limiting database size using the [max_page_count] [PRAGMA]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3409 ** in addition to using an authorizer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3410 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3411 ** ^(Only a single authorizer can be in place on a database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3412 ** at a time. Each call to sqlite3_set_authorizer overrides the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3413 ** previous call.)^ ^Disable the authorizer by installing a NULL callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3414 ** The authorizer is disabled by default.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3415 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3416 ** The authorizer callback must not do anything that will modify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3417 ** the database connection that invoked the authorizer callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3418 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3419 ** database connections for the meaning of "modify" in this paragraph.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3420 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3421 ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3422 ** statement might be re-prepared during [sqlite3_step()] due to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3423 ** schema change. Hence, the application should ensure that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3424 ** correct authorizer callback remains in place during the [sqlite3_step()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3425 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3426 ** ^Note that the authorizer callback is invoked only during
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3427 ** [sqlite3_prepare()] or its variants. Authorization is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3428 ** performed during statement evaluation in [sqlite3_step()], unless
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3429 ** as stated in the previous paragraph, sqlite3_step() invokes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3430 ** sqlite3_prepare_v2() to reprepare a statement after a schema change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3431 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3432 SQLITE_API int sqlite3_set_authorizer(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3433 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3434 int (xAuth)(void,int,const char,const char,const char,const char),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3435 void *pUserData
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3436 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3437
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3438 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3439 ** CAPI3REF: Authorizer Return Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3440 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3441 ** The [sqlite3_set_authorizer \| authorizer callback function] must
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3442 ** return either [SQLITE_OK] or one of these two constants in order
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3443 ** to signal SQLite whether or not the action is permitted. See the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3444 ** [sqlite3_set_authorizer \| authorizer documentation] for additional
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3445 ** information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3446 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3447 ** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3448 ** returned from the [sqlite3_vtab_on_conflict()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3449 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3450 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3451 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3452
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3453 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3454 ** CAPI3REF: Authorizer Action Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3455 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3456 ** The [sqlite3_set_authorizer()] interface registers a callback function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3457 ** that is invoked to authorize certain SQL statement actions. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3458 ** second parameter to the callback is an integer code that specifies
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3459 ** what action is being authorized. These are the integer action codes that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3460 ** the authorizer callback may be passed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3461 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3462 ** These action code values signify what kind of operation is to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3463 ** authorized. The 3rd and 4th parameters to the authorization
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3464 ** callback function will be parameters or NULL depending on which of these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3465 ** codes is used as the second parameter. ^(The 5th parameter to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3466 ** authorizer callback is the name of the database ("main", "temp",
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3467 ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3468 ** is the name of the inner-most trigger or view that is responsible for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3469 ** the access attempt or NULL if this access attempt is directly from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3470 ** top-level SQL code.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3471 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3472 /***************************************** 3rd ******** 4th *********/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3473 #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3474 #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3475 #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3476 #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3477 #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3478 #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3479 #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3480 #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3481 #define SQLITE_DELETE 9 /* Table Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3482 #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3483 #define SQLITE_DROP_TABLE 11 /* Table Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3484 #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3485 #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3486 #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3487 #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3488 #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3489 #define SQLITE_DROP_VIEW 17 /* View Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3490 #define SQLITE_INSERT 18 /* Table Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3491 #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3492 #define SQLITE_READ 20 /* Table Name Column Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3493 #define SQLITE_SELECT 21 /* NULL NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3494 #define SQLITE_TRANSACTION 22 /* Operation NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3495 #define SQLITE_UPDATE 23 /* Table Name Column Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3496 #define SQLITE_ATTACH 24 /* Filename NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3497 #define SQLITE_DETACH 25 /* Database Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3498 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3499 #define SQLITE_REINDEX 27 /* Index Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3500 #define SQLITE_ANALYZE 28 /* Table Name NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3501 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3502 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3503 #define SQLITE_FUNCTION 31 /* NULL Function Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3504 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3505 #define SQLITE_COPY 0 /* No longer used */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3506 #define SQLITE_RECURSIVE 33 /* NULL NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3507
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3508 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3509 ** CAPI3REF: Deprecated Tracing And Profiling Functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3510 ** DEPRECATED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3511 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3512 ** These routines are deprecated. Use the [sqlite3_trace_v2()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3513 ** instead of the routines described here.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3514 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3515 ** These routines register callback functions that can be used for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3516 ** tracing and profiling the execution of SQL statements.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3517 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3518 ** ^The callback function registered by sqlite3_trace() is invoked at
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3519 ** various times when an SQL statement is being run by [sqlite3_step()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3520 ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3521 ** SQL statement text as the statement first begins executing.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3522 ** ^(Additional sqlite3_trace() callbacks might occur
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3523 ** as each triggered subprogram is entered. The callbacks for triggers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3524 ** contain a UTF-8 SQL comment that identifies the trigger.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3525 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3526 ** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3527 ** the length of [bound parameter] expansion in the output of sqlite3_trace().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3528 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3529 ** ^The callback function registered by sqlite3_profile() is invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3530 ** as each SQL statement finishes. ^The profile callback contains
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3531 ** the original statement text and an estimate of wall-clock time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3532 ** of how long that statement took to run. ^The profile callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3533 ** time is in units of nanoseconds, however the current implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3534 ** is only capable of millisecond resolution so the six least significant
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3535 ** digits in the time are meaningless. Future versions of SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3536 ** might provide greater resolution on the profiler callback. Invoking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3537 ** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3538 ** profile callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3539 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3540 SQLITE_API SQLITE_DEPRECATED void sqlite3_trace(sqlite3,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3541 void(xTrace)(void,const char), void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3542 SQLITE_API SQLITE_DEPRECATED void sqlite3_profile(sqlite3,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3543 void(xProfile)(void,const char,sqlite3_uint64), void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3544
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3545 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3546 ** CAPI3REF: SQL Trace Event Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3547 ** KEYWORDS: SQLITE_TRACE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3548 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3549 ** These constants identify classes of events that can be monitored
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3550 ** using the [sqlite3_trace_v2()] tracing logic. The M argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3551 ** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3552 ** the following constants. ^The first argument to the trace callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3553 ** is one of the following constants.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3554 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3555 ** New tracing constants may be added in future releases.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3556 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3557 ** ^A trace callback has four arguments: xCallback(T,C,P,X).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3558 ** ^The T argument is one of the integer type codes above.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3559 ** ^The C argument is a copy of the context pointer passed in as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3560 ** fourth argument to [sqlite3_trace_v2()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3561 ** The P and X arguments are pointers whose meanings depend on T.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3562 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3563 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3564 ** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3565 ** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3566 ** first begins running and possibly at other times during the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3567 ** execution of the prepared statement, such as at the start of each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3568 ** trigger subprogram. ^The P argument is a pointer to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3569 ** [prepared statement]. ^The X argument is a pointer to a string which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3570 ** is the unexpanded SQL text of the prepared statement or an SQL comment
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3571 ** that indicates the invocation of a trigger. ^The callback can compute
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3572 ** the same text that would have been returned by the legacy [sqlite3_trace()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3573 ** interface by using the X argument when X begins with "--" and invoking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3574 ** [sqlite3_expanded_sql(P)] otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3575 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3576 ** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3577 ** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3578 ** information as is provided by the [sqlite3_profile()] callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3579 ** ^The P argument is a pointer to the [prepared statement] and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3580 ** X argument points to a 64-bit integer which is approximately
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3581 ** the number of nanoseconds that the prepared statement took to run.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3582 ** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3583 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3584 ** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3585 ** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3586 ** statement generates a single row of result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3587 ** ^The P argument is a pointer to the [prepared statement] and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3588 ** X argument is unused.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3589 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3590 ** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3591 ** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3592 ** connection closes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3593 ** ^The P argument is a pointer to the [database connection] object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3594 ** and the X argument is unused.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3595 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3596 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3597 #define SQLITE_TRACE_STMT 0x01
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3598 #define SQLITE_TRACE_PROFILE 0x02
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3599 #define SQLITE_TRACE_ROW 0x04
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3600 #define SQLITE_TRACE_CLOSE 0x08
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3601
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3602 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3603 ** CAPI3REF: SQL Trace Hook
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3604 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3605 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3606 ** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3607 ** function X against [database connection] D, using property mask M
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3608 ** and context pointer P. ^If the X callback is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3609 ** NULL or if the M mask is zero, then tracing is disabled. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3610 ** M argument should be the bitwise OR-ed combination of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3611 ** zero or more [SQLITE_TRACE] constants.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3612 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3613 ** ^Each call to either sqlite3_trace(D,X,P) or sqlite3_trace_v2(D,M,X,P)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3614 ** overrides (cancels) all prior calls to sqlite3_trace(D,X,P) or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3615 ** sqlite3_trace_v2(D,M,X,P) for the [database connection] D. Each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3616 ** database connection may have at most one trace callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3617 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3618 ** ^The X callback is invoked whenever any of the events identified by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3619 ** mask M occur. ^The integer return value from the callback is currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3620 ** ignored, though this may change in future releases. Callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3621 ** implementations should return zero to ensure future compatibility.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3622 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3623 ** ^A trace callback is invoked with four arguments: callback(T,C,P,X).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3624 ** ^The T argument is one of the [SQLITE_TRACE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3625 ** constants to indicate why the callback was invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3626 ** ^The C argument is a copy of the context pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3627 ** The P and X arguments are pointers whose meanings depend on T.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3628 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3629 ** The sqlite3_trace_v2() interface is intended to replace the legacy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3630 ** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3631 ** are deprecated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3632 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3633 SQLITE_API int sqlite3_trace_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3634 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3635 unsigned uMask,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3636 int(xCallback)(unsigned,void,void,void),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3637 void *pCtx
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3638 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3639
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3640 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3641 ** CAPI3REF: Query Progress Callbacks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3642 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3643 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3644 ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3645 ** function X to be invoked periodically during long running calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3646 ** [sqlite3_step()] and [sqlite3_prepare()] and similar for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3647 ** database connection D. An example use for this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3648 ** interface is to keep a GUI updated during a large query.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3649 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3650 ** ^The parameter P is passed through as the only parameter to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3651 ** callback function X. ^The parameter N is the approximate number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3652 ** [virtual machine instructions] that are evaluated between successive
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3653 ** invocations of the callback X. ^If N is less than one then the progress
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3654 ** handler is disabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3655 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3656 ** ^Only a single progress handler may be defined at one time per
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3657 ** [database connection]; setting a new progress handler cancels the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3658 ** old one. ^Setting parameter X to NULL disables the progress handler.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3659 ** ^The progress handler is also disabled by setting N to a value less
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3660 ** than 1.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3661 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3662 ** ^If the progress callback returns non-zero, the operation is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3663 ** interrupted. This feature can be used to implement a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3664 ** "Cancel" button on a GUI progress dialog box.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3665 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3666 ** The progress handler callback must not do anything that will modify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3667 ** the database connection that invoked the progress handler.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3668 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3669 ** database connections for the meaning of "modify" in this paragraph.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3670 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3671 ** The progress handler callback would originally only be invoked from the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3672 ** bytecode engine. It still might be invoked during [sqlite3_prepare()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3673 ** and similar because those routines might force a reparse of the schema
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3674 ** which involves running the bytecode engine. However, beginning with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3675 ** SQLite version 3.41.0, the progress handler callback might also be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3676 ** invoked directly from [sqlite3_prepare()] while analyzing and generating
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3677 ** code for complex queries.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3678 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3679 SQLITE_API void sqlite3_progress_handler(sqlite3, int, int()(void), void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3680
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3681 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3682 ** CAPI3REF: Opening A New Database Connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3683 ** CONSTRUCTOR: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3684 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3685 ** ^These routines open an SQLite database file as specified by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3686 ** filename argument. ^The filename argument is interpreted as UTF-8 for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3687 ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3688 ** order for sqlite3_open16(). ^(A [database connection] handle is usually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3689 ** returned in *ppDb, even if an error occurs. The only exception is that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3690 ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3691 ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3692 ** object.)^ ^(If the database is opened (and/or created) successfully, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3693 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3694 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3695 ** an English language description of the error following a failure of any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3696 ** of the sqlite3_open() routines.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3697 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3698 ** ^The default encoding will be UTF-8 for databases created using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3699 ** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3700 ** created using sqlite3_open16() will be UTF-16 in the native byte order.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3701 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3702 ** Whether or not an error occurs when it is opened, resources
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3703 ** associated with the [database connection] handle should be released by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3704 ** passing it to [sqlite3_close()] when it is no longer required.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3705 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3706 ** The sqlite3_open_v2() interface works like sqlite3_open()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3707 ** except that it accepts two additional parameters for additional control
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3708 ** over the new database connection. ^(The flags parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3709 ** sqlite3_open_v2() must include, at a minimum, one of the following
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3710 ** three flag combinations:)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3711 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3712 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3713 ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3714 ** <dd>The database is opened in read-only mode. If the database does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3715 ** not already exist, an error is returned.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3716 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3717 ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3718 ** <dd>The database is opened for reading and writing if possible, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3719 ** reading only if the file is write protected by the operating
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3720 ** system. In either case the database must already exist, otherwise
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3721 ** an error is returned. For historical reasons, if opening in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3722 ** read-write mode fails due to OS-level permissions, an attempt is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3723 ** made to open it in read-only mode. [sqlite3_db_readonly()] can be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3724 ** used to determine whether the database is actually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3725 ** read-write.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3726 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3727 ** ^(<dt>[SQLITE_OPEN_READWRITE] \| [SQLITE_OPEN_CREATE]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3728 ** <dd>The database is opened for reading and writing, and is created if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3729 ** it does not already exist. This is the behavior that is always used for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3730 ** sqlite3_open() and sqlite3_open16().</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3731 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3732 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3733 ** In addition to the required flags, the following optional flags are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3734 ** also supported:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3735 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3736 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3737 ** ^(<dt>[SQLITE_OPEN_URI]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3738 ** <dd>The filename can be interpreted as a URI if this flag is set.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3739 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3740 ** ^(<dt>[SQLITE_OPEN_MEMORY]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3741 ** <dd>The database will be opened as an in-memory database. The database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3742 ** is named by the "filename" argument for the purposes of cache-sharing,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3743 ** if shared cache mode is enabled, but the "filename" is otherwise ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3744 ** </dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3745 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3746 ** ^(<dt>[SQLITE_OPEN_NOMUTEX]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3747 ** <dd>The new database connection will use the "multi-thread"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3748 ** [threading mode].)^ This means that separate threads are allowed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3749 ** to use SQLite at the same time, as long as each thread is using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3750 ** a different [database connection].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3751 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3752 ** ^(<dt>[SQLITE_OPEN_FULLMUTEX]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3753 ** <dd>The new database connection will use the "serialized"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3754 ** [threading mode].)^ This means the multiple threads can safely
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3755 ** attempt to use the same database connection at the same time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3756 ** (Mutexes will block any actual concurrency, but in this mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3757 ** there is no harm in trying.)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3758 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3759 ** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3760 ** <dd>The database is opened with [shared cache] enabled, overriding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3761 ** the default shared cache setting provided by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3762 ** [sqlite3_enable_shared_cache()].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3763 ** The [use of shared cache mode is discouraged] and hence shared cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3764 ** capabilities may be omitted from many builds of SQLite. In such cases,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3765 ** this option is a no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3766 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3767 ** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3768 ** <dd>The database is opened with [shared cache] disabled, overriding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3769 ** the default shared cache setting provided by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3770 ** [sqlite3_enable_shared_cache()].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3771 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3772 ** [[OPEN_EXRESCODE]] ^(<dt>[SQLITE_OPEN_EXRESCODE]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3773 ** <dd>The database connection comes up in "extended result code mode".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3774 ** In other words, the database behaves as if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3775 ** [sqlite3_extended_result_codes(db,1)] were called on the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3776 ** connection as soon as the connection is created. In addition to setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3777 ** the extended result code mode, this flag also causes [sqlite3_open_v2()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3778 ** to return an extended result code.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3779 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3780 ** [[OPEN_NOFOLLOW]] ^(<dt>[SQLITE_OPEN_NOFOLLOW]</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3781 ** <dd>The database filename is not allowed to contain a symbolic link</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3782 ** </dl>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3783 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3784 ** If the 3rd parameter to sqlite3_open_v2() is not one of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3785 ** required combinations shown above optionally combined with other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3786 ** [SQLITE_OPEN_READONLY \| SQLITE_OPEN_* bits]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3787 ** then the behavior is undefined. Historic versions of SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3788 ** have silently ignored surplus bits in the flags parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3789 ** sqlite3_open_v2(), however that behavior might not be carried through
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3790 ** into future versions of SQLite and so applications should not rely
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3791 ** upon it. Note in particular that the SQLITE_OPEN_EXCLUSIVE flag is a no-op
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3792 ** for sqlite3_open_v2(). The SQLITE_OPEN_EXCLUSIVE does not cause
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3793 ** the open to fail if the database already exists. The SQLITE_OPEN_EXCLUSIVE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3794 ** flag is intended for use by the [sqlite3_vfs\|VFS interface] only, and not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3795 ** by sqlite3_open_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3796 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3797 ** ^The fourth parameter to sqlite3_open_v2() is the name of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3798 ** [sqlite3_vfs] object that defines the operating system interface that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3799 ** the new database connection should use. ^If the fourth parameter is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3800 ** a NULL pointer then the default [sqlite3_vfs] object is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3801 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3802 ** ^If the filename is ":memory:", then a private, temporary in-memory database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3803 ** is created for the connection. ^This in-memory database will vanish when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3804 ** the database connection is closed. Future versions of SQLite might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3805 ** make use of additional special filenames that begin with the ":" character.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3806 ** It is recommended that when a database filename actually does begin with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3807 ** a ":" character you should prefix the filename with a pathname such as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3808 ** "./" to avoid ambiguity.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3809 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3810 ** ^If the filename is an empty string, then a private, temporary
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3811 ** on-disk database will be created. ^This private database will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3812 ** automatically deleted as soon as the database connection is closed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3813 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3814 ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3815 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3816 ** ^If [URI filename] interpretation is enabled, and the filename argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3817 ** begins with "file:", then the filename is interpreted as a URI. ^URI
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3818 ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3819 ** set in the third argument to sqlite3_open_v2(), or if it has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3820 ** been enabled globally using the [SQLITE_CONFIG_URI] option with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3821 ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3822 ** URI filename interpretation is turned off
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3823 ** by default, but future releases of SQLite might enable URI filename
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3824 ** interpretation by default. See "[URI filenames]" for additional
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3825 ** information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3826 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3827 ** URI filenames are parsed according to RFC 3986. ^If the URI contains an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3828 ** authority, then it must be either an empty string or the string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3829 ** "localhost". ^If the authority is not an empty string or "localhost", an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3830 ** error is returned to the caller. ^The fragment component of a URI, if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3831 ** present, is ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3832 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3833 ** ^SQLite uses the path component of the URI as the name of the disk file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3834 ** which contains the database. ^If the path begins with a '/' character,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3835 ** then it is interpreted as an absolute path. ^If the path does not begin
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3836 ** with a '/' (meaning that the authority section is omitted from the URI)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3837 ** then the path is interpreted as a relative path.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3838 ** ^(On windows, the first component of an absolute path
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3839 ** is a drive specification (e.g. "C:").)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3840 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3841 ** [[core URI query parameters]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3842 ** The query component of a URI may contain parameters that are interpreted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3843 ** either by SQLite itself, or by a [VFS \| custom VFS implementation].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3844 ** SQLite and its built-in [VFSes] interpret the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3845 ** following query parameters:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3846 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3847 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3848 ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3849 ** a VFS object that provides the operating system interface that should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3850 ** be used to access the database file on disk. ^If this option is set to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3851 ** an empty string the default VFS object is used. ^Specifying an unknown
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3852 ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3853 ** present, then the VFS specified by the option takes precedence over
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3854 ** the value passed as the fourth parameter to sqlite3_open_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3855 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3856 ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3857 ** "rwc", or "memory". Attempting to set it to any other value is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3858 ** an error)^.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3859 ** ^If "ro" is specified, then the database is opened for read-only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3860 ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3861 ** third argument to sqlite3_open_v2(). ^If the mode option is set to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3862 ** "rw", then the database is opened for read-write (but not create)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3863 ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3864 ** been set. ^Value "rwc" is equivalent to setting both
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3865 ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3866 ** set to "memory" then a pure [in-memory database] that never reads
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3867 ** or writes from disk is used. ^It is an error to specify a value for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3868 ** the mode parameter that is less restrictive than that specified by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3869 ** the flags passed in the third parameter to sqlite3_open_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3870 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3871 ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3872 ** "private". ^Setting it to "shared" is equivalent to setting the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3873 ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3874 ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3875 ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3876 ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3877 ** a URI filename, its value overrides any behavior requested by setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3878 ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3879 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3880 ** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3881 ** [powersafe overwrite] property does or does not apply to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3882 ** storage media on which the database file resides.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3883 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3884 ** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3885 ** which if set disables file locking in rollback journal modes. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3886 ** is useful for accessing a database on a filesystem that does not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3887 ** support locking. Caution: Database corruption might result if two
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3888 ** or more processes write to the same database and any one of those
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3889 ** processes uses nolock=1.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3890 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3891 ** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3892 ** parameter that indicates that the database file is stored on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3893 ** read-only media. ^When immutable is set, SQLite assumes that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3894 ** database file cannot be changed, even by a process with higher
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3895 ** privilege, and so the database is opened read-only and all locking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3896 ** and change detection is disabled. Caution: Setting the immutable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3897 ** property on a database file that does in fact change can result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3898 ** in incorrect query results and/or [SQLITE_CORRUPT] errors.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3899 ** See also: [SQLITE_IOCAP_IMMUTABLE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3900 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3901 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3902 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3903 ** ^Specifying an unknown parameter in the query component of a URI is not an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3904 ** error. Future versions of SQLite might understand additional query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3905 ** parameters. See "[query parameters with special meaning to SQLite]" for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3906 ** additional information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3907 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3908 ** [[URI filename examples]] <h3>URI filename examples</h3>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3909 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3910 ** <table border="1" align=center cellpadding=5>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3911 ** <tr><th> URI filenames <th> Results
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3912 ** <tr><td> file:data.db <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3913 ** Open the file "data.db" in the current directory.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3914 ** <tr><td> file:/home/fred/data.db<br>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3915 ** file:///home/fred/data.db <br>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3916 ** file://localhost/home/fred/data.db <br> <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3917 ** Open the database file "/home/fred/data.db".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3918 ** <tr><td> file://darkstar/home/fred/data.db <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3919 ** An error. "darkstar" is not a recognized authority.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3920 ** <tr><td style="white-space:nowrap">
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3921 ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3922 ** <td> Windows only: Open the file "data.db" on fred's desktop on drive
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3923 ** C:. Note that the %20 escaping in this example is not strictly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3924 ** necessary - space characters can be used literally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3925 ** in URI filenames.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3926 ** <tr><td> file:data.db?mode=ro&cache=private <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3927 ** Open file "data.db" in the current directory for read-only access.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3928 ** Regardless of whether or not shared-cache mode is enabled by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3929 ** default, use a private cache.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3930 ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3931 ** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3932 ** that uses dot-files in place of posix advisory locking.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3933 ** <tr><td> file:data.db?mode=readonly <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3934 ** An error. "readonly" is not a valid option for the "mode" parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3935 ** Use "ro" instead: "file:data.db?mode=ro".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3936 ** </table>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3937 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3938 ** ^URI hexadecimal escape sequences (%HH) are supported within the path and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3939 ** query components of a URI. A hexadecimal escape sequence consists of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3940 ** percent sign - "%" - followed by exactly two hexadecimal digits
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3941 ** specifying an octet value. ^Before the path or query components of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3942 ** URI filename are interpreted, they are encoded using UTF-8 and all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3943 ** hexadecimal escape sequences replaced by a single byte containing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3944 ** corresponding octet. If this process generates an invalid UTF-8 encoding,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3945 ** the results are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3946 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3947 ** <b>Note to Windows users:</b> The encoding used for the filename argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3948 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3949 ** codepage is currently defined. Filenames containing international
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3950 ** characters must be converted to UTF-8 prior to passing them into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3951 ** sqlite3_open() or sqlite3_open_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3952 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3953 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3954 ** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3955 ** features that require the use of temporary files may fail.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3956 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3957 ** See also: [sqlite3_temp_directory]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3958 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3959 SQLITE_API int sqlite3_open(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3960 const char filename, / Database filename (UTF-8) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3961 sqlite3 *ppDb / OUT: SQLite db handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3962 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3963 SQLITE_API int sqlite3_open16(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3964 const void filename, / Database filename (UTF-16) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3965 sqlite3 *ppDb / OUT: SQLite db handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3966 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3967 SQLITE_API int sqlite3_open_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3968 const char filename, / Database filename (UTF-8) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3969 sqlite3 *ppDb, / OUT: SQLite db handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3970 int flags, /* Flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3971 const char zVfs / Name of VFS module to use */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3972 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3973
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3974 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3975 ** CAPI3REF: Obtain Values For URI Parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3976 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3977 ** These are utility routines, useful to [VFS\|custom VFS implementations],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3978 ** that check if a database file was a URI that contained a specific query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3979 ** parameter, and if so obtains the value of that query parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3980 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3981 ** The first parameter to these interfaces (hereafter referred to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3982 ** as F) must be one of:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3983 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3984 ** <li> A database filename pointer created by the SQLite core and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3985 ** passed into the xOpen() method of a VFS implementation, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3986 ** <li> A filename obtained from [sqlite3_db_filename()], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3987 ** <li> A new filename constructed using [sqlite3_create_filename()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3988 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3989 ** If the F parameter is not one of the above, then the behavior is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3990 ** undefined and probably undesirable. Older versions of SQLite were
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3991 ** more tolerant of invalid F parameters than newer versions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3992 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3993 ** If F is a suitable filename (as described in the previous paragraph)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3994 ** and if P is the name of the query parameter, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3995 ** sqlite3_uri_parameter(F,P) returns the value of the P
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3996 ** parameter if it exists or a NULL pointer if P does not appear as a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3997 ** query parameter on F. If P is a query parameter of F and it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3998 ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	3999 ** a pointer to an empty string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4000 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4001 ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4002 ** parameter and returns true (1) or false (0) according to the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4003 ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4004 ** value of query parameter P is one of "yes", "true", or "on" in any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4005 ** case or if the value begins with a non-zero number. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4006 ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4007 ** query parameter P is one of "no", "false", or "off" in any case or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4008 ** if the value begins with a numeric zero. If P is not a query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4009 ** parameter on F or if the value of P does not match any of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4010 ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4011 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4012 ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4013 ** 64-bit signed integer and returns that integer, or D if P does not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4014 ** exist. If the value of P is something other than an integer, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4015 ** zero is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4016 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4017 ** The sqlite3_uri_key(F,N) returns a pointer to the name (not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4018 ** the value) of the N-th query parameter for filename F, or a NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4019 ** pointer if N is less than zero or greater than the number of query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4020 ** parameters minus 1. The N value is zero-based so N should be 0 to obtain
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4021 ** the name of the first query parameter, 1 for the second parameter, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4022 ** so forth.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4023 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4024 ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4025 ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4026 ** is not a database file pathname pointer that the SQLite core passed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4027 ** into the xOpen VFS method, then the behavior of this routine is undefined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4028 ** and probably undesirable.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4029 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4030 ** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4031 ** parameter can also be the name of a rollback journal file or WAL file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4032 ** in addition to the main database file. Prior to version 3.31.0, these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4033 ** routines would only work if F was the name of the main database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4034 ** When the F parameter is the name of the rollback journal or WAL file,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4035 ** it has access to all the same query parameters as were found on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4036 ** main database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4037 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4038 ** See the [URI filename] documentation for additional information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4039 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4040 SQLITE_API const char sqlite3_uri_parameter(sqlite3_filename z, const char zParam);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4041 SQLITE_API int sqlite3_uri_boolean(sqlite3_filename z, const char *zParam, int bDefault);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4042 SQLITE_API sqlite3_int64 sqlite3_uri_int64(sqlite3_filename, const char*, sqlite3_int64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4043 SQLITE_API const char *sqlite3_uri_key(sqlite3_filename z, int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4044
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4045 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4046 ** CAPI3REF: Translate filenames
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4047 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4048 ** These routines are available to [VFS\|custom VFS implementations] for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4049 ** translating filenames between the main database file, the journal file,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4050 ** and the WAL file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4051 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4052 ** If F is the name of an sqlite database file, journal file, or WAL file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4053 ** passed by the SQLite core into the VFS, then sqlite3_filename_database(F)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4054 ** returns the name of the corresponding database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4055 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4056 ** If F is the name of an sqlite database file, journal file, or WAL file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4057 ** passed by the SQLite core into the VFS, or if F is a database filename
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4058 ** obtained from [sqlite3_db_filename()], then sqlite3_filename_journal(F)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4059 ** returns the name of the corresponding rollback journal file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4060 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4061 ** If F is the name of an sqlite database file, journal file, or WAL file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4062 ** that was passed by the SQLite core into the VFS, or if F is a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4063 ** filename obtained from [sqlite3_db_filename()], then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4064 ** sqlite3_filename_wal(F) returns the name of the corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4065 ** WAL file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4066 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4067 ** In all of the above, if F is not the name of a database, journal or WAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4068 ** filename passed into the VFS from the SQLite core and F is not the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4069 ** return value from [sqlite3_db_filename()], then the result is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4070 ** undefined and is likely a memory access violation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4071 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4072 SQLITE_API const char *sqlite3_filename_database(sqlite3_filename);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4073 SQLITE_API const char *sqlite3_filename_journal(sqlite3_filename);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4074 SQLITE_API const char *sqlite3_filename_wal(sqlite3_filename);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4075
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4076 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4077 ** CAPI3REF: Database File Corresponding To A Journal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4078 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4079 ** ^If X is the name of a rollback or WAL-mode journal file that is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4080 ** passed into the xOpen method of [sqlite3_vfs], then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4081 ** sqlite3_database_file_object(X) returns a pointer to the [sqlite3_file]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4082 ** object that represents the main database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4083 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4084 ** This routine is intended for use in custom [VFS] implementations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4085 ** only. It is not a general-purpose interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4086 ** The argument sqlite3_file_object(X) must be a filename pointer that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4087 ** has been passed into [sqlite3_vfs].xOpen method where the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4088 ** flags parameter to xOpen contains one of the bits
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4089 ** [SQLITE_OPEN_MAIN_JOURNAL] or [SQLITE_OPEN_WAL]. Any other use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4090 ** of this routine results in undefined and probably undesirable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4091 ** behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4092 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4093 SQLITE_API sqlite3_file sqlite3_database_file_object(const char);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4094
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4095 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4096 ** CAPI3REF: Create and Destroy VFS Filenames
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4097 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4098 ** These interfaces are provided for use by [VFS shim] implementations and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4099 ** are not useful outside of that context.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4100 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4101 ** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4102 ** database filename D with corresponding journal file J and WAL file W and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4103 ** an array P of N URI Key/Value pairs. The result from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4104 ** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4105 ** is safe to pass to routines like:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4106 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4107 ** <li> [sqlite3_uri_parameter()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4108 ** <li> [sqlite3_uri_boolean()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4109 ** <li> [sqlite3_uri_int64()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4110 ** <li> [sqlite3_uri_key()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4111 ** <li> [sqlite3_filename_database()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4112 ** <li> [sqlite3_filename_journal()], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4113 ** <li> [sqlite3_filename_wal()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4114 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4115 ** If a memory allocation error occurs, sqlite3_create_filename() might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4116 ** return a NULL pointer. The memory obtained from sqlite3_create_filename(X)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4117 ** must be released by a corresponding call to sqlite3_free_filename(Y).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4118 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4119 ** The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4120 ** of 2*N pointers to strings. Each pair of pointers in this array corresponds
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4121 ** to a key and value for a query parameter. The P parameter may be a NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4122 ** pointer if N is zero. None of the 2*N pointers in the P array may be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4123 ** NULL pointers and key pointers should not be empty strings.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4124 ** None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4125 ** be NULL pointers, though they can be empty strings.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4126 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4127 ** The sqlite3_free_filename(Y) routine releases a memory allocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4128 ** previously obtained from sqlite3_create_filename(). Invoking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4129 ** sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4130 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4131 ** If the Y parameter to sqlite3_free_filename(Y) is anything other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4132 ** than a NULL pointer or a pointer previously acquired from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4133 ** sqlite3_create_filename(), then bad things such as heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4134 ** corruption or segfaults may occur. The value Y should not be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4135 ** used again after sqlite3_free_filename(Y) has been called. This means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4136 ** that if the [sqlite3_vfs.xOpen()] method of a VFS has been called using Y,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4137 ** then the corresponding [sqlite3_module.xClose() method should also be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4138 ** invoked prior to calling sqlite3_free_filename(Y).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4139 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4140 SQLITE_API sqlite3_filename sqlite3_create_filename(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4141 const char *zDatabase,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4142 const char *zJournal,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4143 const char *zWal,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4144 int nParam,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4145 const char **azParam
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4146 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4147 SQLITE_API void sqlite3_free_filename(sqlite3_filename);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4148
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4149 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4150 ** CAPI3REF: Error Codes And Messages
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4151 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4152 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4153 ** ^If the most recent sqlite3_* API call associated with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4154 ** [database connection] D failed, then the sqlite3_errcode(D) interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4155 ** returns the numeric [result code] or [extended result code] for that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4156 ** API call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4157 ** ^The sqlite3_extended_errcode()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4158 ** interface is the same except that it always returns the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4159 ** [extended result code] even when extended result codes are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4160 ** disabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4161 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4162 ** The values returned by sqlite3_errcode() and/or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4163 ** sqlite3_extended_errcode() might change with each API call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4164 ** Except, there are some interfaces that are guaranteed to never
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4165 ** change the value of the error code. The error-code preserving
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4166 ** interfaces include the following:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4167 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4168 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4169 ** <li> sqlite3_errcode()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4170 ** <li> sqlite3_extended_errcode()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4171 ** <li> sqlite3_errmsg()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4172 ** <li> sqlite3_errmsg16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4173 ** <li> sqlite3_error_offset()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4174 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4175 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4176 ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4177 ** text that describes the error, as either UTF-8 or UTF-16 respectively,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4178 ** or NULL if no error message is available.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4179 ** (See how SQLite handles [invalid UTF] for exceptions to this rule.)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4180 ** ^(Memory to hold the error message string is managed internally.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4181 ** The application does not need to worry about freeing the result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4182 ** However, the error string might be overwritten or deallocated by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4183 ** subsequent calls to other SQLite interface functions.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4184 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4185 ** ^The sqlite3_errstr(E) interface returns the English-language text
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4186 ** that describes the [result code] E, as UTF-8, or NULL if E is not a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4187 ** result code for which a text error message is available.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4188 ** ^(Memory to hold the error message string is managed internally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4189 ** and must not be freed by the application)^.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4190 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4191 ** ^If the most recent error references a specific token in the input
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4192 ** SQL, the sqlite3_error_offset() interface returns the byte offset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4193 ** of the start of that token. ^The byte offset returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4194 ** sqlite3_error_offset() assumes that the input SQL is UTF-8.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4195 ** ^If the most recent error does not reference a specific token in the input
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4196 ** SQL, then the sqlite3_error_offset() function returns -1.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4197 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4198 ** When the serialized [threading mode] is in use, it might be the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4199 ** case that a second error occurs on a separate thread in between
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4200 ** the time of the first error and the call to these interfaces.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4201 ** When that happens, the second error will be reported since these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4202 ** interfaces always report the most recent result. To avoid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4203 ** this, each thread can obtain exclusive use of the [database connection] D
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4204 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4205 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4206 ** all calls to the interfaces listed here are completed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4207 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4208 ** If an interface fails with SQLITE_MISUSE, that means the interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4209 ** was invoked incorrectly by the application. In that case, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4210 ** error code and message may or may not be set.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4211 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4212 SQLITE_API int sqlite3_errcode(sqlite3 *db);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4213 SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4214 SQLITE_API const char sqlite3_errmsg(sqlite3);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4215 SQLITE_API const void sqlite3_errmsg16(sqlite3);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4216 SQLITE_API const char *sqlite3_errstr(int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4217 SQLITE_API int sqlite3_error_offset(sqlite3 *db);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4218
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4219 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4220 ** CAPI3REF: Set Error Codes And Message
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4221 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4222 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4223 ** Set the error code of the database handle passed as the first argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4224 ** to errcode, and the error message to a copy of nul-terminated string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4225 ** zErrMsg. If zErrMsg is passed NULL, then the error message is set to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4226 ** the default message associated with the supplied error code. Subsequent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4227 ** calls to [sqlite3_errcode()] and [sqlite3_errmsg()] and similar will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4228 ** return the values set by this routine in place of what was previously
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4229 ** set by SQLite itself.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4230 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4231 ** This function returns SQLITE_OK if the error code and error message are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4232 ** successfully set, SQLITE_NOMEM if an OOM occurs, and SQLITE_MISUSE if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4233 ** the database handle is NULL or invalid.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4234 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4235 ** The error code and message set by this routine remains in effect until
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4236 ** they are changed, either by another call to this routine or until they are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4237 ** changed to by SQLite itself to reflect the result of some subsquent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4238 ** API call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4239 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4240 ** This function is intended for use by SQLite extensions or wrappers. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4241 ** idea is that an extension or wrapper can use this routine to set error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4242 ** messages and error codes and thus behave more like a core SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4243 ** feature from the point of view of an application.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4244 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4245 SQLITE_API int sqlite3_set_errmsg(sqlite3 db, int errcode, const char zErrMsg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4246
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4247 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4248 ** CAPI3REF: Prepared Statement Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4249 ** KEYWORDS: {prepared statement} {prepared statements}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4250 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4251 ** An instance of this object represents a single SQL statement that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4252 ** has been compiled into binary form and is ready to be evaluated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4253 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4254 ** Think of each SQL statement as a separate computer program. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4255 ** original SQL text is source code. A prepared statement object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4256 ** is the compiled object code. All SQL must be converted into a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4257 ** prepared statement before it can be run.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4258 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4259 ** The life-cycle of a prepared statement object usually goes like this:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4260 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4261 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4262 ** <li> Create the prepared statement object using [sqlite3_prepare_v2()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4263 ** <li> Bind values to [parameters] using the sqlite3_bind_*()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4264 ** interfaces.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4265 ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4266 ** <li> Reset the prepared statement using [sqlite3_reset()] then go back
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4267 ** to step 2. Do this zero or more times.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4268 ** <li> Destroy the object using [sqlite3_finalize()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4269 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4270 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4271 typedef struct sqlite3_stmt sqlite3_stmt;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4272
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4273 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4274 ** CAPI3REF: Run-time Limits
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4275 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4276 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4277 ** ^(This interface allows the size of various constructs to be limited
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4278 ** on a connection by connection basis. The first parameter is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4279 ** [database connection] whose limit is to be set or queried. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4280 ** second parameter is one of the [limit categories] that define a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4281 ** class of constructs to be size limited. The third parameter is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4282 ** new limit for that construct.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4283 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4284 ** ^If the new limit is a negative number, the limit is unchanged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4285 ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4286 ** [limits \| hard upper bound]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4287 ** set at compile-time by a C preprocessor macro called
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4288 ** [limits \| SQLITE_MAX_<i>NAME</i>].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4289 ** (The "_LIMIT_" in the name is changed to "_MAX_".))^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4290 ** ^Attempts to increase a limit above its hard upper bound are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4291 ** silently truncated to the hard upper bound.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4292 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4293 ** ^Regardless of whether or not the limit was changed, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4294 ** [sqlite3_limit()] interface returns the prior value of the limit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4295 ** ^Hence, to find the current value of a limit without changing it,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4296 ** simply invoke this interface with the third parameter set to -1.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4297 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4298 ** Run-time limits are intended for use in applications that manage
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4299 ** both their own internal database and also databases that are controlled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4300 ** by untrusted external sources. An example application might be a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4301 ** web browser that has its own databases for storing history and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4302 ** separate databases controlled by JavaScript applications downloaded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4303 ** off the Internet. The internal databases can be given the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4304 ** large, default limits. Databases managed by external sources can
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4305 ** be given much smaller limits designed to prevent a denial of service
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4306 ** attack. Developers might also want to use the [sqlite3_set_authorizer()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4307 ** interface to further control untrusted SQL. The size of the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4308 ** created by an untrusted script can be contained using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4309 ** [max_page_count] [PRAGMA].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4310 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4311 ** New run-time limit categories may be added in future releases.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4312 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4313 SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4314
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4315 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4316 ** CAPI3REF: Run-Time Limit Categories
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4317 ** KEYWORDS: {limit category} {*limit categories}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4318 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4319 ** These constants define various performance limits
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4320 ** that can be lowered at run-time using [sqlite3_limit()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4321 ** A concise description of these limits follows, and additional information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4322 ** is available at [limits \| Limits in SQLite].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4323 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4324 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4325 ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4326 ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4327 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4328 ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4329 ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4330 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4331 ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4332 ** <dd>The maximum number of columns in a table definition or in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4333 ** result set of a [SELECT] or the maximum number of columns in an index
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4334 ** or in an ORDER BY or GROUP BY clause.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4335 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4336 ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4337 ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4338 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4339 ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4340 ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4341 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4342 ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4343 ** <dd>The maximum number of instructions in a virtual machine program
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4344 ** used to implement an SQL statement. If [sqlite3_prepare_v2()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4345 ** the equivalent tries to allocate space for more than this many opcodes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4346 ** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4347 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4348 ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4349 ** <dd>The maximum number of arguments on a function.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4350 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4351 ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4352 ** <dd>The maximum number of [ATTACH \| attached databases].)^</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4353 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4354 ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4355 ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4356 ** <dd>The maximum length of the pattern argument to the [LIKE] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4357 ** [GLOB] operators.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4358 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4359 ** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4360 ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4361 ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4362 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4363 ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4364 ** <dd>The maximum depth of recursion for triggers.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4365 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4366 ** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4367 ** <dd>The maximum number of auxiliary worker threads that a single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4368 ** [prepared statement] may start.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4369 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4370 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4371 #define SQLITE_LIMIT_LENGTH 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4372 #define SQLITE_LIMIT_SQL_LENGTH 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4373 #define SQLITE_LIMIT_COLUMN 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4374 #define SQLITE_LIMIT_EXPR_DEPTH 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4375 #define SQLITE_LIMIT_COMPOUND_SELECT 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4376 #define SQLITE_LIMIT_VDBE_OP 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4377 #define SQLITE_LIMIT_FUNCTION_ARG 6
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4378 #define SQLITE_LIMIT_ATTACHED 7
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4379 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4380 #define SQLITE_LIMIT_VARIABLE_NUMBER 9
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4381 #define SQLITE_LIMIT_TRIGGER_DEPTH 10
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4382 #define SQLITE_LIMIT_WORKER_THREADS 11
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4383
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4384 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4385 ** CAPI3REF: Prepare Flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4386 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4387 ** These constants define various flags that can be passed into the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4388 ** "prepFlags" parameter of the [sqlite3_prepare_v3()] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4389 ** [sqlite3_prepare16_v3()] interfaces.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4390 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4391 ** New flags may be added in future releases of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4392 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4393 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4394 ** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4395 ** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4396 ** that the prepared statement will be retained for a long time and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4397 ** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4398 ** and [sqlite3_prepare16_v3()] assume that the prepared statement will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4399 ** be used just once or at most a few times and then destroyed using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4400 ** [sqlite3_finalize()] relatively soon. The current implementation acts
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4401 ** on this hint by avoiding the use of [lookaside memory] so as not to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4402 ** deplete the limited store of lookaside memory. Future versions of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4403 ** SQLite may act on this hint differently.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4404 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4405 ** [[SQLITE_PREPARE_NORMALIZE]] <dt>SQLITE_PREPARE_NORMALIZE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4406 ** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4407 ** to be required for any prepared statement that wanted to use the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4408 ** [sqlite3_normalized_sql()] interface. However, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4409 ** [sqlite3_normalized_sql()] interface is now available to all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4410 ** prepared statements, regardless of whether or not they use this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4411 ** flag.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4412 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4413 ** [[SQLITE_PREPARE_NO_VTAB]] <dt>SQLITE_PREPARE_NO_VTAB</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4414 ** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4415 ** to return an error (error code SQLITE_ERROR) if the statement uses
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4416 ** any virtual tables.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4417 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4418 ** [[SQLITE_PREPARE_DONT_LOG]] <dt>SQLITE_PREPARE_DONT_LOG</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4419 ** <dd>The SQLITE_PREPARE_DONT_LOG flag prevents SQL compiler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4420 ** errors from being sent to the error log defined by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4421 ** [SQLITE_CONFIG_LOG]. This can be used, for example, to do test
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4422 ** compiles to see if some SQL syntax is well-formed, without generating
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4423 ** messages on the global error log when it is not. If the test compile
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4424 ** fails, the sqlite3_prepare_v3() call returns the same error indications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4425 ** with or without this flag; it just omits the call to [sqlite3_log()] that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4426 ** logs the error.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4427 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4428 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4429 #define SQLITE_PREPARE_PERSISTENT 0x01
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4430 #define SQLITE_PREPARE_NORMALIZE 0x02
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4431 #define SQLITE_PREPARE_NO_VTAB 0x04
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4432 #define SQLITE_PREPARE_DONT_LOG 0x10
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4433
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4434 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4435 ** CAPI3REF: Compiling An SQL Statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4436 ** KEYWORDS: {SQL statement compiler}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4437 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4438 ** CONSTRUCTOR: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4439 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4440 ** To execute an SQL statement, it must first be compiled into a byte-code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4441 ** program using one of these routines. Or, in other words, these routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4442 ** are constructors for the [prepared statement] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4443 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4444 ** The preferred routine to use is [sqlite3_prepare_v2()]. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4445 ** [sqlite3_prepare()] interface is legacy and should be avoided.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4446 ** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4447 ** for special purposes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4448 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4449 ** The use of the UTF-8 interfaces is preferred, as SQLite currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4450 ** does all parsing using UTF-8. The UTF-16 interfaces are provided
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4451 ** as a convenience. The UTF-16 interfaces work by converting the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4452 ** input text into UTF-8, then invoking the corresponding UTF-8 interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4453 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4454 ** The first argument, "db", is a [database connection] obtained from a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4455 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4456 ** [sqlite3_open16()]. The database connection must not have been closed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4457 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4458 ** The second argument, "zSql", is the statement to be compiled, encoded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4459 ** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4460 ** and sqlite3_prepare_v3()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4461 ** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4462 ** and sqlite3_prepare16_v3() use UTF-16.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4463 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4464 ** ^If the nByte argument is negative, then zSql is read up to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4465 ** first zero terminator. ^If nByte is positive, then it is the maximum
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4466 ** number of bytes read from zSql. When nByte is positive, zSql is read
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4467 ** up to the first zero terminator or until the nByte bytes have been read,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4468 ** whichever comes first. ^If nByte is zero, then no prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4469 ** statement is generated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4470 ** If the caller knows that the supplied string is nul-terminated, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4471 ** there is a small performance advantage to passing an nByte parameter that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4472 ** is the number of bytes in the input string <i>including</i>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4473 ** the nul-terminator.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4474 ** Note that nByte measures the length of the input in bytes, not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4475 ** characters, even for the UTF-16 interfaces.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4476 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4477 ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4478 ** past the end of the first SQL statement in zSql. These routines only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4479 ** compile the first statement in zSql, so *pzTail is left pointing to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4480 ** what remains uncompiled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4481 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4482 ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4483 ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4484 ** to NULL. ^If the input text contains no SQL (if the input is an empty
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4485 ** string or a comment) then *ppStmt is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4486 ** The calling procedure is responsible for deleting the compiled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4487 ** SQL statement using [sqlite3_finalize()] after it has finished with it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4488 ** ppStmt may not be NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4489 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4490 ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4491 ** otherwise an [error code] is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4492 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4493 ** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4494 ** and sqlite3_prepare16_v3() interfaces are recommended for all new programs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4495 ** The older interfaces (sqlite3_prepare() and sqlite3_prepare16())
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4496 ** are retained for backwards compatibility, but their use is discouraged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4497 ** ^In the "vX" interfaces, the prepared statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4498 ** that is returned (the [sqlite3_stmt] object) contains a copy of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4499 ** original SQL text. This causes the [sqlite3_step()] interface to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4500 ** behave differently in three ways:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4501 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4502 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4503 ** <li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4504 ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4505 ** always used to do, [sqlite3_step()] will automatically recompile the SQL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4506 ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4507 ** retries will occur before sqlite3_step() gives up and returns an error.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4508 ** </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4509 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4510 ** <li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4511 ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4512 ** [error codes] or [extended error codes]. ^The legacy behavior was that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4513 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4514 ** and the application would have to make a second call to [sqlite3_reset()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4515 ** in order to find the underlying cause of the problem. With the "v2" prepare
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4516 ** interfaces, the underlying reason for the error is returned immediately.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4517 ** </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4518 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4519 ** <li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4520 ** ^If the specific value bound to a [parameter \| host parameter] in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4521 ** WHERE clause might influence the choice of query plan for a statement,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4522 ** then the statement will be automatically recompiled, as if there had been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4523 ** a schema change, on the first [sqlite3_step()] call following any change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4524 ** to the [sqlite3_bind_text \| bindings] of that [parameter].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4525 ** ^The specific value of a WHERE-clause [parameter] might influence the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4526 ** choice of query plan if the parameter is the left-hand side of a [LIKE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4527 ** or [GLOB] operator or if the parameter is compared to an indexed column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4528 ** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4529 ** </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4530 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4531 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4532 ** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4533 ** the extra prepFlags parameter, which is a bit array consisting of zero or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4534 ** more of the [SQLITE_PREPARE_PERSISTENT\|SQLITE_PREPARE_*] flags. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4535 ** sqlite3_prepare_v2() interface works exactly the same as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4536 ** sqlite3_prepare_v3() with a zero prepFlags parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4537 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4538 SQLITE_API int sqlite3_prepare(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4539 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4540 const char zSql, / SQL statement, UTF-8 encoded */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4541 int nByte, /* Maximum length of zSql in bytes. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4542 sqlite3_stmt *ppStmt, / OUT: Statement handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4543 const char *pzTail / OUT: Pointer to unused portion of zSql */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4544 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4545 SQLITE_API int sqlite3_prepare_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4546 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4547 const char zSql, / SQL statement, UTF-8 encoded */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4548 int nByte, /* Maximum length of zSql in bytes. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4549 sqlite3_stmt *ppStmt, / OUT: Statement handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4550 const char *pzTail / OUT: Pointer to unused portion of zSql */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4551 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4552 SQLITE_API int sqlite3_prepare_v3(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4553 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4554 const char zSql, / SQL statement, UTF-8 encoded */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4555 int nByte, /* Maximum length of zSql in bytes. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4556 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4557 sqlite3_stmt *ppStmt, / OUT: Statement handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4558 const char *pzTail / OUT: Pointer to unused portion of zSql */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4559 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4560 SQLITE_API int sqlite3_prepare16(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4561 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4562 const void zSql, / SQL statement, UTF-16 encoded */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4563 int nByte, /* Maximum length of zSql in bytes. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4564 sqlite3_stmt *ppStmt, / OUT: Statement handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4565 const void *pzTail / OUT: Pointer to unused portion of zSql */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4566 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4567 SQLITE_API int sqlite3_prepare16_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4568 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4569 const void zSql, / SQL statement, UTF-16 encoded */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4570 int nByte, /* Maximum length of zSql in bytes. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4571 sqlite3_stmt *ppStmt, / OUT: Statement handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4572 const void *pzTail / OUT: Pointer to unused portion of zSql */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4573 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4574 SQLITE_API int sqlite3_prepare16_v3(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4575 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4576 const void zSql, / SQL statement, UTF-16 encoded */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4577 int nByte, /* Maximum length of zSql in bytes. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4578 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4579 sqlite3_stmt *ppStmt, / OUT: Statement handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4580 const void *pzTail / OUT: Pointer to unused portion of zSql */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4581 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4582
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4583 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4584 ** CAPI3REF: Retrieving Statement SQL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4585 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4586 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4587 ** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4588 ** SQL text used to create [prepared statement] P if P was
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4589 ** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4590 ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4591 ** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4592 ** string containing the SQL text of prepared statement P with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4593 ** [bound parameters] expanded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4594 ** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4595 ** string containing the normalized SQL text of prepared statement P. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4596 ** semantics used to normalize a SQL statement are unspecified and subject
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4597 ** to change. At a minimum, literal values will be replaced with suitable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4598 ** placeholders.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4599 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4600 ** ^(For example, if a prepared statement is created using the SQL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4601 ** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4602 ** and parameter :xyz is unbound, then sqlite3_sql() will return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4603 ** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4604 ** will return "SELECT 2345,NULL".)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4605 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4606 ** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4607 ** is available to hold the result, or if the result would exceed the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4608 ** maximum string length determined by the [SQLITE_LIMIT_LENGTH].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4609 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4610 ** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4611 ** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4612 ** option causes sqlite3_expanded_sql() to always return NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4613 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4614 ** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4615 ** are managed by SQLite and are automatically freed when the prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4616 ** statement is finalized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4617 ** ^The string returned by sqlite3_expanded_sql(P), on the other hand,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4618 ** is obtained from [sqlite3_malloc()] and must be freed by the application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4619 ** by passing it to [sqlite3_free()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4620 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4621 ** ^The sqlite3_normalized_sql() interface is only available if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4622 ** the [SQLITE_ENABLE_NORMALIZE] compile-time option is defined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4623 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4624 SQLITE_API const char sqlite3_sql(sqlite3_stmt pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4625 SQLITE_API char sqlite3_expanded_sql(sqlite3_stmt pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4626 #ifdef SQLITE_ENABLE_NORMALIZE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4627 SQLITE_API const char sqlite3_normalized_sql(sqlite3_stmt pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4628 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4629
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4630 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4631 ** CAPI3REF: Determine If An SQL Statement Writes The Database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4632 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4633 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4634 ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4635 ** and only if the [prepared statement] X makes no direct changes to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4636 ** the content of the database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4637 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4638 ** Note that [application-defined SQL functions] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4639 ** [virtual tables] might change the database indirectly as a side effect.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4640 ** ^(For example, if an application defines a function "eval()" that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4641 ** calls [sqlite3_exec()], then the following SQL statement would
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4642 ** change the database file through side-effects:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4643 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4644 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4645 ** SELECT eval('DELETE FROM t1') FROM t2;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4646 ** </pre></blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4647 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4648 ** But because the [SELECT] statement does not change the database file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4649 ** directly, sqlite3_stmt_readonly() would still return true.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4650 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4651 ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4652 ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4653 ** since the statements themselves do not actually modify the database but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4654 ** rather they control the timing of when other statements modify the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4655 ** database. ^The [ATTACH] and [DETACH] statements also cause
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4656 ** sqlite3_stmt_readonly() to return true since, while those statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4657 ** change the configuration of a database connection, they do not make
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4658 ** changes to the content of the database files on disk.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4659 ** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4660 ** [BEGIN] merely sets internal flags, but the [BEGIN\|BEGIN IMMEDIATE] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4661 ** [BEGIN\|BEGIN EXCLUSIVE] commands do touch the database and so
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4662 ** sqlite3_stmt_readonly() returns false for those commands.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4663 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4664 ** ^This routine returns false if there is any possibility that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4665 ** statement might change the database file. ^A false return does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4666 ** not guarantee that the statement will change the database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4667 ** ^For example, an UPDATE statement might have a WHERE clause that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4668 ** makes it a no-op, but the sqlite3_stmt_readonly() result would still
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4669 ** be false. ^Similarly, a CREATE TABLE IF NOT EXISTS statement is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4670 ** read-only no-op if the table already exists, but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4671 ** sqlite3_stmt_readonly() still returns false for such a statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4672 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4673 ** ^If prepared statement X is an [EXPLAIN] or [EXPLAIN QUERY PLAN]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4674 ** statement, then sqlite3_stmt_readonly(X) returns the same value as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4675 ** if the EXPLAIN or EXPLAIN QUERY PLAN prefix were omitted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4676 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4677 SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4678
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4679 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4680 ** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4681 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4682 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4683 ** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4684 ** prepared statement S is an EXPLAIN statement, or 2 if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4685 ** statement S is an EXPLAIN QUERY PLAN.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4686 ** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4687 ** an ordinary statement or a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4688 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4689 SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4690
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4691 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4692 ** CAPI3REF: Change The EXPLAIN Setting For A Prepared Statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4693 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4694 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4695 ** The sqlite3_stmt_explain(S,E) interface changes the EXPLAIN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4696 ** setting for [prepared statement] S. If E is zero, then S becomes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4697 ** a normal prepared statement. If E is 1, then S behaves as if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4698 ** its SQL text began with "[EXPLAIN]". If E is 2, then S behaves as if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4699 ** its SQL text began with "[EXPLAIN QUERY PLAN]".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4700 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4701 ** Calling sqlite3_stmt_explain(S,E) might cause S to be reprepared.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4702 ** SQLite tries to avoid a reprepare, but a reprepare might be necessary
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4703 ** on the first transition into EXPLAIN or EXPLAIN QUERY PLAN mode.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4704 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4705 ** Because of the potential need to reprepare, a call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4706 ** sqlite3_stmt_explain(S,E) will fail with SQLITE_ERROR if S cannot be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4707 ** reprepared because it was created using [sqlite3_prepare()] instead of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4708 ** the newer [sqlite3_prepare_v2()] or [sqlite3_prepare_v3()] interfaces and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4709 ** hence has no saved SQL text with which to reprepare.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4710 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4711 ** Changing the explain setting for a prepared statement does not change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4712 ** the original SQL text for the statement. Hence, if the SQL text originally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4713 ** began with EXPLAIN or EXPLAIN QUERY PLAN, but sqlite3_stmt_explain(S,0)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4714 ** is called to convert the statement into an ordinary statement, the EXPLAIN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4715 ** or EXPLAIN QUERY PLAN keywords will still appear in the sqlite3_sql(S)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4716 ** output, even though the statement now acts like a normal SQL statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4717 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4718 ** This routine returns SQLITE_OK if the explain mode is successfully
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4719 ** changed, or an error code if the explain mode could not be changed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4720 ** The explain mode cannot be changed while a statement is active.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4721 ** Hence, it is good practice to call [sqlite3_reset(S)]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4722 ** immediately prior to calling sqlite3_stmt_explain(S,E).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4723 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4724 SQLITE_API int sqlite3_stmt_explain(sqlite3_stmt *pStmt, int eMode);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4725
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4726 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4727 ** CAPI3REF: Determine If A Prepared Statement Has Been Reset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4728 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4729 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4730 ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4731 ** [prepared statement] S has been stepped at least once using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4732 ** [sqlite3_step(S)] but has neither run to completion (returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4733 ** [SQLITE_DONE] from [sqlite3_step(S)]) nor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4734 ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4735 ** interface returns false if S is a NULL pointer. If S is not a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4736 ** NULL pointer and is not a pointer to a valid [prepared statement]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4737 ** object, then the behavior is undefined and probably undesirable.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4738 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4739 ** This interface can be used in combination [sqlite3_next_stmt()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4740 ** to locate all prepared statements associated with a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4741 ** connection that are in need of being reset. This can be used,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4742 ** for example, in diagnostic routines to search for prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4743 ** statements that are holding a transaction open.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4744 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4745 SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4746
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4747 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4748 ** CAPI3REF: Dynamically Typed Value Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4749 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4750 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4751 ** SQLite uses the sqlite3_value object to represent all values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4752 ** that can be stored in a database table. SQLite uses dynamic typing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4753 ** for the values it stores. ^Values stored in sqlite3_value objects
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4754 ** can be integers, floating point values, strings, BLOBs, or NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4755 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4756 ** An sqlite3_value object may be either "protected" or "unprotected".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4757 ** Some interfaces require a protected sqlite3_value. Other interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4758 ** will accept either a protected or an unprotected sqlite3_value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4759 ** Every interface that accepts sqlite3_value arguments specifies
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4760 ** whether or not it requires a protected sqlite3_value. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4761 ** [sqlite3_value_dup()] interface can be used to construct a new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4762 ** protected sqlite3_value from an unprotected sqlite3_value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4763 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4764 ** The terms "protected" and "unprotected" refer to whether or not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4765 ** a mutex is held. An internal mutex is held for a protected
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4766 ** sqlite3_value object but no mutex is held for an unprotected
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4767 ** sqlite3_value object. If SQLite is compiled to be single-threaded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4768 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4769 ** or if SQLite is run in one of reduced mutex modes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4770 ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4771 ** then there is no distinction between protected and unprotected
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4772 ** sqlite3_value objects and they can be used interchangeably. However,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4773 ** for maximum code portability it is recommended that applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4774 ** still make the distinction between protected and unprotected
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4775 ** sqlite3_value objects even when not strictly required.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4776 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4777 ** ^The sqlite3_value objects that are passed as parameters into the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4778 ** implementation of [application-defined SQL functions] are protected.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4779 ** ^The sqlite3_value objects returned by [sqlite3_vtab_rhs_value()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4780 ** are protected.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4781 ** ^The sqlite3_value object returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4782 ** [sqlite3_column_value()] is unprotected.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4783 ** Unprotected sqlite3_value objects may only be used as arguments
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4784 ** to [sqlite3_result_value()], [sqlite3_bind_value()], and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4785 ** [sqlite3_value_dup()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4786 ** The [sqlite3_value_blob \| sqlite3_value_type()] family of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4787 ** interfaces require protected sqlite3_value objects.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4788 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4789 typedef struct sqlite3_value sqlite3_value;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4790
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4791 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4792 ** CAPI3REF: SQL Function Context Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4793 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4794 ** The context in which an SQL function executes is stored in an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4795 ** sqlite3_context object. ^A pointer to an sqlite3_context object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4796 ** is always the first parameter to [application-defined SQL functions].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4797 ** The application-defined SQL function implementation will pass this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4798 ** pointer through into calls to [sqlite3_result_int \| sqlite3_result()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4799 ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4800 ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4801 ** and/or [sqlite3_set_auxdata()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4802 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4803 typedef struct sqlite3_context sqlite3_context;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4804
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4805 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4806 ** CAPI3REF: Binding Values To Prepared Statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4807 ** KEYWORDS: {host parameter} {host parameters} {host parameter name}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4808 ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4809 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4810 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4811 ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4812 ** literals may be replaced by a [parameter] that matches one of the following
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4813 ** templates:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4814 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4815 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4816 ** <li> ?
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4817 ** <li> ?NNN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4818 ** <li> :VVV
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4819 ** <li> @VVV
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4820 ** <li> $VVV
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4821 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4822 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4823 ** In the templates above, NNN represents an integer literal,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4824 ** and VVV represents an alphanumeric identifier.)^ ^The values of these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4825 ** parameters (also called "host parameter names" or "SQL parameters")
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4826 ** can be set using the sqlite3_bind_*() routines defined here.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4827 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4828 ** ^The first argument to the sqlite3_bind_*() routines is always
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4829 ** a pointer to the [sqlite3_stmt] object returned from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4830 ** [sqlite3_prepare_v2()] or its variants.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4831 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4832 ** ^The second argument is the index of the SQL parameter to be set.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4833 ** ^The leftmost SQL parameter has an index of 1. ^When the same named
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4834 ** SQL parameter is used more than once, second and subsequent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4835 ** occurrences have the same index as the first occurrence.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4836 ** ^The index for named parameters can be looked up using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4837 ** [sqlite3_bind_parameter_index()] API if desired. ^The index
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4838 ** for "?NNN" parameters is the value of NNN.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4839 ** ^The NNN value must be between 1 and the [sqlite3_limit()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4840 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 32766).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4841 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4842 ** ^The third argument is the value to bind to the parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4843 ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4844 ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4845 ** is ignored and the end result is the same as sqlite3_bind_null().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4846 ** ^If the third parameter to sqlite3_bind_text() is not NULL, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4847 ** it should be a pointer to well-formed UTF8 text.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4848 ** ^If the third parameter to sqlite3_bind_text16() is not NULL, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4849 ** it should be a pointer to well-formed UTF16 text.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4850 ** ^If the third parameter to sqlite3_bind_text64() is not NULL, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4851 ** it should be a pointer to a well-formed unicode string that is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4852 ** either UTF8 if the sixth parameter is SQLITE_UTF8, or UTF16
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4853 ** otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4854 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4855 ** [[byte-order determination rules]] ^The byte-order of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4856 ** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4857 ** found in the first character, which is removed, or in the absence of a BOM
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4858 ** the byte order is the native byte order of the host
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4859 ** machine for sqlite3_bind_text16() or the byte order specified in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4860 ** the 6th parameter for sqlite3_bind_text64().)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4861 ** ^If UTF16 input text contains invalid unicode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4862 ** characters, then SQLite might change those invalid characters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4863 ** into the unicode replacement character: U+FFFD.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4864 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4865 ** ^(In those routines that have a fourth argument, its value is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4866 ** number of bytes in the parameter. To be clear: the value is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4867 ** number of <u>bytes</u> in the value, not the number of characters.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4868 ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4869 ** is negative, then the length of the string is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4870 ** the number of bytes up to the first zero terminator.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4871 ** If the fourth parameter to sqlite3_bind_blob() is negative, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4872 ** the behavior is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4873 ** If a non-negative fourth parameter is provided to sqlite3_bind_text()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4874 ** or sqlite3_bind_text16() or sqlite3_bind_text64() then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4875 ** that parameter must be the byte offset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4876 ** where the NUL terminator would occur assuming the string were NUL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4877 ** terminated. If any NUL characters occur at byte offsets less than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4878 ** the value of the fourth parameter then the resulting string value will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4879 ** contain embedded NULs. The result of expressions involving strings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4880 ** with embedded NULs is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4881 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4882 ** ^The fifth argument to the BLOB and string binding interfaces controls
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4883 ** or indicates the lifetime of the object referenced by the third parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4884 ** These three options exist:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4885 ** ^ (1) A destructor to dispose of the BLOB or string after SQLite has finished
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4886 ** with it may be passed. ^It is called to dispose of the BLOB or string even
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4887 ** if the call to the bind API fails, except the destructor is not called if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4888 ** the third parameter is a NULL pointer or the fourth parameter is negative.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4889 ** ^ (2) The special constant, [SQLITE_STATIC], may be passed to indicate that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4890 ** the application remains responsible for disposing of the object. ^In this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4891 ** case, the object and the provided pointer to it must remain valid until
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4892 ** either the prepared statement is finalized or the same SQL parameter is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4893 ** bound to something else, whichever occurs sooner.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4894 ** ^ (3) The constant, [SQLITE_TRANSIENT], may be passed to indicate that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4895 ** object is to be copied prior to the return from sqlite3_bind_*(). ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4896 ** object and pointer to it must remain valid until then. ^SQLite will then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4897 ** manage the lifetime of its private copy.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4898 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4899 ** ^The sixth argument to sqlite3_bind_text64() must be one of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4900 ** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4901 ** to specify the encoding of the text in the third parameter. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4902 ** the sixth argument to sqlite3_bind_text64() is not one of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4903 ** allowed values shown above, or if the text encoding is different
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4904 ** from the encoding specified by the sixth parameter, then the behavior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4905 ** is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4906 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4907 ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4908 ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4909 ** (just an integer to hold its size) while it is being processed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4910 ** Zeroblobs are intended to serve as placeholders for BLOBs whose
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4911 ** content is later written using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4912 ** [sqlite3_blob_open \| incremental BLOB I/O] routines.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4913 ** ^A negative value for the zeroblob results in a zero-length BLOB.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4914 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4915 ** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4916 ** [prepared statement] S to have an SQL value of NULL, but to also be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4917 ** associated with the pointer P of type T. ^D is either a NULL pointer or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4918 ** a pointer to a destructor function for P. ^SQLite will invoke the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4919 ** destructor D with a single argument of P when it is finished using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4920 ** P, even if the call to sqlite3_bind_pointer() fails. Due to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4921 ** historical design quirk, results are undefined if D is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4922 ** SQLITE_TRANSIENT. The T parameter should be a static string,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4923 ** preferably a string literal. The sqlite3_bind_pointer() routine is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4924 ** part of the [pointer passing interface] added for SQLite 3.20.0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4925 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4926 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4927 ** for the [prepared statement] or with a prepared statement for which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4928 ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4929 ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4930 ** routine is passed a [prepared statement] that has been finalized, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4931 ** result is undefined and probably harmful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4932 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4933 ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4934 ** ^Unbound parameters are interpreted as NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4935 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4936 ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4937 ** [error code] if anything goes wrong.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4938 ** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4939 ** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4940 ** [SQLITE_MAX_LENGTH].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4941 ** ^[SQLITE_RANGE] is returned if the parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4942 ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4943 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4944 ** See also: [sqlite3_bind_parameter_count()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4945 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4946 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4947 SQLITE_API int sqlite3_bind_blob(sqlite3_stmt, int, const void, int n, void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4948 SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt, int, const void, sqlite3_uint64,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4949 void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4950 SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4951 SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4952 SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4953 SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4954 SQLITE_API int sqlite3_bind_text(sqlite3_stmt,int,const char,int,void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4955 SQLITE_API int sqlite3_bind_text16(sqlite3_stmt, int, const void, int, void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4956 SQLITE_API int sqlite3_bind_text64(sqlite3_stmt, int, const char, sqlite3_uint64,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4957 void()(void), unsigned char encoding);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4958 SQLITE_API int sqlite3_bind_value(sqlite3_stmt, int, const sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4959 SQLITE_API int sqlite3_bind_pointer(sqlite3_stmt, int, void, const char,void()(void*));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4960 SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4961 SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4962
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4963 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4964 ** CAPI3REF: Number Of SQL Parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4965 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4966 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4967 ** ^This routine can be used to find the number of [SQL parameters]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4968 ** in a [prepared statement]. SQL parameters are tokens of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4969 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4970 ** placeholders for values that are [sqlite3_bind_blob \| bound]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4971 ** to the parameters at a later time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4972 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4973 ** ^(This routine actually returns the index of the largest (rightmost)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4974 ** parameter. For all forms except ?NNN, this will correspond to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4975 ** number of unique parameters. If parameters of the ?NNN form are used,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4976 ** there may be gaps in the list.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4977 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4978 ** See also: [sqlite3_bind_blob\|sqlite3_bind()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4979 ** [sqlite3_bind_parameter_name()], and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4980 ** [sqlite3_bind_parameter_index()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4981 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4982 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4983
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4984 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4985 ** CAPI3REF: Name Of A Host Parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4986 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4987 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4988 ** ^The sqlite3_bind_parameter_name(P,N) interface returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4989 ** the name of the N-th [SQL parameter] in the [prepared statement] P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4990 ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4991 ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4992 ** respectively.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4993 ** In other words, the initial ":" or "$" or "@" or "?"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4994 ** is included as part of the name.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4995 ** ^Parameters of the form "?" without a following integer have no name
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4996 ** and are referred to as "nameless" or "anonymous parameters".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4997 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4998 ** ^The first host parameter has an index of 1, not 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	4999 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5000 ** ^If the value N is out of range or if the N-th parameter is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5001 ** nameless, then NULL is returned. ^The returned string is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5002 ** always in UTF-8 encoding even if the named parameter was
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5003 ** originally specified as UTF-16 in [sqlite3_prepare16()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5004 ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5005 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5006 ** See also: [sqlite3_bind_blob\|sqlite3_bind()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5007 ** [sqlite3_bind_parameter_count()], and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5008 ** [sqlite3_bind_parameter_index()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5009 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5010 SQLITE_API const char sqlite3_bind_parameter_name(sqlite3_stmt, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5011
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5012 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5013 ** CAPI3REF: Index Of A Parameter With A Given Name
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5014 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5015 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5016 ** ^Return the index of an SQL parameter given its name. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5017 ** index value returned is suitable for use as the second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5018 ** parameter to [sqlite3_bind_blob\|sqlite3_bind()]. ^A zero
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5019 ** is returned if no matching parameter is found. ^The parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5020 ** name must be given in UTF-8 even if the original statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5021 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5022 ** [sqlite3_prepare16_v3()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5023 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5024 ** See also: [sqlite3_bind_blob\|sqlite3_bind()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5025 ** [sqlite3_bind_parameter_count()], and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5026 ** [sqlite3_bind_parameter_name()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5027 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5028 SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt, const char zName);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5029
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5030 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5031 ** CAPI3REF: Reset All Bindings On A Prepared Statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5032 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5033 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5034 ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5035 ** the [sqlite3_bind_blob \| bindings] on a [prepared statement].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5036 ** ^Use this routine to reset all host parameters to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5037 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5038 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5039
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5040 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5041 ** CAPI3REF: Number Of Columns In A Result Set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5042 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5043 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5044 ** ^Return the number of columns in the result set returned by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5045 ** [prepared statement]. ^If this routine returns 0, that means the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5046 ** [prepared statement] returns no data (for example an [UPDATE]).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5047 ** ^However, just because this routine returns a positive number does not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5048 ** mean that one or more rows of data will be returned. ^A SELECT statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5049 ** will always have a positive sqlite3_column_count() but depending on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5050 ** WHERE clause constraints and the table content, it might return no rows.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5051 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5052 ** See also: [sqlite3_data_count()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5053 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5054 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5055
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5056 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5057 ** CAPI3REF: Column Names In A Result Set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5058 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5059 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5060 ** ^These routines return the name assigned to a particular column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5061 ** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5062 ** interface returns a pointer to a zero-terminated UTF-8 string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5063 ** and sqlite3_column_name16() returns a pointer to a zero-terminated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5064 ** UTF-16 string. ^The first parameter is the [prepared statement]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5065 ** that implements the [SELECT] statement. ^The second parameter is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5066 ** column number. ^The leftmost column is number 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5067 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5068 ** ^The returned string pointer is valid until either the [prepared statement]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5069 ** is destroyed by [sqlite3_finalize()] or until the statement is automatically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5070 ** reprepared by the first call to [sqlite3_step()] for a particular run
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5071 ** or until the next call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5072 ** sqlite3_column_name() or sqlite3_column_name16() on the same column.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5073 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5074 ** ^If sqlite3_malloc() fails during the processing of either routine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5075 ** (for example during a conversion from UTF-8 to UTF-16) then a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5076 ** NULL pointer is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5077 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5078 ** ^The name of a result column is the value of the "AS" clause for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5079 ** that column, if there is an AS clause. If there is no AS clause
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5080 ** then the name of the column is unspecified and may change from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5081 ** one release of SQLite to the next.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5082 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5083 SQLITE_API const char sqlite3_column_name(sqlite3_stmt, int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5084 SQLITE_API const void sqlite3_column_name16(sqlite3_stmt, int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5085
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5086 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5087 ** CAPI3REF: Source Of Data In A Query Result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5088 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5089 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5090 ** ^These routines provide a means to determine the database, table, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5091 ** table column that is the origin of a particular result column in a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5092 ** [SELECT] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5093 ** ^The name of the database or table or column can be returned as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5094 ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5095 ** the database name, the _table_ routines return the table name, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5096 ** the origin_ routines return the column name.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5097 ** ^The returned string is valid until the [prepared statement] is destroyed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5098 ** using [sqlite3_finalize()] or until the statement is automatically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5099 ** reprepared by the first call to [sqlite3_step()] for a particular run
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5100 ** or until the same information is requested
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5101 ** again in a different encoding.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5102 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5103 ** ^The names returned are the original un-aliased names of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5104 ** database, table, and column.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5105 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5106 ** ^The first argument to these interfaces is a [prepared statement].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5107 ** ^These functions return information about the Nth result column returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5108 ** the statement, where N is the second function argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5109 ** ^The left-most column is column 0 for these routines.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5110 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5111 ** ^If the Nth column returned by the statement is an expression or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5112 ** subquery and is not a column value, then all of these functions return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5113 ** NULL. ^These routines might also return NULL if a memory allocation error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5114 ** occurs. ^Otherwise, they return the name of the attached database, table,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5115 ** or column that query result column was extracted from.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5116 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5117 ** ^As with all other SQLite APIs, those whose names end with "16" return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5118 ** UTF-16 encoded strings and the other functions return UTF-8.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5119 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5120 ** ^These APIs are only available if the library was compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5121 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5122 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5123 ** If two or more threads call one or more
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5124 ** [sqlite3_column_database_name \| column metadata interfaces]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5125 ** for the same [prepared statement] and result column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5126 ** at the same time then the results are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5127 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5128 SQLITE_API const char sqlite3_column_database_name(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5129 SQLITE_API const void sqlite3_column_database_name16(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5130 SQLITE_API const char sqlite3_column_table_name(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5131 SQLITE_API const void sqlite3_column_table_name16(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5132 SQLITE_API const char sqlite3_column_origin_name(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5133 SQLITE_API const void sqlite3_column_origin_name16(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5134
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5135 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5136 ** CAPI3REF: Declared Datatype Of A Query Result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5137 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5138 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5139 ** ^(The first parameter is a [prepared statement].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5140 ** If this statement is a [SELECT] statement and the Nth column of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5141 ** returned result set of that [SELECT] is a table column (not an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5142 ** expression or subquery) then the declared type of the table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5143 ** column is returned.)^ ^If the Nth column of the result set is an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5144 ** expression or subquery, then a NULL pointer is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5145 ** ^The returned string is always UTF-8 encoded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5146 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5147 ** ^(For example, given the database schema:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5148 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5149 ** CREATE TABLE t1(c1 VARIANT);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5150 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5151 ** and the following statement to be compiled:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5152 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5153 ** SELECT c1 + 1, c1 FROM t1;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5154 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5155 ** this routine would return the string "VARIANT" for the second result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5156 ** column (i==1), and a NULL pointer for the first result column (i==0).)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5157 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5158 ** ^SQLite uses dynamic run-time typing. ^So just because a column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5159 ** is declared to contain a particular type does not mean that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5160 ** data stored in that column is of the declared type. SQLite is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5161 ** strongly typed, but the typing is dynamic not static. ^Type
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5162 ** is associated with individual values, not with the containers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5163 ** used to hold those values.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5164 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5165 SQLITE_API const char sqlite3_column_decltype(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5166 SQLITE_API const void sqlite3_column_decltype16(sqlite3_stmt,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5167
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5168 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5169 ** CAPI3REF: Evaluate An SQL Statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5170 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5171 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5172 ** After a [prepared statement] has been prepared using any of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5173 ** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5174 ** or [sqlite3_prepare16_v3()] or one of the legacy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5175 ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5176 ** must be called one or more times to evaluate the statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5177 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5178 ** The details of the behavior of the sqlite3_step() interface depend
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5179 ** on whether the statement was prepared using the newer "vX" interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5180 ** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5181 ** [sqlite3_prepare16_v2()] or the older legacy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5182 ** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5183 ** new "vX" interface is recommended for new applications but the legacy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5184 ** interface will continue to be supported.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5185 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5186 ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5187 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5188 ** ^With the "v2" interface, any of the other [result codes] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5189 ** [extended result codes] might be returned as well.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5190 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5191 ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5192 ** database locks it needs to do its job. ^If the statement is a [COMMIT]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5193 ** or occurs outside of an explicit transaction, then you can retry the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5194 ** statement. If the statement is not a [COMMIT] and occurs within an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5195 ** explicit transaction then you should rollback the transaction before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5196 ** continuing.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5197 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5198 ** ^[SQLITE_DONE] means that the statement has finished executing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5199 ** successfully. sqlite3_step() should not be called again on this virtual
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5200 ** machine without first calling [sqlite3_reset()] to reset the virtual
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5201 ** machine back to its initial state.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5202 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5203 ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5204 ** is returned each time a new row of data is ready for processing by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5205 ** caller. The values may be accessed using the [column access functions].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5206 ** sqlite3_step() is called again to retrieve the next row of data.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5207 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5208 ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5209 ** violation) has occurred. sqlite3_step() should not be called again on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5210 ** the VM. More information may be found by calling [sqlite3_errmsg()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5211 ** ^With the legacy interface, a more specific error code (for example,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5212 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5213 ** can be obtained by calling [sqlite3_reset()] on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5214 ** [prepared statement]. ^In the "v2" interface,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5215 ** the more specific error code is returned directly by sqlite3_step().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5216 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5217 ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5218 ** Perhaps it was called on a [prepared statement] that has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5219 ** already been [sqlite3_finalize \| finalized] or on one that had
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5220 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5221 ** be the case that the same database connection is being used by two or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5222 ** more threads at the same moment in time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5223 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5224 ** For all versions of SQLite up to and including 3.6.23.1, a call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5225 ** [sqlite3_reset()] was required after sqlite3_step() returned anything
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5226 ** other than [SQLITE_ROW] before any subsequent invocation of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5227 ** sqlite3_step(). Failure to reset the prepared statement using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5228 ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5229 ** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1]),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5230 ** sqlite3_step() began
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5231 ** calling [sqlite3_reset()] automatically in this circumstance rather
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5232 ** than returning [SQLITE_MISUSE]. This is not considered a compatibility
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5233 ** break because any application that ever receives an SQLITE_MISUSE error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5234 ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5235 ** can be used to restore the legacy behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5236 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5237 ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5238 ** API always returns a generic error code, [SQLITE_ERROR], following any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5239 ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5240 ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5241 ** specific [error codes] that better describes the error.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5242 ** We admit that this is a goofy design. The problem has been fixed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5243 ** with the "v2" interface. If you prepare all of your SQL statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5244 ** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5245 ** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5246 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5247 ** then the more specific [error codes] are returned directly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5248 ** by sqlite3_step(). The use of the "vX" interfaces is recommended.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5249 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5250 SQLITE_API int sqlite3_step(sqlite3_stmt*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5251
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5252 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5253 ** CAPI3REF: Number of columns in a result set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5254 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5255 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5256 ** ^The sqlite3_data_count(P) interface returns the number of columns in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5257 ** current row of the result set of [prepared statement] P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5258 ** ^If prepared statement P does not have results ready to return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5259 ** (via calls to the [sqlite3_column_int \| sqlite3_column()] family of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5260 ** interfaces) then sqlite3_data_count(P) returns 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5261 ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5262 ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5263 ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5264 ** will return non-zero if previous call to [sqlite3_step](P) returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5265 ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5266 ** where it always returns zero since each step of that multi-step
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5267 ** pragma returns 0 columns of data.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5268 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5269 ** See also: [sqlite3_column_count()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5270 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5271 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5272
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5273 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5274 ** CAPI3REF: Fundamental Datatypes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5275 ** KEYWORDS: SQLITE_TEXT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5276 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5277 ** ^(Every value in SQLite has one of five fundamental datatypes:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5278 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5279 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5280 ** <li> 64-bit signed integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5281 ** <li> 64-bit IEEE floating point number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5282 ** <li> string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5283 ** <li> BLOB
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5284 ** <li> NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5285 ** </ul>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5286 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5287 ** These constants are codes for each of those types.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5288 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5289 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5290 ** for a completely different meaning. Software that links against both
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5291 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5292 ** SQLITE_TEXT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5293 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5294 #define SQLITE_INTEGER 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5295 #define SQLITE_FLOAT 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5296 #define SQLITE_BLOB 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5297 #define SQLITE_NULL 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5298 #ifdef SQLITE_TEXT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5299 # undef SQLITE_TEXT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5300 #else
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5301 # define SQLITE_TEXT 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5302 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5303 #define SQLITE3_TEXT 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5304
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5305 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5306 ** CAPI3REF: Result Values From A Query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5307 ** KEYWORDS: {column access functions}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5308 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5309 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5310 ** <b>Summary:</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5311 ** <blockquote><table border=0 cellpadding=0 cellspacing=0>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5312 ** <tr><td><b>sqlite3_column_blob</b><td>→<td>BLOB result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5313 ** <tr><td><b>sqlite3_column_double</b><td>→<td>REAL result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5314 ** <tr><td><b>sqlite3_column_int</b><td>→<td>32-bit INTEGER result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5315 ** <tr><td><b>sqlite3_column_int64</b><td>→<td>64-bit INTEGER result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5316 ** <tr><td><b>sqlite3_column_text</b><td>→<td>UTF-8 TEXT result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5317 ** <tr><td><b>sqlite3_column_text16</b><td>→<td>UTF-16 TEXT result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5318 ** <tr><td><b>sqlite3_column_value</b><td>→<td>The result as an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5319 ** [sqlite3_value\|unprotected sqlite3_value] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5320 ** <tr><td> <td> <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5321 ** <tr><td><b>sqlite3_column_bytes</b><td>→<td>Size of a BLOB
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5322 ** or a UTF-8 TEXT result in bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5323 ** <tr><td><b>sqlite3_column_bytes16  </b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5324 ** <td>→  <td>Size of UTF-16
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5325 ** TEXT in bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5326 ** <tr><td><b>sqlite3_column_type</b><td>→<td>Default
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5327 ** datatype of the result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5328 ** </table></blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5329 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5330 ** <b>Details:</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5331 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5332 ** ^These routines return information about a single column of the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5333 ** result row of a query. ^In every case the first argument is a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5334 ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5335 ** that was returned from [sqlite3_prepare_v2()] or one of its variants)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5336 ** and the second argument is the index of the column for which information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5337 ** should be returned. ^The leftmost column of the result set has the index 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5338 ** ^The number of columns in the result can be determined using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5339 ** [sqlite3_column_count()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5340 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5341 ** If the SQL statement does not currently point to a valid row, or if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5342 ** column index is out of range, the result is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5343 ** These routines may only be called when the most recent call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5344 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5345 ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5346 ** If any of these routines are called after [sqlite3_reset()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5347 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5348 ** something other than [SQLITE_ROW], the results are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5349 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5350 ** are called from a different thread while any of these routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5351 ** are pending, then the results are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5352 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5353 ** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5354 ** each return the value of a result column in a specific data format. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5355 ** the result column is not initially in the requested format (for example,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5356 ** if the query returns an integer but the sqlite3_column_text() interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5357 ** is used to extract the value) then an automatic type conversion is performed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5358 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5359 ** ^The sqlite3_column_type() routine returns the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5360 ** [SQLITE_INTEGER \| datatype code] for the initial data type
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5361 ** of the result column. ^The returned value is one of [SQLITE_INTEGER],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5362 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5363 ** The return value of sqlite3_column_type() can be used to decide which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5364 ** of the first six interface should be used to extract the column value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5365 ** The value returned by sqlite3_column_type() is only meaningful if no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5366 ** automatic type conversions have occurred for the value in question.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5367 ** After a type conversion, the result of calling sqlite3_column_type()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5368 ** is undefined, though harmless. Future
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5369 ** versions of SQLite may change the behavior of sqlite3_column_type()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5370 ** following a type conversion.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5371 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5372 ** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5373 ** or sqlite3_column_bytes16() interfaces can be used to determine the size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5374 ** of that BLOB or string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5375 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5376 ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5377 ** routine returns the number of bytes in that BLOB or string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5378 ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5379 ** the string to UTF-8 and then returns the number of bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5380 ** ^If the result is a numeric value then sqlite3_column_bytes() uses
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5381 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5382 ** the number of bytes in that string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5383 ** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5384 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5385 ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5386 ** routine returns the number of bytes in that BLOB or string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5387 ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5388 ** the string to UTF-16 and then returns the number of bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5389 ** ^If the result is a numeric value then sqlite3_column_bytes16() uses
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5390 ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5391 ** the number of bytes in that string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5392 ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5393 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5394 ** ^The values returned by [sqlite3_column_bytes()] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5395 ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5396 ** of the string. ^For clarity: the values returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5397 ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5398 ** bytes in the string, not the number of characters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5399 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5400 ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5401 ** even empty strings, are always zero-terminated. ^The return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5402 ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5403 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5404 ** ^Strings returned by sqlite3_column_text16() always have the endianness
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5405 ** which is native to the platform, regardless of the text encoding set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5406 ** for the database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5407 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5408 ** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5409 ** [unprotected sqlite3_value] object. In a multithreaded environment,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5410 ** an unprotected sqlite3_value object may only be used safely with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5411 ** [sqlite3_bind_value()] and [sqlite3_result_value()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5412 ** If the [unprotected sqlite3_value] object returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5413 ** [sqlite3_column_value()] is used in any other way, including calls
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5414 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5415 ** or [sqlite3_value_bytes()], the behavior is not threadsafe.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5416 ** Hence, the sqlite3_column_value() interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5417 ** is normally only useful within the implementation of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5418 ** [application-defined SQL functions] or [virtual tables], not within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5419 ** top-level application code.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5420 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5421 ** These routines may attempt to convert the datatype of the result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5422 ** ^For example, if the internal representation is FLOAT and a text result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5423 ** is requested, [sqlite3_snprintf()] is used internally to perform the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5424 ** conversion automatically. ^(The following table details the conversions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5425 ** that are applied:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5426 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5427 ** <blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5428 ** <table border="1">
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5429 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5430 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5431 ** <tr><td> NULL <td> INTEGER <td> Result is 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5432 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5433 ** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5434 ** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5435 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5436 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5437 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5438 ** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5439 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5440 ** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5441 ** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5442 ** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5443 ** <tr><td> TEXT <td> BLOB <td> No change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5444 ** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5445 ** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5446 ** <tr><td> BLOB <td> TEXT <td> [CAST] to TEXT, ensure zero terminator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5447 ** </table>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5448 ** </blockquote>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5449 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5450 ** Note that when type conversions occur, pointers returned by prior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5451 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5452 ** sqlite3_column_text16() may be invalidated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5453 ** Type conversions and pointer invalidations might occur
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5454 ** in the following cases:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5455 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5456 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5457 ** <li> The initial content is a BLOB and sqlite3_column_text() or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5458 ** sqlite3_column_text16() is called. A zero-terminator might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5459 ** need to be added to the string.</li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5460 ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5461 ** sqlite3_column_text16() is called. The content must be converted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5462 ** to UTF-16.</li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5463 ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5464 ** sqlite3_column_text() is called. The content must be converted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5465 ** to UTF-8.</li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5466 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5467 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5468 ** ^Conversions between UTF-16be and UTF-16le are always done in place and do
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5469 ** not invalidate a prior pointer, though of course the content of the buffer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5470 ** that the prior pointer references will have been modified. Other kinds
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5471 ** of conversion are done in place when it is possible, but sometimes they
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5472 ** are not possible and in those cases prior pointers are invalidated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5473 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5474 ** The safest policy is to invoke these routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5475 ** in one of the following ways:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5476 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5477 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5478 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5479 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5480 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5481 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5482 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5483 ** In other words, you should call sqlite3_column_text(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5484 ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5485 ** into the desired format, then invoke sqlite3_column_bytes() or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5486 ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5487 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5488 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5489 ** with calls to sqlite3_column_bytes().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5490 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5491 ** ^The pointers returned are valid until a type conversion occurs as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5492 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5493 ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5494 ** and BLOBs is freed automatically. Do not pass the pointers returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5495 ** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5496 ** [sqlite3_free()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5497 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5498 ** As long as the input parameters are correct, these routines will only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5499 ** fail if an out-of-memory error occurs during a format conversion.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5500 ** Only the following subset of interfaces are subject to out-of-memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5501 ** errors:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5502 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5503 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5504 ** <li> sqlite3_column_blob()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5505 ** <li> sqlite3_column_text()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5506 ** <li> sqlite3_column_text16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5507 ** <li> sqlite3_column_bytes()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5508 ** <li> sqlite3_column_bytes16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5509 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5510 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5511 ** If an out-of-memory error occurs, then the return value from these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5512 ** routines is the same as if the column had contained an SQL NULL value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5513 ** Valid SQL NULL returns can be distinguished from out-of-memory errors
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5514 ** by invoking the [sqlite3_errcode()] immediately after the suspect
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5515 ** return value is obtained and before any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5516 ** other SQLite interface is called on the same [database connection].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5517 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5518 SQLITE_API const void sqlite3_column_blob(sqlite3_stmt, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5519 SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5520 SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5521 SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5522 SQLITE_API const unsigned char sqlite3_column_text(sqlite3_stmt, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5523 SQLITE_API const void sqlite3_column_text16(sqlite3_stmt, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5524 SQLITE_API sqlite3_value sqlite3_column_value(sqlite3_stmt, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5525 SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5526 SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5527 SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5528
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5529 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5530 ** CAPI3REF: Destroy A Prepared Statement Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5531 ** DESTRUCTOR: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5532 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5533 ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5534 ** ^If the most recent evaluation of the statement encountered no errors
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5535 ** or if the statement has never been evaluated, then sqlite3_finalize() returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5536 ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5537 ** sqlite3_finalize(S) returns the appropriate [error code] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5538 ** [extended error code].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5539 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5540 ** ^The sqlite3_finalize(S) routine can be called at any point during
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5541 ** the life cycle of [prepared statement] S:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5542 ** before statement S is ever evaluated, after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5543 ** one or more calls to [sqlite3_reset()], or after any call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5544 ** to [sqlite3_step()] regardless of whether or not the statement has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5545 ** completed execution.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5546 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5547 ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5548 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5549 ** The application must finalize every [prepared statement] in order to avoid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5550 ** resource leaks. It is a grievous error for the application to try to use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5551 ** a prepared statement after it has been finalized. Any use of a prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5552 ** statement after it has been finalized can result in undefined and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5553 ** undesirable behavior such as segfaults and heap corruption.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5554 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5555 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5556
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5557 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5558 ** CAPI3REF: Reset A Prepared Statement Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5559 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5560 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5561 ** The sqlite3_reset() function is called to reset a [prepared statement]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5562 ** object back to its initial state, ready to be re-executed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5563 ** ^Any SQL statement variables that had values bound to them using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5564 ** the [sqlite3_bind_blob \| sqlite3_bind_*() API] retain their values.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5565 ** Use [sqlite3_clear_bindings()] to reset the bindings.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5566 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5567 ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5568 ** back to the beginning of its program.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5569 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5570 ** ^The return code from [sqlite3_reset(S)] indicates whether or not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5571 ** the previous evaluation of prepared statement S completed successfully.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5572 ** ^If [sqlite3_step(S)] has never before been called on S or if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5573 ** [sqlite3_step(S)] has not been called since the previous call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5574 ** to [sqlite3_reset(S)], then [sqlite3_reset(S)] will return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5575 ** [SQLITE_OK].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5576 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5577 ** ^If the most recent call to [sqlite3_step(S)] for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5578 ** [prepared statement] S indicated an error, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5579 ** [sqlite3_reset(S)] returns an appropriate [error code].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5580 ** ^The [sqlite3_reset(S)] interface might also return an [error code]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5581 ** if there were no prior errors but the process of resetting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5582 ** the prepared statement caused a new error. ^For example, if an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5583 ** [INSERT] statement with a [RETURNING] clause is only stepped one time,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5584 ** that one call to [sqlite3_step(S)] might return SQLITE_ROW but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5585 ** the overall statement might still fail and the [sqlite3_reset(S)] call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5586 ** might return SQLITE_BUSY if locking constraints prevent the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5587 ** database change from committing. Therefore, it is important that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5588 ** applications check the return code from [sqlite3_reset(S)] even if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5589 ** no prior call to [sqlite3_step(S)] indicated a problem.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5590 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5591 ** ^The [sqlite3_reset(S)] interface does not change the values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5592 ** of any [sqlite3_bind_blob\|bindings] on the [prepared statement] S.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5593 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5594 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5595
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5596
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5597 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5598 ** CAPI3REF: Create Or Redefine SQL Functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5599 ** KEYWORDS: {function creation routines}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5600 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5601 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5602 ** ^These functions (collectively known as "function creation routines")
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5603 ** are used to add SQL functions or aggregates or to redefine the behavior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5604 ** of existing SQL functions or aggregates. The only differences between
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5605 ** the three "sqlite3_create_function*" routines are the text encoding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5606 ** expected for the second parameter (the name of the function being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5607 ** created) and the presence or absence of a destructor callback for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5608 ** the application data pointer. Function sqlite3_create_window_function()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5609 ** is similar, but allows the user to supply the extra callback functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5610 ** needed by [aggregate window functions].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5611 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5612 ** ^The first parameter is the [database connection] to which the SQL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5613 ** function is to be added. ^If an application uses more than one database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5614 ** connection then application-defined SQL functions must be added
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5615 ** to each database connection separately.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5616 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5617 ** ^The second parameter is the name of the SQL function to be created or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5618 ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5619 ** representation, exclusive of the zero-terminator. ^Note that the name
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5620 ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5621 ** ^Any attempt to create a function with a longer name
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5622 ** will result in [SQLITE_MISUSE] being returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5623 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5624 ** ^The third parameter (nArg)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5625 ** is the number of arguments that the SQL function or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5626 ** aggregate takes. ^If this parameter is -1, then the SQL function or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5627 ** aggregate may take any number of arguments between 0 and the limit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5628 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5629 ** parameter is less than -1 or greater than 127 then the behavior is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5630 ** undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5631 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5632 ** ^The fourth parameter, eTextRep, specifies what
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5633 ** [SQLITE_UTF8 \| text encoding] this SQL function prefers for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5634 ** its parameters. The application should set this parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5635 ** [SQLITE_UTF16LE] if the function implementation invokes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5636 ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5637 ** implementation invokes [sqlite3_value_text16be()] on an input, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5638 ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5639 ** otherwise. ^The same SQL function may be registered multiple times using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5640 ** different preferred text encodings, with different implementations for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5641 ** each encoding.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5642 ** ^When multiple implementations of the same function are available, SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5643 ** will pick the one that involves the least amount of data conversion.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5644 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5645 ** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5646 ** to signal that the function will always return the same result given
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5647 ** the same inputs within a single SQL statement. Most SQL functions are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5648 ** deterministic. The built-in [random()] SQL function is an example of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5649 ** function that is not deterministic. The SQLite query planner is able to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5650 ** perform additional optimizations on deterministic functions, so use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5651 ** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5652 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5653 ** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5654 ** flag, which if present prevents the function from being invoked from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5655 ** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5656 ** index expressions, or the WHERE clause of partial indexes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5657 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5658 ** For best security, the [SQLITE_DIRECTONLY] flag is recommended for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5659 ** all application-defined SQL functions that do not need to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5660 ** used inside of triggers, views, CHECK constraints, or other elements of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5661 ** the database schema. This flag is especially recommended for SQL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5662 ** functions that have side effects or reveal internal application state.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5663 ** Without this flag, an attacker might be able to modify the schema of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5664 ** a database file to include invocations of the function with parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5665 ** chosen by the attacker, which the application will then execute when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5666 ** the database file is opened and read.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5667 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5668 ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5669 ** function can gain access to this pointer using [sqlite3_user_data()].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5670 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5671 ** ^The sixth, seventh and eighth parameters passed to the three
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5672 ** "sqlite3_create_function*" functions, xFunc, xStep and xFinal, are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5673 ** pointers to C-language functions that implement the SQL function or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5674 ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5675 ** callback only; NULL pointers must be passed as the xStep and xFinal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5676 ** parameters. ^An aggregate SQL function requires an implementation of xStep
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5677 ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5678 ** SQL function or aggregate, pass NULL pointers for all three function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5679 ** callbacks.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5680 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5681 ** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5682 ** and xInverse) passed to sqlite3_create_window_function are pointers to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5683 ** C-language callbacks that implement the new function. xStep and xFinal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5684 ** must both be non-NULL. xValue and xInverse may either both be NULL, in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5685 ** which case a regular aggregate function is created, or must both be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5686 ** non-NULL, in which case the new function may be used as either an aggregate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5687 ** or aggregate window function. More details regarding the implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5688 ** of aggregate window functions are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5689 ** [user-defined window functions\|available here].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5690 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5691 ** ^(If the final parameter to sqlite3_create_function_v2() or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5692 ** sqlite3_create_window_function() is not NULL, then it is the destructor for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5693 ** the application data pointer. The destructor is invoked when the function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5694 ** is deleted, either by being overloaded or when the database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5695 ** closes.)^ ^The destructor is also invoked if the call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5696 ** sqlite3_create_function_v2() fails. ^When the destructor callback is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5697 ** invoked, it is passed a single argument which is a copy of the application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5698 ** data pointer which was the fifth parameter to sqlite3_create_function_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5699 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5700 ** ^It is permitted to register multiple implementations of the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5701 ** functions with the same name but with either differing numbers of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5702 ** arguments or differing preferred text encodings. ^SQLite will use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5703 ** the implementation that most closely matches the way in which the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5704 ** SQL function is used. ^A function implementation with a non-negative
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5705 ** nArg parameter is a better match than a function implementation with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5706 ** a negative nArg. ^A function where the preferred text encoding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5707 ** matches the database encoding is a better
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5708 ** match than a function where the encoding is different.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5709 ** ^A function where the encoding difference is between UTF16le and UTF16be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5710 ** is a closer match than a function where the encoding difference is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5711 ** between UTF8 and UTF16.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5712 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5713 ** ^Built-in functions may be overloaded by new application-defined functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5714 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5715 ** ^An application-defined function is permitted to call other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5716 ** SQLite interfaces. However, such calls must not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5717 ** close the database connection nor finalize or reset the prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5718 ** statement in which the function is running.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5719 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5720 SQLITE_API int sqlite3_create_function(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5721 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5722 const char *zFunctionName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5723 int nArg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5724 int eTextRep,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5725 void *pApp,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5726 void (xFunc)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5727 void (xStep)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5728 void (xFinal)(sqlite3_context)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5729 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5730 SQLITE_API int sqlite3_create_function16(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5731 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5732 const void *zFunctionName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5733 int nArg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5734 int eTextRep,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5735 void *pApp,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5736 void (xFunc)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5737 void (xStep)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5738 void (xFinal)(sqlite3_context)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5739 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5740 SQLITE_API int sqlite3_create_function_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5741 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5742 const char *zFunctionName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5743 int nArg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5744 int eTextRep,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5745 void *pApp,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5746 void (xFunc)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5747 void (xStep)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5748 void (xFinal)(sqlite3_context),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5749 void(xDestroy)(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5750 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5751 SQLITE_API int sqlite3_create_window_function(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5752 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5753 const char *zFunctionName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5754 int nArg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5755 int eTextRep,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5756 void *pApp,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5757 void (xStep)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5758 void (xFinal)(sqlite3_context),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5759 void (xValue)(sqlite3_context),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5760 void (xInverse)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5761 void(xDestroy)(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5762 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5763
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5764 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5765 ** CAPI3REF: Text Encodings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5766 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5767 ** These constants define integer codes that represent the various
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5768 ** text encodings supported by SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5769 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5770 #define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5771 #define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5772 #define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5773 #define SQLITE_UTF16 4 /* Use native byte order */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5774 #define SQLITE_ANY 5 /* Deprecated */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5775 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5776
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5777 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5778 ** CAPI3REF: Function Flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5779 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5780 ** These constants may be ORed together with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5781 ** [SQLITE_UTF8 \| preferred text encoding] as the fourth argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5782 ** to [sqlite3_create_function()], [sqlite3_create_function16()], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5783 ** [sqlite3_create_function_v2()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5784 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5785 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5786 ** [[SQLITE_DETERMINISTIC]] <dt>SQLITE_DETERMINISTIC</dt><dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5787 ** The SQLITE_DETERMINISTIC flag means that the new function always gives
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5788 ** the same output when the input parameters are the same.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5789 ** The [abs\|abs() function] is deterministic, for example, but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5790 ** [randomblob\|randomblob()] is not. Functions must
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5791 ** be deterministic in order to be used in certain contexts such as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5792 ** with the WHERE clause of [partial indexes] or in [generated columns].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5793 ** SQLite might also optimize deterministic functions by factoring them
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5794 ** out of inner loops.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5795 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5796 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5797 ** [[SQLITE_DIRECTONLY]] <dt>SQLITE_DIRECTONLY</dt><dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5798 ** The SQLITE_DIRECTONLY flag means that the function may only be invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5799 ** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5800 ** schema structures such as [CHECK constraints], [DEFAULT clauses],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5801 ** [expression indexes], [partial indexes], or [generated columns].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5802 ** <p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5803 ** The SQLITE_DIRECTONLY flag is recommended for any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5804 ** [application-defined SQL function]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5805 ** that has side-effects or that could potentially leak sensitive information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5806 ** This will prevent attacks in which an application is tricked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5807 ** into using a database file that has had its schema surreptitiously
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5808 ** modified to invoke the application-defined function in ways that are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5809 ** harmful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5810 ** <p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5811 ** Some people say it is good practice to set SQLITE_DIRECTONLY on all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5812 ** [application-defined SQL functions], regardless of whether or not they
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5813 ** are security sensitive, as doing so prevents those functions from being used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5814 ** inside of the database schema, and thus ensures that the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5815 ** can be inspected and modified using generic tools (such as the [CLI])
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5816 ** that do not have access to the application-defined functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5817 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5818 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5819 ** [[SQLITE_INNOCUOUS]] <dt>SQLITE_INNOCUOUS</dt><dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5820 ** The SQLITE_INNOCUOUS flag means that the function is unlikely
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5821 ** to cause problems even if misused. An innocuous function should have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5822 ** no side effects and should not depend on any values other than its
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5823 ** input parameters. The [abs\|abs() function] is an example of an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5824 ** innocuous function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5825 ** The [load_extension() SQL function] is not innocuous because of its
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5826 ** side effects.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5827 ** <p> SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5828 ** exactly the same. The [random\|random() function] is an example of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5829 ** function that is innocuous but not deterministic.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5830 ** <p>Some heightened security settings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5831 ** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF])
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5832 ** disable the use of SQL functions inside views and triggers and in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5833 ** schema structures such as [CHECK constraints], [DEFAULT clauses],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5834 ** [expression indexes], [partial indexes], and [generated columns] unless
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5835 ** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5836 ** are innocuous. Developers are advised to avoid using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5837 ** SQLITE_INNOCUOUS flag for application-defined functions unless the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5838 ** function has been carefully audited and found to be free of potentially
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5839 ** security-adverse side-effects and information-leaks.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5840 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5841 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5842 ** [[SQLITE_SUBTYPE]] <dt>SQLITE_SUBTYPE</dt><dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5843 ** The SQLITE_SUBTYPE flag indicates to SQLite that a function might call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5844 ** [sqlite3_value_subtype()] to inspect the sub-types of its arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5845 ** This flag instructs SQLite to omit some corner-case optimizations that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5846 ** might disrupt the operation of the [sqlite3_value_subtype()] function,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5847 ** causing it to return zero rather than the correct subtype().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5848 ** All SQL functions that invoke [sqlite3_value_subtype()] should have this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5849 ** property. If the SQLITE_SUBTYPE property is omitted, then the return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5850 ** value from [sqlite3_value_subtype()] might sometimes be zero even though
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5851 ** a non-zero subtype was specified by the function argument expression.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5852 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5853 ** [[SQLITE_RESULT_SUBTYPE]] <dt>SQLITE_RESULT_SUBTYPE</dt><dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5854 ** The SQLITE_RESULT_SUBTYPE flag indicates to SQLite that a function might call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5855 ** [sqlite3_result_subtype()] to cause a sub-type to be associated with its
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5856 ** result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5857 ** Every function that invokes [sqlite3_result_subtype()] should have this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5858 ** property. If it does not, then the call to [sqlite3_result_subtype()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5859 ** might become a no-op if the function is used as a term in an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5860 ** [expression index]. On the other hand, SQL functions that never invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5861 ** [sqlite3_result_subtype()] should avoid setting this property, as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5862 ** purpose of this property is to disable certain optimizations that are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5863 ** incompatible with subtypes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5864 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5865 ** [[SQLITE_SELFORDER1]] <dt>SQLITE_SELFORDER1</dt><dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5866 ** The SQLITE_SELFORDER1 flag indicates that the function is an aggregate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5867 ** that internally orders the values provided to the first argument. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5868 ** ordered-set aggregate SQL notation with a single ORDER BY term can be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5869 ** used to invoke this function. If the ordered-set aggregate notation is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5870 ** used on a function that lacks this flag, then an error is raised. Note
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5871 ** that the ordered-set aggregate syntax is only available if SQLite is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5872 ** built using the -DSQLITE_ENABLE_ORDERED_SET_AGGREGATES compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5873 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5874 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5875 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5876 #define SQLITE_DETERMINISTIC 0x000000800
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5877 #define SQLITE_DIRECTONLY 0x000080000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5878 #define SQLITE_SUBTYPE 0x000100000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5879 #define SQLITE_INNOCUOUS 0x000200000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5880 #define SQLITE_RESULT_SUBTYPE 0x001000000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5881 #define SQLITE_SELFORDER1 0x002000000
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5882
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5883 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5884 ** CAPI3REF: Deprecated Functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5885 ** DEPRECATED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5886 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5887 ** These functions are [deprecated]. In order to maintain
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5888 ** backwards compatibility with older code, these functions continue
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5889 ** to be supported. However, new applications should avoid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5890 ** the use of these functions. To encourage programmers to avoid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5891 ** these functions, we will not explain what they do.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5892 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5893 #ifndef SQLITE_OMIT_DEPRECATED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5894 SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5895 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5896 SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt, sqlite3_stmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5897 SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5898 SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5899 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void()(void,sqlite3_int64,int),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5900 void*,sqlite3_int64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5901 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5902
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5903 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5904 ** CAPI3REF: Obtaining SQL Values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5905 ** METHOD: sqlite3_value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5906 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5907 ** <b>Summary:</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5908 ** <blockquote><table border=0 cellpadding=0 cellspacing=0>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5909 ** <tr><td><b>sqlite3_value_blob</b><td>→<td>BLOB value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5910 ** <tr><td><b>sqlite3_value_double</b><td>→<td>REAL value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5911 ** <tr><td><b>sqlite3_value_int</b><td>→<td>32-bit INTEGER value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5912 ** <tr><td><b>sqlite3_value_int64</b><td>→<td>64-bit INTEGER value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5913 ** <tr><td><b>sqlite3_value_pointer</b><td>→<td>Pointer value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5914 ** <tr><td><b>sqlite3_value_text</b><td>→<td>UTF-8 TEXT value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5915 ** <tr><td><b>sqlite3_value_text16</b><td>→<td>UTF-16 TEXT value in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5916 ** the native byteorder
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5917 ** <tr><td><b>sqlite3_value_text16be</b><td>→<td>UTF-16be TEXT value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5918 ** <tr><td><b>sqlite3_value_text16le</b><td>→<td>UTF-16le TEXT value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5919 ** <tr><td> <td> <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5920 ** <tr><td><b>sqlite3_value_bytes</b><td>→<td>Size of a BLOB
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5921 ** or a UTF-8 TEXT in bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5922 ** <tr><td><b>sqlite3_value_bytes16  </b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5923 ** <td>→  <td>Size of UTF-16
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5924 ** TEXT in bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5925 ** <tr><td><b>sqlite3_value_type</b><td>→<td>Default
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5926 ** datatype of the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5927 ** <tr><td><b>sqlite3_value_numeric_type  </b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5928 ** <td>→  <td>Best numeric datatype of the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5929 ** <tr><td><b>sqlite3_value_nochange  </b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5930 ** <td>→  <td>True if the column is unchanged in an UPDATE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5931 ** against a virtual table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5932 ** <tr><td><b>sqlite3_value_frombind  </b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5933 ** <td>→  <td>True if value originated from a [bound parameter]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5934 ** </table></blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5935 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5936 ** <b>Details:</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5937 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5938 ** These routines extract type, size, and content information from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5939 ** [protected sqlite3_value] objects. Protected sqlite3_value objects
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5940 ** are used to pass parameter information into the functions that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5941 ** implement [application-defined SQL functions] and [virtual tables].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5942 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5943 ** These routines work only with [protected sqlite3_value] objects.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5944 ** Any attempt to use these routines on an [unprotected sqlite3_value]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5945 ** is not threadsafe.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5946 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5947 ** ^These routines work just like the corresponding [column access functions]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5948 ** except that these routines take a single [protected sqlite3_value] object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5949 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5950 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5951 ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5952 ** in the native byte-order of the host machine. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5953 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5954 ** extract UTF-16 strings as big-endian and little-endian respectively.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5955 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5956 ** ^If [sqlite3_value] object V was initialized
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5957 ** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5958 ** and if X and Y are strings that compare equal according to strcmp(X,Y),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5959 ** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5960 ** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5961 ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5962 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5963 ** ^(The sqlite3_value_type(V) interface returns the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5964 ** [SQLITE_INTEGER \| datatype code] for the initial datatype of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5965 ** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5966 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5967 ** Other interfaces might change the datatype for an sqlite3_value object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5968 ** For example, if the datatype is initially SQLITE_INTEGER and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5969 ** sqlite3_value_text(V) is called to extract a text value for that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5970 ** integer, then subsequent calls to sqlite3_value_type(V) might return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5971 ** SQLITE_TEXT. Whether or not a persistent internal datatype conversion
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5972 ** occurs is undefined and may change from one release of SQLite to the next.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5973 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5974 ** ^(The sqlite3_value_numeric_type() interface attempts to apply
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5975 ** numeric affinity to the value. This means that an attempt is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5976 ** made to convert the value to an integer or floating point. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5977 ** such a conversion is possible without loss of information (in other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5978 ** words, if the value is a string that looks like a number)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5979 ** then the conversion is performed. Otherwise no conversion occurs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5980 ** The [SQLITE_INTEGER \| datatype] after conversion is returned.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5981 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5982 ** ^Within the [xUpdate] method of a [virtual table], the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5983 ** sqlite3_value_nochange(X) interface returns true if and only if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5984 ** the column corresponding to X is unchanged by the UPDATE operation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5985 ** that the xUpdate method call was invoked to implement and if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5986 ** the prior [xColumn] method call that was invoked to extract
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5987 ** the value for that column returned without setting a result (probably
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5988 ** because it queried [sqlite3_vtab_nochange()] and found that the column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5989 ** was unchanging). ^Within an [xUpdate] method, any value for which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5990 ** sqlite3_value_nochange(X) is true will in all other respects appear
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5991 ** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5992 ** than within an [xUpdate] method call for an UPDATE statement, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5993 ** the return value is arbitrary and meaningless.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5994 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5995 ** ^The sqlite3_value_frombind(X) interface returns non-zero if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5996 ** value X originated from one of the [sqlite3_bind_int\|sqlite3_bind()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5997 ** interfaces. ^If X comes from an SQL literal value, or a table column,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5998 ** or an expression, then sqlite3_value_frombind(X) returns zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	5999 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6000 ** Please pay particular attention to the fact that the pointer returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6001 ** from [sqlite3_value_blob()], [sqlite3_value_text()], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6002 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6003 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6004 ** or [sqlite3_value_text16()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6005 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6006 ** These routines must be called from the same thread as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6007 ** the SQL function that supplied the [sqlite3_value*] parameters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6008 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6009 ** As long as the input parameter is correct, these routines can only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6010 ** fail if an out-of-memory error occurs during a format conversion.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6011 ** Only the following subset of interfaces are subject to out-of-memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6012 ** errors:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6013 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6014 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6015 ** <li> sqlite3_value_blob()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6016 ** <li> sqlite3_value_text()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6017 ** <li> sqlite3_value_text16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6018 ** <li> sqlite3_value_text16le()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6019 ** <li> sqlite3_value_text16be()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6020 ** <li> sqlite3_value_bytes()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6021 ** <li> sqlite3_value_bytes16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6022 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6023 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6024 ** If an out-of-memory error occurs, then the return value from these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6025 ** routines is the same as if the column had contained an SQL NULL value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6026 ** Valid SQL NULL returns can be distinguished from out-of-memory errors
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6027 ** by invoking the [sqlite3_errcode()] immediately after the suspect
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6028 ** return value is obtained and before any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6029 ** other SQLite interface is called on the same [database connection].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6030 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6031 SQLITE_API const void sqlite3_value_blob(sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6032 SQLITE_API double sqlite3_value_double(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6033 SQLITE_API int sqlite3_value_int(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6034 SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6035 SQLITE_API void sqlite3_value_pointer(sqlite3_value, const char*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6036 SQLITE_API const unsigned char sqlite3_value_text(sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6037 SQLITE_API const void sqlite3_value_text16(sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6038 SQLITE_API const void sqlite3_value_text16le(sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6039 SQLITE_API const void sqlite3_value_text16be(sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6040 SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6041 SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6042 SQLITE_API int sqlite3_value_type(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6043 SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6044 SQLITE_API int sqlite3_value_nochange(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6045 SQLITE_API int sqlite3_value_frombind(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6046
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6047 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6048 ** CAPI3REF: Report the internal text encoding state of an sqlite3_value object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6049 ** METHOD: sqlite3_value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6050 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6051 ** ^(The sqlite3_value_encoding(X) interface returns one of [SQLITE_UTF8],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6052 ** [SQLITE_UTF16BE], or [SQLITE_UTF16LE] according to the current text encoding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6053 ** of the value X, assuming that X has type TEXT.)^ If sqlite3_value_type(X)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6054 ** returns something other than SQLITE_TEXT, then the return value from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6055 ** sqlite3_value_encoding(X) is meaningless. ^Calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6056 ** [sqlite3_value_text(X)], [sqlite3_value_text16(X)], [sqlite3_value_text16be(X)],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6057 ** [sqlite3_value_text16le(X)], [sqlite3_value_bytes(X)], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6058 ** [sqlite3_value_bytes16(X)] might change the encoding of the value X and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6059 ** thus change the return from subsequent calls to sqlite3_value_encoding(X).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6060 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6061 ** This routine is intended for used by applications that test and validate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6062 ** the SQLite implementation. This routine is inquiring about the opaque
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6063 ** internal state of an [sqlite3_value] object. Ordinary applications should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6064 ** not need to know what the internal state of an sqlite3_value object is and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6065 ** hence should not need to use this interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6066 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6067 SQLITE_API int sqlite3_value_encoding(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6068
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6069 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6070 ** CAPI3REF: Finding The Subtype Of SQL Values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6071 ** METHOD: sqlite3_value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6072 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6073 ** The sqlite3_value_subtype(V) function returns the subtype for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6074 ** an [application-defined SQL function] argument V. The subtype
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6075 ** information can be used to pass a limited amount of context from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6076 ** one SQL function to another. Use the [sqlite3_result_subtype()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6077 ** routine to set the subtype for the return value of an SQL function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6078 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6079 ** Every [application-defined SQL function] that invokes this interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6080 ** should include the [SQLITE_SUBTYPE] property in the text
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6081 ** encoding argument when the function is [sqlite3_create_function\|registered].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6082 ** If the [SQLITE_SUBTYPE] property is omitted, then sqlite3_value_subtype()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6083 ** might return zero instead of the upstream subtype in some corner cases.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6084 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6085 SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6086
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6087 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6088 ** CAPI3REF: Copy And Free SQL Values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6089 ** METHOD: sqlite3_value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6090 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6091 ** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6092 ** object V and returns a pointer to that copy. ^The [sqlite3_value] returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6093 ** is a [protected sqlite3_value] object even if the input is not.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6094 ** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6095 ** memory allocation fails. ^If V is a [pointer value], then the result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6096 ** of sqlite3_value_dup(V) is a NULL value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6097 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6098 ** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6099 ** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6100 ** then sqlite3_value_free(V) is a harmless no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6101 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6102 SQLITE_API sqlite3_value sqlite3_value_dup(const sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6103 SQLITE_API void sqlite3_value_free(sqlite3_value*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6104
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6105 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6106 ** CAPI3REF: Obtain Aggregate Function Context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6107 ** METHOD: sqlite3_context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6108 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6109 ** Implementations of aggregate SQL functions use this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6110 ** routine to allocate memory for storing their state.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6111 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6112 ** ^The first time the sqlite3_aggregate_context(C,N) routine is called
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6113 ** for a particular aggregate function, SQLite allocates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6114 ** N bytes of memory, zeroes out that memory, and returns a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6115 ** to the new memory. ^On second and subsequent calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6116 ** sqlite3_aggregate_context() for the same aggregate function instance,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6117 ** the same buffer is returned. Sqlite3_aggregate_context() is normally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6118 ** called once for each invocation of the xStep callback and then one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6119 ** last time when the xFinal callback is invoked. ^(When no rows match
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6120 ** an aggregate query, the xStep() callback of the aggregate function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6121 ** implementation is never called and xFinal() is called exactly once.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6122 ** In those cases, sqlite3_aggregate_context() might be called for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6123 ** first time from within xFinal().)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6124 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6125 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6126 ** when first called if N is less than or equal to zero or if a memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6127 ** allocation error occurs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6128 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6129 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6130 ** determined by the N parameter on the first successful call. Changing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6131 ** value of N in any subsequent call to sqlite3_aggregate_context() within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6132 ** the same aggregate function instance will not resize the memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6133 ** allocation.)^ Within the xFinal callback, it is customary to set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6134 ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6135 ** pointless memory allocations occur.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6136 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6137 ** ^SQLite automatically frees the memory allocated by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6138 ** sqlite3_aggregate_context() when the aggregate query concludes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6139 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6140 ** The first parameter must be a copy of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6141 ** [sqlite3_context \| SQL function context] that is the first parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6142 ** to the xStep or xFinal callback routine that implements the aggregate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6143 ** function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6144 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6145 ** This routine must be called from the same thread in which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6146 ** the aggregate SQL function is running.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6147 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6148 SQLITE_API void sqlite3_aggregate_context(sqlite3_context, int nBytes);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6149
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6150 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6151 ** CAPI3REF: User Data For Functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6152 ** METHOD: sqlite3_context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6153 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6154 ** ^The sqlite3_user_data() interface returns a copy of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6155 ** the pointer that was the pUserData parameter (the 5th parameter)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6156 ** of the [sqlite3_create_function()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6157 ** and [sqlite3_create_function16()] routines that originally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6158 ** registered the application defined function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6159 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6160 ** This routine must be called from the same thread in which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6161 ** the application-defined function is running.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6162 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6163 SQLITE_API void sqlite3_user_data(sqlite3_context);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6164
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6165 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6166 ** CAPI3REF: Database Connection For Functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6167 ** METHOD: sqlite3_context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6168 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6169 ** ^The sqlite3_context_db_handle() interface returns a copy of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6170 ** the pointer to the [database connection] (the 1st parameter)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6171 ** of the [sqlite3_create_function()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6172 ** and [sqlite3_create_function16()] routines that originally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6173 ** registered the application defined function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6174 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6175 SQLITE_API sqlite3 sqlite3_context_db_handle(sqlite3_context);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6176
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6177 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6178 ** CAPI3REF: Function Auxiliary Data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6179 ** METHOD: sqlite3_context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6180 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6181 ** These functions may be used by (non-aggregate) SQL functions to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6182 ** associate auxiliary data with argument values. If the same argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6183 ** value is passed to multiple invocations of the same SQL function during
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6184 ** query execution, under some circumstances the associated auxiliary data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6185 ** might be preserved. An example of where this might be useful is in a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6186 ** regular-expression matching function. The compiled version of the regular
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6187 ** expression can be stored as auxiliary data associated with the pattern string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6188 ** Then as long as the pattern string remains the same,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6189 ** the compiled regular expression can be reused on multiple
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6190 ** invocations of the same function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6191 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6192 ** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the auxiliary data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6193 ** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6194 ** value to the application-defined function. ^N is zero for the left-most
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6195 ** function argument. ^If there is no auxiliary data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6196 ** associated with the function argument, the sqlite3_get_auxdata(C,N) interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6197 ** returns a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6198 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6199 ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as auxiliary data for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6200 ** N-th argument of the application-defined function. ^Subsequent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6201 ** calls to sqlite3_get_auxdata(C,N) return P from the most recent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6202 ** sqlite3_set_auxdata(C,N,P,X) call if the auxiliary data is still valid or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6203 ** NULL if the auxiliary data has been discarded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6204 ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6205 ** SQLite will invoke the destructor function X with parameter P exactly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6206 ** once, when the auxiliary data is discarded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6207 ** SQLite is free to discard the auxiliary data at any time, including: <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6208 ** <li> ^(when the corresponding function parameter changes)^, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6209 ** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6210 ** SQL statement)^, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6211 ** <li> ^(when sqlite3_set_auxdata() is invoked again on the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6212 ** parameter)^, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6213 ** <li> ^(during the original sqlite3_set_auxdata() call when a memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6214 ** allocation error occurs.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6215 ** <li> ^(during the original sqlite3_set_auxdata() call if the function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6216 ** is evaluated during query planning instead of during query execution,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6217 ** as sometimes happens with [SQLITE_ENABLE_STAT4].)^ </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6218 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6219 ** Note the last two bullets in particular. The destructor X in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6220 ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6221 ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6222 ** should be called near the end of the function implementation and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6223 ** function implementation should not make any use of P after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6224 ** sqlite3_set_auxdata() has been called. Furthermore, a call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6225 ** sqlite3_get_auxdata() that occurs immediately after a corresponding call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6226 ** to sqlite3_set_auxdata() might still return NULL if an out-of-memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6227 ** condition occurred during the sqlite3_set_auxdata() call or if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6228 ** function is being evaluated during query planning rather than during
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6229 ** query execution.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6230 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6231 ** ^(In practice, auxiliary data is preserved between function calls for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6232 ** function parameters that are compile-time constants, including literal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6233 ** values and [parameters] and expressions composed from the same.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6234 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6235 ** The value of the N parameter to these interfaces should be non-negative.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6236 ** Future enhancements may make use of negative N values to define new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6237 ** kinds of function caching behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6238 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6239 ** These routines must be called from the same thread in which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6240 ** the SQL function is running.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6241 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6242 ** See also: [sqlite3_get_clientdata()] and [sqlite3_set_clientdata()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6243 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6244 SQLITE_API void sqlite3_get_auxdata(sqlite3_context, int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6245 SQLITE_API void sqlite3_set_auxdata(sqlite3_context, int N, void, void ()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6246
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6247 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6248 ** CAPI3REF: Database Connection Client Data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6249 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6250 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6251 ** These functions are used to associate one or more named pointers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6252 ** with a [database connection].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6253 ** A call to sqlite3_set_clientdata(D,N,P,X) causes the pointer P
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6254 ** to be attached to [database connection] D using name N. Subsequent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6255 ** calls to sqlite3_get_clientdata(D,N) will return a copy of pointer P
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6256 ** or a NULL pointer if there were no prior calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6257 ** sqlite3_set_clientdata() with the same values of D and N.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6258 ** Names are compared using strcmp() and are thus case sensitive.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6259 ** It returns 0 on success and SQLITE_NOMEM on allocation failure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6260 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6261 ** If P and X are both non-NULL, then the destructor X is invoked with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6262 ** argument P on the first of the following occurrences:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6263 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6264 ** <li> An out-of-memory error occurs during the call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6265 ** sqlite3_set_clientdata() which attempts to register pointer P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6266 ** <li> A subsequent call to sqlite3_set_clientdata(D,N,P,X) is made
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6267 ** with the same D and N parameters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6268 ** <li> The database connection closes. SQLite does not make any guarantees
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6269 ** about the order in which destructors are called, only that all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6270 ** destructors will be called exactly once at some point during the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6271 ** database connection closing process.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6272 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6273 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6274 ** SQLite does not do anything with client data other than invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6275 ** destructors on the client data at the appropriate time. The intended
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6276 ** use for client data is to provide a mechanism for wrapper libraries
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6277 ** to store additional information about an SQLite database connection.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6278 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6279 ** There is no limit (other than available memory) on the number of different
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6280 ** client data pointers (with different names) that can be attached to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6281 ** single database connection. However, the implementation is optimized
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6282 ** for the case of having only one or two different client data names.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6283 ** Applications and wrapper libraries are discouraged from using more than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6284 ** one client data name each.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6285 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6286 ** There is no way to enumerate the client data pointers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6287 ** associated with a database connection. The N parameter can be thought
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6288 ** of as a secret key such that only code that knows the secret key is able
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6289 ** to access the associated data.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6290 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6291 ** Security Warning: These interfaces should not be exposed in scripting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6292 ** languages or in other circumstances where it might be possible for an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6293 ** attacker to invoke them. Any agent that can invoke these interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6294 ** can probably also take control of the process.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6295 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6296 ** Database connection client data is only available for SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6297 ** version 3.44.0 ([dateof:3.44.0]) and later.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6298 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6299 ** See also: [sqlite3_set_auxdata()] and [sqlite3_get_auxdata()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6300 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6301 SQLITE_API void sqlite3_get_clientdata(sqlite3,const char*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6302 SQLITE_API int sqlite3_set_clientdata(sqlite3, const char, void, void()(void*));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6303
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6304 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6305 ** CAPI3REF: Constants Defining Special Destructor Behavior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6306 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6307 ** These are special values for the destructor that is passed in as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6308 ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6309 ** argument is SQLITE_STATIC, it means that the content pointer is constant
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6310 ** and will never change. It does not need to be destroyed. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6311 ** SQLITE_TRANSIENT value means that the content will likely change in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6312 ** the near future and that SQLite should make its own private copy of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6313 ** the content before returning.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6314 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6315 ** The typedef is necessary to work around problems in certain
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6316 ** C++ compilers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6317 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6318 typedef void (sqlite3_destructor_type)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6319 #define SQLITE_STATIC ((sqlite3_destructor_type)0)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6320 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6321
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6322 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6323 ** CAPI3REF: Setting The Result Of An SQL Function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6324 ** METHOD: sqlite3_context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6325 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6326 ** These routines are used by the xFunc or xFinal callbacks that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6327 ** implement SQL functions and aggregates. See
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6328 ** [sqlite3_create_function()] and [sqlite3_create_function16()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6329 ** for additional information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6330 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6331 ** These functions work very much like the [parameter binding] family of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6332 ** functions used to bind values to host parameters in prepared statements.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6333 ** Refer to the [SQL parameter] documentation for additional information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6334 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6335 ** ^The sqlite3_result_blob() interface sets the result from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6336 ** an application-defined function to be the BLOB whose content is pointed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6337 ** to by the second parameter and which is N bytes long where N is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6338 ** third parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6339 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6340 ** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6341 ** interfaces set the result of the application-defined function to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6342 ** a BLOB containing all zero bytes and N bytes in size.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6343 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6344 ** ^The sqlite3_result_double() interface sets the result from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6345 ** an application-defined function to be a floating point value specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6346 ** by its 2nd argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6347 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6348 ** ^The sqlite3_result_error() and sqlite3_result_error16() functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6349 ** cause the implemented SQL function to throw an exception.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6350 ** ^SQLite uses the string pointed to by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6351 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6352 ** as the text of an error message. ^SQLite interprets the error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6353 ** message string from sqlite3_result_error() as UTF-8. ^SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6354 ** interprets the string from sqlite3_result_error16() as UTF-16 using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6355 ** the same [byte-order determination rules] as [sqlite3_bind_text16()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6356 ** ^If the third parameter to sqlite3_result_error()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6357 ** or sqlite3_result_error16() is negative then SQLite takes as the error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6358 ** message all text up through the first zero character.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6359 ** ^If the third parameter to sqlite3_result_error() or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6360 ** sqlite3_result_error16() is non-negative then SQLite takes that many
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6361 ** bytes (not characters) from the 2nd parameter as the error message.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6362 ** ^The sqlite3_result_error() and sqlite3_result_error16()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6363 ** routines make a private copy of the error message text before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6364 ** they return. Hence, the calling function can deallocate or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6365 ** modify the text after they return without harm.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6366 ** ^The sqlite3_result_error_code() function changes the error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6367 ** returned by SQLite as a result of an error in a function. ^By default,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6368 ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6369 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6370 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6371 ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6372 ** error indicating that a string or BLOB is too long to represent.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6373 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6374 ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6375 ** error indicating that a memory allocation failed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6376 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6377 ** ^The sqlite3_result_int() interface sets the return value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6378 ** of the application-defined function to be the 32-bit signed integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6379 ** value given in the 2nd argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6380 ** ^The sqlite3_result_int64() interface sets the return value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6381 ** of the application-defined function to be the 64-bit signed integer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6382 ** value given in the 2nd argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6383 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6384 ** ^The sqlite3_result_null() interface sets the return value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6385 ** of the application-defined function to be NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6386 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6387 ** ^The sqlite3_result_text(), sqlite3_result_text16(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6388 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6389 ** set the return value of the application-defined function to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6390 ** a text string which is represented as UTF-8, UTF-16 native byte order,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6391 ** UTF-16 little endian, or UTF-16 big endian, respectively.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6392 ** ^The sqlite3_result_text64() interface sets the return value of an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6393 ** application-defined function to be a text string in an encoding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6394 ** specified by the fifth (and last) parameter, which must be one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6395 ** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6396 ** ^SQLite takes the text result from the application from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6397 ** the 2nd parameter of the sqlite3_result_text* interfaces.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6398 ** ^If the 3rd parameter to any of the sqlite3_result_text* interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6399 ** other than sqlite3_result_text64() is negative, then SQLite computes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6400 ** the string length itself by searching the 2nd parameter for the first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6401 ** zero character.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6402 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6403 ** is non-negative, then as many bytes (not characters) of the text
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6404 ** pointed to by the 2nd parameter are taken as the application-defined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6405 ** function result. If the 3rd parameter is non-negative, then it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6406 ** must be the byte offset into the string where the NUL terminator would
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6407 ** appear if the string were NUL terminated. If any NUL characters occur
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6408 ** in the string at a byte offset that is less than the value of the 3rd
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6409 ** parameter, then the resulting string will contain embedded NULs and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6410 ** result of expressions operating on strings with embedded NULs is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6411 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6412 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6413 ** function as the destructor on the text or BLOB result when it has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6414 ** finished using that result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6415 ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6416 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6417 ** assumes that the text or BLOB result is in constant space and does not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6418 ** copy the content of the parameter nor call a destructor on the content
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6419 ** when it has finished using that result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6420 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6421 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6422 ** then SQLite makes a copy of the result into space obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6423 ** from [sqlite3_malloc()] before it returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6424 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6425 ** ^For the sqlite3_result_text16(), sqlite3_result_text16le(), and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6426 ** sqlite3_result_text16be() routines, and for sqlite3_result_text64()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6427 ** when the encoding is not UTF8, if the input UTF16 begins with a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6428 ** byte-order mark (BOM, U+FEFF) then the BOM is removed from the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6429 ** string and the rest of the string is interpreted according to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6430 ** byte-order specified by the BOM. ^The byte-order specified by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6431 ** the BOM at the beginning of the text overrides the byte-order
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6432 ** specified by the interface procedure. ^So, for example, if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6433 ** sqlite3_result_text16le() is invoked with text that begins
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6434 ** with bytes 0xfe, 0xff (a big-endian byte-order mark) then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6435 ** first two bytes of input are skipped and the remaining input
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6436 ** is interpreted as UTF16BE text.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6437 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6438 ** ^For UTF16 input text to the sqlite3_result_text16(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6439 ** sqlite3_result_text16be(), sqlite3_result_text16le(), and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6440 ** sqlite3_result_text64() routines, if the text contains invalid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6441 ** UTF16 characters, the invalid characters might be converted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6442 ** into the unicode replacement character, U+FFFD.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6443 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6444 ** ^The sqlite3_result_value() interface sets the result of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6445 ** the application-defined function to be a copy of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6446 ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6447 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6448 ** so that the [sqlite3_value] specified in the parameter may change or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6449 ** be deallocated after sqlite3_result_value() returns without harm.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6450 ** ^A [protected sqlite3_value] object may always be used where an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6451 ** [unprotected sqlite3_value] object is required, so either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6452 ** kind of [sqlite3_value] object can be used with this interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6453 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6454 ** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6455 ** SQL NULL value, just like [sqlite3_result_null(C)], except that it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6456 ** also associates the host-language pointer P or type T with that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6457 ** NULL value such that the pointer can be retrieved within an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6458 ** [application-defined SQL function] using [sqlite3_value_pointer()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6459 ** ^If the D parameter is not NULL, then it is a pointer to a destructor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6460 ** for the P parameter. ^SQLite invokes D with P as its only argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6461 ** when SQLite is finished with P. The T parameter should be a static
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6462 ** string and preferably a string literal. The sqlite3_result_pointer()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6463 ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6464 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6465 ** If these routines are called from within a different thread
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6466 ** than the one containing the application-defined function that received
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6467 ** the [sqlite3_context] pointer, the results are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6468 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6469 SQLITE_API void sqlite3_result_blob(sqlite3_context, const void, int, void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6470 SQLITE_API void sqlite3_result_blob64(sqlite3_context,const void,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6471 sqlite3_uint64,void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6472 SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6473 SQLITE_API void sqlite3_result_error(sqlite3_context, const char, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6474 SQLITE_API void sqlite3_result_error16(sqlite3_context, const void, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6475 SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6476 SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6477 SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6478 SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6479 SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6480 SQLITE_API void sqlite3_result_null(sqlite3_context*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6481 SQLITE_API void sqlite3_result_text(sqlite3_context, const char, int, void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6482 SQLITE_API void sqlite3_result_text64(sqlite3_context, const char,sqlite3_uint64,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6483 void()(void), unsigned char encoding);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6484 SQLITE_API void sqlite3_result_text16(sqlite3_context, const void, int, void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6485 SQLITE_API void sqlite3_result_text16le(sqlite3_context, const void, int,void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6486 SQLITE_API void sqlite3_result_text16be(sqlite3_context, const void, int,void()(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6487 SQLITE_API void sqlite3_result_value(sqlite3_context, sqlite3_value);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6488 SQLITE_API void sqlite3_result_pointer(sqlite3_context, void,const char,void()(void*));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6489 SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6490 SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6491
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6492
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6493 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6494 ** CAPI3REF: Setting The Subtype Of An SQL Function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6495 ** METHOD: sqlite3_context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6496 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6497 ** The sqlite3_result_subtype(C,T) function causes the subtype of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6498 ** the result from the [application-defined SQL function] with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6499 ** [sqlite3_context] C to be the value T. Only the lower 8 bits
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6500 ** of the subtype T are preserved in current versions of SQLite;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6501 ** higher order bits are discarded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6502 ** The number of subtype bytes preserved by SQLite might increase
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6503 ** in future releases of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6504 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6505 ** Every [application-defined SQL function] that invokes this interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6506 ** should include the [SQLITE_RESULT_SUBTYPE] property in its
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6507 ** text encoding argument when the SQL function is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6508 ** [sqlite3_create_function\|registered]. If the [SQLITE_RESULT_SUBTYPE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6509 ** property is omitted from the function that invokes sqlite3_result_subtype(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6510 ** then in some cases the sqlite3_result_subtype() might fail to set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6511 ** the result subtype.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6512 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6513 ** If SQLite is compiled with -DSQLITE_STRICT_SUBTYPE=1, then any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6514 ** SQL function that invokes the sqlite3_result_subtype() interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6515 ** and that does not have the SQLITE_RESULT_SUBTYPE property will raise
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6516 ** an error. Future versions of SQLite might enable -DSQLITE_STRICT_SUBTYPE=1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6517 ** by default.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6518 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6519 SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6520
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6521 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6522 ** CAPI3REF: Define New Collating Sequences
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6523 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6524 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6525 ** ^These functions add, remove, or modify a [collation] associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6526 ** with the [database connection] specified as the first argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6527 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6528 ** ^The name of the collation is a UTF-8 string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6529 ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6530 ** and a UTF-16 string in native byte order for sqlite3_create_collation16().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6531 ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6532 ** considered to be the same name.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6533 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6534 ** ^(The third argument (eTextRep) must be one of the constants:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6535 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6536 ** <li> [SQLITE_UTF8],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6537 ** <li> [SQLITE_UTF16LE],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6538 ** <li> [SQLITE_UTF16BE],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6539 ** <li> [SQLITE_UTF16], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6540 ** <li> [SQLITE_UTF16_ALIGNED].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6541 ** </ul>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6542 ** ^The eTextRep argument determines the encoding of strings passed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6543 ** to the collating function callback, xCompare.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6544 ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6545 ** force strings to be UTF16 with native byte order.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6546 ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6547 ** on an even byte address.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6548 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6549 ** ^The fourth argument, pArg, is an application data pointer that is passed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6550 ** through as the first argument to the collating function callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6551 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6552 ** ^The fifth argument, xCompare, is a pointer to the collating function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6553 ** ^Multiple collating functions can be registered using the same name but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6554 ** with different eTextRep parameters and SQLite will use whichever
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6555 ** function requires the least amount of data transformation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6556 ** ^If the xCompare argument is NULL then the collating function is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6557 ** deleted. ^When all collating functions having the same name are deleted,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6558 ** that collation is no longer usable.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6559 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6560 ** ^The collating function callback is invoked with a copy of the pArg
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6561 ** application data pointer and with two strings in the encoding specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6562 ** by the eTextRep argument. The two integer parameters to the collating
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6563 ** function callback are the length of the two strings, in bytes. The collating
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6564 ** function must return an integer that is negative, zero, or positive
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6565 ** if the first string is less than, equal to, or greater than the second,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6566 ** respectively. A collating function must always return the same answer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6567 ** given the same inputs. If two or more collating functions are registered
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6568 ** to the same collation name (using different eTextRep values) then all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6569 ** must give an equivalent answer when invoked with equivalent strings.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6570 ** The collating function must obey the following properties for all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6571 ** strings A, B, and C:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6572 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6573 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6574 ** <li> If A==B then B==A.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6575 ** <li> If A==B and B==C then A==C.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6576 ** <li> If A<B THEN B>A.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6577 ** <li> If A<B and B<C then A<C.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6578 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6579 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6580 ** If a collating function fails any of the above constraints and that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6581 ** collating function is registered and used, then the behavior of SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6582 ** is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6583 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6584 ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6585 ** with the addition that the xDestroy callback is invoked on pArg when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6586 ** the collating function is deleted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6587 ** ^Collating functions are deleted when they are overridden by later
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6588 ** calls to the collation creation functions or when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6589 ** [database connection] is closed using [sqlite3_close()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6590 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6591 ** ^The xDestroy callback is <u>not</u> called if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6592 ** sqlite3_create_collation_v2() function fails. Applications that invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6593 ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6594 ** check the return code and dispose of the application data pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6595 ** themselves rather than expecting SQLite to deal with it for them.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6596 ** This is different from every other SQLite interface. The inconsistency
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6597 ** is unfortunate but cannot be changed without breaking backwards
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6598 ** compatibility.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6599 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6600 ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6601 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6602 SQLITE_API int sqlite3_create_collation(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6603 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6604 const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6605 int eTextRep,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6606 void *pArg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6607 int(xCompare)(void,int,const void,int,const void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6608 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6609 SQLITE_API int sqlite3_create_collation_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6610 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6611 const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6612 int eTextRep,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6613 void *pArg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6614 int(xCompare)(void,int,const void,int,const void),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6615 void(xDestroy)(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6616 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6617 SQLITE_API int sqlite3_create_collation16(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6618 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6619 const void *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6620 int eTextRep,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6621 void *pArg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6622 int(xCompare)(void,int,const void,int,const void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6623 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6624
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6625 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6626 ** CAPI3REF: Collation Needed Callbacks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6627 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6628 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6629 ** ^To avoid having to register all collation sequences before a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6630 ** can be used, a single callback function may be registered with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6631 ** [database connection] to be invoked whenever an undefined collation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6632 ** sequence is required.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6633 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6634 ** ^If the function is registered using the sqlite3_collation_needed() API,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6635 ** then it is passed the names of undefined collation sequences as strings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6636 ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6637 ** the names are passed as UTF-16 in machine native byte order.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6638 ** ^A call to either function replaces the existing collation-needed callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6639 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6640 ** ^(When the callback is invoked, the first argument passed is a copy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6641 ** of the second argument to sqlite3_collation_needed() or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6642 ** sqlite3_collation_needed16(). The second argument is the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6643 ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6644 ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6645 ** sequence function required. The fourth parameter is the name of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6646 ** required collation sequence.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6647 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6648 ** The callback function should register the desired collation using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6649 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6650 ** [sqlite3_create_collation_v2()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6651 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6652 SQLITE_API int sqlite3_collation_needed(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6653 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6654 void*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6655 void()(void,sqlite3,int eTextRep,const char)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6656 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6657 SQLITE_API int sqlite3_collation_needed16(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6658 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6659 void*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6660 void()(void,sqlite3,int eTextRep,const void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6661 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6662
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6663 #ifdef SQLITE_ENABLE_CEROD
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6664 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6665 ** Specify the activation key for a CEROD database. Unless
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6666 ** activated, none of the CEROD routines will work.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6667 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6668 SQLITE_API void sqlite3_activate_cerod(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6669 const char zPassPhrase / Activation phrase */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6670 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6671 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6672
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6673 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6674 ** CAPI3REF: Suspend Execution For A Short Time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6675 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6676 ** The sqlite3_sleep() function causes the current thread to suspend execution
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6677 ** for at least a number of milliseconds specified in its parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6678 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6679 ** If the operating system does not support sleep requests with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6680 ** millisecond time resolution, then the time will be rounded up to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6681 ** the nearest second. The number of milliseconds of sleep actually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6682 ** requested from the operating system is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6683 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6684 ** ^SQLite implements this interface by calling the xSleep()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6685 ** method of the default [sqlite3_vfs] object. If the xSleep() method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6686 ** of the default VFS is not implemented correctly, or not implemented at
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6687 ** all, then the behavior of sqlite3_sleep() may deviate from the description
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6688 ** in the previous paragraphs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6689 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6690 ** If a negative argument is passed to sqlite3_sleep() the results vary by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6691 ** VFS and operating system. Some system treat a negative argument as an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6692 ** instruction to sleep forever. Others understand it to mean do not sleep
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6693 ** at all. ^In SQLite version 3.42.0 and later, a negative
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6694 ** argument passed into sqlite3_sleep() is changed to zero before it is relayed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6695 ** down into the xSleep method of the VFS.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6696 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6697 SQLITE_API int sqlite3_sleep(int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6698
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6699 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6700 ** CAPI3REF: Name Of The Folder Holding Temporary Files
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6701 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6702 ** ^(If this global variable is made to point to a string which is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6703 ** the name of a folder (a.k.a. directory), then all temporary files
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6704 ** created by SQLite when using a built-in [sqlite3_vfs \| VFS]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6705 ** will be placed in that directory.)^ ^If this variable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6706 ** is a NULL pointer, then SQLite performs a search for an appropriate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6707 ** temporary file directory.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6708 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6709 ** Applications are strongly discouraged from using this global variable.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6710 ** It is required to set a temporary folder on Windows Runtime (WinRT).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6711 ** But for all other platforms, it is highly recommended that applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6712 ** neither read nor write this variable. This global variable is a relic
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6713 ** that exists for backwards compatibility of legacy applications and should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6714 ** be avoided in new projects.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6715 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6716 ** It is not safe to read or modify this variable in more than one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6717 ** thread at a time. It is not safe to read or modify this variable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6718 ** if a [database connection] is being used at the same time in a separate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6719 ** thread.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6720 ** It is intended that this variable be set once
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6721 ** as part of process initialization and before any SQLite interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6722 ** routines have been called and that this variable remain unchanged
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6723 ** thereafter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6724 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6725 ** ^The [temp_store_directory pragma] may modify this variable and cause
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6726 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6727 ** the [temp_store_directory pragma] always assumes that any string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6728 ** that this variable points to is held in memory obtained from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6729 ** [sqlite3_malloc] and the pragma may attempt to free that memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6730 ** using [sqlite3_free].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6731 ** Hence, if this variable is modified directly, either it should be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6732 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6733 ** or else the use of the [temp_store_directory pragma] should be avoided.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6734 ** Except when requested by the [temp_store_directory pragma], SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6735 ** does not free the memory that sqlite3_temp_directory points to. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6736 ** the application wants that memory to be freed, it must do
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6737 ** so itself, taking care to only do so after all [database connection]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6738 ** objects have been destroyed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6739 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6740 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6741 ** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6742 ** features that require the use of temporary files may fail. Here is an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6743 ** example of how to do this using C++ with the Windows Runtime:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6744 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6745 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6746 ** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6747 **   TemporaryFolder->Path->Data();
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6748 ** char zPathBuf[MAX_PATH + 1];
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6749 ** memset(zPathBuf, 0, sizeof(zPathBuf));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6750 ** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6751 **   NULL, NULL);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6752 ** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6753 ** </pre></blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6754 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6755 SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6756
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6757 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6758 ** CAPI3REF: Name Of The Folder Holding Database Files
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6759 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6760 ** ^(If this global variable is made to point to a string which is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6761 ** the name of a folder (a.k.a. directory), then all database files
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6762 ** specified with a relative pathname and created or accessed by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6763 ** SQLite when using a built-in windows [sqlite3_vfs \| VFS] will be assumed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6764 ** to be relative to that directory.)^ ^If this variable is a NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6765 ** pointer, then SQLite assumes that all database files specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6766 ** with a relative pathname are relative to the current directory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6767 ** for the process. Only the windows VFS makes use of this global
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6768 ** variable; it is ignored by the unix VFS.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6769 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6770 ** Changing the value of this variable while a database connection is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6771 ** open can result in a corrupt database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6772 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6773 ** It is not safe to read or modify this variable in more than one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6774 ** thread at a time. It is not safe to read or modify this variable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6775 ** if a [database connection] is being used at the same time in a separate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6776 ** thread.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6777 ** It is intended that this variable be set once
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6778 ** as part of process initialization and before any SQLite interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6779 ** routines have been called and that this variable remain unchanged
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6780 ** thereafter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6781 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6782 ** ^The [data_store_directory pragma] may modify this variable and cause
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6783 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6784 ** the [data_store_directory pragma] always assumes that any string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6785 ** that this variable points to is held in memory obtained from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6786 ** [sqlite3_malloc] and the pragma may attempt to free that memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6787 ** using [sqlite3_free].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6788 ** Hence, if this variable is modified directly, either it should be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6789 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6790 ** or else the use of the [data_store_directory pragma] should be avoided.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6791 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6792 SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6793
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6794 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6795 ** CAPI3REF: Win32 Specific Interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6796 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6797 ** These interfaces are available only on Windows. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6798 ** [sqlite3_win32_set_directory] interface is used to set the value associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6799 ** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6800 ** zValue, depending on the value of the type parameter. The zValue parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6801 ** should be NULL to cause the previous value to be freed via [sqlite3_free];
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6802 ** a non-NULL value will be copied into memory obtained from [sqlite3_malloc]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6803 ** prior to being used. The [sqlite3_win32_set_directory] interface returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6804 ** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6805 ** or [SQLITE_NOMEM] if memory could not be allocated. The value of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6806 ** [sqlite3_data_directory] variable is intended to act as a replacement for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6807 ** the current directory on the sub-platforms of Win32 where that concept is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6808 ** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6809 ** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6810 ** sqlite3_win32_set_directory interface except the string parameter must be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6811 ** UTF-8 or UTF-16, respectively.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6812 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6813 SQLITE_API int sqlite3_win32_set_directory(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6814 unsigned long type, /* Identifier for directory being set or reset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6815 void zValue / New value for directory being set or reset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6816 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6817 SQLITE_API int sqlite3_win32_set_directory8(unsigned long type, const char *zValue);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6818 SQLITE_API int sqlite3_win32_set_directory16(unsigned long type, const void *zValue);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6819
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6820 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6821 ** CAPI3REF: Win32 Directory Types
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6822 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6823 ** These macros are only available on Windows. They define the allowed values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6824 ** for the type argument to the [sqlite3_win32_set_directory] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6825 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6826 #define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6827 #define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6828
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6829 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6830 ** CAPI3REF: Test For Auto-Commit Mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6831 ** KEYWORDS: {autocommit mode}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6832 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6833 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6834 ** ^The sqlite3_get_autocommit() interface returns non-zero or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6835 ** zero if the given database connection is or is not in autocommit mode,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6836 ** respectively. ^Autocommit mode is on by default.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6837 ** ^Autocommit mode is disabled by a [BEGIN] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6838 ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6839 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6840 ** If certain kinds of errors occur on a statement within a multi-statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6841 ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6842 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6843 ** transaction might be rolled back automatically. The only way to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6844 ** find out whether SQLite automatically rolled back the transaction after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6845 ** an error is to use this function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6846 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6847 ** If another thread changes the autocommit status of the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6848 ** connection while this routine is running, then the return value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6849 ** is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6850 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6851 SQLITE_API int sqlite3_get_autocommit(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6852
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6853 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6854 ** CAPI3REF: Find The Database Handle Of A Prepared Statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6855 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6856 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6857 ** ^The sqlite3_db_handle interface returns the [database connection] handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6858 ** to which a [prepared statement] belongs. ^The [database connection]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6859 ** returned by sqlite3_db_handle is the same [database connection]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6860 ** that was the first argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6861 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6862 ** create the statement in the first place.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6863 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6864 SQLITE_API sqlite3 sqlite3_db_handle(sqlite3_stmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6865
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6866 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6867 ** CAPI3REF: Return The Schema Name For A Database Connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6868 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6869 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6870 ** ^The sqlite3_db_name(D,N) interface returns a pointer to the schema name
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6871 ** for the N-th database on database connection D, or a NULL pointer if N is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6872 ** out of range. An N value of 0 means the main database file. An N of 1 is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6873 ** the "temp" schema. Larger values of N correspond to various ATTACH-ed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6874 ** databases.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6875 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6876 ** Space to hold the string that is returned by sqlite3_db_name() is managed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6877 ** by SQLite itself. The string might be deallocated by any operation that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6878 ** changes the schema, including [ATTACH] or [DETACH] or calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6879 ** [sqlite3_serialize()] or [sqlite3_deserialize()], even operations that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6880 ** occur on a different thread. Applications that need to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6881 ** remember the string long-term should make their own copy. Applications that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6882 ** are accessing the same database connection simultaneously on multiple
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6883 ** threads should mutex-protect calls to this API and should make their own
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6884 ** private copy of the result prior to releasing the mutex.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6885 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6886 SQLITE_API const char sqlite3_db_name(sqlite3 db, int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6887
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6888 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6889 ** CAPI3REF: Return The Filename For A Database Connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6890 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6891 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6892 ** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6893 ** associated with database N of connection D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6894 ** ^If there is no attached database N on the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6895 ** connection D, or if database N is a temporary or in-memory database, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6896 ** this function will return either a NULL pointer or an empty string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6897 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6898 ** ^The string value returned by this routine is owned and managed by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6899 ** the database connection. ^The value will be valid until the database N
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6900 ** is [DETACH]-ed or until the database connection closes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6901 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6902 ** ^The filename returned by this function is the output of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6903 ** xFullPathname method of the [VFS]. ^In other words, the filename
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6904 ** will be an absolute pathname, even if the filename used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6905 ** to open the database originally was a URI or relative pathname.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6906 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6907 ** If the filename pointer returned by this routine is not NULL, then it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6908 ** can be used as the filename input parameter to these routines:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6909 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6910 ** <li> [sqlite3_uri_parameter()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6911 ** <li> [sqlite3_uri_boolean()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6912 ** <li> [sqlite3_uri_int64()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6913 ** <li> [sqlite3_filename_database()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6914 ** <li> [sqlite3_filename_journal()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6915 ** <li> [sqlite3_filename_wal()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6916 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6917 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6918 SQLITE_API sqlite3_filename sqlite3_db_filename(sqlite3 db, const char zDbName);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6919
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6920 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6921 ** CAPI3REF: Determine if a database is read-only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6922 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6923 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6924 ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6925 ** of connection D is read-only, 0 if it is read/write, or -1 if N is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6926 ** the name of a database on connection D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6927 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6928 SQLITE_API int sqlite3_db_readonly(sqlite3 db, const char zDbName);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6929
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6930 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6931 ** CAPI3REF: Determine the transaction state of a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6932 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6933 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6934 ** ^The sqlite3_txn_state(D,S) interface returns the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6935 ** [transaction state] of schema S in database connection D. ^If S is NULL,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6936 ** then the highest transaction state of any schema on database connection D
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6937 ** is returned. Transaction states are (in order of lowest to highest):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6938 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6939 ** <li value="0"> SQLITE_TXN_NONE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6940 ** <li value="1"> SQLITE_TXN_READ
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6941 ** <li value="2"> SQLITE_TXN_WRITE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6942 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6943 ** ^If the S argument to sqlite3_txn_state(D,S) is not the name of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6944 ** a valid schema, then -1 is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6945 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6946 SQLITE_API int sqlite3_txn_state(sqlite3,const char zSchema);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6947
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6948 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6949 ** CAPI3REF: Allowed return values from sqlite3_txn_state()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6950 ** KEYWORDS: {transaction state}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6951 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6952 ** These constants define the current transaction state of a database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6953 ** ^The [sqlite3_txn_state(D,S)] interface returns one of these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6954 ** constants in order to describe the transaction state of schema S
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6955 ** in [database connection] D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6956 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6957 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6958 ** [[SQLITE_TXN_NONE]] <dt>SQLITE_TXN_NONE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6959 ** <dd>The SQLITE_TXN_NONE state means that no transaction is currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6960 ** pending.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6961 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6962 ** [[SQLITE_TXN_READ]] <dt>SQLITE_TXN_READ</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6963 ** <dd>The SQLITE_TXN_READ state means that the database is currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6964 ** in a read transaction. Content has been read from the database file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6965 ** but nothing in the database file has changed. The transaction state
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6966 ** will be advanced to SQLITE_TXN_WRITE if any changes occur and there are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6967 ** no other conflicting concurrent write transactions. The transaction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6968 ** state will revert to SQLITE_TXN_NONE following a [ROLLBACK] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6969 ** [COMMIT].</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6970 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6971 ** [[SQLITE_TXN_WRITE]] <dt>SQLITE_TXN_WRITE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6972 ** <dd>The SQLITE_TXN_WRITE state means that the database is currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6973 ** in a write transaction. Content has been written to the database file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6974 ** but has not yet committed. The transaction state will change to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6975 ** SQLITE_TXN_NONE at the next [ROLLBACK] or [COMMIT].</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6976 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6977 #define SQLITE_TXN_NONE 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6978 #define SQLITE_TXN_READ 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6979 #define SQLITE_TXN_WRITE 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6980
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6981 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6982 ** CAPI3REF: Find the next prepared statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6983 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6984 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6985 ** ^This interface returns a pointer to the next [prepared statement] after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6986 ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6987 ** then this interface returns a pointer to the first prepared statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6988 ** associated with the database connection pDb. ^If no prepared statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6989 ** satisfies the conditions of this routine, it returns NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6990 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6991 ** The [database connection] pointer D in a call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6992 ** [sqlite3_next_stmt(D,S)] must refer to an open database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6993 ** connection and in particular must not be a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6994 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6995 SQLITE_API sqlite3_stmt sqlite3_next_stmt(sqlite3 pDb, sqlite3_stmt *pStmt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6996
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6997 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6998 ** CAPI3REF: Commit And Rollback Notification Callbacks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	6999 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7000 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7001 ** ^The sqlite3_commit_hook() interface registers a callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7002 ** function to be invoked whenever a transaction is [COMMIT \| committed].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7003 ** ^Any callback set by a previous call to sqlite3_commit_hook()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7004 ** for the same database connection is overridden.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7005 ** ^The sqlite3_rollback_hook() interface registers a callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7006 ** function to be invoked whenever a transaction is [ROLLBACK \| rolled back].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7007 ** ^Any callback set by a previous call to sqlite3_rollback_hook()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7008 ** for the same database connection is overridden.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7009 ** ^The pArg argument is passed through to the callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7010 ** ^If the callback on a commit hook function returns non-zero,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7011 ** then the commit is converted into a rollback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7012 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7013 ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7014 ** return the P argument from the previous call of the same function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7015 ** on the same [database connection] D, or NULL for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7016 ** the first call for each function on D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7017 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7018 ** The commit and rollback hook callbacks are not reentrant.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7019 ** The callback implementation must not do anything that will modify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7020 ** the database connection that invoked the callback. Any actions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7021 ** to modify the database connection must be deferred until after the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7022 ** completion of the [sqlite3_step()] call that triggered the commit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7023 ** or rollback hook in the first place.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7024 ** Note that running any other SQL statements, including SELECT statements,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7025 ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7026 ** the database connections for the meaning of "modify" in this paragraph.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7027 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7028 ** ^Registering a NULL function disables the callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7029 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7030 ** ^When the commit hook callback routine returns zero, the [COMMIT]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7031 ** operation is allowed to continue normally. ^If the commit hook
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7032 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7033 ** ^The rollback hook is invoked on a rollback that results from a commit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7034 ** hook returning non-zero, just as it would be with any other rollback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7035 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7036 ** ^For the purposes of this API, a transaction is said to have been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7037 ** rolled back if an explicit "ROLLBACK" statement is executed, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7038 ** an error or constraint causes an implicit rollback to occur.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7039 ** ^The rollback callback is not invoked if a transaction is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7040 ** automatically rolled back because the database connection is closed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7041 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7042 ** See also the [sqlite3_update_hook()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7043 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7044 SQLITE_API void sqlite3_commit_hook(sqlite3, int()(void), void*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7045 SQLITE_API void sqlite3_rollback_hook(sqlite3, void()(void ), void*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7046
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7047 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7048 ** CAPI3REF: Autovacuum Compaction Amount Callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7049 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7050 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7051 ** ^The sqlite3_autovacuum_pages(D,C,P,X) interface registers a callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7052 ** function C that is invoked prior to each autovacuum of the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7053 ** file. ^The callback is passed a copy of the generic data pointer (P),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7054 ** the schema-name of the attached database that is being autovacuumed,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7055 ** the size of the database file in pages, the number of free pages,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7056 ** and the number of bytes per page, respectively. The callback should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7057 ** return the number of free pages that should be removed by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7058 ** autovacuum. ^If the callback returns zero, then no autovacuum happens.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7059 ** ^If the value returned is greater than or equal to the number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7060 ** free pages, then a complete autovacuum happens.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7061 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7062 ** <p>^If there are multiple ATTACH-ed database files that are being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7063 ** modified as part of a transaction commit, then the autovacuum pages
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7064 ** callback is invoked separately for each file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7065 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7066 ** <p><b>The callback is not reentrant.</b> The callback function should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7067 ** not attempt to invoke any other SQLite interface. If it does, bad
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7068 ** things may happen, including segmentation faults and corrupt database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7069 ** files. The callback function should be a simple function that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7070 ** does some arithmetic on its input parameters and returns a result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7071 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7072 ** ^The X parameter to sqlite3_autovacuum_pages(D,C,P,X) is an optional
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7073 ** destructor for the P parameter. ^If X is not NULL, then X(P) is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7074 ** invoked whenever the database connection closes or when the callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7075 ** is overwritten by another invocation of sqlite3_autovacuum_pages().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7076 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7077 ** <p>^There is only one autovacuum pages callback per database connection.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7078 ** ^Each call to the sqlite3_autovacuum_pages() interface overrides all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7079 ** previous invocations for that database connection. ^If the callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7080 ** argument (C) to sqlite3_autovacuum_pages(D,C,P,X) is a NULL pointer,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7081 ** then the autovacuum steps callback is canceled. The return value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7082 ** from sqlite3_autovacuum_pages() is normally SQLITE_OK, but might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7083 ** be some other error code if something goes wrong. The current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7084 ** implementation will only return SQLITE_OK or SQLITE_MISUSE, but other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7085 ** return codes might be added in future releases.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7086 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7087 ** <p>If no autovacuum pages callback is specified (the usual case) or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7088 ** a NULL pointer is provided for the callback,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7089 ** then the default behavior is to vacuum all free pages. So, in other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7090 ** words, the default behavior is the same as if the callback function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7091 ** were something like this:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7092 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7093 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7094 **   unsigned int demonstration_autovac_pages_callback(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7095 **   void *pClientData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7096 **   const char *zSchema,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7097 **   unsigned int nDbPage,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7098 **   unsigned int nFreePage,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7099 **   unsigned int nBytePerPage
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7100 **   ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7101 **   return nFreePage;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7102 **   }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7103 ** </pre></blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7104 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7105 SQLITE_API int sqlite3_autovacuum_pages(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7106 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7107 unsigned int()(void,const char*,unsigned int,unsigned int,unsigned int),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7108 void*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7109 void()(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7110 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7111
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7112
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7113 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7114 ** CAPI3REF: Data Change Notification Callbacks
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7115 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7116 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7117 ** ^The sqlite3_update_hook() interface registers a callback function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7118 ** with the [database connection] identified by the first argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7119 ** to be invoked whenever a row is updated, inserted or deleted in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7120 ** a [rowid table].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7121 ** ^Any callback set by a previous call to this function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7122 ** for the same database connection is overridden.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7123 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7124 ** ^The second argument is a pointer to the function to invoke when a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7125 ** row is updated, inserted or deleted in a rowid table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7126 ** ^The update hook is disabled by invoking sqlite3_update_hook()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7127 ** with a NULL pointer as the second parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7128 ** ^The first argument to the callback is a copy of the third argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7129 ** to sqlite3_update_hook().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7130 ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7131 ** or [SQLITE_UPDATE], depending on the operation that caused the callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7132 ** to be invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7133 ** ^The third and fourth arguments to the callback contain pointers to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7134 ** database and table name containing the affected row.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7135 ** ^The final callback parameter is the [rowid] of the row.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7136 ** ^In the case of an update, this is the [rowid] after the update takes place.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7137 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7138 ** ^(The update hook is not invoked when internal system tables are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7139 ** modified (i.e. sqlite_sequence).)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7140 ** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7141 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7142 ** ^In the current implementation, the update hook
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7143 ** is not invoked when conflicting rows are deleted because of an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7144 ** [ON CONFLICT \| ON CONFLICT REPLACE] clause. ^Nor is the update hook
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7145 ** invoked when rows are deleted using the [truncate optimization].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7146 ** The exceptions defined in this paragraph might change in a future
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7147 ** release of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7148 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7149 ** Whether the update hook is invoked before or after the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7150 ** corresponding change is currently unspecified and may differ
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7151 ** depending on the type of change. Do not rely on the order of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7152 ** hook call with regards to the final result of the operation which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7153 ** triggers the hook.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7154 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7155 ** The update hook implementation must not do anything that will modify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7156 ** the database connection that invoked the update hook. Any actions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7157 ** to modify the database connection must be deferred until after the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7158 ** completion of the [sqlite3_step()] call that triggered the update hook.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7159 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7160 ** database connections for the meaning of "modify" in this paragraph.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7161 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7162 ** ^The sqlite3_update_hook(D,C,P) function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7163 ** returns the P argument from the previous call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7164 ** on the same [database connection] D, or NULL for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7165 ** the first call on D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7166 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7167 ** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7168 ** and [sqlite3_preupdate_hook()] interfaces.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7169 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7170 SQLITE_API void *sqlite3_update_hook(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7171 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7172 void()(void ,int ,char const ,char const ,sqlite3_int64),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7173 void*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7174 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7175
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7176 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7177 ** CAPI3REF: Enable Or Disable Shared Pager Cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7178 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7179 ** ^(This routine enables or disables the sharing of the database cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7180 ** and schema data structures between [database connection \| connections]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7181 ** to the same database. Sharing is enabled if the argument is true
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7182 ** and disabled if the argument is false.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7183 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7184 ** This interface is omitted if SQLite is compiled with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7185 ** [-DSQLITE_OMIT_SHARED_CACHE]. The [-DSQLITE_OMIT_SHARED_CACHE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7186 ** compile-time option is recommended because the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7187 ** [use of shared cache mode is discouraged].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7188 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7189 ** ^Cache sharing is enabled and disabled for an entire process.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7190 ** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7191 ** In prior versions of SQLite,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7192 ** sharing was enabled or disabled for each thread separately.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7193 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7194 ** ^(The cache sharing mode set by this interface effects all subsequent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7195 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7196 ** Existing database connections continue to use the sharing mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7197 ** that was in effect at the time they were opened.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7198 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7199 ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7200 ** successfully. An [error code] is returned otherwise.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7201 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7202 ** ^Shared cache is disabled by default. It is recommended that it stay
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7203 ** that way. In other words, do not use this routine. This interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7204 ** continues to be provided for historical compatibility, but its use is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7205 ** discouraged. Any use of shared cache is discouraged. If shared cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7206 ** must be used, it is recommended that shared cache only be enabled for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7207 ** individual database connections using the [sqlite3_open_v2()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7208 ** with the [SQLITE_OPEN_SHAREDCACHE] flag.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7209 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7210 ** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7211 ** and will always return SQLITE_MISUSE. On those systems,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7212 ** shared cache mode should be enabled per-database connection via
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7213 ** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7214 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7215 ** This interface is threadsafe on processors where writing a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7216 ** 32-bit integer is atomic.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7217 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7218 ** See Also: [SQLite Shared-Cache Mode]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7219 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7220 SQLITE_API int sqlite3_enable_shared_cache(int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7221
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7222 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7223 ** CAPI3REF: Attempt To Free Heap Memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7224 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7225 ** ^The sqlite3_release_memory() interface attempts to free N bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7226 ** of heap memory by deallocating non-essential memory allocations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7227 ** held by the database library. Memory used to cache database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7228 ** pages to improve performance is an example of non-essential memory.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7229 ** ^sqlite3_release_memory() returns the number of bytes actually freed,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7230 ** which might be more or less than the amount requested.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7231 ** ^The sqlite3_release_memory() routine is a no-op returning zero
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7232 ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7233 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7234 ** See also: [sqlite3_db_release_memory()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7235 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7236 SQLITE_API int sqlite3_release_memory(int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7237
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7238 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7239 ** CAPI3REF: Free Memory Used By A Database Connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7240 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7241 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7242 ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7243 ** memory as possible from database connection D. Unlike the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7244 ** [sqlite3_release_memory()] interface, this interface is in effect even
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7245 ** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7246 ** omitted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7247 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7248 ** See also: [sqlite3_release_memory()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7249 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7250 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7251
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7252 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7253 ** CAPI3REF: Impose A Limit On Heap Size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7254 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7255 ** These interfaces impose limits on the amount of heap memory that will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7256 ** used by all database connections within a single process.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7257 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7258 ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7259 ** soft limit on the amount of heap memory that may be allocated by SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7260 ** ^SQLite strives to keep heap memory utilization below the soft heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7261 ** limit by reducing the number of pages held in the page cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7262 ** as heap memory usages approaches the limit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7263 ** ^The soft heap limit is "soft" because even though SQLite strives to stay
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7264 ** below the limit, it will exceed the limit rather than generate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7265 ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7266 ** is advisory only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7267 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7268 ** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7269 ** N bytes on the amount of memory that will be allocated. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7270 ** sqlite3_hard_heap_limit64(N) interface is similar to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7271 ** sqlite3_soft_heap_limit64(N) except that memory allocations will fail
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7272 ** when the hard heap limit is reached.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7273 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7274 ** ^The return value from both sqlite3_soft_heap_limit64() and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7275 ** sqlite3_hard_heap_limit64() is the size of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7276 ** the heap limit prior to the call, or negative in the case of an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7277 ** error. ^If the argument N is negative
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7278 ** then no change is made to the heap limit. Hence, the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7279 ** size of heap limits can be determined by invoking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7280 ** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7281 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7282 ** ^Setting the heap limits to zero disables the heap limiter mechanism.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7283 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7284 ** ^The soft heap limit may not be greater than the hard heap limit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7285 ** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7286 ** is invoked with a value of N that is greater than the hard heap limit,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7287 ** the soft heap limit is set to the value of the hard heap limit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7288 ** ^The soft heap limit is automatically enabled whenever the hard heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7289 ** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7290 ** the soft heap limit is outside the range of 1..N, then the soft heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7291 ** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7292 ** hard heap limit is enabled makes the soft heap limit equal to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7293 ** hard heap limit.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7294 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7295 ** The memory allocation limits can also be adjusted using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7296 ** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7297 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7298 ** ^(The heap limits are not enforced in the current implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7299 ** if one or more of following conditions are true:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7300 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7301 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7302 ** <li> The limit value is set to zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7303 ** <li> Memory accounting is disabled using a combination of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7304 ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7305 ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7306 ** <li> An alternative page cache implementation is specified using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7307 ** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7308 ** <li> The page cache allocates from its own memory pool supplied
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7309 ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7310 ** from the heap.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7311 ** </ul>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7312 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7313 ** The circumstances under which SQLite will enforce the heap limits may
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7314 ** change in future releases of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7315 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7316 SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7317 SQLITE_API sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7318
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7319 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7320 ** CAPI3REF: Deprecated Soft Heap Limit Interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7321 ** DEPRECATED
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7322 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7323 ** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7324 ** interface. This routine is provided for historical compatibility
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7325 ** only. All new applications should use the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7326 ** [sqlite3_soft_heap_limit64()] interface rather than this one.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7327 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7328 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7329
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7330
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7331 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7332 ** CAPI3REF: Extract Metadata About A Column Of A Table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7333 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7334 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7335 ** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7336 ** information about column C of table T in database D
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7337 ** on [database connection] X.)^ ^The sqlite3_table_column_metadata()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7338 ** interface returns SQLITE_OK and fills in the non-NULL pointers in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7339 ** the final five arguments with appropriate values if the specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7340 ** column exists. ^The sqlite3_table_column_metadata() interface returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7341 ** SQLITE_ERROR if the specified column does not exist.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7342 ** ^If the column-name parameter to sqlite3_table_column_metadata() is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7343 ** NULL pointer, then this routine simply checks for the existence of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7344 ** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7345 ** does not. If the table name parameter T in a call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7346 ** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7347 ** undefined behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7348 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7349 ** ^The column is identified by the second, third and fourth parameters to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7350 ** this function. ^(The second parameter is either the name of the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7351 ** (i.e. "main", "temp", or an attached database) containing the specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7352 ** table or NULL.)^ ^If it is NULL, then all attached databases are searched
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7353 ** for the table using the same algorithm used by the database engine to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7354 ** resolve unqualified table references.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7355 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7356 ** ^The third and fourth parameters to this function are the table and column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7357 ** name of the desired column, respectively.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7358 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7359 ** ^Metadata is returned by writing to the memory locations passed as the 5th
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7360 ** and subsequent parameters to this function. ^Any of these arguments may be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7361 ** NULL, in which case the corresponding element of metadata is omitted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7362 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7363 ** ^(<blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7364 ** <table border="1">
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7365 ** <tr><th> Parameter <th> Output<br>Type <th> Description
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7366 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7367 ** <tr><td> 5th <td> const char* <td> Data type
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7368 ** <tr><td> 6th <td> const char* <td> Name of default collation sequence
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7369 ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7370 ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7371 ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7372 ** </table>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7373 ** </blockquote>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7374 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7375 ** ^The memory pointed to by the character pointers returned for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7376 ** declaration type and collation sequence is valid until the next
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7377 ** call to any SQLite API function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7378 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7379 ** ^If the specified table is actually a view, an [error code] is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7380 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7381 ** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7382 ** is not a [WITHOUT ROWID] table and an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7383 ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7384 ** parameters are set for the explicitly declared column. ^(If there is no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7385 ** [INTEGER PRIMARY KEY] column, then the outputs
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7386 ** for the [rowid] are set as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7387 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7388 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7389 ** data type: "INTEGER"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7390 ** collation sequence: "BINARY"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7391 ** not null: 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7392 ** primary key: 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7393 ** auto increment: 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7394 ** </pre>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7395 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7396 ** ^This function causes all database schemas to be read from disk and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7397 ** parsed, if that has not already been done, and returns an error if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7398 ** any errors are encountered while loading the schema.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7399 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7400 SQLITE_API int sqlite3_table_column_metadata(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7401 sqlite3 db, / Connection handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7402 const char zDbName, / Database name or NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7403 const char zTableName, / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7404 const char zColumnName, / Column name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7405 char const *pzDataType, / OUTPUT: Declared data type */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7406 char const *pzCollSeq, / OUTPUT: Collation sequence name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7407 int pNotNull, / OUTPUT: True if NOT NULL constraint exists */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7408 int pPrimaryKey, / OUTPUT: True if column part of PK */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7409 int pAutoinc / OUTPUT: True if column is auto-increment */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7410 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7411
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7412 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7413 ** CAPI3REF: Load An Extension
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7414 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7415 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7416 ** ^This interface loads an SQLite extension library from the named file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7417 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7418 ** ^The sqlite3_load_extension() interface attempts to load an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7419 ** [SQLite extension] library contained in the file zFile. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7420 ** the file cannot be loaded directly, attempts are made to load
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7421 ** with various operating-system specific extensions added.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7422 ** So for example, if "samplelib" cannot be loaded, then names like
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7423 ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7424 ** be tried also.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7425 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7426 ** ^The entry point is zProc.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7427 ** ^(zProc may be 0, in which case SQLite will try to come up with an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7428 ** entry point name on its own. It first tries "sqlite3_extension_init".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7429 ** If that does not work, it constructs a name "sqlite3_X_init" where
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7430 ** X consists of the lower-case equivalent of all ASCII alphabetic
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7431 ** characters in the filename from the last "/" to the first following
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7432 ** "." and omitting any initial "lib".)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7433 ** ^The sqlite3_load_extension() interface returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7434 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7435 ** ^If an error occurs and pzErrMsg is not 0, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7436 ** [sqlite3_load_extension()] interface shall attempt to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7437 ** fill *pzErrMsg with error message text stored in memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7438 ** obtained from [sqlite3_malloc()]. The calling function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7439 ** should free this memory by calling [sqlite3_free()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7440 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7441 ** ^Extension loading must be enabled using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7442 ** [sqlite3_enable_load_extension()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7443 ** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7444 ** prior to calling this API,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7445 ** otherwise an error will be returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7446 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7447 ** <b>Security warning:</b> It is recommended that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7448 ** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7449 ** interface. The use of the [sqlite3_enable_load_extension()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7450 ** should be avoided. This will keep the SQL function [load_extension()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7451 ** disabled and prevent SQL injections from giving attackers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7452 ** access to extension loading capabilities.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7453 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7454 ** See also the [load_extension() SQL function].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7455 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7456 SQLITE_API int sqlite3_load_extension(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7457 sqlite3 db, / Load the extension into this database connection */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7458 const char zFile, / Name of the shared library containing extension */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7459 const char zProc, / Entry point. Derived from zFile if 0 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7460 char *pzErrMsg / Put error message here if not 0 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7461 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7462
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7463 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7464 ** CAPI3REF: Enable Or Disable Extension Loading
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7465 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7466 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7467 ** ^So as not to open security holes in older applications that are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7468 ** unprepared to deal with [extension loading], and as a means of disabling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7469 ** [extension loading] while evaluating user-entered SQL, the following API
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7470 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7471 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7472 ** ^Extension loading is off by default.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7473 ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7474 ** to turn extension loading on and call it with onoff==0 to turn
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7475 ** it back off again.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7476 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7477 ** ^This interface enables or disables both the C-API
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7478 ** [sqlite3_load_extension()] and the SQL function [load_extension()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7479 ** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7480 ** to enable or disable only the C-API.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7481 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7482 ** <b>Security warning:</b> It is recommended that extension loading
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7483 ** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7484 ** rather than this interface, so the [load_extension()] SQL function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7485 ** remains disabled. This will prevent SQL injections from giving attackers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7486 ** access to extension loading capabilities.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7487 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7488 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7489
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7490 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7491 ** CAPI3REF: Automatically Load Statically Linked Extensions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7492 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7493 ** ^This interface causes the xEntryPoint() function to be invoked for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7494 ** each new [database connection] that is created. The idea here is that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7495 ** xEntryPoint() is the entry point for a statically linked [SQLite extension]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7496 ** that is to be automatically loaded into all new database connections.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7497 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7498 ** ^(Even though the function prototype shows that xEntryPoint() takes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7499 ** no arguments and returns void, SQLite invokes xEntryPoint() with three
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7500 ** arguments and expects an integer result as if the signature of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7501 ** entry point were as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7502 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7503 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7504 **   int xEntryPoint(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7505 **   sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7506   const char pzErrMsg,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7507 **   const struct sqlite3_api_routines *pThunk
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7508 **   );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7509 ** </pre></blockquote>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7510 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7511 ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7512 ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7513 ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7514 ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7515 ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7516 ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7517 ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7518 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7519 ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7520 ** on the list of automatic extensions is a harmless no-op. ^No entry point
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7521 ** will be called more than once for each database connection that is opened.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7522 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7523 ** See also: [sqlite3_reset_auto_extension()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7524 ** and [sqlite3_cancel_auto_extension()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7525 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7526 SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7527
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7528 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7529 ** CAPI3REF: Cancel Automatic Extension Loading
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7530 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7531 ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7532 ** initialization routine X that was registered using a prior call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7533 ** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7534 ** routine returns 1 if initialization routine X was successfully
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7535 ** unregistered and it returns 0 if X was not on the list of initialization
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7536 ** routines.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7537 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7538 SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7539
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7540 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7541 ** CAPI3REF: Reset Automatic Extension Loading
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7542 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7543 ** ^This interface disables all automatic extensions previously
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7544 ** registered using [sqlite3_auto_extension()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7545 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7546 SQLITE_API void sqlite3_reset_auto_extension(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7547
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7548 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7549 ** Structures used by the virtual table interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7550 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7551 typedef struct sqlite3_vtab sqlite3_vtab;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7552 typedef struct sqlite3_index_info sqlite3_index_info;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7553 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7554 typedef struct sqlite3_module sqlite3_module;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7555
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7556 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7557 ** CAPI3REF: Virtual Table Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7558 ** KEYWORDS: sqlite3_module {virtual table module}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7559 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7560 ** This structure, sometimes called a "virtual table module",
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7561 ** defines the implementation of a [virtual table].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7562 ** This structure consists mostly of methods for the module.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7563 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7564 ** ^A virtual table module is created by filling in a persistent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7565 ** instance of this structure and passing a pointer to that instance
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7566 ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7567 ** ^The registration remains valid until it is replaced by a different
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7568 ** module or until the [database connection] closes. The content
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7569 ** of this structure must not change while it is registered with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7570 ** any database connection.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7571 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7572 struct sqlite3_module {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7573 int iVersion;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7574 int (xCreate)(sqlite3, void *pAux,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7575 int argc, const char constargv,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7576 sqlite3_vtab ppVTab, char);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7577 int (xConnect)(sqlite3, void *pAux,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7578 int argc, const char constargv,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7579 sqlite3_vtab ppVTab, char);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7580 int (xBestIndex)(sqlite3_vtab pVTab, sqlite3_index_info*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7581 int (xDisconnect)(sqlite3_vtab pVTab);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7582 int (xDestroy)(sqlite3_vtab pVTab);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7583 int (xOpen)(sqlite3_vtab pVTab, sqlite3_vtab_cursor **ppCursor);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7584 int (xClose)(sqlite3_vtab_cursor);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7585 int (xFilter)(sqlite3_vtab_cursor, int idxNum, const char *idxStr,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7586 int argc, sqlite3_value **argv);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7587 int (xNext)(sqlite3_vtab_cursor);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7588 int (xEof)(sqlite3_vtab_cursor);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7589 int (xColumn)(sqlite3_vtab_cursor, sqlite3_context*, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7590 int (xRowid)(sqlite3_vtab_cursor, sqlite3_int64 *pRowid);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7591 int (xUpdate)(sqlite3_vtab , int, sqlite3_value *, sqlite3_int64 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7592 int (xBegin)(sqlite3_vtab pVTab);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7593 int (xSync)(sqlite3_vtab pVTab);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7594 int (xCommit)(sqlite3_vtab pVTab);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7595 int (xRollback)(sqlite3_vtab pVTab);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7596 int (xFindFunction)(sqlite3_vtab pVtab, int nArg, const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7597 void (*pxFunc)(sqlite3_context,int,sqlite3_value**),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7598 void **ppArg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7599 int (xRename)(sqlite3_vtab pVtab, const char *zNew);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7600 /* The methods above are in version 1 of the sqlite_module object. Those
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7601 ** below are for version 2 and greater. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7602 int (xSavepoint)(sqlite3_vtab pVTab, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7603 int (xRelease)(sqlite3_vtab pVTab, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7604 int (xRollbackTo)(sqlite3_vtab pVTab, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7605 /* The methods above are in versions 1 and 2 of the sqlite_module object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7606 ** Those below are for version 3 and greater. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7607 int (xShadowName)(const char);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7608 /* The methods above are in versions 1 through 3 of the sqlite_module object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7609 ** Those below are for version 4 and greater. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7610 int (xIntegrity)(sqlite3_vtab pVTab, const char *zSchema,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7611 const char zTabName, int mFlags, char *pzErr);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7612 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7613
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7614 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7615 ** CAPI3REF: Virtual Table Indexing Information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7616 ** KEYWORDS: sqlite3_index_info
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7617 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7618 ** The sqlite3_index_info structure and its substructures is used as part
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7619 ** of the [virtual table] interface to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7620 ** pass information into and receive the reply from the [xBestIndex]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7621 method of a [virtual table module]. The fields under Inputs** are the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7622 ** inputs to xBestIndex and are read-only. xBestIndex inserts its
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7623 results into the Outputs** fields.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7624 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7625 ** ^(The aConstraint[] array records WHERE clause constraints of the form:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7626 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7627 ** <blockquote>column OP expr</blockquote>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7628 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7629 ** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7630 ** stored in aConstraint[].op using one of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7631 ** [SQLITE_INDEX_CONSTRAINT_EQ \| SQLITE_INDEX_CONSTRAINT_ values].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7632 ** ^(The index of the column is stored in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7633 ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7634 ** expr on the right-hand side can be evaluated (and thus the constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7635 ** is usable) and false if it cannot.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7636 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7637 ** ^The optimizer automatically inverts terms of the form "expr OP column"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7638 ** and makes other simplifications to the WHERE clause in an attempt to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7639 ** get as many WHERE clause terms into the form shown above as possible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7640 ** ^The aConstraint[] array only reports WHERE clause terms that are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7641 ** relevant to the particular virtual table being queried.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7642 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7643 ** ^Information about the ORDER BY clause is stored in aOrderBy[].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7644 ** ^Each term of aOrderBy records a column of the ORDER BY clause.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7645 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7646 ** The colUsed field indicates which columns of the virtual table may be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7647 ** required by the current scan. Virtual table columns are numbered from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7648 ** zero in the order in which they appear within the CREATE TABLE statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7649 ** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7650 ** the corresponding bit is set within the colUsed mask if the column may be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7651 ** required by SQLite. If the table has at least 64 columns and any column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7652 ** to the right of the first 63 is required, then bit 63 of colUsed is also
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7653 ** set. In other words, column iCol may be required if the expression
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7654 ** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7655 ** non-zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7656 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7657 ** The [xBestIndex] method must fill aConstraintUsage[] with information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7658 ** about what parameters to pass to xFilter. ^If argvIndex>0 then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7659 ** the right-hand side of the corresponding aConstraint[] is evaluated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7660 ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7661 ** is true, then the constraint is assumed to be fully handled by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7662 ** virtual table and might not be checked again by the byte code.)^ ^(The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7663 ** aConstraintUsage[].omit flag is an optimization hint. When the omit flag
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7664 ** is left in its default setting of false, the constraint will always be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7665 ** checked separately in byte code. If the omit flag is changed to true, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7666 ** the constraint may or may not be checked in byte code. In other words,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7667 ** when the omit flag is true there is no guarantee that the constraint will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7668 ** not be checked again using byte code.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7669 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7670 ** ^The idxNum and idxStr values are recorded and passed into the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7671 ** [xFilter] method.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7672 ** ^[sqlite3_free()] is used to free idxStr if and only if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7673 ** needToFreeIdxStr is true.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7674 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7675 ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7676 ** the correct order to satisfy the ORDER BY clause so that no separate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7677 ** sorting step is required.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7678 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7679 ** ^The estimatedCost value is an estimate of the cost of a particular
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7680 ** strategy. A cost of N indicates that the cost of the strategy is similar
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7681 ** to a linear scan of an SQLite table with N rows. A cost of log(N)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7682 ** indicates that the expense of the operation is similar to that of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7683 ** binary search on a unique indexed field of an SQLite table with N rows.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7684 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7685 ** ^The estimatedRows value is an estimate of the number of rows that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7686 ** will be returned by the strategy.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7687 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7688 ** The xBestIndex method may optionally populate the idxFlags field with a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7689 ** mask of SQLITE_INDEX_SCAN_* flags. One such flag is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7690 ** [SQLITE_INDEX_SCAN_HEX], which if set causes the [EXPLAIN QUERY PLAN]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7691 ** output to show the idxNum as hex instead of as decimal. Another flag is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7692 ** SQLITE_INDEX_SCAN_UNIQUE, which if set indicates that the query plan will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7693 ** return at most one row.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7694 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7695 ** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7696 ** SQLite also assumes that if a call to the xUpdate() method is made as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7697 ** part of the same statement to delete or update a virtual table row and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7698 ** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7699 ** any database changes. In other words, if the xUpdate() returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7700 ** SQLITE_CONSTRAINT, the database contents must be exactly as they were
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7701 ** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7702 ** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7703 ** the xUpdate method are automatically rolled back by SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7704 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7705 ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7706 ** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7707 ** If a virtual table extension is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7708 ** used with an SQLite version earlier than 3.8.2, the results of attempting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7709 ** to read or write the estimatedRows field are undefined (but are likely
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7710 ** to include crashing the application). The estimatedRows field should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7711 ** therefore only be used if [sqlite3_libversion_number()] returns a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7712 ** value greater than or equal to 3008002. Similarly, the idxFlags field
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7713 ** was added for [version 3.9.0] ([dateof:3.9.0]).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7714 ** It may therefore only be used if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7715 ** sqlite3_libversion_number() returns a value greater than or equal to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7716 ** 3009000.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7717 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7718 struct sqlite3_index_info {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7719 /* Inputs */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7720 int nConstraint; /* Number of entries in aConstraint */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7721 struct sqlite3_index_constraint {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7722 int iColumn; /* Column constrained. -1 for ROWID */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7723 unsigned char op; /* Constraint operator */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7724 unsigned char usable; /* True if this constraint is usable */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7725 int iTermOffset; /* Used internally - xBestIndex should ignore */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7726 } aConstraint; / Table of WHERE clause constraints */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7727 int nOrderBy; /* Number of terms in the ORDER BY clause */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7728 struct sqlite3_index_orderby {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7729 int iColumn; /* Column number */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7730 unsigned char desc; /* True for DESC. False for ASC. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7731 } aOrderBy; / The ORDER BY clause */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7732 /* Outputs */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7733 struct sqlite3_index_constraint_usage {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7734 int argvIndex; /* if >0, constraint is part of argv to xFilter */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7735 unsigned char omit; /* Do not code a test for this constraint */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7736 } *aConstraintUsage;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7737 int idxNum; /* Number used to identify the index */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7738 char idxStr; / String, possibly obtained from sqlite3_malloc */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7739 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7740 int orderByConsumed; /* True if output is already ordered */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7741 double estimatedCost; /* Estimated cost of using this index */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7742 /* Fields below are only available in SQLite 3.8.2 and later */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7743 sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7744 /* Fields below are only available in SQLite 3.9.0 and later */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7745 int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7746 /* Fields below are only available in SQLite 3.10.0 and later */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7747 sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7748 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7749
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7750 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7751 ** CAPI3REF: Virtual Table Scan Flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7752 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7753 ** Virtual table implementations are allowed to set the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7754 ** [sqlite3_index_info].idxFlags field to some combination of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7755 ** these bits.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7756 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7757 #define SQLITE_INDEX_SCAN_UNIQUE 0x00000001 /* Scan visits at most 1 row */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7758 #define SQLITE_INDEX_SCAN_HEX 0x00000002 /* Display idxNum as hex */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7759 /* in EXPLAIN QUERY PLAN */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7760
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7761 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7762 ** CAPI3REF: Virtual Table Constraint Operator Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7763 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7764 ** These macros define the allowed values for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7765 ** [sqlite3_index_info].aConstraint[].op field. Each value represents
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7766 ** an operator that is part of a constraint term in the WHERE clause of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7767 ** a query that uses a [virtual table].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7768 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7769 ** ^The left-hand operand of the operator is given by the corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7770 ** aConstraint[].iColumn field. ^An iColumn of -1 indicates the left-hand
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7771 ** operand is the rowid.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7772 ** The SQLITE_INDEX_CONSTRAINT_LIMIT and SQLITE_INDEX_CONSTRAINT_OFFSET
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7773 ** operators have no left-hand operand, and so for those operators the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7774 ** corresponding aConstraint[].iColumn is meaningless and should not be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7775 ** used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7776 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7777 ** All operator values from SQLITE_INDEX_CONSTRAINT_FUNCTION through
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7778 ** value 255 are reserved to represent functions that are overloaded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7779 ** by the [xFindFunction\|xFindFunction method] of the virtual table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7780 ** implementation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7781 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7782 ** The right-hand operands for each constraint might be accessible using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7783 ** the [sqlite3_vtab_rhs_value()] interface. Usually the right-hand
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7784 ** operand is only available if it appears as a single constant literal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7785 ** in the input SQL. If the right-hand operand is another column or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7786 ** expression (even a constant expression) or a parameter, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7787 ** sqlite3_vtab_rhs_value() probably will not be able to extract it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7788 ** ^The SQLITE_INDEX_CONSTRAINT_ISNULL and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7789 ** SQLITE_INDEX_CONSTRAINT_ISNOTNULL operators have no right-hand operand
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7790 ** and hence calls to sqlite3_vtab_rhs_value() for those operators will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7791 ** always return SQLITE_NOTFOUND.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7792 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7793 ** The collating sequence to be used for comparison can be found using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7794 ** the [sqlite3_vtab_collation()] interface. For most real-world virtual
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7795 ** tables, the collating sequence of constraints does not matter (for example
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7796 ** because the constraints are numeric) and so the sqlite3_vtab_collation()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7797 ** interface is not commonly needed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7798 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7799 #define SQLITE_INDEX_CONSTRAINT_EQ 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7800 #define SQLITE_INDEX_CONSTRAINT_GT 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7801 #define SQLITE_INDEX_CONSTRAINT_LE 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7802 #define SQLITE_INDEX_CONSTRAINT_LT 16
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7803 #define SQLITE_INDEX_CONSTRAINT_GE 32
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7804 #define SQLITE_INDEX_CONSTRAINT_MATCH 64
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7805 #define SQLITE_INDEX_CONSTRAINT_LIKE 65
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7806 #define SQLITE_INDEX_CONSTRAINT_GLOB 66
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7807 #define SQLITE_INDEX_CONSTRAINT_REGEXP 67
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7808 #define SQLITE_INDEX_CONSTRAINT_NE 68
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7809 #define SQLITE_INDEX_CONSTRAINT_ISNOT 69
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7810 #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7811 #define SQLITE_INDEX_CONSTRAINT_ISNULL 71
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7812 #define SQLITE_INDEX_CONSTRAINT_IS 72
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7813 #define SQLITE_INDEX_CONSTRAINT_LIMIT 73
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7814 #define SQLITE_INDEX_CONSTRAINT_OFFSET 74
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7815 #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7816
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7817 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7818 ** CAPI3REF: Register A Virtual Table Implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7819 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7820 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7821 ** ^These routines are used to register a new [virtual table module] name.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7822 ** ^Module names must be registered before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7823 ** creating a new [virtual table] using the module and before using a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7824 ** preexisting [virtual table] for the module.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7825 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7826 ** ^The module name is registered on the [database connection] specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7827 ** by the first parameter. ^The name of the module is given by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7828 ** second parameter. ^The third parameter is a pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7829 ** the implementation of the [virtual table module]. ^The fourth
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7830 ** parameter is an arbitrary client data pointer that is passed through
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7831 ** into the [xCreate] and [xConnect] methods of the virtual table module
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7832 ** when a new virtual table is being created or reinitialized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7833 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7834 ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7835 ** is a pointer to a destructor for the pClientData. ^SQLite will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7836 ** invoke the destructor function (if it is not NULL) when SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7837 ** no longer needs the pClientData pointer. ^The destructor will also
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7838 ** be invoked if the call to sqlite3_create_module_v2() fails.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7839 ** ^The sqlite3_create_module()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7840 ** interface is equivalent to sqlite3_create_module_v2() with a NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7841 ** destructor.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7842 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7843 ** ^If the third parameter (the pointer to the sqlite3_module object) is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7844 ** NULL then no new module is created and any existing modules with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7845 ** same name are dropped.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7846 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7847 ** See also: [sqlite3_drop_modules()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7848 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7849 SQLITE_API int sqlite3_create_module(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7850 sqlite3 db, / SQLite connection to register module with */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7851 const char zName, / Name of the module */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7852 const sqlite3_module p, / Methods for the module */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7853 void pClientData / Client data for xCreate/xConnect */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7854 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7855 SQLITE_API int sqlite3_create_module_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7856 sqlite3 db, / SQLite connection to register module with */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7857 const char zName, / Name of the module */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7858 const sqlite3_module p, / Methods for the module */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7859 void pClientData, / Client data for xCreate/xConnect */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7860 void(xDestroy)(void) /* Module destructor function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7861 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7862
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7863 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7864 ** CAPI3REF: Remove Unnecessary Virtual Table Implementations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7865 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7866 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7867 ** ^The sqlite3_drop_modules(D,L) interface removes all virtual
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7868 ** table modules from database connection D except those named on list L.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7869 ** The L parameter must be either NULL or a pointer to an array of pointers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7870 ** to strings where the array is terminated by a single NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7871 ** ^If the L parameter is NULL, then all virtual table modules are removed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7872 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7873 ** See also: [sqlite3_create_module()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7874 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7875 SQLITE_API int sqlite3_drop_modules(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7876 sqlite3 db, / Remove modules from this connection */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7877 const char *azKeep / Except, do not remove the ones named here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7878 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7879
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7880 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7881 ** CAPI3REF: Virtual Table Instance Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7882 ** KEYWORDS: sqlite3_vtab
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7883 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7884 ** Every [virtual table module] implementation uses a subclass
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7885 ** of this object to describe a particular instance
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7886 ** of the [virtual table]. Each subclass will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7887 ** be tailored to the specific needs of the module implementation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7888 ** The purpose of this superclass is to define certain fields that are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7889 ** common to all module implementations.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7890 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7891 ** ^Virtual tables methods can set an error message by assigning a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7892 ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7893 ** take care that any prior string is freed by a call to [sqlite3_free()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7894 ** prior to assigning a new string to zErrMsg. ^After the error message
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7895 ** is delivered up to the client application, the string will be automatically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7896 ** freed by sqlite3_free() and the zErrMsg field will be zeroed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7897 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7898 struct sqlite3_vtab {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7899 const sqlite3_module pModule; / The module for this virtual table */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7900 int nRef; /* Number of open cursors */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7901 char zErrMsg; / Error message from sqlite3_mprintf() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7902 /* Virtual table implementations will typically add additional fields */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7903 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7904
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7905 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7906 ** CAPI3REF: Virtual Table Cursor Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7907 ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7908 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7909 ** Every [virtual table module] implementation uses a subclass of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7910 ** following structure to describe cursors that point into the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7911 ** [virtual table] and are used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7912 ** to loop through the virtual table. Cursors are created using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7913 ** [sqlite3_module.xOpen \| xOpen] method of the module and are destroyed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7914 ** by the [sqlite3_module.xClose \| xClose] method. Cursors are used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7915 ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7916 ** of the module. Each module implementation will define
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7917 ** the content of a cursor structure to suit its own needs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7918 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7919 ** This superclass exists in order to define fields of the cursor that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7920 ** are common to all implementations.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7921 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7922 struct sqlite3_vtab_cursor {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7923 sqlite3_vtab pVtab; / Virtual table of this cursor */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7924 /* Virtual table implementations will typically add additional fields */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7925 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7926
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7927 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7928 ** CAPI3REF: Declare The Schema Of A Virtual Table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7929 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7930 ** ^The [xCreate] and [xConnect] methods of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7931 ** [virtual table module] call this interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7932 ** to declare the format (the names and datatypes of the columns) of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7933 ** the virtual tables they implement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7934 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7935 SQLITE_API int sqlite3_declare_vtab(sqlite3, const char zSQL);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7936
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7937 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7938 ** CAPI3REF: Overload A Function For A Virtual Table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7939 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7940 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7941 ** ^(Virtual tables can provide alternative implementations of functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7942 ** using the [xFindFunction] method of the [virtual table module].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7943 ** But global versions of those functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7944 ** must exist in order to be overloaded.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7945 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7946 ** ^(This API makes sure a global version of a function with a particular
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7947 ** name and number of parameters exists. If no such function exists
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7948 ** before this API is called, a new function is created.)^ ^The implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7949 ** of the new function always causes an exception to be thrown. So
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7950 ** the new function is not good for anything by itself. Its only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7951 ** purpose is to be a placeholder function that can be overloaded
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7952 ** by a [virtual table].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7953 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7954 SQLITE_API int sqlite3_overload_function(sqlite3, const char zFuncName, int nArg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7955
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7956 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7957 ** CAPI3REF: A Handle To An Open BLOB
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7958 ** KEYWORDS: {BLOB handle} {BLOB handles}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7959 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7960 ** An instance of this object represents an open BLOB on which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7961 ** [sqlite3_blob_open \| incremental BLOB I/O] can be performed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7962 ** ^Objects of this type are created by [sqlite3_blob_open()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7963 ** and destroyed by [sqlite3_blob_close()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7964 ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7965 ** can be used to read or write small subsections of the BLOB.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7966 ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7967 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7968 typedef struct sqlite3_blob sqlite3_blob;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7969
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7970 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7971 ** CAPI3REF: Open A BLOB For Incremental I/O
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7972 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7973 ** CONSTRUCTOR: sqlite3_blob
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7974 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7975 ** ^(This interfaces opens a [BLOB handle \| handle] to the BLOB located
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7976 ** in row iRow, column zColumn, table zTable in database zDb;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7977 ** in other words, the same BLOB that would be selected by:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7978 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7979 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7980 ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7981 ** </pre>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7982 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7983 ** ^(Parameter zDb is not the filename that contains the database, but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7984 ** rather the symbolic name of the database. For attached databases, this is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7985 ** the name that appears after the AS keyword in the [ATTACH] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7986 ** For the main database file, the database name is "main". For TEMP
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7987 ** tables, the database name is "temp".)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7988 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7989 ** ^If the flags parameter is non-zero, then the BLOB is opened for read
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7990 ** and write access. ^If the flags parameter is zero, the BLOB is opened for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7991 ** read-only access.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7992 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7993 ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7994 ** in *ppBlob. Otherwise an [error code] is returned and, unless the error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7995 ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7996 ** the API is not misused, it is always safe to call [sqlite3_blob_close()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7997 ** on *ppBlob after this function returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7998 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	7999 ** This function fails with SQLITE_ERROR if any of the following are true:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8000 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8001 ** <li> ^(Database zDb does not exist)^,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8002 ** <li> ^(Table zTable does not exist within database zDb)^,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8003 ** <li> ^(Table zTable is a WITHOUT ROWID table)^,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8004 ** <li> ^(Column zColumn does not exist)^,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8005 ** <li> ^(Row iRow is not present in the table)^,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8006 ** <li> ^(The specified column of row iRow contains a value that is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8007 ** a TEXT or BLOB value)^,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8008 ** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8009 ** constraint and the blob is being opened for read/write access)^,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8010 ** <li> ^([foreign key constraints \| Foreign key constraints] are enabled,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8011 ** column zColumn is part of a [child key] definition and the blob is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8012 ** being opened for read/write access)^.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8013 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8014 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8015 ** ^Unless it returns SQLITE_MISUSE, this function sets the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8016 ** [database connection] error code and message accessible via
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8017 ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8018 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8019 ** A BLOB referenced by sqlite3_blob_open() may be read using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8020 ** [sqlite3_blob_read()] interface and modified by using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8021 ** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8022 ** different row of the same table using the [sqlite3_blob_reopen()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8023 ** interface. However, the column, table, or database of a [BLOB handle]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8024 ** cannot be changed after the [BLOB handle] is opened.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8025 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8026 ** ^(If the row that a BLOB handle points to is modified by an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8027 ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8028 ** then the BLOB handle is marked as "expired".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8029 ** This is true if any column of the row is changed, even a column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8030 ** other than the one the BLOB handle is open on.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8031 ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8032 ** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8033 ** ^(Changes written into a BLOB prior to the BLOB expiring are not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8034 ** rolled back by the expiration of the BLOB. Such changes will eventually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8035 ** commit if the transaction continues to completion.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8036 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8037 ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8038 ** the opened blob. ^The size of a blob may not be changed by this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8039 ** interface. Use the [UPDATE] SQL command to change the size of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8040 ** blob.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8041 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8042 ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8043 ** and the built-in [zeroblob] SQL function may be used to create a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8044 ** zero-filled blob to read or write using the incremental-blob interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8045 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8046 ** To avoid a resource leak, every open [BLOB handle] should eventually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8047 ** be released by a call to [sqlite3_blob_close()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8048 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8049 ** See also: [sqlite3_blob_close()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8050 ** [sqlite3_blob_reopen()], [sqlite3_blob_read()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8051 ** [sqlite3_blob_bytes()], [sqlite3_blob_write()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8052 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8053 SQLITE_API int sqlite3_blob_open(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8054 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8055 const char *zDb,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8056 const char *zTable,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8057 const char *zColumn,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8058 sqlite3_int64 iRow,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8059 int flags,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8060 sqlite3_blob **ppBlob
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8061 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8062
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8063 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8064 ** CAPI3REF: Move a BLOB Handle to a New Row
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8065 ** METHOD: sqlite3_blob
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8066 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8067 ** ^This function is used to move an existing [BLOB handle] so that it points
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8068 ** to a different row of the same database table. ^The new row is identified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8069 ** by the rowid value passed as the second argument. Only the row can be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8070 ** changed. ^The database, table and column on which the blob handle is open
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8071 ** remain the same. Moving an existing [BLOB handle] to a new row is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8072 ** faster than closing the existing handle and opening a new one.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8073 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8074 ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8075 ** it must exist and there must be either a blob or text value stored in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8076 ** the nominated column.)^ ^If the new row is not present in the table, or if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8077 ** it does not contain a blob or text value, or if another error occurs, an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8078 ** SQLite error code is returned and the blob handle is considered aborted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8079 ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8080 ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8081 ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8082 ** always returns zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8083 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8084 ** ^This function sets the database handle error code and message.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8085 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8086 SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8087
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8088 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8089 ** CAPI3REF: Close A BLOB Handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8090 ** DESTRUCTOR: sqlite3_blob
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8091 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8092 ** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8093 ** unconditionally. Even if this routine returns an error code, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8094 ** handle is still closed.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8095 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8096 ** ^If the blob handle being closed was opened for read-write access, and if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8097 ** the database is in auto-commit mode and there are no other open read-write
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8098 ** blob handles or active write statements, the current transaction is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8099 ** committed. ^If an error occurs while committing the transaction, an error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8100 ** code is returned and the transaction rolled back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8101 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8102 ** Calling this function with an argument that is not a NULL pointer or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8103 ** open blob handle results in undefined behavior. ^Calling this routine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8104 ** with a null pointer (such as would be returned by a failed call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8105 ** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8106 ** is passed a valid open blob handle, the values returned by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8107 ** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8108 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8109 SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8110
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8111 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8112 ** CAPI3REF: Return The Size Of An Open BLOB
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8113 ** METHOD: sqlite3_blob
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8114 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8115 ** ^Returns the size in bytes of the BLOB accessible via the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8116 ** successfully opened [BLOB handle] in its only argument. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8117 ** incremental blob I/O routines can only read or overwrite existing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8118 ** blob content; they cannot change the size of a blob.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8119 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8120 ** This routine only works on a [BLOB handle] which has been created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8121 ** by a prior successful call to [sqlite3_blob_open()] and which has not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8122 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8123 ** to this routine results in undefined and probably undesirable behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8124 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8125 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8126
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8127 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8128 ** CAPI3REF: Read Data From A BLOB Incrementally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8129 ** METHOD: sqlite3_blob
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8130 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8131 ** ^(This function is used to read data from an open [BLOB handle] into a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8132 ** caller-supplied buffer. N bytes of data are copied into buffer Z
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8133 ** from the open BLOB, starting at offset iOffset.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8134 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8135 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8136 ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8137 ** less than zero, [SQLITE_ERROR] is returned and no data is read.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8138 ** ^The size of the blob (and hence the maximum value of N+iOffset)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8139 ** can be determined using the [sqlite3_blob_bytes()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8140 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8141 ** ^An attempt to read from an expired [BLOB handle] fails with an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8142 ** error code of [SQLITE_ABORT].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8143 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8144 ** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8145 ** Otherwise, an [error code] or an [extended error code] is returned.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8146 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8147 ** This routine only works on a [BLOB handle] which has been created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8148 ** by a prior successful call to [sqlite3_blob_open()] and which has not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8149 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8150 ** to this routine results in undefined and probably undesirable behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8151 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8152 ** See also: [sqlite3_blob_write()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8153 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8154 SQLITE_API int sqlite3_blob_read(sqlite3_blob , void Z, int N, int iOffset);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8155
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8156 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8157 ** CAPI3REF: Write Data Into A BLOB Incrementally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8158 ** METHOD: sqlite3_blob
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8159 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8160 ** ^(This function is used to write data into an open [BLOB handle] from a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8161 ** caller-supplied buffer. N bytes of data are copied from the buffer Z
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8162 ** into the open BLOB, starting at offset iOffset.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8163 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8164 ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8165 ** Otherwise, an [error code] or an [extended error code] is returned.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8166 ** ^Unless SQLITE_MISUSE is returned, this function sets the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8167 ** [database connection] error code and message accessible via
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8168 ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8169 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8170 ** ^If the [BLOB handle] passed as the first argument was not opened for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8171 ** writing (the flags parameter to [sqlite3_blob_open()] was zero),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8172 ** this function returns [SQLITE_READONLY].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8173 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8174 ** This function may only modify the contents of the BLOB; it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8175 ** not possible to increase the size of a BLOB using this API.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8176 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8177 ** [SQLITE_ERROR] is returned and no data is written. The size of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8178 ** BLOB (and hence the maximum value of N+iOffset) can be determined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8179 ** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8180 ** than zero [SQLITE_ERROR] is returned and no data is written.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8181 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8182 ** ^An attempt to write to an expired [BLOB handle] fails with an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8183 ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8184 ** before the [BLOB handle] expired are not rolled back by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8185 ** expiration of the handle, though of course those changes might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8186 ** have been overwritten by the statement that expired the BLOB handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8187 ** or by other independent statements.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8188 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8189 ** This routine only works on a [BLOB handle] which has been created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8190 ** by a prior successful call to [sqlite3_blob_open()] and which has not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8191 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8192 ** to this routine results in undefined and probably undesirable behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8193 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8194 ** See also: [sqlite3_blob_read()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8195 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8196 SQLITE_API int sqlite3_blob_write(sqlite3_blob , const void z, int n, int iOffset);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8197
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8198 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8199 ** CAPI3REF: Virtual File System Objects
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8200 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8201 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8202 ** that SQLite uses to interact
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8203 ** with the underlying operating system. Most SQLite builds come with a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8204 ** single default VFS that is appropriate for the host computer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8205 ** New VFSes can be registered and existing VFSes can be unregistered.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8206 ** The following interfaces are provided.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8207 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8208 ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8209 ** ^Names are case sensitive.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8210 ** ^Names are zero-terminated UTF-8 strings.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8211 ** ^If there is no match, a NULL pointer is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8212 ** ^If zVfsName is NULL then the default VFS is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8213 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8214 ** ^New VFSes are registered with sqlite3_vfs_register().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8215 ** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8216 ** ^The same VFS can be registered multiple times without injury.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8217 ** ^To make an existing VFS into the default VFS, register it again
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8218 ** with the makeDflt flag set. If two different VFSes with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8219 ** same name are registered, the behavior is undefined. If a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8220 ** VFS is registered with a name that is NULL or an empty string,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8221 ** then the behavior is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8222 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8223 ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8224 ** ^(If the default VFS is unregistered, another VFS is chosen as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8225 ** the default. The choice for the new VFS is arbitrary.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8226 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8227 SQLITE_API sqlite3_vfs sqlite3_vfs_find(const char zVfsName);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8228 SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8229 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8230
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8231 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8232 ** CAPI3REF: Mutexes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8233 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8234 ** The SQLite core uses these routines for thread
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8235 ** synchronization. Though they are intended for internal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8236 ** use by SQLite, code that links against SQLite is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8237 ** permitted to use any of these routines.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8238 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8239 ** The SQLite source code contains multiple implementations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8240 ** of these mutex routines. An appropriate implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8241 ** is selected automatically at compile-time. The following
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8242 ** implementations are available in the SQLite core:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8243 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8244 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8245 ** <li> SQLITE_MUTEX_PTHREADS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8246 ** <li> SQLITE_MUTEX_W32
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8247 ** <li> SQLITE_MUTEX_NOOP
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8248 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8249 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8250 ** The SQLITE_MUTEX_NOOP implementation is a set of routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8251 ** that does no real locking and is appropriate for use in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8252 ** a single-threaded application. The SQLITE_MUTEX_PTHREADS and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8253 ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8254 ** and Windows.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8255 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8256 ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8257 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8258 ** implementation is included with the library. In this case the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8259 ** application must supply a custom mutex implementation using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8260 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8261 ** before calling sqlite3_initialize() or any other public sqlite3_
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8262 ** function that calls sqlite3_initialize().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8263 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8264 ** ^The sqlite3_mutex_alloc() routine allocates a new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8265 ** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8266 ** routine returns NULL if it is unable to allocate the requested
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8267 ** mutex. The argument to sqlite3_mutex_alloc() must be one of these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8268 ** integer constants:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8269 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8270 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8271 ** <li> SQLITE_MUTEX_FAST
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8272 ** <li> SQLITE_MUTEX_RECURSIVE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8273 ** <li> SQLITE_MUTEX_STATIC_MAIN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8274 ** <li> SQLITE_MUTEX_STATIC_MEM
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8275 ** <li> SQLITE_MUTEX_STATIC_OPEN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8276 ** <li> SQLITE_MUTEX_STATIC_PRNG
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8277 ** <li> SQLITE_MUTEX_STATIC_LRU
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8278 ** <li> SQLITE_MUTEX_STATIC_PMEM
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8279 ** <li> SQLITE_MUTEX_STATIC_APP1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8280 ** <li> SQLITE_MUTEX_STATIC_APP2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8281 ** <li> SQLITE_MUTEX_STATIC_APP3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8282 ** <li> SQLITE_MUTEX_STATIC_VFS1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8283 ** <li> SQLITE_MUTEX_STATIC_VFS2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8284 ** <li> SQLITE_MUTEX_STATIC_VFS3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8285 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8286 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8287 ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8288 ** cause sqlite3_mutex_alloc() to create
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8289 ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8290 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8291 ** The mutex implementation does not need to make a distinction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8292 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8293 ** not want to. SQLite will only request a recursive mutex in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8294 ** cases where it really needs one. If a faster non-recursive mutex
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8295 ** implementation is available on the host platform, the mutex subsystem
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8296 ** might return such a mutex in response to SQLITE_MUTEX_FAST.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8297 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8298 ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8299 ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8300 ** a pointer to a static preexisting mutex. ^Nine static mutexes are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8301 ** used by the current version of SQLite. Future versions of SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8302 ** may add additional static mutexes. Static mutexes are for internal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8303 ** use by SQLite only. Applications that use SQLite mutexes should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8304 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8305 ** SQLITE_MUTEX_RECURSIVE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8306 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8307 ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8308 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8309 ** returns a different mutex on every call. ^For the static
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8310 ** mutex types, the same mutex is returned on every call that has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8311 ** the same type number.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8312 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8313 ** ^The sqlite3_mutex_free() routine deallocates a previously
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8314 ** allocated dynamic mutex. Attempting to deallocate a static
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8315 ** mutex results in undefined behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8316 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8317 ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8318 ** to enter a mutex. ^If another thread is already within the mutex,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8319 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8320 ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8321 ** upon successful entry. ^(Mutexes created using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8322 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8323 ** In such cases, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8324 ** mutex must be exited an equal number of times before another thread
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8325 ** can enter.)^ If the same thread tries to enter any mutex other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8326 ** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8327 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8328 ** ^(Some systems (for example, Windows 95) do not support the operation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8329 ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8330 ** will always return SQLITE_BUSY. In most cases the SQLite core only uses
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8331 ** sqlite3_mutex_try() as an optimization, so this is acceptable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8332 ** behavior. The exceptions are unix builds that set the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8333 ** SQLITE_ENABLE_SETLK_TIMEOUT build option. In that case a working
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8334 ** sqlite3_mutex_try() is required.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8335 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8336 ** ^The sqlite3_mutex_leave() routine exits a mutex that was
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8337 ** previously entered by the same thread. The behavior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8338 ** is undefined if the mutex is not currently entered by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8339 ** calling thread or is not currently allocated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8340 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8341 ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8342 ** sqlite3_mutex_leave(), or sqlite3_mutex_free() is a NULL pointer,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8343 ** then any of the four routines behaves as a no-op.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8344 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8345 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8346 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8347 SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8348 SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8349 SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8350 SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8351 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8352
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8353 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8354 ** CAPI3REF: Mutex Methods Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8355 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8356 ** An instance of this structure defines the low-level routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8357 ** used to allocate and use mutexes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8358 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8359 ** Usually, the default mutex implementations provided by SQLite are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8360 ** sufficient, however the application has the option of substituting a custom
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8361 ** implementation for specialized deployments or systems for which SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8362 ** does not provide a suitable implementation. In this case, the application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8363 ** creates and populates an instance of this structure to pass
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8364 ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8365 ** Additionally, an instance of this structure can be used as an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8366 ** output variable when querying the system for the current mutex
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8367 ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8368 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8369 ** ^The xMutexInit method defined by this structure is invoked as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8370 ** part of system initialization by the sqlite3_initialize() function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8371 ** ^The xMutexInit routine is called by SQLite exactly once for each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8372 ** effective call to [sqlite3_initialize()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8373 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8374 ** ^The xMutexEnd method defined by this structure is invoked as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8375 ** part of system shutdown by the sqlite3_shutdown() function. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8376 ** implementation of this method is expected to release all outstanding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8377 ** resources obtained by the mutex methods implementation, especially
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8378 ** those obtained by the xMutexInit method. ^The xMutexEnd()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8379 ** interface is invoked exactly once for each call to [sqlite3_shutdown()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8380 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8381 ** ^(The remaining seven methods defined by this structure (xMutexAlloc,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8382 ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8383 ** xMutexNotheld) implement the following interfaces (respectively):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8384 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8385 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8386 ** <li> [sqlite3_mutex_alloc()] </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8387 ** <li> [sqlite3_mutex_free()] </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8388 ** <li> [sqlite3_mutex_enter()] </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8389 ** <li> [sqlite3_mutex_try()] </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8390 ** <li> [sqlite3_mutex_leave()] </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8391 ** <li> [sqlite3_mutex_held()] </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8392 ** <li> [sqlite3_mutex_notheld()] </li>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8393 ** </ul>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8394 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8395 ** The only difference is that the public sqlite3_XXX functions enumerated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8396 ** above silently ignore any invocations that pass a NULL pointer instead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8397 ** of a valid mutex handle. The implementations of the methods defined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8398 ** by this structure are not required to handle this case. The results
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8399 ** of passing a NULL pointer instead of a valid mutex handle are undefined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8400 ** (i.e. it is acceptable to provide an implementation that segfaults if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8401 ** it is passed a NULL pointer).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8402 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8403 ** The xMutexInit() method must be threadsafe. It must be harmless to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8404 ** invoke xMutexInit() multiple times within the same process and without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8405 ** intervening calls to xMutexEnd(). Second and subsequent calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8406 ** xMutexInit() must be no-ops.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8407 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8408 ** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8409 ** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8410 ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8411 ** memory allocation for a fast or recursive mutex.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8412 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8413 ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8414 ** called, but only if the prior call to xMutexInit returned SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8415 ** If xMutexInit fails in any way, it is expected to clean up after itself
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8416 ** prior to returning.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8417 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8418 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8419 struct sqlite3_mutex_methods {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8420 int (*xMutexInit)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8421 int (*xMutexEnd)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8422 sqlite3_mutex (xMutexAlloc)(int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8423 void (xMutexFree)(sqlite3_mutex );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8424 void (xMutexEnter)(sqlite3_mutex );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8425 int (xMutexTry)(sqlite3_mutex );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8426 void (xMutexLeave)(sqlite3_mutex );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8427 int (xMutexHeld)(sqlite3_mutex );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8428 int (xMutexNotheld)(sqlite3_mutex );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8429 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8430
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8431 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8432 ** CAPI3REF: Mutex Verification Routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8433 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8434 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8435 ** are intended for use inside assert() statements. The SQLite core
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8436 ** never uses these routines except inside an assert() and applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8437 ** are advised to follow the lead of the core. The SQLite core only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8438 ** provides implementations for these routines when it is compiled
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8439 ** with the SQLITE_DEBUG flag. External mutex implementations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8440 ** are only required to provide these routines if SQLITE_DEBUG is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8441 ** defined and if NDEBUG is not defined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8442 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8443 ** These routines should return true if the mutex in their argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8444 ** is held or not held, respectively, by the calling thread.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8445 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8446 ** The implementation is not required to provide versions of these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8447 ** routines that actually work. If the implementation does not provide working
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8448 ** versions of these routines, it should at least provide stubs that always
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8449 ** return true so that one does not get spurious assertion failures.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8450 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8451 ** If the argument to sqlite3_mutex_held() is a NULL pointer then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8452 ** the routine should return 1. This seems counter-intuitive since
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8453 ** clearly the mutex cannot be held if it does not exist. But
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8454 ** the reason the mutex does not exist is because the build is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8455 ** using mutexes. And we do not want the assert() containing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8456 ** call to sqlite3_mutex_held() to fail, so a non-zero return is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8457 ** the appropriate thing to do. The sqlite3_mutex_notheld()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8458 ** interface should also return 1 when given a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8459 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8460 #ifndef NDEBUG
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8461 SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8462 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8463 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8464
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8465 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8466 ** CAPI3REF: Mutex Types
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8467 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8468 ** The [sqlite3_mutex_alloc()] interface takes a single argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8469 ** which is one of these integer constants.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8470 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8471 ** The set of static mutexes may change from one SQLite release to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8472 ** next. Applications that override the built-in mutex logic must be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8473 ** prepared to accommodate additional static mutexes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8474 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8475 #define SQLITE_MUTEX_FAST 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8476 #define SQLITE_MUTEX_RECURSIVE 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8477 #define SQLITE_MUTEX_STATIC_MAIN 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8478 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8479 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8480 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8481 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8482 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8483 #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8484 #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8485 #define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8486 #define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8487 #define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8488 #define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8489 #define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8490 #define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8491
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8492 /* Legacy compatibility: */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8493 #define SQLITE_MUTEX_STATIC_MASTER 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8494
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8495
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8496 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8497 ** CAPI3REF: Retrieve the mutex for a database connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8498 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8499 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8500 ** ^This interface returns a pointer to the [sqlite3_mutex] object that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8501 ** serializes access to the [database connection] given in the argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8502 ** when the [threading mode] is Serialized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8503 ** ^If the [threading mode] is Single-thread or Multi-thread then this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8504 ** routine returns a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8505 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8506 SQLITE_API sqlite3_mutex sqlite3_db_mutex(sqlite3);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8507
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8508 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8509 ** CAPI3REF: Low-Level Control Of Database Files
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8510 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8511 ** KEYWORDS: {file control}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8512 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8513 ** ^The [sqlite3_file_control()] interface makes a direct call to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8514 ** xFileControl method for the [sqlite3_io_methods] object associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8515 ** with a particular database identified by the second argument. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8516 ** name of the database is "main" for the main database or "temp" for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8517 ** TEMP database, or the name that appears after the AS keyword for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8518 ** databases that are added using the [ATTACH] SQL command.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8519 ** ^A NULL pointer can be used in place of "main" to refer to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8520 ** main database file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8521 ** ^The third and fourth parameters to this routine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8522 ** are passed directly through to the second and third parameters of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8523 ** the xFileControl method. ^The return value of the xFileControl
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8524 ** method becomes the return value of this routine.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8525 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8526 ** A few opcodes for [sqlite3_file_control()] are handled directly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8527 ** by the SQLite core and never invoke the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8528 ** sqlite3_io_methods.xFileControl method.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8529 ** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8530 ** a pointer to the underlying [sqlite3_file] object to be written into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8531 ** the space pointed to by the 4th parameter. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8532 ** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8533 ** the [sqlite3_file] object associated with the journal file instead of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8534 ** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8535 ** a pointer to the underlying [sqlite3_vfs] object for the file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8536 ** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8537 ** from the pager.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8538 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8539 ** ^If the second parameter (zDbName) does not match the name of any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8540 ** open database file, then SQLITE_ERROR is returned. ^This error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8541 ** code is not remembered and will not be recalled by [sqlite3_errcode()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8542 ** or [sqlite3_errmsg()]. The underlying xFileControl method might
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8543 ** also return SQLITE_ERROR. There is no way to distinguish between
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8544 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8545 ** xFileControl method.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8546 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8547 ** See also: [file control opcodes]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8548 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8549 SQLITE_API int sqlite3_file_control(sqlite3, const char zDbName, int op, void*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8550
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8551 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8552 ** CAPI3REF: Testing Interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8553 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8554 ** ^The sqlite3_test_control() interface is used to read out internal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8555 ** state of SQLite and to inject faults into SQLite for testing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8556 ** purposes. ^The first parameter is an operation code that determines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8557 ** the number, meaning, and operation of all subsequent parameters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8558 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8559 ** This interface is not for use by applications. It exists solely
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8560 ** for verifying the correct operation of the SQLite library. Depending
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8561 ** on how the SQLite library is compiled, this interface might not exist.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8562 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8563 ** The details of the operation codes, their meanings, the parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8564 ** they take, and what they do are all subject to change without notice.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8565 ** Unlike most of the SQLite API, this function is not guaranteed to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8566 ** operate consistently from one release to the next.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8567 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8568 SQLITE_API int sqlite3_test_control(int op, ...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8569
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8570 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8571 ** CAPI3REF: Testing Interface Operation Codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8572 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8573 ** These constants are the valid operation code parameters used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8574 ** as the first argument to [sqlite3_test_control()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8575 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8576 ** These parameters and their meanings are subject to change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8577 ** without notice. These values are for testing purposes only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8578 ** Applications should not use any of these parameters or the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8579 ** [sqlite3_test_control()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8580 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8581 #define SQLITE_TESTCTRL_FIRST 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8582 #define SQLITE_TESTCTRL_PRNG_SAVE 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8583 #define SQLITE_TESTCTRL_PRNG_RESTORE 6
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8584 #define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8585 #define SQLITE_TESTCTRL_FK_NO_ACTION 7
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8586 #define SQLITE_TESTCTRL_BITVEC_TEST 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8587 #define SQLITE_TESTCTRL_FAULT_INSTALL 9
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8588 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8589 #define SQLITE_TESTCTRL_PENDING_BYTE 11
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8590 #define SQLITE_TESTCTRL_ASSERT 12
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8591 #define SQLITE_TESTCTRL_ALWAYS 13
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8592 #define SQLITE_TESTCTRL_RESERVE 14 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8593 #define SQLITE_TESTCTRL_JSON_SELFCHECK 14
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8594 #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8595 #define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8596 #define SQLITE_TESTCTRL_GETOPT 16
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8597 #define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8598 #define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8599 #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8600 #define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8601 #define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8602 #define SQLITE_TESTCTRL_NEVER_CORRUPT 20
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8603 #define SQLITE_TESTCTRL_VDBE_COVERAGE 21
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8604 #define SQLITE_TESTCTRL_BYTEORDER 22
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8605 #define SQLITE_TESTCTRL_ISINIT 23
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8606 #define SQLITE_TESTCTRL_SORTER_MMAP 24
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8607 #define SQLITE_TESTCTRL_IMPOSTER 25
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8608 #define SQLITE_TESTCTRL_PARSER_COVERAGE 26
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8609 #define SQLITE_TESTCTRL_RESULT_INTREAL 27
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8610 #define SQLITE_TESTCTRL_PRNG_SEED 28
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8611 #define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8612 #define SQLITE_TESTCTRL_SEEK_COUNT 30
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8613 #define SQLITE_TESTCTRL_TRACEFLAGS 31
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8614 #define SQLITE_TESTCTRL_TUNE 32
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8615 #define SQLITE_TESTCTRL_LOGEST 33
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8616 #define SQLITE_TESTCTRL_USELONGDOUBLE 34 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8617 #define SQLITE_TESTCTRL_LAST 34 /* Largest TESTCTRL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8618
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8619 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8620 ** CAPI3REF: SQL Keyword Checking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8621 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8622 ** These routines provide access to the set of SQL language keywords
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8623 ** recognized by SQLite. Applications can use these routines to determine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8624 ** whether or not a specific identifier needs to be escaped (for example,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8625 ** by enclosing in double-quotes) so as not to confuse the parser.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8626 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8627 ** The sqlite3_keyword_count() interface returns the number of distinct
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8628 ** keywords understood by SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8629 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8630 ** The sqlite3_keyword_name(N,Z,L) interface finds the 0-based N-th keyword and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8631 ** makes *Z point to that keyword expressed as UTF8 and writes the number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8632 ** of bytes in the keyword into L. The string that Z points to is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8633 ** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8634 ** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8635 ** or L are NULL or invalid pointers then calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8636 ** sqlite3_keyword_name(N,Z,L) result in undefined behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8637 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8638 ** The sqlite3_keyword_check(Z,L) interface checks to see whether or not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8639 ** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8640 ** if it is and zero if not.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8641 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8642 ** The parser used by SQLite is forgiving. It is often possible to use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8643 ** a keyword as an identifier as long as such use does not result in a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8644 ** parsing ambiguity. For example, the statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8645 ** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8646 ** creates a new table named "BEGIN" with three columns named
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8647 ** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8648 ** using keywords as identifiers. Common techniques used to avoid keyword
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8649 ** name collisions include:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8650 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8651 ** <li> Put all identifier names inside double-quotes. This is the official
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8652 ** SQL way to escape identifier names.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8653 ** <li> Put identifier names inside [...]. This is not standard SQL,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8654 ** but it is what SQL Server does and so lots of programmers use this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8655 ** technique.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8656 ** <li> Begin every identifier with the letter "Z" as no SQL keywords start
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8657 ** with "Z".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8658 ** <li> Include a digit somewhere in every identifier name.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8659 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8660 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8661 ** Note that the number of keywords understood by SQLite can depend on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8662 ** compile-time options. For example, "VACUUM" is not a keyword if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8663 ** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8664 ** new keywords may be added to future releases of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8665 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8666 SQLITE_API int sqlite3_keyword_count(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8667 SQLITE_API int sqlite3_keyword_name(int,const char*,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8668 SQLITE_API int sqlite3_keyword_check(const char*,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8669
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8670 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8671 ** CAPI3REF: Dynamic String Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8672 ** KEYWORDS: {dynamic string}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8673 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8674 ** An instance of the sqlite3_str object contains a dynamically-sized
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8675 ** string under construction.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8676 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8677 ** The lifecycle of an sqlite3_str object is as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8678 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8679 ** <li> ^The sqlite3_str object is created using [sqlite3_str_new()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8680 ** <li> ^Text is appended to the sqlite3_str object using various
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8681 ** methods, such as [sqlite3_str_appendf()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8682 ** <li> ^The sqlite3_str object is destroyed and the string it created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8683 ** is returned using the [sqlite3_str_finish()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8684 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8685 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8686 typedef struct sqlite3_str sqlite3_str;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8687
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8688 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8689 ** CAPI3REF: Create A New Dynamic String Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8690 ** CONSTRUCTOR: sqlite3_str
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8691 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8692 ** ^The [sqlite3_str_new(D)] interface allocates and initializes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8693 ** a new [sqlite3_str] object. To avoid memory leaks, the object returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8694 ** [sqlite3_str_new()] must be freed by a subsequent call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8695 ** [sqlite3_str_finish(X)].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8696 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8697 ** ^The [sqlite3_str_new(D)] interface always returns a pointer to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8698 ** valid [sqlite3_str] object, though in the event of an out-of-memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8699 ** error the returned object might be a special singleton that will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8700 ** silently reject new text, always return SQLITE_NOMEM from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8701 ** [sqlite3_str_errcode()], always return 0 for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8702 ** [sqlite3_str_length()], and always return NULL from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8703 ** [sqlite3_str_finish(X)]. It is always safe to use the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8704 ** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8705 ** to any of the other [sqlite3_str] methods.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8706 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8707 ** The D parameter to [sqlite3_str_new(D)] may be NULL. If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8708 ** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8709 ** length of the string contained in the [sqlite3_str] object will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8710 ** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8711 ** of [SQLITE_MAX_LENGTH].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8712 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8713 SQLITE_API sqlite3_str sqlite3_str_new(sqlite3);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8714
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8715 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8716 ** CAPI3REF: Finalize A Dynamic String
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8717 ** DESTRUCTOR: sqlite3_str
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8718 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8719 ** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8720 ** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8721 ** that contains the constructed string. The calling application should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8722 ** pass the returned value to [sqlite3_free()] to avoid a memory leak.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8723 ** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8724 ** errors were encountered during construction of the string. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8725 ** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8726 ** string in [sqlite3_str] object X is zero bytes long.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8727 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8728 SQLITE_API char sqlite3_str_finish(sqlite3_str);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8729
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8730 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8731 ** CAPI3REF: Add Content To A Dynamic String
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8732 ** METHOD: sqlite3_str
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8733 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8734 ** These interfaces add content to an sqlite3_str object previously obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8735 ** from [sqlite3_str_new()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8736 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8737 ** ^The [sqlite3_str_appendf(X,F,...)] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8738 ** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8739 ** functionality of SQLite to append formatted text onto the end of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8740 ** [sqlite3_str] object X.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8741 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8742 ** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8743 ** onto the end of the [sqlite3_str] object X. N must be non-negative.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8744 ** S must contain at least N non-zero bytes of content. To append a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8745 ** zero-terminated string in its entirety, use the [sqlite3_str_appendall()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8746 ** method instead.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8747 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8748 ** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8749 ** zero-terminated string S onto the end of [sqlite3_str] object X.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8750 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8751 ** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8752 ** single-byte character C onto the end of [sqlite3_str] object X.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8753 ** ^This method can be used, for example, to add whitespace indentation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8754 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8755 ** ^The [sqlite3_str_reset(X)] method resets the string under construction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8756 ** inside [sqlite3_str] object X back to zero bytes in length.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8757 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8758 ** These methods do not return a result code. ^If an error occurs, that fact
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8759 ** is recorded in the [sqlite3_str] object and can be recovered by a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8760 ** subsequent call to [sqlite3_str_errcode(X)].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8761 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8762 SQLITE_API void sqlite3_str_appendf(sqlite3_str, const char zFormat, ...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8763 SQLITE_API void sqlite3_str_vappendf(sqlite3_str, const char zFormat, va_list);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8764 SQLITE_API void sqlite3_str_append(sqlite3_str, const char zIn, int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8765 SQLITE_API void sqlite3_str_appendall(sqlite3_str, const char zIn);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8766 SQLITE_API void sqlite3_str_appendchar(sqlite3_str*, int N, char C);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8767 SQLITE_API void sqlite3_str_reset(sqlite3_str*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8768
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8769 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8770 ** CAPI3REF: Status Of A Dynamic String
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8771 ** METHOD: sqlite3_str
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8772 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8773 ** These interfaces return the current status of an [sqlite3_str] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8774 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8775 ** ^If any prior errors have occurred while constructing the dynamic string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8776 ** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8777 ** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8778 ** [SQLITE_NOMEM] following any out-of-memory error, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8779 ** [SQLITE_TOOBIG] if the size of the dynamic string exceeds
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8780 ** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8781 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8782 ** ^The [sqlite3_str_length(X)] method returns the current length, in bytes,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8783 ** of the dynamic string under construction in [sqlite3_str] object X.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8784 ** ^The length returned by [sqlite3_str_length(X)] does not include the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8785 ** zero-termination byte.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8786 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8787 ** ^The [sqlite3_str_value(X)] method returns a pointer to the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8788 ** content of the dynamic string under construction in X. The value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8789 ** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8790 ** and might be freed or altered by any subsequent method on the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8791 ** [sqlite3_str] object. Applications must not use the pointer returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8792 ** [sqlite3_str_value(X)] after any subsequent method call on the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8793 ** object. ^Applications may change the content of the string returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8794 ** by [sqlite3_str_value(X)] as long as they do not write into any bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8795 ** outside the range of 0 to [sqlite3_str_length(X)] and do not read or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8796 ** write any byte after any subsequent sqlite3_str method call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8797 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8798 SQLITE_API int sqlite3_str_errcode(sqlite3_str*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8799 SQLITE_API int sqlite3_str_length(sqlite3_str*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8800 SQLITE_API char sqlite3_str_value(sqlite3_str);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8801
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8802 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8803 ** CAPI3REF: SQLite Runtime Status
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8804 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8805 ** ^These interfaces are used to retrieve runtime status information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8806 ** about the performance of SQLite, and optionally to reset various
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8807 ** highwater marks. ^The first argument is an integer code for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8808 ** the specific parameter to measure. ^(Recognized integer codes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8809 ** are of the form [status parameters \| SQLITE_STATUS_...].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8810 ** ^The current value of the parameter is returned into *pCurrent.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8811 ** ^The highest recorded value is returned in *pHighwater. ^If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8812 ** resetFlag is true, then the highest record value is reset after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8813 ** *pHighwater is written. ^(Some parameters do not record the highest
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8814 ** value. For those parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8815 ** nothing is written into *pHighwater and the resetFlag is ignored.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8816 ** ^(Other parameters record only the highwater mark and not the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8817 ** value. For these latter parameters nothing is written into *pCurrent.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8818 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8819 ** ^The sqlite3_status() and sqlite3_status64() routines return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8820 ** SQLITE_OK on success and a non-zero [error code] on failure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8821 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8822 ** If either the current value or the highwater mark is too large to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8823 ** be represented by a 32-bit integer, then the values returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8824 ** sqlite3_status() are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8825 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8826 ** See also: [sqlite3_db_status()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8827 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8828 SQLITE_API int sqlite3_status(int op, int pCurrent, int pHighwater, int resetFlag);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8829 SQLITE_API int sqlite3_status64(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8830 int op,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8831 sqlite3_int64 *pCurrent,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8832 sqlite3_int64 *pHighwater,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8833 int resetFlag
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8834 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8835
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8836
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8837 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8838 ** CAPI3REF: Status Parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8839 ** KEYWORDS: {status parameters}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8840 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8841 ** These integer constants designate various run-time status parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8842 ** that can be returned by [sqlite3_status()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8843 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8844 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8845 ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8846 ** <dd>This parameter is the current amount of memory checked out
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8847 ** using [sqlite3_malloc()], either directly or indirectly. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8848 ** figure includes calls made to [sqlite3_malloc()] by the application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8849 ** and internal memory usage by the SQLite library. Auxiliary page-cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8850 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8851 ** this parameter. The amount returned is the sum of the allocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8852 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8853 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8854 ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8855 ** <dd>This parameter records the largest memory allocation request
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8856 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8857 ** internal equivalents). Only the value returned in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8858 ** *pHighwater parameter to [sqlite3_status()] is of interest.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8859 ** The value written into the *pCurrent parameter is undefined.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8860 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8861 ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8862 ** <dd>This parameter records the number of separate memory allocations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8863 ** currently checked out.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8864 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8865 ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8866 ** <dd>This parameter returns the number of pages used out of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8867 ** [pagecache memory allocator] that was configured using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8868 ** [SQLITE_CONFIG_PAGECACHE]. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8869 ** value returned is in pages, not in bytes.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8870 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8871 ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8872 ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8873 ** <dd>This parameter returns the number of bytes of page cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8874 ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8875 ** buffer and where forced to overflow to [sqlite3_malloc()]. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8876 ** returned value includes allocations that overflowed because they
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8877 ** were too large (they were larger than the "sz" parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8878 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8879 ** no space was left in the page cache.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8880 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8881 ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8882 ** <dd>This parameter records the largest memory allocation request
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8883 ** handed to the [pagecache memory allocator]. Only the value returned in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8884 ** *pHighwater parameter to [sqlite3_status()] is of interest.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8885 ** The value written into the *pCurrent parameter is undefined.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8886 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8887 ** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8888 ** <dd>No longer used.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8889 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8890 ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8891 ** <dd>No longer used.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8892 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8893 ** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8894 ** <dd>No longer used.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8895 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8896 ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8897 ** <dd>The *pHighwater parameter records the deepest parser stack.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8898 ** The pCurrent value is undefined. The pHighwater value is only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8899 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8900 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8901 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8902 ** New status parameters may be added from time to time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8903 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8904 #define SQLITE_STATUS_MEMORY_USED 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8905 #define SQLITE_STATUS_PAGECACHE_USED 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8906 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8907 #define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8908 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8909 #define SQLITE_STATUS_MALLOC_SIZE 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8910 #define SQLITE_STATUS_PARSER_STACK 6
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8911 #define SQLITE_STATUS_PAGECACHE_SIZE 7
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8912 #define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8913 #define SQLITE_STATUS_MALLOC_COUNT 9
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8914
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8915 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8916 ** CAPI3REF: Database Connection Status
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8917 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8918 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8919 ** ^This interface is used to retrieve runtime status information
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8920 ** about a single [database connection]. ^The first argument is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8921 ** database connection object to be interrogated. ^The second argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8922 ** is an integer constant, taken from the set of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8923 ** [SQLITE_DBSTATUS options], that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8924 ** determines the parameter to interrogate. The set of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8925 ** [SQLITE_DBSTATUS options] is likely
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8926 ** to grow in future releases of SQLite.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8927 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8928 ** ^The current value of the requested parameter is written into *pCur
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8929 ** and the highest instantaneous value is written into *pHiwtr. ^If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8930 ** the resetFlg is true, then the highest instantaneous value is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8931 ** reset back down to the current value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8932 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8933 ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8934 ** non-zero [error code] on failure.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8935 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8936 ** ^The sqlite3_db_status64(D,O,C,H,R) routine works exactly the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8937 ** way as sqlite3_db_status(D,O,C,H,R) routine except that the C and H
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8938 ** parameters are pointer to 64-bit integers (type: sqlite3_int64) instead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8939 ** of pointers to 32-bit integers, which allows larger status values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8940 ** to be returned. If a status value exceeds 2,147,483,647 then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8941 ** sqlite3_db_status() will truncate the value whereas sqlite3_db_status64()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8942 ** will return the full value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8943 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8944 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8945 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8946 SQLITE_API int sqlite3_db_status(sqlite3, int op, int pCur, int *pHiwtr, int resetFlg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8947 SQLITE_API int sqlite3_db_status64(sqlite3,int,sqlite3_int64,sqlite3_int64*,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8948
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8949 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8950 ** CAPI3REF: Status Parameters for database connections
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8951 ** KEYWORDS: {SQLITE_DBSTATUS options}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8952 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8953 ** These constants are the available integer "verbs" that can be passed as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8954 ** the second argument to the [sqlite3_db_status()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8955 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8956 ** New verbs may be added in future releases of SQLite. Existing verbs
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8957 ** might be discontinued. Applications should check the return code from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8958 ** [sqlite3_db_status()] to make sure that the call worked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8959 ** The [sqlite3_db_status()] interface will return a non-zero error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8960 ** if a discontinued or unsupported verb is invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8961 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8962 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8963 ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8964 ** <dd>This parameter returns the number of lookaside memory slots currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8965 ** checked out.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8966 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8967 ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8968 ** <dd>This parameter returns the number of malloc attempts that were
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8969 ** satisfied using lookaside memory. Only the high-water value is meaningful;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8970 ** the current value is always zero.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8971 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8972 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8973 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8974 ** <dd>This parameter returns the number of malloc attempts that might have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8975 ** been satisfied using lookaside memory but failed due to the amount of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8976 ** memory requested being larger than the lookaside slot size.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8977 ** Only the high-water value is meaningful;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8978 ** the current value is always zero.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8979 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8980 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8981 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8982 ** <dd>This parameter returns the number of malloc attempts that might have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8983 ** been satisfied using lookaside memory but failed due to all lookaside
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8984 ** memory already being in use.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8985 ** Only the high-water value is meaningful;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8986 ** the current value is always zero.</dd>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8987 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8988 ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8989 ** <dd>This parameter returns the approximate number of bytes of heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8990 ** memory used by all pager caches associated with the database connection.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8991 ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8992 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8993 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8994 ** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8995 ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8996 ** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8997 ** pager cache is shared between two or more connections the bytes of heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8998 ** memory used by that pager cache is divided evenly between the attached
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	8999 ** connections.)^ In other words, if none of the pager caches associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9000 ** with the database connection are shared, this request returns the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9001 ** value as DBSTATUS_CACHE_USED. Or, if one or more of the pager caches are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9002 ** shared, the value returned by this call will be smaller than that returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9003 ** by DBSTATUS_CACHE_USED. ^The highwater mark associated with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9004 ** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9005 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9006 ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9007 ** <dd>This parameter returns the approximate number of bytes of heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9008 ** memory used to store the schema for all databases associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9009 ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9010 ** ^The full amount of memory used by the schemas is reported, even if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9011 ** schema memory is shared with other database connections due to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9012 ** [shared cache mode] being enabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9013 ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9014 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9015 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9016 ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9017 ** <dd>This parameter returns the approximate number of bytes of heap
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9018 ** and lookaside memory used by all prepared statements associated with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9019 ** the database connection.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9020 ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9021 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9022 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9023 ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9024 ** <dd>This parameter returns the number of pager cache hits that have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9025 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9026 ** is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9027 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9028 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9029 ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9030 ** <dd>This parameter returns the number of pager cache misses that have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9031 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9032 ** is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9033 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9034 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9035 ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9036 ** <dd>This parameter returns the number of dirty cache entries that have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9037 ** been written to disk. Specifically, the number of pages written to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9038 ** wal file in wal mode databases, or the number of pages written to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9039 ** database file in rollback mode databases. Any pages written as part of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9040 ** transaction rollback or database recovery operations are not included.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9041 ** If an IO or other error occurs while writing a page to disk, the effect
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9042 ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9043 ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9044 ** <p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9045 ** ^(There is overlap between the quantities measured by this parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9046 ** (SQLITE_DBSTATUS_CACHE_WRITE) and SQLITE_DBSTATUS_TEMPBUF_SPILL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9047 ** Resetting one will reduce the other.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9048 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9049 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9050 ** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9051 ** <dd>This parameter returns the number of dirty cache entries that have
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9052 ** been written to disk in the middle of a transaction due to the page
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9053 ** cache overflowing. Transactions are more efficient if they are written
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9054 ** to disk all at once. When pages spill mid-transaction, that introduces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9055 ** additional overhead. This parameter can be used to help identify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9056 ** inefficiencies that can be resolved by increasing the cache size.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9057 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9058 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9059 ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9060 ** <dd>This parameter returns zero for the current value if and only if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9061 ** all foreign key constraints (deferred or immediate) have been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9062 ** resolved.)^ ^The highwater mark is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9063 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9064 ** [[SQLITE_DBSTATUS_TEMPBUF_SPILL] ^(<dt>SQLITE_DBSTATUS_TEMPBUF_SPILL</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9065 ** <dd>^(This parameter returns the number of bytes written to temporary
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9066 ** files on disk that could have been kept in memory had sufficient memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9067 ** been available. This value includes writes to intermediate tables that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9068 ** are part of complex queries, external sorts that spill to disk, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9069 ** writes to TEMP tables.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9070 ** ^The highwater mark is always 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9071 ** <p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9072 ** ^(There is overlap between the quantities measured by this parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9073 ** (SQLITE_DBSTATUS_TEMPBUF_SPILL) and SQLITE_DBSTATUS_CACHE_WRITE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9074 ** Resetting one will reduce the other.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9075 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9076 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9077 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9078 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9079 #define SQLITE_DBSTATUS_CACHE_USED 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9080 #define SQLITE_DBSTATUS_SCHEMA_USED 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9081 #define SQLITE_DBSTATUS_STMT_USED 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9082 #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9083 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9084 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9085 #define SQLITE_DBSTATUS_CACHE_HIT 7
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9086 #define SQLITE_DBSTATUS_CACHE_MISS 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9087 #define SQLITE_DBSTATUS_CACHE_WRITE 9
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9088 #define SQLITE_DBSTATUS_DEFERRED_FKS 10
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9089 #define SQLITE_DBSTATUS_CACHE_USED_SHARED 11
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9090 #define SQLITE_DBSTATUS_CACHE_SPILL 12
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9091 #define SQLITE_DBSTATUS_TEMPBUF_SPILL 13
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9092 #define SQLITE_DBSTATUS_MAX 13 /* Largest defined DBSTATUS */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9093
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9094
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9095 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9096 ** CAPI3REF: Prepared Statement Status
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9097 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9098 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9099 ** ^(Each prepared statement maintains various
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9100 ** [SQLITE_STMTSTATUS counters] that measure the number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9101 ** of times it has performed specific operations.)^ These counters can
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9102 ** be used to monitor the performance characteristics of the prepared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9103 ** statements. For example, if the number of table steps greatly exceeds
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9104 ** the number of table searches or result rows, that would tend to indicate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9105 ** that the prepared statement is using a full table scan rather than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9106 ** an index.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9107 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9108 ** ^(This interface is used to retrieve and reset counter values from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9109 ** a [prepared statement]. The first argument is the prepared statement
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9110 ** object to be interrogated. The second argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9111 ** is an integer code for a specific [SQLITE_STMTSTATUS counter]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9112 ** to be interrogated.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9113 ** ^The current value of the requested counter is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9114 ** ^If the resetFlg is true, then the counter is reset to zero after this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9115 ** interface call returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9116 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9117 ** See also: [sqlite3_status()] and [sqlite3_db_status()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9118 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9119 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9120
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9121 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9122 ** CAPI3REF: Status Parameters for prepared statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9123 ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9124 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9125 ** These preprocessor macros define integer codes that name counter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9126 ** values associated with the [sqlite3_stmt_status()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9127 ** The meanings of the various counters are as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9128 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9129 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9130 ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9131 ** <dd>^This is the number of times that SQLite has stepped forward in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9132 ** a table as part of a full table scan. Large numbers for this counter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9133 ** may indicate opportunities for performance improvement through
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9134 ** careful use of indices.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9135 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9136 ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9137 ** <dd>^This is the number of sort operations that have occurred.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9138 ** A non-zero value in this counter may indicate an opportunity to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9139 ** improve performance through careful use of indices.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9140 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9141 ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9142 ** <dd>^This is the number of rows inserted into transient indices that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9143 ** were created automatically in order to help joins run faster.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9144 ** A non-zero value in this counter may indicate an opportunity to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9145 ** improve performance by adding permanent indices that do not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9146 ** need to be reinitialized each time the statement is run.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9147 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9148 ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9149 ** <dd>^This is the number of virtual machine operations executed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9150 ** by the prepared statement if that number is less than or equal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9151 ** to 2147483647. The number of virtual machine operations can be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9152 ** used as a proxy for the total work done by the prepared statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9153 ** If the number of virtual machine operations exceeds 2147483647
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9154 ** then the value returned by this statement status code is undefined.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9155 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9156 ** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9157 ** <dd>^This is the number of times that the prepare statement has been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9158 ** automatically regenerated due to schema changes or changes to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9159 ** [bound parameters] that might affect the query plan.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9160 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9161 ** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9162 ** <dd>^This is the number of times that the prepared statement has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9163 ** been run. A single "run" for the purposes of this counter is one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9164 ** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9165 ** The counter is incremented on the first [sqlite3_step()] call of each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9166 ** cycle.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9167 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9168 ** [[SQLITE_STMTSTATUS_FILTER_MISS]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9169 ** [[SQLITE_STMTSTATUS_FILTER HIT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9170 ** <dt>SQLITE_STMTSTATUS_FILTER_HIT<br>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9171 ** SQLITE_STMTSTATUS_FILTER_MISS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9172 ** <dd>^SQLITE_STMTSTATUS_FILTER_HIT is the number of times that a join
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9173 ** step was bypassed because a Bloom filter returned not-found. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9174 ** corresponding SQLITE_STMTSTATUS_FILTER_MISS value is the number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9175 ** times that the Bloom filter returned a find, and thus the join step
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9176 ** had to be processed as normal.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9177 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9178 ** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9179 ** <dd>^This is the approximate number of bytes of heap memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9180 ** used to store the prepared statement. ^This value is not actually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9181 ** a counter, and so the resetFlg parameter to sqlite3_stmt_status()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9182 ** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9183 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9184 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9185 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9186 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9187 #define SQLITE_STMTSTATUS_SORT 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9188 #define SQLITE_STMTSTATUS_AUTOINDEX 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9189 #define SQLITE_STMTSTATUS_VM_STEP 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9190 #define SQLITE_STMTSTATUS_REPREPARE 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9191 #define SQLITE_STMTSTATUS_RUN 6
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9192 #define SQLITE_STMTSTATUS_FILTER_MISS 7
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9193 #define SQLITE_STMTSTATUS_FILTER_HIT 8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9194 #define SQLITE_STMTSTATUS_MEMUSED 99
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9195
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9196 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9197 ** CAPI3REF: Custom Page Cache Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9198 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9199 ** The sqlite3_pcache type is opaque. It is implemented by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9200 ** the pluggable module. The SQLite core has no knowledge of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9201 ** its size or internal structure and never deals with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9202 ** sqlite3_pcache object except by holding and passing pointers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9203 ** to the object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9204 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9205 ** See [sqlite3_pcache_methods2] for additional information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9206 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9207 typedef struct sqlite3_pcache sqlite3_pcache;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9208
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9209 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9210 ** CAPI3REF: Custom Page Cache Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9211 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9212 ** The sqlite3_pcache_page object represents a single page in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9213 ** page cache. The page cache will allocate instances of this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9214 ** object. Various methods of the page cache use pointers to instances
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9215 ** of this object as parameters or as their return value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9216 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9217 ** See [sqlite3_pcache_methods2] for additional information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9218 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9219 typedef struct sqlite3_pcache_page sqlite3_pcache_page;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9220 struct sqlite3_pcache_page {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9221 void pBuf; / The content of the page */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9222 void pExtra; / Extra information associated with the page */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9223 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9224
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9225 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9226 ** CAPI3REF: Application Defined Page Cache.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9227 ** KEYWORDS: {page cache}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9228 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9229 ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9230 ** register an alternative page cache implementation by passing in an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9231 ** instance of the sqlite3_pcache_methods2 structure.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9232 ** In many applications, most of the heap memory allocated by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9233 ** SQLite is used for the page cache.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9234 ** By implementing a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9235 ** custom page cache using this API, an application can better control
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9236 ** the amount of memory consumed by SQLite, the way in which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9237 ** that memory is allocated and released, and the policies used to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9238 ** determine exactly which parts of a database file are cached and for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9239 ** how long.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9240 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9241 ** The alternative page cache mechanism is an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9242 ** extreme measure that is only needed by the most demanding applications.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9243 ** The built-in page cache is recommended for most uses.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9244 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9245 ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9246 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9247 ** the application may discard the parameter after the call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9248 ** [sqlite3_config()] returns.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9249 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9250 ** [[the xInit() page cache method]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9251 ** ^(The xInit() method is called once for each effective
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9252 ** call to [sqlite3_initialize()])^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9253 ** (usually only once during the lifetime of the process). ^(The xInit()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9254 ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9255 ** The intent of the xInit() method is to set up global data structures
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9256 ** required by the custom page cache implementation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9257 ** ^(If the xInit() method is NULL, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9258 ** built-in default page cache is used instead of the application defined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9259 ** page cache.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9260 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9261 ** [[the xShutdown() page cache method]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9262 ** ^The xShutdown() method is called by [sqlite3_shutdown()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9263 ** It can be used to clean up
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9264 ** any outstanding resources before process shutdown, if required.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9265 ** ^The xShutdown() method may be NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9266 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9267 ** ^SQLite automatically serializes calls to the xInit method,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9268 ** so the xInit method need not be threadsafe. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9269 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9270 ** not need to be threadsafe either. All other methods must be threadsafe
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9271 ** in multithreaded applications.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9272 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9273 ** ^SQLite will never invoke xInit() more than once without an intervening
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9274 ** call to xShutdown().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9275 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9276 ** [[the xCreate() page cache methods]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9277 ** ^SQLite invokes the xCreate() method to construct a new cache instance.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9278 ** SQLite will typically create one cache instance for each open database file,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9279 ** though this is not guaranteed. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9280 ** first parameter, szPage, is the size in bytes of the pages that must
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9281 ** be allocated by the cache. ^szPage will always be a power of two. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9282 ** second parameter szExtra is a number of bytes of extra storage
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9283 ** associated with each page cache entry. ^The szExtra parameter will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9284 ** a number less than 250. SQLite will use the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9285 ** extra szExtra bytes on each page to store metadata about the underlying
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9286 ** database page on disk. The value passed into szExtra depends
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9287 ** on the SQLite version, the target platform, and how SQLite was compiled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9288 ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9289 ** created will be used to cache database pages of a file stored on disk, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9290 ** false if it is used for an in-memory database. The cache implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9291 ** does not have to do anything special based upon the value of bPurgeable;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9292 ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9293 ** never invoke xUnpin() except to deliberately delete a page.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9294 ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9295 ** false will always have the "discard" flag set to true.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9296 ** ^Hence, a cache created with bPurgeable set to false will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9297 ** never contain any unpinned pages.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9298 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9299 ** [[the xCachesize() page cache method]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9300 ** ^(The xCachesize() method may be called at any time by SQLite to set the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9301 ** suggested maximum cache-size (number of pages stored) for the cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9302 ** instance passed as the first argument. This is the value configured using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9303 ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9304 ** parameter, the implementation is not required to do anything with this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9305 ** value; it is advisory only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9306 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9307 ** [[the xPagecount() page cache methods]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9308 ** The xPagecount() method must return the number of pages currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9309 ** stored in the cache, both pinned and unpinned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9310 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9311 ** [[the xFetch() page cache methods]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9312 ** The xFetch() method locates a page in the cache and returns a pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9313 ** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9314 ** The pBuf element of the returned sqlite3_pcache_page object will be a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9315 ** pointer to a buffer of szPage bytes used to store the content of a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9316 ** single database page. The pExtra element of sqlite3_pcache_page will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9317 ** a pointer to the szExtra bytes of extra storage that SQLite has requested
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9318 ** for each entry in the page cache.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9319 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9320 ** The page to be fetched is determined by the key. ^The minimum key value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9321 ** is 1. After it has been retrieved using xFetch, the page is considered
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9322 ** to be "pinned".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9323 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9324 ** If the requested page is already in the page cache, then the page cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9325 ** implementation must return a pointer to the page buffer with its content
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9326 ** intact. If the requested page is not already in the cache, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9327 ** cache implementation should use the value of the createFlag
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9328 ** parameter to help it determine what action to take:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9329 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9330 ** <table border=1 width=85% align=center>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9331 ** <tr><th> createFlag <th> Behavior when page is not already in cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9332 ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9333 ** <tr><td> 1 <td> Allocate a new page if it is easy and convenient to do so.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9334 ** Otherwise return NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9335 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9336 ** NULL if allocating a new page is effectively impossible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9337 ** </table>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9338 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9339 ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9340 ** will only use a createFlag of 2 after a prior call with a createFlag of 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9341 ** failed.)^ In between the xFetch() calls, SQLite may
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9342 ** attempt to unpin one or more cache pages by spilling the content of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9343 ** pinned pages to disk and synching the operating system disk cache.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9344 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9345 ** [[the xUnpin() page cache method]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9346 ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9347 ** as its second argument. If the third parameter, discard, is non-zero,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9348 ** then the page must be evicted from the cache.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9349 ** ^If the discard parameter is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9350 ** zero, then the page may be discarded or retained at the discretion of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9351 ** page cache implementation. ^The page cache implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9352 ** may choose to evict unpinned pages at any time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9353 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9354 ** The cache must not perform any reference counting. A single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9355 ** call to xUnpin() unpins the page regardless of the number of prior calls
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9356 ** to xFetch().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9357 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9358 ** [[the xRekey() page cache methods]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9359 ** The xRekey() method is used to change the key value associated with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9360 ** page passed as the second argument. If the cache
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9361 ** previously contains an entry associated with newKey, it must be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9362 ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9363 ** to be pinned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9364 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9365 ** When SQLite calls the xTruncate() method, the cache must discard all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9366 ** existing cache entries with page numbers (keys) greater than or equal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9367 ** to the value of the iLimit parameter passed to xTruncate(). If any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9368 ** of these pages are pinned, they become implicitly unpinned, meaning that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9369 ** they can be safely discarded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9370 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9371 ** [[the xDestroy() page cache method]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9372 ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9373 ** All resources associated with the specified cache should be freed. ^After
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9374 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9375 ** handle invalid, and will not use it with any other sqlite3_pcache_methods2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9376 ** functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9377 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9378 ** [[the xShrink() page cache method]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9379 ** ^SQLite invokes the xShrink() method when it wants the page cache to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9380 ** free up as much of heap memory as possible. The page cache implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9381 ** is not obligated to free any memory, but well-behaved implementations should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9382 ** do their best.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9383 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9384 typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9385 struct sqlite3_pcache_methods2 {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9386 int iVersion;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9387 void *pArg;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9388 int (xInit)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9389 void (xShutdown)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9390 sqlite3_pcache (xCreate)(int szPage, int szExtra, int bPurgeable);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9391 void (xCachesize)(sqlite3_pcache, int nCachesize);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9392 int (xPagecount)(sqlite3_pcache);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9393 sqlite3_pcache_page (xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9394 void (xUnpin)(sqlite3_pcache, sqlite3_pcache_page*, int discard);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9395 void (xRekey)(sqlite3_pcache, sqlite3_pcache_page*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9396 unsigned oldKey, unsigned newKey);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9397 void (xTruncate)(sqlite3_pcache, unsigned iLimit);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9398 void (xDestroy)(sqlite3_pcache);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9399 void (xShrink)(sqlite3_pcache);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9400 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9401
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9402 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9403 ** This is the obsolete pcache_methods object that has now been replaced
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9404 ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9405 ** retained in the header file for backwards compatibility only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9406 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9407 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9408 struct sqlite3_pcache_methods {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9409 void *pArg;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9410 int (xInit)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9411 void (xShutdown)(void);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9412 sqlite3_pcache (xCreate)(int szPage, int bPurgeable);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9413 void (xCachesize)(sqlite3_pcache, int nCachesize);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9414 int (xPagecount)(sqlite3_pcache);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9415 void (xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9416 void (xUnpin)(sqlite3_pcache, void*, int discard);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9417 void (xRekey)(sqlite3_pcache, void*, unsigned oldKey, unsigned newKey);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9418 void (xTruncate)(sqlite3_pcache, unsigned iLimit);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9419 void (xDestroy)(sqlite3_pcache);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9420 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9421
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9422
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9423 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9424 ** CAPI3REF: Online Backup Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9425 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9426 ** The sqlite3_backup object records state information about an ongoing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9427 ** online backup operation. ^The sqlite3_backup object is created by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9428 ** a call to [sqlite3_backup_init()] and is destroyed by a call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9429 ** [sqlite3_backup_finish()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9430 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9431 ** See Also: [Using the SQLite Online Backup API]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9432 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9433 typedef struct sqlite3_backup sqlite3_backup;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9434
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9435 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9436 ** CAPI3REF: Online Backup API.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9437 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9438 ** The backup API copies the content of one database into another.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9439 ** It is useful either for creating backups of databases or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9440 ** for copying in-memory databases to or from persistent files.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9441 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9442 ** See Also: [Using the SQLite Online Backup API]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9443 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9444 ** ^SQLite holds a write transaction open on the destination database file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9445 ** for the duration of the backup operation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9446 ** ^The source database is read-locked only while it is being read;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9447 ** it is not locked continuously for the entire backup operation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9448 ** ^Thus, the backup may be performed on a live source database without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9449 ** preventing other database connections from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9450 ** reading or writing to the source database while the backup is underway.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9451 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9452 ** ^(To perform a backup operation:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9453 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9454 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9455 ** backup,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9456 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9457 ** the data between the two databases, and finally
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9458 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9459 ** associated with the backup operation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9460 ** </ol>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9461 ** There should be exactly one call to sqlite3_backup_finish() for each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9462 ** successful call to sqlite3_backup_init().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9463 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9464 ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9465 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9466 ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9467 ** [database connection] associated with the destination database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9468 ** and the database name, respectively.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9469 ** ^The database name is "main" for the main database, "temp" for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9470 ** temporary database, or the name specified after the AS keyword in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9471 ** an [ATTACH] statement for an attached database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9472 ** ^The S and M arguments passed to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9473 ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9474 ** and database name of the source database, respectively.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9475 ** ^The source and destination [database connections] (parameters S and D)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9476 ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9477 ** an error.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9478 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9479 ** ^A call to sqlite3_backup_init() will fail, returning NULL, if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9480 ** there is already a read or read-write transaction open on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9481 ** destination database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9482 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9483 ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9484 ** returned and an error code and error message are stored in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9485 ** destination [database connection] D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9486 ** ^The error code and message for the failed call to sqlite3_backup_init()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9487 ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9488 ** [sqlite3_errmsg16()] functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9489 ** ^A successful call to sqlite3_backup_init() returns a pointer to an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9490 ** [sqlite3_backup] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9491 ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9492 ** sqlite3_backup_finish() functions to perform the specified backup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9493 ** operation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9494 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9495 ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9496 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9497 ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9498 ** the source and destination databases specified by [sqlite3_backup] object B.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9499 ** ^If N is negative, all remaining source pages are copied.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9500 ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9501 ** are still more pages to be copied, then the function returns [SQLITE_OK].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9502 ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9503 ** from source to destination, then it returns [SQLITE_DONE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9504 ** ^If an error occurs while running sqlite3_backup_step(B,N),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9505 ** then an [error code] is returned. ^As well as [SQLITE_OK] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9506 ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9507 ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9508 ** [SQLITE_IOERR_ACCESS \| SQLITE_IOERR_XXX] extended error code.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9509 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9510 ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9511 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9512 ** <li> the destination database was opened read-only, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9513 ** <li> the destination database is using write-ahead-log journaling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9514 ** and the destination and source page sizes differ, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9515 ** <li> the destination database is an in-memory database and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9516 ** destination and source page sizes differ.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9517 ** </ol>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9518 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9519 ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9520 ** the [sqlite3_busy_handler \| busy-handler function]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9521 ** is invoked (if one is specified). ^If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9522 ** busy-handler returns non-zero before the lock is available, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9523 ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9524 ** sqlite3_backup_step() can be retried later. ^If the source
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9525 ** [database connection]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9526 ** is being used to write to the source database when sqlite3_backup_step()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9527 ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9528 ** case the call to sqlite3_backup_step() can be retried later on. ^(If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9529 ** [SQLITE_IOERR_ACCESS \| SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9530 ** [SQLITE_READONLY] is returned, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9531 ** there is no point in retrying the call to sqlite3_backup_step(). These
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9532 ** errors are considered fatal.)^ The application must accept
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9533 ** that the backup operation has failed and pass the backup operation handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9534 ** to the sqlite3_backup_finish() to release associated resources.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9535 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9536 ** ^The first call to sqlite3_backup_step() obtains an exclusive lock
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9537 ** on the destination file. ^The exclusive lock is not released until either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9538 ** sqlite3_backup_finish() is called or the backup operation is complete
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9539 ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9540 ** sqlite3_backup_step() obtains a [shared lock] on the source database that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9541 ** lasts for the duration of the sqlite3_backup_step() call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9542 ** ^Because the source database is not locked between calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9543 ** sqlite3_backup_step(), the source database may be modified mid-way
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9544 ** through the backup process. ^If the source database is modified by an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9545 ** external process or via a database connection other than the one being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9546 ** used by the backup operation, then the backup will be automatically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9547 ** restarted by the next call to sqlite3_backup_step(). ^If the source
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9548 ** database is modified by using the same database connection as is used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9549 ** by the backup operation, then the backup database is automatically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9550 ** updated at the same time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9551 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9552 ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9553 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9554 ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9555 ** application wishes to abandon the backup operation, the application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9556 ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9557 ** ^The sqlite3_backup_finish() interfaces releases all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9558 ** resources associated with the [sqlite3_backup] object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9559 ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9560 ** active write-transaction on the destination database is rolled back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9561 ** The [sqlite3_backup] object is invalid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9562 ** and may not be used following a call to sqlite3_backup_finish().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9563 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9564 ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9565 ** sqlite3_backup_step() errors occurred, regardless of whether or not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9566 ** sqlite3_backup_step() completed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9567 ** ^If an out-of-memory condition or IO error occurred during any prior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9568 ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9569 ** sqlite3_backup_finish() returns the corresponding [error code].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9570 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9571 ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9572 ** is not a permanent error and does not affect the return value of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9573 ** sqlite3_backup_finish().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9574 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9575 ** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9576 ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9577 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9578 ** ^The sqlite3_backup_remaining() routine returns the number of pages still
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9579 ** to be backed up at the conclusion of the most recent sqlite3_backup_step().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9580 ** ^The sqlite3_backup_pagecount() routine returns the total number of pages
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9581 ** in the source database at the conclusion of the most recent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9582 ** sqlite3_backup_step().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9583 ** ^(The values returned by these functions are only updated by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9584 ** sqlite3_backup_step(). If the source database is modified in a way that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9585 ** changes the size of the source database or the number of pages remaining,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9586 ** those changes are not reflected in the output of sqlite3_backup_pagecount()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9587 ** and sqlite3_backup_remaining() until after the next
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9588 ** sqlite3_backup_step().)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9589 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9590 ** <b>Concurrent Usage of Database Handles</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9591 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9592 ** ^The source [database connection] may be used by the application for other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9593 ** purposes while a backup operation is underway or being initialized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9594 ** ^If SQLite is compiled and configured to support threadsafe database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9595 ** connections, then the source database connection may be used concurrently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9596 ** from within other threads.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9597 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9598 ** However, the application must guarantee that the destination
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9599 ** [database connection] is not passed to any other API (by any thread) after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9600 ** sqlite3_backup_init() is called and before the corresponding call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9601 ** sqlite3_backup_finish(). SQLite does not currently check to see
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9602 ** if the application incorrectly accesses the destination [database connection]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9603 ** and so no error code is reported, but the operations may malfunction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9604 ** nevertheless. Use of the destination database connection while a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9605 ** backup is in progress might also cause a mutex deadlock.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9606 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9607 ** If running in [shared cache mode], the application must
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9608 ** guarantee that the shared cache used by the destination database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9609 ** is not accessed while the backup is running. In practice this means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9610 ** that the application must guarantee that the disk file being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9611 ** backed up to is not accessed by any connection within the process,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9612 ** not just the specific connection that was passed to sqlite3_backup_init().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9613 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9614 ** The [sqlite3_backup] object itself is partially threadsafe. Multiple
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9615 ** threads may safely make multiple concurrent calls to sqlite3_backup_step().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9616 ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9617 ** APIs are not strictly speaking threadsafe. If they are invoked at the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9618 ** same time as another thread is invoking sqlite3_backup_step() it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9619 ** possible that they return invalid values.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9620 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9621 ** <b>Alternatives To Using The Backup API</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9622 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9623 ** Other techniques for safely creating a consistent backup of an SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9624 ** database include:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9625 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9626 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9627 ** <li> The [VACUUM INTO] command.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9628 ** <li> The [sqlite3_rsync] utility program.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9629 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9630 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9631 SQLITE_API sqlite3_backup *sqlite3_backup_init(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9632 sqlite3 pDest, / Destination database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9633 const char zDestName, / Destination database name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9634 sqlite3 pSource, / Source database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9635 const char zSourceName / Source database name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9636 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9637 SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9638 SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9639 SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9640 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9641
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9642 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9643 ** CAPI3REF: Unlock Notification
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9644 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9645 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9646 ** ^When running in shared-cache mode, a database operation may fail with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9647 ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9648 ** individual tables within the shared-cache cannot be obtained. See
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9649 ** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9650 ** ^This API may be used to register a callback that SQLite will invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9651 ** when the connection currently holding the required lock relinquishes it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9652 ** ^This API is only available if the library was compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9653 ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9654 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9655 ** See Also: [Using the SQLite Unlock Notification Feature].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9656 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9657 ** ^Shared-cache locks are released when a database connection concludes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9658 ** its current transaction, either by committing it or rolling it back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9659 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9660 ** ^When a connection (known as the blocked connection) fails to obtain a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9661 ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9662 ** identity of the database connection (the blocking connection) that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9663 ** has locked the required resource is stored internally. ^After an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9664 ** application receives an SQLITE_LOCKED error, it may call the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9665 ** sqlite3_unlock_notify() method with the blocked connection handle as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9666 ** the first argument to register for a callback that will be invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9667 ** when the blocking connection's current transaction is concluded. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9668 ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9669 ** call that concludes the blocking connection's transaction.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9670 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9671 ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9672 ** there is a chance that the blocking connection will have already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9673 ** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9674 ** If this happens, then the specified callback is invoked immediately,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9675 ** from within the call to sqlite3_unlock_notify().)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9676 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9677 ** ^If the blocked connection is attempting to obtain a write-lock on a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9678 ** shared-cache table, and more than one other connection currently holds
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9679 ** a read-lock on the same table, then SQLite arbitrarily selects one of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9680 ** the other connections to use as the blocking connection.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9681 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9682 ** ^(There may be at most one unlock-notify callback registered by a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9683 ** blocked connection. If sqlite3_unlock_notify() is called when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9684 ** blocked connection already has a registered unlock-notify callback,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9685 ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9686 ** called with a NULL pointer as its second argument, then any existing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9687 ** unlock-notify callback is canceled. ^The blocked connection's
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9688 ** unlock-notify callback may also be canceled by closing the blocked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9689 ** connection using [sqlite3_close()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9690 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9691 ** The unlock-notify callback is not reentrant. If an application invokes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9692 ** any sqlite3_xxx API functions from within an unlock-notify callback, a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9693 ** crash or deadlock may be the result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9694 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9695 ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9696 ** returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9697 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9698 ** <b>Callback Invocation Details</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9699 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9700 ** When an unlock-notify callback is registered, the application provides a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9701 ** single void* pointer that is passed to the callback when it is invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9702 ** However, the signature of the callback function allows SQLite to pass
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9703 ** it an array of void* context pointers. The first argument passed to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9704 ** an unlock-notify callback is a pointer to an array of void* pointers,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9705 ** and the second is the number of entries in the array.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9706 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9707 ** When a blocking connection's transaction is concluded, there may be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9708 ** more than one blocked connection that has registered for an unlock-notify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9709 ** callback. ^If two or more such blocked connections have specified the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9710 ** same callback function, then instead of invoking the callback function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9711 ** multiple times, it is invoked once with the set of void* context pointers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9712 ** specified by the blocked connections bundled together into an array.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9713 ** This gives the application an opportunity to prioritize any actions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9714 ** related to the set of unblocked database connections.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9715 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9716 ** <b>Deadlock Detection</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9717 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9718 ** Assuming that after registering for an unlock-notify callback a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9719 ** database waits for the callback to be issued before taking any further
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9720 ** action (a reasonable assumption), then using this API may cause the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9721 ** application to deadlock. For example, if connection X is waiting for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9722 ** connection Y's transaction to be concluded, and similarly connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9723 ** Y is waiting on connection X's transaction, then neither connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9724 ** will proceed and the system may remain deadlocked indefinitely.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9725 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9726 ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9727 ** detection. ^If a given call to sqlite3_unlock_notify() would put the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9728 ** system in a deadlocked state, then SQLITE_LOCKED is returned and no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9729 ** unlock-notify callback is registered. The system is said to be in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9730 ** a deadlocked state if connection A has registered for an unlock-notify
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9731 ** callback on the conclusion of connection B's transaction, and connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9732 ** B has itself registered for an unlock-notify callback when connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9733 ** A's transaction is concluded. ^Indirect deadlock is also detected, so
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9734 ** the system is also considered to be deadlocked if connection B has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9735 ** registered for an unlock-notify callback on the conclusion of connection
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9736 ** C's transaction, where connection C is waiting on connection A. ^Any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9737 ** number of levels of indirection are allowed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9738 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9739 ** <b>The "DROP TABLE" Exception</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9740 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9741 ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9742 ** always appropriate to call sqlite3_unlock_notify(). There is however,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9743 ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9744 ** SQLite checks if there are any currently executing SELECT statements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9745 ** that belong to the same connection. If there are, SQLITE_LOCKED is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9746 ** returned. In this case there is no "blocking connection", so invoking
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9747 ** sqlite3_unlock_notify() results in the unlock-notify callback being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9748 ** invoked immediately. If the application then re-attempts the "DROP TABLE"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9749 ** or "DROP INDEX" query, an infinite loop might be the result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9750 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9751 ** One way around this problem is to check the extended error code returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9752 ** by an sqlite3_step() call. ^(If there is a blocking connection, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9753 ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9754 ** the special "DROP TABLE/INDEX" case, the extended error code is just
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9755 ** SQLITE_LOCKED.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9756 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9757 SQLITE_API int sqlite3_unlock_notify(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9758 sqlite3 pBlocked, / Waiting connection */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9759 void (xNotify)(void apArg, int nArg), / Callback function to invoke */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9760 void pNotifyArg / Argument to pass to xNotify */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9761 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9762
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9763
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9764 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9765 ** CAPI3REF: String Comparison
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9766 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9767 ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9768 ** and extensions to compare the contents of two buffers containing UTF-8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9769 ** strings in a case-independent fashion, using the same definition of "case
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9770 ** independence" that SQLite uses internally when comparing identifiers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9771 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9772 SQLITE_API int sqlite3_stricmp(const char , const char );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9773 SQLITE_API int sqlite3_strnicmp(const char , const char , int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9774
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9775 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9776 ** CAPI3REF: String Globbing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9777 *
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9778 ** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9779 ** string X matches the [GLOB] pattern P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9780 ** ^The definition of [GLOB] pattern matching used in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9781 ** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9782 ** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9783 ** is case sensitive.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9784 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9785 ** Note that this routine returns zero on a match and non-zero if the strings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9786 ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9787 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9788 ** See also: [sqlite3_strlike()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9789 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9790 SQLITE_API int sqlite3_strglob(const char zGlob, const char zStr);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9791
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9792 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9793 ** CAPI3REF: String LIKE Matching
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9794 *
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9795 ** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9796 ** string X matches the [LIKE] pattern P with escape character E.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9797 ** ^The definition of [LIKE] pattern matching used in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9798 ** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9799 ** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9800 ** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9801 ** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9802 ** insensitive - equivalent upper and lower case ASCII characters match
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9803 ** one another.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9804 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9805 ** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9806 ** only ASCII characters are case folded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9807 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9808 ** Note that this routine returns zero on a match and non-zero if the strings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9809 ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9810 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9811 ** See also: [sqlite3_strglob()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9812 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9813 SQLITE_API int sqlite3_strlike(const char zGlob, const char zStr, unsigned int cEsc);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9814
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9815 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9816 ** CAPI3REF: Error Logging Interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9817 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9818 ** ^The [sqlite3_log()] interface writes a message into the [error log]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9819 ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9820 ** ^If logging is enabled, the zFormat string and subsequent arguments are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9821 ** used with [sqlite3_snprintf()] to generate the final output string.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9822 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9823 ** The sqlite3_log() interface is intended for use by extensions such as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9824 ** virtual tables, collating functions, and SQL functions. While there is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9825 ** nothing to prevent an application from calling sqlite3_log(), doing so
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9826 ** is considered bad form.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9827 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9828 ** The zFormat string must not be NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9829 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9830 ** To avoid deadlocks and other threading problems, the sqlite3_log() routine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9831 ** will not use dynamically allocated memory. The log message is stored in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9832 ** a fixed-length buffer on the stack. If the log message is longer than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9833 ** a few hundred characters, it will be truncated to the length of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9834 ** buffer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9835 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9836 SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9837
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9838 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9839 ** CAPI3REF: Write-Ahead Log Commit Hook
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9840 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9841 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9842 ** ^The [sqlite3_wal_hook()] function is used to register a callback that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9843 ** is invoked each time data is committed to a database in wal mode.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9844 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9845 ** ^(The callback is invoked by SQLite after the commit has taken place and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9846 ** the associated write-lock on the database released)^, so the implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9847 ** may read, write or [checkpoint] the database as required.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9848 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9849 ** ^The first parameter passed to the callback function when it is invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9850 ** is a copy of the third parameter passed to sqlite3_wal_hook() when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9851 ** registering the callback. ^The second is a copy of the database handle.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9852 ** ^The third parameter is the name of the database that was written to -
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9853 ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9854 ** is the number of pages currently in the write-ahead log file,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9855 ** including those that were just committed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9856 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9857 ** ^The callback function should normally return [SQLITE_OK]. ^If an error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9858 ** code is returned, that error will propagate back up through the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9859 ** SQLite code base to cause the statement that provoked the callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9860 ** to report an error, though the commit will have still occurred. If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9861 ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9862 ** that does not correspond to any valid SQLite error code, the results
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9863 ** are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9864 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9865 ** ^A single database handle may have at most a single write-ahead log
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9866 ** callback registered at one time. ^Calling [sqlite3_wal_hook()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9867 ** replaces the default behavior or previously registered write-ahead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9868 ** log callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9869 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9870 ** ^The return value is a copy of the third parameter from the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9871 ** previous call, if any, or 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9872 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9873 ** ^The [sqlite3_wal_autocheckpoint()] interface and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9874 ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9875 ** will overwrite any prior [sqlite3_wal_hook()] settings.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9876 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9877 ** ^If a write-ahead log callback is set using this function then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9878 ** [sqlite3_wal_checkpoint_v2()] or [PRAGMA wal_checkpoint]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9879 ** should be invoked periodically to keep the write-ahead log file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9880 ** from growing without bound.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9881 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9882 ** ^Passing a NULL pointer for the callback disables automatic
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9883 ** checkpointing entirely. To re-enable the default behavior, call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9884 ** sqlite3_wal_autocheckpoint(db,1000) or use [PRAGMA wal_checkpoint].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9885 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9886 SQLITE_API void *sqlite3_wal_hook(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9887 sqlite3*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9888 int()(void ,sqlite3,const char,int),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9889 void*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9890 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9891
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9892 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9893 ** CAPI3REF: Configure an auto-checkpoint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9894 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9895 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9896 ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9897 ** [sqlite3_wal_hook()] that causes any database on [database connection] D
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9898 ** to automatically [checkpoint]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9899 ** after committing a transaction if there are N or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9900 ** more frames in the [write-ahead log] file. ^Passing zero or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9901 ** a negative value as the N parameter disables automatic
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9902 ** checkpoints entirely.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9903 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9904 ** ^The callback registered by this function replaces any existing callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9905 ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9906 ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9907 ** configured by this function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9908 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9909 ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9910 ** from SQL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9911 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9912 ** ^Checkpoints initiated by this mechanism are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9913 ** [sqlite3_wal_checkpoint_v2\|PASSIVE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9914 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9915 ** ^Every new [database connection] defaults to having the auto-checkpoint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9916 ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9917 ** pages.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9918 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9919 ** ^The use of this interface is only necessary if the default setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9920 ** is found to be suboptimal for a particular application.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9921 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9922 SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9923
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9924 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9925 ** CAPI3REF: Checkpoint a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9926 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9927 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9928 ** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9929 ** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9930 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9931 ** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9932 ** [write-ahead log] for database X on [database connection] D to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9933 ** transferred into the database file and for the write-ahead log to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9934 ** be reset. See the [checkpointing] documentation for addition
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9935 ** information.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9936 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9937 ** This interface used to be the only way to cause a checkpoint to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9938 ** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9939 ** interface was added. This interface is retained for backwards
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9940 ** compatibility and as a convenience for applications that need to manually
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9941 ** start a callback but which do not need the full power (and corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9942 ** complication) of [sqlite3_wal_checkpoint_v2()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9943 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9944 SQLITE_API int sqlite3_wal_checkpoint(sqlite3 db, const char zDb);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9945
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9946 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9947 ** CAPI3REF: Checkpoint a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9948 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9949 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9950 ** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9951 ** operation on database X of [database connection] D in mode M. Status
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9952 ** information is written back into integers pointed to by L and C.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9953 ** ^(The M parameter must be a valid [checkpoint mode]:)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9954 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9955 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9956 ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9957 ** ^Checkpoint as many frames as possible without waiting for any database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9958 ** readers or writers to finish, then sync the database file if all frames
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9959 ** in the log were checkpointed. ^The [busy-handler callback]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9960 ** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9961 ** ^On the other hand, passive mode might leave the checkpoint unfinished
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9962 ** if there are concurrent readers or writers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9963 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9964 ** <dt>SQLITE_CHECKPOINT_FULL<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9965 ** ^This mode blocks (it invokes the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9966 ** [sqlite3_busy_handler\|busy-handler callback]) until there is no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9967 ** database writer and all readers are reading from the most recent database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9968 ** snapshot. ^It then checkpoints all frames in the log file and syncs the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9969 ** database file. ^This mode blocks new database writers while it is pending,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9970 ** but new database readers are allowed to continue unimpeded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9971 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9972 ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9973 ** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9974 ** that after checkpointing the log file it blocks (calls the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9975 ** [busy-handler callback])
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9976 ** until all readers are reading from the database file only. ^This ensures
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9977 ** that the next writer will restart the log file from the beginning.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9978 ** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9979 ** database writer attempts while it is pending, but does not impede readers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9980 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9981 ** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9982 ** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9983 ** addition that it also truncates the log file to zero bytes just prior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9984 ** to a successful return.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9985 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9986 ** <dt>SQLITE_CHECKPOINT_NOOP<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9987 ** ^This mode always checkpoints zero frames. The only reason to invoke
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9988 ** a NOOP checkpoint is to access the values returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9989 ** sqlite3_wal_checkpoint_v2() via output parameters pnLog and pnCkpt.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9990 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9991 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9992 ** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9993 ** the log file or to -1 if the checkpoint could not run because
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9994 ** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9995 ** NULL,then *pnCkpt is set to the total number of checkpointed frames in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9996 ** log file (including any that were already checkpointed before the function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9997 ** was called) or to -1 if the checkpoint could not run due to an error or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9998 ** because the database is not in WAL mode. ^Note that upon successful
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	9999 ** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10000 ** truncated to zero bytes and so both pnLog and pnCkpt will be set to zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10001 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10002 ** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10003 ** any other process is running a checkpoint operation at the same time, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10004 ** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10005 ** busy-handler configured, it will not be invoked in this case.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10006 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10007 ** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10008 ** exclusive "writer" lock on the database file. ^If the writer lock cannot be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10009 ** obtained immediately, and a busy-handler is configured, it is invoked and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10010 ** the writer lock retried until either the busy-handler returns 0 or the lock
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10011 ** is successfully obtained. ^The busy-handler is also invoked while waiting for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10012 ** database readers as described above. ^If the busy-handler returns 0 before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10013 ** the writer lock is obtained or while waiting for database readers, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10014 ** checkpoint operation proceeds from that point in the same way as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10015 ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10016 ** without blocking any further. ^SQLITE_BUSY is returned in this case.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10017 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10018 ** ^If parameter zDb is NULL or points to a zero length string, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10019 ** specified operation is attempted on all WAL databases [attached] to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10020 ** [database connection] db. In this case the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10021 ** values written to output parameters pnLog and pnCkpt are undefined. ^If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10022 ** an SQLITE_BUSY error is encountered when processing one or more of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10023 ** attached WAL databases, the operation is still attempted on any remaining
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10024 ** attached databases and SQLITE_BUSY is returned at the end. ^If any other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10025 ** error occurs while processing an attached database, processing is abandoned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10026 ** and the error code is returned to the caller immediately. ^If no error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10027 ** (SQLITE_BUSY or otherwise) is encountered while processing the attached
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10028 ** databases, SQLITE_OK is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10029 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10030 ** ^If database zDb is the name of an attached database that is not in WAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10031 ** mode, SQLITE_OK is returned and both pnLog and pnCkpt set to -1. ^If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10032 ** zDb is not NULL (or a zero length string) and is not the name of any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10033 ** attached database, SQLITE_ERROR is returned to the caller.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10034 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10035 ** ^Unless it returns SQLITE_MISUSE,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10036 ** the sqlite3_wal_checkpoint_v2() interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10037 ** sets the error information that is queried by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10038 ** [sqlite3_errcode()] and [sqlite3_errmsg()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10039 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10040 ** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10041 ** from SQL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10042 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10043 SQLITE_API int sqlite3_wal_checkpoint_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10044 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10045 const char zDb, / Name of attached database (or NULL) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10046 int eMode, /* SQLITE_CHECKPOINT_* value */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10047 int pnLog, / OUT: Size of WAL log in frames */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10048 int pnCkpt / OUT: Total number of frames checkpointed */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10049 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10050
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10051 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10052 ** CAPI3REF: Checkpoint Mode Values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10053 ** KEYWORDS: {checkpoint mode}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10054 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10055 ** These constants define all valid values for the "checkpoint mode" passed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10056 ** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10057 ** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10058 ** meaning of each of these checkpoint modes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10059 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10060 #define SQLITE_CHECKPOINT_NOOP -1 /* Do no work at all */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10061 #define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10062 #define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10063 #define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for readers */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10064 #define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10065
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10066 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10067 ** CAPI3REF: Virtual Table Interface Configuration
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10068 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10069 ** This function may be called by either the [xConnect] or [xCreate] method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10070 ** of a [virtual table] implementation to configure
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10071 ** various facets of the virtual table interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10072 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10073 ** If this interface is invoked outside the context of an xConnect or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10074 ** xCreate virtual table method then the behavior is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10075 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10076 ** In the call sqlite3_vtab_config(D,C,...) the D parameter is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10077 ** [database connection] in which the virtual table is being created and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10078 ** which is passed in as the first argument to the [xConnect] or [xCreate]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10079 ** method that is invoking sqlite3_vtab_config(). The C parameter is one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10080 ** of the [virtual table configuration options]. The presence and meaning
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10081 ** of parameters after C depend on which [virtual table configuration option]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10082 ** is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10083 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10084 SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10085
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10086 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10087 ** CAPI3REF: Virtual Table Configuration Options
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10088 ** KEYWORDS: {virtual table configuration options}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10089 ** KEYWORDS: {virtual table configuration option}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10090 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10091 ** These macros define the various options to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10092 ** [sqlite3_vtab_config()] interface that [virtual table] implementations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10093 ** can use to customize and optimize their behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10094 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10095 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10096 ** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10097 ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10098 ** <dd>Calls of the form
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10099 ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10100 ** where X is an integer. If X is zero, then the [virtual table] whose
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10101 ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10102 ** support constraints. In this configuration (which is the default) if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10103 ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10104 ** statement is rolled back as if [ON CONFLICT \| OR ABORT] had been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10105 ** specified as part of the user's SQL statement, regardless of the actual
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10106 ** ON CONFLICT mode specified.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10107 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10108 ** If X is non-zero, then the virtual table implementation guarantees
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10109 ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10110 ** any modifications to internal or persistent data structures have been made.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10111 ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10112 ** is able to roll back a statement or database transaction, and abandon
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10113 ** or continue processing the current SQL statement as appropriate.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10114 ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10115 ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10116 ** had been ABORT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10117 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10118 ** Virtual table implementations that are required to handle OR REPLACE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10119 ** must do so within the [xUpdate] method. If a call to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10120 ** [sqlite3_vtab_on_conflict()] function indicates that the current ON
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10121 ** CONFLICT policy is REPLACE, the virtual table implementation should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10122 ** silently replace the appropriate rows within the xUpdate callback and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10123 ** return SQLITE_OK. Or, if this is not possible, it may return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10124 ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10125 ** constraint handling.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10126 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10127 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10128 ** [[SQLITE_VTAB_DIRECTONLY]]<dt>SQLITE_VTAB_DIRECTONLY</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10129 ** <dd>Calls of the form
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10130 ** [sqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10131 ** the [xConnect] or [xCreate] methods of a [virtual table] implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10132 ** prohibits that virtual table from being used from within triggers and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10133 ** views.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10134 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10135 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10136 ** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10137 ** <dd>Calls of the form
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10138 ** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10139 ** [xConnect] or [xCreate] methods of a [virtual table] implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10140 ** identify that virtual table as being safe to use from within triggers
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10141 ** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10142 ** virtual table can do no serious harm even if it is controlled by a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10143 ** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10144 ** flag unless absolutely necessary.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10145 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10146 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10147 ** [[SQLITE_VTAB_USES_ALL_SCHEMAS]]<dt>SQLITE_VTAB_USES_ALL_SCHEMAS</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10148 ** <dd>Calls of the form
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10149 ** [sqlite3_vtab_config](db,SQLITE_VTAB_USES_ALL_SCHEMA) from within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10150 ** the [xConnect] or [xCreate] methods of a [virtual table] implementation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10151 ** instruct the query planner to begin at least a read transaction on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10152 ** all schemas ("main", "temp", and any ATTACH-ed databases) whenever the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10153 ** virtual table is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10154 ** </dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10155 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10156 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10157 #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10158 #define SQLITE_VTAB_INNOCUOUS 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10159 #define SQLITE_VTAB_DIRECTONLY 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10160 #define SQLITE_VTAB_USES_ALL_SCHEMAS 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10161
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10162 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10163 ** CAPI3REF: Determine The Virtual Table Conflict Policy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10164 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10165 ** This function may only be called from within a call to the [xUpdate] method
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10166 ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10167 ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10168 ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10169 ** of the SQL statement that triggered the call to the [xUpdate] method of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10170 ** [virtual table].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10171 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10172 SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10173
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10174 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10175 ** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10176 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10177 ** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10178 ** method of a [virtual table], then it might return true if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10179 ** column is being fetched as part of an UPDATE operation during which the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10180 ** column value will not change. The virtual table implementation can use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10181 ** this hint as permission to substitute a return value that is less
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10182 ** expensive to compute and that the corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10183 ** [xUpdate] method understands as a "no-change" value.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10184 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10185 ** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10186 ** the column is not changed by the UPDATE statement, then the xColumn
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10187 ** method can optionally return without setting a result, without calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10188 ** any of the [sqlite3_result_int\|sqlite3_result_xxxxx() interfaces].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10189 ** In that case, [sqlite3_value_nochange(X)] will return true for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10190 ** same column in the [xUpdate] method.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10191 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10192 ** The sqlite3_vtab_nochange() routine is an optimization. Virtual table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10193 ** implementations should continue to give a correct answer even if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10194 ** sqlite3_vtab_nochange() interface were to always return false. In the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10195 ** current implementation, the sqlite3_vtab_nochange() interface does always
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10196 ** returns false for the enhanced [UPDATE FROM] statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10197 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10198 SQLITE_API int sqlite3_vtab_nochange(sqlite3_context*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10199
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10200 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10201 ** CAPI3REF: Determine The Collation For a Virtual Table Constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10202 ** METHOD: sqlite3_index_info
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10203 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10204 ** This function may only be called from within a call to the [xBestIndex]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10205 ** method of a [virtual table]. This function returns a pointer to a string
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10206 ** that is the name of the appropriate collation sequence to use for text
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10207 ** comparisons on the constraint identified by its arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10208 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10209 ** The first argument must be the pointer to the [sqlite3_index_info] object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10210 ** that is the first parameter to the xBestIndex() method. The second argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10211 ** must be an index into the aConstraint[] array belonging to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10212 ** sqlite3_index_info structure passed to xBestIndex.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10213 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10214 ** Important:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10215 ** The first parameter must be the same pointer that is passed into the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10216 ** xBestMethod() method. The first parameter may not be a pointer to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10217 ** different [sqlite3_index_info] object, even an exact copy.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10218 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10219 ** The return value is computed as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10220 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10221 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10222 ** <li><p> If the constraint comes from a WHERE clause expression that contains
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10223 ** a [COLLATE operator], then the name of the collation specified by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10224 ** that COLLATE operator is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10225 ** <li><p> If there is no COLLATE operator, but the column that is the subject
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10226 ** of the constraint specifies an alternative collating sequence via
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10227 ** a [COLLATE clause] on the column definition within the CREATE TABLE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10228 ** statement that was passed into [sqlite3_declare_vtab()], then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10229 ** name of that alternative collating sequence is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10230 ** <li><p> Otherwise, "BINARY" is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10231 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10232 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10233 SQLITE_API const char sqlite3_vtab_collation(sqlite3_index_info,int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10234
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10235 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10236 ** CAPI3REF: Determine if a virtual table query is DISTINCT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10237 ** METHOD: sqlite3_index_info
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10238 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10239 ** This API may only be used from within an [xBestIndex\|xBestIndex method]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10240 ** of a [virtual table] implementation. The result of calling this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10241 ** interface from outside of xBestIndex() is undefined and probably harmful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10242 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10243 ** ^The sqlite3_vtab_distinct() interface returns an integer between 0 and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10244 ** 3. The integer returned by sqlite3_vtab_distinct()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10245 ** gives the virtual table additional information about how the query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10246 ** planner wants the output to be ordered. As long as the virtual table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10247 ** can meet the ordering requirements of the query planner, it may set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10248 ** the "orderByConsumed" flag.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10249 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10250 ** <ol><li value="0"><p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10251 ** ^If the sqlite3_vtab_distinct() interface returns 0, that means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10252 ** that the query planner needs the virtual table to return all rows in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10253 ** sort order defined by the "nOrderBy" and "aOrderBy" fields of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10254 ** [sqlite3_index_info] object. This is the default expectation. If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10255 ** virtual table outputs all rows in sorted order, then it is always safe for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10256 ** the xBestIndex method to set the "orderByConsumed" flag, regardless of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10257 ** the return value from sqlite3_vtab_distinct().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10258 ** <li value="1"><p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10259 ** ^(If the sqlite3_vtab_distinct() interface returns 1, that means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10260 ** that the query planner does not need the rows to be returned in sorted order
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10261 ** as long as all rows with the same values in all columns identified by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10262 ** "aOrderBy" field are adjacent.)^ This mode is used when the query planner
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10263 ** is doing a GROUP BY.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10264 ** <li value="2"><p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10265 ** ^(If the sqlite3_vtab_distinct() interface returns 2, that means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10266 ** that the query planner does not need the rows returned in any particular
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10267 ** order, as long as rows with the same values in all columns identified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10268 ** by "aOrderBy" are adjacent.)^ ^(Furthermore, when two or more rows
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10269 ** contain the same values for all columns identified by "colUsed", all but
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10270 ** one such row may optionally be omitted from the result.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10271 ** The virtual table is not required to omit rows that are duplicates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10272 ** over the "colUsed" columns, but if the virtual table can do that without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10273 ** too much extra effort, it could potentially help the query to run faster.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10274 ** This mode is used for a DISTINCT query.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10275 ** <li value="3"><p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10276 ** ^(If the sqlite3_vtab_distinct() interface returns 3, that means the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10277 ** virtual table must return rows in the order defined by "aOrderBy" as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10278 ** if the sqlite3_vtab_distinct() interface had returned 0. However if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10279 ** two or more rows in the result have the same values for all columns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10280 ** identified by "colUsed", then all but one such row may optionally be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10281 ** omitted.)^ Like when the return value is 2, the virtual table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10282 ** is not required to omit rows that are duplicates over the "colUsed"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10283 ** columns, but if the virtual table can do that without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10284 ** too much extra effort, it could potentially help the query to run faster.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10285 ** This mode is used for queries
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10286 ** that have both DISTINCT and ORDER BY clauses.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10287 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10288 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10289 ** <p>The following table summarizes the conditions under which the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10290 ** virtual table is allowed to set the "orderByConsumed" flag based on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10291 ** the value returned by sqlite3_vtab_distinct(). This table is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10292 ** restatement of the previous four paragraphs:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10293 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10294 ** <table border=1 cellspacing=0 cellpadding=10 width="90%">
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10295 ** <tr>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10296 ** <td valign="top">sqlite3_vtab_distinct() return value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10297 ** <td valign="top">Rows are returned in aOrderBy order
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10298 ** <td valign="top">Rows with the same value in all aOrderBy columns are adjacent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10299 ** <td valign="top">Duplicates over all colUsed columns may be omitted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10300 ** <tr><td>0<td>yes<td>yes<td>no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10301 ** <tr><td>1<td>no<td>yes<td>no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10302 ** <tr><td>2<td>no<td>yes<td>yes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10303 ** <tr><td>3<td>yes<td>yes<td>yes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10304 ** </table>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10305 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10306 ** ^For the purposes of comparing virtual table output values to see if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10307 ** values are the same value for sorting purposes, two NULL values are considered
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10308 ** to be the same. In other words, the comparison operator is "IS"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10309 ** (or "IS NOT DISTINCT FROM") and not "==".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10310 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10311 ** If a virtual table implementation is unable to meet the requirements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10312 ** specified above, then it must not set the "orderByConsumed" flag in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10313 ** [sqlite3_index_info] object or an incorrect answer may result.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10314 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10315 ** ^A virtual table implementation is always free to return rows in any order
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10316 ** it wants, as long as the "orderByConsumed" flag is not set. ^When the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10317 ** "orderByConsumed" flag is unset, the query planner will add extra
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10318 ** [bytecode] to ensure that the final results returned by the SQL query are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10319 ** ordered correctly. The use of the "orderByConsumed" flag and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10320 ** sqlite3_vtab_distinct() interface is merely an optimization. ^Careful
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10321 ** use of the sqlite3_vtab_distinct() interface and the "orderByConsumed"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10322 ** flag might help queries against a virtual table to run faster. Being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10323 ** overly aggressive and setting the "orderByConsumed" flag when it is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10324 ** valid to do so, on the other hand, might cause SQLite to return incorrect
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10325 ** results.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10326 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10327 SQLITE_API int sqlite3_vtab_distinct(sqlite3_index_info*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10328
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10329 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10330 ** CAPI3REF: Identify and handle IN constraints in xBestIndex
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10331 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10332 ** This interface may only be used from within an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10333 ** [xBestIndex\|xBestIndex() method] of a [virtual table] implementation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10334 ** The result of invoking this interface from any other context is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10335 ** undefined and probably harmful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10336 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10337 ** ^(A constraint on a virtual table of the form
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10338 ** "[IN operator\|column IN (...)]" is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10339 ** communicated to the xBestIndex method as a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10340 ** [SQLITE_INDEX_CONSTRAINT_EQ] constraint.)^ If xBestIndex wants to use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10341 ** this constraint, it must set the corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10342 ** aConstraintUsage[].argvIndex to a positive integer. ^(Then, under
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10343 ** the usual mode of handling IN operators, SQLite generates [bytecode]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10344 ** that invokes the [xFilter\|xFilter() method] once for each value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10345 ** on the right-hand side of the IN operator.)^ Thus the virtual table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10346 ** only sees a single value from the right-hand side of the IN operator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10347 ** at a time.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10348 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10349 ** In some cases, however, it would be advantageous for the virtual
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10350 ** table to see all values on the right-hand of the IN operator all at
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10351 ** once. The sqlite3_vtab_in() interfaces facilitates this in two ways:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10352 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10353 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10354 ** <li><p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10355 ** ^A call to sqlite3_vtab_in(P,N,-1) will return true (non-zero)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10356 ** if and only if the [sqlite3_index_info\|P->aConstraint][N] constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10357 ** is an [IN operator] that can be processed all at once. ^In other words,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10358 ** sqlite3_vtab_in() with -1 in the third argument is a mechanism
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10359 ** by which the virtual table can ask SQLite if all-at-once processing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10360 ** of the IN operator is even possible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10361 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10362 ** <li><p>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10363 ** ^A call to sqlite3_vtab_in(P,N,F) with F==1 or F==0 indicates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10364 ** to SQLite that the virtual table does or does not want to process
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10365 ** the IN operator all-at-once, respectively. ^Thus when the third
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10366 ** parameter (F) is non-negative, this interface is the mechanism by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10367 ** which the virtual table tells SQLite how it wants to process the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10368 ** IN operator.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10369 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10370 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10371 ** ^The sqlite3_vtab_in(P,N,F) interface can be invoked multiple times
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10372 ** within the same xBestIndex method call. ^For any given P,N pair,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10373 ** the return value from sqlite3_vtab_in(P,N,F) will always be the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10374 ** within the same xBestIndex call. ^If the interface returns true
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10375 ** (non-zero), that means that the constraint is an IN operator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10376 ** that can be processed all-at-once. ^If the constraint is not an IN
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10377 ** operator or cannot be processed all-at-once, then the interface returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10378 ** false.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10379 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10380 ** ^(All-at-once processing of the IN operator is selected if both of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10381 ** following conditions are met:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10382 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10383 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10384 ** <li><p> The P->aConstraintUsage[N].argvIndex value is set to a positive
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10385 ** integer. This is how the virtual table tells SQLite that it wants to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10386 ** use the N-th constraint.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10387 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10388 ** <li><p> The last call to sqlite3_vtab_in(P,N,F) for which F was
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10389 ** non-negative had F>=1.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10390 ** </ol>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10391 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10392 ** ^If either or both of the conditions above are false, then SQLite uses
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10393 ** the traditional one-at-a-time processing strategy for the IN constraint.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10394 ** ^If both conditions are true, then the argvIndex-th parameter to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10395 ** xFilter method will be an [sqlite3_value] that appears to be NULL,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10396 ** but which can be passed to [sqlite3_vtab_in_first()] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10397 ** [sqlite3_vtab_in_next()] to find all values on the right-hand side
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10398 ** of the IN constraint.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10399 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10400 SQLITE_API int sqlite3_vtab_in(sqlite3_index_info*, int iCons, int bHandle);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10401
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10402 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10403 ** CAPI3REF: Find all elements on the right-hand side of an IN constraint.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10404 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10405 ** These interfaces are only useful from within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10406 ** [xFilter\|xFilter() method] of a [virtual table] implementation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10407 ** The result of invoking these interfaces from any other context
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10408 ** is undefined and probably harmful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10409 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10410 ** The X parameter in a call to sqlite3_vtab_in_first(X,P) or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10411 ** sqlite3_vtab_in_next(X,P) should be one of the parameters to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10412 ** xFilter method which invokes these routines, and specifically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10413 ** a parameter that was previously selected for all-at-once IN constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10414 ** processing using the [sqlite3_vtab_in()] interface in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10415 ** [xBestIndex\|xBestIndex method]. ^(If the X parameter is not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10416 ** an xFilter argument that was selected for all-at-once IN constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10417 ** processing, then these routines return [SQLITE_ERROR].)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10418 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10419 ** ^(Use these routines to access all values on the right-hand side
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10420 ** of the IN constraint using code like the following:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10421 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10422 ** <blockquote><pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10423 **   for(rc=sqlite3_vtab_in_first(pList, &pVal);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10424 **   rc==SQLITE_OK && pVal;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10425 **   rc=sqlite3_vtab_in_next(pList, &pVal)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10426 **   ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10427 **   // do something with pVal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10428 **   }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10429 **   if( rc!=SQLITE_DONE ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10430 **   // an error has occurred
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10431 **   }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10432 ** </pre></blockquote>)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10433 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10434 ** ^On success, the sqlite3_vtab_in_first(X,P) and sqlite3_vtab_in_next(X,P)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10435 ** routines return SQLITE_OK and set *P to point to the first or next value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10436 ** on the RHS of the IN constraint. ^If there are no more values on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10437 ** right hand side of the IN constraint, then *P is set to NULL and these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10438 ** routines return [SQLITE_DONE]. ^The return value might be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10439 ** some other value, such as SQLITE_NOMEM, in the event of a malfunction.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10440 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10441 ** The *ppOut values returned by these routines are only valid until the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10442 ** next call to either of these routines or until the end of the xFilter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10443 ** method from which these routines were called. If the virtual table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10444 ** implementation needs to retain the *ppOut values for longer, it must make
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10445 ** copies. The *ppOut values are [protected sqlite3_value\|protected].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10446 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10447 SQLITE_API int sqlite3_vtab_in_first(sqlite3_value pVal, sqlite3_value *ppOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10448 SQLITE_API int sqlite3_vtab_in_next(sqlite3_value pVal, sqlite3_value *ppOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10449
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10450 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10451 ** CAPI3REF: Constraint values in xBestIndex()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10452 ** METHOD: sqlite3_index_info
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10453 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10454 ** This API may only be used from within the [xBestIndex\|xBestIndex method]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10455 ** of a [virtual table] implementation. The result of calling this interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10456 ** from outside of an xBestIndex method are undefined and probably harmful.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10457 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10458 ** ^When the sqlite3_vtab_rhs_value(P,J,V) interface is invoked from within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10459 ** the [xBestIndex] method of a [virtual table] implementation, with P being
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10460 ** a copy of the [sqlite3_index_info] object pointer passed into xBestIndex and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10461 ** J being a 0-based index into P->aConstraint[], then this routine
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10462 ** attempts to set *V to the value of the right-hand operand of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10463 ** that constraint if the right-hand operand is known. ^If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10464 ** right-hand operand is not known, then *V is set to a NULL pointer.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10465 ** ^The sqlite3_vtab_rhs_value(P,J,V) interface returns SQLITE_OK if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10466 ** and only if *V is set to a value. ^The sqlite3_vtab_rhs_value(P,J,V)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10467 ** inteface returns SQLITE_NOTFOUND if the right-hand side of the J-th
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10468 ** constraint is not available. ^The sqlite3_vtab_rhs_value() interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10469 ** can return a result code other than SQLITE_OK or SQLITE_NOTFOUND if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10470 ** something goes wrong.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10471 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10472 ** The sqlite3_vtab_rhs_value() interface is usually only successful if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10473 ** the right-hand operand of a constraint is a literal value in the original
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10474 ** SQL statement. If the right-hand operand is an expression or a reference
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10475 ** to some other column or a [host parameter], then sqlite3_vtab_rhs_value()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10476 ** will probably return [SQLITE_NOTFOUND].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10477 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10478 ** ^(Some constraints, such as [SQLITE_INDEX_CONSTRAINT_ISNULL] and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10479 ** [SQLITE_INDEX_CONSTRAINT_ISNOTNULL], have no right-hand operand. For such
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10480 ** constraints, sqlite3_vtab_rhs_value() always returns SQLITE_NOTFOUND.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10481 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10482 ** ^The [sqlite3_value] object returned in *V is a protected sqlite3_value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10483 ** and remains valid for the duration of the xBestIndex method call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10484 ** ^When xBestIndex returns, the sqlite3_value object returned by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10485 ** sqlite3_vtab_rhs_value() is automatically deallocated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10486 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10487 ** The "_rhs_" in the name of this routine is an abbreviation for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10488 ** "Right-Hand Side".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10489 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10490 SQLITE_API int sqlite3_vtab_rhs_value(sqlite3_index_info, int, sqlite3_value *ppVal);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10491
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10492 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10493 ** CAPI3REF: Conflict resolution modes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10494 ** KEYWORDS: {conflict resolution mode}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10495 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10496 ** These constants are returned by [sqlite3_vtab_on_conflict()] to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10497 ** inform a [virtual table] implementation of the [ON CONFLICT] mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10498 ** for the SQL statement being evaluated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10499 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10500 ** Note that the [SQLITE_IGNORE] constant is also used as a potential
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10501 ** return value from the [sqlite3_set_authorizer()] callback and that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10502 ** [SQLITE_ABORT] is also a [result code].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10503 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10504 #define SQLITE_ROLLBACK 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10505 /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10506 #define SQLITE_FAIL 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10507 /* #define SQLITE_ABORT 4 // Also an error code */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10508 #define SQLITE_REPLACE 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10509
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10510 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10511 ** CAPI3REF: Prepared Statement Scan Status Opcodes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10512 ** KEYWORDS: {scanstatus options}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10513 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10514 ** The following constants can be used for the T parameter to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10515 ** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10516 ** different metric for sqlite3_stmt_scanstatus() to return.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10517 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10518 ** When the value returned to V is a string, space to hold that string is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10519 ** managed by the prepared statement S and will be automatically freed when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10520 ** S is finalized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10521 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10522 ** Not all values are available for all query elements. When a value is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10523 ** not available, the output variable is set to -1 if the value is numeric,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10524 ** or to NULL if it is a string (SQLITE_SCANSTAT_NAME).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10525 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10526 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10527 ** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10528 ** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10529 ** set to the total number of times that the X-th loop has run.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10530 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10531 ** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10532 ** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10533 ** to the total number of rows examined by all iterations of the X-th loop.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10534 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10535 ** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10536 ** <dd>^The "double" variable pointed to by the V parameter will be set to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10537 ** query planner's estimate for the average number of rows output from each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10538 ** iteration of the X-th loop. If the query planner's estimate was accurate,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10539 ** then this value will approximate the quotient NVISIT/NLOOP and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10540 ** product of this value for all prior loops with the same SELECTID will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10541 ** be the NLOOP value for the current loop.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10542 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10543 ** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10544 ** <dd>^The "const char *" variable pointed to by the V parameter will be set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10545 ** to a zero-terminated UTF-8 string containing the name of the index or table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10546 ** used for the X-th loop.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10547 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10548 ** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10549 ** <dd>^The "const char *" variable pointed to by the V parameter will be set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10550 ** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10551 ** description for the X-th loop.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10552 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10553 ** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECTID</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10554 ** <dd>^The "int" variable pointed to by the V parameter will be set to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10555 ** id for the X-th query plan element. The id value is unique within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10556 ** statement. The select-id is the same value as is output in the first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10557 ** column of an [EXPLAIN QUERY PLAN] query.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10558 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10559 ** [[SQLITE_SCANSTAT_PARENTID]] <dt>SQLITE_SCANSTAT_PARENTID</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10560 ** <dd>The "int" variable pointed to by the V parameter will be set to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10561 ** id of the parent of the current query element, if applicable, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10562 ** to zero if the query element has no parent. This is the same value as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10563 ** returned in the second column of an [EXPLAIN QUERY PLAN] query.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10564 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10565 ** [[SQLITE_SCANSTAT_NCYCLE]] <dt>SQLITE_SCANSTAT_NCYCLE</dt>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10566 ** <dd>The sqlite3_int64 output value is set to the number of cycles,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10567 ** according to the processor time-stamp counter, that elapsed while the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10568 ** query element was being processed. This value is not available for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10569 ** all query elements - if it is unavailable the output variable is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10570 ** set to -1.</dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10571 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10572 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10573 #define SQLITE_SCANSTAT_NLOOP 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10574 #define SQLITE_SCANSTAT_NVISIT 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10575 #define SQLITE_SCANSTAT_EST 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10576 #define SQLITE_SCANSTAT_NAME 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10577 #define SQLITE_SCANSTAT_EXPLAIN 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10578 #define SQLITE_SCANSTAT_SELECTID 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10579 #define SQLITE_SCANSTAT_PARENTID 6
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10580 #define SQLITE_SCANSTAT_NCYCLE 7
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10581
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10582 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10583 ** CAPI3REF: Prepared Statement Scan Status
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10584 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10585 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10586 ** These interfaces return information about the predicted and measured
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10587 ** performance for pStmt. Advanced applications can use this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10588 ** interface to compare the predicted and the measured performance and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10589 ** issue warnings and/or rerun [ANALYZE] if discrepancies are found.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10590 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10591 ** Since this interface is expected to be rarely used, it is only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10592 ** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10593 ** compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10594 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10595 ** The "iScanStatusOp" parameter determines which status information to return.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10596 ** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10597 ** of this interface is undefined. ^The requested measurement is written into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10598 ** a variable pointed to by the "pOut" parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10599 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10600 ** The "flags" parameter must be passed a mask of flags. At present only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10601 ** one flag is defined - SQLITE_SCANSTAT_COMPLEX. If SQLITE_SCANSTAT_COMPLEX
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10602 ** is specified, then status information is available for all elements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10603 ** of a query plan that are reported by "EXPLAIN QUERY PLAN" output. If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10604 ** SQLITE_SCANSTAT_COMPLEX is not specified, then only query plan elements
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10605 ** that correspond to query loops (the "SCAN..." and "SEARCH..." elements of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10606 ** the EXPLAIN QUERY PLAN output) are available. Invoking API
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10607 ** sqlite3_stmt_scanstatus() is equivalent to calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10608 ** sqlite3_stmt_scanstatus_v2() with a zeroed flags parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10609 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10610 ** Parameter "idx" identifies the specific query element to retrieve statistics
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10611 ** for. Query elements are numbered starting from zero. A value of -1 may
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10612 ** retrieve statistics for the entire query. ^If idx is out of range
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10613 ** - less than -1 or greater than or equal to the total number of query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10614 ** elements used to implement the statement - a non-zero value is returned and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10615 ** the variable that pOut points to is unchanged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10616 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10617 ** See also: [sqlite3_stmt_scanstatus_reset()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10618 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10619 SQLITE_API int sqlite3_stmt_scanstatus(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10620 sqlite3_stmt pStmt, / Prepared statement for which info desired */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10621 int idx, /* Index of loop to report on */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10622 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10623 void pOut / Result written here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10624 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10625 SQLITE_API int sqlite3_stmt_scanstatus_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10626 sqlite3_stmt pStmt, / Prepared statement for which info desired */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10627 int idx, /* Index of loop to report on */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10628 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10629 int flags, /* Mask of flags defined below */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10630 void pOut / Result written here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10631 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10632
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10633 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10634 ** CAPI3REF: Prepared Statement Scan Status
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10635 ** KEYWORDS: {scan status flags}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10636 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10637 #define SQLITE_SCANSTAT_COMPLEX 0x0001
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10638
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10639 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10640 ** CAPI3REF: Zero Scan-Status Counters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10641 ** METHOD: sqlite3_stmt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10642 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10643 ** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10644 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10645 ** This API is only available if the library is built with pre-processor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10646 ** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10647 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10648 SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10649
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10650 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10651 ** CAPI3REF: Flush caches to disk mid-transaction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10652 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10653 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10654 ** ^If a write-transaction is open on [database connection] D when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10655 ** [sqlite3_db_cacheflush(D)] interface is invoked, any dirty
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10656 ** pages in the pager-cache that are not currently in use are written out
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10657 ** to disk. A dirty page may be in use if a database cursor created by an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10658 ** active SQL statement is reading from it, or if it is page 1 of a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10659 ** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10660 ** interface flushes caches for all schemas - "main", "temp", and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10661 ** any [attached] databases.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10662 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10663 ** ^If this function needs to obtain extra database locks before dirty pages
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10664 ** can be flushed to disk, it does so. ^If those locks cannot be obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10665 ** immediately and there is a busy-handler callback configured, it is invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10666 ** in the usual manner. ^If the required lock still cannot be obtained, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10667 ** the database is skipped and an attempt made to flush any dirty pages
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10668 ** belonging to the next (if any) database. ^If any databases are skipped
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10669 ** because locks cannot be obtained, but no other error occurs, this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10670 ** function returns SQLITE_BUSY.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10671 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10672 ** ^If any other error occurs while flushing dirty pages to disk (for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10673 ** example an IO error or out-of-memory condition), then processing is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10674 ** abandoned and an SQLite [error code] is returned to the caller immediately.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10675 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10676 ** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10677 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10678 ** ^This function does not set the database handle error code or message
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10679 ** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10680 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10681 SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10682
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10683 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10684 ** CAPI3REF: The pre-update hook.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10685 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10686 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10687 ** ^These interfaces are only available if SQLite is compiled using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10688 ** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10689 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10690 ** ^The [sqlite3_preupdate_hook()] interface registers a callback function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10691 ** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10692 ** on a database table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10693 ** ^At most one preupdate hook may be registered at a time on a single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10694 ** [database connection]; each call to [sqlite3_preupdate_hook()] overrides
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10695 ** the previous setting.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10696 ** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10697 ** with a NULL pointer as the second parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10698 ** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10699 ** the first parameter to callbacks.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10700 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10701 ** ^The preupdate hook only fires for changes to real database tables; the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10702 ** preupdate hook is not invoked for changes to [virtual tables] or to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10703 ** system tables like sqlite_sequence or sqlite_stat1.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10704 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10705 ** ^The second parameter to the preupdate callback is a pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10706 ** the [database connection] that registered the preupdate hook.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10707 ** ^The third parameter to the preupdate callback is one of the constants
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10708 ** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10709 ** kind of update operation that is about to occur.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10710 ** ^(The fourth parameter to the preupdate callback is the name of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10711 ** database within the database connection that is being modified. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10712 ** will be "main" for the main database or "temp" for TEMP tables or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10713 ** the name given after the AS keyword in the [ATTACH] statement for attached
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10714 ** databases.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10715 ** ^The fifth parameter to the preupdate callback is the name of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10716 ** table that is being modified.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10717 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10718 ** For an UPDATE or DELETE operation on a [rowid table], the sixth
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10719 ** parameter passed to the preupdate callback is the initial [rowid] of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10720 ** row being modified or deleted. For an INSERT operation on a rowid table,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10721 ** or any operation on a WITHOUT ROWID table, the value of the sixth
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10722 ** parameter is undefined. For an INSERT or UPDATE on a rowid table the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10723 ** seventh parameter is the final rowid value of the row being inserted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10724 ** or updated. The value of the seventh parameter passed to the callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10725 ** function is not defined for operations on WITHOUT ROWID tables, or for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10726 ** DELETE operations on rowid tables.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10727 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10728 ** ^The sqlite3_preupdate_hook(D,C,P) function returns the P argument from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10729 ** the previous call on the same [database connection] D, or NULL for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10730 ** the first call on D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10731 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10732 ** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10733 ** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10734 ** provide additional information about a preupdate event. These routines
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10735 ** may only be called from within a preupdate callback. Invoking any of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10736 ** these routines from outside of a preupdate callback or with a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10737 ** [database connection] pointer that is different from the one supplied
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10738 ** to the preupdate callback results in undefined and probably undesirable
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10739 ** behavior.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10740 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10741 ** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10742 ** in the row that is being inserted, updated, or deleted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10743 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10744 ** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10745 ** a [protected sqlite3_value] that contains the value of the Nth column of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10746 ** the table row before it is updated. The N parameter must be between 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10747 ** and one less than the number of columns or the behavior will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10748 ** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10749 ** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10750 ** behavior is undefined. The [sqlite3_value] that P points to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10751 ** will be destroyed when the preupdate callback returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10752 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10753 ** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10754 ** a [protected sqlite3_value] that contains the value of the Nth column of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10755 ** the table row after it is updated. The N parameter must be between 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10756 ** and one less than the number of columns or the behavior will be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10757 ** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10758 ** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10759 ** behavior is undefined. The [sqlite3_value] that P points to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10760 ** will be destroyed when the preupdate callback returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10761 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10762 ** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10763 ** callback was invoked as a result of a direct insert, update, or delete
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10764 ** operation; or 1 for inserts, updates, or deletes invoked by top-level
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10765 ** triggers; or 2 for changes resulting from triggers called by top-level
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10766 ** triggers; and so forth.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10767 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10768 ** When the [sqlite3_blob_write()] API is used to update a blob column,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10769 ** the pre-update hook is invoked with SQLITE_DELETE, because
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10770 ** the new values are not yet available. In this case, when a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10771 ** callback made with op==SQLITE_DELETE is actually a write using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10772 ** sqlite3_blob_write() API, the [sqlite3_preupdate_blobwrite()] returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10773 ** the index of the column being written. In other cases, where the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10774 ** pre-update hook is being invoked for some other reason, including a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10775 ** regular DELETE, sqlite3_preupdate_blobwrite() returns -1.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10776 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10777 ** See also: [sqlite3_update_hook()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10778 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10779 #if defined(SQLITE_ENABLE_PREUPDATE_HOOK)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10780 SQLITE_API void *sqlite3_preupdate_hook(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10781 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10782 void(*xPreUpdate)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10783 void pCtx, / Copy of third arg to preupdate_hook() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10784 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10785 int op, /* SQLITE_UPDATE, DELETE or INSERT */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10786 char const zDb, / Database name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10787 char const zName, / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10788 sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10789 sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10790 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10791 void*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10792 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10793 SQLITE_API int sqlite3_preupdate_old(sqlite3 , int, sqlite3_value *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10794 SQLITE_API int sqlite3_preupdate_count(sqlite3 *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10795 SQLITE_API int sqlite3_preupdate_depth(sqlite3 *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10796 SQLITE_API int sqlite3_preupdate_new(sqlite3 , int, sqlite3_value *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10797 SQLITE_API int sqlite3_preupdate_blobwrite(sqlite3 *);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10798 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10799
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10800 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10801 ** CAPI3REF: Low-level system error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10802 ** METHOD: sqlite3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10803 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10804 ** ^Attempt to return the underlying operating system error code or error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10805 ** number that caused the most recent I/O error or failure to open a file.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10806 ** The return value is OS-dependent. For example, on unix systems, after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10807 ** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10808 ** called to get back the underlying "errno" that caused the problem, such
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10809 ** as ENOSPC, EAUTH, EISDIR, and so forth.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10810 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10811 SQLITE_API int sqlite3_system_errno(sqlite3*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10812
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10813 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10814 ** CAPI3REF: Database Snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10815 ** KEYWORDS: {snapshot} {sqlite3_snapshot}
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10816 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10817 ** An instance of the snapshot object records the state of a [WAL mode]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10818 ** database for some specific point in history.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10819 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10820 ** In [WAL mode], multiple [database connections] that are open on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10821 ** same database file can each be reading a different historical version
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10822 ** of the database file. When a [database connection] begins a read
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10823 ** transaction, that connection sees an unchanging copy of the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10824 ** as it existed for the point in time when the transaction first started.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10825 ** Subsequent changes to the database from other connections are not seen
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10826 ** by the reader until a new read transaction is started.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10827 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10828 ** The sqlite3_snapshot object records state information about an historical
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10829 ** version of the database file so that it is possible to later open a new read
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10830 ** transaction that sees that historical version of the database rather than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10831 ** the most recent version.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10832 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10833 typedef struct sqlite3_snapshot {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10834 unsigned char hidden[48];
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10835 } sqlite3_snapshot;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10836
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10837 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10838 ** CAPI3REF: Record A Database Snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10839 ** CONSTRUCTOR: sqlite3_snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10840 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10841 ** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10842 ** new [sqlite3_snapshot] object that records the current state of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10843 ** schema S in database connection D. ^On success, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10844 ** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10845 ** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10846 ** If there is not already a read-transaction open on schema S when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10847 ** this function is called, one is opened automatically.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10848 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10849 ** If a read-transaction is opened by this function, then it is guaranteed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10850 ** that the returned snapshot object may not be invalidated by a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10851 ** writer or checkpointer until after the read-transaction is closed. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10852 ** is not guaranteed if a read-transaction is already open when this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10853 ** function is called. In that case, any subsequent write or checkpoint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10854 ** operation on the database may invalidate the returned snapshot handle,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10855 ** even while the read-transaction remains open.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10856 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10857 ** The following must be true for this function to succeed. If any of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10858 ** the following statements are false when sqlite3_snapshot_get() is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10859 ** called, SQLITE_ERROR is returned. The final value of *P is undefined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10860 ** in this case.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10861 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10862 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10863 ** <li> The database handle must not be in [autocommit mode].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10864 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10865 ** <li> Schema S of [database connection] D must be a [WAL mode] database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10866 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10867 ** <li> There must not be a write transaction open on schema S of database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10868 ** connection D.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10869 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10870 ** <li> One or more transactions must have been written to the current wal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10871 ** file since it was created on disk (by any connection). This means
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10872 ** that a snapshot cannot be taken on a wal mode database with no wal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10873 ** file immediately after it is first opened. At least one transaction
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10874 ** must be written to it first.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10875 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10876 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10877 ** This function may also return SQLITE_NOMEM. If it is called with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10878 ** database handle in autocommit mode but fails for some other reason,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10879 ** whether or not a read transaction is opened on schema S is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10880 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10881 ** The [sqlite3_snapshot] object returned from a successful call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10882 ** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10883 ** to avoid a memory leak.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10884 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10885 ** The [sqlite3_snapshot_get()] interface is only available when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10886 ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10887 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10888 SQLITE_API int sqlite3_snapshot_get(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10889 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10890 const char *zSchema,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10891 sqlite3_snapshot **ppSnapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10892 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10893
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10894 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10895 ** CAPI3REF: Start a read transaction on an historical snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10896 ** METHOD: sqlite3_snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10897 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10898 ** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10899 ** transaction or upgrades an existing one for schema S of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10900 ** [database connection] D such that the read transaction refers to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10901 ** historical [snapshot] P, rather than the most recent change to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10902 ** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10903 ** on success or an appropriate [error code] if it fails.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10904 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10905 ** ^In order to succeed, the database connection must not be in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10906 ** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10907 ** is already a read transaction open on schema S, then the database handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10908 ** must have no active statements (SELECT statements that have been passed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10909 ** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10910 ** SQLITE_ERROR is returned if either of these conditions is violated, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10911 ** if schema S does not exist, or if the snapshot object is invalid.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10912 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10913 ** ^A call to sqlite3_snapshot_open() will fail to open if the specified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10914 ** snapshot has been overwritten by a [checkpoint]. In this case
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10915 ** SQLITE_ERROR_SNAPSHOT is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10916 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10917 ** If there is already a read transaction open when this function is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10918 ** invoked, then the same read transaction remains open (on the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10919 ** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10920 ** is returned. If another error code - for example SQLITE_PROTOCOL or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10921 ** SQLITE_IOERR error code - is returned, then the final state of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10922 ** read transaction is undefined. If SQLITE_OK is returned, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10923 ** read transaction is now open on database snapshot P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10924 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10925 ** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10926 ** database connection D does not know that the database file for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10927 ** schema S is in [WAL mode]. A database connection might not know
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10928 ** that the database file is in [WAL mode] if there has been no prior
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10929 ** I/O on that database connection, or if the database entered [WAL mode]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10930 ** after the most recent I/O on the database connection.)^
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10931 ** (Hint: Run "[PRAGMA application_id]" against a newly opened
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10932 ** database connection in order to make it ready to use snapshots.)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10933 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10934 ** The [sqlite3_snapshot_open()] interface is only available when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10935 ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10936 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10937 SQLITE_API int sqlite3_snapshot_open(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10938 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10939 const char *zSchema,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10940 sqlite3_snapshot *pSnapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10941 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10942
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10943 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10944 ** CAPI3REF: Destroy a snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10945 ** DESTRUCTOR: sqlite3_snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10946 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10947 ** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10948 ** The application must eventually free every [sqlite3_snapshot] object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10949 ** using this routine to avoid a memory leak.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10950 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10951 ** The [sqlite3_snapshot_free()] interface is only available when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10952 ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10953 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10954 SQLITE_API void sqlite3_snapshot_free(sqlite3_snapshot*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10955
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10956 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10957 ** CAPI3REF: Compare the ages of two snapshot handles.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10958 ** METHOD: sqlite3_snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10959 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10960 ** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10961 ** of two valid snapshot handles.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10962 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10963 ** If the two snapshot handles are not associated with the same database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10964 ** file, the result of the comparison is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10965 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10966 ** Additionally, the result of the comparison is only valid if both of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10967 ** snapshot handles were obtained by calling sqlite3_snapshot_get() since the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10968 ** last time the wal file was deleted. The wal file is deleted when the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10969 ** database is changed back to rollback mode or when the number of database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10970 ** clients drops to zero. If either snapshot handle was obtained before the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10971 ** wal file was last deleted, the value returned by this function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10972 ** is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10973 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10974 ** Otherwise, this API returns a negative value if P1 refers to an older
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10975 ** snapshot than P2, zero if the two handles refer to the same database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10976 ** snapshot, and a positive value if P1 is a newer snapshot than P2.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10977 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10978 ** This interface is only available if SQLite is compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10979 ** [SQLITE_ENABLE_SNAPSHOT] option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10980 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10981 SQLITE_API int sqlite3_snapshot_cmp(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10982 sqlite3_snapshot *p1,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10983 sqlite3_snapshot *p2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10984 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10985
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10986 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10987 ** CAPI3REF: Recover snapshots from a wal file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10988 ** METHOD: sqlite3_snapshot
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10989 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10990 ** If a [WAL file] remains on disk after all database connections close
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10991 ** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10992 ** or because the last process to have the database opened exited without
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10993 ** calling [sqlite3_close()]) and a new connection is subsequently opened
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10994 ** on that database and [WAL file], the [sqlite3_snapshot_open()] interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10995 ** will only be able to open the last transaction added to the WAL file
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10996 ** even though the WAL file contains other valid transactions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10997 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10998 ** This function attempts to scan the WAL file associated with database zDb
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	10999 ** of database handle db and make all valid snapshots available to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11000 ** sqlite3_snapshot_open(). It is an error if there is already a read
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11001 ** transaction open on the database, or if the database is not a WAL mode
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11002 ** database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11003 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11004 ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11005 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11006 ** This interface is only available if SQLite is compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11007 ** [SQLITE_ENABLE_SNAPSHOT] option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11008 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11009 SQLITE_API int sqlite3_snapshot_recover(sqlite3 db, const char zDb);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11010
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11011 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11012 ** CAPI3REF: Serialize a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11013 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11014 ** The sqlite3_serialize(D,S,P,F) interface returns a pointer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11015 ** memory that is a serialization of the S database on
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11016 ** [database connection] D. If S is a NULL pointer, the main database is used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11017 ** If P is not a NULL pointer, then the size of the database in bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11018 ** is written into *P.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11019 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11020 ** For an ordinary on-disk database file, the serialization is just a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11021 ** copy of the disk file. For an in-memory database or a "TEMP" database,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11022 ** the serialization is the same sequence of bytes which would be written
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11023 ** to disk if that database were backed up to disk.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11024 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11025 ** The usual case is that sqlite3_serialize() copies the serialization of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11026 ** the database into memory obtained from [sqlite3_malloc64()] and returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11027 ** a pointer to that memory. The caller is responsible for freeing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11028 ** returned value to avoid a memory leak. However, if the F argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11029 ** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11030 ** are made, and the sqlite3_serialize() function will return a pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11031 ** to the contiguous memory representation of the database that SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11032 ** is currently using for that database, or NULL if no such contiguous
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11033 ** memory representation of the database exists. A contiguous memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11034 ** representation of the database will usually only exist if there has
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11035 ** been a prior call to [sqlite3_deserialize(D,S,...)] with the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11036 ** values of D and S.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11037 ** The size of the database is written into *P even if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11038 ** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11039 ** of the database exists.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11040 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11041 ** After the call, if the SQLITE_SERIALIZE_NOCOPY bit had been set,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11042 ** the returned buffer content will remain accessible and unchanged
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11043 ** until either the next write operation on the connection or when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11044 ** the connection is closed, and applications must not modify the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11045 ** buffer. If the bit had been clear, the returned buffer will not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11046 ** be accessed by SQLite after the call.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11047 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11048 ** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11049 ** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11050 ** allocation error occurs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11051 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11052 ** This interface is omitted if SQLite is compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11053 ** [SQLITE_OMIT_DESERIALIZE] option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11054 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11055 SQLITE_API unsigned char *sqlite3_serialize(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11056 sqlite3 db, / The database connection */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11057 const char zSchema, / Which DB to serialize. ex: "main", "temp", ... */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11058 sqlite3_int64 piSize, / Write size of the DB here, if not NULL */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11059 unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11060 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11061
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11062 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11063 ** CAPI3REF: Flags for sqlite3_serialize
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11064 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11065 ** Zero or more of the following constants can be OR-ed together for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11066 ** the F argument to [sqlite3_serialize(D,S,P,F)].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11067 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11068 ** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11069 ** a pointer to contiguous in-memory database that it is currently using,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11070 ** without making a copy of the database. If SQLite is not currently using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11071 ** a contiguous in-memory database, then this option causes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11072 ** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11073 ** using a contiguous in-memory database if it has been initialized by a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11074 ** prior call to [sqlite3_deserialize()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11075 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11076 #define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11077
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11078 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11079 ** CAPI3REF: Deserialize a database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11080 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11081 ** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11082 ** [database connection] D to disconnect from database S and then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11083 ** reopen S as an in-memory database based on the serialization
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11084 ** contained in P. If S is a NULL pointer, the main database is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11085 ** used. The serialized database P is N bytes in size. M is the size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11086 ** of the buffer P, which might be larger than N. If M is larger than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11087 ** N, and the SQLITE_DESERIALIZE_READONLY bit is not set in F, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11088 ** SQLite is permitted to add content to the in-memory database as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11089 ** long as the total size does not exceed M bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11090 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11091 ** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11092 ** invoke sqlite3_free() on the serialization buffer when the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11093 ** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11094 ** SQLite will try to increase the buffer size using sqlite3_realloc64()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11095 ** if writes on the database cause it to grow larger than M bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11096 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11097 ** Applications must not modify the buffer P or invalidate it before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11098 ** the database connection D is closed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11099 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11100 ** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11101 ** database is currently in a read transaction or is involved in a backup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11102 ** operation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11103 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11104 ** It is not possible to deserialize into the TEMP database. If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11105 ** S argument to sqlite3_deserialize(D,S,P,N,M,F) is "temp" then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11106 ** function returns SQLITE_ERROR.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11107 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11108 ** The deserialized database should not be in [WAL mode]. If the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11109 ** is in WAL mode, then any attempt to use the database file will result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11110 ** in an [SQLITE_CANTOPEN] error. The application can set the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11111 ** [file format version numbers] (bytes 18 and 19) of the input database P
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11112 ** to 0x01 prior to invoking sqlite3_deserialize(D,S,P,N,M,F) to force the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11113 ** database file into rollback mode and work around this limitation.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11114 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11115 ** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11116 ** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11117 ** [sqlite3_free()] is invoked on argument P prior to returning.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11118 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11119 ** This interface is omitted if SQLite is compiled with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11120 ** [SQLITE_OMIT_DESERIALIZE] option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11121 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11122 SQLITE_API int sqlite3_deserialize(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11123 sqlite3 db, / The database connection */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11124 const char zSchema, / Which DB to reopen with the deserialization */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11125 unsigned char pData, / The serialized database content */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11126 sqlite3_int64 szDb, /* Number of bytes in the deserialization */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11127 sqlite3_int64 szBuf, /* Total size of buffer pData[] */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11128 unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11129 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11130
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11131 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11132 ** CAPI3REF: Flags for sqlite3_deserialize()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11133 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11134 ** The following are allowed values for the 6th argument (the F argument) to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11135 ** the [sqlite3_deserialize(D,S,P,N,M,F)] interface.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11136 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11137 ** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11138 ** in the P argument is held in memory obtained from [sqlite3_malloc64()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11139 ** and that SQLite should take ownership of this memory and automatically
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11140 ** free it when it has finished using it. Without this flag, the caller
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11141 ** is responsible for freeing any dynamically allocated memory.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11142 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11143 ** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11144 ** grow the size of the database using calls to [sqlite3_realloc64()]. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11145 ** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11146 ** Without this flag, the deserialized database cannot increase in size beyond
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11147 ** the number of bytes specified by the M parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11148 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11149 ** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11150 ** should be treated as read-only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11151 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11152 #define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11153 #define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11154 #define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11155
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11156 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11157 ** CAPI3REF: Bind array values to the CARRAY table-valued function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11158 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11159 ** The sqlite3_carray_bind(S,I,P,N,F,X) interface binds an array value to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11160 ** one of the first argument of the [carray() table-valued function]. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11161 ** S parameter is a pointer to the [prepared statement] that uses the carray()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11162 ** functions. I is the parameter index to be bound. P is a pointer to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11163 ** array to be bound, and N is the number of eements in the array. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11164 ** F argument is one of constants [SQLITE_CARRAY_INT32], [SQLITE_CARRAY_INT64],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11165 ** [SQLITE_CARRAY_DOUBLE], [SQLITE_CARRAY_TEXT], or [SQLITE_CARRAY_BLOB] to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11166 ** indicate the datatype of the array being bound. The X argument is not a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11167 ** NULL pointer, then SQLite will invoke the function X on the P parameter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11168 ** after it has finished using P, even if the call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11169 ** sqlite3_carray_bind() fails. The special-case finalizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11170 ** SQLITE_TRANSIENT has no effect here.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11171 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11172 SQLITE_API int sqlite3_carray_bind(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11173 sqlite3_stmt pStmt, / Statement to be bound */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11174 int i, /* Parameter index */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11175 void aData, / Pointer to array data */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11176 int nData, /* Number of data elements */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11177 int mFlags, /* CARRAY flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11178 void (xDel)(void) /* Destructor for aData */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11179 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11180
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11181 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11182 ** CAPI3REF: Datatypes for the CARRAY table-valued function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11183 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11184 ** The fifth argument to the [sqlite3_carray_bind()] interface musts be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11185 ** one of the following constants, to specify the datatype of the array
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11186 ** that is being bound into the [carray table-valued function].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11187 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11188 #define SQLITE_CARRAY_INT32 0 /* Data is 32-bit signed integers */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11189 #define SQLITE_CARRAY_INT64 1 /* Data is 64-bit signed integers */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11190 #define SQLITE_CARRAY_DOUBLE 2 /* Data is doubles */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11191 #define SQLITE_CARRAY_TEXT 3 /* Data is char* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11192 #define SQLITE_CARRAY_BLOB 4 /* Data is struct iovec */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11193
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11194 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11195 ** Versions of the above #defines that omit the initial SQLITE_, for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11196 ** legacy compatibility.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11197 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11198 #define CARRAY_INT32 0 /* Data is 32-bit signed integers */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11199 #define CARRAY_INT64 1 /* Data is 64-bit signed integers */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11200 #define CARRAY_DOUBLE 2 /* Data is doubles */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11201 #define CARRAY_TEXT 3 /* Data is char* */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11202 #define CARRAY_BLOB 4 /* Data is struct iovec */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11203
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11204 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11205 ** Undo the hack that converts floating point types to integer for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11206 ** builds on processors without floating point support.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11207 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11208 #ifdef SQLITE_OMIT_FLOATING_POINT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11209 # undef double
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11210 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11211
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11212 #if defined(__wasi__)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11213 # undef SQLITE_WASI
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11214 # define SQLITE_WASI 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11215 # ifndef SQLITE_OMIT_LOAD_EXTENSION
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11216 # define SQLITE_OMIT_LOAD_EXTENSION
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11217 # endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11218 # ifndef SQLITE_THREADSAFE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11219 # define SQLITE_THREADSAFE 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11220 # endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11221 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11222
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11223 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11224 } /* End of the 'extern "C"' block */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11225 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11226 /* #endif for SQLITE3_H will be added by mksqlite3.tcl */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11227
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11228 /****** Begin file sqlite3rtree.h *******/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11229 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11230 ** 2010 August 30
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11231 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11232 ** The author disclaims copyright to this source code. In place of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11233 ** a legal notice, here is a blessing:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11234 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11235 ** May you do good and not evil.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11236 ** May you find forgiveness for yourself and forgive others.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11237 ** May you share freely, never taking more than you give.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11238 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11239 *************************************************************************
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11240 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11241
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11242 #ifndef _SQLITE3RTREE_H_
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11243 #define _SQLITE3RTREE_H_
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11244
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11245
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11246 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11247 extern "C" {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11248 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11249
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11250 typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11251 typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11252
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11253 /* The double-precision datatype used by RTree depends on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11254 ** SQLITE_RTREE_INT_ONLY compile-time option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11255 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11256 #ifdef SQLITE_RTREE_INT_ONLY
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11257 typedef sqlite3_int64 sqlite3_rtree_dbl;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11258 #else
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11259 typedef double sqlite3_rtree_dbl;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11260 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11261
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11262 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11263 ** Register a geometry callback named zGeom that can be used as part of an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11264 ** R-Tree geometry query as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11265 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11266 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11267 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11268 SQLITE_API int sqlite3_rtree_geometry_callback(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11269 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11270 const char *zGeom,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11271 int (xGeom)(sqlite3_rtree_geometry, int, sqlite3_rtree_dbl,int),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11272 void *pContext
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11273 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11274
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11275
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11276 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11277 ** A pointer to a structure of the following type is passed as the first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11278 ** argument to callbacks registered using rtree_geometry_callback().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11279 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11280 struct sqlite3_rtree_geometry {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11281 void pContext; / Copy of pContext passed to s_r_g_c() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11282 int nParam; /* Size of array aParam[] */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11283 sqlite3_rtree_dbl aParam; / Parameters passed to SQL geom function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11284 void pUser; / Callback implementation user data */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11285 void (xDelUser)(void ); /* Called by SQLite to clean up pUser */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11286 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11287
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11288 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11289 ** Register a 2nd-generation geometry callback named zScore that can be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11290 ** used as part of an R-Tree geometry query as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11291 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11292 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11293 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11294 SQLITE_API int sqlite3_rtree_query_callback(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11295 sqlite3 *db,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11296 const char *zQueryFunc,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11297 int (xQueryFunc)(sqlite3_rtree_query_info),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11298 void *pContext,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11299 void (xDestructor)(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11300 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11301
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11302
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11303 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11304 ** A pointer to a structure of the following type is passed as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11305 ** argument to scored geometry callback registered using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11306 ** sqlite3_rtree_query_callback().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11307 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11308 ** Note that the first 5 fields of this structure are identical to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11309 ** sqlite3_rtree_geometry. This structure is a subclass of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11310 ** sqlite3_rtree_geometry.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11311 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11312 struct sqlite3_rtree_query_info {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11313 void pContext; / pContext from when function registered */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11314 int nParam; /* Number of function parameters */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11315 sqlite3_rtree_dbl aParam; / value of function parameters */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11316 void pUser; / callback can use this, if desired */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11317 void (xDelUser)(void); /* function to free pUser */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11318 sqlite3_rtree_dbl aCoord; / Coordinates of node or entry to check */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11319 unsigned int anQueue; / Number of pending entries in the queue */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11320 int nCoord; /* Number of coordinates */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11321 int iLevel; /* Level of current node or entry */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11322 int mxLevel; /* The largest iLevel value in the tree */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11323 sqlite3_int64 iRowid; /* Rowid for current entry */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11324 sqlite3_rtree_dbl rParentScore; /* Score of parent node */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11325 int eParentWithin; /* Visibility of parent node */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11326 int eWithin; /* OUT: Visibility */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11327 sqlite3_rtree_dbl rScore; /* OUT: Write the score here */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11328 /* The following fields are only available in 3.8.11 and later */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11329 sqlite3_value *apSqlParam; / Original SQL values of parameters */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11330 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11331
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11332 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11333 ** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11334 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11335 #define NOT_WITHIN 0 /* Object completely outside of query region */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11336 #define PARTLY_WITHIN 1 /* Object partially overlaps query region */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11337 #define FULLY_WITHIN 2 /* Object fully contained within query region */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11338
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11339
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11340 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11341 } /* end of the 'extern "C"' block */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11342 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11343
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11344 #endif /* ifndef _SQLITE3RTREE_H_ */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11345
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11346 /****** End of sqlite3rtree.h *******/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11347 /****** Begin file sqlite3session.h *******/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11348
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11349 #if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11350 #define __SQLITESESSION_H_ 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11351
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11352 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11353 ** Make sure we can call this stuff from C++.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11354 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11355 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11356 extern "C" {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11357 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11358
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11359
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11360 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11361 ** CAPI3REF: Session Object Handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11362 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11363 ** An instance of this object is a [session] that can be used to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11364 ** record changes to a database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11365 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11366 typedef struct sqlite3_session sqlite3_session;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11367
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11368 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11369 ** CAPI3REF: Changeset Iterator Handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11370 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11371 ** An instance of this object acts as a cursor for iterating
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11372 ** over the elements of a [changeset] or [patchset].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11373 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11374 typedef struct sqlite3_changeset_iter sqlite3_changeset_iter;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11375
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11376 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11377 ** CAPI3REF: Create A New Session Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11378 ** CONSTRUCTOR: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11379 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11380 ** Create a new session object attached to database handle db. If successful,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11381 ** a pointer to the new object is written to *ppSession and SQLITE_OK is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11382 ** returned. If an error occurs, *ppSession is set to NULL and an SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11383 ** error code (e.g. SQLITE_NOMEM) is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11384 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11385 ** It is possible to create multiple session objects attached to a single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11386 ** database handle.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11387 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11388 ** Session objects created using this function should be deleted using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11389 ** [sqlite3session_delete()] function before the database handle that they
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11390 ** are attached to is itself closed. If the database handle is closed before
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11391 ** the session object is deleted, then the results of calling any session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11392 ** module function, including [sqlite3session_delete()] on the session object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11393 ** are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11394 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11395 ** Because the session module uses the [sqlite3_preupdate_hook()] API, it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11396 ** is not possible for an application to register a pre-update hook on a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11397 ** database handle that has one or more session objects attached. Nor is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11398 ** it possible to create a session object attached to a database handle for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11399 ** which a pre-update hook is already defined. The results of attempting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11400 ** either of these things are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11401 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11402 ** The session object will be used to create changesets for tables in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11403 ** database zDb, where zDb is either "main", or "temp", or the name of an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11404 ** attached database. It is not an error if database zDb is not attached
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11405 ** to the database when the session object is created.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11406 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11407 SQLITE_API int sqlite3session_create(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11408 sqlite3 db, / Database handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11409 const char zDb, / Name of db (e.g. "main") */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11410 sqlite3_session *ppSession / OUT: New session object */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11411 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11412
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11413 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11414 ** CAPI3REF: Delete A Session Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11415 ** DESTRUCTOR: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11416 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11417 ** Delete a session object previously allocated using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11418 ** [sqlite3session_create()]. Once a session object has been deleted, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11419 ** results of attempting to use pSession with any other session module
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11420 ** function are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11421 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11422 ** Session objects must be deleted before the database handle to which they
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11423 ** are attached is closed. Refer to the documentation for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11424 ** [sqlite3session_create()] for details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11425 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11426 SQLITE_API void sqlite3session_delete(sqlite3_session *pSession);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11427
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11428 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11429 ** CAPI3REF: Configure a Session Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11430 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11431 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11432 ** This method is used to configure a session object after it has been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11433 ** created. At present the only valid values for the second parameter are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11434 ** [SQLITE_SESSION_OBJCONFIG_SIZE] and [SQLITE_SESSION_OBJCONFIG_ROWID].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11435 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11436 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11437 SQLITE_API int sqlite3session_object_config(sqlite3_session, int op, void pArg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11438
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11439 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11440 ** CAPI3REF: Options for sqlite3session_object_config
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11441 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11442 ** The following values may passed as the the 2nd parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11443 ** sqlite3session_object_config().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11444 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11445 ** <dt>SQLITE_SESSION_OBJCONFIG_SIZE <dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11446 ** This option is used to set, clear or query the flag that enables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11447 ** the [sqlite3session_changeset_size()] API. Because it imposes some
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11448 ** computational overhead, this API is disabled by default. Argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11449 ** pArg must point to a value of type (int). If the value is initially
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11450 ** 0, then the sqlite3session_changeset_size() API is disabled. If it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11451 ** is greater than 0, then the same API is enabled. Or, if the initial
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11452 ** value is less than zero, no change is made. In all cases the (int)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11453 ** variable is set to 1 if the sqlite3session_changeset_size() API is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11454 ** enabled following the current call, or 0 otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11455 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11456 ** It is an error (SQLITE_MISUSE) to attempt to modify this setting after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11457 ** the first table has been attached to the session object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11458 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11459 ** <dt>SQLITE_SESSION_OBJCONFIG_ROWID <dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11460 ** This option is used to set, clear or query the flag that enables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11461 ** collection of data for tables with no explicit PRIMARY KEY.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11462 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11463 ** Normally, tables with no explicit PRIMARY KEY are simply ignored
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11464 ** by the sessions module. However, if this flag is set, it behaves
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11465 ** as if such tables have a column "_rowid_ INTEGER PRIMARY KEY" inserted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11466 ** as their leftmost columns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11467 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11468 ** It is an error (SQLITE_MISUSE) to attempt to modify this setting after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11469 ** the first table has been attached to the session object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11470 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11471 #define SQLITE_SESSION_OBJCONFIG_SIZE 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11472 #define SQLITE_SESSION_OBJCONFIG_ROWID 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11473
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11474 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11475 ** CAPI3REF: Enable Or Disable A Session Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11476 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11477 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11478 ** Enable or disable the recording of changes by a session object. When
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11479 ** enabled, a session object records changes made to the database. When
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11480 ** disabled - it does not. A newly created session object is enabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11481 ** Refer to the documentation for [sqlite3session_changeset()] for further
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11482 ** details regarding how enabling and disabling a session object affects
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11483 ** the eventual changesets.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11484 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11485 ** Passing zero to this function disables the session. Passing a value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11486 ** greater than zero enables it. Passing a value less than zero is a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11487 ** no-op, and may be used to query the current state of the session.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11488 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11489 ** The return value indicates the final state of the session object: 0 if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11490 ** the session is disabled, or 1 if it is enabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11491 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11492 SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11493
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11494 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11495 ** CAPI3REF: Set Or Clear the Indirect Change Flag
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11496 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11497 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11498 ** Each change recorded by a session object is marked as either direct or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11499 ** indirect. A change is marked as indirect if either:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11500 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11501 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11502 ** <li> The session object "indirect" flag is set when the change is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11503 ** made, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11504 ** <li> The change is made by an SQL trigger or foreign key action
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11505 ** instead of directly as a result of a users SQL statement.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11506 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11507 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11508 ** If a single row is affected by more than one operation within a session,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11509 ** then the change is considered indirect if all operations meet the criteria
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11510 ** for an indirect change above, or direct otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11511 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11512 ** This function is used to set, clear or query the session object indirect
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11513 ** flag. If the second argument passed to this function is zero, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11514 ** indirect flag is cleared. If it is greater than zero, the indirect flag
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11515 ** is set. Passing a value less than zero does not modify the current value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11516 ** of the indirect flag, and may be used to query the current state of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11517 ** indirect flag for the specified session object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11518 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11519 ** The return value indicates the final state of the indirect flag: 0 if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11520 ** it is clear, or 1 if it is set.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11521 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11522 SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11523
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11524 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11525 ** CAPI3REF: Attach A Table To A Session Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11526 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11527 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11528 ** If argument zTab is not NULL, then it is the name of a table to attach
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11529 ** to the session object passed as the first argument. All subsequent changes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11530 ** made to the table while the session object is enabled will be recorded. See
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11531 ** documentation for [sqlite3session_changeset()] for further details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11532 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11533 ** Or, if argument zTab is NULL, then changes are recorded for all tables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11534 ** in the database. If additional tables are added to the database (by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11535 ** executing "CREATE TABLE" statements) after this call is made, changes for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11536 ** the new tables are also recorded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11537 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11538 ** Changes can only be recorded for tables that have a PRIMARY KEY explicitly
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11539 ** defined as part of their CREATE TABLE statement. It does not matter if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11540 ** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11541 ** KEY may consist of a single column, or may be a composite key.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11542 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11543 ** It is not an error if the named table does not exist in the database. Nor
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11544 ** is it an error if the named table does not have a PRIMARY KEY. However,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11545 ** no changes will be recorded in either of these scenarios.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11546 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11547 ** Changes are not recorded for individual rows that have NULL values stored
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11548 ** in one or more of their PRIMARY KEY columns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11549 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11550 ** SQLITE_OK is returned if the call completes without error. Or, if an error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11551 ** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11552 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11553 ** <h3>Special sqlite_stat1 Handling</h3>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11554 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11555 ** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11556 ** some of the rules above. In SQLite, the schema of sqlite_stat1 is:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11557 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11558 **   CREATE TABLE sqlite_stat1(tbl,idx,stat)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11559 ** </pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11560 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11561 ** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11562 ** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11563 ** are recorded for rows for which (idx IS NULL) is true. However, for such
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11564 ** rows a zero-length blob (SQL value X'') is stored in the changeset or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11565 ** patchset instead of a NULL value. This allows such changesets to be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11566 ** manipulated by legacy implementations of sqlite3changeset_invert(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11567 ** concat() and similar.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11568 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11569 ** The sqlite3changeset_apply() function automatically converts the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11570 ** zero-length blob back to a NULL value when updating the sqlite_stat1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11571 ** table. However, if the application calls sqlite3changeset_new(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11572 ** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11573 ** iterator directly (including on a changeset iterator passed to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11574 ** conflict-handler callback) then the X'' value is returned. The application
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11575 ** must translate X'' to NULL itself if required.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11576 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11577 ** Legacy (older than 3.22.0) versions of the sessions module cannot capture
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11578 ** changes made to the sqlite_stat1 table. Legacy versions of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11579 ** sqlite3changeset_apply() function silently ignore any modifications to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11580 ** sqlite_stat1 table that are part of a changeset or patchset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11581 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11582 SQLITE_API int sqlite3session_attach(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11583 sqlite3_session pSession, / Session object */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11584 const char zTab / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11585 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11586
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11587 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11588 ** CAPI3REF: Set a table filter on a Session Object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11589 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11590 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11591 ** The second argument (xFilter) is the "filter callback". For changes to rows
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11592 ** in tables that are not attached to the Session object, the filter is called
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11593 ** to determine whether changes to the table's rows should be tracked or not.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11594 ** If xFilter returns 0, changes are not tracked. Note that once a table is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11595 ** attached, xFilter will not be called again.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11596 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11597 SQLITE_API void sqlite3session_table_filter(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11598 sqlite3_session pSession, / Session object */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11599 int(*xFilter)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11600 void pCtx, / Copy of third arg to _filter_table() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11601 const char zTab / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11602 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11603 void pCtx / First argument passed to xFilter */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11604 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11605
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11606 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11607 ** CAPI3REF: Generate A Changeset From A Session Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11608 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11609 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11610 ** Obtain a changeset containing changes to the tables attached to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11611 ** session object passed as the first argument. If successful,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11612 ** set *ppChangeset to point to a buffer containing the changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11613 ** and *pnChangeset to the size of the changeset in bytes before returning
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11614 ** SQLITE_OK. If an error occurs, set both ppChangeset and pnChangeset to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11615 ** zero and return an SQLite error code.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11616 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11617 ** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11618 ** each representing a change to a single row of an attached table. An INSERT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11619 ** change contains the values of each field of a new database row. A DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11620 ** contains the original values of each field of a deleted database row. An
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11621 ** UPDATE change contains the original values of each field of an updated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11622 ** database row along with the updated values for each updated non-primary-key
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11623 ** column. It is not possible for an UPDATE change to represent a change that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11624 ** modifies the values of primary key columns. If such a change is made, it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11625 ** is represented in a changeset as a DELETE followed by an INSERT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11626 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11627 ** Changes are not recorded for rows that have NULL values stored in one or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11628 ** more of their PRIMARY KEY columns. If such a row is inserted or deleted,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11629 ** no corresponding change is present in the changesets returned by this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11630 ** function. If an existing row with one or more NULL values stored in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11631 ** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11632 ** only an INSERT is appears in the changeset. Similarly, if an existing row
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11633 ** with non-NULL PRIMARY KEY values is updated so that one or more of its
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11634 ** PRIMARY KEY columns are set to NULL, the resulting changeset contains a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11635 ** DELETE change only.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11636 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11637 ** The contents of a changeset may be traversed using an iterator created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11638 ** using the [sqlite3changeset_start()] API. A changeset may be applied to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11639 ** a database with a compatible schema using the [sqlite3changeset_apply()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11640 ** API.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11641 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11642 ** Within a changeset generated by this function, all changes related to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11643 ** single table are grouped together. In other words, when iterating through
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11644 ** a changeset or when applying a changeset to a database, all changes related
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11645 ** to a single table are processed before moving on to the next table. Tables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11646 ** are sorted in the same order in which they were attached (or auto-attached)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11647 ** to the sqlite3_session object. The order in which the changes related to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11648 ** a single table are stored is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11649 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11650 ** Following a successful call to this function, it is the responsibility of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11651 ** the caller to eventually free the buffer that *ppChangeset points to using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11652 ** [sqlite3_free()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11653 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11654 ** <h3>Changeset Generation</h3>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11655 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11656 ** Once a table has been attached to a session object, the session object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11657 ** records the primary key values of all new rows inserted into the table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11658 ** It also records the original primary key and other column values of any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11659 ** deleted or updated rows. For each unique primary key value, data is only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11660 ** recorded once - the first time a row with said primary key is inserted,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11661 ** updated or deleted in the lifetime of the session.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11662 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11663 ** There is one exception to the previous paragraph: when a row is inserted,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11664 ** updated or deleted, if one or more of its primary key columns contain a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11665 ** NULL value, no record of the change is made.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11666 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11667 ** The session object therefore accumulates two types of records - those
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11668 ** that consist of primary key values only (created when the user inserts
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11669 ** a new record) and those that consist of the primary key values and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11670 ** original values of other table columns (created when the users deletes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11671 ** or updates a record).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11672 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11673 ** When this function is called, the requested changeset is created using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11674 ** both the accumulated records and the current contents of the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11675 ** file. Specifically:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11676 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11677 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11678 ** <li> For each record generated by an insert, the database is queried
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11679 ** for a row with a matching primary key. If one is found, an INSERT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11680 ** change is added to the changeset. If no such row is found, no change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11681 ** is added to the changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11682 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11683 ** <li> For each record generated by an update or delete, the database is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11684 ** queried for a row with a matching primary key. If such a row is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11685 ** found and one or more of the non-primary key fields have been
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11686 ** modified from their original values, an UPDATE change is added to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11687 ** the changeset. Or, if no such row is found in the table, a DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11688 ** change is added to the changeset. If there is a row with a matching
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11689 ** primary key in the database, but all fields contain their original
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11690 ** values, no change is added to the changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11691 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11692 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11693 ** This means, amongst other things, that if a row is inserted and then later
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11694 ** deleted while a session object is active, neither the insert nor the delete
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11695 ** will be present in the changeset. Or if a row is deleted and then later a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11696 ** row with the same primary key values inserted while a session object is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11697 ** active, the resulting changeset will contain an UPDATE change instead of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11698 ** a DELETE and an INSERT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11699 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11700 ** When a session object is disabled (see the [sqlite3session_enable()] API),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11701 ** it does not accumulate records when rows are inserted, updated or deleted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11702 ** This may appear to have some counter-intuitive effects if a single row
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11703 ** is written to more than once during a session. For example, if a row
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11704 ** is inserted while a session object is enabled, then later deleted while
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11705 ** the same session object is disabled, no INSERT record will appear in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11706 ** changeset, even though the delete took place while the session was disabled.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11707 ** Or, if one field of a row is updated while a session is enabled, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11708 ** then another field of the same row is updated while the session is disabled,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11709 ** the resulting changeset will contain an UPDATE change that updates both
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11710 ** fields.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11711 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11712 SQLITE_API int sqlite3session_changeset(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11713 sqlite3_session pSession, / Session object */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11714 int pnChangeset, / OUT: Size of buffer at ppChangeset /
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11715 void *ppChangeset / OUT: Buffer containing changeset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11716 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11717
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11718 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11719 ** CAPI3REF: Return An Upper-limit For The Size Of The Changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11720 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11721 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11722 ** By default, this function always returns 0. For it to return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11723 ** a useful result, the sqlite3_session object must have been configured
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11724 ** to enable this API using sqlite3session_object_config() with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11725 ** SQLITE_SESSION_OBJCONFIG_SIZE verb.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11726 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11727 ** When enabled, this function returns an upper limit, in bytes, for the size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11728 ** of the changeset that might be produced if sqlite3session_changeset() were
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11729 ** called. The final changeset size might be equal to or smaller than the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11730 ** size in bytes returned by this function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11731 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11732 SQLITE_API sqlite3_int64 sqlite3session_changeset_size(sqlite3_session *pSession);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11733
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11734 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11735 ** CAPI3REF: Load The Difference Between Tables Into A Session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11736 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11737 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11738 ** If it is not already attached to the session object passed as the first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11739 ** argument, this function attaches table zTbl in the same manner as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11740 ** [sqlite3session_attach()] function. If zTbl does not exist, or if it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11741 ** does not have a primary key, this function is a no-op (but does not return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11742 ** an error).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11743 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11744 ** Argument zFromDb must be the name of a database ("main", "temp" etc.)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11745 ** attached to the same database handle as the session object that contains
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11746 ** a table compatible with the table attached to the session by this function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11747 ** A table is considered compatible if it:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11748 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11749 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11750 ** <li> Has the same name,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11751 ** <li> Has the same set of columns declared in the same order, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11752 ** <li> Has the same PRIMARY KEY definition.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11753 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11754 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11755 ** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11756 ** are compatible but do not have any PRIMARY KEY columns, it is not an error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11757 ** but no changes are added to the session object. As with other session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11758 ** APIs, tables without PRIMARY KEYs are simply ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11759 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11760 ** This function adds a set of changes to the session object that could be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11761 ** used to update the table in database zFrom (call this the "from-table")
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11762 ** so that its content is the same as the table attached to the session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11763 ** object (call this the "to-table"). Specifically:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11764 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11765 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11766 ** <li> For each row (primary key) that exists in the to-table but not in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11767 ** the from-table, an INSERT record is added to the session object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11768 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11769 ** <li> For each row (primary key) that exists in the to-table but not in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11770 ** the from-table, a DELETE record is added to the session object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11771 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11772 ** <li> For each row (primary key) that exists in both tables, but features
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11773 ** different non-PK values in each, an UPDATE record is added to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11774 ** session.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11775 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11776 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11777 ** To clarify, if this function is called and then a changeset constructed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11778 ** using [sqlite3session_changeset()], then after applying that changeset to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11779 ** database zFrom the contents of the two compatible tables would be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11780 ** identical.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11781 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11782 ** Unless the call to this function is a no-op as described above, it is an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11783 ** error if database zFrom does not exist or does not contain the required
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11784 ** compatible table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11785 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11786 ** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11787 ** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11788 ** may be set to point to a buffer containing an English language error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11789 ** message. It is the responsibility of the caller to free this buffer using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11790 ** sqlite3_free().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11791 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11792 SQLITE_API int sqlite3session_diff(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11793 sqlite3_session *pSession,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11794 const char *zFromDb,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11795 const char *zTbl,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11796 char **pzErrMsg
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11797 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11798
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11799
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11800 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11801 ** CAPI3REF: Generate A Patchset From A Session Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11802 ** METHOD: sqlite3_session
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11803 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11804 ** The differences between a patchset and a changeset are that:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11805 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11806 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11807 ** <li> DELETE records consist of the primary key fields only. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11808 ** original values of other fields are omitted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11809 ** <li> The original values of any modified fields are omitted from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11810 ** UPDATE records.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11811 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11812 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11813 ** A patchset blob may be used with up to date versions of all
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11814 ** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11815 ** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11816 ** attempting to use a patchset blob with old versions of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11817 ** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11818 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11819 ** Because the non-primary key "old.*" fields are omitted, no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11820 ** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11821 ** is passed to the sqlite3changeset_apply() API. Other conflict types work
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11822 ** in the same way as for changesets.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11823 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11824 ** Changes within a patchset are ordered in the same way as for changesets
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11825 ** generated by the sqlite3session_changeset() function (i.e. all changes for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11826 ** a single table are grouped together, tables appear in the order in which
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11827 ** they were attached to the session object).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11828 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11829 SQLITE_API int sqlite3session_patchset(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11830 sqlite3_session pSession, / Session object */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11831 int pnPatchset, / OUT: Size of buffer at ppPatchset /
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11832 void *ppPatchset / OUT: Buffer containing patchset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11833 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11834
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11835 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11836 ** CAPI3REF: Test if a changeset has recorded any changes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11837 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11838 ** Return non-zero if no changes to attached tables have been recorded by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11839 ** the session object passed as the first argument. Otherwise, if one or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11840 ** more changes have been recorded, return zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11841 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11842 ** Even if this function returns zero, it is possible that calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11843 ** [sqlite3session_changeset()] on the session handle may still return a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11844 ** changeset that contains no changes. This can happen when a row in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11845 ** an attached table is modified and then later on the original values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11846 ** are restored. However, if this function returns non-zero, then it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11847 ** guaranteed that a call to sqlite3session_changeset() will return a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11848 ** changeset containing zero changes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11849 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11850 SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11851
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11852 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11853 ** CAPI3REF: Query for the amount of heap memory used by a session object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11854 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11855 ** This API returns the total amount of heap memory in bytes currently
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11856 ** used by the session object passed as the only argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11857 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11858 SQLITE_API sqlite3_int64 sqlite3session_memory_used(sqlite3_session *pSession);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11859
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11860 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11861 ** CAPI3REF: Create An Iterator To Traverse A Changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11862 ** CONSTRUCTOR: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11863 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11864 ** Create an iterator used to iterate through the contents of a changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11865 ** If successful, *pp is set to point to the iterator handle and SQLITE_OK
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11866 ** is returned. Otherwise, if an error occurs, *pp is set to zero and an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11867 ** SQLite error code is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11868 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11869 ** The following functions can be used to advance and query a changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11870 ** iterator created by this function:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11871 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11872 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11873 ** <li> [sqlite3changeset_next()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11874 ** <li> [sqlite3changeset_op()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11875 ** <li> [sqlite3changeset_new()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11876 ** <li> [sqlite3changeset_old()]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11877 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11878 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11879 ** It is the responsibility of the caller to eventually destroy the iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11880 ** by passing it to [sqlite3changeset_finalize()]. The buffer containing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11881 ** changeset (pChangeset) must remain valid until after the iterator is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11882 ** destroyed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11883 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11884 ** Assuming the changeset blob was created by one of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11885 ** [sqlite3session_changeset()], [sqlite3changeset_concat()] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11886 ** [sqlite3changeset_invert()] functions, all changes within the changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11887 ** that apply to a single table are grouped together. This means that when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11888 ** an application iterates through a changeset using an iterator created by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11889 ** this function, all changes that relate to a single table are visited
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11890 ** consecutively. There is no chance that the iterator will visit a change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11891 ** the applies to table X, then one for table Y, and then later on visit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11892 ** another change for table X.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11893 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11894 ** The behavior of sqlite3changeset_start_v2() and its streaming equivalent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11895 ** may be modified by passing a combination of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11896 ** [SQLITE_CHANGESETSTART_INVERT \| supported flags] as the 4th parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11897 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11898 ** Note that the sqlite3changeset_start_v2() API is still <b>experimental</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11899 ** and therefore subject to change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11900 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11901 SQLITE_API int sqlite3changeset_start(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11902 sqlite3_changeset_iter *pp, / OUT: New changeset iterator handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11903 int nChangeset, /* Size of changeset blob in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11904 void pChangeset / Pointer to blob containing changeset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11905 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11906 SQLITE_API int sqlite3changeset_start_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11907 sqlite3_changeset_iter *pp, / OUT: New changeset iterator handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11908 int nChangeset, /* Size of changeset blob in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11909 void pChangeset, / Pointer to blob containing changeset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11910 int flags /* SESSION_CHANGESETSTART_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11911 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11912
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11913 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11914 ** CAPI3REF: Flags for sqlite3changeset_start_v2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11915 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11916 ** The following flags may passed via the 4th parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11917 ** [sqlite3changeset_start_v2] and [sqlite3changeset_start_v2_strm]:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11918 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11919 ** <dt>SQLITE_CHANGESETSTART_INVERT <dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11920 ** Invert the changeset while iterating through it. This is equivalent to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11921 ** inverting a changeset using sqlite3changeset_invert() before applying it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11922 ** It is an error to specify this flag with a patchset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11923 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11924 #define SQLITE_CHANGESETSTART_INVERT 0x0002
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11925
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11926
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11927 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11928 ** CAPI3REF: Advance A Changeset Iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11929 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11930 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11931 ** This function may only be used with iterators created by the function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11932 ** [sqlite3changeset_start()]. If it is called on an iterator passed to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11933 ** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11934 ** is returned and the call has no effect.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11935 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11936 ** Immediately after an iterator is created by sqlite3changeset_start(), it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11937 ** does not point to any change in the changeset. Assuming the changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11938 ** is not empty, the first call to this function advances the iterator to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11939 ** point to the first change in the changeset. Each subsequent call advances
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11940 ** the iterator to point to the next change in the changeset (if any). If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11941 ** no error occurs and the iterator points to a valid change after a call
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11942 ** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11943 ** Otherwise, if all changes in the changeset have already been visited,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11944 ** SQLITE_DONE is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11945 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11946 ** If an error occurs, an SQLite error code is returned. Possible error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11947 ** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11948 ** SQLITE_NOMEM.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11949 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11950 SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11951
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11952 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11953 ** CAPI3REF: Obtain The Current Operation From A Changeset Iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11954 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11955 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11956 ** The pIter argument passed to this function may either be an iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11957 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11958 ** created by [sqlite3changeset_start()]. In the latter case, the most recent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11959 ** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11960 ** is not the case, this function returns [SQLITE_MISUSE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11961 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11962 ** Arguments pOp, pnCol and pzTab may not be NULL. Upon return, three
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11963 ** outputs are set through these pointers:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11964 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11965 ** *pOp is set to one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11966 ** depending on the type of change that the iterator currently points to;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11967 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11968 ** *pnCol is set to the number of columns in the table affected by the change; and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11969 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11970 ** *pzTab is set to point to a nul-terminated utf-8 encoded string containing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11971 ** the name of the table affected by the current change. The buffer remains
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11972 ** valid until either sqlite3changeset_next() is called on the iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11973 ** or until the conflict-handler function returns.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11974 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11975 ** If pbIndirect is not NULL, then *pbIndirect is set to true (1) if the change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11976 ** is an indirect change, or false (0) otherwise. See the documentation for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11977 ** [sqlite3session_indirect()] for a description of direct and indirect
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11978 ** changes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11979 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11980 ** If no error occurs, SQLITE_OK is returned. If an error does occur, an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11981 ** SQLite error code is returned. The values of the output variables may not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11982 ** be trusted in this case.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11983 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11984 SQLITE_API int sqlite3changeset_op(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11985 sqlite3_changeset_iter pIter, / Iterator object */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11986 const char *pzTab, / OUT: Pointer to table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11987 int pnCol, / OUT: Number of columns in table */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11988 int pOp, / OUT: SQLITE_INSERT, DELETE or UPDATE */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11989 int pbIndirect / OUT: True for an 'indirect' change */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11990 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11991
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11992 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11993 ** CAPI3REF: Obtain The Primary Key Definition Of A Table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11994 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11995 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11996 ** For each modified table, a changeset includes the following:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11997 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11998 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	11999 ** <li> The number of columns in the table, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12000 ** <li> Which of those columns make up the tables PRIMARY KEY.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12001 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12002 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12003 ** This function is used to find which columns comprise the PRIMARY KEY of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12004 ** the table modified by the change that iterator pIter currently points to.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12005 ** If successful, *pabPK is set to point to an array of nCol entries, where
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12006 ** nCol is the number of columns in the table. Elements of *pabPK are set to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12007 ** 0x01 if the corresponding column is part of the tables primary key, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12008 ** 0x00 if it is not.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12009 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12010 ** If argument pnCol is not NULL, then *pnCol is set to the number of columns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12011 ** in the table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12012 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12013 ** If this function is called when the iterator does not point to a valid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12014 ** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12015 ** SQLITE_OK is returned and the output variables populated as described
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12016 ** above.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12017 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12018 SQLITE_API int sqlite3changeset_pk(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12019 sqlite3_changeset_iter pIter, / Iterator object */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12020 unsigned char *pabPK, / OUT: Array of boolean - true for PK cols */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12021 int pnCol / OUT: Number of entries in output array */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12022 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12023
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12024 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12025 ** CAPI3REF: Obtain old.* Values From A Changeset Iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12026 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12027 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12028 ** The pIter argument passed to this function may either be an iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12029 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12030 ** created by [sqlite3changeset_start()]. In the latter case, the most recent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12031 ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12032 ** Furthermore, it may only be called if the type of change that the iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12033 ** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12034 ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12035 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12036 ** Argument iVal must be greater than or equal to 0, and less than the number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12037 ** of columns in the table affected by the current change. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12038 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12039 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12040 ** If successful, this function sets *ppValue to point to a protected
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12041 ** sqlite3_value object containing the iVal'th value from the vector of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12042 ** original row values stored as part of the UPDATE or DELETE change and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12043 ** returns SQLITE_OK. The name of the function comes from the fact that this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12044 ** is similar to the "old.*" columns available to update or delete triggers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12045 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12046 ** If some other error occurs (e.g. an OOM condition), an SQLite error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12047 ** is returned and *ppValue is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12048 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12049 SQLITE_API int sqlite3changeset_old(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12050 sqlite3_changeset_iter pIter, / Changeset iterator */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12051 int iVal, /* Column number */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12052 sqlite3_value *ppValue / OUT: Old value (or NULL pointer) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12053 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12054
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12055 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12056 ** CAPI3REF: Obtain new.* Values From A Changeset Iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12057 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12058 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12059 ** The pIter argument passed to this function may either be an iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12060 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12061 ** created by [sqlite3changeset_start()]. In the latter case, the most recent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12062 ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12063 ** Furthermore, it may only be called if the type of change that the iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12064 ** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12065 ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12066 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12067 ** Argument iVal must be greater than or equal to 0, and less than the number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12068 ** of columns in the table affected by the current change. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12069 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12070 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12071 ** If successful, this function sets *ppValue to point to a protected
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12072 ** sqlite3_value object containing the iVal'th value from the vector of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12073 ** new row values stored as part of the UPDATE or INSERT change and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12074 ** returns SQLITE_OK. If the change is an UPDATE and does not include
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12075 ** a new value for the requested column, *ppValue is set to NULL and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12076 ** SQLITE_OK returned. The name of the function comes from the fact that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12077 ** this is similar to the "new.*" columns available to update or delete
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12078 ** triggers.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12079 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12080 ** If some other error occurs (e.g. an OOM condition), an SQLite error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12081 ** is returned and *ppValue is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12082 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12083 SQLITE_API int sqlite3changeset_new(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12084 sqlite3_changeset_iter pIter, / Changeset iterator */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12085 int iVal, /* Column number */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12086 sqlite3_value *ppValue / OUT: New value (or NULL pointer) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12087 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12088
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12089 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12090 ** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12091 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12092 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12093 ** This function should only be used with iterator objects passed to a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12094 ** conflict-handler callback by [sqlite3changeset_apply()] with either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12095 ** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12096 ** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12097 ** is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12098 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12099 ** Argument iVal must be greater than or equal to 0, and less than the number
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12100 ** of columns in the table affected by the current change. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12101 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12102 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12103 ** If successful, this function sets *ppValue to point to a protected
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12104 ** sqlite3_value object containing the iVal'th value from the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12105 ** "conflicting row" associated with the current conflict-handler callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12106 ** and returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12107 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12108 ** If some other error occurs (e.g. an OOM condition), an SQLite error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12109 ** is returned and *ppValue is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12110 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12111 SQLITE_API int sqlite3changeset_conflict(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12112 sqlite3_changeset_iter pIter, / Changeset iterator */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12113 int iVal, /* Column number */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12114 sqlite3_value *ppValue / OUT: Value from conflicting row */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12115 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12116
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12117 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12118 ** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12119 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12120 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12121 ** This function may only be called with an iterator passed to an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12122 ** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12123 ** it sets the output variable to the total number of known foreign key
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12124 ** violations in the destination database and returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12125 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12126 ** In all other cases this function returns SQLITE_MISUSE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12127 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12128 SQLITE_API int sqlite3changeset_fk_conflicts(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12129 sqlite3_changeset_iter pIter, / Changeset iterator */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12130 int pnOut / OUT: Number of FK violations */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12131 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12132
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12133
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12134 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12135 ** CAPI3REF: Finalize A Changeset Iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12136 ** METHOD: sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12137 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12138 ** This function is used to finalize an iterator allocated with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12139 ** [sqlite3changeset_start()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12140 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12141 ** This function should only be called on iterators created using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12142 ** [sqlite3changeset_start()] function. If an application calls this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12143 ** function with an iterator passed to a conflict-handler by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12144 ** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12145 ** call has no effect.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12146 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12147 ** If an error was encountered within a call to an sqlite3changeset_xxx()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12148 ** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12149 ** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12150 ** to that error is returned by this function. Otherwise, SQLITE_OK is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12151 ** returned. This is to allow the following pattern (pseudo-code):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12152 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12153 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12154 ** sqlite3changeset_start();
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12155 ** while( SQLITE_ROW==sqlite3changeset_next() ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12156 ** // Do something with change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12157 ** }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12158 ** rc = sqlite3changeset_finalize();
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12159 ** if( rc!=SQLITE_OK ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12160 ** // An error has occurred
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12161 ** }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12162 ** </pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12163 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12164 SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12165
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12166 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12167 ** CAPI3REF: Invert A Changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12168 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12169 ** This function is used to "invert" a changeset object. Applying an inverted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12170 ** changeset to a database reverses the effects of applying the uninverted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12171 ** changeset. Specifically:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12172 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12173 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12174 ** <li> Each DELETE change is changed to an INSERT, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12175 ** <li> Each INSERT change is changed to a DELETE, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12176 ** <li> For each UPDATE change, the old.* and new.* values are exchanged.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12177 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12178 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12179 ** This function does not change the order in which changes appear within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12180 ** the changeset. It merely reverses the sense of each individual change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12181 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12182 ** If successful, a pointer to a buffer containing the inverted changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12183 ** is stored in ppOut, the size of the same buffer is stored in pnOut, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12184 ** SQLITE_OK is returned. If an error occurs, both pnOut and ppOut are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12185 ** zeroed and an SQLite error code returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12186 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12187 ** It is the responsibility of the caller to eventually call sqlite3_free()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12188 ** on the *ppOut pointer to free the buffer allocation following a successful
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12189 ** call to this function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12190 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12191 ** WARNING/TODO: This function currently assumes that the input is a valid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12192 ** changeset. If it is not, the results are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12193 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12194 SQLITE_API int sqlite3changeset_invert(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12195 int nIn, const void pIn, / Input changeset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12196 int pnOut, void ppOut / OUT: Inverse of input */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12197 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12198
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12199 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12200 ** CAPI3REF: Concatenate Two Changeset Objects
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12201 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12202 ** This function is used to concatenate two changesets, A and B, into a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12203 ** single changeset. The result is a changeset equivalent to applying
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12204 ** changeset A followed by changeset B.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12205 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12206 ** This function combines the two input changesets using an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12207 ** sqlite3_changegroup object. Calling it produces similar results as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12208 ** following code fragment:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12209 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12210 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12211 ** sqlite3_changegroup *pGrp;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12212 ** rc = sqlite3_changegroup_new(&pGrp);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12213 ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12214 ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12215 ** if( rc==SQLITE_OK ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12216 ** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12217 ** }else{
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12218 ** *ppOut = 0;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12219 ** *pnOut = 0;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12220 ** }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12221 ** </pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12222 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12223 ** Refer to the sqlite3_changegroup documentation below for details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12224 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12225 SQLITE_API int sqlite3changeset_concat(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12226 int nA, /* Number of bytes in buffer pA */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12227 void pA, / Pointer to buffer containing changeset A */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12228 int nB, /* Number of bytes in buffer pB */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12229 void pB, / Pointer to buffer containing changeset B */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12230 int pnOut, / OUT: Number of bytes in output changeset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12231 void *ppOut / OUT: Buffer containing output changeset */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12232 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12233
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12234 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12235 ** CAPI3REF: Changegroup Handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12236 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12237 ** A changegroup is an object used to combine two or more
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12238 ** [changesets] or [patchsets]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12239 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12240 typedef struct sqlite3_changegroup sqlite3_changegroup;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12241
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12242 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12243 ** CAPI3REF: Create A New Changegroup Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12244 ** CONSTRUCTOR: sqlite3_changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12245 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12246 ** An sqlite3_changegroup object is used to combine two or more changesets
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12247 ** (or patchsets) into a single changeset (or patchset). A single changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12248 ** object may combine changesets or patchsets, but not both. The output is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12249 ** always in the same format as the input.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12250 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12251 ** If successful, this function returns SQLITE_OK and populates (*pp) with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12252 ** a pointer to a new sqlite3_changegroup object before returning. The caller
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12253 ** should eventually free the returned object using a call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12254 ** sqlite3changegroup_delete(). If an error occurs, an SQLite error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12255 ** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12256 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12257 ** The usual usage pattern for an sqlite3_changegroup object is as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12258 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12259 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12260 ** <li> It is created using a call to sqlite3changegroup_new().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12261 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12262 ** <li> Zero or more changesets (or patchsets) are added to the object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12263 ** by calling sqlite3changegroup_add().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12264 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12265 ** <li> The result of combining all input changesets together is obtained
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12266 ** by the application via a call to sqlite3changegroup_output().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12267 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12268 ** <li> The object is deleted using a call to sqlite3changegroup_delete().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12269 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12270 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12271 ** Any number of calls to add() and output() may be made between the calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12272 ** new() and delete(), and in any order.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12273 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12274 ** As well as the regular sqlite3changegroup_add() and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12275 ** sqlite3changegroup_output() functions, also available are the streaming
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12276 ** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12277 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12278 SQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12279
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12280 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12281 ** CAPI3REF: Add a Schema to a Changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12282 ** METHOD: sqlite3_changegroup_schema
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12283 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12284 ** This method may be used to optionally enforce the rule that the changesets
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12285 ** added to the changegroup handle must match the schema of database zDb
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12286 ** ("main", "temp", or the name of an attached database). If
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12287 ** sqlite3changegroup_add() is called to add a changeset that is not compatible
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12288 ** with the configured schema, SQLITE_SCHEMA is returned and the changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12289 ** object is left in an undefined state.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12290 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12291 ** A changeset schema is considered compatible with the database schema in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12292 ** the same way as for sqlite3changeset_apply(). Specifically, for each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12293 ** table in the changeset, there exists a database table with:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12294 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12295 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12296 ** <li> The name identified by the changeset, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12297 ** <li> at least as many columns as recorded in the changeset, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12298 ** <li> the primary key columns in the same position as recorded in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12299 ** the changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12300 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12301 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12302 ** The output of the changegroup object always has the same schema as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12303 ** database nominated using this function. In cases where changesets passed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12304 ** to sqlite3changegroup_add() have fewer columns than the corresponding table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12305 ** in the database schema, these are filled in using the default column
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12306 ** values from the database schema. This makes it possible to combined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12307 ** changesets that have different numbers of columns for a single table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12308 ** within a changegroup, provided that they are otherwise compatible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12309 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12310 SQLITE_API int sqlite3changegroup_schema(sqlite3_changegroup, sqlite3, const char *zDb);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12311
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12312 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12313 ** CAPI3REF: Add A Changeset To A Changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12314 ** METHOD: sqlite3_changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12315 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12316 ** Add all changes within the changeset (or patchset) in buffer pData (size
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12317 ** nData bytes) to the changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12318 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12319 ** If the buffer contains a patchset, then all prior calls to this function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12320 ** on the same changegroup object must also have specified patchsets. Or, if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12321 ** the buffer contains a changeset, so must have the earlier calls to this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12322 ** function. Otherwise, SQLITE_ERROR is returned and no changes are added
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12323 ** to the changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12324 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12325 ** Rows within the changeset and changegroup are identified by the values in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12326 ** their PRIMARY KEY columns. A change in the changeset is considered to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12327 ** apply to the same row as a change already present in the changegroup if
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12328 ** the two rows have the same primary key.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12329 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12330 ** Changes to rows that do not already appear in the changegroup are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12331 ** simply copied into it. Or, if both the new changeset and the changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12332 ** contain changes that apply to a single row, the final contents of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12333 ** changegroup depends on the type of each change, as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12334 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12335 ** <table border=1 style="margin-left:8ex;margin-right:8ex">
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12336 ** <tr><th style="white-space:pre">Existing Change </th>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12337 ** <th style="white-space:pre">New Change </th>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12338 ** <th>Output Change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12339 ** <tr><td>INSERT <td>INSERT <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12340 ** The new change is ignored. This case does not occur if the new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12341 ** changeset was recorded immediately after the changesets already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12342 ** added to the changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12343 ** <tr><td>INSERT <td>UPDATE <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12344 ** The INSERT change remains in the changegroup. The values in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12345 ** INSERT change are modified as if the row was inserted by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12346 ** existing change and then updated according to the new change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12347 ** <tr><td>INSERT <td>DELETE <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12348 ** The existing INSERT is removed from the changegroup. The DELETE is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12349 ** not added.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12350 ** <tr><td>UPDATE <td>INSERT <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12351 ** The new change is ignored. This case does not occur if the new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12352 ** changeset was recorded immediately after the changesets already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12353 ** added to the changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12354 ** <tr><td>UPDATE <td>UPDATE <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12355 ** The existing UPDATE remains within the changegroup. It is amended
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12356 ** so that the accompanying values are as if the row was updated once
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12357 ** by the existing change and then again by the new change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12358 ** <tr><td>UPDATE <td>DELETE <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12359 ** The existing UPDATE is replaced by the new DELETE within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12360 ** changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12361 ** <tr><td>DELETE <td>INSERT <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12362 ** If one or more of the column values in the row inserted by the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12363 ** new change differ from those in the row deleted by the existing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12364 ** change, the existing DELETE is replaced by an UPDATE within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12365 ** changegroup. Otherwise, if the inserted row is exactly the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12366 ** as the deleted row, the existing DELETE is simply discarded.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12367 ** <tr><td>DELETE <td>UPDATE <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12368 ** The new change is ignored. This case does not occur if the new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12369 ** changeset was recorded immediately after the changesets already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12370 ** added to the changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12371 ** <tr><td>DELETE <td>DELETE <td>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12372 ** The new change is ignored. This case does not occur if the new
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12373 ** changeset was recorded immediately after the changesets already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12374 ** added to the changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12375 ** </table>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12376 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12377 ** If the new changeset contains changes to a table that is already present
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12378 ** in the changegroup, then the number of columns and the position of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12379 ** primary key columns for the table must be consistent. If this is not the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12380 ** case, this function fails with SQLITE_SCHEMA. Except, if the changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12381 ** object has been configured with a database schema using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12382 ** sqlite3changegroup_schema() API, then it is possible to combine changesets
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12383 ** with different numbers of columns for a single table, provided that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12384 ** they are otherwise compatible.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12385 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12386 ** If the input changeset appears to be corrupt and the corruption is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12387 ** detected, SQLITE_CORRUPT is returned. Or, if an out-of-memory condition
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12388 ** occurs during processing, this function returns SQLITE_NOMEM.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12389 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12390 ** In all cases, if an error occurs the state of the final contents of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12391 ** changegroup is undefined. If no error occurs, SQLITE_OK is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12392 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12393 SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup, int nData, void pData);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12394
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12395 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12396 ** CAPI3REF: Add A Single Change To A Changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12397 ** METHOD: sqlite3_changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12398 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12399 ** This function adds the single change currently indicated by the iterator
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12400 ** passed as the second argument to the changegroup object. The rules for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12401 ** adding the change are just as described for [sqlite3changegroup_add()].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12402 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12403 ** If the change is successfully added to the changegroup, SQLITE_OK is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12404 ** returned. Otherwise, an SQLite error code is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12405 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12406 ** The iterator must point to a valid entry when this function is called.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12407 ** If it does not, SQLITE_ERROR is returned and no change is added to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12408 ** changegroup. Additionally, the iterator must not have been opened with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12409 ** the SQLITE_CHANGESETAPPLY_INVERT flag. In this case SQLITE_ERROR is also
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12410 ** returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12411 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12412 SQLITE_API int sqlite3changegroup_add_change(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12413 sqlite3_changegroup*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12414 sqlite3_changeset_iter*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12415 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12416
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12417
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12418
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12419 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12420 ** CAPI3REF: Obtain A Composite Changeset From A Changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12421 ** METHOD: sqlite3_changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12422 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12423 ** Obtain a buffer containing a changeset (or patchset) representing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12424 ** current contents of the changegroup. If the inputs to the changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12425 ** were themselves changesets, the output is a changeset. Or, if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12426 ** inputs were patchsets, the output is also a patchset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12427 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12428 ** As with the output of the sqlite3session_changeset() and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12429 ** sqlite3session_patchset() functions, all changes related to a single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12430 ** table are grouped together in the output of this function. Tables appear
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12431 ** in the same order as for the very first changeset added to the changegroup.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12432 ** If the second or subsequent changesets added to the changegroup contain
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12433 ** changes for tables that do not appear in the first changeset, they are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12434 ** appended onto the end of the output changeset, again in the order in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12435 ** which they are first encountered.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12436 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12437 ** If an error occurs, an SQLite error code is returned and the output
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12438 ** variables (pnData) and (ppData) are set to 0. Otherwise, SQLITE_OK
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12439 ** is returned and the output variables are set to the size of and a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12440 ** pointer to the output buffer, respectively. In this case it is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12441 ** responsibility of the caller to eventually free the buffer using a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12442 ** call to sqlite3_free().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12443 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12444 SQLITE_API int sqlite3changegroup_output(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12445 sqlite3_changegroup*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12446 int pnData, / OUT: Size of output buffer in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12447 void *ppData / OUT: Pointer to output buffer */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12448 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12449
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12450 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12451 ** CAPI3REF: Delete A Changegroup Object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12452 ** DESTRUCTOR: sqlite3_changegroup
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12453 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12454 SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12455
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12456 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12457 ** CAPI3REF: Apply A Changeset To A Database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12458 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12459 ** Apply a changeset or patchset to a database. These functions attempt to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12460 ** update the "main" database attached to handle db with the changes found in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12461 ** the changeset passed via the second and third arguments.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12462 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12463 ** All changes made by these functions are enclosed in a savepoint transaction.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12464 ** If any other error (aside from a constraint failure when attempting to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12465 ** write to the target database) occurs, then the savepoint transaction is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12466 ** rolled back, restoring the target database to its original state, and an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12467 ** SQLite error code returned. Additionally, starting with version 3.51.0,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12468 ** an error code and error message that may be accessed using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12469 ** [sqlite3_errcode()] and [sqlite3_errmsg()] APIs are left in the database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12470 ** handle.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12471 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12472 ** The fourth argument (xFilter) passed to these functions is the "filter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12473 ** callback". This may be passed NULL, in which case all changes in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12474 ** changeset are applied to the database. For sqlite3changeset_apply() and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12475 ** sqlite3_changeset_apply_v2(), if it is not NULL, then it is invoked once
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12476 ** for each table affected by at least one change in the changeset. In this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12477 ** case the table name is passed as the second argument, and a copy of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12478 ** the context pointer passed as the sixth argument to apply() or apply_v2()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12479 ** as the first. If the "filter callback" returns zero, then no attempt is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12480 ** made to apply any changes to the table. Otherwise, if the return value is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12481 ** non-zero, all changes related to the table are attempted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12482 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12483 ** For sqlite3_changeset_apply_v3(), the xFilter callback is invoked once
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12484 ** per change. The second argument in this case is an sqlite3_changeset_iter
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12485 ** that may be queried using the usual APIs for the details of the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12486 ** change. If the "filter callback" returns zero in this case, then no attempt
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12487 ** is made to apply the current change. If it returns non-zero, the change
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12488 ** is applied.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12489 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12490 ** For each table that is not excluded by the filter callback, this function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12491 ** tests that the target database contains a compatible table. A table is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12492 ** considered compatible if all of the following are true:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12493 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12494 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12495 ** <li> The table has the same name as the name recorded in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12496 ** changeset, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12497 ** <li> The table has at least as many columns as recorded in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12498 ** changeset, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12499 ** <li> The table has primary key columns in the same position as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12500 ** recorded in the changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12501 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12502 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12503 ** If there is no compatible table, it is not an error, but none of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12504 ** changes associated with the table are applied. A warning message is issued
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12505 ** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12506 ** one such warning is issued for each table in the changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12507 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12508 ** For each change for which there is a compatible table, an attempt is made
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12509 ** to modify the table contents according to each UPDATE, INSERT or DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12510 ** change that is not excluded by a filter callback. If a change cannot be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12511 ** applied cleanly, the conflict handler function passed as the fifth argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12512 ** to sqlite3changeset_apply() may be invoked. A description of exactly when
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12513 ** the conflict handler is invoked for each type of change is below.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12514 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12515 ** Unlike the xFilter argument, xConflict may not be passed NULL. The results
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12516 ** of passing anything other than a valid function pointer as the xConflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12517 ** argument are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12518 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12519 ** Each time the conflict handler function is invoked, it must return one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12520 ** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12521 ** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12522 ** if the second argument passed to the conflict handler is either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12523 ** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12524 ** returns an illegal value, any changes already made are rolled back and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12525 ** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12526 ** actions are taken by sqlite3changeset_apply() depending on the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12527 ** returned by each invocation of the conflict-handler function. Refer to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12528 ** the documentation for the three
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12529 ** [SQLITE_CHANGESET_OMIT\|available return values] for details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12530 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12531 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12532 ** <dt>DELETE Changes<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12533 ** For each DELETE change, the function checks if the target database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12534 ** contains a row with the same primary key value (or values) as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12535 ** original row values stored in the changeset. If it does, and the values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12536 ** stored in all non-primary key columns also match the values stored in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12537 ** the changeset the row is deleted from the target database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12538 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12539 ** If a row with matching primary key values is found, but one or more of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12540 ** the non-primary key fields contains a value different from the original
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12541 ** row value stored in the changeset, the conflict-handler function is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12542 ** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12543 ** database table has more columns than are recorded in the changeset,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12544 ** only the values of those non-primary key fields are compared against
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12545 ** the current database contents - any trailing database table columns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12546 ** are ignored.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12547 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12548 ** If no row with matching primary key values is found in the database,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12549 ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12550 ** passed as the second argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12551 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12552 ** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12553 ** (which can only happen if a foreign key constraint is violated), the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12554 ** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12555 ** passed as the second argument. This includes the case where the DELETE
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12556 ** operation is attempted because an earlier call to the conflict handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12557 ** function returned [SQLITE_CHANGESET_REPLACE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12558 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12559 ** <dt>INSERT Changes<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12560 ** For each INSERT change, an attempt is made to insert the new row into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12561 ** the database. If the changeset row contains fewer fields than the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12562 ** database table, the trailing fields are populated with their default
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12563 ** values.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12564 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12565 ** If the attempt to insert the row fails because the database already
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12566 ** contains a row with the same primary key values, the conflict handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12567 ** function is invoked with the second argument set to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12568 ** [SQLITE_CHANGESET_CONFLICT].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12569 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12570 ** If the attempt to insert the row fails because of some other constraint
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12571 ** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12572 ** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12573 ** This includes the case where the INSERT operation is re-attempted because
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12574 ** an earlier call to the conflict handler function returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12575 ** [SQLITE_CHANGESET_REPLACE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12576 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12577 ** <dt>UPDATE Changes<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12578 ** For each UPDATE change, the function checks if the target database
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12579 ** contains a row with the same primary key value (or values) as the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12580 ** original row values stored in the changeset. If it does, and the values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12581 ** stored in all modified non-primary key columns also match the values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12582 ** stored in the changeset the row is updated within the target database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12583 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12584 ** If a row with matching primary key values is found, but one or more of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12585 ** the modified non-primary key fields contains a value different from an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12586 ** original row value stored in the changeset, the conflict-handler function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12587 ** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12588 ** UPDATE changes only contain values for non-primary key fields that are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12589 ** to be modified, only those fields need to match the original values to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12590 ** avoid the SQLITE_CHANGESET_DATA conflict-handler callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12591 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12592 ** If no row with matching primary key values is found in the database,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12593 ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12594 ** passed as the second argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12595 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12596 ** If the UPDATE operation is attempted, but SQLite returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12597 ** SQLITE_CONSTRAINT, the conflict-handler function is invoked with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12598 ** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12599 ** This includes the case where the UPDATE operation is attempted after
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12600 ** an earlier call to the conflict handler function returned
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12601 ** [SQLITE_CHANGESET_REPLACE].
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12602 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12603 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12604 ** It is safe to execute SQL statements, including those that write to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12605 ** table that the callback related to, from within the xConflict callback.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12606 ** This can be used to further customize the application's conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12607 ** resolution strategy.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12608 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12609 ** If the output parameters (ppRebase) and (pnRebase) are non-NULL and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12610 ** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12611 ** may set (*ppRebase) to point to a "rebase" that may be used with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12612 ** sqlite3_rebaser APIs buffer before returning. In this case (*pnRebase)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12613 ** is set to the size of the buffer in bytes. It is the responsibility of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12614 ** caller to eventually free any such buffer using sqlite3_free(). The buffer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12615 ** is only allocated and populated if one or more conflicts were encountered
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12616 ** while applying the patchset. See comments surrounding the sqlite3_rebaser
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12617 ** APIs for further details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12618 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12619 ** The behavior of sqlite3changeset_apply_v2() and its streaming equivalent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12620 ** may be modified by passing a combination of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12621 ** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT \| supported flags] as the 9th parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12622 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12623 ** Note that the sqlite3changeset_apply_v2() API is still <b>experimental</b>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12624 ** and therefore subject to change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12625 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12626 SQLITE_API int sqlite3changeset_apply(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12627 sqlite3 db, / Apply change to "main" db of this handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12628 int nChangeset, /* Size of changeset in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12629 void pChangeset, / Changeset blob */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12630 int(*xFilter)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12631 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12632 const char zTab / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12633 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12634 int(*xConflict)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12635 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12636 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12637 sqlite3_changeset_iter p / Handle describing change and conflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12638 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12639 void pCtx / First argument passed to xConflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12640 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12641 SQLITE_API int sqlite3changeset_apply_v2(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12642 sqlite3 db, / Apply change to "main" db of this handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12643 int nChangeset, /* Size of changeset in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12644 void pChangeset, / Changeset blob */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12645 int(*xFilter)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12646 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12647 const char zTab / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12648 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12649 int(*xConflict)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12650 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12651 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12652 sqlite3_changeset_iter p / Handle describing change and conflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12653 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12654 void pCtx, / First argument passed to xConflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12655 void *ppRebase, int pnRebase, /* OUT: Rebase data */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12656 int flags /* SESSION_CHANGESETAPPLY_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12657 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12658 SQLITE_API int sqlite3changeset_apply_v3(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12659 sqlite3 db, / Apply change to "main" db of this handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12660 int nChangeset, /* Size of changeset in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12661 void pChangeset, / Changeset blob */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12662 int(*xFilter)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12663 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12664 sqlite3_changeset_iter p / Handle describing change */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12665 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12666 int(*xConflict)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12667 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12668 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12669 sqlite3_changeset_iter p / Handle describing change and conflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12670 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12671 void pCtx, / First argument passed to xConflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12672 void *ppRebase, int pnRebase, /* OUT: Rebase data */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12673 int flags /* SESSION_CHANGESETAPPLY_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12674 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12675
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12676 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12677 ** CAPI3REF: Flags for sqlite3changeset_apply_v2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12678 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12679 ** The following flags may passed via the 9th parameter to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12680 ** [sqlite3changeset_apply_v2] and [sqlite3changeset_apply_v2_strm]:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12681 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12682 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12683 ** <dt>SQLITE_CHANGESETAPPLY_NOSAVEPOINT <dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12684 ** Usually, the sessions module encloses all operations performed by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12685 ** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12686 ** SAVEPOINT is committed if the changeset or patchset is successfully
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12687 ** applied, or rolled back if an error occurs. Specifying this flag
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12688 ** causes the sessions module to omit this savepoint. In this case, if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12689 ** caller has an open transaction or savepoint when apply_v2() is called,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12690 ** it may revert the partially applied changeset by rolling it back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12691 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12692 ** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12693 ** Invert the changeset before applying it. This is equivalent to inverting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12694 ** a changeset using sqlite3changeset_invert() before applying it. It is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12695 ** an error to specify this flag with a patchset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12696 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12697 ** <dt>SQLITE_CHANGESETAPPLY_IGNORENOOP <dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12698 ** Do not invoke the conflict handler callback for any changes that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12699 ** would not actually modify the database even if they were applied.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12700 ** Specifically, this means that the conflict handler is not invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12701 ** for:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12702 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12703 ** <li>a delete change if the row being deleted cannot be found,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12704 ** <li>an update change if the modified fields are already set to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12705 ** their new values in the conflicting row, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12706 ** <li>an insert change if all fields of the conflicting row match
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12707 ** the row being inserted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12708 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12709 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12710 ** <dt>SQLITE_CHANGESETAPPLY_FKNOACTION <dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12711 ** If this flag it set, then all foreign key constraints in the target
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12712 ** database behave as if they were declared with "ON UPDATE NO ACTION ON
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12713 ** DELETE NO ACTION", even if they are actually CASCADE, RESTRICT, SET NULL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12714 ** or SET DEFAULT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12715 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12716 #define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12717 #define SQLITE_CHANGESETAPPLY_INVERT 0x0002
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12718 #define SQLITE_CHANGESETAPPLY_IGNORENOOP 0x0004
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12719 #define SQLITE_CHANGESETAPPLY_FKNOACTION 0x0008
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12720
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12721 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12722 ** CAPI3REF: Constants Passed To The Conflict Handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12723 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12724 ** Values that may be passed as the second argument to a conflict-handler.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12725 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12726 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12727 ** <dt>SQLITE_CHANGESET_DATA<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12728 ** The conflict handler is invoked with CHANGESET_DATA as the second argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12729 ** when processing a DELETE or UPDATE change if a row with the required
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12730 ** PRIMARY KEY fields is present in the database, but one or more other
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12731 ** (non primary-key) fields modified by the update do not contain the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12732 ** expected "before" values.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12733 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12734 ** The conflicting row, in this case, is the database row with the matching
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12735 ** primary key.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12736 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12737 ** <dt>SQLITE_CHANGESET_NOTFOUND<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12738 ** The conflict handler is invoked with CHANGESET_NOTFOUND as the second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12739 ** argument when processing a DELETE or UPDATE change if a row with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12740 ** required PRIMARY KEY fields is not present in the database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12741 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12742 ** There is no conflicting row in this case. The results of invoking the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12743 ** sqlite3changeset_conflict() API are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12744 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12745 ** <dt>SQLITE_CHANGESET_CONFLICT<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12746 ** CHANGESET_CONFLICT is passed as the second argument to the conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12747 ** handler while processing an INSERT change if the operation would result
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12748 ** in duplicate primary key values.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12749 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12750 ** The conflicting row in this case is the database row with the matching
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12751 ** primary key.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12752 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12753 ** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12754 ** If foreign key handling is enabled, and applying a changeset leaves the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12755 ** database in a state containing foreign key violations, the conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12756 ** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12757 ** exactly once before the changeset is committed. If the conflict handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12758 ** returns CHANGESET_OMIT, the changes, including those that caused the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12759 ** foreign key constraint violation, are committed. Or, if it returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12760 ** CHANGESET_ABORT, the changeset is rolled back.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12761 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12762 ** No current or conflicting row information is provided. The only function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12763 ** it is possible to call on the supplied sqlite3_changeset_iter handle
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12764 ** is sqlite3changeset_fk_conflicts().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12765 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12766 ** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12767 ** If any other constraint violation occurs while applying a change (i.e.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12768 ** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12769 ** invoked with CHANGESET_CONSTRAINT as the second argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12770 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12771 ** There is no conflicting row in this case. The results of invoking the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12772 ** sqlite3changeset_conflict() API are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12773 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12774 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12775 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12776 #define SQLITE_CHANGESET_DATA 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12777 #define SQLITE_CHANGESET_NOTFOUND 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12778 #define SQLITE_CHANGESET_CONFLICT 3
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12779 #define SQLITE_CHANGESET_CONSTRAINT 4
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12780 #define SQLITE_CHANGESET_FOREIGN_KEY 5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12781
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12782 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12783 ** CAPI3REF: Constants Returned By The Conflict Handler
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12784 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12785 ** A conflict handler callback must return one of the following three values.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12786 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12787 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12788 ** <dt>SQLITE_CHANGESET_OMIT<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12789 ** If a conflict handler returns this value no special action is taken. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12790 ** change that caused the conflict is not applied. The session module
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12791 ** continues to the next change in the changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12792 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12793 ** <dt>SQLITE_CHANGESET_REPLACE<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12794 ** This value may only be returned if the second argument to the conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12795 ** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12796 ** is not the case, any changes applied so far are rolled back and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12797 ** call to sqlite3changeset_apply() returns SQLITE_MISUSE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12798 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12799 ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12800 ** handler, then the conflicting row is either updated or deleted, depending
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12801 ** on the type of change.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12802 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12803 ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12804 ** handler, then the conflicting row is removed from the database and a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12805 ** second attempt to apply the change is made. If this second attempt fails,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12806 ** the original row is restored to the database before continuing.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12807 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12808 ** <dt>SQLITE_CHANGESET_ABORT<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12809 ** If this value is returned, any changes applied so far are rolled back
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12810 ** and the call to sqlite3changeset_apply() returns SQLITE_ABORT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12811 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12812 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12813 #define SQLITE_CHANGESET_OMIT 0
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12814 #define SQLITE_CHANGESET_REPLACE 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12815 #define SQLITE_CHANGESET_ABORT 2
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12816
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12817 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12818 ** CAPI3REF: Rebasing changesets
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12819 ** EXPERIMENTAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12820 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12821 ** Suppose there is a site hosting a database in state S0. And that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12822 ** modifications are made that move that database to state S1 and a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12823 ** changeset recorded (the "local" changeset). Then, a changeset based
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12824 ** on S0 is received from another site (the "remote" changeset) and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12825 ** applied to the database. The database is then in state
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12826 ** (S1+"remote"), where the exact state depends on any conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12827 ** resolution decisions (OMIT or REPLACE) made while applying "remote".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12828 ** Rebasing a changeset is to update it to take those conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12829 ** resolution decisions into account, so that the same conflicts
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12830 ** do not have to be resolved elsewhere in the network.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12831 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12832 ** For example, if both the local and remote changesets contain an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12833 ** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)":
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12834 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12835 ** local: INSERT INTO t1 VALUES(1, 'v1');
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12836 ** remote: INSERT INTO t1 VALUES(1, 'v2');
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12837 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12838 ** and the conflict resolution is REPLACE, then the INSERT change is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12839 ** removed from the local changeset (it was overridden). Or, if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12840 ** conflict resolution was "OMIT", then the local changeset is modified
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12841 ** to instead contain:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12842 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12843 ** UPDATE t1 SET b = 'v2' WHERE a=1;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12844 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12845 ** Changes within the local changeset are rebased as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12846 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12847 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12848 ** <dt>Local INSERT<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12849 ** This may only conflict with a remote INSERT. If the conflict
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12850 ** resolution was OMIT, then add an UPDATE change to the rebased
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12851 ** changeset. Or, if the conflict resolution was REPLACE, add
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12852 ** nothing to the rebased changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12853 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12854 ** <dt>Local DELETE<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12855 ** This may conflict with a remote UPDATE or DELETE. In both cases the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12856 ** only possible resolution is OMIT. If the remote operation was a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12857 ** DELETE, then add no change to the rebased changeset. If the remote
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12858 ** operation was an UPDATE, then the old.* fields of change are updated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12859 ** to reflect the new.* values in the UPDATE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12860 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12861 ** <dt>Local UPDATE<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12862 ** This may conflict with a remote UPDATE or DELETE. If it conflicts
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12863 ** with a DELETE, and the conflict resolution was OMIT, then the update
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12864 ** is changed into an INSERT. Any undefined values in the new.* record
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12865 ** from the update change are filled in using the old.* values from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12866 ** the conflicting DELETE. Or, if the conflict resolution was REPLACE,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12867 ** the UPDATE change is simply omitted from the rebased changeset.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12868 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12869 ** If conflict is with a remote UPDATE and the resolution is OMIT, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12870 ** the old.* values are rebased using the new.* values in the remote
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12871 ** change. Or, if the resolution is REPLACE, then the change is copied
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12872 ** into the rebased changeset with updates to columns also updated by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12873 ** the conflicting remote UPDATE removed. If this means no columns would
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12874 ** be updated, the change is omitted.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12875 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12876 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12877 ** A local change may be rebased against multiple remote changes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12878 ** simultaneously. If a single key is modified by multiple remote
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12879 ** changesets, they are combined as follows before the local changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12880 ** is rebased:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12881 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12882 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12883 ** <li> If there has been one or more REPLACE resolutions on a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12884 ** key, it is rebased according to a REPLACE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12885 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12886 ** <li> If there have been no REPLACE resolutions on a key, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12887 ** the local changeset is rebased according to the most recent
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12888 ** of the OMIT resolutions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12889 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12890 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12891 ** Note that conflict resolutions from multiple remote changesets are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12892 ** combined on a per-field basis, not per-row. This means that in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12893 ** case of multiple remote UPDATE operations, some fields of a single
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12894 ** local change may be rebased for REPLACE while others are rebased for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12895 ** OMIT.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12896 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12897 ** In order to rebase a local changeset, the remote changeset must first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12898 ** be applied to the local database using sqlite3changeset_apply_v2() and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12899 ** the buffer of rebase information captured. Then:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12900 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12901 ** <ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12902 ** <li> An sqlite3_rebaser object is created by calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12903 ** sqlite3rebaser_create().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12904 ** <li> The new object is configured with the rebase buffer obtained from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12905 ** sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12906 ** If the local changeset is to be rebased against multiple remote
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12907 ** changesets, then sqlite3rebaser_configure() should be called
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12908 ** multiple times, in the same order that the multiple
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12909 ** sqlite3changeset_apply_v2() calls were made.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12910 ** <li> Each local changeset is rebased by calling sqlite3rebaser_rebase().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12911 ** <li> The sqlite3_rebaser object is deleted by calling
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12912 ** sqlite3rebaser_delete().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12913 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12914 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12915 typedef struct sqlite3_rebaser sqlite3_rebaser;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12916
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12917 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12918 ** CAPI3REF: Create a changeset rebaser object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12919 ** EXPERIMENTAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12920 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12921 ** Allocate a new changeset rebaser object. If successful, set (*ppNew) to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12922 ** point to the new object and return SQLITE_OK. Otherwise, if an error
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12923 ** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12924 ** to NULL.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12925 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12926 SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12927
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12928 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12929 ** CAPI3REF: Configure a changeset rebaser object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12930 ** EXPERIMENTAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12931 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12932 ** Configure the changeset rebaser object to rebase changesets according
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12933 ** to the conflict resolutions described by buffer pRebase (size nRebase
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12934 ** bytes), which must have been obtained from a previous call to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12935 ** sqlite3changeset_apply_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12936 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12937 SQLITE_API int sqlite3rebaser_configure(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12938 sqlite3_rebaser*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12939 int nRebase, const void *pRebase
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12940 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12941
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12942 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12943 ** CAPI3REF: Rebase a changeset
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12944 ** EXPERIMENTAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12945 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12946 ** Argument pIn must point to a buffer containing a changeset nIn bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12947 ** in size. This function allocates and populates a buffer with a copy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12948 ** of the changeset rebased according to the configuration of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12949 ** rebaser object passed as the first argument. If successful, (*ppOut)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12950 ** is set to point to the new buffer containing the rebased changeset and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12951 ** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12952 ** responsibility of the caller to eventually free the new buffer using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12953 ** sqlite3_free(). Otherwise, if an error occurs, (ppOut) and (pnOut)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12954 ** are set to zero and an SQLite error code returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12955 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12956 SQLITE_API int sqlite3rebaser_rebase(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12957 sqlite3_rebaser*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12958 int nIn, const void *pIn,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12959 int pnOut, void *ppOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12960 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12961
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12962 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12963 ** CAPI3REF: Delete a changeset rebaser object.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12964 ** EXPERIMENTAL
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12965 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12966 ** Delete the changeset rebaser object and all associated resources. There
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12967 ** should be one call to this function for each successful invocation
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12968 ** of sqlite3rebaser_create().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12969 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12970 SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12971
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12972 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12973 ** CAPI3REF: Streaming Versions of API functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12974 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12975 ** The six streaming API xxx_strm() functions serve similar purposes to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12976 ** corresponding non-streaming API functions:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12977 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12978 ** <table border=1 style="margin-left:8ex;margin-right:8ex">
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12979 ** <tr><th>Streaming function<th>Non-streaming equivalent</th>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12980 ** <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12981 ** <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12982 ** <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12983 ** <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12984 ** <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12985 ** <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12986 ** <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset]
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12987 ** </table>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12988 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12989 ** Non-streaming functions that accept changesets (or patchsets) as input
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12990 ** require that the entire changeset be stored in a single buffer in memory.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12991 ** Similarly, those that return a changeset or patchset do so by returning
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12992 ** a pointer to a single large buffer allocated using sqlite3_malloc().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12993 ** Normally this is convenient. However, if an application running in a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12994 ** low-memory environment is required to handle very large changesets, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12995 ** large contiguous memory allocations required can become onerous.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12996 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12997 ** In order to avoid this problem, instead of a single large buffer, input
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12998 ** is passed to a streaming API functions by way of a callback function that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	12999 ** the sessions module invokes to incrementally request input data as it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13000 ** required. In all cases, a pair of API function parameters such as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13001 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13002 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13003 **   int nChangeset,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13004 **   void *pChangeset,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13005 ** </pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13006 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13007 ** Is replaced by:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13008 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13009 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13010 **   int (xInput)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13011 **   void *pIn,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13012 ** </pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13013 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13014 ** Each time the xInput callback is invoked by the sessions module, the first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13015 ** argument passed is a copy of the supplied pIn context pointer. The second
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13016 ** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13017 ** error occurs the xInput method should copy up to (*pnData) bytes of data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13018 ** into the buffer and set (*pnData) to the actual number of bytes copied
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13019 ** before returning SQLITE_OK. If the input is completely exhausted, (*pnData)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13020 ** should be set to zero to indicate this. Or, if an error occurs, an SQLite
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13021 ** error code should be returned. In all cases, if an xInput callback returns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13022 ** an error, all processing is abandoned and the streaming API function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13023 ** returns a copy of the error code to the caller.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13024 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13025 ** In the case of sqlite3changeset_start_strm(), the xInput callback may be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13026 ** invoked by the sessions module at any point during the lifetime of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13027 ** iterator. If such an xInput callback returns an error, the iterator enters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13028 ** an error state, whereby all subsequent calls to iterator functions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13029 ** immediately fail with the same error code as returned by xInput.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13030 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13031 ** Similarly, streaming API functions that return changesets (or patchsets)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13032 ** return them in chunks by way of a callback function instead of via a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13033 ** pointer to a single large buffer. In this case, a pair of parameters such
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13034 ** as:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13035 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13036 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13037 **   int *pnChangeset,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13038   void ppChangeset,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13039 ** </pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13040 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13041 ** Is replaced by:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13042 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13043 ** <pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13044 **   int (xOutput)(void pOut, const void *pData, int nData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13045 **   void *pOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13046 ** </pre>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13047 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13048 ** The xOutput callback is invoked zero or more times to return data to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13049 ** the application. The first parameter passed to each call is a copy of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13050 ** pOut pointer supplied by the application. The second parameter, pData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13051 ** points to a buffer nData bytes in size containing the chunk of output
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13052 ** data being returned. If the xOutput callback successfully processes the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13053 ** supplied data, it should return SQLITE_OK to indicate success. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13054 ** it should return some other SQLite error code. In this case processing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13055 ** is immediately abandoned and the streaming API function returns a copy
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13056 ** of the xOutput error code to the application.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13057 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13058 ** The sessions module never invokes an xOutput callback with the third
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13059 ** parameter set to a value less than or equal to zero. Other than this,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13060 ** no guarantees are made as to the size of the chunks of data returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13061 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13062 SQLITE_API int sqlite3changeset_apply_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13063 sqlite3 db, / Apply change to "main" db of this handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13064 int (xInput)(void pIn, void pData, int pnData), /* Input function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13065 void pIn, / First arg for xInput */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13066 int(*xFilter)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13067 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13068 const char zTab / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13069 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13070 int(*xConflict)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13071 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13072 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13073 sqlite3_changeset_iter p / Handle describing change and conflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13074 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13075 void pCtx / First argument passed to xConflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13076 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13077 SQLITE_API int sqlite3changeset_apply_v2_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13078 sqlite3 db, / Apply change to "main" db of this handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13079 int (xInput)(void pIn, void pData, int pnData), /* Input function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13080 void pIn, / First arg for xInput */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13081 int(*xFilter)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13082 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13083 const char zTab / Table name */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13084 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13085 int(*xConflict)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13086 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13087 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13088 sqlite3_changeset_iter p / Handle describing change and conflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13089 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13090 void pCtx, / First argument passed to xConflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13091 void *ppRebase, int pnRebase,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13092 int flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13093 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13094 SQLITE_API int sqlite3changeset_apply_v3_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13095 sqlite3 db, / Apply change to "main" db of this handle */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13096 int (xInput)(void pIn, void pData, int pnData), /* Input function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13097 void pIn, / First arg for xInput */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13098 int(*xFilter)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13099 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13100 sqlite3_changeset_iter *p
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13101 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13102 int(*xConflict)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13103 void pCtx, / Copy of sixth arg to _apply() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13104 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13105 sqlite3_changeset_iter p / Handle describing change and conflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13106 ),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13107 void pCtx, / First argument passed to xConflict */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13108 void *ppRebase, int pnRebase,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13109 int flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13110 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13111 SQLITE_API int sqlite3changeset_concat_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13112 int (xInputA)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13113 void *pInA,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13114 int (xInputB)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13115 void *pInB,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13116 int (xOutput)(void pOut, const void *pData, int nData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13117 void *pOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13118 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13119 SQLITE_API int sqlite3changeset_invert_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13120 int (xInput)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13121 void *pIn,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13122 int (xOutput)(void pOut, const void *pData, int nData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13123 void *pOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13124 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13125 SQLITE_API int sqlite3changeset_start_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13126 sqlite3_changeset_iter **pp,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13127 int (xInput)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13128 void *pIn
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13129 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13130 SQLITE_API int sqlite3changeset_start_v2_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13131 sqlite3_changeset_iter **pp,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13132 int (xInput)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13133 void *pIn,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13134 int flags
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13135 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13136 SQLITE_API int sqlite3session_changeset_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13137 sqlite3_session *pSession,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13138 int (xOutput)(void pOut, const void *pData, int nData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13139 void *pOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13140 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13141 SQLITE_API int sqlite3session_patchset_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13142 sqlite3_session *pSession,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13143 int (xOutput)(void pOut, const void *pData, int nData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13144 void *pOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13145 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13146 SQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13147 int (xInput)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13148 void *pIn
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13149 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13150 SQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13151 int (xOutput)(void pOut, const void *pData, int nData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13152 void *pOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13153 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13154 SQLITE_API int sqlite3rebaser_rebase_strm(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13155 sqlite3_rebaser *pRebaser,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13156 int (xInput)(void pIn, void pData, int pnData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13157 void *pIn,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13158 int (xOutput)(void pOut, const void *pData, int nData),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13159 void *pOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13160 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13161
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13162 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13163 ** CAPI3REF: Configure global parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13164 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13165 ** The sqlite3session_config() interface is used to make global configuration
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13166 ** changes to the sessions module in order to tune it to the specific needs
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13167 ** of the application.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13168 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13169 ** The sqlite3session_config() interface is not threadsafe. If it is invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13170 ** while any other thread is inside any other sessions method then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13171 ** results are undefined. Furthermore, if it is invoked after any sessions
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13172 ** related objects have been created, the results are also undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13173 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13174 ** The first argument to the sqlite3session_config() function must be one
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13175 ** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13176 ** interpretation of the (void*) value passed as the second parameter and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13177 ** the effect of calling this function depends on the value of the first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13178 ** parameter.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13179 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13180 ** <dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13181 ** <dt>SQLITE_SESSION_CONFIG_STRMSIZE<dd>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13182 ** By default, the sessions module streaming interfaces attempt to input
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13183 ** and output data in approximately 1 KiB chunks. This operand may be used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13184 ** to set and query the value of this configuration setting. The pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13185 ** passed as the second argument must point to a value of type (int).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13186 ** If this value is greater than 0, it is used as the new streaming data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13187 ** chunk size for both input and output. Before returning, the (int) value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13188 ** pointed to by pArg is set to the final value of the streaming interface
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13189 ** chunk size.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13190 ** </dl>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13191 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13192 ** This function returns SQLITE_OK if successful, or an SQLite error code
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13193 ** otherwise.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13194 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13195 SQLITE_API int sqlite3session_config(int op, void *pArg);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13196
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13197 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13198 ** CAPI3REF: Values for sqlite3session_config().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13199 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13200 #define SQLITE_SESSION_CONFIG_STRMSIZE 1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13201
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13202 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13203 ** Make sure we can call this stuff from C++.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13204 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13205 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13206 }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13207 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13208
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13209 #endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13210
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13211 /****** End of sqlite3session.h *******/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13212 /****** Begin file fts5.h *******/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13213 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13214 ** 2014 May 31
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13215 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13216 ** The author disclaims copyright to this source code. In place of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13217 ** a legal notice, here is a blessing:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13218 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13219 ** May you do good and not evil.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13220 ** May you find forgiveness for yourself and forgive others.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13221 ** May you share freely, never taking more than you give.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13222 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13223 ******************************************************************************
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13224 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13225 ** Interfaces to extend FTS5. Using the interfaces defined in this file,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13226 ** FTS5 may be extended with:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13227 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13228 ** * custom tokenizers, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13229 ** * custom auxiliary functions.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13230 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13231
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13232
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13233 #ifndef _FTS5_H
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13234 #define _FTS5_H
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13235
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13236
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13237 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13238 extern "C" {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13239 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13240
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13241 /*************************************************************************
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13242 ** CUSTOM AUXILIARY FUNCTIONS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13243 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13244 ** Virtual table implementations may overload SQL functions by implementing
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13245 ** the sqlite3_module.xFindFunction() method.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13246 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13247
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13248 typedef struct Fts5ExtensionApi Fts5ExtensionApi;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13249 typedef struct Fts5Context Fts5Context;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13250 typedef struct Fts5PhraseIter Fts5PhraseIter;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13251
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13252 typedef void (*fts5_extension_function)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13253 const Fts5ExtensionApi pApi, / API offered by current FTS version */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13254 Fts5Context pFts, / First arg to pass to pApi functions */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13255 sqlite3_context pCtx, / Context for returning result/error */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13256 int nVal, /* Number of values in apVal[] array */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13257 sqlite3_value *apVal / Array of trailing arguments */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13258 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13259
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13260 struct Fts5PhraseIter {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13261 const unsigned char *a;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13262 const unsigned char *b;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13263 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13264
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13265 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13266 ** EXTENSION API FUNCTIONS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13267 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13268 ** xUserData(pFts):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13269 ** Return a copy of the pUserData pointer passed to the xCreateFunction()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13270 ** API when the extension function was registered.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13271 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13272 ** xColumnTotalSize(pFts, iCol, pnToken):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13273 ** If parameter iCol is less than zero, set output variable *pnToken
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13274 ** to the total number of tokens in the FTS5 table. Or, if iCol is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13275 ** non-negative but less than the number of columns in the table, return
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13276 ** the total number of tokens in column iCol, considering all rows in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13277 ** the FTS5 table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13278 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13279 ** If parameter iCol is greater than or equal to the number of columns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13280 ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13281 ** an OOM condition or IO error), an appropriate SQLite error code is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13282 ** returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13283 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13284 ** xColumnCount(pFts):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13285 ** Return the number of columns in the table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13286 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13287 ** xColumnSize(pFts, iCol, pnToken):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13288 ** If parameter iCol is less than zero, set output variable *pnToken
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13289 ** to the total number of tokens in the current row. Or, if iCol is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13290 ** non-negative but less than the number of columns in the table, set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13291 ** *pnToken to the number of tokens in column iCol of the current row.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13292 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13293 ** If parameter iCol is greater than or equal to the number of columns
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13294 ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13295 ** an OOM condition or IO error), an appropriate SQLite error code is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13296 ** returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13297 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13298 ** This function may be quite inefficient if used with an FTS5 table
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13299 ** created with the "columnsize=0" option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13300 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13301 ** xColumnText:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13302 ** If parameter iCol is less than zero, or greater than or equal to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13303 ** number of columns in the table, SQLITE_RANGE is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13304 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13305 ** Otherwise, this function attempts to retrieve the text of column iCol of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13306 ** the current document. If successful, (*pz) is set to point to a buffer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13307 ** containing the text in utf-8 encoding, (*pn) is set to the size in bytes
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13308 ** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13309 ** if an error occurs, an SQLite error code is returned and the final values
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13310 ** of (pz) and (pn) are undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13311 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13312 ** xPhraseCount:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13313 ** Returns the number of phrases in the current query expression.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13314 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13315 ** xPhraseSize:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13316 ** If parameter iCol is less than zero, or greater than or equal to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13317 ** number of phrases in the current query, as returned by xPhraseCount,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13318 ** 0 is returned. Otherwise, this function returns the number of tokens in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13319 ** phrase iPhrase of the query. Phrases are numbered starting from zero.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13320 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13321 ** xInstCount:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13322 ** Set *pnInst to the total number of occurrences of all phrases within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13323 ** the query within the current row. Return SQLITE_OK if successful, or
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13324 ** an error code (i.e. SQLITE_NOMEM) if an error occurs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13325 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13326 ** This API can be quite slow if used with an FTS5 table created with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13327 ** "detail=none" or "detail=column" option. If the FTS5 table is created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13328 ** with either "detail=none" or "detail=column" and "content=" option
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13329 ** (i.e. if it is a contentless table), then this API always returns 0.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13330 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13331 ** xInst:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13332 ** Query for the details of phrase match iIdx within the current row.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13333 ** Phrase matches are numbered starting from zero, so the iIdx argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13334 ** should be greater than or equal to zero and smaller than the value
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13335 ** output by xInstCount(). If iIdx is less than zero or greater than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13336 ** or equal to the value returned by xInstCount(), SQLITE_RANGE is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13337 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13338 ** Otherwise, output parameter piPhrase is set to the phrase number, piCol
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13339 ** to the column in which it occurs and *piOff the token offset of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13340 ** first token of the phrase. SQLITE_OK is returned if successful, or an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13341 ** error code (i.e. SQLITE_NOMEM) if an error occurs.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13342 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13343 ** This API can be quite slow if used with an FTS5 table created with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13344 ** "detail=none" or "detail=column" option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13345 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13346 ** xRowid:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13347 ** Returns the rowid of the current row.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13348 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13349 ** xTokenize:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13350 ** Tokenize text using the tokenizer belonging to the FTS5 table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13351 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13352 ** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13353 ** This API function is used to query the FTS table for phrase iPhrase
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13354 ** of the current query. Specifically, a query equivalent to:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13355 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13356 ** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13357 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13358 ** with $p set to a phrase equivalent to the phrase iPhrase of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13359 ** current query is executed. Any column filter that applies to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13360 ** phrase iPhrase of the current query is included in $p. For each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13361 ** row visited, the callback function passed as the fourth argument
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13362 ** is invoked. The context and API objects passed to the callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13363 ** function may be used to access the properties of each matched row.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13364 ** Invoking Api.xUserData() returns a copy of the pointer passed as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13365 ** the third argument to pUserData.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13366 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13367 ** If parameter iPhrase is less than zero, or greater than or equal to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13368 ** the number of phrases in the query, as returned by xPhraseCount(),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13369 ** this function returns SQLITE_RANGE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13370 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13371 ** If the callback function returns any value other than SQLITE_OK, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13372 ** query is abandoned and the xQueryPhrase function returns immediately.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13373 ** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13374 ** Otherwise, the error code is propagated upwards.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13375 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13376 ** If the query runs to completion without incident, SQLITE_OK is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13377 ** Or, if some error occurs before the query completes or is aborted by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13378 ** the callback, an SQLite error code is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13379 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13380 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13381 ** xSetAuxdata(pFts5, pAux, xDelete)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13382 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13383 ** Save the pointer passed as the second argument as the extension function's
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13384 ** "auxiliary data". The pointer may then be retrieved by the current or any
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13385 ** future invocation of the same fts5 extension function made as part of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13386 ** the same MATCH query using the xGetAuxdata() API.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13387 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13388 ** Each extension function is allocated a single auxiliary data slot for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13389 ** each FTS query (MATCH expression). If the extension function is invoked
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13390 ** more than once for a single FTS query, then all invocations share a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13391 ** single auxiliary data context.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13392 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13393 ** If there is already an auxiliary data pointer when this function is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13394 ** invoked, then it is replaced by the new pointer. If an xDelete callback
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13395 ** was specified along with the original pointer, it is invoked at this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13396 ** point.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13397 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13398 ** The xDelete callback, if one is specified, is also invoked on the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13399 ** auxiliary data pointer after the FTS5 query has finished.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13400 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13401 ** If an error (e.g. an OOM condition) occurs within this function,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13402 ** the auxiliary data is set to NULL and an error code returned. If the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13403 ** xDelete parameter was not NULL, it is invoked on the auxiliary data
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13404 ** pointer before returning.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13405 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13406 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13407 ** xGetAuxdata(pFts5, bClear)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13408 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13409 ** Returns the current auxiliary data pointer for the fts5 extension
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13410 ** function. See the xSetAuxdata() method for details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13411 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13412 ** If the bClear argument is non-zero, then the auxiliary data is cleared
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13413 ** (set to NULL) before this function returns. In this case the xDelete,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13414 ** if any, is not invoked.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13415 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13416 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13417 ** xRowCount(pFts5, pnRow)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13418 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13419 ** This function is used to retrieve the total number of rows in the table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13420 ** In other words, the same value that would be returned by:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13421 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13422 ** SELECT count(*) FROM ftstable;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13423 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13424 ** xPhraseFirst()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13425 ** This function is used, along with type Fts5PhraseIter and the xPhraseNext
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13426 ** method, to iterate through all instances of a single query phrase within
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13427 ** the current row. This is the same information as is accessible via the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13428 ** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13429 ** to use, this API may be faster under some circumstances. To iterate
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13430 ** through instances of phrase iPhrase, use the following code:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13431 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13432 ** Fts5PhraseIter iter;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13433 ** int iCol, iOff;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13434 ** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13435 ** iCol>=0;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13436 ** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13437 ** ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13438 ** // An instance of phrase iPhrase at offset iOff of column iCol
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13439 ** }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13440 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13441 ** The Fts5PhraseIter structure is defined above. Applications should not
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13442 ** modify this structure directly - it should only be used as shown above
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13443 ** with the xPhraseFirst() and xPhraseNext() API methods (and by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13444 ** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13445 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13446 ** This API can be quite slow if used with an FTS5 table created with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13447 ** "detail=none" or "detail=column" option. If the FTS5 table is created
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13448 ** with either "detail=none" or "detail=column" and "content=" option
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13449 ** (i.e. if it is a contentless table), then this API always iterates
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13450 ** through an empty set (all calls to xPhraseFirst() set iCol to -1).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13451 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13452 ** In all cases, matches are visited in (column ASC, offset ASC) order.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13453 ** i.e. all those in column 0, sorted by offset, followed by those in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13454 ** column 1, etc.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13455 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13456 ** xPhraseNext()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13457 ** See xPhraseFirst above.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13458 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13459 ** xPhraseFirstColumn()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13460 ** This function and xPhraseNextColumn() are similar to the xPhraseFirst()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13461 ** and xPhraseNext() APIs described above. The difference is that instead
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13462 ** of iterating through all instances of a phrase in the current row, these
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13463 ** APIs are used to iterate through the set of columns in the current row
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13464 ** that contain one or more instances of a specified phrase. For example:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13465 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13466 ** Fts5PhraseIter iter;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13467 ** int iCol;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13468 ** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13469 ** iCol>=0;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13470 ** pApi->xPhraseNextColumn(pFts, &iter, &iCol)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13471 ** ){
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13472 ** // Column iCol contains at least one instance of phrase iPhrase
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13473 ** }
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13474 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13475 ** This API can be quite slow if used with an FTS5 table created with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13476 ** "detail=none" option. If the FTS5 table is created with either
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13477 ** "detail=none" "content=" option (i.e. if it is a contentless table),
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13478 ** then this API always iterates through an empty set (all calls to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13479 ** xPhraseFirstColumn() set iCol to -1).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13480 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13481 ** The information accessed using this API and its companion
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13482 ** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13483 ** (or xInst/xInstCount). The chief advantage of this API is that it is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13484 ** significantly more efficient than those alternatives when used with
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13485 ** "detail=column" tables.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13486 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13487 ** xPhraseNextColumn()
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13488 ** See xPhraseFirstColumn above.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13489 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13490 ** xQueryToken(pFts5, iPhrase, iToken, ppToken, pnToken)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13491 ** This is used to access token iToken of phrase iPhrase of the current
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13492 ** query. Before returning, output parameter *ppToken is set to point
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13493 ** to a buffer containing the requested token, and *pnToken to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13494 ** size of this buffer in bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13495 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13496 ** If iPhrase or iToken are less than zero, or if iPhrase is greater than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13497 ** or equal to the number of phrases in the query as reported by
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13498 ** xPhraseCount(), or if iToken is equal to or greater than the number of
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13499 ** tokens in the phrase, SQLITE_RANGE is returned and ppToken and pnToken
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13500 are both zeroed.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13501 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13502 ** The output text is not a copy of the query text that specified the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13503 ** token. It is the output of the tokenizer module. For tokendata=1
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13504 ** tables, this includes any embedded 0x00 and trailing data.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13505 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13506 ** xInstToken(pFts5, iIdx, iToken, ppToken, pnToken)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13507 ** This is used to access token iToken of phrase hit iIdx within the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13508 ** current row. If iIdx is less than zero or greater than or equal to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13509 ** value returned by xInstCount(), SQLITE_RANGE is returned. Otherwise,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13510 ** output variable (*ppToken) is set to point to a buffer containing the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13511 ** matching document token, and (*pnToken) to the size of that buffer in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13512 ** bytes.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13513 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13514 ** The output text is not a copy of the document text that was tokenized.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13515 ** It is the output of the tokenizer module. For tokendata=1 tables, this
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13516 ** includes any embedded 0x00 and trailing data.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13517 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13518 ** This API may be slow in some cases if the token identified by parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13519 ** iIdx and iToken matched a prefix token in the query. In most cases, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13520 ** first call to this API for each prefix token in the query is forced
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13521 ** to scan the portion of the full-text index that matches the prefix
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13522 ** token to collect the extra data required by this API. If the prefix
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13523 ** token matches a large number of token instances in the document set,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13524 ** this may be a performance problem.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13525 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13526 ** If the user knows in advance that a query may use this API for a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13527 ** prefix token, FTS5 may be configured to collect all required data as part
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13528 ** of the initial querying of the full-text index, avoiding the second scan
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13529 ** entirely. This also causes prefix queries that do not use this API to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13530 ** run more slowly and use more memory. FTS5 may be configured in this way
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13531 ** either on a per-table basis using the [FTS5 insttoken \| 'insttoken']
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13532 ** option, or on a per-query basis using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13533 ** [fts5_insttoken \| fts5_insttoken()] user function.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13534 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13535 ** This API can be quite slow if used with an FTS5 table created with the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13536 ** "detail=none" or "detail=column" option.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13537 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13538 ** xColumnLocale(pFts5, iIdx, pzLocale, pnLocale)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13539 ** If parameter iCol is less than zero, or greater than or equal to the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13540 ** number of columns in the table, SQLITE_RANGE is returned.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13541 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13542 ** Otherwise, this function attempts to retrieve the locale associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13543 ** with column iCol of the current row. Usually, there is no associated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13544 ** locale, and output parameters (pzLocale) and (pnLocale) are set
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13545 ** to NULL and 0, respectively. However, if the fts5_locale() function
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13546 ** was used to associate a locale with the value when it was inserted
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13547 ** into the fts5 table, then (*pzLocale) is set to point to a nul-terminated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13548 ** buffer containing the name of the locale in utf-8 encoding. (*pnLocale)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13549 ** is set to the size in bytes of the buffer, not including the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13550 ** nul-terminator.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13551 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13552 ** If successful, SQLITE_OK is returned. Or, if an error occurs, an
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13553 ** SQLite error code is returned. The final value of the output parameters
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13554 ** is undefined in this case.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13555 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13556 ** xTokenize_v2:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13557 ** Tokenize text using the tokenizer belonging to the FTS5 table. This
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13558 ** API is the same as the xTokenize() API, except that it allows a tokenizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13559 ** locale to be specified.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13560 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13561 struct Fts5ExtensionApi {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13562 int iVersion; /* Currently always set to 4 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13563
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13564 void (xUserData)(Fts5Context*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13565
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13566 int (xColumnCount)(Fts5Context);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13567 int (xRowCount)(Fts5Context, sqlite3_int64 *pnRow);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13568 int (xColumnTotalSize)(Fts5Context, int iCol, sqlite3_int64 *pnToken);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13569
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13570 int (xTokenize)(Fts5Context,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13571 const char pText, int nText, / Text to tokenize */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13572 void pCtx, / Context passed to xToken() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13573 int (xToken)(void, int, const char, int, int, int) / Callback */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13574 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13575
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13576 int (xPhraseCount)(Fts5Context);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13577 int (xPhraseSize)(Fts5Context, int iPhrase);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13578
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13579 int (xInstCount)(Fts5Context, int *pnInst);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13580 int (xInst)(Fts5Context, int iIdx, int piPhrase, int piCol, int *piOff);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13581
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13582 sqlite3_int64 (xRowid)(Fts5Context);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13583 int (xColumnText)(Fts5Context, int iCol, const char *pz, int pn);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13584 int (xColumnSize)(Fts5Context, int iCol, int *pnToken);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13585
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13586 int (xQueryPhrase)(Fts5Context, int iPhrase, void *pUserData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13587 int()(const Fts5ExtensionApi,Fts5Context,void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13588 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13589 int (xSetAuxdata)(Fts5Context, void pAux, void(xDelete)(void*));
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13590 void (xGetAuxdata)(Fts5Context*, int bClear);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13591
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13592 int (xPhraseFirst)(Fts5Context, int iPhrase, Fts5PhraseIter, int, int*);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13593 void (xPhraseNext)(Fts5Context, Fts5PhraseIter, int piCol, int *piOff);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13594
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13595 int (xPhraseFirstColumn)(Fts5Context, int iPhrase, Fts5PhraseIter, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13596 void (xPhraseNextColumn)(Fts5Context, Fts5PhraseIter, int piCol);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13597
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13598 /* Below this point are iVersion>=3 only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13599 int (xQueryToken)(Fts5Context,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13600 int iPhrase, int iToken,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13601 const char *ppToken, int pnToken
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13602 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13603 int (xInstToken)(Fts5Context, int iIdx, int iToken, const char*, int);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13604
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13605 /* Below this point are iVersion>=4 only */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13606 int (xColumnLocale)(Fts5Context, int iCol, const char *pz, int pn);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13607 int (xTokenize_v2)(Fts5Context,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13608 const char pText, int nText, / Text to tokenize */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13609 const char pLocale, int nLocale, / Locale to pass to tokenizer */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13610 void pCtx, / Context passed to xToken() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13611 int (xToken)(void, int, const char, int, int, int) / Callback */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13612 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13613 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13614
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13615 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13616 ** CUSTOM AUXILIARY FUNCTIONS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13617 *************************************************************************/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13618
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13619 /*************************************************************************
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13620 ** CUSTOM TOKENIZERS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13621 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13622 ** Applications may also register custom tokenizer types. A tokenizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13623 ** is registered by providing fts5 with a populated instance of the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13624 ** following structure. All structure methods must be defined, setting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13625 ** any member of the fts5_tokenizer struct to NULL leads to undefined
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13626 ** behaviour. The structure methods are expected to function as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13627 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13628 ** xCreate:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13629 ** This function is used to allocate and initialize a tokenizer instance.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13630 ** A tokenizer instance is required to actually tokenize text.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13631 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13632 ** The first argument passed to this function is a copy of the (void*)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13633 ** pointer provided by the application when the fts5_tokenizer_v2 object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13634 ** was registered with FTS5 (the third argument to xCreateTokenizer()).
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13635 ** The second and third arguments are an array of nul-terminated strings
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13636 ** containing the tokenizer arguments, if any, specified following the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13637 ** tokenizer name as part of the CREATE VIRTUAL TABLE statement used
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13638 ** to create the FTS5 table.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13639 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13640 ** The final argument is an output variable. If successful, (*ppOut)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13641 ** should be set to point to the new tokenizer handle and SQLITE_OK
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13642 ** returned. If an error occurs, some value other than SQLITE_OK should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13643 ** be returned. In this case, fts5 assumes that the final value of *ppOut
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13644 ** is undefined.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13645 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13646 ** xDelete:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13647 ** This function is invoked to delete a tokenizer handle previously
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13648 ** allocated using xCreate(). Fts5 guarantees that this function will
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13649 ** be invoked exactly once for each successful call to xCreate().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13650 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13651 ** xTokenize:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13652 ** This function is expected to tokenize the nText byte string indicated
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13653 ** by argument pText. pText may or may not be nul-terminated. The first
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13654 ** argument passed to this function is a pointer to an Fts5Tokenizer object
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13655 ** returned by an earlier call to xCreate().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13656 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13657 ** The third argument indicates the reason that FTS5 is requesting
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13658 ** tokenization of the supplied text. This is always one of the following
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13659 ** four values:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13660 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13661 ** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13662 ** or removed from the FTS table. The tokenizer is being invoked to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13663 ** determine the set of tokens to add to (or delete from) the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13664 ** FTS index.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13665 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13666 ** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13667 ** against the FTS index. The tokenizer is being called to tokenize
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13668 ** a bareword or quoted string specified as part of the query.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13669 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13670 ** <li> <b>(FTS5_TOKENIZE_QUERY \| FTS5_TOKENIZE_PREFIX)</b> - Same as
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13671 ** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13672 ** followed by a "*" character, indicating that the last token
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13673 ** returned by the tokenizer will be treated as a token prefix.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13674 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13675 ** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13676 ** satisfy an fts5_api.xTokenize() request made by an auxiliary
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13677 ** function. Or an fts5_api.xColumnSize() request made by the same
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13678 ** on a columnsize=0 database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13679 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13680 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13681 ** The sixth and seventh arguments passed to xTokenize() - pLocale and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13682 ** nLocale - are a pointer to a buffer containing the locale to use for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13683 ** tokenization (e.g. "en_US") and its size in bytes, respectively. The
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13684 ** pLocale buffer is not nul-terminated. pLocale may be passed NULL (in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13685 ** which case nLocale is always 0) to indicate that the tokenizer should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13686 ** use its default locale.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13687 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13688 ** For each token in the input string, the supplied callback xToken() must
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13689 ** be invoked. The first argument to it should be a copy of the pointer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13690 ** passed as the second argument to xTokenize(). The third and fourth
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13691 ** arguments are a pointer to a buffer containing the token text, and the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13692 ** size of the token in bytes. The 4th and 5th arguments are the byte offsets
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13693 ** of the first byte of and first byte immediately following the text from
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13694 ** which the token is derived within the input.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13695 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13696 ** The second argument passed to the xToken() callback ("tflags") should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13697 ** normally be set to 0. The exception is if the tokenizer supports
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13698 ** synonyms. In this case see the discussion below for details.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13699 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13700 ** FTS5 assumes the xToken() callback is invoked for each token in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13701 ** order that they occur within the input text.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13702 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13703 ** If an xToken() callback returns any value other than SQLITE_OK, then
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13704 ** the tokenization should be abandoned and the xTokenize() method should
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13705 ** immediately return a copy of the xToken() return value. Or, if the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13706 ** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13707 ** if an error occurs with the xTokenize() implementation itself, it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13708 ** may abandon the tokenization and return any error code other than
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13709 ** SQLITE_OK or SQLITE_DONE.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13710 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13711 ** If the tokenizer is registered using an fts5_tokenizer_v2 object,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13712 ** then the xTokenize() method has two additional arguments - pLocale
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13713 ** and nLocale. These specify the locale that the tokenizer should use
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13714 ** for the current request. If pLocale and nLocale are both 0, then the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13715 ** tokenizer should use its default locale. Otherwise, pLocale points to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13716 ** an nLocale byte buffer containing the name of the locale to use as utf-8
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13717 ** text. pLocale is not nul-terminated.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13718 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13719 ** FTS5_TOKENIZER
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13720 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13721 ** There is also an fts5_tokenizer object. This is an older, deprecated,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13722 ** version of fts5_tokenizer_v2. It is similar except that:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13723 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13724 ** <ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13725 ** <li> There is no "iVersion" field, and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13726 ** <li> The xTokenize() method does not take a locale argument.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13727 ** </ul>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13728 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13729 ** Legacy fts5_tokenizer tokenizers must be registered using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13730 ** legacy xCreateTokenizer() function, instead of xCreateTokenizer_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13731 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13732 ** Tokenizer implementations registered using either API may be retrieved
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13733 ** using both xFindTokenizer() and xFindTokenizer_v2().
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13734 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13735 ** SYNONYM SUPPORT
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13736 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13737 ** Custom tokenizers may also support synonyms. Consider a case in which a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13738 ** user wishes to query for a phrase such as "first place". Using the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13739 ** built-in tokenizers, the FTS5 query 'first + place' will match instances
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13740 ** of "first place" within the document set, but not alternative forms
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13741 ** such as "1st place". In some applications, it would be better to match
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13742 ** all instances of "first place" or "1st place" regardless of which form
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13743 ** the user specified in the MATCH query text.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13744 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13745 ** There are several ways to approach this in FTS5:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13746 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13747 ** <ol><li> By mapping all synonyms to a single token. In this case, using
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13748 ** the above example, this means that the tokenizer returns the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13749 ** same token for inputs "first" and "1st". Say that token is in
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13750 ** fact "first", so that when the user inserts the document "I won
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13751 ** 1st place" entries are added to the index for tokens "i", "won",
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13752 ** "first" and "place". If the user then queries for '1st + place',
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13753 ** the tokenizer substitutes "first" for "1st" and the query works
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13754 ** as expected.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13755 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13756 ** <li> By querying the index for all synonyms of each query term
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13757 ** separately. In this case, when tokenizing query text, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13758 ** tokenizer may provide multiple synonyms for a single term
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13759 ** within the document. FTS5 then queries the index for each
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13760 ** synonym individually. For example, faced with the query:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13761 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13762 ** <codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13763 ** ... MATCH 'first place'</codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13764 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13765 ** the tokenizer offers both "1st" and "first" as synonyms for the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13766 ** first token in the MATCH query and FTS5 effectively runs a query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13767 ** similar to:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13768 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13769 ** <codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13770 ** ... MATCH '(first OR 1st) place'</codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13771 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13772 ** except that, for the purposes of auxiliary functions, the query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13773 ** still appears to contain just two phrases - "(first OR 1st)"
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13774 ** being treated as a single phrase.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13775 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13776 ** <li> By adding multiple synonyms for a single term to the FTS index.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13777 ** Using this method, when tokenizing document text, the tokenizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13778 ** provides multiple synonyms for each token. So that when a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13779 ** document such as "I won first place" is tokenized, entries are
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13780 ** added to the FTS index for "i", "won", "first", "1st" and
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13781 ** "place".
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13782 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13783 ** This way, even if the tokenizer does not provide synonyms
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13784 ** when tokenizing query text (it should not - to do so would be
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13785 ** inefficient), it doesn't matter if the user queries for
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13786 ** 'first + place' or '1st + place', as there are entries in the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13787 ** FTS index corresponding to both forms of the first token.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13788 ** </ol>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13789 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13790 ** Whether it is parsing document or query text, any call to xToken that
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13791 ** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13792 ** is considered to supply a synonym for the previous token. For example,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13793 ** when parsing the document "I won first place", a tokenizer that supports
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13794 ** synonyms would call xToken() 5 times, as follows:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13795 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13796 ** <codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13797 ** xToken(pCtx, 0, "i", 1, 0, 1);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13798 ** xToken(pCtx, 0, "won", 3, 2, 5);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13799 ** xToken(pCtx, 0, "first", 5, 6, 11);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13800 ** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13801 ** xToken(pCtx, 0, "place", 5, 12, 17);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13802 **</codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13803 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13804 ** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13805 ** xToken() is called. Multiple synonyms may be specified for a single token
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13806 ** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13807 ** There is no limit to the number of synonyms that may be provided for a
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13808 ** single token.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13809 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13810 ** In many cases, method (1) above is the best approach. It does not add
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13811 ** extra data to the FTS index or require FTS5 to query for multiple terms,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13812 ** so it is efficient in terms of disk space and query speed. However, it
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13813 ** does not support prefix queries very well. If, as suggested above, the
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13814 ** token "first" is substituted for "1st" by the tokenizer, then the query:
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13815 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13816 ** <codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13817 ** ... MATCH '1s*'</codeblock>
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13818 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13819 ** will not match documents that contain the token "1st" (as the tokenizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13820 ** will probably not map "1s" to any prefix of "first").
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13821 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13822 ** For full prefix support, method (3) may be preferred. In this case,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13823 ** because the index contains entries for both "first" and "1st", prefix
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13824 ** queries such as 'fi' or '1s' will match correctly. However, because
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13825 ** extra entries are added to the FTS index, this method uses more space
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13826 ** within the database.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13827 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13828 ** Method (2) offers a midpoint between (1) and (3). Using this method,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13829 ** a query such as '1s*' will match documents that contain the literal
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13830 ** token "1st", but not "first" (assuming the tokenizer is not able to
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13831 ** provide synonyms for prefixes). However, a non-prefix query like '1st'
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13832 ** will match against "1st" and "first". This method does not require
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13833 ** extra disk space, as no extra entries are added to the FTS index.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13834 ** On the other hand, it may require more CPU cycles to run MATCH queries,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13835 ** as separate queries of the FTS index are required for each synonym.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13836 **
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13837 ** When using methods (2) or (3), it is important that the tokenizer only
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13838 ** provide synonyms when tokenizing document text (method (3)) or query
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13839 ** text (method (2)), not both. Doing so will not cause any errors, but is
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13840 ** inefficient.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13841 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13842 typedef struct Fts5Tokenizer Fts5Tokenizer;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13843 typedef struct fts5_tokenizer_v2 fts5_tokenizer_v2;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13844 struct fts5_tokenizer_v2 {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13845 int iVersion; /* Currently always 2 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13846
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13847 int (xCreate)(void, const char azArg, int nArg, Fts5Tokenizer ppOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13848 void (xDelete)(Fts5Tokenizer);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13849 int (xTokenize)(Fts5Tokenizer,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13850 void *pCtx,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13851 int flags, /* Mask of FTS5_TOKENIZE_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13852 const char *pText, int nText,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13853 const char *pLocale, int nLocale,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13854 int (*xToken)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13855 void pCtx, / Copy of 2nd argument to xTokenize() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13856 int tflags, /* Mask of FTS5_TOKEN_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13857 const char pToken, / Pointer to buffer containing token */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13858 int nToken, /* Size of token in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13859 int iStart, /* Byte offset of token within input text */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13860 int iEnd /* Byte offset of end of token within input text */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13861 )
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13862 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13863 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13864
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13865 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13866 ** New code should use the fts5_tokenizer_v2 type to define tokenizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13867 ** implementations. The following type is included for legacy applications
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13868 ** that still use it.
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13869 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13870 typedef struct fts5_tokenizer fts5_tokenizer;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13871 struct fts5_tokenizer {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13872 int (xCreate)(void, const char azArg, int nArg, Fts5Tokenizer ppOut);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13873 void (xDelete)(Fts5Tokenizer);
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13874 int (xTokenize)(Fts5Tokenizer,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13875 void *pCtx,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13876 int flags, /* Mask of FTS5_TOKENIZE_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13877 const char *pText, int nText,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13878 int (*xToken)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13879 void pCtx, / Copy of 2nd argument to xTokenize() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13880 int tflags, /* Mask of FTS5_TOKEN_* flags */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13881 const char pToken, / Pointer to buffer containing token */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13882 int nToken, /* Size of token in bytes */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13883 int iStart, /* Byte offset of token within input text */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13884 int iEnd /* Byte offset of end of token within input text */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13885 )
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13886 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13887 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13888
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13889
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13890 /* Flags that may be passed as the third argument to xTokenize() */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13891 #define FTS5_TOKENIZE_QUERY 0x0001
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13892 #define FTS5_TOKENIZE_PREFIX 0x0002
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13893 #define FTS5_TOKENIZE_DOCUMENT 0x0004
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13894 #define FTS5_TOKENIZE_AUX 0x0008
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13895
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13896 /* Flags that may be passed by the tokenizer implementation back to FTS5
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13897 ** as the third argument to the supplied xToken callback. */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13898 #define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13899
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13900 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13901 ** END OF CUSTOM TOKENIZERS
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13902 *************************************************************************/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13903
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13904 /*************************************************************************
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13905 ** FTS5 EXTENSION REGISTRATION API
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13906 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13907 typedef struct fts5_api fts5_api;
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13908 struct fts5_api {
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13909 int iVersion; /* Currently always set to 3 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13910
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13911 /* Create a new tokenizer */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13912 int (*xCreateTokenizer)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13913 fts5_api *pApi,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13914 const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13915 void *pUserData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13916 fts5_tokenizer *pTokenizer,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13917 void (xDestroy)(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13918 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13919
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13920 /* Find an existing tokenizer */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13921 int (*xFindTokenizer)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13922 fts5_api *pApi,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13923 const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13924 void **ppUserData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13925 fts5_tokenizer *pTokenizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13926 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13927
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13928 /* Create a new auxiliary function */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13929 int (*xCreateFunction)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13930 fts5_api *pApi,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13931 const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13932 void *pUserData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13933 fts5_extension_function xFunction,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13934 void (xDestroy)(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13935 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13936
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13937 /* APIs below this point are only available if iVersion>=3 */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13938
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13939 /* Create a new tokenizer */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13940 int (*xCreateTokenizer_v2)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13941 fts5_api *pApi,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13942 const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13943 void *pUserData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13944 fts5_tokenizer_v2 *pTokenizer,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13945 void (xDestroy)(void)
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13946 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13947
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13948 /* Find an existing tokenizer */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13949 int (*xFindTokenizer_v2)(
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13950 fts5_api *pApi,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13951 const char *zName,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13952 void **ppUserData,
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13953 fts5_tokenizer_v2 **ppTokenizer
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13954 );
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13955 };
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13956
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13957 /*
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13958 ** END OF REGISTRATION API
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13959 *************************************************************************/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13960
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13961 #ifdef __cplusplus
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13962 } /* end of the 'extern "C"' block */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13963 #endif
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13964
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13965 #endif /* _FTS5_H */
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13966
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13967 /****** End of fts5.h *******/
589bab390fb4 [ThirdParty] Added sqlite3 to the third_party. MrJuneJune <me@mrjunejune.com> parents: diff changeset	13968 #endif /* SQLITE3_H */

Mercurial

annotate third_party/sqlite3/sqlite3.h @ 200:90dfcef375fb