trustbridge/nss-cmake-static: sqlite/sqlite3.h annotate

annotate sqlite/sqlite3.h @ 0:1e5118fa0cb1

This is NSS with a Cmake Buildsyste To compile a static NSS library for Windows we've used the Chromium-NSS fork and added a Cmake buildsystem to compile it statically for Windows. See README.chromium for chromium changes and README.trustbridge for our modifications.

author	Andre Heinecke <andre.heinecke@intevation.de>
date	Mon, 28 Jul 2014 10:47:06 +0200
parents
children

rev	line source
0 1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2 ** 2001 September 15
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4 ** The author disclaims copyright to this source code. In place of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5 ** a legal notice, here is a blessing:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7 ** May you do good and not evil.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	8 ** May you find forgiveness for yourself and forgive others.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	9 ** May you share freely, never taking more than you give.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	10 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	11 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	12 ** This header file defines the interface that the SQLite library
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	13 ** presents to client programs. If a C-function, structure, datatype,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	14 ** or constant definition does not appear in this file, then it is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	15 ** not a published API of SQLite, is subject to change without
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	16 ** notice, and should not be referenced by programs that use SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	17 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	18 ** Some of the definitions that are in this file are marked as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	19 ** "experimental". Experimental interfaces are normally new
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	20 ** features recently added to SQLite. We do not anticipate changes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	21 ** to experimental interfaces but reserve the right to make minor changes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	22 ** if experience from use "in the wild" suggest such changes are prudent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	23 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	24 ** The official C-language API documentation for SQLite is derived
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	25 ** from comments in this file. This file is the authoritative source
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	26 ** on how SQLite interfaces are suppose to operate.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	27 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	28 ** The name of this file under configuration management is "sqlite.h.in".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	29 ** The makefile makes some minor changes to this file (such as inserting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	30 ** the version number) and changes its name to "sqlite3.h" as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	31 ** part of the build process.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	32 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	33 #ifndef _SQLITE3_H_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	34 #define _SQLITE3_H_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	35 #include <stdarg.h> /* Needed for the definition of va_list */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	36
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	37 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	38 ** Make sure we can call this stuff from C++.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	39 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	40 #ifdef __cplusplus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	41 extern "C" {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	42 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	43
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	44
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	45 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	46 ** Add the ability to override 'extern'
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	47 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	48 #ifndef SQLITE_EXTERN
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	49 # define SQLITE_EXTERN extern
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	50 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	51
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	52 #ifndef SQLITE_API
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	53 # define SQLITE_API
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	54 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	55
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	56
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	57 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	58 ** These no-op macros are used in front of interfaces to mark those
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	59 ** interfaces as either deprecated or experimental. New applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	60 ** should not use deprecated interfaces - they are support for backwards
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	61 ** compatibility only. Application writers should be aware that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	62 ** experimental interfaces are subject to change in point releases.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	63 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	64 ** These macros used to resolve to various kinds of compiler magic that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	65 ** would generate warning messages when they were used. But that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	66 ** compiler magic ended up generating such a flurry of bug reports
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	67 ** that we have taken it all out and gone back to using simple
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	68 ** noop macros.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	69 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	70 #define SQLITE_DEPRECATED
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	71 #define SQLITE_EXPERIMENTAL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	72
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	73 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	74 ** Ensure these symbols were not defined by some previous header file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	75 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	76 #ifdef SQLITE_VERSION
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	77 # undef SQLITE_VERSION
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	78 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	79 #ifdef SQLITE_VERSION_NUMBER
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	80 # undef SQLITE_VERSION_NUMBER
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	81 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	82
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	83 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	84 ** CAPI3REF: Compile-Time Library Version Numbers
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	85 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	86 ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	87 ** evaluates to a string literal that is the SQLite version in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	88 ** format "X.Y.Z" where X is the major version number (always 3 for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	89 ** SQLite3) and Y is the minor version number and Z is the release number.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	90 ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	91 ** with the value (X1000000 + Y1000 + Z) where X, Y, and Z are the same
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	92 ** numbers used in [SQLITE_VERSION].)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	93 ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	94 ** be larger than the release from which it is derived. Either Y will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	95 ** be held constant and Z will be incremented or else Y will be incremented
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	96 ** and Z will be reset to zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	97 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	98 ** Since version 3.6.18, SQLite source code has been stored in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	99 ** <a href="http://www.fossil-scm.org/">Fossil configuration management
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	100 ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	101 ** a string which identifies a particular check-in of SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	102 ** within its configuration management system. ^The SQLITE_SOURCE_ID
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	103 ** string contains the date and time of the check-in (UTC) and an SHA1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	104 ** hash of the entire source tree.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	105 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	106 ** See also: [sqlite3_libversion()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	107 ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	108 ** [sqlite_version()] and [sqlite_source_id()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	109 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	110 #define SQLITE_VERSION "3.8.5"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	111 #define SQLITE_VERSION_NUMBER 3008005
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	112 #define SQLITE_SOURCE_ID "2014-06-04 14:06:34 b1ed4f2a34ba66c29b130f8d13e9092758019212"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	113
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	114 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	115 ** CAPI3REF: Run-Time Library Version Numbers
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	116 ** KEYWORDS: sqlite3_version, sqlite3_sourceid
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	117 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	118 ** These interfaces provide the same information as the [SQLITE_VERSION],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	119 ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	120 ** but are associated with the library instead of the header file. ^(Cautious
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	121 ** programmers might include assert() statements in their application to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	122 ** verify that values returned by these interfaces match the macros in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	123 ** the header, and thus insure that the application is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	124 ** compiled with matching library and header files.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	125 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	126 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	127 ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	128 ** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	129 ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	130 ** </pre></blockquote>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	131 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	132 ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	133 ** macro. ^The sqlite3_libversion() function returns a pointer to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	134 ** to the sqlite3_version[] string constant. The sqlite3_libversion()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	135 ** function is provided for use in DLLs since DLL users usually do not have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	136 ** direct access to string constants within the DLL. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	137 ** sqlite3_libversion_number() function returns an integer equal to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	138 ** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	139 ** a pointer to a string constant whose value is the same as the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	140 ** [SQLITE_SOURCE_ID] C preprocessor macro.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	141 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	142 ** See also: [sqlite_version()] and [sqlite_source_id()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	143 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	144 SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	145 SQLITE_API const char *sqlite3_libversion(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	146 SQLITE_API const char *sqlite3_sourceid(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	147 SQLITE_API int sqlite3_libversion_number(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	148
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	149 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	150 ** CAPI3REF: Run-Time Library Compilation Options Diagnostics
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	151 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	152 ** ^The sqlite3_compileoption_used() function returns 0 or 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	153 ** indicating whether the specified option was defined at
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	154 ** compile time. ^The SQLITE_ prefix may be omitted from the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	155 ** option name passed to sqlite3_compileoption_used().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	156 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	157 ** ^The sqlite3_compileoption_get() function allows iterating
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	158 ** over the list of options that were defined at compile time by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	159 ** returning the N-th compile time option string. ^If N is out of range,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	160 ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	161 ** prefix is omitted from any strings returned by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	162 ** sqlite3_compileoption_get().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	163 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	164 ** ^Support for the diagnostic functions sqlite3_compileoption_used()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	165 ** and sqlite3_compileoption_get() may be omitted by specifying the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	166 ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	167 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	168 ** See also: SQL functions [sqlite_compileoption_used()] and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	169 ** [sqlite_compileoption_get()] and the [compile_options pragma].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	170 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	171 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	172 SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	173 SQLITE_API const char *sqlite3_compileoption_get(int N);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	174 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	175
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	176 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	177 ** CAPI3REF: Test To See If The Library Is Threadsafe
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	178 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	179 ** ^The sqlite3_threadsafe() function returns zero if and only if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	180 ** SQLite was compiled with mutexing code omitted due to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	181 ** [SQLITE_THREADSAFE] compile-time option being set to 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	182 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	183 ** SQLite can be compiled with or without mutexes. When
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	184 ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	185 ** are enabled and SQLite is threadsafe. When the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	186 ** [SQLITE_THREADSAFE] macro is 0,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	187 ** the mutexes are omitted. Without the mutexes, it is not safe
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	188 ** to use SQLite concurrently from more than one thread.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	189 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	190 ** Enabling mutexes incurs a measurable performance penalty.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	191 ** So if speed is of utmost importance, it makes sense to disable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	192 ** the mutexes. But for maximum safety, mutexes should be enabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	193 ** ^The default behavior is for mutexes to be enabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	194 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	195 ** This interface can be used by an application to make sure that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	196 ** version of SQLite that it is linking against was compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	197 ** the desired setting of the [SQLITE_THREADSAFE] macro.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	198 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	199 ** This interface only reports on the compile-time mutex setting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	200 ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	201 ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	202 ** can be fully or partially disabled using a call to [sqlite3_config()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	203 ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	204 ** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	205 ** sqlite3_threadsafe() function shows only the compile-time setting of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	206 ** thread safety, not any run-time changes to that setting made by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	207 ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	208 ** is unchanged by calls to sqlite3_config().)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	209 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	210 ** See the [threading mode] documentation for additional information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	211 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	212 SQLITE_API int sqlite3_threadsafe(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	213
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	214 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	215 ** CAPI3REF: Database Connection Handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	216 ** KEYWORDS: {database connection} {database connections}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	217 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	218 ** Each open SQLite database is represented by a pointer to an instance of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	219 ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	220 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	221 ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	222 ** and [sqlite3_close_v2()] are its destructors. There are many other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	223 ** interfaces (such as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	224 ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	225 ** [sqlite3_busy_timeout()] to name but three) that are methods on an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	226 ** sqlite3 object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	227 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	228 typedef struct sqlite3 sqlite3;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	229
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	230 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	231 ** CAPI3REF: 64-Bit Integer Types
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	232 ** KEYWORDS: sqlite_int64 sqlite_uint64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	233 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	234 ** Because there is no cross-platform way to specify 64-bit integer types
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	235 ** SQLite includes typedefs for 64-bit signed and unsigned integers.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	236 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	237 ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	238 ** The sqlite_int64 and sqlite_uint64 types are supported for backwards
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	239 ** compatibility only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	240 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	241 ** ^The sqlite3_int64 and sqlite_int64 types can store integer values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	242 ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	243 ** sqlite3_uint64 and sqlite_uint64 types can store integer values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	244 ** between 0 and +18446744073709551615 inclusive.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	245 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	246 #ifdef SQLITE_INT64_TYPE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	247 typedef SQLITE_INT64_TYPE sqlite_int64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	248 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	249 #elif defined(_MSC_VER) \|\| defined(__BORLANDC__)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	250 typedef __int64 sqlite_int64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	251 typedef unsigned __int64 sqlite_uint64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	252 #else
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	253 typedef long long int sqlite_int64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	254 typedef unsigned long long int sqlite_uint64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	255 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	256 typedef sqlite_int64 sqlite3_int64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	257 typedef sqlite_uint64 sqlite3_uint64;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	258
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	259 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	260 ** If compiling for a processor that lacks floating point support,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	261 ** substitute integer for floating-point.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	262 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	263 #ifdef SQLITE_OMIT_FLOATING_POINT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	264 # define double sqlite3_int64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	265 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	266
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	267 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	268 ** CAPI3REF: Closing A Database Connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	269 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	270 ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	271 ** for the [sqlite3] object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	272 ** ^Calls to sqlite3_close() and sqlite3_close_v2() return SQLITE_OK if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	273 ** the [sqlite3] object is successfully destroyed and all associated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	274 ** resources are deallocated.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	275 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	276 ** ^If the database connection is associated with unfinalized prepared
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	277 ** statements or unfinished sqlite3_backup objects then sqlite3_close()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	278 ** will leave the database connection open and return [SQLITE_BUSY].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	279 ** ^If sqlite3_close_v2() is called with unfinalized prepared statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	280 ** and unfinished sqlite3_backups, then the database connection becomes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	281 ** an unusable "zombie" which will automatically be deallocated when the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	282 ** last prepared statement is finalized or the last sqlite3_backup is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	283 ** finished. The sqlite3_close_v2() interface is intended for use with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	284 ** host languages that are garbage collected, and where the order in which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	285 ** destructors are called is arbitrary.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	286 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	287 ** Applications should [sqlite3_finalize \| finalize] all [prepared statements],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	288 ** [sqlite3_blob_close \| close] all [BLOB handles], and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	289 ** [sqlite3_backup_finish \| finish] all [sqlite3_backup] objects associated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	290 ** with the [sqlite3] object prior to attempting to close the object. ^If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	291 ** sqlite3_close_v2() is called on a [database connection] that still has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	292 ** outstanding [prepared statements], [BLOB handles], and/or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	293 ** [sqlite3_backup] objects then it returns SQLITE_OK but the deallocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	294 ** of resources is deferred until all [prepared statements], [BLOB handles],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	295 ** and [sqlite3_backup] objects are also destroyed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	296 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	297 ** ^If an [sqlite3] object is destroyed while a transaction is open,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	298 ** the transaction is automatically rolled back.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	299 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	300 ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	301 ** must be either a NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	302 ** pointer or an [sqlite3] object pointer obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	303 ** from [sqlite3_open()], [sqlite3_open16()], or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	304 ** [sqlite3_open_v2()], and not previously closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	305 ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	306 ** argument is a harmless no-op.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	307 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	308 SQLITE_API int sqlite3_close(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	309 SQLITE_API int sqlite3_close_v2(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	310
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	311 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	312 ** The type for a callback function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	313 ** This is legacy and deprecated. It is included for historical
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	314 ** compatibility and is not documented.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	315 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	316 typedef int (sqlite3_callback)(void,int,char, char);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	317
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	318 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	319 ** CAPI3REF: One-Step Query Execution Interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	320 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	321 ** The sqlite3_exec() interface is a convenience wrapper around
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	322 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	323 ** that allows an application to run multiple statements of SQL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	324 ** without having to use a lot of C code.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	325 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	326 ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	327 ** semicolon-separate SQL statements passed into its 2nd argument,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	328 ** in the context of the [database connection] passed in as its 1st
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	329 ** argument. ^If the callback function of the 3rd argument to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	330 ** sqlite3_exec() is not NULL, then it is invoked for each result row
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	331 ** coming out of the evaluated SQL statements. ^The 4th argument to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	332 ** sqlite3_exec() is relayed through to the 1st argument of each
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	333 ** callback invocation. ^If the callback pointer to sqlite3_exec()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	334 ** is NULL, then no callback is ever invoked and result rows are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	335 ** ignored.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	336 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	337 ** ^If an error occurs while evaluating the SQL statements passed into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	338 ** sqlite3_exec(), then execution of the current statement stops and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	339 ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	340 ** is not NULL then any error message is written into memory obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	341 ** from [sqlite3_malloc()] and passed back through the 5th parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	342 ** To avoid memory leaks, the application should invoke [sqlite3_free()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	343 ** on error message strings returned through the 5th parameter of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	344 ** of sqlite3_exec() after the error message string is no longer needed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	345 ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	346 ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	347 ** NULL before returning.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	348 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	349 ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	350 ** routine returns SQLITE_ABORT without invoking the callback again and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	351 ** without running any subsequent SQL statements.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	352 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	353 ** ^The 2nd argument to the sqlite3_exec() callback function is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	354 ** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	355 ** callback is an array of pointers to strings obtained as if from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	356 ** [sqlite3_column_text()], one for each column. ^If an element of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	357 ** result row is NULL then the corresponding string pointer for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	358 ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	359 ** sqlite3_exec() callback is an array of pointers to strings where each
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	360 ** entry represents the name of corresponding result column as obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	361 ** from [sqlite3_column_name()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	362 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	363 ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	364 ** to an empty string, or a pointer that contains only whitespace and/or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	365 ** SQL comments, then no SQL statements are evaluated and the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	366 ** is not changed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	367 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	368 ** Restrictions:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	369 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	370 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	371 ** <li> The application must insure that the 1st parameter to sqlite3_exec()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	372 ** is a valid and open [database connection].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	373 ** <li> The application must not close the [database connection] specified by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	374 ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	375 ** <li> The application must not modify the SQL statement text passed into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	376 ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	377 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	378 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	379 SQLITE_API int sqlite3_exec(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	380 sqlite3, / An open database */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	381 const char sql, / SQL to be evaluated */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	382 int (callback)(void,int,char,char), /* Callback function */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	383 void , / 1st argument to callback */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	384 char *errmsg / Error msg written here */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	385 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	386
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	387 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	388 ** CAPI3REF: Result Codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	389 ** KEYWORDS: SQLITE_OK {error code} {error codes}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	390 ** KEYWORDS: {result code} {result codes}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	391 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	392 ** Many SQLite functions return an integer result code from the set shown
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	393 ** here in order to indicate success or failure.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	394 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	395 ** New error codes may be added in future versions of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	396 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	397 ** See also: [SQLITE_IOERR_READ \| extended result codes],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	398 ** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK \| result codes].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	399 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	400 #define SQLITE_OK 0 /* Successful result */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	401 /* beginning-of-error-codes */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	402 #define SQLITE_ERROR 1 /* SQL error or missing database */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	403 #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	404 #define SQLITE_PERM 3 /* Access permission denied */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	405 #define SQLITE_ABORT 4 /* Callback routine requested an abort */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	406 #define SQLITE_BUSY 5 /* The database file is locked */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	407 #define SQLITE_LOCKED 6 /* A table in the database is locked */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	408 #define SQLITE_NOMEM 7 /* A malloc() failed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	409 #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	410 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	411 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	412 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	413 #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	414 #define SQLITE_FULL 13 /* Insertion failed because database is full */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	415 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	416 #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	417 #define SQLITE_EMPTY 16 /* Database is empty */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	418 #define SQLITE_SCHEMA 17 /* The database schema changed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	419 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	420 #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	421 #define SQLITE_MISMATCH 20 /* Data type mismatch */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	422 #define SQLITE_MISUSE 21 /* Library used incorrectly */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	423 #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	424 #define SQLITE_AUTH 23 /* Authorization denied */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	425 #define SQLITE_FORMAT 24 /* Auxiliary database format error */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	426 #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	427 #define SQLITE_NOTADB 26 /* File opened that is not a database file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	428 #define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	429 #define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	430 #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	431 #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	432 /* end-of-error-codes */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	433
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	434 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	435 ** CAPI3REF: Extended Result Codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	436 ** KEYWORDS: {extended error code} {extended error codes}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	437 ** KEYWORDS: {extended result code} {extended result codes}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	438 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	439 ** In its default configuration, SQLite API routines return one of 26 integer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	440 ** [SQLITE_OK \| result codes]. However, experience has shown that many of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	441 ** these result codes are too coarse-grained. They do not provide as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	442 ** much information about problems as programmers might like. In an effort to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	443 ** address this, newer versions of SQLite (version 3.3.8 and later) include
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	444 ** support for additional result codes that provide more detailed information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	445 ** about errors. The extended result codes are enabled or disabled
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	446 ** on a per database connection basis using the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	447 ** [sqlite3_extended_result_codes()] API.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	448 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	449 ** Some of the available extended result codes are listed here.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	450 ** One may expect the number of extended result codes will increase
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	451 ** over time. Software that uses extended result codes should expect
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	452 ** to see new result codes in future releases of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	453 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	454 ** The SQLITE_OK result code will never be extended. It will always
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	455 ** be exactly zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	456 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	457 #define SQLITE_IOERR_READ (SQLITE_IOERR \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	458 #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR \| (2<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	459 #define SQLITE_IOERR_WRITE (SQLITE_IOERR \| (3<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	460 #define SQLITE_IOERR_FSYNC (SQLITE_IOERR \| (4<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	461 #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR \| (5<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	462 #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR \| (6<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	463 #define SQLITE_IOERR_FSTAT (SQLITE_IOERR \| (7<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	464 #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR \| (8<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	465 #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR \| (9<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	466 #define SQLITE_IOERR_DELETE (SQLITE_IOERR \| (10<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	467 #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR \| (11<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	468 #define SQLITE_IOERR_NOMEM (SQLITE_IOERR \| (12<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	469 #define SQLITE_IOERR_ACCESS (SQLITE_IOERR \| (13<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	470 #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR \| (14<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	471 #define SQLITE_IOERR_LOCK (SQLITE_IOERR \| (15<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	472 #define SQLITE_IOERR_CLOSE (SQLITE_IOERR \| (16<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	473 #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR \| (17<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	474 #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR \| (18<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	475 #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR \| (19<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	476 #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR \| (20<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	477 #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR \| (21<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	478 #define SQLITE_IOERR_SEEK (SQLITE_IOERR \| (22<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	479 #define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR \| (23<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	480 #define SQLITE_IOERR_MMAP (SQLITE_IOERR \| (24<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	481 #define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR \| (25<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	482 #define SQLITE_IOERR_CONVPATH (SQLITE_IOERR \| (26<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	483 #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	484 #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	485 #define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY \| (2<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	486 #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	487 #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN \| (2<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	488 #define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN \| (3<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	489 #define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN \| (4<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	490 #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	491 #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	492 #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY \| (2<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	493 #define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY \| (3<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	494 #define SQLITE_READONLY_DBMOVED (SQLITE_READONLY \| (4<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	495 #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT \| (2<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	496 #define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	497 #define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT \| (2<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	498 #define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT \| (3<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	499 #define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT \| (4<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	500 #define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT \| (5<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	501 #define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT \| (6<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	502 #define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT \| (7<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	503 #define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT \| (8<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	504 #define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT \| (9<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	505 #define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT \|(10<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	506 #define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	507 #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE \| (2<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	508 #define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING \| (1<<8))
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	509
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	510 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	511 ** CAPI3REF: Flags For File Open Operations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	512 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	513 ** These bit values are intended for use in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	514 ** 3rd parameter to the [sqlite3_open_v2()] interface and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	515 ** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	516 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	517 #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	518 #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	519 #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	520 #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	521 #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	522 #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	523 #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	524 #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	525 #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	526 #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	527 #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	528 #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	529 #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	530 #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	531 #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	532 #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	533 #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	534 #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	535 #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	536 #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	537
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	538 /* Reserved: 0x00F00000 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	539
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	540 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	541 ** CAPI3REF: Device Characteristics
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	542 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	543 ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	544 ** object returns an integer which is a vector of these
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	545 ** bit values expressing I/O characteristics of the mass storage
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	546 ** device that holds the file that the [sqlite3_io_methods]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	547 ** refers to.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	548 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	549 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	550 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	551 ** mean that writes of blocks that are nnn bytes in size and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	552 ** are aligned to an address which is an integer multiple of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	553 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	554 ** that when data is appended to a file, the data is appended
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	555 ** first then the size of the file is extended, never the other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	556 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	557 ** information is written to disk in the same order as calls
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	558 ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	559 ** after reboot following a crash or power loss, the only bytes in a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	560 ** file that were written at the application level might have changed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	561 ** and that adjacent bytes, even bytes within the same sector are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	562 ** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	563 ** flag indicate that a file cannot be deleted when open. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	564 ** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	565 ** read-only media and cannot be changed even by processes with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	566 ** elevated privileges.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	567 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	568 #define SQLITE_IOCAP_ATOMIC 0x00000001
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	569 #define SQLITE_IOCAP_ATOMIC512 0x00000002
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	570 #define SQLITE_IOCAP_ATOMIC1K 0x00000004
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	571 #define SQLITE_IOCAP_ATOMIC2K 0x00000008
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	572 #define SQLITE_IOCAP_ATOMIC4K 0x00000010
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	573 #define SQLITE_IOCAP_ATOMIC8K 0x00000020
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	574 #define SQLITE_IOCAP_ATOMIC16K 0x00000040
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	575 #define SQLITE_IOCAP_ATOMIC32K 0x00000080
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	576 #define SQLITE_IOCAP_ATOMIC64K 0x00000100
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	577 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	578 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	579 #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	580 #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	581 #define SQLITE_IOCAP_IMMUTABLE 0x00002000
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	582
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	583 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	584 ** CAPI3REF: File Locking Levels
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	585 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	586 ** SQLite uses one of these integer values as the second
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	587 ** argument to calls it makes to the xLock() and xUnlock() methods
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	588 ** of an [sqlite3_io_methods] object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	589 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	590 #define SQLITE_LOCK_NONE 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	591 #define SQLITE_LOCK_SHARED 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	592 #define SQLITE_LOCK_RESERVED 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	593 #define SQLITE_LOCK_PENDING 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	594 #define SQLITE_LOCK_EXCLUSIVE 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	595
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	596 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	597 ** CAPI3REF: Synchronization Type Flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	598 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	599 ** When SQLite invokes the xSync() method of an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	600 ** [sqlite3_io_methods] object it uses a combination of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	601 ** these integer values as the second argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	602 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	603 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	604 ** sync operation only needs to flush data to mass storage. Inode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	605 ** information need not be flushed. If the lower four bits of the flag
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	606 ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	607 ** If the lower four bits equal SQLITE_SYNC_FULL, that means
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	608 ** to use Mac OS X style fullsync instead of fsync().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	609 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	610 ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	611 ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	612 ** settings. The [synchronous pragma] determines when calls to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	613 ** xSync VFS method occur and applies uniformly across all platforms.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	614 ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	615 ** energetic or rigorous or forceful the sync operations are and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	616 ** only make a difference on Mac OSX for the default SQLite code.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	617 ** (Third-party VFS implementations might also make the distinction
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	618 ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	619 ** operating systems natively supported by SQLite, only Mac OSX
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	620 ** cares about the difference.)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	621 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	622 #define SQLITE_SYNC_NORMAL 0x00002
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	623 #define SQLITE_SYNC_FULL 0x00003
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	624 #define SQLITE_SYNC_DATAONLY 0x00010
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	625
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	626 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	627 ** CAPI3REF: OS Interface Open File Handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	628 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	629 ** An [sqlite3_file] object represents an open file in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	630 ** [sqlite3_vfs \| OS interface layer]. Individual OS interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	631 ** implementations will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	632 ** want to subclass this object by appending additional fields
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	633 ** for their own use. The pMethods entry is a pointer to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	634 ** [sqlite3_io_methods] object that defines methods for performing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	635 ** I/O operations on the open file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	636 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	637 typedef struct sqlite3_file sqlite3_file;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	638 struct sqlite3_file {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	639 const struct sqlite3_io_methods pMethods; / Methods for an open file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	640 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	641
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	642 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	643 ** CAPI3REF: OS Interface File Virtual Methods Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	644 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	645 ** Every file opened by the [sqlite3_vfs.xOpen] method populates an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	646 ** [sqlite3_file] object (or, more commonly, a subclass of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	647 ** [sqlite3_file] object) with a pointer to an instance of this object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	648 ** This object defines the methods used to perform various operations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	649 ** against the open file represented by the [sqlite3_file] object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	650 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	651 ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	652 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	653 ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	654 ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	655 ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	656 ** to NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	657 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	658 ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	659 ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	660 ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	661 ** flag may be ORed in to indicate that only the data of the file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	662 ** and not its inode needs to be synced.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	663 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	664 ** The integer values to xLock() and xUnlock() are one of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	665 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	666 ** <li> [SQLITE_LOCK_NONE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	667 ** <li> [SQLITE_LOCK_SHARED],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	668 ** <li> [SQLITE_LOCK_RESERVED],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	669 ** <li> [SQLITE_LOCK_PENDING], or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	670 ** <li> [SQLITE_LOCK_EXCLUSIVE].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	671 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	672 ** xLock() increases the lock. xUnlock() decreases the lock.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	673 ** The xCheckReservedLock() method checks whether any database connection,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	674 ** either in this process or in some other process, is holding a RESERVED,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	675 ** PENDING, or EXCLUSIVE lock on the file. It returns true
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	676 ** if such a lock exists and false otherwise.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	677 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	678 ** The xFileControl() method is a generic interface that allows custom
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	679 ** VFS implementations to directly control an open file using the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	680 ** [sqlite3_file_control()] interface. The second "op" argument is an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	681 ** integer opcode. The third argument is a generic pointer intended to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	682 ** point to a structure that may contain arguments or space in which to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	683 ** write return values. Potential uses for xFileControl() might be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	684 ** functions to enable blocking locks with timeouts, to change the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	685 ** locking strategy (for example to use dot-file locks), to inquire
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	686 ** about the status of a lock, or to break stale locks. The SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	687 ** core reserves all opcodes less than 100 for its own use.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	688 ** A [SQLITE_FCNTL_LOCKSTATE \| list of opcodes] less than 100 is available.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	689 ** Applications that define a custom xFileControl method should use opcodes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	690 ** greater than 100 to avoid conflicts. VFS implementations should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	691 ** return [SQLITE_NOTFOUND] for file control opcodes that they do not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	692 ** recognize.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	693 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	694 ** The xSectorSize() method returns the sector size of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	695 ** device that underlies the file. The sector size is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	696 ** minimum write that can be performed without disturbing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	697 ** other bytes in the file. The xDeviceCharacteristics()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	698 ** method returns a bit vector describing behaviors of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	699 ** underlying device:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	700 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	701 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	702 ** <li> [SQLITE_IOCAP_ATOMIC]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	703 ** <li> [SQLITE_IOCAP_ATOMIC512]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	704 ** <li> [SQLITE_IOCAP_ATOMIC1K]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	705 ** <li> [SQLITE_IOCAP_ATOMIC2K]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	706 ** <li> [SQLITE_IOCAP_ATOMIC4K]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	707 ** <li> [SQLITE_IOCAP_ATOMIC8K]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	708 ** <li> [SQLITE_IOCAP_ATOMIC16K]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	709 ** <li> [SQLITE_IOCAP_ATOMIC32K]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	710 ** <li> [SQLITE_IOCAP_ATOMIC64K]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	711 ** <li> [SQLITE_IOCAP_SAFE_APPEND]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	712 ** <li> [SQLITE_IOCAP_SEQUENTIAL]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	713 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	714 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	715 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	716 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	717 ** mean that writes of blocks that are nnn bytes in size and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	718 ** are aligned to an address which is an integer multiple of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	719 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	720 ** that when data is appended to a file, the data is appended
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	721 ** first then the size of the file is extended, never the other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	722 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	723 ** information is written to disk in the same order as calls
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	724 ** to xWrite().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	725 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	726 ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	727 ** in the unread portions of the buffer with zeros. A VFS that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	728 ** fails to zero-fill short reads might seem to work. However,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	729 ** failure to zero-fill short reads will eventually lead to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	730 ** database corruption.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	731 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	732 typedef struct sqlite3_io_methods sqlite3_io_methods;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	733 struct sqlite3_io_methods {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	734 int iVersion;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	735 int (xClose)(sqlite3_file);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	736 int (xRead)(sqlite3_file, void*, int iAmt, sqlite3_int64 iOfst);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	737 int (xWrite)(sqlite3_file, const void*, int iAmt, sqlite3_int64 iOfst);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	738 int (xTruncate)(sqlite3_file, sqlite3_int64 size);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	739 int (xSync)(sqlite3_file, int flags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	740 int (xFileSize)(sqlite3_file, sqlite3_int64 *pSize);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	741 int (xLock)(sqlite3_file, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	742 int (xUnlock)(sqlite3_file, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	743 int (xCheckReservedLock)(sqlite3_file, int *pResOut);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	744 int (xFileControl)(sqlite3_file, int op, void *pArg);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	745 int (xSectorSize)(sqlite3_file);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	746 int (xDeviceCharacteristics)(sqlite3_file);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	747 /* Methods above are valid for version 1 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	748 int (xShmMap)(sqlite3_file, int iPg, int pgsz, int, void volatile**);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	749 int (xShmLock)(sqlite3_file, int offset, int n, int flags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	750 void (xShmBarrier)(sqlite3_file);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	751 int (xShmUnmap)(sqlite3_file, int deleteFlag);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	752 /* Methods above are valid for version 2 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	753 int (xFetch)(sqlite3_file, sqlite3_int64 iOfst, int iAmt, void **pp);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	754 int (xUnfetch)(sqlite3_file, sqlite3_int64 iOfst, void *p);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	755 /* Methods above are valid for version 3 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	756 /* Additional methods may be added in future releases */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	757 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	758
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	759 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	760 ** CAPI3REF: Standard File Control Opcodes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	761 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	762 ** These integer constants are opcodes for the xFileControl method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	763 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	764 ** interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	765 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	766 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	767 ** opcode causes the xFileControl method to write the current state of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	768 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	769 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	770 ** into an integer that the pArg argument points to. This capability
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	771 ** is used during testing and only needs to be supported when SQLITE_TEST
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	772 ** is defined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	773 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	774 ** <li>[[SQLITE_FCNTL_SIZE_HINT]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	775 ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	776 ** layer a hint of how large the database file will grow to be during the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	777 ** current transaction. This hint is not guaranteed to be accurate but it
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	778 ** is often close. The underlying VFS might choose to preallocate database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	779 ** file space based on this hint in order to help writes to the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	780 ** file run faster.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	781 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	782 ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	783 ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	784 ** extends and truncates the database file in chunks of a size specified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	785 ** by the user. The fourth argument to [sqlite3_file_control()] should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	786 ** point to an integer (type int) containing the new chunk-size to use
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	787 ** for the nominated database. Allocating database file space in large
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	788 ** chunks (say 1MB at a time), may reduce file-system fragmentation and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	789 ** improve performance on some systems.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	790 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	791 ** <li>[[SQLITE_FCNTL_FILE_POINTER]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	792 ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	793 ** to the [sqlite3_file] object associated with a particular database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	794 ** connection. See the [sqlite3_file_control()] documentation for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	795 ** additional information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	796 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	797 ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	798 ** No longer in use.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	799 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	800 ** <li>[[SQLITE_FCNTL_SYNC]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	801 ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	802 ** sent to the VFS immediately before the xSync method is invoked on a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	803 ** database file descriptor. Or, if the xSync method is not invoked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	804 ** because the user has configured SQLite with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	805 ** [PRAGMA synchronous \| PRAGMA synchronous=OFF] it is invoked in place
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	806 ** of the xSync method. In most cases, the pointer argument passed with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	807 ** this file-control is NULL. However, if the database file is being synced
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	808 ** as part of a multi-database commit, the argument points to a nul-terminated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	809 ** string containing the transactions master-journal file name. VFSes that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	810 ** do not need this signal should silently ignore this opcode. Applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	811 ** should not call [sqlite3_file_control()] with this opcode as doing so may
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	812 ** disrupt the operation of the specialized VFSes that do require it.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	813 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	814 ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	815 ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	816 ** and sent to the VFS after a transaction has been committed immediately
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	817 ** but before the database is unlocked. VFSes that do not need this signal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	818 ** should silently ignore this opcode. Applications should not call
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	819 ** [sqlite3_file_control()] with this opcode as doing so may disrupt the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	820 ** operation of the specialized VFSes that do require it.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	821 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	822 ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	823 ** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	824 ** retry counts and intervals for certain disk I/O operations for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	825 ** windows [VFS] in order to provide robustness in the presence of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	826 ** anti-virus programs. By default, the windows VFS will retry file read,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	827 ** file write, and file delete operations up to 10 times, with a delay
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	828 ** of 25 milliseconds before the first retry and with the delay increasing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	829 ** by an additional 25 milliseconds with each subsequent retry. This
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	830 ** opcode allows these two values (10 retries and 25 milliseconds of delay)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	831 ** to be adjusted. The values are changed for all database connections
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	832 ** within the same process. The argument is a pointer to an array of two
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	833 ** integers where the first integer i the new retry count and the second
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	834 ** integer is the delay. If either integer is negative, then the setting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	835 ** is not changed but instead the prior value of that setting is written
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	836 ** into the array entry, allowing the current retry settings to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	837 ** interrogated. The zDbName parameter is ignored.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	838 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	839 ** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	840 ** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	841 ** persistent [WAL \| Write Ahead Log] setting. By default, the auxiliary
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	842 ** write ahead log and shared memory files used for transaction control
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	843 ** are automatically deleted when the latest connection to the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	844 ** closes. Setting persistent WAL mode causes those files to persist after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	845 ** close. Persisting the files is useful when other processes that do not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	846 ** have write permission on the directory containing the database file want
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	847 ** to read the database file, as the WAL and shared memory files must exist
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	848 ** in order for the database to be readable. The fourth parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	849 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	850 ** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	851 ** WAL mode. If the integer is -1, then it is overwritten with the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	852 ** WAL persistence setting.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	853 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	854 ** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	855 ** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	856 ** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	857 ** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	858 ** xDeviceCharacteristics methods. The fourth parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	859 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	860 ** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	861 ** mode. If the integer is -1, then it is overwritten with the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	862 ** zero-damage mode setting.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	863 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	864 ** <li>[[SQLITE_FCNTL_OVERWRITE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	865 ** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	866 ** a write transaction to indicate that, unless it is rolled back for some
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	867 ** reason, the entire database file will be overwritten by the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	868 ** transaction. This is used by VACUUM operations.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	869 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	870 ** <li>[[SQLITE_FCNTL_VFSNAME]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	871 ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	872 ** all [VFSes] in the VFS stack. The names are of all VFS shims and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	873 ** final bottom-level VFS are written into memory obtained from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	874 ** [sqlite3_malloc()] and the result is stored in the char* variable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	875 ** that the fourth parameter of [sqlite3_file_control()] points to.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	876 ** The caller is responsible for freeing the memory when done. As with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	877 ** all file-control actions, there is no guarantee that this will actually
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	878 ** do anything. Callers should initialize the char* variable to a NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	879 ** pointer in case this file-control is not implemented. This file-control
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	880 ** is intended for diagnostic use only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	881 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	882 ** <li>[[SQLITE_FCNTL_PRAGMA]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	883 ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	884 ** file control is sent to the open [sqlite3_file] object corresponding
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	885 ** to the database file to which the pragma statement refers. ^The argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	886 ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	887 pointers to strings (char) in which the second element of the array
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	888 ** is the name of the pragma and the third element is the argument to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	889 ** pragma or NULL if the pragma has no argument. ^The handler for an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	890 ** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	891 of the char argument point to a string obtained from [sqlite3_mprintf()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	892 ** or the equivalent and that string will become the result of the pragma or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	893 ** the error message if the pragma fails. ^If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	894 ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	895 ** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	896 ** file control returns [SQLITE_OK], then the parser assumes that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	897 ** VFS has handled the PRAGMA itself and the parser generates a no-op
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	898 ** prepared statement. ^If the [SQLITE_FCNTL_PRAGMA] file control returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	899 ** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	900 ** that the VFS encountered an error while handling the [PRAGMA] and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	901 ** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	902 ** file control occurs at the beginning of pragma statement analysis and so
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	903 ** it is able to override built-in [PRAGMA] statements.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	904 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	905 ** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	906 ** ^The [SQLITE_FCNTL_BUSYHANDLER]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	907 ** file-control may be invoked by SQLite on the database file handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	908 ** shortly after it is opened in order to provide a custom VFS with access
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	909 to the connections busy-handler callback. The argument is of type (void )
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	910 ** - an array of two (void ) values. The first (void ) actually points
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	911 ** to a function of type (int ()(void )). In order to invoke the connections
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	912 ** busy-handler, this function should be invoked with the second (void *) in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	913 ** the array as the only argument. If it returns non-zero, then the operation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	914 ** should be retried. If it returns zero, the custom VFS should abandon the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	915 ** current operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	916 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	917 ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	918 ** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	919 ** to have SQLite generate a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	920 ** temporary filename using the same algorithm that is followed to generate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	921 ** temporary filenames for TEMP tables and other internal uses. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	922 argument should be a char which will be filled with the filename
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	923 ** written into memory obtained from [sqlite3_malloc()]. The caller should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	924 ** invoke [sqlite3_free()] on the result to avoid a memory leak.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	925 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	926 ** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	927 ** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	928 ** maximum number of bytes that will be used for memory-mapped I/O.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	929 ** The argument is a pointer to a value of type sqlite3_int64 that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	930 ** is an advisory maximum number of bytes in the file to memory map. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	931 ** pointer is overwritten with the old value. The limit is not changed if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	932 ** the value originally pointed to is negative, and so the current limit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	933 ** can be queried by passing in a pointer to a negative number. This
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	934 ** file-control is used internally to implement [PRAGMA mmap_size].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	935 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	936 ** <li>[[SQLITE_FCNTL_TRACE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	937 ** The [SQLITE_FCNTL_TRACE] file control provides advisory information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	938 ** to the VFS about what the higher layers of the SQLite stack are doing.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	939 ** This file control is used by some VFS activity tracing [shims].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	940 ** The argument is a zero-terminated string. Higher layers in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	941 ** SQLite stack may generate instances of this file control if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	942 ** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	943 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	944 ** <li>[[SQLITE_FCNTL_HAS_MOVED]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	945 ** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	946 ** pointer to an integer and it writes a boolean into that integer depending
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	947 ** on whether or not the file has been renamed, moved, or deleted since it
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	948 ** was first opened.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	949 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	950 ** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	951 ** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	952 ** opcode causes the xFileControl method to swap the file handle with the one
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	953 ** pointed to by the pArg argument. This capability is used during testing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	954 ** and only needs to be supported when SQLITE_TEST is defined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	955 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	956 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	957 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	958 #define SQLITE_FCNTL_LOCKSTATE 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	959 #define SQLITE_GET_LOCKPROXYFILE 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	960 #define SQLITE_SET_LOCKPROXYFILE 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	961 #define SQLITE_LAST_ERRNO 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	962 #define SQLITE_FCNTL_SIZE_HINT 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	963 #define SQLITE_FCNTL_CHUNK_SIZE 6
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	964 #define SQLITE_FCNTL_FILE_POINTER 7
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	965 #define SQLITE_FCNTL_SYNC_OMITTED 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	966 #define SQLITE_FCNTL_WIN32_AV_RETRY 9
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	967 #define SQLITE_FCNTL_PERSIST_WAL 10
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	968 #define SQLITE_FCNTL_OVERWRITE 11
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	969 #define SQLITE_FCNTL_VFSNAME 12
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	970 #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	971 #define SQLITE_FCNTL_PRAGMA 14
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	972 #define SQLITE_FCNTL_BUSYHANDLER 15
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	973 #define SQLITE_FCNTL_TEMPFILENAME 16
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	974 #define SQLITE_FCNTL_MMAP_SIZE 18
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	975 #define SQLITE_FCNTL_TRACE 19
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	976 #define SQLITE_FCNTL_HAS_MOVED 20
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	977 #define SQLITE_FCNTL_SYNC 21
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	978 #define SQLITE_FCNTL_COMMIT_PHASETWO 22
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	979 #define SQLITE_FCNTL_WIN32_SET_HANDLE 23
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	980
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	981 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	982 ** CAPI3REF: Mutex Handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	983 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	984 ** The mutex module within SQLite defines [sqlite3_mutex] to be an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	985 ** abstract type for a mutex object. The SQLite core never looks
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	986 ** at the internal representation of an [sqlite3_mutex]. It only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	987 ** deals with pointers to the [sqlite3_mutex] object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	988 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	989 ** Mutexes are created using [sqlite3_mutex_alloc()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	990 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	991 typedef struct sqlite3_mutex sqlite3_mutex;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	992
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	993 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	994 ** CAPI3REF: OS Interface Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	995 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	996 ** An instance of the sqlite3_vfs object defines the interface between
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	997 ** the SQLite core and the underlying operating system. The "vfs"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	998 ** in the name of the object stands for "virtual file system". See
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	999 ** the [VFS \| VFS documentation] for further information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1000 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1001 ** The value of the iVersion field is initially 1 but may be larger in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1002 ** future versions of SQLite. Additional fields may be appended to this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1003 ** object when the iVersion value is increased. Note that the structure
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1004 ** of the sqlite3_vfs object changes in the transaction between
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1005 ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1006 ** modified.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1007 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1008 ** The szOsFile field is the size of the subclassed [sqlite3_file]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1009 ** structure used by this VFS. mxPathname is the maximum length of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1010 ** a pathname in this VFS.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1011 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1012 ** Registered sqlite3_vfs objects are kept on a linked list formed by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1013 ** the pNext pointer. The [sqlite3_vfs_register()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1014 ** and [sqlite3_vfs_unregister()] interfaces manage this list
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1015 ** in a thread-safe way. The [sqlite3_vfs_find()] interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1016 ** searches the list. Neither the application code nor the VFS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1017 ** implementation should use the pNext pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1018 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1019 ** The pNext field is the only field in the sqlite3_vfs
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1020 ** structure that SQLite will ever modify. SQLite will only access
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1021 ** or modify this field while holding a particular static mutex.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1022 ** The application should never modify anything within the sqlite3_vfs
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1023 ** object once the object has been registered.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1024 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1025 ** The zName field holds the name of the VFS module. The name must
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1026 ** be unique across all VFS modules.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1027 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1028 ** [[sqlite3_vfs.xOpen]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1029 ** ^SQLite guarantees that the zFilename parameter to xOpen
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1030 ** is either a NULL pointer or string obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1031 ** from xFullPathname() with an optional suffix added.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1032 ** ^If a suffix is added to the zFilename parameter, it will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1033 ** consist of a single "-" character followed by no more than
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1034 ** 11 alphanumeric and/or "-" characters.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1035 ** ^SQLite further guarantees that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1036 ** the string will be valid and unchanged until xClose() is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1037 ** called. Because of the previous sentence,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1038 ** the [sqlite3_file] can safely store a pointer to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1039 ** filename if it needs to remember the filename for some reason.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1040 ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1041 ** must invent its own temporary name for the file. ^Whenever the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1042 ** xFilename parameter is NULL it will also be the case that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1043 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1044 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1045 ** The flags argument to xOpen() includes all bits set in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1046 ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1047 ** or [sqlite3_open16()] is used, then flags includes at least
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1048 ** [SQLITE_OPEN_READWRITE] \| [SQLITE_OPEN_CREATE].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1049 ** If xOpen() opens a file read-only then it sets *pOutFlags to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1050 ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1051 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1052 ** ^(SQLite will also add one of the following flags to the xOpen()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1053 ** call, depending on the object being opened:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1054 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1055 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1056 ** <li> [SQLITE_OPEN_MAIN_DB]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1057 ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1058 ** <li> [SQLITE_OPEN_TEMP_DB]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1059 ** <li> [SQLITE_OPEN_TEMP_JOURNAL]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1060 ** <li> [SQLITE_OPEN_TRANSIENT_DB]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1061 ** <li> [SQLITE_OPEN_SUBJOURNAL]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1062 ** <li> [SQLITE_OPEN_MASTER_JOURNAL]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1063 ** <li> [SQLITE_OPEN_WAL]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1064 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1065 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1066 ** The file I/O implementation can use the object type flags to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1067 ** change the way it deals with files. For example, an application
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1068 ** that does not care about crash recovery or rollback might make
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1069 ** the open of a journal file a no-op. Writes to this journal would
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1070 ** also be no-ops, and any attempt to read the journal would return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1071 ** SQLITE_IOERR. Or the implementation might recognize that a database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1072 ** file will be doing page-aligned sector reads and writes in a random
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1073 ** order and set up its I/O subsystem accordingly.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1074 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1075 ** SQLite might also add one of the following flags to the xOpen method:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1076 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1077 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1078 ** <li> [SQLITE_OPEN_DELETEONCLOSE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1079 ** <li> [SQLITE_OPEN_EXCLUSIVE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1080 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1081 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1082 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1083 ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1084 ** will be set for TEMP databases and their journals, transient
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1085 ** databases, and subjournals.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1086 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1087 ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1088 ** with the [SQLITE_OPEN_CREATE] flag, which are both directly
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1089 ** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1090 ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1091 ** SQLITE_OPEN_CREATE, is used to indicate that file should always
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1092 ** be created, and that it is an error if it already exists.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1093 ** It is <i>not</i> used to indicate the file should be opened
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1094 ** for exclusive access.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1095 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1096 ** ^At least szOsFile bytes of memory are allocated by SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1097 ** to hold the [sqlite3_file] structure passed as the third
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1098 ** argument to xOpen. The xOpen method does not have to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1099 ** allocate the structure; it should just fill it in. Note that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1100 ** the xOpen method must set the sqlite3_file.pMethods to either
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1101 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1102 ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1103 ** element will be valid after xOpen returns regardless of the success
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1104 ** or failure of the xOpen call.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1105 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1106 ** [[sqlite3_vfs.xAccess]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1107 ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1108 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1109 ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1110 ** to test whether a file is at least readable. The file can be a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1111 ** directory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1112 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1113 ** ^SQLite will always allocate at least mxPathname+1 bytes for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1114 ** output buffer xFullPathname. The exact size of the output buffer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1115 ** is also passed as a parameter to both methods. If the output buffer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1116 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1117 ** handled as a fatal error by SQLite, vfs implementations should endeavor
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1118 ** to prevent this by setting mxPathname to a sufficiently large value.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1119 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1120 ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1121 ** interfaces are not strictly a part of the filesystem, but they are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1122 ** included in the VFS structure for completeness.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1123 ** The xRandomness() function attempts to return nBytes bytes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1124 ** of good-quality randomness into zOut. The return value is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1125 ** the actual number of bytes of randomness obtained.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1126 ** The xSleep() method causes the calling thread to sleep for at
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1127 ** least the number of microseconds given. ^The xCurrentTime()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1128 ** method returns a Julian Day Number for the current date and time as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1129 ** a floating point value.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1130 ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1131 ** Day Number multiplied by 86400000 (the number of milliseconds in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1132 ** a 24-hour day).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1133 ** ^SQLite will use the xCurrentTimeInt64() method to get the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1134 ** date and time if that method is available (if iVersion is 2 or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1135 ** greater and the function pointer is not NULL) and will fall back
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1136 ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1137 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1138 ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1139 ** are not used by the SQLite core. These optional interfaces are provided
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1140 ** by some VFSes to facilitate testing of the VFS code. By overriding
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1141 ** system calls with functions under its control, a test program can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1142 ** simulate faults and error conditions that would otherwise be difficult
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1143 ** or impossible to induce. The set of system calls that can be overridden
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1144 ** varies from one VFS to another, and from one version of the same VFS to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1145 ** next. Applications that use these interfaces must be prepared for any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1146 ** or all of these interfaces to be NULL or for their behavior to change
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1147 ** from one release to the next. Applications must not attempt to access
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1148 ** any of these methods if the iVersion of the VFS is less than 3.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1149 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1150 typedef struct sqlite3_vfs sqlite3_vfs;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1151 typedef void (*sqlite3_syscall_ptr)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1152 struct sqlite3_vfs {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1153 int iVersion; /* Structure version number (currently 3) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1154 int szOsFile; /* Size of subclassed sqlite3_file */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1155 int mxPathname; /* Maximum file pathname length */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1156 sqlite3_vfs pNext; / Next registered VFS */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1157 const char zName; / Name of this virtual file system */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1158 void pAppData; / Pointer to application-specific data */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1159 int (xOpen)(sqlite3_vfs, const char zName, sqlite3_file,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1160 int flags, int *pOutFlags);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1161 int (xDelete)(sqlite3_vfs, const char *zName, int syncDir);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1162 int (xAccess)(sqlite3_vfs, const char zName, int flags, int pResOut);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1163 int (xFullPathname)(sqlite3_vfs, const char zName, int nOut, char zOut);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1164 void (xDlOpen)(sqlite3_vfs, const char zFilename);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1165 void (xDlError)(sqlite3_vfs, int nByte, char *zErrMsg);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1166 void ((xDlSym)(sqlite3_vfs,void, const char *zSymbol))(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1167 void (xDlClose)(sqlite3_vfs, void*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1168 int (xRandomness)(sqlite3_vfs, int nByte, char *zOut);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1169 int (xSleep)(sqlite3_vfs, int microseconds);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1170 int (xCurrentTime)(sqlite3_vfs, double*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1171 int (xGetLastError)(sqlite3_vfs, int, char *);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1172 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1173 ** The methods above are in version 1 of the sqlite_vfs object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1174 ** definition. Those that follow are added in version 2 or later
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1175 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1176 int (xCurrentTimeInt64)(sqlite3_vfs, sqlite3_int64*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1177 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1178 ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1179 ** Those below are for version 3 and greater.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1180 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1181 int (xSetSystemCall)(sqlite3_vfs, const char *zName, sqlite3_syscall_ptr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1182 sqlite3_syscall_ptr (xGetSystemCall)(sqlite3_vfs, const char *zName);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1183 const char (xNextSystemCall)(sqlite3_vfs, const char zName);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1184 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1185 ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1186 ** New fields may be appended in figure versions. The iVersion
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1187 ** value will increment whenever this happens.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1188 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1189 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1190
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1191 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1192 ** CAPI3REF: Flags for the xAccess VFS method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1193 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1194 ** These integer constants can be used as the third parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1195 ** the xAccess method of an [sqlite3_vfs] object. They determine
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1196 ** what kind of permissions the xAccess method is looking for.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1197 ** With SQLITE_ACCESS_EXISTS, the xAccess method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1198 ** simply checks whether the file exists.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1199 ** With SQLITE_ACCESS_READWRITE, the xAccess method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1200 ** checks whether the named directory is both readable and writable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1201 ** (in other words, if files can be added, removed, and renamed within
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1202 ** the directory).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1203 ** The SQLITE_ACCESS_READWRITE constant is currently used only by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1204 ** [temp_store_directory pragma], though this could change in a future
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1205 ** release of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1206 ** With SQLITE_ACCESS_READ, the xAccess method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1207 ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1208 ** currently unused, though it might be used in a future release of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1209 ** SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1210 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1211 #define SQLITE_ACCESS_EXISTS 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1212 #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1213 #define SQLITE_ACCESS_READ 2 /* Unused */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1214
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1215 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1216 ** CAPI3REF: Flags for the xShmLock VFS method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1217 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1218 ** These integer constants define the various locking operations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1219 ** allowed by the xShmLock method of [sqlite3_io_methods]. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1220 ** following are the only legal combinations of flags to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1221 ** xShmLock method:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1222 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1223 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1224 ** <li> SQLITE_SHM_LOCK \| SQLITE_SHM_SHARED
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1225 ** <li> SQLITE_SHM_LOCK \| SQLITE_SHM_EXCLUSIVE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1226 ** <li> SQLITE_SHM_UNLOCK \| SQLITE_SHM_SHARED
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1227 ** <li> SQLITE_SHM_UNLOCK \| SQLITE_SHM_EXCLUSIVE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1228 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1229 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1230 ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1231 ** was given no the corresponding lock.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1232 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1233 ** The xShmLock method can transition between unlocked and SHARED or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1234 ** between unlocked and EXCLUSIVE. It cannot transition between SHARED
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1235 ** and EXCLUSIVE.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1236 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1237 #define SQLITE_SHM_UNLOCK 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1238 #define SQLITE_SHM_LOCK 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1239 #define SQLITE_SHM_SHARED 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1240 #define SQLITE_SHM_EXCLUSIVE 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1241
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1242 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1243 ** CAPI3REF: Maximum xShmLock index
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1244 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1245 ** The xShmLock method on [sqlite3_io_methods] may use values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1246 ** between 0 and this upper bound as its "offset" argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1247 ** The SQLite core will never attempt to acquire or release a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1248 ** lock outside of this range
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1249 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1250 #define SQLITE_SHM_NLOCK 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1251
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1252
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1253 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1254 ** CAPI3REF: Initialize The SQLite Library
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1255 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1256 ** ^The sqlite3_initialize() routine initializes the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1257 ** SQLite library. ^The sqlite3_shutdown() routine
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1258 ** deallocates any resources that were allocated by sqlite3_initialize().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1259 ** These routines are designed to aid in process initialization and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1260 ** shutdown on embedded systems. Workstation applications using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1261 ** SQLite normally do not need to invoke either of these routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1262 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1263 ** A call to sqlite3_initialize() is an "effective" call if it is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1264 ** the first time sqlite3_initialize() is invoked during the lifetime of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1265 ** the process, or if it is the first time sqlite3_initialize() is invoked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1266 ** following a call to sqlite3_shutdown(). ^(Only an effective call
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1267 ** of sqlite3_initialize() does any initialization. All other calls
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1268 ** are harmless no-ops.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1269 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1270 ** A call to sqlite3_shutdown() is an "effective" call if it is the first
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1271 ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1272 ** an effective call to sqlite3_shutdown() does any deinitialization.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1273 ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1274 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1275 ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1276 ** is not. The sqlite3_shutdown() interface must only be called from a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1277 ** single thread. All open [database connections] must be closed and all
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1278 ** other SQLite resources must be deallocated prior to invoking
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1279 ** sqlite3_shutdown().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1280 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1281 ** Among other things, ^sqlite3_initialize() will invoke
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1282 ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1283 ** will invoke sqlite3_os_end().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1284 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1285 ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1286 ** ^If for some reason, sqlite3_initialize() is unable to initialize
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1287 ** the library (perhaps it is unable to allocate a needed resource such
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1288 ** as a mutex) it returns an [error code] other than [SQLITE_OK].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1289 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1290 ** ^The sqlite3_initialize() routine is called internally by many other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1291 ** SQLite interfaces so that an application usually does not need to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1292 ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1293 ** calls sqlite3_initialize() so the SQLite library will be automatically
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1294 ** initialized when [sqlite3_open()] is called if it has not be initialized
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1295 ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1296 ** compile-time option, then the automatic calls to sqlite3_initialize()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1297 ** are omitted and the application must call sqlite3_initialize() directly
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1298 ** prior to using any other SQLite interface. For maximum portability,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1299 ** it is recommended that applications always invoke sqlite3_initialize()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1300 ** directly prior to using any other SQLite interface. Future releases
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1301 ** of SQLite may require this. In other words, the behavior exhibited
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1302 ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1303 ** default behavior in some future release of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1304 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1305 ** The sqlite3_os_init() routine does operating-system specific
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1306 ** initialization of the SQLite library. The sqlite3_os_end()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1307 ** routine undoes the effect of sqlite3_os_init(). Typical tasks
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1308 ** performed by these routines include allocation or deallocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1309 ** of static resources, initialization of global variables,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1310 ** setting up a default [sqlite3_vfs] module, or setting up
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1311 ** a default configuration using [sqlite3_config()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1312 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1313 ** The application should never invoke either sqlite3_os_init()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1314 ** or sqlite3_os_end() directly. The application should only invoke
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1315 ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1316 ** interface is called automatically by sqlite3_initialize() and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1317 ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1318 ** implementations for sqlite3_os_init() and sqlite3_os_end()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1319 ** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1320 ** When [custom builds \| built for other platforms]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1321 ** (using the [SQLITE_OS_OTHER=1] compile-time
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1322 ** option) the application must supply a suitable implementation for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1323 ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1324 ** implementation of sqlite3_os_init() or sqlite3_os_end()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1325 ** must return [SQLITE_OK] on success and some other [error code] upon
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1326 ** failure.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1327 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1328 SQLITE_API int sqlite3_initialize(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1329 SQLITE_API int sqlite3_shutdown(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1330 SQLITE_API int sqlite3_os_init(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1331 SQLITE_API int sqlite3_os_end(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1332
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1333 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1334 ** CAPI3REF: Configuring The SQLite Library
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1335 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1336 ** The sqlite3_config() interface is used to make global configuration
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1337 ** changes to SQLite in order to tune SQLite to the specific needs of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1338 ** the application. The default configuration is recommended for most
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1339 ** applications and so this routine is usually not necessary. It is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1340 ** provided to support rare applications with unusual needs.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1341 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1342 ** The sqlite3_config() interface is not threadsafe. The application
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1343 ** must insure that no other SQLite interfaces are invoked by other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1344 ** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1345 ** may only be invoked prior to library initialization using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1346 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1347 ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1348 ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1349 ** Note, however, that ^sqlite3_config() can be called as part of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1350 ** implementation of an application-defined [sqlite3_os_init()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1351 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1352 ** The first argument to sqlite3_config() is an integer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1353 ** [configuration option] that determines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1354 ** what property of SQLite is to be configured. Subsequent arguments
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1355 ** vary depending on the [configuration option]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1356 ** in the first argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1357 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1358 ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1359 ** ^If the option is unknown or SQLite is unable to set the option
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1360 ** then this routine returns a non-zero [error code].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1361 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1362 SQLITE_API int sqlite3_config(int, ...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1363
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1364 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1365 ** CAPI3REF: Configure database connections
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1366 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1367 ** The sqlite3_db_config() interface is used to make configuration
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1368 ** changes to a [database connection]. The interface is similar to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1369 ** [sqlite3_config()] except that the changes apply to a single
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1370 ** [database connection] (specified in the first argument).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1371 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1372 ** The second argument to sqlite3_db_config(D,V,...) is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1373 ** [SQLITE_DBCONFIG_LOOKASIDE \| configuration verb] - an integer code
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1374 ** that indicates what aspect of the [database connection] is being configured.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1375 ** Subsequent arguments vary depending on the configuration verb.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1376 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1377 ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1378 ** the call is considered successful.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1379 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1380 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1381
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1382 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1383 ** CAPI3REF: Memory Allocation Routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1384 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1385 ** An instance of this object defines the interface between SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1386 ** and low-level memory allocation routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1387 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1388 ** This object is used in only one place in the SQLite interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1389 ** A pointer to an instance of this object is the argument to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1390 ** [sqlite3_config()] when the configuration option is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1391 ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1392 ** By creating an instance of this object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1393 ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1394 ** during configuration, an application can specify an alternative
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1395 ** memory allocation subsystem for SQLite to use for all of its
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1396 ** dynamic memory needs.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1397 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1398 ** Note that SQLite comes with several [built-in memory allocators]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1399 ** that are perfectly adequate for the overwhelming majority of applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1400 ** and that this object is only useful to a tiny minority of applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1401 ** with specialized memory allocation requirements. This object is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1402 ** also used during testing of SQLite in order to specify an alternative
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1403 ** memory allocator that simulates memory out-of-memory conditions in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1404 ** order to verify that SQLite recovers gracefully from such
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1405 ** conditions.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1406 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1407 ** The xMalloc, xRealloc, and xFree methods must work like the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1408 ** malloc(), realloc() and free() functions from the standard C library.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1409 ** ^SQLite guarantees that the second argument to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1410 ** xRealloc is always a value returned by a prior call to xRoundup.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1411 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1412 ** xSize should return the allocated size of a memory allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1413 ** previously obtained from xMalloc or xRealloc. The allocated size
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1414 ** is always at least as big as the requested size but may be larger.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1415 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1416 ** The xRoundup method returns what would be the allocated size of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1417 ** a memory allocation given a particular requested size. Most memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1418 ** allocators round up memory allocations at least to the next multiple
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1419 ** of 8. Some allocators round up to a larger multiple or to a power of 2.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1420 ** Every memory allocation request coming in through [sqlite3_malloc()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1421 ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1422 ** that causes the corresponding memory allocation to fail.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1423 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1424 ** The xInit method initializes the memory allocator. For example,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1425 ** it might allocate any require mutexes or initialize internal data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1426 ** structures. The xShutdown method is invoked (indirectly) by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1427 ** [sqlite3_shutdown()] and should deallocate any resources acquired
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1428 ** by xInit. The pAppData pointer is used as the only parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1429 ** xInit and xShutdown.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1430 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1431 ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1432 ** the xInit method, so the xInit method need not be threadsafe. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1433 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1434 ** not need to be threadsafe either. For all other methods, SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1435 ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1436 ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1437 ** it is by default) and so the methods are automatically serialized.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1438 ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1439 ** methods must be threadsafe or else make their own arrangements for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1440 ** serialization.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1441 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1442 ** SQLite will never invoke xInit() more than once without an intervening
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1443 ** call to xShutdown().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1444 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1445 typedef struct sqlite3_mem_methods sqlite3_mem_methods;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1446 struct sqlite3_mem_methods {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1447 void (xMalloc)(int); /* Memory allocation function */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1448 void (xFree)(void); /* Free a prior allocation */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1449 void (xRealloc)(void,int); / Resize an allocation */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1450 int (xSize)(void); /* Return the size of an allocation */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1451 int (xRoundup)(int); / Round up request size to allocation size */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1452 int (xInit)(void); /* Initialize the memory allocator */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1453 void (xShutdown)(void); /* Deinitialize the memory allocator */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1454 void pAppData; / Argument to xInit() and xShutdown() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1455 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1456
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1457 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1458 ** CAPI3REF: Configuration Options
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1459 ** KEYWORDS: {configuration option}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1460 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1461 ** These constants are the available integer configuration options that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1462 ** can be passed as the first argument to the [sqlite3_config()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1463 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1464 ** New configuration options may be added in future releases of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1465 ** Existing configuration options might be discontinued. Applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1466 ** should check the return code from [sqlite3_config()] to make sure that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1467 ** the call worked. The [sqlite3_config()] interface will return a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1468 ** non-zero [error code] if a discontinued or unsupported configuration option
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1469 ** is invoked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1470 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1471 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1472 ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1473 ** <dd>There are no arguments to this option. ^This option sets the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1474 ** [threading mode] to Single-thread. In other words, it disables
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1475 ** all mutexing and puts SQLite into a mode where it can only be used
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1476 ** by a single thread. ^If SQLite is compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1477 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1478 ** it is not possible to change the [threading mode] from its default
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1479 ** value of Single-thread and so [sqlite3_config()] will return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1480 ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1481 ** configuration option.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1482 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1483 ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1484 ** <dd>There are no arguments to this option. ^This option sets the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1485 ** [threading mode] to Multi-thread. In other words, it disables
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1486 ** mutexing on [database connection] and [prepared statement] objects.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1487 ** The application is responsible for serializing access to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1488 ** [database connections] and [prepared statements]. But other mutexes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1489 ** are enabled so that SQLite will be safe to use in a multi-threaded
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1490 ** environment as long as no two threads attempt to use the same
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1491 ** [database connection] at the same time. ^If SQLite is compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1492 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1493 ** it is not possible to set the Multi-thread [threading mode] and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1494 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1495 ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1496 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1497 ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1498 ** <dd>There are no arguments to this option. ^This option sets the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1499 ** [threading mode] to Serialized. In other words, this option enables
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1500 ** all mutexes including the recursive
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1501 ** mutexes on [database connection] and [prepared statement] objects.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1502 ** In this mode (which is the default when SQLite is compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1503 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1504 ** to [database connections] and [prepared statements] so that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1505 ** application is free to use the same [database connection] or the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1506 ** same [prepared statement] in different threads at the same time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1507 ** ^If SQLite is compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1508 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1509 ** it is not possible to set the Serialized [threading mode] and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1510 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1511 ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1512 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1513 ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1514 ** <dd> ^(This option takes a single argument which is a pointer to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1515 ** instance of the [sqlite3_mem_methods] structure. The argument specifies
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1516 ** alternative low-level memory allocation routines to be used in place of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1517 ** the memory allocation routines built into SQLite.)^ ^SQLite makes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1518 ** its own private copy of the content of the [sqlite3_mem_methods] structure
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1519 ** before the [sqlite3_config()] call returns.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1520 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1521 ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1522 ** <dd> ^(This option takes a single argument which is a pointer to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1523 ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1524 ** structure is filled with the currently defined memory allocation routines.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1525 ** This option can be used to overload the default memory allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1526 ** routines with a wrapper that simulations memory allocation failure or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1527 ** tracks memory usage, for example. </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1528 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1529 ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1530 ** <dd> ^This option takes single argument of type int, interpreted as a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1531 ** boolean, which enables or disables the collection of memory allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1532 ** statistics. ^(When memory allocation statistics are disabled, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1533 ** following SQLite interfaces become non-operational:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1534 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1535 ** <li> [sqlite3_memory_used()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1536 ** <li> [sqlite3_memory_highwater()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1537 ** <li> [sqlite3_soft_heap_limit64()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1538 ** <li> [sqlite3_status()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1539 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1540 ** ^Memory allocation statistics are enabled by default unless SQLite is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1541 ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1542 ** allocation statistics are disabled by default.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1543 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1544 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1545 ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1546 ** <dd> ^This option specifies a static memory buffer that SQLite can use for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1547 ** scratch memory. There are three arguments: A pointer an 8-byte
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1548 ** aligned memory buffer from which the scratch allocations will be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1549 ** drawn, the size of each scratch allocation (sz),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1550 ** and the maximum number of scratch allocations (N). The sz
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1551 ** argument must be a multiple of 16.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1552 ** The first argument must be a pointer to an 8-byte aligned buffer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1553 ** of at least sz*N bytes of memory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1554 ** ^SQLite will use no more than two scratch buffers per thread. So
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1555 ** N should be set to twice the expected maximum number of threads.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1556 ** ^SQLite will never require a scratch buffer that is more than 6
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1557 ** times the database page size. ^If SQLite needs needs additional
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1558 ** scratch memory beyond what is provided by this configuration option, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1559 ** [sqlite3_malloc()] will be used to obtain the memory needed.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1560 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1561 ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1562 ** <dd> ^This option specifies a static memory buffer that SQLite can use for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1563 ** the database page cache with the default page cache implementation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1564 ** This configuration should not be used if an application-define page
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1565 ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1566 ** There are three arguments to this option: A pointer to 8-byte aligned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1567 ** memory, the size of each page buffer (sz), and the number of pages (N).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1568 ** The sz argument should be the size of the largest database page
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1569 ** (a power of two between 512 and 32768) plus a little extra for each
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1570 ** page header. ^The page header size is 20 to 40 bytes depending on
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1571 ** the host architecture. ^It is harmless, apart from the wasted memory,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1572 ** to make sz a little too large. The first
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1573 ** argument should point to an allocation of at least sz*N bytes of memory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1574 ** ^SQLite will use the memory provided by the first argument to satisfy its
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1575 ** memory needs for the first N pages that it adds to cache. ^If additional
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1576 ** page cache memory is needed beyond what is provided by this option, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1577 ** SQLite goes to [sqlite3_malloc()] for the additional storage space.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1578 ** The pointer in the first argument must
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1579 ** be aligned to an 8-byte boundary or subsequent behavior of SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1580 ** will be undefined.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1581 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1582 ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1583 ** <dd> ^This option specifies a static memory buffer that SQLite will use
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1584 ** for all of its dynamic memory allocation needs beyond those provided
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1585 ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1586 ** There are three arguments: An 8-byte aligned pointer to the memory,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1587 ** the number of bytes in the memory buffer, and the minimum allocation size.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1588 ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1589 ** to using its default memory allocator (the system malloc() implementation),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1590 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1591 ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1592 ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1593 ** allocator is engaged to handle all of SQLites memory allocation needs.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1594 ** The first pointer (the memory pointer) must be aligned to an 8-byte
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1595 ** boundary or subsequent behavior of SQLite will be undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1596 The minimum allocation size is capped at 212. Reasonable values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1597 for the minimum allocation size are 25 through 2**8.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1598 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1599 ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1600 ** <dd> ^(This option takes a single argument which is a pointer to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1601 ** instance of the [sqlite3_mutex_methods] structure. The argument specifies
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1602 ** alternative low-level mutex routines to be used in place
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1603 ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1604 ** content of the [sqlite3_mutex_methods] structure before the call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1605 ** [sqlite3_config()] returns. ^If SQLite is compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1606 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1607 ** the entire mutexing subsystem is omitted from the build and hence calls to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1608 ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1609 ** return [SQLITE_ERROR].</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1610 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1611 ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1612 ** <dd> ^(This option takes a single argument which is a pointer to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1613 ** instance of the [sqlite3_mutex_methods] structure. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1614 ** [sqlite3_mutex_methods]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1615 ** structure is filled with the currently defined mutex routines.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1616 ** This option can be used to overload the default mutex allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1617 ** routines with a wrapper used to track mutex usage for performance
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1618 ** profiling or testing, for example. ^If SQLite is compiled with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1619 ** the [SQLITE_THREADSAFE \| SQLITE_THREADSAFE=0] compile-time option then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1620 ** the entire mutexing subsystem is omitted from the build and hence calls to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1621 ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1622 ** return [SQLITE_ERROR].</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1623 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1624 ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1625 ** <dd> ^(This option takes two arguments that determine the default
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1626 ** memory allocation for the lookaside memory allocator on each
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1627 ** [database connection]. The first argument is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1628 ** size of each lookaside buffer slot and the second is the number of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1629 ** slots allocated to each database connection.)^ ^(This option sets the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1630 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1631 ** verb to [sqlite3_db_config()] can be used to change the lookaside
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1632 ** configuration on individual connections.)^ </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1633 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1634 ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1635 ** <dd> ^(This option takes a single argument which is a pointer to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1636 ** an [sqlite3_pcache_methods2] object. This object specifies the interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1637 ** to a custom page cache implementation.)^ ^SQLite makes a copy of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1638 ** object and uses it for page cache memory allocations.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1639 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1640 ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1641 ** <dd> ^(This option takes a single argument which is a pointer to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1642 ** [sqlite3_pcache_methods2] object. SQLite copies of the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1643 ** page cache implementation into that object.)^ </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1644 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1645 ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1646 ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1647 ** global [error log].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1648 ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1649 ** function with a call signature of void()(void,int,const char*),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1650 ** and a pointer to void. ^If the function pointer is not NULL, it is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1651 ** invoked by [sqlite3_log()] to process each logging event. ^If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1652 ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1653 ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1654 ** passed through as the first parameter to the application-defined logger
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1655 ** function whenever that function is invoked. ^The second parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1656 ** the logger function is a copy of the first parameter to the corresponding
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1657 ** [sqlite3_log()] call and is intended to be a [result code] or an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1658 ** [extended result code]. ^The third parameter passed to the logger is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1659 ** log message after formatting via [sqlite3_snprintf()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1660 ** The SQLite logging interface is not reentrant; the logger function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1661 ** supplied by the application must not invoke any SQLite interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1662 ** In a multi-threaded application, the application-defined logger
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1663 ** function must be threadsafe. </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1664 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1665 ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1666 ** <dd>^(This option takes a single argument of type int. If non-zero, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1667 ** URI handling is globally enabled. If the parameter is zero, then URI handling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1668 ** is globally disabled.)^ ^If URI handling is globally enabled, all filenames
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1669 ** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1670 ** specified as part of [ATTACH] commands are interpreted as URIs, regardless
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1671 ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1672 ** connection is opened. ^If it is globally disabled, filenames are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1673 ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1674 ** database connection is opened. ^(By default, URI handling is globally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1675 ** disabled. The default value may be changed by compiling with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1676 ** [SQLITE_USE_URI] symbol defined.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1677 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1678 ** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1679 ** <dd>^This option takes a single integer argument which is interpreted as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1680 ** a boolean in order to enable or disable the use of covering indices for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1681 ** full table scans in the query optimizer. ^The default setting is determined
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1682 ** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1683 ** if that compile-time option is omitted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1684 ** The ability to disable the use of covering indices for full table scans
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1685 ** is because some incorrectly coded legacy applications might malfunction
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1686 ** when the optimization is enabled. Providing the ability to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1687 ** disable the optimization allows the older, buggy application code to work
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1688 ** without change even with newer versions of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1689 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1690 ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1691 ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1692 ** <dd> These options are obsolete and should not be used by new code.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1693 ** They are retained for backwards compatibility but are now no-ops.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1694 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1695 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1696 ** [[SQLITE_CONFIG_SQLLOG]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1697 ** <dt>SQLITE_CONFIG_SQLLOG
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1698 ** <dd>This option is only available if sqlite is compiled with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1699 ** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1700 ** be a pointer to a function of type void()(void,sqlite3,const char, int).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1701 ** The second should be of type (void*). The callback is invoked by the library
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1702 ** in three separate circumstances, identified by the value passed as the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1703 ** fourth parameter. If the fourth parameter is 0, then the database connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1704 ** passed as the second argument has just been opened. The third argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1705 ** points to a buffer containing the name of the main database file. If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1706 ** fourth parameter is 1, then the SQL statement that the third parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1707 ** points to has just been executed. Or, if the fourth parameter is 2, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1708 ** the connection being passed as the second parameter is being closed. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1709 ** third parameter is passed NULL In this case. An example of using this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1710 ** configuration option can be seen in the "test_sqllog.c" source file in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1711 ** the canonical SQLite source tree.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1712 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1713 ** [[SQLITE_CONFIG_MMAP_SIZE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1714 ** <dt>SQLITE_CONFIG_MMAP_SIZE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1715 ** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1716 ** that are the default mmap size limit (the default setting for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1717 ** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1718 ** ^The default setting can be overridden by each database connection using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1719 ** either the [PRAGMA mmap_size] command, or by using the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1720 ** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1721 ** cannot be changed at run-time. Nor may the maximum allowed mmap size
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1722 ** exceed the compile-time maximum mmap size set by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1723 ** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1724 ** ^If either argument to this option is negative, then that argument is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1725 ** changed to its compile-time default.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1726 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1727 ** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1728 ** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1729 ** <dd>^This option is only available if SQLite is compiled for Windows
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1730 ** with the [SQLITE_WIN32_MALLOC] pre-processor macro defined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1731 ** SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1732 ** that specifies the maximum size of the created heap.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1733 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1734 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1735 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1736 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1737 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1738 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1739 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1740 #define SQLITE_CONFIG_SCRATCH 6 /* void, int sz, int N /
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1741 #define SQLITE_CONFIG_PAGECACHE 7 /* void, int sz, int N /
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1742 #define SQLITE_CONFIG_HEAP 8 /* void, int nByte, int min /
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1743 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1744 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1745 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1746 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1747 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1748 #define SQLITE_CONFIG_PCACHE 14 /* no-op */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1749 #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1750 #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1751 #define SQLITE_CONFIG_URI 17 /* int */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1752 #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1753 #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1754 #define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1755 #define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1756 #define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1757 #define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1758
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1759 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1760 ** CAPI3REF: Database Connection Configuration Options
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1761 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1762 ** These constants are the available integer configuration options that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1763 ** can be passed as the second argument to the [sqlite3_db_config()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1764 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1765 ** New configuration options may be added in future releases of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1766 ** Existing configuration options might be discontinued. Applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1767 ** should check the return code from [sqlite3_db_config()] to make sure that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1768 ** the call worked. ^The [sqlite3_db_config()] interface will return a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1769 ** non-zero [error code] if a discontinued or unsupported configuration option
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1770 ** is invoked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1771 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1772 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1773 ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1774 ** <dd> ^This option takes three additional arguments that determine the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1775 ** [lookaside memory allocator] configuration for the [database connection].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1776 ** ^The first argument (the third parameter to [sqlite3_db_config()] is a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1777 ** pointer to a memory buffer to use for lookaside memory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1778 ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1779 ** may be NULL in which case SQLite will allocate the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1780 ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1781 ** size of each lookaside buffer slot. ^The third argument is the number of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1782 ** slots. The size of the buffer in the first argument must be greater than
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1783 ** or equal to the product of the second and third arguments. The buffer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1784 ** must be aligned to an 8-byte boundary. ^If the second argument to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1785 ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1786 ** rounded down to the next smaller multiple of 8. ^(The lookaside memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1787 ** configuration for a database connection can only be changed when that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1788 ** connection is not currently using lookaside memory, or in other words
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1789 ** when the "current value" returned by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1790 ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1791 ** Any attempt to change the lookaside memory configuration when lookaside
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1792 ** memory is in use leaves the configuration unchanged and returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1793 ** [SQLITE_BUSY].)^</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1794 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1795 ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1796 ** <dd> ^This option is used to enable or disable the enforcement of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1797 ** [foreign key constraints]. There should be two additional arguments.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1798 ** The first argument is an integer which is 0 to disable FK enforcement,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1799 ** positive to enable FK enforcement or negative to leave FK enforcement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1800 ** unchanged. The second parameter is a pointer to an integer into which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1801 ** is written 0 or 1 to indicate whether FK enforcement is off or on
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1802 ** following this call. The second parameter may be a NULL pointer, in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1803 ** which case the FK enforcement setting is not reported back. </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1804 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1805 ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1806 ** <dd> ^This option is used to enable or disable [CREATE TRIGGER \| triggers].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1807 ** There should be two additional arguments.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1808 ** The first argument is an integer which is 0 to disable triggers,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1809 ** positive to enable triggers or negative to leave the setting unchanged.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1810 ** The second parameter is a pointer to an integer into which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1811 ** is written 0 or 1 to indicate whether triggers are disabled or enabled
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1812 ** following this call. The second parameter may be a NULL pointer, in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1813 ** which case the trigger setting is not reported back. </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1814 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1815 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1816 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1817 #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1818 #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1819 #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1820
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1821
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1822 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1823 ** CAPI3REF: Enable Or Disable Extended Result Codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1824 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1825 ** ^The sqlite3_extended_result_codes() routine enables or disables the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1826 ** [extended result codes] feature of SQLite. ^The extended result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1827 ** codes are disabled by default for historical compatibility.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1828 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1829 SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1830
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1831 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1832 ** CAPI3REF: Last Insert Rowid
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1833 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1834 ** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1835 ** has a unique 64-bit signed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1836 ** integer key called the [ROWID \| "rowid"]. ^The rowid is always available
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1837 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1838 ** names are not also used by explicitly declared columns. ^If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1839 ** the table has a column of type [INTEGER PRIMARY KEY] then that column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1840 ** is another alias for the rowid.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1841 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1842 ** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1843 ** most recent successful [INSERT] into a rowid table or [virtual table]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1844 ** on database connection D.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1845 ** ^Inserts into [WITHOUT ROWID] tables are not recorded.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1846 ** ^If no successful [INSERT]s into rowid tables
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1847 ** have ever occurred on the database connection D,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1848 ** then sqlite3_last_insert_rowid(D) returns zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1849 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1850 ** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1851 ** method, then this routine will return the [rowid] of the inserted
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1852 ** row as long as the trigger or virtual table method is running.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1853 ** But once the trigger or virtual table method ends, the value returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1854 ** by this routine reverts to what it was before the trigger or virtual
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1855 ** table method began.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1856 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1857 ** ^An [INSERT] that fails due to a constraint violation is not a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1858 ** successful [INSERT] and does not change the value returned by this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1859 ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1860 ** and INSERT OR ABORT make no changes to the return value of this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1861 ** routine when their insertion fails. ^(When INSERT OR REPLACE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1862 ** encounters a constraint violation, it does not fail. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1863 ** INSERT continues to completion after deleting rows that caused
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1864 ** the constraint problem so INSERT OR REPLACE will always change
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1865 ** the return value of this interface.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1866 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1867 ** ^For the purposes of this routine, an [INSERT] is considered to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1868 ** be successful even if it is subsequently rolled back.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1869 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1870 ** This function is accessible to SQL statements via the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1871 ** [last_insert_rowid() SQL function].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1872 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1873 ** If a separate thread performs a new [INSERT] on the same
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1874 ** database connection while the [sqlite3_last_insert_rowid()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1875 ** function is running and thus changes the last insert [rowid],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1876 ** then the value returned by [sqlite3_last_insert_rowid()] is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1877 ** unpredictable and might not equal either the old or the new
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1878 ** last insert [rowid].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1879 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1880 SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1881
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1882 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1883 ** CAPI3REF: Count The Number Of Rows Modified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1884 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1885 ** ^This function returns the number of database rows that were changed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1886 ** or inserted or deleted by the most recently completed SQL statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1887 ** on the [database connection] specified by the first parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1888 ** ^(Only changes that are directly specified by the [INSERT], [UPDATE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1889 ** or [DELETE] statement are counted. Auxiliary changes caused by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1890 ** triggers or [foreign key actions] are not counted.)^ Use the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1891 ** [sqlite3_total_changes()] function to find the total number of changes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1892 ** including changes caused by triggers and foreign key actions.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1893 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1894 ** ^Changes to a view that are simulated by an [INSTEAD OF trigger]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1895 ** are not counted. Only real table changes are counted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1896 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1897 ** ^(A "row change" is a change to a single row of a single table
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1898 ** caused by an INSERT, DELETE, or UPDATE statement. Rows that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1899 ** are changed as side effects of [REPLACE] constraint resolution,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1900 ** rollback, ABORT processing, [DROP TABLE], or by any other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1901 ** mechanisms do not count as direct row changes.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1902 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1903 ** A "trigger context" is a scope of execution that begins and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1904 ** ends with the script of a [CREATE TRIGGER \| trigger].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1905 ** Most SQL statements are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1906 ** evaluated outside of any trigger. This is the "top level"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1907 ** trigger context. If a trigger fires from the top level, a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1908 ** new trigger context is entered for the duration of that one
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1909 ** trigger. Subtriggers create subcontexts for their duration.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1910 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1911 ** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1912 ** not create a new trigger context.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1913 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1914 ** ^This function returns the number of direct row changes in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1915 ** most recent INSERT, UPDATE, or DELETE statement within the same
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1916 ** trigger context.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1917 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1918 ** ^Thus, when called from the top level, this function returns the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1919 ** number of changes in the most recent INSERT, UPDATE, or DELETE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1920 ** that also occurred at the top level. ^(Within the body of a trigger,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1921 ** the sqlite3_changes() interface can be called to find the number of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1922 ** changes in the most recently completed INSERT, UPDATE, or DELETE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1923 ** statement within the body of the same trigger.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1924 ** However, the number returned does not include changes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1925 ** caused by subtriggers since those have their own context.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1926 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1927 ** See also the [sqlite3_total_changes()] interface, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1928 ** [count_changes pragma], and the [changes() SQL function].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1929 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1930 ** If a separate thread makes changes on the same database connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1931 ** while [sqlite3_changes()] is running then the value returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1932 ** is unpredictable and not meaningful.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1933 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1934 SQLITE_API int sqlite3_changes(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1935
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1936 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1937 ** CAPI3REF: Total Number Of Rows Modified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1938 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1939 ** ^This function returns the number of row changes caused by [INSERT],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1940 ** [UPDATE] or [DELETE] statements since the [database connection] was opened.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1941 ** ^(The count returned by sqlite3_total_changes() includes all changes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1942 ** from all [CREATE TRIGGER \| trigger] contexts and changes made by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1943 ** [foreign key actions]. However,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1944 ** the count does not include changes used to implement [REPLACE] constraints,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1945 ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1946 ** count does not include rows of views that fire an [INSTEAD OF trigger],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1947 ** though if the INSTEAD OF trigger makes changes of its own, those changes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1948 ** are counted.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1949 ** ^The sqlite3_total_changes() function counts the changes as soon as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1950 ** the statement that makes them is completed (when the statement handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1951 ** is passed to [sqlite3_reset()] or [sqlite3_finalize()]).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1952 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1953 ** See also the [sqlite3_changes()] interface, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1954 ** [count_changes pragma], and the [total_changes() SQL function].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1955 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1956 ** If a separate thread makes changes on the same database connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1957 ** while [sqlite3_total_changes()] is running then the value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1958 ** returned is unpredictable and not meaningful.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1959 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1960 SQLITE_API int sqlite3_total_changes(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1961
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1962 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1963 ** CAPI3REF: Interrupt A Long-Running Query
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1964 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1965 ** ^This function causes any pending database operation to abort and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1966 ** return at its earliest opportunity. This routine is typically
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1967 ** called in response to a user action such as pressing "Cancel"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1968 ** or Ctrl-C where the user wants a long query operation to halt
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1969 ** immediately.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1970 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1971 ** ^It is safe to call this routine from a thread different from the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1972 ** thread that is currently running the database operation. But it
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1973 ** is not safe to call this routine with a [database connection] that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1974 ** is closed or might close before sqlite3_interrupt() returns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1975 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1976 ** ^If an SQL operation is very nearly finished at the time when
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1977 ** sqlite3_interrupt() is called, then it might not have an opportunity
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1978 ** to be interrupted and might continue to completion.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1979 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1980 ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1981 ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1982 ** that is inside an explicit transaction, then the entire transaction
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1983 ** will be rolled back automatically.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1984 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1985 ** ^The sqlite3_interrupt(D) call is in effect until all currently running
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1986 ** SQL statements on [database connection] D complete. ^Any new SQL statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1987 ** that are started after the sqlite3_interrupt() call and before the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1988 ** running statements reaches zero are interrupted as if they had been
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1989 ** running prior to the sqlite3_interrupt() call. ^New SQL statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1990 ** that are started after the running statement count reaches zero are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1991 ** not effected by the sqlite3_interrupt().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1992 ** ^A call to sqlite3_interrupt(D) that occurs when there are no running
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1993 ** SQL statements is a no-op and has no effect on SQL statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1994 ** that are started after the sqlite3_interrupt() call returns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1995 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1996 ** If the database connection closes while [sqlite3_interrupt()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1997 ** is running then bad things will likely happen.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1998 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1999 SQLITE_API void sqlite3_interrupt(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2000
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2001 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2002 ** CAPI3REF: Determine If An SQL Statement Is Complete
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2003 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2004 ** These routines are useful during command-line input to determine if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2005 ** currently entered text seems to form a complete SQL statement or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2006 ** if additional input is needed before sending the text into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2007 ** SQLite for parsing. ^These routines return 1 if the input string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2008 ** appears to be a complete SQL statement. ^A statement is judged to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2009 ** complete if it ends with a semicolon token and is not a prefix of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2010 ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2011 ** string literals or quoted identifier names or comments are not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2012 ** independent tokens (they are part of the token in which they are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2013 ** embedded) and thus do not count as a statement terminator. ^Whitespace
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2014 ** and comments that follow the final semicolon are ignored.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2015 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2016 ** ^These routines return 0 if the statement is incomplete. ^If a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2017 ** memory allocation fails, then SQLITE_NOMEM is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2018 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2019 ** ^These routines do not parse the SQL statements thus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2020 ** will not detect syntactically incorrect SQL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2021 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2022 ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2023 ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2024 ** automatically by sqlite3_complete16(). If that initialization fails,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2025 ** then the return value from sqlite3_complete16() will be non-zero
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2026 ** regardless of whether or not the input SQL is complete.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2027 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2028 ** The input to [sqlite3_complete()] must be a zero-terminated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2029 ** UTF-8 string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2030 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2031 ** The input to [sqlite3_complete16()] must be a zero-terminated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2032 ** UTF-16 string in native byte order.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2033 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2034 SQLITE_API int sqlite3_complete(const char *sql);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2035 SQLITE_API int sqlite3_complete16(const void *sql);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2036
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2037 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2038 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2039 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2040 ** ^This routine sets a callback function that might be invoked whenever
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2041 ** an attempt is made to open a database table that another thread
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2042 ** or process has locked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2043 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2044 ** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2045 ** is returned immediately upon encountering the lock. ^If the busy callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2046 ** is not NULL, then the callback might be invoked with two arguments.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2047 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2048 ** ^The first argument to the busy handler is a copy of the void* pointer which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2049 ** is the third argument to sqlite3_busy_handler(). ^The second argument to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2050 ** the busy handler callback is the number of times that the busy handler has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2051 ** been invoked for this locking event. ^If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2052 ** busy callback returns 0, then no additional attempts are made to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2053 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2054 ** ^If the callback returns non-zero, then another attempt
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2055 ** is made to open the database for reading and the cycle repeats.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2056 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2057 ** The presence of a busy handler does not guarantee that it will be invoked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2058 ** when there is lock contention. ^If SQLite determines that invoking the busy
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2059 ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2060 ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2061 ** Consider a scenario where one process is holding a read lock that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2062 ** it is trying to promote to a reserved lock and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2063 ** a second process is holding a reserved lock that it is trying
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2064 ** to promote to an exclusive lock. The first process cannot proceed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2065 ** because it is blocked by the second and the second process cannot
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2066 ** proceed because it is blocked by the first. If both processes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2067 ** invoke the busy handlers, neither will make any progress. Therefore,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2068 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2069 ** will induce the first process to release its read lock and allow
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2070 ** the second process to proceed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2071 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2072 ** ^The default busy callback is NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2073 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2074 ** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2075 ** when SQLite is in the middle of a large transaction where all the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2076 ** changes will not fit into the in-memory cache. SQLite will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2077 ** already hold a RESERVED lock on the database file, but it needs
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2078 ** to promote this lock to EXCLUSIVE so that it can spill cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2079 ** pages into the database file without harm to concurrent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2080 ** readers. ^If it is unable to promote the lock, then the in-memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2081 ** cache will be left in an inconsistent state and so the error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2082 ** code is promoted from the relatively benign [SQLITE_BUSY] to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2083 ** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2084 ** forces an automatic rollback of the changes. See the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2085 ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2086 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2087 ** this is important.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2088 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2089 ** ^(There can only be a single busy handler defined for each
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2090 ** [database connection]. Setting a new busy handler clears any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2091 ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2092 ** will also set or clear the busy handler.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2093 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2094 ** The busy callback should not take any actions which modify the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2095 ** database connection that invoked the busy handler. Any such actions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2096 ** result in undefined behavior.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2097 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2098 ** A busy handler must not close the database connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2099 ** or [prepared statement] that invoked the busy handler.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2100 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2101 SQLITE_API int sqlite3_busy_handler(sqlite3, int()(void,int), void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2102
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2103 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2104 ** CAPI3REF: Set A Busy Timeout
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2105 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2106 ** ^This routine sets a [sqlite3_busy_handler \| busy handler] that sleeps
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2107 ** for a specified amount of time when a table is locked. ^The handler
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2108 ** will sleep multiple times until at least "ms" milliseconds of sleeping
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2109 ** have accumulated. ^After at least "ms" milliseconds of sleeping,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2110 ** the handler returns 0 which causes [sqlite3_step()] to return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2111 ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2112 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2113 ** ^Calling this routine with an argument less than or equal to zero
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2114 ** turns off all busy handlers.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2115 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2116 ** ^(There can only be a single busy handler for a particular
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2117 ** [database connection] any any given moment. If another busy handler
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2118 ** was defined (using [sqlite3_busy_handler()]) prior to calling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2119 ** this routine, that other busy handler is cleared.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2120 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2121 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2122
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2123 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2124 ** CAPI3REF: Convenience Routines For Running Queries
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2125 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2126 ** This is a legacy interface that is preserved for backwards compatibility.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2127 ** Use of this interface is not recommended.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2128 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2129 ** Definition: A <b>result table</b> is memory data structure created by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2130 ** [sqlite3_get_table()] interface. A result table records the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2131 ** complete query results from one or more queries.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2132 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2133 ** The table conceptually has a number of rows and columns. But
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2134 ** these numbers are not part of the result table itself. These
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2135 ** numbers are obtained separately. Let N be the number of rows
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2136 ** and M be the number of columns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2137 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2138 ** A result table is an array of pointers to zero-terminated UTF-8 strings.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2139 ** There are (N+1)*M elements in the array. The first M pointers point
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2140 ** to zero-terminated strings that contain the names of the columns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2141 ** The remaining entries all point to query results. NULL values result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2142 ** in NULL pointers. All other values are in their UTF-8 zero-terminated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2143 ** string representation as returned by [sqlite3_column_text()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2144 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2145 ** A result table might consist of one or more memory allocations.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2146 ** It is not safe to pass a result table directly to [sqlite3_free()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2147 ** A result table should be deallocated using [sqlite3_free_table()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2148 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2149 ** ^(As an example of the result table format, suppose a query result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2150 ** is as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2151 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2152 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2153 ** Name \| Age
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2154 ** -----------------------
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2155 ** Alice \| 43
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2156 ** Bob \| 28
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2157 ** Cindy \| 21
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2158 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2159 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2160 ** There are two column (M==2) and three rows (N==3). Thus the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2161 ** result table has 8 entries. Suppose the result table is stored
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2162 ** in an array names azResult. Then azResult holds this content:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2163 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2164 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2165 ** azResult[0] = "Name";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2166 ** azResult[1] = "Age";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2167 ** azResult[2] = "Alice";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2168 ** azResult[3] = "43";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2169 ** azResult[4] = "Bob";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2170 ** azResult[5] = "28";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2171 ** azResult[6] = "Cindy";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2172 ** azResult[7] = "21";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2173 ** </pre></blockquote>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2174 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2175 ** ^The sqlite3_get_table() function evaluates one or more
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2176 ** semicolon-separated SQL statements in the zero-terminated UTF-8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2177 ** string of its 2nd parameter and returns a result table to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2178 ** pointer given in its 3rd parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2179 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2180 ** After the application has finished with the result from sqlite3_get_table(),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2181 ** it must pass the result table pointer to sqlite3_free_table() in order to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2182 ** release the memory that was malloced. Because of the way the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2183 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2184 ** function must not try to call [sqlite3_free()] directly. Only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2185 ** [sqlite3_free_table()] is able to release the memory properly and safely.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2186 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2187 ** The sqlite3_get_table() interface is implemented as a wrapper around
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2188 ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2189 ** to any internal data structures of SQLite. It uses only the public
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2190 ** interface defined here. As a consequence, errors that occur in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2191 ** wrapper layer outside of the internal [sqlite3_exec()] call are not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2192 ** reflected in subsequent calls to [sqlite3_errcode()] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2193 ** [sqlite3_errmsg()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2194 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2195 SQLITE_API int sqlite3_get_table(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2196 sqlite3 db, / An open database */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2197 const char zSql, / SQL to be evaluated */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2198 char **pazResult, / Results of the query */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2199 int pnRow, / Number of result rows written here */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2200 int pnColumn, / Number of result columns written here */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2201 char *pzErrmsg / Error msg written here */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2202 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2203 SQLITE_API void sqlite3_free_table(char **result);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2204
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2205 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2206 ** CAPI3REF: Formatted String Printing Functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2207 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2208 ** These routines are work-alikes of the "printf()" family of functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2209 ** from the standard C library.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2210 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2211 ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2212 ** results into memory obtained from [sqlite3_malloc()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2213 ** The strings returned by these two routines should be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2214 ** released by [sqlite3_free()]. ^Both routines return a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2215 ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2216 ** memory to hold the resulting string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2217 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2218 ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2219 ** the standard C library. The result is written into the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2220 ** buffer supplied as the second parameter whose size is given by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2221 ** the first parameter. Note that the order of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2222 ** first two parameters is reversed from snprintf().)^ This is an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2223 ** historical accident that cannot be fixed without breaking
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2224 ** backwards compatibility. ^(Note also that sqlite3_snprintf()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2225 ** returns a pointer to its buffer instead of the number of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2226 ** characters actually written into the buffer.)^ We admit that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2227 ** the number of characters written would be a more useful return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2228 ** value but we cannot change the implementation of sqlite3_snprintf()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2229 ** now without breaking compatibility.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2230 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2231 ** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2232 ** guarantees that the buffer is always zero-terminated. ^The first
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2233 ** parameter "n" is the total size of the buffer, including space for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2234 ** the zero terminator. So the longest string that can be completely
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2235 ** written will be n-1 characters.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2236 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2237 ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2238 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2239 ** These routines all implement some additional formatting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2240 ** options that are useful for constructing SQL statements.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2241 ** All of the usual printf() formatting options apply. In addition, there
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2242 ** is are "%q", "%Q", and "%z" options.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2243 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2244 ** ^(The %q option works like %s in that it substitutes a nul-terminated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2245 ** string from the argument list. But %q also doubles every '\'' character.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2246 ** %q is designed for use inside a string literal.)^ By doubling each '\''
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2247 ** character it escapes that character and allows it to be inserted into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2248 ** the string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2249 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2250 ** For example, assume the string variable zText contains text as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2251 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2252 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2253 ** char *zText = "It's a happy day!";
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2254 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2255 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2256 ** One can use this text in an SQL statement as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2257 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2258 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2259 ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2260 ** sqlite3_exec(db, zSQL, 0, 0, 0);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2261 ** sqlite3_free(zSQL);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2262 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2263 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2264 ** Because the %q format string is used, the '\'' character in zText
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2265 ** is escaped and the SQL generated is as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2266 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2267 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2268 ** INSERT INTO table1 VALUES('It''s a happy day!')
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2269 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2270 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2271 ** This is correct. Had we used %s instead of %q, the generated SQL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2272 ** would have looked like this:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2273 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2274 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2275 ** INSERT INTO table1 VALUES('It's a happy day!');
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2276 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2277 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2278 ** This second example is an SQL syntax error. As a general rule you should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2279 ** always use %q instead of %s when inserting text into a string literal.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2280 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2281 ** ^(The %Q option works like %q except it also adds single quotes around
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2282 ** the outside of the total string. Additionally, if the parameter in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2283 ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2284 ** single quotes).)^ So, for example, one could say:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2285 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2286 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2287 ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2288 ** sqlite3_exec(db, zSQL, 0, 0, 0);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2289 ** sqlite3_free(zSQL);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2290 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2291 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2292 ** The code above will render a correct SQL statement in the zSQL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2293 ** variable even if the zText variable is a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2294 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2295 ** ^(The "%z" formatting option works like "%s" but with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2296 ** addition that after the string has been read and copied into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2297 ** the result, [sqlite3_free()] is called on the input string.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2298 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2299 SQLITE_API char sqlite3_mprintf(const char,...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2300 SQLITE_API char sqlite3_vmprintf(const char, va_list);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2301 SQLITE_API char sqlite3_snprintf(int,char,const char*, ...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2302 SQLITE_API char sqlite3_vsnprintf(int,char,const char*, va_list);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2303
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2304 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2305 ** CAPI3REF: Memory Allocation Subsystem
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2306 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2307 ** The SQLite core uses these three routines for all of its own
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2308 ** internal memory allocation needs. "Core" in the previous sentence
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2309 ** does not include operating-system specific VFS implementation. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2310 ** Windows VFS uses native malloc() and free() for some operations.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2311 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2312 ** ^The sqlite3_malloc() routine returns a pointer to a block
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2313 ** of memory at least N bytes in length, where N is the parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2314 ** ^If sqlite3_malloc() is unable to obtain sufficient free
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2315 ** memory, it returns a NULL pointer. ^If the parameter N to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2316 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2317 ** a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2318 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2319 ** ^Calling sqlite3_free() with a pointer previously returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2320 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2321 ** that it might be reused. ^The sqlite3_free() routine is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2322 ** a no-op if is called with a NULL pointer. Passing a NULL pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2323 ** to sqlite3_free() is harmless. After being freed, memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2324 ** should neither be read nor written. Even reading previously freed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2325 ** memory might result in a segmentation fault or other severe error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2326 ** Memory corruption, a segmentation fault, or other severe error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2327 ** might result if sqlite3_free() is called with a non-NULL pointer that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2328 ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2329 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2330 ** ^(The sqlite3_realloc() interface attempts to resize a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2331 ** prior memory allocation to be at least N bytes, where N is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2332 ** second parameter. The memory allocation to be resized is the first
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2333 ** parameter.)^ ^ If the first parameter to sqlite3_realloc()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2334 ** is a NULL pointer then its behavior is identical to calling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2335 ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2336 ** ^If the second parameter to sqlite3_realloc() is zero or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2337 ** negative then the behavior is exactly the same as calling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2338 ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2339 ** ^sqlite3_realloc() returns a pointer to a memory allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2340 ** of at least N bytes in size or NULL if sufficient memory is unavailable.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2341 ** ^If M is the size of the prior allocation, then min(N,M) bytes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2342 ** of the prior allocation are copied into the beginning of buffer returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2343 ** by sqlite3_realloc() and the prior allocation is freed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2344 ** ^If sqlite3_realloc() returns NULL, then the prior allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2345 ** is not freed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2346 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2347 ** ^The memory returned by sqlite3_malloc() and sqlite3_realloc()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2348 ** is always aligned to at least an 8 byte boundary, or to a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2349 ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2350 ** option is used.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2351 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2352 ** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2353 ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2354 ** implementation of these routines to be omitted. That capability
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2355 ** is no longer provided. Only built-in memory allocators can be used.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2356 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2357 ** Prior to SQLite version 3.7.10, the Windows OS interface layer called
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2358 ** the system malloc() and free() directly when converting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2359 ** filenames between the UTF-8 encoding used by SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2360 ** and whatever filename encoding is used by the particular Windows
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2361 ** installation. Memory allocation errors were detected, but
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2362 ** they were reported back as [SQLITE_CANTOPEN] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2363 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2364 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2365 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2366 ** must be either NULL or else pointers obtained from a prior
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2367 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2368 ** not yet been released.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2369 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2370 ** The application must not read or write any part of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2371 ** a block of memory after it has been released using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2372 ** [sqlite3_free()] or [sqlite3_realloc()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2373 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2374 SQLITE_API void *sqlite3_malloc(int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2375 SQLITE_API void sqlite3_realloc(void, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2376 SQLITE_API void sqlite3_free(void*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2377
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2378 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2379 ** CAPI3REF: Memory Allocator Statistics
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2380 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2381 ** SQLite provides these two interfaces for reporting on the status
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2382 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2383 ** routines, which form the built-in memory allocation subsystem.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2384 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2385 ** ^The [sqlite3_memory_used()] routine returns the number of bytes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2386 ** of memory currently outstanding (malloced but not freed).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2387 ** ^The [sqlite3_memory_highwater()] routine returns the maximum
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2388 ** value of [sqlite3_memory_used()] since the high-water mark
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2389 ** was last reset. ^The values returned by [sqlite3_memory_used()] and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2390 ** [sqlite3_memory_highwater()] include any overhead
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2391 ** added by SQLite in its implementation of [sqlite3_malloc()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2392 ** but not overhead added by the any underlying system library
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2393 ** routines that [sqlite3_malloc()] may call.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2394 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2395 ** ^The memory high-water mark is reset to the current value of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2396 ** [sqlite3_memory_used()] if and only if the parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2397 ** [sqlite3_memory_highwater()] is true. ^The value returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2398 ** by [sqlite3_memory_highwater(1)] is the high-water mark
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2399 ** prior to the reset.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2400 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2401 SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2402 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2403
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2404 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2405 ** CAPI3REF: Pseudo-Random Number Generator
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2406 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2407 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2408 ** select random [ROWID \| ROWIDs] when inserting new records into a table that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2409 ** already uses the largest possible [ROWID]. The PRNG is also used for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2410 ** the build-in random() and randomblob() SQL functions. This interface allows
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2411 ** applications to access the same PRNG for other purposes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2412 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2413 ** ^A call to this routine stores N bytes of randomness into buffer P.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2414 ** ^If N is less than one, then P can be a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2415 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2416 ** ^If this routine has not been previously called or if the previous
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2417 ** call had N less than one, then the PRNG is seeded using randomness
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2418 ** obtained from the xRandomness method of the default [sqlite3_vfs] object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2419 ** ^If the previous call to this routine had an N of 1 or more then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2420 ** the pseudo-randomness is generated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2421 ** internally and without recourse to the [sqlite3_vfs] xRandomness
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2422 ** method.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2423 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2424 SQLITE_API void sqlite3_randomness(int N, void *P);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2425
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2426 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2427 ** CAPI3REF: Compile-Time Authorization Callbacks
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2428 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2429 ** ^This routine registers an authorizer callback with a particular
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2430 ** [database connection], supplied in the first argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2431 ** ^The authorizer callback is invoked as SQL statements are being compiled
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2432 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2433 ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2434 ** points during the compilation process, as logic is being created
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2435 ** to perform various actions, the authorizer callback is invoked to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2436 ** see if those actions are allowed. ^The authorizer callback should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2437 ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2438 ** specific action but allow the SQL statement to continue to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2439 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2440 ** rejected with an error. ^If the authorizer callback returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2441 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2442 ** then the [sqlite3_prepare_v2()] or equivalent call that triggered
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2443 ** the authorizer will fail with an error message.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2444 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2445 ** When the callback returns [SQLITE_OK], that means the operation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2446 ** requested is ok. ^When the callback returns [SQLITE_DENY], the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2447 ** [sqlite3_prepare_v2()] or equivalent call that triggered the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2448 ** authorizer will fail with an error message explaining that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2449 ** access is denied.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2450 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2451 ** ^The first parameter to the authorizer callback is a copy of the third
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2452 ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2453 ** to the callback is an integer [SQLITE_COPY \| action code] that specifies
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2454 ** the particular action to be authorized. ^The third through sixth parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2455 ** to the callback are zero-terminated strings that contain additional
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2456 ** details about the action to be authorized.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2457 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2458 ** ^If the action code is [SQLITE_READ]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2459 ** and the callback returns [SQLITE_IGNORE] then the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2460 ** [prepared statement] statement is constructed to substitute
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2461 ** a NULL value in place of the table column that would have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2462 ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2463 ** return can be used to deny an untrusted user access to individual
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2464 ** columns of a table.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2465 ** ^If the action code is [SQLITE_DELETE] and the callback returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2466 ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2467 ** [truncate optimization] is disabled and all rows are deleted individually.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2468 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2469 ** An authorizer is used when [sqlite3_prepare \| preparing]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2470 ** SQL statements from an untrusted source, to ensure that the SQL statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2471 ** do not try to access data they are not allowed to see, or that they do not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2472 ** try to execute malicious statements that damage the database. For
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2473 ** example, an application may allow a user to enter arbitrary
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2474 ** SQL queries for evaluation by a database. But the application does
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2475 ** not want the user to be able to make arbitrary changes to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2476 ** database. An authorizer could then be put in place while the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2477 ** user-entered SQL is being [sqlite3_prepare \| prepared] that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2478 ** disallows everything except [SELECT] statements.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2479 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2480 ** Applications that need to process SQL from untrusted sources
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2481 ** might also consider lowering resource limits using [sqlite3_limit()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2482 ** and limiting database size using the [max_page_count] [PRAGMA]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2483 ** in addition to using an authorizer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2484 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2485 ** ^(Only a single authorizer can be in place on a database connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2486 ** at a time. Each call to sqlite3_set_authorizer overrides the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2487 ** previous call.)^ ^Disable the authorizer by installing a NULL callback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2488 ** The authorizer is disabled by default.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2489 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2490 ** The authorizer callback must not do anything that will modify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2491 ** the database connection that invoked the authorizer callback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2492 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2493 ** database connections for the meaning of "modify" in this paragraph.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2494 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2495 ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2496 ** statement might be re-prepared during [sqlite3_step()] due to a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2497 ** schema change. Hence, the application should ensure that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2498 ** correct authorizer callback remains in place during the [sqlite3_step()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2499 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2500 ** ^Note that the authorizer callback is invoked only during
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2501 ** [sqlite3_prepare()] or its variants. Authorization is not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2502 ** performed during statement evaluation in [sqlite3_step()], unless
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2503 ** as stated in the previous paragraph, sqlite3_step() invokes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2504 ** sqlite3_prepare_v2() to reprepare a statement after a schema change.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2505 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2506 SQLITE_API int sqlite3_set_authorizer(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2507 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2508 int (xAuth)(void,int,const char,const char,const char,const char),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2509 void *pUserData
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2510 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2511
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2512 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2513 ** CAPI3REF: Authorizer Return Codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2514 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2515 ** The [sqlite3_set_authorizer \| authorizer callback function] must
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2516 ** return either [SQLITE_OK] or one of these two constants in order
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2517 ** to signal SQLite whether or not the action is permitted. See the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2518 ** [sqlite3_set_authorizer \| authorizer documentation] for additional
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2519 ** information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2520 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2521 ** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK \| return code]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2522 ** from the [sqlite3_vtab_on_conflict()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2523 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2524 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2525 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2526
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2527 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2528 ** CAPI3REF: Authorizer Action Codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2529 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2530 ** The [sqlite3_set_authorizer()] interface registers a callback function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2531 ** that is invoked to authorize certain SQL statement actions. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2532 ** second parameter to the callback is an integer code that specifies
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2533 ** what action is being authorized. These are the integer action codes that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2534 ** the authorizer callback may be passed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2535 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2536 ** These action code values signify what kind of operation is to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2537 ** authorized. The 3rd and 4th parameters to the authorization
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2538 ** callback function will be parameters or NULL depending on which of these
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2539 ** codes is used as the second parameter. ^(The 5th parameter to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2540 ** authorizer callback is the name of the database ("main", "temp",
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2541 ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2542 ** is the name of the inner-most trigger or view that is responsible for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2543 ** the access attempt or NULL if this access attempt is directly from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2544 ** top-level SQL code.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2545 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2546 /***************************************** 3rd ******** 4th *********/
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2547 #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2548 #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2549 #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2550 #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2551 #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2552 #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2553 #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2554 #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2555 #define SQLITE_DELETE 9 /* Table Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2556 #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2557 #define SQLITE_DROP_TABLE 11 /* Table Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2558 #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2559 #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2560 #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2561 #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2562 #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2563 #define SQLITE_DROP_VIEW 17 /* View Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2564 #define SQLITE_INSERT 18 /* Table Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2565 #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2566 #define SQLITE_READ 20 /* Table Name Column Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2567 #define SQLITE_SELECT 21 /* NULL NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2568 #define SQLITE_TRANSACTION 22 /* Operation NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2569 #define SQLITE_UPDATE 23 /* Table Name Column Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2570 #define SQLITE_ATTACH 24 /* Filename NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2571 #define SQLITE_DETACH 25 /* Database Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2572 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2573 #define SQLITE_REINDEX 27 /* Index Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2574 #define SQLITE_ANALYZE 28 /* Table Name NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2575 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2576 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2577 #define SQLITE_FUNCTION 31 /* NULL Function Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2578 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2579 #define SQLITE_COPY 0 /* No longer used */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2580 #define SQLITE_RECURSIVE 33 /* NULL NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2581
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2582 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2583 ** CAPI3REF: Tracing And Profiling Functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2584 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2585 ** These routines register callback functions that can be used for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2586 ** tracing and profiling the execution of SQL statements.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2587 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2588 ** ^The callback function registered by sqlite3_trace() is invoked at
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2589 ** various times when an SQL statement is being run by [sqlite3_step()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2590 ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2591 ** SQL statement text as the statement first begins executing.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2592 ** ^(Additional sqlite3_trace() callbacks might occur
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2593 ** as each triggered subprogram is entered. The callbacks for triggers
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2594 ** contain a UTF-8 SQL comment that identifies the trigger.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2595 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2596 ** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2597 ** the length of [bound parameter] expansion in the output of sqlite3_trace().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2598 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2599 ** ^The callback function registered by sqlite3_profile() is invoked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2600 ** as each SQL statement finishes. ^The profile callback contains
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2601 ** the original statement text and an estimate of wall-clock time
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2602 ** of how long that statement took to run. ^The profile callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2603 ** time is in units of nanoseconds, however the current implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2604 ** is only capable of millisecond resolution so the six least significant
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2605 ** digits in the time are meaningless. Future versions of SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2606 ** might provide greater resolution on the profiler callback. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2607 ** sqlite3_profile() function is considered experimental and is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2608 ** subject to change in future versions of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2609 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2610 SQLITE_API void sqlite3_trace(sqlite3, void(xTrace)(void,const char), void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2611 SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_profile(sqlite3,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2612 void(xProfile)(void,const char,sqlite3_uint64), void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2613
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2614 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2615 ** CAPI3REF: Query Progress Callbacks
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2616 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2617 ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2618 ** function X to be invoked periodically during long running calls to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2619 ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2620 ** database connection D. An example use for this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2621 ** interface is to keep a GUI updated during a large query.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2622 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2623 ** ^The parameter P is passed through as the only parameter to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2624 ** callback function X. ^The parameter N is the approximate number of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2625 ** [virtual machine instructions] that are evaluated between successive
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2626 ** invocations of the callback X. ^If N is less than one then the progress
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2627 ** handler is disabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2628 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2629 ** ^Only a single progress handler may be defined at one time per
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2630 ** [database connection]; setting a new progress handler cancels the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2631 ** old one. ^Setting parameter X to NULL disables the progress handler.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2632 ** ^The progress handler is also disabled by setting N to a value less
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2633 ** than 1.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2634 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2635 ** ^If the progress callback returns non-zero, the operation is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2636 ** interrupted. This feature can be used to implement a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2637 ** "Cancel" button on a GUI progress dialog box.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2638 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2639 ** The progress handler callback must not do anything that will modify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2640 ** the database connection that invoked the progress handler.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2641 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2642 ** database connections for the meaning of "modify" in this paragraph.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2643 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2644 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2645 SQLITE_API void sqlite3_progress_handler(sqlite3, int, int()(void), void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2646
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2647 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2648 ** CAPI3REF: Opening A New Database Connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2649 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2650 ** ^These routines open an SQLite database file as specified by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2651 ** filename argument. ^The filename argument is interpreted as UTF-8 for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2652 ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2653 ** order for sqlite3_open16(). ^(A [database connection] handle is usually
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2654 ** returned in *ppDb, even if an error occurs. The only exception is that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2655 ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2656 ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2657 ** object.)^ ^(If the database is opened (and/or created) successfully, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2658 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2659 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2660 ** an English language description of the error following a failure of any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2661 ** of the sqlite3_open() routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2662 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2663 ** ^The default encoding for the database will be UTF-8 if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2664 ** sqlite3_open() or sqlite3_open_v2() is called and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2665 ** UTF-16 in the native byte order if sqlite3_open16() is used.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2666 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2667 ** Whether or not an error occurs when it is opened, resources
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2668 ** associated with the [database connection] handle should be released by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2669 ** passing it to [sqlite3_close()] when it is no longer required.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2670 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2671 ** The sqlite3_open_v2() interface works like sqlite3_open()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2672 ** except that it accepts two additional parameters for additional control
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2673 ** over the new database connection. ^(The flags parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2674 ** sqlite3_open_v2() can take one of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2675 ** the following three values, optionally combined with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2676 ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2677 ** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2678 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2679 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2680 ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2681 ** <dd>The database is opened in read-only mode. If the database does not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2682 ** already exist, an error is returned.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2683 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2684 ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2685 ** <dd>The database is opened for reading and writing if possible, or reading
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2686 ** only if the file is write protected by the operating system. In either
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2687 ** case the database must already exist, otherwise an error is returned.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2688 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2689 ** ^(<dt>[SQLITE_OPEN_READWRITE] \| [SQLITE_OPEN_CREATE]</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2690 ** <dd>The database is opened for reading and writing, and is created if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2691 ** it does not already exist. This is the behavior that is always used for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2692 ** sqlite3_open() and sqlite3_open16().</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2693 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2694 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2695 ** If the 3rd parameter to sqlite3_open_v2() is not one of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2696 ** combinations shown above optionally combined with other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2697 ** [SQLITE_OPEN_READONLY \| SQLITE_OPEN_* bits]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2698 ** then the behavior is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2699 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2700 ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2701 ** opens in the multi-thread [threading mode] as long as the single-thread
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2702 ** mode has not been set at compile-time or start-time. ^If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2703 ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2704 ** in the serialized [threading mode] unless single-thread was
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2705 ** previously selected at compile-time or start-time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2706 ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2707 ** eligible to use [shared cache mode], regardless of whether or not shared
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2708 ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2709 ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2710 ** participate in [shared cache mode] even if it is enabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2711 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2712 ** ^The fourth parameter to sqlite3_open_v2() is the name of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2713 ** [sqlite3_vfs] object that defines the operating system interface that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2714 ** the new database connection should use. ^If the fourth parameter is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2715 ** a NULL pointer then the default [sqlite3_vfs] object is used.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2716 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2717 ** ^If the filename is ":memory:", then a private, temporary in-memory database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2718 ** is created for the connection. ^This in-memory database will vanish when
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2719 ** the database connection is closed. Future versions of SQLite might
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2720 ** make use of additional special filenames that begin with the ":" character.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2721 ** It is recommended that when a database filename actually does begin with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2722 ** a ":" character you should prefix the filename with a pathname such as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2723 ** "./" to avoid ambiguity.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2724 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2725 ** ^If the filename is an empty string, then a private, temporary
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2726 ** on-disk database will be created. ^This private database will be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2727 ** automatically deleted as soon as the database connection is closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2728 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2729 ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2730 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2731 ** ^If [URI filename] interpretation is enabled, and the filename argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2732 ** begins with "file:", then the filename is interpreted as a URI. ^URI
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2733 ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2734 ** set in the fourth argument to sqlite3_open_v2(), or if it has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2735 ** been enabled globally using the [SQLITE_CONFIG_URI] option with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2736 ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2737 ** As of SQLite version 3.7.7, URI filename interpretation is turned off
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2738 ** by default, but future releases of SQLite might enable URI filename
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2739 ** interpretation by default. See "[URI filenames]" for additional
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2740 ** information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2741 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2742 ** URI filenames are parsed according to RFC 3986. ^If the URI contains an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2743 ** authority, then it must be either an empty string or the string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2744 ** "localhost". ^If the authority is not an empty string or "localhost", an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2745 ** error is returned to the caller. ^The fragment component of a URI, if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2746 ** present, is ignored.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2747 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2748 ** ^SQLite uses the path component of the URI as the name of the disk file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2749 ** which contains the database. ^If the path begins with a '/' character,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2750 ** then it is interpreted as an absolute path. ^If the path does not begin
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2751 ** with a '/' (meaning that the authority section is omitted from the URI)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2752 ** then the path is interpreted as a relative path.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2753 ** ^On windows, the first component of an absolute path
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2754 ** is a drive specification (e.g. "C:").
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2755 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2756 ** [[core URI query parameters]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2757 ** The query component of a URI may contain parameters that are interpreted
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2758 ** either by SQLite itself, or by a [VFS \| custom VFS implementation].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2759 ** SQLite interprets the following three query parameters:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2760 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2761 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2762 ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2763 ** a VFS object that provides the operating system interface that should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2764 ** be used to access the database file on disk. ^If this option is set to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2765 ** an empty string the default VFS object is used. ^Specifying an unknown
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2766 ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2767 ** present, then the VFS specified by the option takes precedence over
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2768 ** the value passed as the fourth parameter to sqlite3_open_v2().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2769 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2770 ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2771 ** "rwc", or "memory". Attempting to set it to any other value is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2772 ** an error)^.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2773 ** ^If "ro" is specified, then the database is opened for read-only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2774 ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2775 ** third argument to sqlite3_open_v2(). ^If the mode option is set to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2776 ** "rw", then the database is opened for read-write (but not create)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2777 ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2778 ** been set. ^Value "rwc" is equivalent to setting both
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2779 ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2780 ** set to "memory" then a pure [in-memory database] that never reads
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2781 ** or writes from disk is used. ^It is an error to specify a value for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2782 ** the mode parameter that is less restrictive than that specified by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2783 ** the flags passed in the third parameter to sqlite3_open_v2().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2784 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2785 ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2786 ** "private". ^Setting it to "shared" is equivalent to setting the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2787 ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2788 ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2789 ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2790 ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2791 ** a URI filename, its value overrides any behavior requested by setting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2792 ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2793 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2794 ** <li> <b>psow</b>: ^The psow parameter may be "true" (or "on" or "yes" or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2795 ** "1") or "false" (or "off" or "no" or "0") to indicate that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2796 ** [powersafe overwrite] property does or does not apply to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2797 ** storage media on which the database file resides. ^The psow query
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2798 ** parameter only works for the built-in unix and Windows VFSes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2799 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2800 ** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2801 ** which if set disables file locking in rollback journal modes. This
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2802 ** is useful for accessing a database on a filesystem that does not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2803 ** support locking. Caution: Database corruption might result if two
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2804 ** or more processes write to the same database and any one of those
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2805 ** processes uses nolock=1.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2806 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2807 ** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2808 ** parameter that indicates that the database file is stored on
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2809 ** read-only media. ^When immutable is set, SQLite assumes that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2810 ** database file cannot be changed, even by a process with higher
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2811 ** privilege, and so the database is opened read-only and all locking
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2812 ** and change detection is disabled. Caution: Setting the immutable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2813 ** property on a database file that does in fact change can result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2814 ** in incorrect query results and/or [SQLITE_CORRUPT] errors.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2815 ** See also: [SQLITE_IOCAP_IMMUTABLE].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2816 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2817 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2818 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2819 ** ^Specifying an unknown parameter in the query component of a URI is not an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2820 ** error. Future versions of SQLite might understand additional query
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2821 ** parameters. See "[query parameters with special meaning to SQLite]" for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2822 ** additional information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2823 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2824 ** [[URI filename examples]] <h3>URI filename examples</h3>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2825 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2826 ** <table border="1" align=center cellpadding=5>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2827 ** <tr><th> URI filenames <th> Results
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2828 ** <tr><td> file:data.db <td>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2829 ** Open the file "data.db" in the current directory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2830 ** <tr><td> file:/home/fred/data.db<br>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2831 ** file:///home/fred/data.db <br>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2832 ** file://localhost/home/fred/data.db <br> <td>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2833 ** Open the database file "/home/fred/data.db".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2834 ** <tr><td> file://darkstar/home/fred/data.db <td>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2835 ** An error. "darkstar" is not a recognized authority.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2836 ** <tr><td style="white-space:nowrap">
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2837 ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2838 ** <td> Windows only: Open the file "data.db" on fred's desktop on drive
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2839 ** C:. Note that the %20 escaping in this example is not strictly
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2840 ** necessary - space characters can be used literally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2841 ** in URI filenames.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2842 ** <tr><td> file:data.db?mode=ro&cache=private <td>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2843 ** Open file "data.db" in the current directory for read-only access.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2844 ** Regardless of whether or not shared-cache mode is enabled by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2845 ** default, use a private cache.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2846 ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2847 ** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2848 ** that uses dot-files in place of posix advisory locking.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2849 ** <tr><td> file:data.db?mode=readonly <td>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2850 ** An error. "readonly" is not a valid option for the "mode" parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2851 ** </table>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2852 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2853 ** ^URI hexadecimal escape sequences (%HH) are supported within the path and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2854 ** query components of a URI. A hexadecimal escape sequence consists of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2855 ** percent sign - "%" - followed by exactly two hexadecimal digits
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2856 ** specifying an octet value. ^Before the path or query components of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2857 ** URI filename are interpreted, they are encoded using UTF-8 and all
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2858 ** hexadecimal escape sequences replaced by a single byte containing the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2859 ** corresponding octet. If this process generates an invalid UTF-8 encoding,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2860 ** the results are undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2861 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2862 ** <b>Note to Windows users:</b> The encoding used for the filename argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2863 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2864 ** codepage is currently defined. Filenames containing international
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2865 ** characters must be converted to UTF-8 prior to passing them into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2866 ** sqlite3_open() or sqlite3_open_v2().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2867 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2868 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2869 ** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2870 ** features that require the use of temporary files may fail.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2871 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2872 ** See also: [sqlite3_temp_directory]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2873 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2874 SQLITE_API int sqlite3_open(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2875 const char filename, / Database filename (UTF-8) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2876 sqlite3 *ppDb / OUT: SQLite db handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2877 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2878 SQLITE_API int sqlite3_open16(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2879 const void filename, / Database filename (UTF-16) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2880 sqlite3 *ppDb / OUT: SQLite db handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2881 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2882 SQLITE_API int sqlite3_open_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2883 const char filename, / Database filename (UTF-8) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2884 sqlite3 *ppDb, / OUT: SQLite db handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2885 int flags, /* Flags */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2886 const char zVfs / Name of VFS module to use */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2887 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2888
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2889 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2890 ** CAPI3REF: Obtain Values For URI Parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2891 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2892 ** These are utility routines, useful to VFS implementations, that check
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2893 ** to see if a database file was a URI that contained a specific query
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2894 ** parameter, and if so obtains the value of that query parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2895 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2896 ** If F is the database filename pointer passed into the xOpen() method of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2897 ** a VFS implementation when the flags parameter to xOpen() has one or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2898 ** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2899 ** P is the name of the query parameter, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2900 ** sqlite3_uri_parameter(F,P) returns the value of the P
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2901 ** parameter if it exists or a NULL pointer if P does not appear as a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2902 ** query parameter on F. If P is a query parameter of F
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2903 ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2904 ** a pointer to an empty string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2905 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2906 ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2907 ** parameter and returns true (1) or false (0) according to the value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2908 ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2909 ** value of query parameter P is one of "yes", "true", or "on" in any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2910 ** case or if the value begins with a non-zero number. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2911 ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2912 ** query parameter P is one of "no", "false", or "off" in any case or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2913 ** if the value begins with a numeric zero. If P is not a query
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2914 ** parameter on F or if the value of P is does not match any of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2915 ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2916 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2917 ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2918 ** 64-bit signed integer and returns that integer, or D if P does not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2919 ** exist. If the value of P is something other than an integer, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2920 ** zero is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2921 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2922 ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2923 ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2924 ** is not a database file pathname pointer that SQLite passed into the xOpen
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2925 ** VFS method, then the behavior of this routine is undefined and probably
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2926 ** undesirable.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2927 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2928 SQLITE_API const char sqlite3_uri_parameter(const char zFilename, const char *zParam);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2929 SQLITE_API int sqlite3_uri_boolean(const char zFile, const char zParam, int bDefault);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2930 SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char, const char, sqlite3_int64);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2931
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2932
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2933 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2934 ** CAPI3REF: Error Codes And Messages
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2935 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2936 ** ^The sqlite3_errcode() interface returns the numeric [result code] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2937 ** [extended result code] for the most recent failed sqlite3_* API call
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2938 ** associated with a [database connection]. If a prior API call failed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2939 ** but the most recent API call succeeded, the return value from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2940 ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2941 ** interface is the same except that it always returns the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2942 ** [extended result code] even when extended result codes are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2943 ** disabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2944 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2945 ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2946 ** text that describes the error, as either UTF-8 or UTF-16 respectively.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2947 ** ^(Memory to hold the error message string is managed internally.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2948 ** The application does not need to worry about freeing the result.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2949 ** However, the error string might be overwritten or deallocated by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2950 ** subsequent calls to other SQLite interface functions.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2951 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2952 ** ^The sqlite3_errstr() interface returns the English-language text
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2953 ** that describes the [result code], as UTF-8.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2954 ** ^(Memory to hold the error message string is managed internally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2955 ** and must not be freed by the application)^.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2956 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2957 ** When the serialized [threading mode] is in use, it might be the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2958 ** case that a second error occurs on a separate thread in between
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2959 ** the time of the first error and the call to these interfaces.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2960 ** When that happens, the second error will be reported since these
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2961 ** interfaces always report the most recent result. To avoid
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2962 ** this, each thread can obtain exclusive use of the [database connection] D
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2963 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2964 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2965 ** all calls to the interfaces listed here are completed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2966 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2967 ** If an interface fails with SQLITE_MISUSE, that means the interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2968 ** was invoked incorrectly by the application. In that case, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2969 ** error code and message may or may not be set.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2970 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2971 SQLITE_API int sqlite3_errcode(sqlite3 *db);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2972 SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2973 SQLITE_API const char sqlite3_errmsg(sqlite3);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2974 SQLITE_API const void sqlite3_errmsg16(sqlite3);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2975 SQLITE_API const char *sqlite3_errstr(int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2976
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2977 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2978 ** CAPI3REF: SQL Statement Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2979 ** KEYWORDS: {prepared statement} {prepared statements}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2980 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2981 ** An instance of this object represents a single SQL statement.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2982 ** This object is variously known as a "prepared statement" or a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2983 ** "compiled SQL statement" or simply as a "statement".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2984 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2985 ** The life of a statement object goes something like this:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2986 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2987 ** <ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2988 ** <li> Create the object using [sqlite3_prepare_v2()] or a related
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2989 ** function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2990 ** <li> Bind values to [host parameters] using the sqlite3_bind_*()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2991 ** interfaces.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2992 ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2993 ** <li> Reset the statement using [sqlite3_reset()] then go back
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2994 ** to step 2. Do this zero or more times.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2995 ** <li> Destroy the object using [sqlite3_finalize()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2996 ** </ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2997 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2998 ** Refer to documentation on individual methods above for additional
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2999 ** information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3000 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3001 typedef struct sqlite3_stmt sqlite3_stmt;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3002
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3003 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3004 ** CAPI3REF: Run-time Limits
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3005 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3006 ** ^(This interface allows the size of various constructs to be limited
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3007 ** on a connection by connection basis. The first parameter is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3008 ** [database connection] whose limit is to be set or queried. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3009 ** second parameter is one of the [limit categories] that define a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3010 ** class of constructs to be size limited. The third parameter is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3011 ** new limit for that construct.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3012 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3013 ** ^If the new limit is a negative number, the limit is unchanged.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3014 ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3015 ** [limits \| hard upper bound]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3016 ** set at compile-time by a C preprocessor macro called
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3017 ** [limits \| SQLITE_MAX_<i>NAME</i>].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3018 ** (The "_LIMIT_" in the name is changed to "_MAX_".))^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3019 ** ^Attempts to increase a limit above its hard upper bound are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3020 ** silently truncated to the hard upper bound.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3021 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3022 ** ^Regardless of whether or not the limit was changed, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3023 ** [sqlite3_limit()] interface returns the prior value of the limit.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3024 ** ^Hence, to find the current value of a limit without changing it,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3025 ** simply invoke this interface with the third parameter set to -1.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3026 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3027 ** Run-time limits are intended for use in applications that manage
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3028 ** both their own internal database and also databases that are controlled
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3029 ** by untrusted external sources. An example application might be a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3030 ** web browser that has its own databases for storing history and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3031 ** separate databases controlled by JavaScript applications downloaded
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3032 ** off the Internet. The internal databases can be given the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3033 ** large, default limits. Databases managed by external sources can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3034 ** be given much smaller limits designed to prevent a denial of service
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3035 ** attack. Developers might also want to use the [sqlite3_set_authorizer()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3036 ** interface to further control untrusted SQL. The size of the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3037 ** created by an untrusted script can be contained using the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3038 ** [max_page_count] [PRAGMA].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3039 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3040 ** New run-time limit categories may be added in future releases.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3041 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3042 SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3043
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3044 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3045 ** CAPI3REF: Run-Time Limit Categories
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3046 ** KEYWORDS: {limit category} {*limit categories}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3047 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3048 ** These constants define various performance limits
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3049 ** that can be lowered at run-time using [sqlite3_limit()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3050 ** The synopsis of the meanings of the various limits is shown below.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3051 ** Additional information is available at [limits \| Limits in SQLite].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3052 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3053 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3054 ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3055 ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3056 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3057 ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3058 ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3059 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3060 ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3061 ** <dd>The maximum number of columns in a table definition or in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3062 ** result set of a [SELECT] or the maximum number of columns in an index
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3063 ** or in an ORDER BY or GROUP BY clause.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3064 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3065 ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3066 ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3067 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3068 ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3069 ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3070 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3071 ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3072 ** <dd>The maximum number of instructions in a virtual machine program
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3073 ** used to implement an SQL statement. This limit is not currently
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3074 ** enforced, though that might be added in some future release of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3075 ** SQLite.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3076 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3077 ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3078 ** <dd>The maximum number of arguments on a function.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3079 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3080 ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3081 ** <dd>The maximum number of [ATTACH \| attached databases].)^</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3082 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3083 ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3084 ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3085 ** <dd>The maximum length of the pattern argument to the [LIKE] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3086 ** [GLOB] operators.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3087 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3088 ** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3089 ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3090 ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3091 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3092 ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3093 ** <dd>The maximum depth of recursion for triggers.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3094 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3095 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3096 #define SQLITE_LIMIT_LENGTH 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3097 #define SQLITE_LIMIT_SQL_LENGTH 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3098 #define SQLITE_LIMIT_COLUMN 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3099 #define SQLITE_LIMIT_EXPR_DEPTH 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3100 #define SQLITE_LIMIT_COMPOUND_SELECT 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3101 #define SQLITE_LIMIT_VDBE_OP 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3102 #define SQLITE_LIMIT_FUNCTION_ARG 6
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3103 #define SQLITE_LIMIT_ATTACHED 7
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3104 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3105 #define SQLITE_LIMIT_VARIABLE_NUMBER 9
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3106 #define SQLITE_LIMIT_TRIGGER_DEPTH 10
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3107
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3108 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3109 ** CAPI3REF: Compiling An SQL Statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3110 ** KEYWORDS: {SQL statement compiler}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3111 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3112 ** To execute an SQL query, it must first be compiled into a byte-code
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3113 ** program using one of these routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3114 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3115 ** The first argument, "db", is a [database connection] obtained from a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3116 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3117 ** [sqlite3_open16()]. The database connection must not have been closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3118 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3119 ** The second argument, "zSql", is the statement to be compiled, encoded
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3120 ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3121 ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3122 ** use UTF-16.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3123 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3124 ** ^If the nByte argument is less than zero, then zSql is read up to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3125 ** first zero terminator. ^If nByte is non-negative, then it is the maximum
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3126 ** number of bytes read from zSql. ^When nByte is non-negative, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3127 ** zSql string ends at either the first '\000' or '\u0000' character or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3128 ** the nByte-th byte, whichever comes first. If the caller knows
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3129 ** that the supplied string is nul-terminated, then there is a small
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3130 ** performance advantage to be gained by passing an nByte parameter that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3131 ** is equal to the number of bytes in the input string <i>including</i>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3132 ** the nul-terminator bytes as this saves SQLite from having to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3133 ** make a copy of the input string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3134 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3135 ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3136 ** past the end of the first SQL statement in zSql. These routines only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3137 ** compile the first statement in zSql, so *pzTail is left pointing to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3138 ** what remains uncompiled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3139 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3140 ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3141 ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3142 ** to NULL. ^If the input text contains no SQL (if the input is an empty
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3143 ** string or a comment) then *ppStmt is set to NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3144 ** The calling procedure is responsible for deleting the compiled
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3145 ** SQL statement using [sqlite3_finalize()] after it has finished with it.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3146 ** ppStmt may not be NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3147 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3148 ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3149 ** otherwise an [error code] is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3150 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3151 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3152 ** recommended for all new programs. The two older interfaces are retained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3153 ** for backwards compatibility, but their use is discouraged.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3154 ** ^In the "v2" interfaces, the prepared statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3155 ** that is returned (the [sqlite3_stmt] object) contains a copy of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3156 ** original SQL text. This causes the [sqlite3_step()] interface to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3157 ** behave differently in three ways:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3158 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3159 ** <ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3160 ** <li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3161 ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3162 ** always used to do, [sqlite3_step()] will automatically recompile the SQL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3163 ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3164 ** retries will occur before sqlite3_step() gives up and returns an error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3165 ** </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3166 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3167 ** <li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3168 ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3169 ** [error codes] or [extended error codes]. ^The legacy behavior was that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3170 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3171 ** and the application would have to make a second call to [sqlite3_reset()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3172 ** in order to find the underlying cause of the problem. With the "v2" prepare
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3173 ** interfaces, the underlying reason for the error is returned immediately.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3174 ** </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3175 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3176 ** <li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3177 ** ^If the specific value bound to [parameter \| host parameter] in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3178 ** WHERE clause might influence the choice of query plan for a statement,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3179 ** then the statement will be automatically recompiled, as if there had been
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3180 ** a schema change, on the first [sqlite3_step()] call following any change
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3181 ** to the [sqlite3_bind_text \| bindings] of that [parameter].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3182 ** ^The specific value of WHERE-clause [parameter] might influence the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3183 ** choice of query plan if the parameter is the left-hand side of a [LIKE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3184 ** or [GLOB] operator or if the parameter is compared to an indexed column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3185 ** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3186 ** </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3187 ** </ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3188 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3189 SQLITE_API int sqlite3_prepare(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3190 sqlite3 db, / Database handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3191 const char zSql, / SQL statement, UTF-8 encoded */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3192 int nByte, /* Maximum length of zSql in bytes. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3193 sqlite3_stmt *ppStmt, / OUT: Statement handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3194 const char *pzTail / OUT: Pointer to unused portion of zSql */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3195 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3196 SQLITE_API int sqlite3_prepare_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3197 sqlite3 db, / Database handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3198 const char zSql, / SQL statement, UTF-8 encoded */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3199 int nByte, /* Maximum length of zSql in bytes. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3200 sqlite3_stmt *ppStmt, / OUT: Statement handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3201 const char *pzTail / OUT: Pointer to unused portion of zSql */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3202 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3203 SQLITE_API int sqlite3_prepare16(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3204 sqlite3 db, / Database handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3205 const void zSql, / SQL statement, UTF-16 encoded */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3206 int nByte, /* Maximum length of zSql in bytes. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3207 sqlite3_stmt *ppStmt, / OUT: Statement handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3208 const void *pzTail / OUT: Pointer to unused portion of zSql */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3209 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3210 SQLITE_API int sqlite3_prepare16_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3211 sqlite3 db, / Database handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3212 const void zSql, / SQL statement, UTF-16 encoded */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3213 int nByte, /* Maximum length of zSql in bytes. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3214 sqlite3_stmt *ppStmt, / OUT: Statement handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3215 const void *pzTail / OUT: Pointer to unused portion of zSql */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3216 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3217
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3218 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3219 ** CAPI3REF: Retrieving Statement SQL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3220 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3221 ** ^This interface can be used to retrieve a saved copy of the original
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3222 ** SQL text used to create a [prepared statement] if that statement was
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3223 ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3224 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3225 SQLITE_API const char sqlite3_sql(sqlite3_stmt pStmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3226
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3227 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3228 ** CAPI3REF: Determine If An SQL Statement Writes The Database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3229 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3230 ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3231 ** and only if the [prepared statement] X makes no direct changes to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3232 ** the content of the database file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3233 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3234 ** Note that [application-defined SQL functions] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3235 ** [virtual tables] might change the database indirectly as a side effect.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3236 ** ^(For example, if an application defines a function "eval()" that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3237 ** calls [sqlite3_exec()], then the following SQL statement would
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3238 ** change the database file through side-effects:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3239 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3240 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3241 ** SELECT eval('DELETE FROM t1') FROM t2;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3242 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3243 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3244 ** But because the [SELECT] statement does not change the database file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3245 ** directly, sqlite3_stmt_readonly() would still return true.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3246 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3247 ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3248 ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3249 ** since the statements themselves do not actually modify the database but
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3250 ** rather they control the timing of when other statements modify the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3251 ** database. ^The [ATTACH] and [DETACH] statements also cause
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3252 ** sqlite3_stmt_readonly() to return true since, while those statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3253 ** change the configuration of a database connection, they do not make
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3254 ** changes to the content of the database files on disk.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3255 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3256 SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3257
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3258 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3259 ** CAPI3REF: Determine If A Prepared Statement Has Been Reset
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3260 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3261 ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3262 ** [prepared statement] S has been stepped at least once using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3263 ** [sqlite3_step(S)] but has not run to completion and/or has not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3264 ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3265 ** interface returns false if S is a NULL pointer. If S is not a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3266 ** NULL pointer and is not a pointer to a valid [prepared statement]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3267 ** object, then the behavior is undefined and probably undesirable.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3268 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3269 ** This interface can be used in combination [sqlite3_next_stmt()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3270 ** to locate all prepared statements associated with a database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3271 ** connection that are in need of being reset. This can be used,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3272 ** for example, in diagnostic routines to search for prepared
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3273 ** statements that are holding a transaction open.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3274 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3275 SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3276
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3277 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3278 ** CAPI3REF: Dynamically Typed Value Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3279 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3280 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3281 ** SQLite uses the sqlite3_value object to represent all values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3282 ** that can be stored in a database table. SQLite uses dynamic typing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3283 ** for the values it stores. ^Values stored in sqlite3_value objects
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3284 ** can be integers, floating point values, strings, BLOBs, or NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3285 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3286 ** An sqlite3_value object may be either "protected" or "unprotected".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3287 ** Some interfaces require a protected sqlite3_value. Other interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3288 ** will accept either a protected or an unprotected sqlite3_value.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3289 ** Every interface that accepts sqlite3_value arguments specifies
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3290 ** whether or not it requires a protected sqlite3_value.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3291 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3292 ** The terms "protected" and "unprotected" refer to whether or not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3293 ** a mutex is held. An internal mutex is held for a protected
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3294 ** sqlite3_value object but no mutex is held for an unprotected
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3295 ** sqlite3_value object. If SQLite is compiled to be single-threaded
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3296 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3297 ** or if SQLite is run in one of reduced mutex modes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3298 ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3299 ** then there is no distinction between protected and unprotected
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3300 ** sqlite3_value objects and they can be used interchangeably. However,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3301 ** for maximum code portability it is recommended that applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3302 ** still make the distinction between protected and unprotected
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3303 ** sqlite3_value objects even when not strictly required.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3304 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3305 ** ^The sqlite3_value objects that are passed as parameters into the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3306 ** implementation of [application-defined SQL functions] are protected.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3307 ** ^The sqlite3_value object returned by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3308 ** [sqlite3_column_value()] is unprotected.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3309 ** Unprotected sqlite3_value objects may only be used with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3310 ** [sqlite3_result_value()] and [sqlite3_bind_value()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3311 ** The [sqlite3_value_blob \| sqlite3_value_type()] family of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3312 ** interfaces require protected sqlite3_value objects.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3313 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3314 typedef struct Mem sqlite3_value;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3315
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3316 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3317 ** CAPI3REF: SQL Function Context Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3318 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3319 ** The context in which an SQL function executes is stored in an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3320 ** sqlite3_context object. ^A pointer to an sqlite3_context object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3321 ** is always first parameter to [application-defined SQL functions].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3322 ** The application-defined SQL function implementation will pass this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3323 ** pointer through into calls to [sqlite3_result_int \| sqlite3_result()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3324 ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3325 ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3326 ** and/or [sqlite3_set_auxdata()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3327 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3328 typedef struct sqlite3_context sqlite3_context;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3329
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3330 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3331 ** CAPI3REF: Binding Values To Prepared Statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3332 ** KEYWORDS: {host parameter} {host parameters} {host parameter name}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3333 ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3334 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3335 ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3336 ** literals may be replaced by a [parameter] that matches one of following
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3337 ** templates:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3338 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3339 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3340 ** <li> ?
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3341 ** <li> ?NNN
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3342 ** <li> :VVV
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3343 ** <li> @VVV
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3344 ** <li> $VVV
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3345 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3346 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3347 ** In the templates above, NNN represents an integer literal,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3348 ** and VVV represents an alphanumeric identifier.)^ ^The values of these
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3349 ** parameters (also called "host parameter names" or "SQL parameters")
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3350 ** can be set using the sqlite3_bind_*() routines defined here.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3351 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3352 ** ^The first argument to the sqlite3_bind_*() routines is always
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3353 ** a pointer to the [sqlite3_stmt] object returned from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3354 ** [sqlite3_prepare_v2()] or its variants.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3355 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3356 ** ^The second argument is the index of the SQL parameter to be set.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3357 ** ^The leftmost SQL parameter has an index of 1. ^When the same named
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3358 ** SQL parameter is used more than once, second and subsequent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3359 ** occurrences have the same index as the first occurrence.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3360 ** ^The index for named parameters can be looked up using the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3361 ** [sqlite3_bind_parameter_index()] API if desired. ^The index
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3362 ** for "?NNN" parameters is the value of NNN.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3363 ** ^The NNN value must be between 1 and the [sqlite3_limit()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3364 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3365 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3366 ** ^The third argument is the value to bind to the parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3367 ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3368 ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3369 ** is ignored and the end result is the same as sqlite3_bind_null().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3370 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3371 ** ^(In those routines that have a fourth argument, its value is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3372 ** number of bytes in the parameter. To be clear: the value is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3373 ** number of <u>bytes</u> in the value, not the number of characters.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3374 ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3375 ** is negative, then the length of the string is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3376 ** the number of bytes up to the first zero terminator.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3377 ** If the fourth parameter to sqlite3_bind_blob() is negative, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3378 ** the behavior is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3379 ** If a non-negative fourth parameter is provided to sqlite3_bind_text()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3380 ** or sqlite3_bind_text16() then that parameter must be the byte offset
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3381 ** where the NUL terminator would occur assuming the string were NUL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3382 ** terminated. If any NUL characters occur at byte offsets less than
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3383 ** the value of the fourth parameter then the resulting string value will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3384 ** contain embedded NULs. The result of expressions involving strings
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3385 ** with embedded NULs is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3386 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3387 ** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3388 ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3389 ** string after SQLite has finished with it. ^The destructor is called
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3390 ** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3391 ** sqlite3_bind_text(), or sqlite3_bind_text16() fails.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3392 ** ^If the fifth argument is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3393 ** the special value [SQLITE_STATIC], then SQLite assumes that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3394 ** information is in static, unmanaged space and does not need to be freed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3395 ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3396 ** SQLite makes its own private copy of the data immediately, before
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3397 ** the sqlite3_bind_*() routine returns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3398 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3399 ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3400 ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3401 ** (just an integer to hold its size) while it is being processed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3402 ** Zeroblobs are intended to serve as placeholders for BLOBs whose
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3403 ** content is later written using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3404 ** [sqlite3_blob_open \| incremental BLOB I/O] routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3405 ** ^A negative value for the zeroblob results in a zero-length BLOB.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3406 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3407 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3408 ** for the [prepared statement] or with a prepared statement for which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3409 ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3410 ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3411 ** routine is passed a [prepared statement] that has been finalized, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3412 ** result is undefined and probably harmful.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3413 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3414 ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3415 ** ^Unbound parameters are interpreted as NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3416 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3417 ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3418 ** [error code] if anything goes wrong.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3419 ** ^[SQLITE_RANGE] is returned if the parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3420 ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3421 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3422 ** See also: [sqlite3_bind_parameter_count()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3423 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3424 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3425 SQLITE_API int sqlite3_bind_blob(sqlite3_stmt, int, const void, int n, void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3426 SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3427 SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3428 SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3429 SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3430 SQLITE_API int sqlite3_bind_text(sqlite3_stmt, int, const char, int n, void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3431 SQLITE_API int sqlite3_bind_text16(sqlite3_stmt, int, const void, int, void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3432 SQLITE_API int sqlite3_bind_value(sqlite3_stmt, int, const sqlite3_value);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3433 SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3434
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3435 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3436 ** CAPI3REF: Number Of SQL Parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3437 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3438 ** ^This routine can be used to find the number of [SQL parameters]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3439 ** in a [prepared statement]. SQL parameters are tokens of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3440 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3441 ** placeholders for values that are [sqlite3_bind_blob \| bound]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3442 ** to the parameters at a later time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3443 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3444 ** ^(This routine actually returns the index of the largest (rightmost)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3445 ** parameter. For all forms except ?NNN, this will correspond to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3446 ** number of unique parameters. If parameters of the ?NNN form are used,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3447 ** there may be gaps in the list.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3448 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3449 ** See also: [sqlite3_bind_blob\|sqlite3_bind()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3450 ** [sqlite3_bind_parameter_name()], and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3451 ** [sqlite3_bind_parameter_index()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3452 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3453 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3454
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3455 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3456 ** CAPI3REF: Name Of A Host Parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3457 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3458 ** ^The sqlite3_bind_parameter_name(P,N) interface returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3459 ** the name of the N-th [SQL parameter] in the [prepared statement] P.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3460 ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3461 ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3462 ** respectively.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3463 ** In other words, the initial ":" or "$" or "@" or "?"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3464 ** is included as part of the name.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3465 ** ^Parameters of the form "?" without a following integer have no name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3466 ** and are referred to as "nameless" or "anonymous parameters".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3467 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3468 ** ^The first host parameter has an index of 1, not 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3469 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3470 ** ^If the value N is out of range or if the N-th parameter is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3471 ** nameless, then NULL is returned. ^The returned string is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3472 ** always in UTF-8 encoding even if the named parameter was
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3473 ** originally specified as UTF-16 in [sqlite3_prepare16()] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3474 ** [sqlite3_prepare16_v2()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3475 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3476 ** See also: [sqlite3_bind_blob\|sqlite3_bind()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3477 ** [sqlite3_bind_parameter_count()], and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3478 ** [sqlite3_bind_parameter_index()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3479 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3480 SQLITE_API const char sqlite3_bind_parameter_name(sqlite3_stmt, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3481
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3482 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3483 ** CAPI3REF: Index Of A Parameter With A Given Name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3484 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3485 ** ^Return the index of an SQL parameter given its name. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3486 ** index value returned is suitable for use as the second
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3487 ** parameter to [sqlite3_bind_blob\|sqlite3_bind()]. ^A zero
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3488 ** is returned if no matching parameter is found. ^The parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3489 ** name must be given in UTF-8 even if the original statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3490 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3491 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3492 ** See also: [sqlite3_bind_blob\|sqlite3_bind()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3493 ** [sqlite3_bind_parameter_count()], and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3494 ** [sqlite3_bind_parameter_index()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3495 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3496 SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt, const char zName);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3497
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3498 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3499 ** CAPI3REF: Reset All Bindings On A Prepared Statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3500 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3501 ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3502 ** the [sqlite3_bind_blob \| bindings] on a [prepared statement].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3503 ** ^Use this routine to reset all host parameters to NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3504 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3505 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3506
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3507 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3508 ** CAPI3REF: Number Of Columns In A Result Set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3509 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3510 ** ^Return the number of columns in the result set returned by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3511 ** [prepared statement]. ^This routine returns 0 if pStmt is an SQL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3512 ** statement that does not return data (for example an [UPDATE]).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3513 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3514 ** See also: [sqlite3_data_count()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3515 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3516 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3517
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3518 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3519 ** CAPI3REF: Column Names In A Result Set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3520 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3521 ** ^These routines return the name assigned to a particular column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3522 ** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3523 ** interface returns a pointer to a zero-terminated UTF-8 string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3524 ** and sqlite3_column_name16() returns a pointer to a zero-terminated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3525 ** UTF-16 string. ^The first parameter is the [prepared statement]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3526 ** that implements the [SELECT] statement. ^The second parameter is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3527 ** column number. ^The leftmost column is number 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3528 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3529 ** ^The returned string pointer is valid until either the [prepared statement]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3530 ** is destroyed by [sqlite3_finalize()] or until the statement is automatically
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3531 ** reprepared by the first call to [sqlite3_step()] for a particular run
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3532 ** or until the next call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3533 ** sqlite3_column_name() or sqlite3_column_name16() on the same column.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3534 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3535 ** ^If sqlite3_malloc() fails during the processing of either routine
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3536 ** (for example during a conversion from UTF-8 to UTF-16) then a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3537 ** NULL pointer is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3538 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3539 ** ^The name of a result column is the value of the "AS" clause for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3540 ** that column, if there is an AS clause. If there is no AS clause
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3541 ** then the name of the column is unspecified and may change from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3542 ** one release of SQLite to the next.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3543 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3544 SQLITE_API const char sqlite3_column_name(sqlite3_stmt, int N);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3545 SQLITE_API const void sqlite3_column_name16(sqlite3_stmt, int N);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3546
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3547 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3548 ** CAPI3REF: Source Of Data In A Query Result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3549 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3550 ** ^These routines provide a means to determine the database, table, and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3551 ** table column that is the origin of a particular result column in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3552 ** [SELECT] statement.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3553 ** ^The name of the database or table or column can be returned as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3554 ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3555 ** the database name, the _table_ routines return the table name, and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3556 ** the origin_ routines return the column name.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3557 ** ^The returned string is valid until the [prepared statement] is destroyed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3558 ** using [sqlite3_finalize()] or until the statement is automatically
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3559 ** reprepared by the first call to [sqlite3_step()] for a particular run
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3560 ** or until the same information is requested
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3561 ** again in a different encoding.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3562 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3563 ** ^The names returned are the original un-aliased names of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3564 ** database, table, and column.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3565 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3566 ** ^The first argument to these interfaces is a [prepared statement].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3567 ** ^These functions return information about the Nth result column returned by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3568 ** the statement, where N is the second function argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3569 ** ^The left-most column is column 0 for these routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3570 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3571 ** ^If the Nth column returned by the statement is an expression or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3572 ** subquery and is not a column value, then all of these functions return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3573 ** NULL. ^These routine might also return NULL if a memory allocation error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3574 ** occurs. ^Otherwise, they return the name of the attached database, table,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3575 ** or column that query result column was extracted from.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3576 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3577 ** ^As with all other SQLite APIs, those whose names end with "16" return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3578 ** UTF-16 encoded strings and the other functions return UTF-8.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3579 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3580 ** ^These APIs are only available if the library was compiled with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3581 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3582 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3583 ** If two or more threads call one or more of these routines against the same
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3584 ** prepared statement and column at the same time then the results are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3585 ** undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3586 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3587 ** If two or more threads call one or more
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3588 ** [sqlite3_column_database_name \| column metadata interfaces]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3589 ** for the same [prepared statement] and result column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3590 ** at the same time then the results are undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3591 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3592 SQLITE_API const char sqlite3_column_database_name(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3593 SQLITE_API const void sqlite3_column_database_name16(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3594 SQLITE_API const char sqlite3_column_table_name(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3595 SQLITE_API const void sqlite3_column_table_name16(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3596 SQLITE_API const char sqlite3_column_origin_name(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3597 SQLITE_API const void sqlite3_column_origin_name16(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3598
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3599 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3600 ** CAPI3REF: Declared Datatype Of A Query Result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3601 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3602 ** ^(The first parameter is a [prepared statement].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3603 ** If this statement is a [SELECT] statement and the Nth column of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3604 ** returned result set of that [SELECT] is a table column (not an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3605 ** expression or subquery) then the declared type of the table
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3606 ** column is returned.)^ ^If the Nth column of the result set is an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3607 ** expression or subquery, then a NULL pointer is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3608 ** ^The returned string is always UTF-8 encoded.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3609 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3610 ** ^(For example, given the database schema:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3611 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3612 ** CREATE TABLE t1(c1 VARIANT);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3613 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3614 ** and the following statement to be compiled:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3615 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3616 ** SELECT c1 + 1, c1 FROM t1;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3617 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3618 ** this routine would return the string "VARIANT" for the second result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3619 ** column (i==1), and a NULL pointer for the first result column (i==0).)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3620 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3621 ** ^SQLite uses dynamic run-time typing. ^So just because a column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3622 ** is declared to contain a particular type does not mean that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3623 ** data stored in that column is of the declared type. SQLite is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3624 ** strongly typed, but the typing is dynamic not static. ^Type
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3625 ** is associated with individual values, not with the containers
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3626 ** used to hold those values.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3627 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3628 SQLITE_API const char sqlite3_column_decltype(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3629 SQLITE_API const void sqlite3_column_decltype16(sqlite3_stmt,int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3630
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3631 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3632 ** CAPI3REF: Evaluate An SQL Statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3633 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3634 ** After a [prepared statement] has been prepared using either
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3635 ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3636 ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3637 ** must be called one or more times to evaluate the statement.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3638 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3639 ** The details of the behavior of the sqlite3_step() interface depend
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3640 ** on whether the statement was prepared using the newer "v2" interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3641 ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3642 ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3643 ** new "v2" interface is recommended for new applications but the legacy
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3644 ** interface will continue to be supported.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3645 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3646 ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3647 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3648 ** ^With the "v2" interface, any of the other [result codes] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3649 ** [extended result codes] might be returned as well.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3650 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3651 ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3652 ** database locks it needs to do its job. ^If the statement is a [COMMIT]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3653 ** or occurs outside of an explicit transaction, then you can retry the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3654 ** statement. If the statement is not a [COMMIT] and occurs within an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3655 ** explicit transaction then you should rollback the transaction before
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3656 ** continuing.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3657 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3658 ** ^[SQLITE_DONE] means that the statement has finished executing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3659 ** successfully. sqlite3_step() should not be called again on this virtual
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3660 ** machine without first calling [sqlite3_reset()] to reset the virtual
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3661 ** machine back to its initial state.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3662 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3663 ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3664 ** is returned each time a new row of data is ready for processing by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3665 ** caller. The values may be accessed using the [column access functions].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3666 ** sqlite3_step() is called again to retrieve the next row of data.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3667 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3668 ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3669 ** violation) has occurred. sqlite3_step() should not be called again on
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3670 ** the VM. More information may be found by calling [sqlite3_errmsg()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3671 ** ^With the legacy interface, a more specific error code (for example,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3672 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3673 ** can be obtained by calling [sqlite3_reset()] on the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3674 ** [prepared statement]. ^In the "v2" interface,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3675 ** the more specific error code is returned directly by sqlite3_step().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3676 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3677 ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3678 ** Perhaps it was called on a [prepared statement] that has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3679 ** already been [sqlite3_finalize \| finalized] or on one that had
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3680 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3681 ** be the case that the same database connection is being used by two or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3682 ** more threads at the same moment in time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3683 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3684 ** For all versions of SQLite up to and including 3.6.23.1, a call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3685 ** [sqlite3_reset()] was required after sqlite3_step() returned anything
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3686 ** other than [SQLITE_ROW] before any subsequent invocation of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3687 ** sqlite3_step(). Failure to reset the prepared statement using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3688 ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3689 ** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3690 ** calling [sqlite3_reset()] automatically in this circumstance rather
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3691 ** than returning [SQLITE_MISUSE]. This is not considered a compatibility
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3692 ** break because any application that ever receives an SQLITE_MISUSE error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3693 ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3694 ** can be used to restore the legacy behavior.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3695 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3696 ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3697 ** API always returns a generic error code, [SQLITE_ERROR], following any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3698 ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3699 ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3700 ** specific [error codes] that better describes the error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3701 ** We admit that this is a goofy design. The problem has been fixed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3702 ** with the "v2" interface. If you prepare all of your SQL statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3703 ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3704 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3705 ** then the more specific [error codes] are returned directly
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3706 ** by sqlite3_step(). The use of the "v2" interface is recommended.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3707 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3708 SQLITE_API int sqlite3_step(sqlite3_stmt*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3709
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3710 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3711 ** CAPI3REF: Number of columns in a result set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3712 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3713 ** ^The sqlite3_data_count(P) interface returns the number of columns in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3714 ** current row of the result set of [prepared statement] P.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3715 ** ^If prepared statement P does not have results ready to return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3716 ** (via calls to the [sqlite3_column_int \| sqlite3_column_*()] of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3717 ** interfaces) then sqlite3_data_count(P) returns 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3718 ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3719 ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3720 ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3721 ** will return non-zero if previous call to [sqlite3_step](P) returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3722 ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3723 ** where it always returns zero since each step of that multi-step
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3724 ** pragma returns 0 columns of data.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3725 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3726 ** See also: [sqlite3_column_count()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3727 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3728 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3729
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3730 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3731 ** CAPI3REF: Fundamental Datatypes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3732 ** KEYWORDS: SQLITE_TEXT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3733 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3734 ** ^(Every value in SQLite has one of five fundamental datatypes:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3735 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3736 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3737 ** <li> 64-bit signed integer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3738 ** <li> 64-bit IEEE floating point number
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3739 ** <li> string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3740 ** <li> BLOB
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3741 ** <li> NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3742 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3743 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3744 ** These constants are codes for each of those types.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3745 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3746 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3747 ** for a completely different meaning. Software that links against both
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3748 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3749 ** SQLITE_TEXT.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3750 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3751 #define SQLITE_INTEGER 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3752 #define SQLITE_FLOAT 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3753 #define SQLITE_BLOB 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3754 #define SQLITE_NULL 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3755 #ifdef SQLITE_TEXT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3756 # undef SQLITE_TEXT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3757 #else
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3758 # define SQLITE_TEXT 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3759 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3760 #define SQLITE3_TEXT 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3761
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3762 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3763 ** CAPI3REF: Result Values From A Query
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3764 ** KEYWORDS: {column access functions}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3765 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3766 ** These routines form the "result set" interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3767 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3768 ** ^These routines return information about a single column of the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3769 ** result row of a query. ^In every case the first argument is a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3770 ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3771 ** that was returned from [sqlite3_prepare_v2()] or one of its variants)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3772 ** and the second argument is the index of the column for which information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3773 ** should be returned. ^The leftmost column of the result set has the index 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3774 ** ^The number of columns in the result can be determined using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3775 ** [sqlite3_column_count()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3776 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3777 ** If the SQL statement does not currently point to a valid row, or if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3778 ** column index is out of range, the result is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3779 ** These routines may only be called when the most recent call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3780 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3781 ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3782 ** If any of these routines are called after [sqlite3_reset()] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3783 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3784 ** something other than [SQLITE_ROW], the results are undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3785 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3786 ** are called from a different thread while any of these routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3787 ** are pending, then the results are undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3788 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3789 ** ^The sqlite3_column_type() routine returns the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3790 ** [SQLITE_INTEGER \| datatype code] for the initial data type
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3791 ** of the result column. ^The returned value is one of [SQLITE_INTEGER],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3792 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3793 ** returned by sqlite3_column_type() is only meaningful if no type
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3794 ** conversions have occurred as described below. After a type conversion,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3795 ** the value returned by sqlite3_column_type() is undefined. Future
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3796 ** versions of SQLite may change the behavior of sqlite3_column_type()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3797 ** following a type conversion.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3798 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3799 ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3800 ** routine returns the number of bytes in that BLOB or string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3801 ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3802 ** the string to UTF-8 and then returns the number of bytes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3803 ** ^If the result is a numeric value then sqlite3_column_bytes() uses
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3804 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3805 ** the number of bytes in that string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3806 ** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3807 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3808 ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3809 ** routine returns the number of bytes in that BLOB or string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3810 ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3811 ** the string to UTF-16 and then returns the number of bytes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3812 ** ^If the result is a numeric value then sqlite3_column_bytes16() uses
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3813 ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3814 ** the number of bytes in that string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3815 ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3816 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3817 ** ^The values returned by [sqlite3_column_bytes()] and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3818 ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3819 ** of the string. ^For clarity: the values returned by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3820 ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3821 ** bytes in the string, not the number of characters.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3822 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3823 ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3824 ** even empty strings, are always zero-terminated. ^The return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3825 ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3826 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3827 ** ^The object returned by [sqlite3_column_value()] is an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3828 ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3829 ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3830 ** If the [unprotected sqlite3_value] object returned by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3831 ** [sqlite3_column_value()] is used in any other way, including calls
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3832 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3833 ** or [sqlite3_value_bytes()], then the behavior is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3834 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3835 ** These routines attempt to convert the value where appropriate. ^For
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3836 ** example, if the internal representation is FLOAT and a text result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3837 ** is requested, [sqlite3_snprintf()] is used internally to perform the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3838 ** conversion automatically. ^(The following table details the conversions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3839 ** that are applied:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3840 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3841 ** <blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3842 ** <table border="1">
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3843 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3844 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3845 ** <tr><td> NULL <td> INTEGER <td> Result is 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3846 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3847 ** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3848 ** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3849 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3850 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3851 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3852 ** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3853 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3854 ** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3855 ** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3856 ** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3857 ** <tr><td> TEXT <td> BLOB <td> No change
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3858 ** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3859 ** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3860 ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3861 ** </table>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3862 ** </blockquote>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3863 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3864 ** The table above makes reference to standard C library functions atoi()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3865 ** and atof(). SQLite does not really use these functions. It has its
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3866 ** own equivalent internal routines. The atoi() and atof() names are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3867 ** used in the table for brevity and because they are familiar to most
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3868 ** C programmers.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3869 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3870 ** Note that when type conversions occur, pointers returned by prior
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3871 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3872 ** sqlite3_column_text16() may be invalidated.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3873 ** Type conversions and pointer invalidations might occur
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3874 ** in the following cases:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3875 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3876 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3877 ** <li> The initial content is a BLOB and sqlite3_column_text() or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3878 ** sqlite3_column_text16() is called. A zero-terminator might
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3879 ** need to be added to the string.</li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3880 ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3881 ** sqlite3_column_text16() is called. The content must be converted
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3882 ** to UTF-16.</li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3883 ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3884 ** sqlite3_column_text() is called. The content must be converted
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3885 ** to UTF-8.</li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3886 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3887 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3888 ** ^Conversions between UTF-16be and UTF-16le are always done in place and do
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3889 ** not invalidate a prior pointer, though of course the content of the buffer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3890 ** that the prior pointer references will have been modified. Other kinds
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3891 ** of conversion are done in place when it is possible, but sometimes they
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3892 ** are not possible and in those cases prior pointers are invalidated.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3893 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3894 ** The safest and easiest to remember policy is to invoke these routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3895 ** in one of the following ways:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3896 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3897 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3898 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3899 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3900 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3901 ** </ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3902 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3903 ** In other words, you should call sqlite3_column_text(),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3904 ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3905 ** into the desired format, then invoke sqlite3_column_bytes() or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3906 ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3907 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3908 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3909 ** with calls to sqlite3_column_bytes().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3910 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3911 ** ^The pointers returned are valid until a type conversion occurs as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3912 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3913 ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3914 ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3915 ** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3916 ** [sqlite3_free()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3917 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3918 ** ^(If a memory allocation error occurs during the evaluation of any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3919 ** of these routines, a default value is returned. The default value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3920 ** is either the integer 0, the floating point number 0.0, or a NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3921 ** pointer. Subsequent calls to [sqlite3_errcode()] will return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3922 ** [SQLITE_NOMEM].)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3923 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3924 SQLITE_API const void sqlite3_column_blob(sqlite3_stmt, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3925 SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3926 SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3927 SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3928 SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3929 SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3930 SQLITE_API const unsigned char sqlite3_column_text(sqlite3_stmt, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3931 SQLITE_API const void sqlite3_column_text16(sqlite3_stmt, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3932 SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3933 SQLITE_API sqlite3_value sqlite3_column_value(sqlite3_stmt, int iCol);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3934
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3935 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3936 ** CAPI3REF: Destroy A Prepared Statement Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3937 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3938 ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3939 ** ^If the most recent evaluation of the statement encountered no errors
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3940 ** or if the statement is never been evaluated, then sqlite3_finalize() returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3941 ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3942 ** sqlite3_finalize(S) returns the appropriate [error code] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3943 ** [extended error code].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3944 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3945 ** ^The sqlite3_finalize(S) routine can be called at any point during
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3946 ** the life cycle of [prepared statement] S:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3947 ** before statement S is ever evaluated, after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3948 ** one or more calls to [sqlite3_reset()], or after any call
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3949 ** to [sqlite3_step()] regardless of whether or not the statement has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3950 ** completed execution.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3951 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3952 ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3953 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3954 ** The application must finalize every [prepared statement] in order to avoid
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3955 ** resource leaks. It is a grievous error for the application to try to use
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3956 ** a prepared statement after it has been finalized. Any use of a prepared
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3957 ** statement after it has been finalized can result in undefined and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3958 ** undesirable behavior such as segfaults and heap corruption.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3959 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3960 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3961
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3962 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3963 ** CAPI3REF: Reset A Prepared Statement Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3964 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3965 ** The sqlite3_reset() function is called to reset a [prepared statement]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3966 ** object back to its initial state, ready to be re-executed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3967 ** ^Any SQL statement variables that had values bound to them using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3968 ** the [sqlite3_bind_blob \| sqlite3_bind_*() API] retain their values.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3969 ** Use [sqlite3_clear_bindings()] to reset the bindings.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3970 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3971 ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3972 ** back to the beginning of its program.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3973 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3974 ** ^If the most recent call to [sqlite3_step(S)] for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3975 ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3976 ** or if [sqlite3_step(S)] has never before been called on S,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3977 ** then [sqlite3_reset(S)] returns [SQLITE_OK].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3978 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3979 ** ^If the most recent call to [sqlite3_step(S)] for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3980 ** [prepared statement] S indicated an error, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3981 ** [sqlite3_reset(S)] returns an appropriate [error code].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3982 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3983 ** ^The [sqlite3_reset(S)] interface does not change the values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3984 ** of any [sqlite3_bind_blob\|bindings] on the [prepared statement] S.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3985 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3986 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3987
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3988 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3989 ** CAPI3REF: Create Or Redefine SQL Functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3990 ** KEYWORDS: {function creation routines}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3991 ** KEYWORDS: {application-defined SQL function}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3992 ** KEYWORDS: {application-defined SQL functions}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3993 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3994 ** ^These functions (collectively known as "function creation routines")
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3995 ** are used to add SQL functions or aggregates or to redefine the behavior
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3996 ** of existing SQL functions or aggregates. The only differences between
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3997 ** these routines are the text encoding expected for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3998 ** the second parameter (the name of the function being created)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3999 ** and the presence or absence of a destructor callback for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4000 ** the application data pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4001 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4002 ** ^The first parameter is the [database connection] to which the SQL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4003 ** function is to be added. ^If an application uses more than one database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4004 ** connection then application-defined SQL functions must be added
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4005 ** to each database connection separately.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4006 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4007 ** ^The second parameter is the name of the SQL function to be created or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4008 ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4009 ** representation, exclusive of the zero-terminator. ^Note that the name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4010 ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4011 ** ^Any attempt to create a function with a longer name
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4012 ** will result in [SQLITE_MISUSE] being returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4013 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4014 ** ^The third parameter (nArg)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4015 ** is the number of arguments that the SQL function or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4016 ** aggregate takes. ^If this parameter is -1, then the SQL function or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4017 ** aggregate may take any number of arguments between 0 and the limit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4018 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4019 ** parameter is less than -1 or greater than 127 then the behavior is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4020 ** undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4021 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4022 ** ^The fourth parameter, eTextRep, specifies what
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4023 ** [SQLITE_UTF8 \| text encoding] this SQL function prefers for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4024 ** its parameters. The application should set this parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4025 ** [SQLITE_UTF16LE] if the function implementation invokes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4026 ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4027 ** implementation invokes [sqlite3_value_text16be()] on an input, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4028 ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4029 ** otherwise. ^The same SQL function may be registered multiple times using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4030 ** different preferred text encodings, with different implementations for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4031 ** each encoding.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4032 ** ^When multiple implementations of the same function are available, SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4033 ** will pick the one that involves the least amount of data conversion.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4034 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4035 ** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4036 ** to signal that the function will always return the same result given
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4037 ** the same inputs within a single SQL statement. Most SQL functions are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4038 ** deterministic. The built-in [random()] SQL function is an example of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4039 ** function that is not deterministic. The SQLite query planner is able to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4040 ** perform additional optimizations on deterministic functions, so use
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4041 ** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4042 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4043 ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4044 ** function can gain access to this pointer using [sqlite3_user_data()].)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4045 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4046 ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4047 ** pointers to C-language functions that implement the SQL function or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4048 ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4049 ** callback only; NULL pointers must be passed as the xStep and xFinal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4050 ** parameters. ^An aggregate SQL function requires an implementation of xStep
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4051 ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4052 ** SQL function or aggregate, pass NULL pointers for all three function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4053 ** callbacks.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4054 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4055 ** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4056 ** then it is destructor for the application data pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4057 ** The destructor is invoked when the function is deleted, either by being
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4058 ** overloaded or when the database connection closes.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4059 ** ^The destructor is also invoked if the call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4060 ** sqlite3_create_function_v2() fails.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4061 ** ^When the destructor callback of the tenth parameter is invoked, it
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4062 ** is passed a single argument which is a copy of the application data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4063 ** pointer which was the fifth parameter to sqlite3_create_function_v2().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4064 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4065 ** ^It is permitted to register multiple implementations of the same
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4066 ** functions with the same name but with either differing numbers of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4067 ** arguments or differing preferred text encodings. ^SQLite will use
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4068 ** the implementation that most closely matches the way in which the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4069 ** SQL function is used. ^A function implementation with a non-negative
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4070 ** nArg parameter is a better match than a function implementation with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4071 ** a negative nArg. ^A function where the preferred text encoding
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4072 ** matches the database encoding is a better
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4073 ** match than a function where the encoding is different.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4074 ** ^A function where the encoding difference is between UTF16le and UTF16be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4075 ** is a closer match than a function where the encoding difference is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4076 ** between UTF8 and UTF16.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4077 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4078 ** ^Built-in functions may be overloaded by new application-defined functions.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4079 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4080 ** ^An application-defined function is permitted to call other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4081 ** SQLite interfaces. However, such calls must not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4082 ** close the database connection nor finalize or reset the prepared
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4083 ** statement in which the function is running.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4084 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4085 SQLITE_API int sqlite3_create_function(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4086 sqlite3 *db,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4087 const char *zFunctionName,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4088 int nArg,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4089 int eTextRep,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4090 void *pApp,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4091 void (xFunc)(sqlite3_context,int,sqlite3_value**),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4092 void (xStep)(sqlite3_context,int,sqlite3_value**),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4093 void (xFinal)(sqlite3_context)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4094 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4095 SQLITE_API int sqlite3_create_function16(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4096 sqlite3 *db,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4097 const void *zFunctionName,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4098 int nArg,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4099 int eTextRep,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4100 void *pApp,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4101 void (xFunc)(sqlite3_context,int,sqlite3_value**),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4102 void (xStep)(sqlite3_context,int,sqlite3_value**),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4103 void (xFinal)(sqlite3_context)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4104 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4105 SQLITE_API int sqlite3_create_function_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4106 sqlite3 *db,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4107 const char *zFunctionName,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4108 int nArg,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4109 int eTextRep,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4110 void *pApp,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4111 void (xFunc)(sqlite3_context,int,sqlite3_value**),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4112 void (xStep)(sqlite3_context,int,sqlite3_value**),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4113 void (xFinal)(sqlite3_context),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4114 void(xDestroy)(void)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4115 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4116
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4117 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4118 ** CAPI3REF: Text Encodings
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4119 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4120 ** These constant define integer codes that represent the various
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4121 ** text encodings supported by SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4122 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4123 #define SQLITE_UTF8 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4124 #define SQLITE_UTF16LE 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4125 #define SQLITE_UTF16BE 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4126 #define SQLITE_UTF16 4 /* Use native byte order */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4127 #define SQLITE_ANY 5 /* Deprecated */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4128 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4129
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4130 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4131 ** CAPI3REF: Function Flags
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4132 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4133 ** These constants may be ORed together with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4134 ** [SQLITE_UTF8 \| preferred text encoding] as the fourth argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4135 ** to [sqlite3_create_function()], [sqlite3_create_function16()], or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4136 ** [sqlite3_create_function_v2()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4137 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4138 #define SQLITE_DETERMINISTIC 0x800
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4139
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4140 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4141 ** CAPI3REF: Deprecated Functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4142 ** DEPRECATED
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4143 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4144 ** These functions are [deprecated]. In order to maintain
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4145 ** backwards compatibility with older code, these functions continue
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4146 ** to be supported. However, new applications should avoid
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4147 ** the use of these functions. To help encourage people to avoid
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4148 ** using these functions, we are not going to tell you what they do.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4149 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4150 #ifndef SQLITE_OMIT_DEPRECATED
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4151 SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4152 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4153 SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt, sqlite3_stmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4154 SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4155 SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4156 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void()(void,sqlite3_int64,int),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4157 void*,sqlite3_int64);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4158 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4159
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4160 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4161 ** CAPI3REF: Obtaining SQL Function Parameter Values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4162 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4163 ** The C-language implementation of SQL functions and aggregates uses
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4164 ** this set of interface routines to access the parameter values on
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4165 ** the function or aggregate.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4166 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4167 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4168 ** to [sqlite3_create_function()] and [sqlite3_create_function16()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4169 ** define callbacks that implement the SQL functions and aggregates.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4170 ** The 3rd parameter to these callbacks is an array of pointers to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4171 ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4172 ** each parameter to the SQL function. These routines are used to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4173 ** extract values from the [sqlite3_value] objects.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4174 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4175 ** These routines work only with [protected sqlite3_value] objects.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4176 ** Any attempt to use these routines on an [unprotected sqlite3_value]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4177 ** object results in undefined behavior.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4178 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4179 ** ^These routines work just like the corresponding [column access functions]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4180 ** except that these routines take a single [protected sqlite3_value] object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4181 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4182 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4183 ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4184 ** in the native byte-order of the host machine. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4185 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4186 ** extract UTF-16 strings as big-endian and little-endian respectively.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4187 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4188 ** ^(The sqlite3_value_numeric_type() interface attempts to apply
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4189 ** numeric affinity to the value. This means that an attempt is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4190 ** made to convert the value to an integer or floating point. If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4191 ** such a conversion is possible without loss of information (in other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4192 ** words, if the value is a string that looks like a number)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4193 ** then the conversion is performed. Otherwise no conversion occurs.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4194 ** The [SQLITE_INTEGER \| datatype] after conversion is returned.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4195 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4196 ** Please pay particular attention to the fact that the pointer returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4197 ** from [sqlite3_value_blob()], [sqlite3_value_text()], or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4198 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4199 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4200 ** or [sqlite3_value_text16()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4201 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4202 ** These routines must be called from the same thread as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4203 ** the SQL function that supplied the [sqlite3_value*] parameters.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4204 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4205 SQLITE_API const void sqlite3_value_blob(sqlite3_value);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4206 SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4207 SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4208 SQLITE_API double sqlite3_value_double(sqlite3_value*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4209 SQLITE_API int sqlite3_value_int(sqlite3_value*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4210 SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4211 SQLITE_API const unsigned char sqlite3_value_text(sqlite3_value);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4212 SQLITE_API const void sqlite3_value_text16(sqlite3_value);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4213 SQLITE_API const void sqlite3_value_text16le(sqlite3_value);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4214 SQLITE_API const void sqlite3_value_text16be(sqlite3_value);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4215 SQLITE_API int sqlite3_value_type(sqlite3_value*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4216 SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4217
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4218 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4219 ** CAPI3REF: Obtain Aggregate Function Context
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4220 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4221 ** Implementations of aggregate SQL functions use this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4222 ** routine to allocate memory for storing their state.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4223 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4224 ** ^The first time the sqlite3_aggregate_context(C,N) routine is called
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4225 ** for a particular aggregate function, SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4226 ** allocates N of memory, zeroes out that memory, and returns a pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4227 ** to the new memory. ^On second and subsequent calls to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4228 ** sqlite3_aggregate_context() for the same aggregate function instance,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4229 ** the same buffer is returned. Sqlite3_aggregate_context() is normally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4230 ** called once for each invocation of the xStep callback and then one
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4231 ** last time when the xFinal callback is invoked. ^(When no rows match
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4232 ** an aggregate query, the xStep() callback of the aggregate function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4233 ** implementation is never called and xFinal() is called exactly once.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4234 ** In those cases, sqlite3_aggregate_context() might be called for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4235 ** first time from within xFinal().)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4236 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4237 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4238 ** when first called if N is less than or equal to zero or if a memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4239 ** allocate error occurs.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4240 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4241 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4242 ** determined by the N parameter on first successful call. Changing the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4243 ** value of N in subsequent call to sqlite3_aggregate_context() within
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4244 ** the same aggregate function instance will not resize the memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4245 ** allocation.)^ Within the xFinal callback, it is customary to set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4246 ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4247 ** pointless memory allocations occur.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4248 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4249 ** ^SQLite automatically frees the memory allocated by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4250 ** sqlite3_aggregate_context() when the aggregate query concludes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4251 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4252 ** The first parameter must be a copy of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4253 ** [sqlite3_context \| SQL function context] that is the first parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4254 ** to the xStep or xFinal callback routine that implements the aggregate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4255 ** function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4256 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4257 ** This routine must be called from the same thread in which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4258 ** the aggregate SQL function is running.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4259 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4260 SQLITE_API void sqlite3_aggregate_context(sqlite3_context, int nBytes);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4261
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4262 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4263 ** CAPI3REF: User Data For Functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4264 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4265 ** ^The sqlite3_user_data() interface returns a copy of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4266 ** the pointer that was the pUserData parameter (the 5th parameter)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4267 ** of the [sqlite3_create_function()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4268 ** and [sqlite3_create_function16()] routines that originally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4269 ** registered the application defined function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4270 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4271 ** This routine must be called from the same thread in which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4272 ** the application-defined function is running.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4273 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4274 SQLITE_API void sqlite3_user_data(sqlite3_context);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4275
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4276 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4277 ** CAPI3REF: Database Connection For Functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4278 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4279 ** ^The sqlite3_context_db_handle() interface returns a copy of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4280 ** the pointer to the [database connection] (the 1st parameter)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4281 ** of the [sqlite3_create_function()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4282 ** and [sqlite3_create_function16()] routines that originally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4283 ** registered the application defined function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4284 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4285 SQLITE_API sqlite3 sqlite3_context_db_handle(sqlite3_context);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4286
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4287 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4288 ** CAPI3REF: Function Auxiliary Data
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4289 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4290 ** These functions may be used by (non-aggregate) SQL functions to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4291 ** associate metadata with argument values. If the same value is passed to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4292 ** multiple invocations of the same SQL function during query execution, under
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4293 ** some circumstances the associated metadata may be preserved. An example
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4294 ** of where this might be useful is in a regular-expression matching
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4295 ** function. The compiled version of the regular expression can be stored as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4296 ** metadata associated with the pattern string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4297 ** Then as long as the pattern string remains the same,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4298 ** the compiled regular expression can be reused on multiple
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4299 ** invocations of the same function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4300 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4301 ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4302 ** associated by the sqlite3_set_auxdata() function with the Nth argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4303 ** value to the application-defined function. ^If there is no metadata
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4304 ** associated with the function argument, this sqlite3_get_auxdata() interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4305 ** returns a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4306 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4307 ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4308 ** argument of the application-defined function. ^Subsequent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4309 ** calls to sqlite3_get_auxdata(C,N) return P from the most recent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4310 ** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4311 ** NULL if the metadata has been discarded.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4312 ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4313 ** SQLite will invoke the destructor function X with parameter P exactly
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4314 ** once, when the metadata is discarded.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4315 ** SQLite is free to discard the metadata at any time, including: <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4316 ** <li> when the corresponding function parameter changes, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4317 ** <li> when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4318 ** SQL statement, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4319 ** <li> when sqlite3_set_auxdata() is invoked again on the same parameter, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4320 ** <li> during the original sqlite3_set_auxdata() call when a memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4321 ** allocation error occurs. </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4322 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4323 ** Note the last bullet in particular. The destructor X in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4324 ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4325 ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4326 ** should be called near the end of the function implementation and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4327 ** function implementation should not make any use of P after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4328 ** sqlite3_set_auxdata() has been called.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4329 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4330 ** ^(In practice, metadata is preserved between function calls for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4331 ** function parameters that are compile-time constants, including literal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4332 ** values and [parameters] and expressions composed from the same.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4333 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4334 ** These routines must be called from the same thread in which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4335 ** the SQL function is running.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4336 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4337 SQLITE_API void sqlite3_get_auxdata(sqlite3_context, int N);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4338 SQLITE_API void sqlite3_set_auxdata(sqlite3_context, int N, void, void ()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4339
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4340
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4341 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4342 ** CAPI3REF: Constants Defining Special Destructor Behavior
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4343 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4344 ** These are special values for the destructor that is passed in as the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4345 ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4346 ** argument is SQLITE_STATIC, it means that the content pointer is constant
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4347 ** and will never change. It does not need to be destroyed. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4348 ** SQLITE_TRANSIENT value means that the content will likely change in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4349 ** the near future and that SQLite should make its own private copy of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4350 ** the content before returning.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4351 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4352 ** The typedef is necessary to work around problems in certain
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4353 ** C++ compilers.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4354 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4355 typedef void (sqlite3_destructor_type)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4356 #define SQLITE_STATIC ((sqlite3_destructor_type)0)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4357 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4358
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4359 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4360 ** CAPI3REF: Setting The Result Of An SQL Function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4361 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4362 ** These routines are used by the xFunc or xFinal callbacks that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4363 ** implement SQL functions and aggregates. See
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4364 ** [sqlite3_create_function()] and [sqlite3_create_function16()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4365 ** for additional information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4366 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4367 ** These functions work very much like the [parameter binding] family of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4368 ** functions used to bind values to host parameters in prepared statements.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4369 ** Refer to the [SQL parameter] documentation for additional information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4370 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4371 ** ^The sqlite3_result_blob() interface sets the result from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4372 ** an application-defined function to be the BLOB whose content is pointed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4373 ** to by the second parameter and which is N bytes long where N is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4374 ** third parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4375 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4376 ** ^The sqlite3_result_zeroblob() interfaces set the result of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4377 ** the application-defined function to be a BLOB containing all zero
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4378 ** bytes and N bytes in size, where N is the value of the 2nd parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4379 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4380 ** ^The sqlite3_result_double() interface sets the result from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4381 ** an application-defined function to be a floating point value specified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4382 ** by its 2nd argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4383 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4384 ** ^The sqlite3_result_error() and sqlite3_result_error16() functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4385 ** cause the implemented SQL function to throw an exception.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4386 ** ^SQLite uses the string pointed to by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4387 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4388 ** as the text of an error message. ^SQLite interprets the error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4389 ** message string from sqlite3_result_error() as UTF-8. ^SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4390 ** interprets the string from sqlite3_result_error16() as UTF-16 in native
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4391 ** byte order. ^If the third parameter to sqlite3_result_error()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4392 ** or sqlite3_result_error16() is negative then SQLite takes as the error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4393 ** message all text up through the first zero character.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4394 ** ^If the third parameter to sqlite3_result_error() or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4395 ** sqlite3_result_error16() is non-negative then SQLite takes that many
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4396 ** bytes (not characters) from the 2nd parameter as the error message.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4397 ** ^The sqlite3_result_error() and sqlite3_result_error16()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4398 ** routines make a private copy of the error message text before
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4399 ** they return. Hence, the calling function can deallocate or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4400 ** modify the text after they return without harm.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4401 ** ^The sqlite3_result_error_code() function changes the error code
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4402 ** returned by SQLite as a result of an error in a function. ^By default,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4403 ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4404 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4405 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4406 ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4407 ** error indicating that a string or BLOB is too long to represent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4408 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4409 ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4410 ** error indicating that a memory allocation failed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4411 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4412 ** ^The sqlite3_result_int() interface sets the return value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4413 ** of the application-defined function to be the 32-bit signed integer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4414 ** value given in the 2nd argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4415 ** ^The sqlite3_result_int64() interface sets the return value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4416 ** of the application-defined function to be the 64-bit signed integer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4417 ** value given in the 2nd argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4418 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4419 ** ^The sqlite3_result_null() interface sets the return value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4420 ** of the application-defined function to be NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4421 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4422 ** ^The sqlite3_result_text(), sqlite3_result_text16(),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4423 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4424 ** set the return value of the application-defined function to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4425 ** a text string which is represented as UTF-8, UTF-16 native byte order,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4426 ** UTF-16 little endian, or UTF-16 big endian, respectively.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4427 ** ^SQLite takes the text result from the application from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4428 ** the 2nd parameter of the sqlite3_result_text* interfaces.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4429 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4430 ** is negative, then SQLite takes result text from the 2nd parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4431 ** through the first zero character.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4432 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4433 ** is non-negative, then as many bytes (not characters) of the text
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4434 ** pointed to by the 2nd parameter are taken as the application-defined
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4435 ** function result. If the 3rd parameter is non-negative, then it
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4436 ** must be the byte offset into the string where the NUL terminator would
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4437 ** appear if the string where NUL terminated. If any NUL characters occur
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4438 ** in the string at a byte offset that is less than the value of the 3rd
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4439 ** parameter, then the resulting string will contain embedded NULs and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4440 ** result of expressions operating on strings with embedded NULs is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4441 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4442 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4443 ** function as the destructor on the text or BLOB result when it has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4444 ** finished using that result.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4445 ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4446 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4447 ** assumes that the text or BLOB result is in constant space and does not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4448 ** copy the content of the parameter nor call a destructor on the content
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4449 ** when it has finished using that result.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4450 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4451 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4452 ** then SQLite makes a copy of the result into space obtained from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4453 ** from [sqlite3_malloc()] before it returns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4454 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4455 ** ^The sqlite3_result_value() interface sets the result of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4456 ** the application-defined function to be a copy the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4457 ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4458 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4459 ** so that the [sqlite3_value] specified in the parameter may change or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4460 ** be deallocated after sqlite3_result_value() returns without harm.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4461 ** ^A [protected sqlite3_value] object may always be used where an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4462 ** [unprotected sqlite3_value] object is required, so either
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4463 ** kind of [sqlite3_value] object can be used with this interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4464 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4465 ** If these routines are called from within the different thread
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4466 ** than the one containing the application-defined function that received
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4467 ** the [sqlite3_context] pointer, the results are undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4468 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4469 SQLITE_API void sqlite3_result_blob(sqlite3_context, const void, int, void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4470 SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4471 SQLITE_API void sqlite3_result_error(sqlite3_context, const char, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4472 SQLITE_API void sqlite3_result_error16(sqlite3_context, const void, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4473 SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4474 SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4475 SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4476 SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4477 SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4478 SQLITE_API void sqlite3_result_null(sqlite3_context*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4479 SQLITE_API void sqlite3_result_text(sqlite3_context, const char, int, void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4480 SQLITE_API void sqlite3_result_text16(sqlite3_context, const void, int, void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4481 SQLITE_API void sqlite3_result_text16le(sqlite3_context, const void, int,void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4482 SQLITE_API void sqlite3_result_text16be(sqlite3_context, const void, int,void()(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4483 SQLITE_API void sqlite3_result_value(sqlite3_context, sqlite3_value);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4484 SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4485
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4486 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4487 ** CAPI3REF: Define New Collating Sequences
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4488 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4489 ** ^These functions add, remove, or modify a [collation] associated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4490 ** with the [database connection] specified as the first argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4491 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4492 ** ^The name of the collation is a UTF-8 string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4493 ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4494 ** and a UTF-16 string in native byte order for sqlite3_create_collation16().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4495 ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4496 ** considered to be the same name.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4497 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4498 ** ^(The third argument (eTextRep) must be one of the constants:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4499 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4500 ** <li> [SQLITE_UTF8],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4501 ** <li> [SQLITE_UTF16LE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4502 ** <li> [SQLITE_UTF16BE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4503 ** <li> [SQLITE_UTF16], or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4504 ** <li> [SQLITE_UTF16_ALIGNED].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4505 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4506 ** ^The eTextRep argument determines the encoding of strings passed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4507 ** to the collating function callback, xCallback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4508 ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4509 ** force strings to be UTF16 with native byte order.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4510 ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4511 ** on an even byte address.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4512 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4513 ** ^The fourth argument, pArg, is an application data pointer that is passed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4514 ** through as the first argument to the collating function callback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4515 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4516 ** ^The fifth argument, xCallback, is a pointer to the collating function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4517 ** ^Multiple collating functions can be registered using the same name but
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4518 ** with different eTextRep parameters and SQLite will use whichever
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4519 ** function requires the least amount of data transformation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4520 ** ^If the xCallback argument is NULL then the collating function is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4521 ** deleted. ^When all collating functions having the same name are deleted,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4522 ** that collation is no longer usable.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4523 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4524 ** ^The collating function callback is invoked with a copy of the pArg
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4525 ** application data pointer and with two strings in the encoding specified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4526 ** by the eTextRep argument. The collating function must return an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4527 ** integer that is negative, zero, or positive
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4528 ** if the first string is less than, equal to, or greater than the second,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4529 ** respectively. A collating function must always return the same answer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4530 ** given the same inputs. If two or more collating functions are registered
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4531 ** to the same collation name (using different eTextRep values) then all
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4532 ** must give an equivalent answer when invoked with equivalent strings.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4533 ** The collating function must obey the following properties for all
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4534 ** strings A, B, and C:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4535 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4536 ** <ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4537 ** <li> If A==B then B==A.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4538 ** <li> If A==B and B==C then A==C.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4539 ** <li> If A<B THEN B>A.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4540 ** <li> If A<B and B<C then A<C.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4541 ** </ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4542 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4543 ** If a collating function fails any of the above constraints and that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4544 ** collating function is registered and used, then the behavior of SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4545 ** is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4546 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4547 ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4548 ** with the addition that the xDestroy callback is invoked on pArg when
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4549 ** the collating function is deleted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4550 ** ^Collating functions are deleted when they are overridden by later
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4551 ** calls to the collation creation functions or when the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4552 ** [database connection] is closed using [sqlite3_close()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4553 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4554 ** ^The xDestroy callback is <u>not</u> called if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4555 ** sqlite3_create_collation_v2() function fails. Applications that invoke
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4556 ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4557 ** check the return code and dispose of the application data pointer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4558 ** themselves rather than expecting SQLite to deal with it for them.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4559 ** This is different from every other SQLite interface. The inconsistency
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4560 ** is unfortunate but cannot be changed without breaking backwards
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4561 ** compatibility.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4562 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4563 ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4564 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4565 SQLITE_API int sqlite3_create_collation(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4566 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4567 const char *zName,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4568 int eTextRep,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4569 void *pArg,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4570 int(xCompare)(void,int,const void,int,const void)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4571 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4572 SQLITE_API int sqlite3_create_collation_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4573 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4574 const char *zName,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4575 int eTextRep,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4576 void *pArg,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4577 int(xCompare)(void,int,const void,int,const void),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4578 void(xDestroy)(void)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4579 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4580 SQLITE_API int sqlite3_create_collation16(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4581 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4582 const void *zName,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4583 int eTextRep,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4584 void *pArg,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4585 int(xCompare)(void,int,const void,int,const void)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4586 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4587
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4588 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4589 ** CAPI3REF: Collation Needed Callbacks
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4590 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4591 ** ^To avoid having to register all collation sequences before a database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4592 ** can be used, a single callback function may be registered with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4593 ** [database connection] to be invoked whenever an undefined collation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4594 ** sequence is required.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4595 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4596 ** ^If the function is registered using the sqlite3_collation_needed() API,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4597 ** then it is passed the names of undefined collation sequences as strings
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4598 ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4599 ** the names are passed as UTF-16 in machine native byte order.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4600 ** ^A call to either function replaces the existing collation-needed callback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4601 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4602 ** ^(When the callback is invoked, the first argument passed is a copy
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4603 ** of the second argument to sqlite3_collation_needed() or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4604 ** sqlite3_collation_needed16(). The second argument is the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4605 ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4606 ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4607 ** sequence function required. The fourth parameter is the name of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4608 ** required collation sequence.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4609 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4610 ** The callback function should register the desired collation using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4611 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4612 ** [sqlite3_create_collation_v2()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4613 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4614 SQLITE_API int sqlite3_collation_needed(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4615 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4616 void*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4617 void()(void,sqlite3,int eTextRep,const char)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4618 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4619 SQLITE_API int sqlite3_collation_needed16(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4620 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4621 void*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4622 void()(void,sqlite3,int eTextRep,const void)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4623 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4624
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4625 #ifdef SQLITE_HAS_CODEC
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4626 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4627 ** Specify the key for an encrypted database. This routine should be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4628 ** called right after sqlite3_open().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4629 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4630 ** The code to implement this API is not available in the public release
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4631 ** of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4632 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4633 SQLITE_API int sqlite3_key(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4634 sqlite3 db, / Database to be rekeyed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4635 const void pKey, int nKey / The key */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4636 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4637 SQLITE_API int sqlite3_key_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4638 sqlite3 db, / Database to be rekeyed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4639 const char zDbName, / Name of the database */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4640 const void pKey, int nKey / The key */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4641 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4642
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4643 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4644 ** Change the key on an open database. If the current database is not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4645 ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4646 ** database is decrypted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4647 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4648 ** The code to implement this API is not available in the public release
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4649 ** of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4650 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4651 SQLITE_API int sqlite3_rekey(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4652 sqlite3 db, / Database to be rekeyed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4653 const void pKey, int nKey / The new key */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4654 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4655 SQLITE_API int sqlite3_rekey_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4656 sqlite3 db, / Database to be rekeyed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4657 const char zDbName, / Name of the database */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4658 const void pKey, int nKey / The new key */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4659 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4660
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4661 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4662 ** Specify the activation key for a SEE database. Unless
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4663 ** activated, none of the SEE routines will work.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4664 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4665 SQLITE_API void sqlite3_activate_see(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4666 const char zPassPhrase / Activation phrase */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4667 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4668 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4669
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4670 #ifdef SQLITE_ENABLE_CEROD
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4671 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4672 ** Specify the activation key for a CEROD database. Unless
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4673 ** activated, none of the CEROD routines will work.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4674 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4675 SQLITE_API void sqlite3_activate_cerod(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4676 const char zPassPhrase / Activation phrase */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4677 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4678 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4679
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4680 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4681 ** CAPI3REF: Suspend Execution For A Short Time
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4682 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4683 ** The sqlite3_sleep() function causes the current thread to suspend execution
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4684 ** for at least a number of milliseconds specified in its parameter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4685 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4686 ** If the operating system does not support sleep requests with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4687 ** millisecond time resolution, then the time will be rounded up to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4688 ** the nearest second. The number of milliseconds of sleep actually
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4689 ** requested from the operating system is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4690 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4691 ** ^SQLite implements this interface by calling the xSleep()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4692 ** method of the default [sqlite3_vfs] object. If the xSleep() method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4693 ** of the default VFS is not implemented correctly, or not implemented at
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4694 ** all, then the behavior of sqlite3_sleep() may deviate from the description
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4695 ** in the previous paragraphs.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4696 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4697 SQLITE_API int sqlite3_sleep(int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4698
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4699 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4700 ** CAPI3REF: Name Of The Folder Holding Temporary Files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4701 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4702 ** ^(If this global variable is made to point to a string which is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4703 ** the name of a folder (a.k.a. directory), then all temporary files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4704 ** created by SQLite when using a built-in [sqlite3_vfs \| VFS]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4705 ** will be placed in that directory.)^ ^If this variable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4706 ** is a NULL pointer, then SQLite performs a search for an appropriate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4707 ** temporary file directory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4708 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4709 ** It is not safe to read or modify this variable in more than one
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4710 ** thread at a time. It is not safe to read or modify this variable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4711 ** if a [database connection] is being used at the same time in a separate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4712 ** thread.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4713 ** It is intended that this variable be set once
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4714 ** as part of process initialization and before any SQLite interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4715 ** routines have been called and that this variable remain unchanged
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4716 ** thereafter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4717 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4718 ** ^The [temp_store_directory pragma] may modify this variable and cause
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4719 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4720 ** the [temp_store_directory pragma] always assumes that any string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4721 ** that this variable points to is held in memory obtained from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4722 ** [sqlite3_malloc] and the pragma may attempt to free that memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4723 ** using [sqlite3_free].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4724 ** Hence, if this variable is modified directly, either it should be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4725 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4726 ** or else the use of the [temp_store_directory pragma] should be avoided.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4727 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4728 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4729 ** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4730 ** features that require the use of temporary files may fail. Here is an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4731 ** example of how to do this using C++ with the Windows Runtime:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4732 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4733 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4734 ** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4735 **   TemporaryFolder->Path->Data();
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4736 ** char zPathBuf[MAX_PATH + 1];
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4737 ** memset(zPathBuf, 0, sizeof(zPathBuf));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4738 ** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4739 **   NULL, NULL);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4740 ** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4741 ** </pre></blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4742 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4743 SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4744
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4745 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4746 ** CAPI3REF: Name Of The Folder Holding Database Files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4747 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4748 ** ^(If this global variable is made to point to a string which is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4749 ** the name of a folder (a.k.a. directory), then all database files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4750 ** specified with a relative pathname and created or accessed by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4751 ** SQLite when using a built-in windows [sqlite3_vfs \| VFS] will be assumed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4752 ** to be relative to that directory.)^ ^If this variable is a NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4753 ** pointer, then SQLite assumes that all database files specified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4754 ** with a relative pathname are relative to the current directory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4755 ** for the process. Only the windows VFS makes use of this global
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4756 ** variable; it is ignored by the unix VFS.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4757 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4758 ** Changing the value of this variable while a database connection is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4759 ** open can result in a corrupt database.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4760 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4761 ** It is not safe to read or modify this variable in more than one
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4762 ** thread at a time. It is not safe to read or modify this variable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4763 ** if a [database connection] is being used at the same time in a separate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4764 ** thread.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4765 ** It is intended that this variable be set once
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4766 ** as part of process initialization and before any SQLite interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4767 ** routines have been called and that this variable remain unchanged
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4768 ** thereafter.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4769 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4770 ** ^The [data_store_directory pragma] may modify this variable and cause
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4771 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4772 ** the [data_store_directory pragma] always assumes that any string
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4773 ** that this variable points to is held in memory obtained from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4774 ** [sqlite3_malloc] and the pragma may attempt to free that memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4775 ** using [sqlite3_free].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4776 ** Hence, if this variable is modified directly, either it should be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4777 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4778 ** or else the use of the [data_store_directory pragma] should be avoided.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4779 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4780 SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4781
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4782 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4783 ** CAPI3REF: Test For Auto-Commit Mode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4784 ** KEYWORDS: {autocommit mode}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4785 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4786 ** ^The sqlite3_get_autocommit() interface returns non-zero or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4787 ** zero if the given database connection is or is not in autocommit mode,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4788 ** respectively. ^Autocommit mode is on by default.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4789 ** ^Autocommit mode is disabled by a [BEGIN] statement.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4790 ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4791 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4792 ** If certain kinds of errors occur on a statement within a multi-statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4793 ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4794 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4795 ** transaction might be rolled back automatically. The only way to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4796 ** find out whether SQLite automatically rolled back the transaction after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4797 ** an error is to use this function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4798 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4799 ** If another thread changes the autocommit status of the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4800 ** connection while this routine is running, then the return value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4801 ** is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4802 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4803 SQLITE_API int sqlite3_get_autocommit(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4804
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4805 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4806 ** CAPI3REF: Find The Database Handle Of A Prepared Statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4807 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4808 ** ^The sqlite3_db_handle interface returns the [database connection] handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4809 ** to which a [prepared statement] belongs. ^The [database connection]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4810 ** returned by sqlite3_db_handle is the same [database connection]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4811 ** that was the first argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4812 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4813 ** create the statement in the first place.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4814 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4815 SQLITE_API sqlite3 sqlite3_db_handle(sqlite3_stmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4816
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4817 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4818 ** CAPI3REF: Return The Filename For A Database Connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4819 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4820 ** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4821 ** associated with database N of connection D. ^The main database file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4822 ** has the name "main". If there is no attached database N on the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4823 ** connection D, or if database N is a temporary or in-memory database, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4824 ** a NULL pointer is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4825 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4826 ** ^The filename returned by this function is the output of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4827 ** xFullPathname method of the [VFS]. ^In other words, the filename
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4828 ** will be an absolute pathname, even if the filename used
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4829 ** to open the database originally was a URI or relative pathname.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4830 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4831 SQLITE_API const char sqlite3_db_filename(sqlite3 db, const char *zDbName);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4832
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4833 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4834 ** CAPI3REF: Determine if a database is read-only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4835 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4836 ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4837 ** of connection D is read-only, 0 if it is read/write, or -1 if N is not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4838 ** the name of a database on connection D.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4839 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4840 SQLITE_API int sqlite3_db_readonly(sqlite3 db, const char zDbName);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4841
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4842 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4843 ** CAPI3REF: Find the next prepared statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4844 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4845 ** ^This interface returns a pointer to the next [prepared statement] after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4846 ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4847 ** then this interface returns a pointer to the first prepared statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4848 ** associated with the database connection pDb. ^If no prepared statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4849 ** satisfies the conditions of this routine, it returns NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4850 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4851 ** The [database connection] pointer D in a call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4852 ** [sqlite3_next_stmt(D,S)] must refer to an open database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4853 ** connection and in particular must not be a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4854 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4855 SQLITE_API sqlite3_stmt sqlite3_next_stmt(sqlite3 pDb, sqlite3_stmt *pStmt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4856
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4857 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4858 ** CAPI3REF: Commit And Rollback Notification Callbacks
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4859 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4860 ** ^The sqlite3_commit_hook() interface registers a callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4861 ** function to be invoked whenever a transaction is [COMMIT \| committed].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4862 ** ^Any callback set by a previous call to sqlite3_commit_hook()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4863 ** for the same database connection is overridden.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4864 ** ^The sqlite3_rollback_hook() interface registers a callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4865 ** function to be invoked whenever a transaction is [ROLLBACK \| rolled back].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4866 ** ^Any callback set by a previous call to sqlite3_rollback_hook()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4867 ** for the same database connection is overridden.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4868 ** ^The pArg argument is passed through to the callback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4869 ** ^If the callback on a commit hook function returns non-zero,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4870 ** then the commit is converted into a rollback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4871 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4872 ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4873 ** return the P argument from the previous call of the same function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4874 ** on the same [database connection] D, or NULL for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4875 ** the first call for each function on D.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4876 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4877 ** The commit and rollback hook callbacks are not reentrant.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4878 ** The callback implementation must not do anything that will modify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4879 ** the database connection that invoked the callback. Any actions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4880 ** to modify the database connection must be deferred until after the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4881 ** completion of the [sqlite3_step()] call that triggered the commit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4882 ** or rollback hook in the first place.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4883 ** Note that running any other SQL statements, including SELECT statements,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4884 ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4885 ** the database connections for the meaning of "modify" in this paragraph.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4886 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4887 ** ^Registering a NULL function disables the callback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4888 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4889 ** ^When the commit hook callback routine returns zero, the [COMMIT]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4890 ** operation is allowed to continue normally. ^If the commit hook
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4891 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4892 ** ^The rollback hook is invoked on a rollback that results from a commit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4893 ** hook returning non-zero, just as it would be with any other rollback.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4894 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4895 ** ^For the purposes of this API, a transaction is said to have been
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4896 ** rolled back if an explicit "ROLLBACK" statement is executed, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4897 ** an error or constraint causes an implicit rollback to occur.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4898 ** ^The rollback callback is not invoked if a transaction is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4899 ** automatically rolled back because the database connection is closed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4900 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4901 ** See also the [sqlite3_update_hook()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4902 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4903 SQLITE_API void sqlite3_commit_hook(sqlite3, int()(void), void*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4904 SQLITE_API void sqlite3_rollback_hook(sqlite3, void()(void ), void*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4905
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4906 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4907 ** CAPI3REF: Data Change Notification Callbacks
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4908 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4909 ** ^The sqlite3_update_hook() interface registers a callback function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4910 ** with the [database connection] identified by the first argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4911 ** to be invoked whenever a row is updated, inserted or deleted in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4912 ** a rowid table.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4913 ** ^Any callback set by a previous call to this function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4914 ** for the same database connection is overridden.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4915 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4916 ** ^The second argument is a pointer to the function to invoke when a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4917 ** row is updated, inserted or deleted in a rowid table.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4918 ** ^The first argument to the callback is a copy of the third argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4919 ** to sqlite3_update_hook().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4920 ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4921 ** or [SQLITE_UPDATE], depending on the operation that caused the callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4922 ** to be invoked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4923 ** ^The third and fourth arguments to the callback contain pointers to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4924 ** database and table name containing the affected row.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4925 ** ^The final callback parameter is the [rowid] of the row.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4926 ** ^In the case of an update, this is the [rowid] after the update takes place.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4927 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4928 ** ^(The update hook is not invoked when internal system tables are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4929 ** modified (i.e. sqlite_master and sqlite_sequence).)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4930 ** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4931 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4932 ** ^In the current implementation, the update hook
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4933 ** is not invoked when duplication rows are deleted because of an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4934 ** [ON CONFLICT \| ON CONFLICT REPLACE] clause. ^Nor is the update hook
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4935 ** invoked when rows are deleted using the [truncate optimization].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4936 ** The exceptions defined in this paragraph might change in a future
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4937 ** release of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4938 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4939 ** The update hook implementation must not do anything that will modify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4940 ** the database connection that invoked the update hook. Any actions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4941 ** to modify the database connection must be deferred until after the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4942 ** completion of the [sqlite3_step()] call that triggered the update hook.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4943 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4944 ** database connections for the meaning of "modify" in this paragraph.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4945 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4946 ** ^The sqlite3_update_hook(D,C,P) function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4947 ** returns the P argument from the previous call
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4948 ** on the same [database connection] D, or NULL for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4949 ** the first call on D.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4950 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4951 ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4952 ** interfaces.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4953 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4954 SQLITE_API void *sqlite3_update_hook(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4955 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4956 void()(void ,int ,char const ,char const ,sqlite3_int64),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4957 void*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4958 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4959
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4960 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4961 ** CAPI3REF: Enable Or Disable Shared Pager Cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4962 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4963 ** ^(This routine enables or disables the sharing of the database cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4964 ** and schema data structures between [database connection \| connections]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4965 ** to the same database. Sharing is enabled if the argument is true
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4966 ** and disabled if the argument is false.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4967 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4968 ** ^Cache sharing is enabled and disabled for an entire process.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4969 ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4970 ** sharing was enabled or disabled for each thread separately.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4971 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4972 ** ^(The cache sharing mode set by this interface effects all subsequent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4973 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4974 ** Existing database connections continue use the sharing mode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4975 ** that was in effect at the time they were opened.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4976 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4977 ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4978 ** successfully. An [error code] is returned otherwise.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4979 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4980 ** ^Shared cache is disabled by default. But this might change in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4981 ** future releases of SQLite. Applications that care about shared
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4982 ** cache setting should set it explicitly.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4983 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4984 ** This interface is threadsafe on processors where writing a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4985 ** 32-bit integer is atomic.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4986 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4987 ** See Also: [SQLite Shared-Cache Mode]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4988 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4989 SQLITE_API int sqlite3_enable_shared_cache(int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4990
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4991 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4992 ** CAPI3REF: Attempt To Free Heap Memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4993 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4994 ** ^The sqlite3_release_memory() interface attempts to free N bytes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4995 ** of heap memory by deallocating non-essential memory allocations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4996 ** held by the database library. Memory used to cache database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4997 ** pages to improve performance is an example of non-essential memory.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4998 ** ^sqlite3_release_memory() returns the number of bytes actually freed,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4999 ** which might be more or less than the amount requested.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5000 ** ^The sqlite3_release_memory() routine is a no-op returning zero
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5001 ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5002 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5003 ** See also: [sqlite3_db_release_memory()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5004 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5005 SQLITE_API int sqlite3_release_memory(int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5006
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5007 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5008 ** CAPI3REF: Free Memory Used By A Database Connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5009 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5010 ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5011 ** memory as possible from database connection D. Unlike the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5012 ** [sqlite3_release_memory()] interface, this interface is in effect even
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5013 ** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5014 ** omitted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5015 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5016 ** See also: [sqlite3_release_memory()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5017 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5018 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5019
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5020 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5021 ** CAPI3REF: Impose A Limit On Heap Size
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5022 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5023 ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5024 ** soft limit on the amount of heap memory that may be allocated by SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5025 ** ^SQLite strives to keep heap memory utilization below the soft heap
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5026 ** limit by reducing the number of pages held in the page cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5027 ** as heap memory usages approaches the limit.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5028 ** ^The soft heap limit is "soft" because even though SQLite strives to stay
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5029 ** below the limit, it will exceed the limit rather than generate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5030 ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5031 ** is advisory only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5032 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5033 ** ^The return value from sqlite3_soft_heap_limit64() is the size of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5034 ** the soft heap limit prior to the call, or negative in the case of an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5035 ** error. ^If the argument N is negative
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5036 ** then no change is made to the soft heap limit. Hence, the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5037 ** size of the soft heap limit can be determined by invoking
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5038 ** sqlite3_soft_heap_limit64() with a negative argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5039 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5040 ** ^If the argument N is zero then the soft heap limit is disabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5041 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5042 ** ^(The soft heap limit is not enforced in the current implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5043 ** if one or more of following conditions are true:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5044 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5045 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5046 ** <li> The soft heap limit is set to zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5047 ** <li> Memory accounting is disabled using a combination of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5048 ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5049 ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5050 ** <li> An alternative page cache implementation is specified using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5051 ** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5052 ** <li> The page cache allocates from its own memory pool supplied
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5053 ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5054 ** from the heap.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5055 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5056 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5057 ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5058 ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5059 ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5060 ** the soft heap limit is enforced on every memory allocation. Without
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5061 ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5062 ** when memory is allocated by the page cache. Testing suggests that because
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5063 ** the page cache is the predominate memory user in SQLite, most
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5064 ** applications will achieve adequate soft heap limit enforcement without
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5065 ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5066 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5067 ** The circumstances under which SQLite will enforce the soft heap limit may
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5068 ** changes in future releases of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5069 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5070 SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5071
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5072 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5073 ** CAPI3REF: Deprecated Soft Heap Limit Interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5074 ** DEPRECATED
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5075 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5076 ** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5077 ** interface. This routine is provided for historical compatibility
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5078 ** only. All new applications should use the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5079 ** [sqlite3_soft_heap_limit64()] interface rather than this one.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5080 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5081 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5082
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5083
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5084 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5085 ** CAPI3REF: Extract Metadata About A Column Of A Table
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5086 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5087 ** ^This routine returns metadata about a specific column of a specific
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5088 ** database table accessible using the [database connection] handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5089 ** passed as the first function argument.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5090 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5091 ** ^The column is identified by the second, third and fourth parameters to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5092 ** this function. ^The second parameter is either the name of the database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5093 ** (i.e. "main", "temp", or an attached database) containing the specified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5094 ** table or NULL. ^If it is NULL, then all attached databases are searched
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5095 ** for the table using the same algorithm used by the database engine to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5096 ** resolve unqualified table references.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5097 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5098 ** ^The third and fourth parameters to this function are the table and column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5099 ** name of the desired column, respectively. Neither of these parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5100 ** may be NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5101 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5102 ** ^Metadata is returned by writing to the memory locations passed as the 5th
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5103 ** and subsequent parameters to this function. ^Any of these arguments may be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5104 ** NULL, in which case the corresponding element of metadata is omitted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5105 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5106 ** ^(<blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5107 ** <table border="1">
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5108 ** <tr><th> Parameter <th> Output<br>Type <th> Description
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5109 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5110 ** <tr><td> 5th <td> const char* <td> Data type
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5111 ** <tr><td> 6th <td> const char* <td> Name of default collation sequence
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5112 ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5113 ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5114 ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5115 ** </table>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5116 ** </blockquote>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5117 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5118 ** ^The memory pointed to by the character pointers returned for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5119 ** declaration type and collation sequence is valid only until the next
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5120 ** call to any SQLite API function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5121 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5122 ** ^If the specified table is actually a view, an [error code] is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5123 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5124 ** ^If the specified column is "rowid", "oid" or "_rowid_" and an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5125 ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5126 ** parameters are set for the explicitly declared column. ^(If there is no
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5127 ** explicitly declared [INTEGER PRIMARY KEY] column, then the output
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5128 ** parameters are set as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5129 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5130 ** <pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5131 ** data type: "INTEGER"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5132 ** collation sequence: "BINARY"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5133 ** not null: 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5134 ** primary key: 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5135 ** auto increment: 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5136 ** </pre>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5137 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5138 ** ^(This function may load one or more schemas from database files. If an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5139 ** error occurs during this process, or if the requested table or column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5140 ** cannot be found, an [error code] is returned and an error message left
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5141 ** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5142 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5143 ** ^This API is only available if the library was compiled with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5144 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5145 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5146 SQLITE_API int sqlite3_table_column_metadata(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5147 sqlite3 db, / Connection handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5148 const char zDbName, / Database name or NULL */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5149 const char zTableName, / Table name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5150 const char zColumnName, / Column name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5151 char const *pzDataType, / OUTPUT: Declared data type */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5152 char const *pzCollSeq, / OUTPUT: Collation sequence name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5153 int pNotNull, / OUTPUT: True if NOT NULL constraint exists */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5154 int pPrimaryKey, / OUTPUT: True if column part of PK */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5155 int pAutoinc / OUTPUT: True if column is auto-increment */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5156 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5157
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5158 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5159 ** CAPI3REF: Load An Extension
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5160 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5161 ** ^This interface loads an SQLite extension library from the named file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5162 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5163 ** ^The sqlite3_load_extension() interface attempts to load an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5164 ** [SQLite extension] library contained in the file zFile. If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5165 ** the file cannot be loaded directly, attempts are made to load
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5166 ** with various operating-system specific extensions added.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5167 ** So for example, if "samplelib" cannot be loaded, then names like
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5168 ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5169 ** be tried also.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5170 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5171 ** ^The entry point is zProc.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5172 ** ^(zProc may be 0, in which case SQLite will try to come up with an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5173 ** entry point name on its own. It first tries "sqlite3_extension_init".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5174 ** If that does not work, it constructs a name "sqlite3_X_init" where the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5175 ** X is consists of the lower-case equivalent of all ASCII alphabetic
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5176 ** characters in the filename from the last "/" to the first following
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5177 ** "." and omitting any initial "lib".)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5178 ** ^The sqlite3_load_extension() interface returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5179 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5180 ** ^If an error occurs and pzErrMsg is not 0, then the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5181 ** [sqlite3_load_extension()] interface shall attempt to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5182 ** fill *pzErrMsg with error message text stored in memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5183 ** obtained from [sqlite3_malloc()]. The calling function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5184 ** should free this memory by calling [sqlite3_free()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5185 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5186 ** ^Extension loading must be enabled using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5187 ** [sqlite3_enable_load_extension()] prior to calling this API,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5188 ** otherwise an error will be returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5189 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5190 ** See also the [load_extension() SQL function].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5191 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5192 SQLITE_API int sqlite3_load_extension(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5193 sqlite3 db, / Load the extension into this database connection */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5194 const char zFile, / Name of the shared library containing extension */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5195 const char zProc, / Entry point. Derived from zFile if 0 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5196 char *pzErrMsg / Put error message here if not 0 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5197 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5198
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5199 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5200 ** CAPI3REF: Enable Or Disable Extension Loading
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5201 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5202 ** ^So as not to open security holes in older applications that are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5203 ** unprepared to deal with [extension loading], and as a means of disabling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5204 ** [extension loading] while evaluating user-entered SQL, the following API
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5205 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5206 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5207 ** ^Extension loading is off by default.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5208 ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5209 ** to turn extension loading on and call it with onoff==0 to turn
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5210 ** it back off again.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5211 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5212 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5213
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5214 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5215 ** CAPI3REF: Automatically Load Statically Linked Extensions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5216 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5217 ** ^This interface causes the xEntryPoint() function to be invoked for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5218 ** each new [database connection] that is created. The idea here is that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5219 ** xEntryPoint() is the entry point for a statically linked [SQLite extension]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5220 ** that is to be automatically loaded into all new database connections.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5221 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5222 ** ^(Even though the function prototype shows that xEntryPoint() takes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5223 ** no arguments and returns void, SQLite invokes xEntryPoint() with three
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5224 ** arguments and expects and integer result as if the signature of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5225 ** entry point where as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5226 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5227 ** <blockquote><pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5228 **   int xEntryPoint(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5229 **   sqlite3 *db,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5230   const char pzErrMsg,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5231 **   const struct sqlite3_api_routines *pThunk
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5232 **   );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5233 ** </pre></blockquote>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5234 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5235 ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5236 ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5237 ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5238 ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5239 ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5240 ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5241 ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5242 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5243 ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5244 ** on the list of automatic extensions is a harmless no-op. ^No entry point
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5245 ** will be called more than once for each database connection that is opened.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5246 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5247 ** See also: [sqlite3_reset_auto_extension()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5248 ** and [sqlite3_cancel_auto_extension()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5249 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5250 SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5251
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5252 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5253 ** CAPI3REF: Cancel Automatic Extension Loading
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5254 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5255 ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5256 ** initialization routine X that was registered using a prior call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5257 ** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5258 ** routine returns 1 if initialization routine X was successfully
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5259 ** unregistered and it returns 0 if X was not on the list of initialization
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5260 ** routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5261 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5262 SQLITE_API int sqlite3_cancel_auto_extension(void (*xEntryPoint)(void));
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5263
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5264 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5265 ** CAPI3REF: Reset Automatic Extension Loading
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5266 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5267 ** ^This interface disables all automatic extensions previously
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5268 ** registered using [sqlite3_auto_extension()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5269 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5270 SQLITE_API void sqlite3_reset_auto_extension(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5271
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5272 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5273 ** The interface to the virtual-table mechanism is currently considered
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5274 ** to be experimental. The interface might change in incompatible ways.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5275 ** If this is a problem for you, do not use the interface at this time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5276 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5277 ** When the virtual-table mechanism stabilizes, we will declare the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5278 ** interface fixed, support it indefinitely, and remove this comment.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5279 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5280
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5281 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5282 ** Structures used by the virtual table interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5283 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5284 typedef struct sqlite3_vtab sqlite3_vtab;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5285 typedef struct sqlite3_index_info sqlite3_index_info;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5286 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5287 typedef struct sqlite3_module sqlite3_module;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5288
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5289 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5290 ** CAPI3REF: Virtual Table Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5291 ** KEYWORDS: sqlite3_module {virtual table module}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5292 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5293 ** This structure, sometimes called a "virtual table module",
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5294 ** defines the implementation of a [virtual tables].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5295 ** This structure consists mostly of methods for the module.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5296 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5297 ** ^A virtual table module is created by filling in a persistent
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5298 ** instance of this structure and passing a pointer to that instance
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5299 ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5300 ** ^The registration remains valid until it is replaced by a different
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5301 ** module or until the [database connection] closes. The content
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5302 ** of this structure must not change while it is registered with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5303 ** any database connection.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5304 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5305 struct sqlite3_module {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5306 int iVersion;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5307 int (xCreate)(sqlite3, void *pAux,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5308 int argc, const char constargv,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5309 sqlite3_vtab ppVTab, char);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5310 int (xConnect)(sqlite3, void *pAux,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5311 int argc, const char constargv,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5312 sqlite3_vtab ppVTab, char);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5313 int (xBestIndex)(sqlite3_vtab pVTab, sqlite3_index_info*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5314 int (xDisconnect)(sqlite3_vtab pVTab);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5315 int (xDestroy)(sqlite3_vtab pVTab);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5316 int (xOpen)(sqlite3_vtab pVTab, sqlite3_vtab_cursor **ppCursor);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5317 int (xClose)(sqlite3_vtab_cursor);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5318 int (xFilter)(sqlite3_vtab_cursor, int idxNum, const char *idxStr,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5319 int argc, sqlite3_value **argv);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5320 int (xNext)(sqlite3_vtab_cursor);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5321 int (xEof)(sqlite3_vtab_cursor);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5322 int (xColumn)(sqlite3_vtab_cursor, sqlite3_context*, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5323 int (xRowid)(sqlite3_vtab_cursor, sqlite3_int64 *pRowid);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5324 int (xUpdate)(sqlite3_vtab , int, sqlite3_value *, sqlite3_int64 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5325 int (xBegin)(sqlite3_vtab pVTab);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5326 int (xSync)(sqlite3_vtab pVTab);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5327 int (xCommit)(sqlite3_vtab pVTab);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5328 int (xRollback)(sqlite3_vtab pVTab);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5329 int (xFindFunction)(sqlite3_vtab pVtab, int nArg, const char *zName,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5330 void (*pxFunc)(sqlite3_context,int,sqlite3_value**),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5331 void **ppArg);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5332 int (xRename)(sqlite3_vtab pVtab, const char *zNew);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5333 /* The methods above are in version 1 of the sqlite_module object. Those
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5334 ** below are for version 2 and greater. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5335 int (xSavepoint)(sqlite3_vtab pVTab, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5336 int (xRelease)(sqlite3_vtab pVTab, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5337 int (xRollbackTo)(sqlite3_vtab pVTab, int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5338 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5339
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5340 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5341 ** CAPI3REF: Virtual Table Indexing Information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5342 ** KEYWORDS: sqlite3_index_info
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5343 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5344 ** The sqlite3_index_info structure and its substructures is used as part
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5345 ** of the [virtual table] interface to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5346 ** pass information into and receive the reply from the [xBestIndex]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5347 method of a [virtual table module]. The fields under Inputs** are the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5348 ** inputs to xBestIndex and are read-only. xBestIndex inserts its
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5349 results into the Outputs** fields.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5350 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5351 ** ^(The aConstraint[] array records WHERE clause constraints of the form:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5352 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5353 ** <blockquote>column OP expr</blockquote>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5354 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5355 ** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5356 ** stored in aConstraint[].op using one of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5357 ** [SQLITE_INDEX_CONSTRAINT_EQ \| SQLITE_INDEX_CONSTRAINT_ values].)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5358 ** ^(The index of the column is stored in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5359 ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5360 ** expr on the right-hand side can be evaluated (and thus the constraint
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5361 ** is usable) and false if it cannot.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5362 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5363 ** ^The optimizer automatically inverts terms of the form "expr OP column"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5364 ** and makes other simplifications to the WHERE clause in an attempt to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5365 ** get as many WHERE clause terms into the form shown above as possible.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5366 ** ^The aConstraint[] array only reports WHERE clause terms that are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5367 ** relevant to the particular virtual table being queried.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5368 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5369 ** ^Information about the ORDER BY clause is stored in aOrderBy[].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5370 ** ^Each term of aOrderBy records a column of the ORDER BY clause.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5371 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5372 ** The [xBestIndex] method must fill aConstraintUsage[] with information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5373 ** about what parameters to pass to xFilter. ^If argvIndex>0 then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5374 ** the right-hand side of the corresponding aConstraint[] is evaluated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5375 ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5376 ** is true, then the constraint is assumed to be fully handled by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5377 ** virtual table and is not checked again by SQLite.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5378 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5379 ** ^The idxNum and idxPtr values are recorded and passed into the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5380 ** [xFilter] method.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5381 ** ^[sqlite3_free()] is used to free idxPtr if and only if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5382 ** needToFreeIdxPtr is true.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5383 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5384 ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5385 ** the correct order to satisfy the ORDER BY clause so that no separate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5386 ** sorting step is required.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5387 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5388 ** ^The estimatedCost value is an estimate of the cost of a particular
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5389 ** strategy. A cost of N indicates that the cost of the strategy is similar
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5390 ** to a linear scan of an SQLite table with N rows. A cost of log(N)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5391 ** indicates that the expense of the operation is similar to that of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5392 ** binary search on a unique indexed field of an SQLite table with N rows.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5393 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5394 ** ^The estimatedRows value is an estimate of the number of rows that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5395 ** will be returned by the strategy.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5396 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5397 ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5398 ** structure for SQLite version 3.8.2. If a virtual table extension is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5399 ** used with an SQLite version earlier than 3.8.2, the results of attempting
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5400 ** to read or write the estimatedRows field are undefined (but are likely
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5401 ** to included crashing the application). The estimatedRows field should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5402 ** therefore only be used if [sqlite3_libversion_number()] returns a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5403 ** value greater than or equal to 3008002.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5404 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5405 struct sqlite3_index_info {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5406 /* Inputs */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5407 int nConstraint; /* Number of entries in aConstraint */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5408 struct sqlite3_index_constraint {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5409 int iColumn; /* Column on left-hand side of constraint */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5410 unsigned char op; /* Constraint operator */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5411 unsigned char usable; /* True if this constraint is usable */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5412 int iTermOffset; /* Used internally - xBestIndex should ignore */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5413 } aConstraint; / Table of WHERE clause constraints */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5414 int nOrderBy; /* Number of terms in the ORDER BY clause */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5415 struct sqlite3_index_orderby {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5416 int iColumn; /* Column number */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5417 unsigned char desc; /* True for DESC. False for ASC. */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5418 } aOrderBy; / The ORDER BY clause */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5419 /* Outputs */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5420 struct sqlite3_index_constraint_usage {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5421 int argvIndex; /* if >0, constraint is part of argv to xFilter */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5422 unsigned char omit; /* Do not code a test for this constraint */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5423 } *aConstraintUsage;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5424 int idxNum; /* Number used to identify the index */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5425 char idxStr; / String, possibly obtained from sqlite3_malloc */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5426 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5427 int orderByConsumed; /* True if output is already ordered */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5428 double estimatedCost; /* Estimated cost of using this index */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5429 /* Fields below are only available in SQLite 3.8.2 and later */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5430 sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5431 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5432
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5433 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5434 ** CAPI3REF: Virtual Table Constraint Operator Codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5435 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5436 ** These macros defined the allowed values for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5437 ** [sqlite3_index_info].aConstraint[].op field. Each value represents
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5438 ** an operator that is part of a constraint term in the wHERE clause of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5439 ** a query that uses a [virtual table].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5440 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5441 #define SQLITE_INDEX_CONSTRAINT_EQ 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5442 #define SQLITE_INDEX_CONSTRAINT_GT 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5443 #define SQLITE_INDEX_CONSTRAINT_LE 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5444 #define SQLITE_INDEX_CONSTRAINT_LT 16
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5445 #define SQLITE_INDEX_CONSTRAINT_GE 32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5446 #define SQLITE_INDEX_CONSTRAINT_MATCH 64
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5447
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5448 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5449 ** CAPI3REF: Register A Virtual Table Implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5450 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5451 ** ^These routines are used to register a new [virtual table module] name.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5452 ** ^Module names must be registered before
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5453 ** creating a new [virtual table] using the module and before using a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5454 ** preexisting [virtual table] for the module.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5455 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5456 ** ^The module name is registered on the [database connection] specified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5457 ** by the first parameter. ^The name of the module is given by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5458 ** second parameter. ^The third parameter is a pointer to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5459 ** the implementation of the [virtual table module]. ^The fourth
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5460 ** parameter is an arbitrary client data pointer that is passed through
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5461 ** into the [xCreate] and [xConnect] methods of the virtual table module
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5462 ** when a new virtual table is be being created or reinitialized.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5463 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5464 ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5465 ** is a pointer to a destructor for the pClientData. ^SQLite will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5466 ** invoke the destructor function (if it is not NULL) when SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5467 ** no longer needs the pClientData pointer. ^The destructor will also
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5468 ** be invoked if the call to sqlite3_create_module_v2() fails.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5469 ** ^The sqlite3_create_module()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5470 ** interface is equivalent to sqlite3_create_module_v2() with a NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5471 ** destructor.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5472 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5473 SQLITE_API int sqlite3_create_module(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5474 sqlite3 db, / SQLite connection to register module with */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5475 const char zName, / Name of the module */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5476 const sqlite3_module p, / Methods for the module */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5477 void pClientData / Client data for xCreate/xConnect */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5478 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5479 SQLITE_API int sqlite3_create_module_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5480 sqlite3 db, / SQLite connection to register module with */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5481 const char zName, / Name of the module */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5482 const sqlite3_module p, / Methods for the module */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5483 void pClientData, / Client data for xCreate/xConnect */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5484 void(xDestroy)(void) /* Module destructor function */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5485 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5486
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5487 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5488 ** CAPI3REF: Virtual Table Instance Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5489 ** KEYWORDS: sqlite3_vtab
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5490 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5491 ** Every [virtual table module] implementation uses a subclass
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5492 ** of this object to describe a particular instance
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5493 ** of the [virtual table]. Each subclass will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5494 ** be tailored to the specific needs of the module implementation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5495 ** The purpose of this superclass is to define certain fields that are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5496 ** common to all module implementations.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5497 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5498 ** ^Virtual tables methods can set an error message by assigning a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5499 ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5500 ** take care that any prior string is freed by a call to [sqlite3_free()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5501 ** prior to assigning a new string to zErrMsg. ^After the error message
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5502 ** is delivered up to the client application, the string will be automatically
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5503 ** freed by sqlite3_free() and the zErrMsg field will be zeroed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5504 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5505 struct sqlite3_vtab {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5506 const sqlite3_module pModule; / The module for this virtual table */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5507 int nRef; /* NO LONGER USED */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5508 char zErrMsg; / Error message from sqlite3_mprintf() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5509 /* Virtual table implementations will typically add additional fields */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5510 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5511
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5512 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5513 ** CAPI3REF: Virtual Table Cursor Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5514 ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5515 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5516 ** Every [virtual table module] implementation uses a subclass of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5517 ** following structure to describe cursors that point into the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5518 ** [virtual table] and are used
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5519 ** to loop through the virtual table. Cursors are created using the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5520 ** [sqlite3_module.xOpen \| xOpen] method of the module and are destroyed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5521 ** by the [sqlite3_module.xClose \| xClose] method. Cursors are used
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5522 ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5523 ** of the module. Each module implementation will define
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5524 ** the content of a cursor structure to suit its own needs.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5525 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5526 ** This superclass exists in order to define fields of the cursor that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5527 ** are common to all implementations.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5528 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5529 struct sqlite3_vtab_cursor {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5530 sqlite3_vtab pVtab; / Virtual table of this cursor */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5531 /* Virtual table implementations will typically add additional fields */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5532 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5533
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5534 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5535 ** CAPI3REF: Declare The Schema Of A Virtual Table
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5536 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5537 ** ^The [xCreate] and [xConnect] methods of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5538 ** [virtual table module] call this interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5539 ** to declare the format (the names and datatypes of the columns) of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5540 ** the virtual tables they implement.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5541 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5542 SQLITE_API int sqlite3_declare_vtab(sqlite3, const char zSQL);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5543
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5544 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5545 ** CAPI3REF: Overload A Function For A Virtual Table
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5546 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5547 ** ^(Virtual tables can provide alternative implementations of functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5548 ** using the [xFindFunction] method of the [virtual table module].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5549 ** But global versions of those functions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5550 ** must exist in order to be overloaded.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5551 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5552 ** ^(This API makes sure a global version of a function with a particular
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5553 ** name and number of parameters exists. If no such function exists
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5554 ** before this API is called, a new function is created.)^ ^The implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5555 ** of the new function always causes an exception to be thrown. So
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5556 ** the new function is not good for anything by itself. Its only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5557 ** purpose is to be a placeholder function that can be overloaded
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5558 ** by a [virtual table].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5559 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5560 SQLITE_API int sqlite3_overload_function(sqlite3, const char zFuncName, int nArg);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5561
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5562 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5563 ** The interface to the virtual-table mechanism defined above (back up
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5564 ** to a comment remarkably similar to this one) is currently considered
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5565 ** to be experimental. The interface might change in incompatible ways.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5566 ** If this is a problem for you, do not use the interface at this time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5567 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5568 ** When the virtual-table mechanism stabilizes, we will declare the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5569 ** interface fixed, support it indefinitely, and remove this comment.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5570 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5571
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5572 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5573 ** CAPI3REF: A Handle To An Open BLOB
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5574 ** KEYWORDS: {BLOB handle} {BLOB handles}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5575 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5576 ** An instance of this object represents an open BLOB on which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5577 ** [sqlite3_blob_open \| incremental BLOB I/O] can be performed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5578 ** ^Objects of this type are created by [sqlite3_blob_open()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5579 ** and destroyed by [sqlite3_blob_close()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5580 ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5581 ** can be used to read or write small subsections of the BLOB.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5582 ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5583 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5584 typedef struct sqlite3_blob sqlite3_blob;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5585
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5586 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5587 ** CAPI3REF: Open A BLOB For Incremental I/O
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5588 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5589 ** ^(This interfaces opens a [BLOB handle \| handle] to the BLOB located
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5590 ** in row iRow, column zColumn, table zTable in database zDb;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5591 ** in other words, the same BLOB that would be selected by:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5592 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5593 ** <pre>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5594 ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5595 ** </pre>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5596 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5597 ** ^If the flags parameter is non-zero, then the BLOB is opened for read
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5598 ** and write access. ^If it is zero, the BLOB is opened for read access.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5599 ** ^It is not possible to open a column that is part of an index or primary
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5600 ** key for writing. ^If [foreign key constraints] are enabled, it is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5601 ** not possible to open a column that is part of a [child key] for writing.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5602 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5603 ** ^Note that the database name is not the filename that contains
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5604 ** the database but rather the symbolic name of the database that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5605 ** appears after the AS keyword when the database is connected using [ATTACH].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5606 ** ^For the main database file, the database name is "main".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5607 ** ^For TEMP tables, the database name is "temp".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5608 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5609 ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5610 ** to ppBlob. Otherwise an [error code] is returned and ppBlob is set
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5611 ** to be a null pointer.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5612 ** ^This function sets the [database connection] error code and message
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5613 ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5614 ** functions. ^Note that the *ppBlob variable is always initialized in a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5615 ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5616 ** regardless of the success or failure of this routine.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5617 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5618 ** ^(If the row that a BLOB handle points to is modified by an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5619 ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5620 ** then the BLOB handle is marked as "expired".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5621 ** This is true if any column of the row is changed, even a column
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5622 ** other than the one the BLOB handle is open on.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5623 ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5624 ** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5625 ** ^(Changes written into a BLOB prior to the BLOB expiring are not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5626 ** rolled back by the expiration of the BLOB. Such changes will eventually
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5627 ** commit if the transaction continues to completion.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5628 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5629 ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5630 ** the opened blob. ^The size of a blob may not be changed by this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5631 ** interface. Use the [UPDATE] SQL command to change the size of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5632 ** blob.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5633 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5634 ** ^The [sqlite3_blob_open()] interface will fail for a [WITHOUT ROWID]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5635 ** table. Incremental BLOB I/O is not possible on [WITHOUT ROWID] tables.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5636 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5637 ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5638 ** and the built-in [zeroblob] SQL function can be used, if desired,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5639 ** to create an empty, zero-filled blob in which to read or write using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5640 ** this interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5641 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5642 ** To avoid a resource leak, every open [BLOB handle] should eventually
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5643 ** be released by a call to [sqlite3_blob_close()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5644 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5645 SQLITE_API int sqlite3_blob_open(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5646 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5647 const char *zDb,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5648 const char *zTable,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5649 const char *zColumn,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5650 sqlite3_int64 iRow,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5651 int flags,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5652 sqlite3_blob **ppBlob
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5653 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5654
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5655 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5656 ** CAPI3REF: Move a BLOB Handle to a New Row
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5657 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5658 ** ^This function is used to move an existing blob handle so that it points
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5659 ** to a different row of the same database table. ^The new row is identified
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5660 ** by the rowid value passed as the second argument. Only the row can be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5661 ** changed. ^The database, table and column on which the blob handle is open
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5662 ** remain the same. Moving an existing blob handle to a new row can be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5663 ** faster than closing the existing handle and opening a new one.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5664 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5665 ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5666 ** it must exist and there must be either a blob or text value stored in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5667 ** the nominated column.)^ ^If the new row is not present in the table, or if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5668 ** it does not contain a blob or text value, or if another error occurs, an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5669 ** SQLite error code is returned and the blob handle is considered aborted.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5670 ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5671 ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5672 ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5673 ** always returns zero.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5674 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5675 ** ^This function sets the database handle error code and message.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5676 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5677 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5678
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5679 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5680 ** CAPI3REF: Close A BLOB Handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5681 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5682 ** ^Closes an open [BLOB handle].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5683 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5684 ** ^Closing a BLOB shall cause the current transaction to commit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5685 ** if there are no other BLOBs, no pending prepared statements, and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5686 ** database connection is in [autocommit mode].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5687 ** ^If any writes were made to the BLOB, they might be held in cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5688 ** until the close operation if they will fit.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5689 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5690 ** ^(Closing the BLOB often forces the changes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5691 ** out to disk and so if any I/O errors occur, they will likely occur
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5692 ** at the time when the BLOB is closed. Any errors that occur during
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5693 ** closing are reported as a non-zero return value.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5694 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5695 ** ^(The BLOB is closed unconditionally. Even if this routine returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5696 ** an error code, the BLOB is still closed.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5697 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5698 ** ^Calling this routine with a null pointer (such as would be returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5699 ** by a failed call to [sqlite3_blob_open()]) is a harmless no-op.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5700 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5701 SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5702
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5703 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5704 ** CAPI3REF: Return The Size Of An Open BLOB
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5705 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5706 ** ^Returns the size in bytes of the BLOB accessible via the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5707 ** successfully opened [BLOB handle] in its only argument. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5708 ** incremental blob I/O routines can only read or overwriting existing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5709 ** blob content; they cannot change the size of a blob.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5710 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5711 ** This routine only works on a [BLOB handle] which has been created
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5712 ** by a prior successful call to [sqlite3_blob_open()] and which has not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5713 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5714 ** to this routine results in undefined and probably undesirable behavior.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5715 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5716 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5717
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5718 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5719 ** CAPI3REF: Read Data From A BLOB Incrementally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5720 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5721 ** ^(This function is used to read data from an open [BLOB handle] into a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5722 ** caller-supplied buffer. N bytes of data are copied into buffer Z
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5723 ** from the open BLOB, starting at offset iOffset.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5724 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5725 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5726 ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5727 ** less than zero, [SQLITE_ERROR] is returned and no data is read.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5728 ** ^The size of the blob (and hence the maximum value of N+iOffset)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5729 ** can be determined using the [sqlite3_blob_bytes()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5730 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5731 ** ^An attempt to read from an expired [BLOB handle] fails with an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5732 ** error code of [SQLITE_ABORT].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5733 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5734 ** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5735 ** Otherwise, an [error code] or an [extended error code] is returned.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5736 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5737 ** This routine only works on a [BLOB handle] which has been created
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5738 ** by a prior successful call to [sqlite3_blob_open()] and which has not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5739 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5740 ** to this routine results in undefined and probably undesirable behavior.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5741 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5742 ** See also: [sqlite3_blob_write()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5743 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5744 SQLITE_API int sqlite3_blob_read(sqlite3_blob , void Z, int N, int iOffset);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5745
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5746 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5747 ** CAPI3REF: Write Data Into A BLOB Incrementally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5748 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5749 ** ^This function is used to write data into an open [BLOB handle] from a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5750 ** caller-supplied buffer. ^N bytes of data are copied from the buffer Z
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5751 ** into the open BLOB, starting at offset iOffset.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5752 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5753 ** ^If the [BLOB handle] passed as the first argument was not opened for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5754 ** writing (the flags parameter to [sqlite3_blob_open()] was zero),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5755 ** this function returns [SQLITE_READONLY].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5756 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5757 ** ^This function may only modify the contents of the BLOB; it is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5758 ** not possible to increase the size of a BLOB using this API.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5759 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5760 ** [SQLITE_ERROR] is returned and no data is written. ^If N is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5761 ** less than zero [SQLITE_ERROR] is returned and no data is written.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5762 ** The size of the BLOB (and hence the maximum value of N+iOffset)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5763 ** can be determined using the [sqlite3_blob_bytes()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5764 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5765 ** ^An attempt to write to an expired [BLOB handle] fails with an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5766 ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5767 ** before the [BLOB handle] expired are not rolled back by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5768 ** expiration of the handle, though of course those changes might
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5769 ** have been overwritten by the statement that expired the BLOB handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5770 ** or by other independent statements.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5771 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5772 ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5773 ** Otherwise, an [error code] or an [extended error code] is returned.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5774 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5775 ** This routine only works on a [BLOB handle] which has been created
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5776 ** by a prior successful call to [sqlite3_blob_open()] and which has not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5777 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5778 ** to this routine results in undefined and probably undesirable behavior.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5779 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5780 ** See also: [sqlite3_blob_read()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5781 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5782 SQLITE_API int sqlite3_blob_write(sqlite3_blob , const void z, int n, int iOffset);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5783
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5784 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5785 ** CAPI3REF: Virtual File System Objects
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5786 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5787 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5788 ** that SQLite uses to interact
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5789 ** with the underlying operating system. Most SQLite builds come with a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5790 ** single default VFS that is appropriate for the host computer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5791 ** New VFSes can be registered and existing VFSes can be unregistered.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5792 ** The following interfaces are provided.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5793 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5794 ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5795 ** ^Names are case sensitive.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5796 ** ^Names are zero-terminated UTF-8 strings.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5797 ** ^If there is no match, a NULL pointer is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5798 ** ^If zVfsName is NULL then the default VFS is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5799 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5800 ** ^New VFSes are registered with sqlite3_vfs_register().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5801 ** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5802 ** ^The same VFS can be registered multiple times without injury.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5803 ** ^To make an existing VFS into the default VFS, register it again
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5804 ** with the makeDflt flag set. If two different VFSes with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5805 ** same name are registered, the behavior is undefined. If a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5806 ** VFS is registered with a name that is NULL or an empty string,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5807 ** then the behavior is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5808 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5809 ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5810 ** ^(If the default VFS is unregistered, another VFS is chosen as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5811 ** the default. The choice for the new VFS is arbitrary.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5812 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5813 SQLITE_API sqlite3_vfs sqlite3_vfs_find(const char zVfsName);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5814 SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5815 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5816
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5817 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5818 ** CAPI3REF: Mutexes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5819 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5820 ** The SQLite core uses these routines for thread
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5821 ** synchronization. Though they are intended for internal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5822 ** use by SQLite, code that links against SQLite is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5823 ** permitted to use any of these routines.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5824 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5825 ** The SQLite source code contains multiple implementations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5826 ** of these mutex routines. An appropriate implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5827 ** is selected automatically at compile-time. ^(The following
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5828 ** implementations are available in the SQLite core:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5829 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5830 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5831 ** <li> SQLITE_MUTEX_PTHREADS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5832 ** <li> SQLITE_MUTEX_W32
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5833 ** <li> SQLITE_MUTEX_NOOP
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5834 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5835 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5836 ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5837 ** that does no real locking and is appropriate for use in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5838 ** a single-threaded application. ^The SQLITE_MUTEX_PTHREADS and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5839 ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5840 ** and Windows.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5841 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5842 ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5843 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5844 ** implementation is included with the library. In this case the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5845 ** application must supply a custom mutex implementation using the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5846 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5847 ** before calling sqlite3_initialize() or any other public sqlite3_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5848 ** function that calls sqlite3_initialize().)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5849 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5850 ** ^The sqlite3_mutex_alloc() routine allocates a new
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5851 ** mutex and returns a pointer to it. ^If it returns NULL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5852 ** that means that a mutex could not be allocated. ^SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5853 ** will unwind its stack and return an error. ^(The argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5854 ** to sqlite3_mutex_alloc() is one of these integer constants:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5855 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5856 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5857 ** <li> SQLITE_MUTEX_FAST
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5858 ** <li> SQLITE_MUTEX_RECURSIVE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5859 ** <li> SQLITE_MUTEX_STATIC_MASTER
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5860 ** <li> SQLITE_MUTEX_STATIC_MEM
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5861 ** <li> SQLITE_MUTEX_STATIC_MEM2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5862 ** <li> SQLITE_MUTEX_STATIC_PRNG
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5863 ** <li> SQLITE_MUTEX_STATIC_LRU
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5864 ** <li> SQLITE_MUTEX_STATIC_LRU2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5865 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5866 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5867 ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5868 ** cause sqlite3_mutex_alloc() to create
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5869 ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5870 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5871 ** The mutex implementation does not need to make a distinction
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5872 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5873 ** not want to. ^SQLite will only request a recursive mutex in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5874 ** cases where it really needs one. ^If a faster non-recursive mutex
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5875 ** implementation is available on the host platform, the mutex subsystem
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5876 ** might return such a mutex in response to SQLITE_MUTEX_FAST.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5877 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5878 ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5879 ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5880 ** a pointer to a static preexisting mutex. ^Six static mutexes are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5881 ** used by the current version of SQLite. Future versions of SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5882 ** may add additional static mutexes. Static mutexes are for internal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5883 ** use by SQLite only. Applications that use SQLite mutexes should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5884 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5885 ** SQLITE_MUTEX_RECURSIVE.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5886 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5887 ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5888 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5889 ** returns a different mutex on every call. ^But for the static
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5890 ** mutex types, the same mutex is returned on every call that has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5891 ** the same type number.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5892 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5893 ** ^The sqlite3_mutex_free() routine deallocates a previously
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5894 ** allocated dynamic mutex. ^SQLite is careful to deallocate every
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5895 ** dynamic mutex that it allocates. The dynamic mutexes must not be in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5896 ** use when they are deallocated. Attempting to deallocate a static
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5897 ** mutex results in undefined behavior. ^SQLite never deallocates
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5898 ** a static mutex.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5899 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5900 ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5901 ** to enter a mutex. ^If another thread is already within the mutex,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5902 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5903 ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5904 ** upon successful entry. ^(Mutexes created using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5905 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5906 ** In such cases the,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5907 ** mutex must be exited an equal number of times before another thread
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5908 ** can enter.)^ ^(If the same thread tries to enter any other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5909 ** kind of mutex more than once, the behavior is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5910 ** SQLite will never exhibit
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5911 ** such behavior in its own use of mutexes.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5912 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5913 ** ^(Some systems (for example, Windows 95) do not support the operation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5914 ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5915 ** will always return SQLITE_BUSY. The SQLite core only ever uses
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5916 ** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5917 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5918 ** ^The sqlite3_mutex_leave() routine exits a mutex that was
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5919 ** previously entered by the same thread. ^(The behavior
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5920 ** is undefined if the mutex is not currently entered by the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5921 ** calling thread or is not currently allocated. SQLite will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5922 ** never do either.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5923 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5924 ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5925 ** sqlite3_mutex_leave() is a NULL pointer, then all three routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5926 ** behave as no-ops.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5927 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5928 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5929 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5930 SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5931 SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5932 SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5933 SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5934 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5935
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5936 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5937 ** CAPI3REF: Mutex Methods Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5938 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5939 ** An instance of this structure defines the low-level routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5940 ** used to allocate and use mutexes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5941 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5942 ** Usually, the default mutex implementations provided by SQLite are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5943 ** sufficient, however the user has the option of substituting a custom
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5944 ** implementation for specialized deployments or systems for which SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5945 ** does not provide a suitable implementation. In this case, the user
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5946 ** creates and populates an instance of this structure to pass
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5947 ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5948 ** Additionally, an instance of this structure can be used as an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5949 ** output variable when querying the system for the current mutex
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5950 ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5951 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5952 ** ^The xMutexInit method defined by this structure is invoked as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5953 ** part of system initialization by the sqlite3_initialize() function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5954 ** ^The xMutexInit routine is called by SQLite exactly once for each
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5955 ** effective call to [sqlite3_initialize()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5956 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5957 ** ^The xMutexEnd method defined by this structure is invoked as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5958 ** part of system shutdown by the sqlite3_shutdown() function. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5959 ** implementation of this method is expected to release all outstanding
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5960 ** resources obtained by the mutex methods implementation, especially
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5961 ** those obtained by the xMutexInit method. ^The xMutexEnd()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5962 ** interface is invoked exactly once for each call to [sqlite3_shutdown()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5963 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5964 ** ^(The remaining seven methods defined by this structure (xMutexAlloc,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5965 ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5966 ** xMutexNotheld) implement the following interfaces (respectively):
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5967 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5968 ** <ul>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5969 ** <li> [sqlite3_mutex_alloc()] </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5970 ** <li> [sqlite3_mutex_free()] </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5971 ** <li> [sqlite3_mutex_enter()] </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5972 ** <li> [sqlite3_mutex_try()] </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5973 ** <li> [sqlite3_mutex_leave()] </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5974 ** <li> [sqlite3_mutex_held()] </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5975 ** <li> [sqlite3_mutex_notheld()] </li>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5976 ** </ul>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5977 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5978 ** The only difference is that the public sqlite3_XXX functions enumerated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5979 ** above silently ignore any invocations that pass a NULL pointer instead
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5980 ** of a valid mutex handle. The implementations of the methods defined
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5981 ** by this structure are not required to handle this case, the results
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5982 ** of passing a NULL pointer instead of a valid mutex handle are undefined
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5983 ** (i.e. it is acceptable to provide an implementation that segfaults if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5984 ** it is passed a NULL pointer).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5985 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5986 ** The xMutexInit() method must be threadsafe. ^It must be harmless to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5987 ** invoke xMutexInit() multiple times within the same process and without
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5988 ** intervening calls to xMutexEnd(). Second and subsequent calls to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5989 ** xMutexInit() must be no-ops.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5990 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5991 ** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5992 ** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5993 ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5994 ** memory allocation for a fast or recursive mutex.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5995 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5996 ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5997 ** called, but only if the prior call to xMutexInit returned SQLITE_OK.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5998 ** If xMutexInit fails in any way, it is expected to clean up after itself
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5999 ** prior to returning.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6000 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6001 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6002 struct sqlite3_mutex_methods {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6003 int (*xMutexInit)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6004 int (*xMutexEnd)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6005 sqlite3_mutex (xMutexAlloc)(int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6006 void (xMutexFree)(sqlite3_mutex );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6007 void (xMutexEnter)(sqlite3_mutex );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6008 int (xMutexTry)(sqlite3_mutex );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6009 void (xMutexLeave)(sqlite3_mutex );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6010 int (xMutexHeld)(sqlite3_mutex );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6011 int (xMutexNotheld)(sqlite3_mutex );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6012 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6013
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6014 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6015 ** CAPI3REF: Mutex Verification Routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6016 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6017 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6018 ** are intended for use inside assert() statements. ^The SQLite core
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6019 ** never uses these routines except inside an assert() and applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6020 ** are advised to follow the lead of the core. ^The SQLite core only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6021 ** provides implementations for these routines when it is compiled
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6022 ** with the SQLITE_DEBUG flag. ^External mutex implementations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6023 ** are only required to provide these routines if SQLITE_DEBUG is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6024 ** defined and if NDEBUG is not defined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6025 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6026 ** ^These routines should return true if the mutex in their argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6027 ** is held or not held, respectively, by the calling thread.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6028 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6029 ** ^The implementation is not required to provide versions of these
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6030 ** routines that actually work. If the implementation does not provide working
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6031 ** versions of these routines, it should at least provide stubs that always
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6032 ** return true so that one does not get spurious assertion failures.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6033 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6034 ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6035 ** the routine should return 1. This seems counter-intuitive since
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6036 ** clearly the mutex cannot be held if it does not exist. But
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6037 ** the reason the mutex does not exist is because the build is not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6038 ** using mutexes. And we do not want the assert() containing the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6039 ** call to sqlite3_mutex_held() to fail, so a non-zero return is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6040 ** the appropriate thing to do. ^The sqlite3_mutex_notheld()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6041 ** interface should also return 1 when given a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6042 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6043 #ifndef NDEBUG
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6044 SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6045 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6046 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6047
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6048 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6049 ** CAPI3REF: Mutex Types
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6050 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6051 ** The [sqlite3_mutex_alloc()] interface takes a single argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6052 ** which is one of these integer constants.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6053 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6054 ** The set of static mutexes may change from one SQLite release to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6055 ** next. Applications that override the built-in mutex logic must be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6056 ** prepared to accommodate additional static mutexes.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6057 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6058 #define SQLITE_MUTEX_FAST 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6059 #define SQLITE_MUTEX_RECURSIVE 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6060 #define SQLITE_MUTEX_STATIC_MASTER 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6061 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6062 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6063 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6064 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6065 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6066 #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6067 #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6068
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6069 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6070 ** CAPI3REF: Retrieve the mutex for a database connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6071 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6072 ** ^This interface returns a pointer the [sqlite3_mutex] object that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6073 ** serializes access to the [database connection] given in the argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6074 ** when the [threading mode] is Serialized.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6075 ** ^If the [threading mode] is Single-thread or Multi-thread then this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6076 ** routine returns a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6077 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6078 SQLITE_API sqlite3_mutex sqlite3_db_mutex(sqlite3);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6079
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6080 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6081 ** CAPI3REF: Low-Level Control Of Database Files
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6082 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6083 ** ^The [sqlite3_file_control()] interface makes a direct call to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6084 ** xFileControl method for the [sqlite3_io_methods] object associated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6085 ** with a particular database identified by the second argument. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6086 ** name of the database is "main" for the main database or "temp" for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6087 ** TEMP database, or the name that appears after the AS keyword for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6088 ** databases that are added using the [ATTACH] SQL command.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6089 ** ^A NULL pointer can be used in place of "main" to refer to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6090 ** main database file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6091 ** ^The third and fourth parameters to this routine
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6092 ** are passed directly through to the second and third parameters of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6093 ** the xFileControl method. ^The return value of the xFileControl
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6094 ** method becomes the return value of this routine.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6095 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6096 ** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6097 ** a pointer to the underlying [sqlite3_file] object to be written into
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6098 ** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6099 ** case is a short-circuit path which does not actually invoke the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6100 ** underlying sqlite3_io_methods.xFileControl method.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6101 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6102 ** ^If the second parameter (zDbName) does not match the name of any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6103 ** open database file, then SQLITE_ERROR is returned. ^This error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6104 ** code is not remembered and will not be recalled by [sqlite3_errcode()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6105 ** or [sqlite3_errmsg()]. The underlying xFileControl method might
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6106 ** also return SQLITE_ERROR. There is no way to distinguish between
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6107 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6108 ** xFileControl method.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6109 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6110 ** See also: [SQLITE_FCNTL_LOCKSTATE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6111 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6112 SQLITE_API int sqlite3_file_control(sqlite3, const char zDbName, int op, void*);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6113
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6114 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6115 ** CAPI3REF: Testing Interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6116 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6117 ** ^The sqlite3_test_control() interface is used to read out internal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6118 ** state of SQLite and to inject faults into SQLite for testing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6119 ** purposes. ^The first parameter is an operation code that determines
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6120 ** the number, meaning, and operation of all subsequent parameters.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6121 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6122 ** This interface is not for use by applications. It exists solely
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6123 ** for verifying the correct operation of the SQLite library. Depending
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6124 ** on how the SQLite library is compiled, this interface might not exist.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6125 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6126 ** The details of the operation codes, their meanings, the parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6127 ** they take, and what they do are all subject to change without notice.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6128 ** Unlike most of the SQLite API, this function is not guaranteed to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6129 ** operate consistently from one release to the next.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6130 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6131 SQLITE_API int sqlite3_test_control(int op, ...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6132
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6133 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6134 ** CAPI3REF: Testing Interface Operation Codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6135 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6136 ** These constants are the valid operation code parameters used
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6137 ** as the first argument to [sqlite3_test_control()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6138 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6139 ** These parameters and their meanings are subject to change
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6140 ** without notice. These values are for testing purposes only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6141 ** Applications should not use any of these parameters or the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6142 ** [sqlite3_test_control()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6143 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6144 #define SQLITE_TESTCTRL_FIRST 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6145 #define SQLITE_TESTCTRL_PRNG_SAVE 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6146 #define SQLITE_TESTCTRL_PRNG_RESTORE 6
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6147 #define SQLITE_TESTCTRL_PRNG_RESET 7
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6148 #define SQLITE_TESTCTRL_BITVEC_TEST 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6149 #define SQLITE_TESTCTRL_FAULT_INSTALL 9
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6150 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6151 #define SQLITE_TESTCTRL_PENDING_BYTE 11
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6152 #define SQLITE_TESTCTRL_ASSERT 12
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6153 #define SQLITE_TESTCTRL_ALWAYS 13
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6154 #define SQLITE_TESTCTRL_RESERVE 14
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6155 #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6156 #define SQLITE_TESTCTRL_ISKEYWORD 16
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6157 #define SQLITE_TESTCTRL_SCRATCHMALLOC 17
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6158 #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6159 #define SQLITE_TESTCTRL_EXPLAIN_STMT 19
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6160 #define SQLITE_TESTCTRL_NEVER_CORRUPT 20
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6161 #define SQLITE_TESTCTRL_VDBE_COVERAGE 21
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6162 #define SQLITE_TESTCTRL_BYTEORDER 22
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6163 #define SQLITE_TESTCTRL_LAST 22
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6164
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6165 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6166 ** CAPI3REF: SQLite Runtime Status
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6167 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6168 ** ^This interface is used to retrieve runtime status information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6169 ** about the performance of SQLite, and optionally to reset various
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6170 ** highwater marks. ^The first argument is an integer code for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6171 ** the specific parameter to measure. ^(Recognized integer codes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6172 ** are of the form [status parameters \| SQLITE_STATUS_...].)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6173 ** ^The current value of the parameter is returned into *pCurrent.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6174 ** ^The highest recorded value is returned in *pHighwater. ^If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6175 ** resetFlag is true, then the highest record value is reset after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6176 ** *pHighwater is written. ^(Some parameters do not record the highest
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6177 ** value. For those parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6178 ** nothing is written into *pHighwater and the resetFlag is ignored.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6179 ** ^(Other parameters record only the highwater mark and not the current
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6180 ** value. For these latter parameters nothing is written into *pCurrent.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6181 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6182 ** ^The sqlite3_status() routine returns SQLITE_OK on success and a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6183 ** non-zero [error code] on failure.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6184 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6185 ** This routine is threadsafe but is not atomic. This routine can be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6186 ** called while other threads are running the same or different SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6187 ** interfaces. However the values returned in *pCurrent and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6188 ** *pHighwater reflect the status of SQLite at different points in time
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6189 ** and it is possible that another thread might change the parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6190 ** in between the times when pCurrent and pHighwater are written.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6191 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6192 ** See also: [sqlite3_db_status()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6193 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6194 SQLITE_API int sqlite3_status(int op, int pCurrent, int pHighwater, int resetFlag);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6195
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6196
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6197 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6198 ** CAPI3REF: Status Parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6199 ** KEYWORDS: {status parameters}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6200 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6201 ** These integer constants designate various run-time status parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6202 ** that can be returned by [sqlite3_status()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6203 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6204 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6205 ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6206 ** <dd>This parameter is the current amount of memory checked out
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6207 ** using [sqlite3_malloc()], either directly or indirectly. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6208 ** figure includes calls made to [sqlite3_malloc()] by the application
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6209 ** and internal memory usage by the SQLite library. Scratch memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6210 ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6211 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6212 ** this parameter. The amount returned is the sum of the allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6213 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6214 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6215 ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6216 ** <dd>This parameter records the largest memory allocation request
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6217 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6218 ** internal equivalents). Only the value returned in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6219 ** *pHighwater parameter to [sqlite3_status()] is of interest.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6220 ** The value written into the *pCurrent parameter is undefined.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6221 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6222 ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6223 ** <dd>This parameter records the number of separate memory allocations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6224 ** currently checked out.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6225 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6226 ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6227 ** <dd>This parameter returns the number of pages used out of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6228 ** [pagecache memory allocator] that was configured using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6229 ** [SQLITE_CONFIG_PAGECACHE]. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6230 ** value returned is in pages, not in bytes.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6231 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6232 ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6233 ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6234 ** <dd>This parameter returns the number of bytes of page cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6235 ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6236 ** buffer and where forced to overflow to [sqlite3_malloc()]. The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6237 ** returned value includes allocations that overflowed because they
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6238 ** where too large (they were larger than the "sz" parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6239 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6240 ** no space was left in the page cache.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6241 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6242 ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6243 ** <dd>This parameter records the largest memory allocation request
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6244 ** handed to [pagecache memory allocator]. Only the value returned in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6245 ** *pHighwater parameter to [sqlite3_status()] is of interest.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6246 ** The value written into the *pCurrent parameter is undefined.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6247 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6248 ** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6249 ** <dd>This parameter returns the number of allocations used out of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6250 ** [scratch memory allocator] configured using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6251 ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6252 ** in bytes. Since a single thread may only have one scratch allocation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6253 ** outstanding at time, this parameter also reports the number of threads
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6254 ** using scratch memory at the same time.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6255 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6256 ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6257 ** <dd>This parameter returns the number of bytes of scratch memory
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6258 ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6259 ** buffer and where forced to overflow to [sqlite3_malloc()]. The values
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6260 ** returned include overflows because the requested allocation was too
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6261 ** larger (that is, because the requested allocation was larger than the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6262 ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6263 ** slots were available.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6264 ** </dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6265 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6266 ** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6267 ** <dd>This parameter records the largest memory allocation request
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6268 ** handed to [scratch memory allocator]. Only the value returned in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6269 ** *pHighwater parameter to [sqlite3_status()] is of interest.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6270 ** The value written into the *pCurrent parameter is undefined.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6271 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6272 ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6273 ** <dd>This parameter records the deepest parser stack. It is only
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6274 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6275 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6276 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6277 ** New status parameters may be added from time to time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6278 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6279 #define SQLITE_STATUS_MEMORY_USED 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6280 #define SQLITE_STATUS_PAGECACHE_USED 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6281 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6282 #define SQLITE_STATUS_SCRATCH_USED 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6283 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6284 #define SQLITE_STATUS_MALLOC_SIZE 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6285 #define SQLITE_STATUS_PARSER_STACK 6
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6286 #define SQLITE_STATUS_PAGECACHE_SIZE 7
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6287 #define SQLITE_STATUS_SCRATCH_SIZE 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6288 #define SQLITE_STATUS_MALLOC_COUNT 9
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6289
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6290 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6291 ** CAPI3REF: Database Connection Status
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6292 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6293 ** ^This interface is used to retrieve runtime status information
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6294 ** about a single [database connection]. ^The first argument is the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6295 ** database connection object to be interrogated. ^The second argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6296 ** is an integer constant, taken from the set of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6297 ** [SQLITE_DBSTATUS options], that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6298 ** determines the parameter to interrogate. The set of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6299 ** [SQLITE_DBSTATUS options] is likely
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6300 ** to grow in future releases of SQLite.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6301 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6302 ** ^The current value of the requested parameter is written into *pCur
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6303 ** and the highest instantaneous value is written into *pHiwtr. ^If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6304 ** the resetFlg is true, then the highest instantaneous value is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6305 ** reset back down to the current value.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6306 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6307 ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6308 ** non-zero [error code] on failure.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6309 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6310 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6311 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6312 SQLITE_API int sqlite3_db_status(sqlite3, int op, int pCur, int *pHiwtr, int resetFlg);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6313
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6314 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6315 ** CAPI3REF: Status Parameters for database connections
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6316 ** KEYWORDS: {SQLITE_DBSTATUS options}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6317 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6318 ** These constants are the available integer "verbs" that can be passed as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6319 ** the second argument to the [sqlite3_db_status()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6320 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6321 ** New verbs may be added in future releases of SQLite. Existing verbs
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6322 ** might be discontinued. Applications should check the return code from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6323 ** [sqlite3_db_status()] to make sure that the call worked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6324 ** The [sqlite3_db_status()] interface will return a non-zero error code
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6325 ** if a discontinued or unsupported verb is invoked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6326 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6327 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6328 ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6329 ** <dd>This parameter returns the number of lookaside memory slots currently
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6330 ** checked out.</dd>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6331 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6332 ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6333 ** <dd>This parameter returns the number malloc attempts that were
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6334 ** satisfied using lookaside memory. Only the high-water value is meaningful;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6335 ** the current value is always zero.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6336 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6337 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6338 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6339 ** <dd>This parameter returns the number malloc attempts that might have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6340 ** been satisfied using lookaside memory but failed due to the amount of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6341 ** memory requested being larger than the lookaside slot size.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6342 ** Only the high-water value is meaningful;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6343 ** the current value is always zero.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6344 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6345 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6346 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6347 ** <dd>This parameter returns the number malloc attempts that might have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6348 ** been satisfied using lookaside memory but failed due to all lookaside
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6349 ** memory already being in use.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6350 ** Only the high-water value is meaningful;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6351 ** the current value is always zero.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6352 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6353 ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6354 ** <dd>This parameter returns the approximate number of of bytes of heap
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6355 ** memory used by all pager caches associated with the database connection.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6356 ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6357 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6358 ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6359 ** <dd>This parameter returns the approximate number of of bytes of heap
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6360 ** memory used to store the schema for all databases associated
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6361 ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6362 ** ^The full amount of memory used by the schemas is reported, even if the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6363 ** schema memory is shared with other database connections due to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6364 ** [shared cache mode] being enabled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6365 ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6366 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6367 ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6368 ** <dd>This parameter returns the approximate number of of bytes of heap
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6369 ** and lookaside memory used by all prepared statements associated with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6370 ** the database connection.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6371 ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6372 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6373 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6374 ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6375 ** <dd>This parameter returns the number of pager cache hits that have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6376 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6377 ** is always 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6378 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6379 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6380 ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6381 ** <dd>This parameter returns the number of pager cache misses that have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6382 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6383 ** is always 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6384 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6385 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6386 ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6387 ** <dd>This parameter returns the number of dirty cache entries that have
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6388 ** been written to disk. Specifically, the number of pages written to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6389 ** wal file in wal mode databases, or the number of pages written to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6390 ** database file in rollback mode databases. Any pages written as part of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6391 ** transaction rollback or database recovery operations are not included.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6392 ** If an IO or other error occurs while writing a page to disk, the effect
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6393 ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6394 ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6395 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6396 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6397 ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6398 ** <dd>This parameter returns zero for the current value if and only if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6399 ** all foreign key constraints (deferred or immediate) have been
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6400 ** resolved.)^ ^The highwater mark is always 0.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6401 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6402 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6403 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6404 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6405 #define SQLITE_DBSTATUS_CACHE_USED 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6406 #define SQLITE_DBSTATUS_SCHEMA_USED 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6407 #define SQLITE_DBSTATUS_STMT_USED 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6408 #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6409 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6410 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6411 #define SQLITE_DBSTATUS_CACHE_HIT 7
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6412 #define SQLITE_DBSTATUS_CACHE_MISS 8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6413 #define SQLITE_DBSTATUS_CACHE_WRITE 9
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6414 #define SQLITE_DBSTATUS_DEFERRED_FKS 10
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6415 #define SQLITE_DBSTATUS_MAX 10 /* Largest defined DBSTATUS */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6416
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6417
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6418 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6419 ** CAPI3REF: Prepared Statement Status
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6420 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6421 ** ^(Each prepared statement maintains various
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6422 ** [SQLITE_STMTSTATUS counters] that measure the number
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6423 ** of times it has performed specific operations.)^ These counters can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6424 ** be used to monitor the performance characteristics of the prepared
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6425 ** statements. For example, if the number of table steps greatly exceeds
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6426 ** the number of table searches or result rows, that would tend to indicate
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6427 ** that the prepared statement is using a full table scan rather than
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6428 ** an index.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6429 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6430 ** ^(This interface is used to retrieve and reset counter values from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6431 ** a [prepared statement]. The first argument is the prepared statement
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6432 ** object to be interrogated. The second argument
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6433 ** is an integer code for a specific [SQLITE_STMTSTATUS counter]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6434 ** to be interrogated.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6435 ** ^The current value of the requested counter is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6436 ** ^If the resetFlg is true, then the counter is reset to zero after this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6437 ** interface call returns.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6438 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6439 ** See also: [sqlite3_status()] and [sqlite3_db_status()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6440 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6441 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6442
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6443 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6444 ** CAPI3REF: Status Parameters for prepared statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6445 ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6446 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6447 ** These preprocessor macros define integer codes that name counter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6448 ** values associated with the [sqlite3_stmt_status()] interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6449 ** The meanings of the various counters are as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6450 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6451 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6452 ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6453 ** <dd>^This is the number of times that SQLite has stepped forward in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6454 ** a table as part of a full table scan. Large numbers for this counter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6455 ** may indicate opportunities for performance improvement through
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6456 ** careful use of indices.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6457 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6458 ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6459 ** <dd>^This is the number of sort operations that have occurred.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6460 ** A non-zero value in this counter may indicate an opportunity to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6461 ** improvement performance through careful use of indices.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6462 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6463 ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6464 ** <dd>^This is the number of rows inserted into transient indices that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6465 ** were created automatically in order to help joins run faster.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6466 ** A non-zero value in this counter may indicate an opportunity to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6467 ** improvement performance by adding permanent indices that do not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6468 ** need to be reinitialized each time the statement is run.</dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6469 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6470 ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6471 ** <dd>^This is the number of virtual machine operations executed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6472 ** by the prepared statement if that number is less than or equal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6473 ** to 2147483647. The number of virtual machine operations can be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6474 ** used as a proxy for the total work done by the prepared statement.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6475 ** If the number of virtual machine operations exceeds 2147483647
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6476 ** then the value returned by this statement status code is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6477 ** </dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6478 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6479 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6480 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6481 #define SQLITE_STMTSTATUS_SORT 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6482 #define SQLITE_STMTSTATUS_AUTOINDEX 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6483 #define SQLITE_STMTSTATUS_VM_STEP 4
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6484
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6485 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6486 ** CAPI3REF: Custom Page Cache Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6487 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6488 ** The sqlite3_pcache type is opaque. It is implemented by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6489 ** the pluggable module. The SQLite core has no knowledge of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6490 ** its size or internal structure and never deals with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6491 ** sqlite3_pcache object except by holding and passing pointers
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6492 ** to the object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6493 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6494 ** See [sqlite3_pcache_methods2] for additional information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6495 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6496 typedef struct sqlite3_pcache sqlite3_pcache;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6497
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6498 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6499 ** CAPI3REF: Custom Page Cache Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6500 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6501 ** The sqlite3_pcache_page object represents a single page in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6502 ** page cache. The page cache will allocate instances of this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6503 ** object. Various methods of the page cache use pointers to instances
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6504 ** of this object as parameters or as their return value.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6505 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6506 ** See [sqlite3_pcache_methods2] for additional information.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6507 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6508 typedef struct sqlite3_pcache_page sqlite3_pcache_page;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6509 struct sqlite3_pcache_page {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6510 void pBuf; / The content of the page */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6511 void pExtra; / Extra information associated with the page */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6512 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6513
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6514 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6515 ** CAPI3REF: Application Defined Page Cache.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6516 ** KEYWORDS: {page cache}
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6517 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6518 ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6519 ** register an alternative page cache implementation by passing in an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6520 ** instance of the sqlite3_pcache_methods2 structure.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6521 ** In many applications, most of the heap memory allocated by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6522 ** SQLite is used for the page cache.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6523 ** By implementing a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6524 ** custom page cache using this API, an application can better control
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6525 ** the amount of memory consumed by SQLite, the way in which
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6526 ** that memory is allocated and released, and the policies used to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6527 ** determine exactly which parts of a database file are cached and for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6528 ** how long.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6529 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6530 ** The alternative page cache mechanism is an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6531 ** extreme measure that is only needed by the most demanding applications.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6532 ** The built-in page cache is recommended for most uses.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6533 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6534 ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6535 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6536 ** the application may discard the parameter after the call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6537 ** [sqlite3_config()] returns.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6538 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6539 ** [[the xInit() page cache method]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6540 ** ^(The xInit() method is called once for each effective
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6541 ** call to [sqlite3_initialize()])^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6542 ** (usually only once during the lifetime of the process). ^(The xInit()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6543 ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6544 ** The intent of the xInit() method is to set up global data structures
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6545 ** required by the custom page cache implementation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6546 ** ^(If the xInit() method is NULL, then the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6547 ** built-in default page cache is used instead of the application defined
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6548 ** page cache.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6549 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6550 ** [[the xShutdown() page cache method]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6551 ** ^The xShutdown() method is called by [sqlite3_shutdown()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6552 ** It can be used to clean up
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6553 ** any outstanding resources before process shutdown, if required.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6554 ** ^The xShutdown() method may be NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6555 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6556 ** ^SQLite automatically serializes calls to the xInit method,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6557 ** so the xInit method need not be threadsafe. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6558 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6559 ** not need to be threadsafe either. All other methods must be threadsafe
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6560 ** in multithreaded applications.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6561 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6562 ** ^SQLite will never invoke xInit() more than once without an intervening
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6563 ** call to xShutdown().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6564 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6565 ** [[the xCreate() page cache methods]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6566 ** ^SQLite invokes the xCreate() method to construct a new cache instance.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6567 ** SQLite will typically create one cache instance for each open database file,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6568 ** though this is not guaranteed. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6569 ** first parameter, szPage, is the size in bytes of the pages that must
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6570 ** be allocated by the cache. ^szPage will always a power of two. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6571 ** second parameter szExtra is a number of bytes of extra storage
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6572 ** associated with each page cache entry. ^The szExtra parameter will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6573 ** a number less than 250. SQLite will use the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6574 ** extra szExtra bytes on each page to store metadata about the underlying
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6575 ** database page on disk. The value passed into szExtra depends
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6576 ** on the SQLite version, the target platform, and how SQLite was compiled.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6577 ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6578 ** created will be used to cache database pages of a file stored on disk, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6579 ** false if it is used for an in-memory database. The cache implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6580 ** does not have to do anything special based with the value of bPurgeable;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6581 ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6582 ** never invoke xUnpin() except to deliberately delete a page.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6583 ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6584 ** false will always have the "discard" flag set to true.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6585 ** ^Hence, a cache created with bPurgeable false will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6586 ** never contain any unpinned pages.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6587 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6588 ** [[the xCachesize() page cache method]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6589 ** ^(The xCachesize() method may be called at any time by SQLite to set the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6590 ** suggested maximum cache-size (number of pages stored by) the cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6591 ** instance passed as the first argument. This is the value configured using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6592 ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6593 ** parameter, the implementation is not required to do anything with this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6594 ** value; it is advisory only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6595 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6596 ** [[the xPagecount() page cache methods]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6597 ** The xPagecount() method must return the number of pages currently
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6598 ** stored in the cache, both pinned and unpinned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6599 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6600 ** [[the xFetch() page cache methods]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6601 ** The xFetch() method locates a page in the cache and returns a pointer to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6602 ** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6603 ** The pBuf element of the returned sqlite3_pcache_page object will be a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6604 ** pointer to a buffer of szPage bytes used to store the content of a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6605 ** single database page. The pExtra element of sqlite3_pcache_page will be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6606 ** a pointer to the szExtra bytes of extra storage that SQLite has requested
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6607 ** for each entry in the page cache.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6608 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6609 ** The page to be fetched is determined by the key. ^The minimum key value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6610 ** is 1. After it has been retrieved using xFetch, the page is considered
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6611 ** to be "pinned".
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6612 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6613 ** If the requested page is already in the page cache, then the page cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6614 ** implementation must return a pointer to the page buffer with its content
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6615 ** intact. If the requested page is not already in the cache, then the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6616 ** cache implementation should use the value of the createFlag
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6617 ** parameter to help it determined what action to take:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6618 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6619 ** <table border=1 width=85% align=center>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6620 ** <tr><th> createFlag <th> Behavior when page is not already in cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6621 ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6622 ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6623 ** Otherwise return NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6624 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6625 ** NULL if allocating a new page is effectively impossible.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6626 ** </table>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6627 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6628 ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6629 ** will only use a createFlag of 2 after a prior call with a createFlag of 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6630 ** failed.)^ In between the to xFetch() calls, SQLite may
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6631 ** attempt to unpin one or more cache pages by spilling the content of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6632 ** pinned pages to disk and synching the operating system disk cache.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6633 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6634 ** [[the xUnpin() page cache method]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6635 ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6636 ** as its second argument. If the third parameter, discard, is non-zero,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6637 ** then the page must be evicted from the cache.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6638 ** ^If the discard parameter is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6639 ** zero, then the page may be discarded or retained at the discretion of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6640 ** page cache implementation. ^The page cache implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6641 ** may choose to evict unpinned pages at any time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6642 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6643 ** The cache must not perform any reference counting. A single
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6644 ** call to xUnpin() unpins the page regardless of the number of prior calls
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6645 ** to xFetch().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6646 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6647 ** [[the xRekey() page cache methods]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6648 ** The xRekey() method is used to change the key value associated with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6649 ** page passed as the second argument. If the cache
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6650 ** previously contains an entry associated with newKey, it must be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6651 ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6652 ** to be pinned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6653 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6654 ** When SQLite calls the xTruncate() method, the cache must discard all
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6655 ** existing cache entries with page numbers (keys) greater than or equal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6656 ** to the value of the iLimit parameter passed to xTruncate(). If any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6657 ** of these pages are pinned, they are implicitly unpinned, meaning that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6658 ** they can be safely discarded.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6659 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6660 ** [[the xDestroy() page cache method]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6661 ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6662 ** All resources associated with the specified cache should be freed. ^After
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6663 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6664 ** handle invalid, and will not use it with any other sqlite3_pcache_methods2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6665 ** functions.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6666 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6667 ** [[the xShrink() page cache method]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6668 ** ^SQLite invokes the xShrink() method when it wants the page cache to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6669 ** free up as much of heap memory as possible. The page cache implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6670 ** is not obligated to free any memory, but well-behaved implementations should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6671 ** do their best.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6672 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6673 typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6674 struct sqlite3_pcache_methods2 {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6675 int iVersion;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6676 void *pArg;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6677 int (xInit)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6678 void (xShutdown)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6679 sqlite3_pcache (xCreate)(int szPage, int szExtra, int bPurgeable);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6680 void (xCachesize)(sqlite3_pcache, int nCachesize);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6681 int (xPagecount)(sqlite3_pcache);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6682 sqlite3_pcache_page (xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6683 void (xUnpin)(sqlite3_pcache, sqlite3_pcache_page*, int discard);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6684 void (xRekey)(sqlite3_pcache, sqlite3_pcache_page*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6685 unsigned oldKey, unsigned newKey);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6686 void (xTruncate)(sqlite3_pcache, unsigned iLimit);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6687 void (xDestroy)(sqlite3_pcache);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6688 void (xShrink)(sqlite3_pcache);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6689 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6690
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6691 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6692 ** This is the obsolete pcache_methods object that has now been replaced
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6693 ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6694 ** retained in the header file for backwards compatibility only.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6695 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6696 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6697 struct sqlite3_pcache_methods {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6698 void *pArg;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6699 int (xInit)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6700 void (xShutdown)(void);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6701 sqlite3_pcache (xCreate)(int szPage, int bPurgeable);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6702 void (xCachesize)(sqlite3_pcache, int nCachesize);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6703 int (xPagecount)(sqlite3_pcache);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6704 void (xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6705 void (xUnpin)(sqlite3_pcache, void*, int discard);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6706 void (xRekey)(sqlite3_pcache, void*, unsigned oldKey, unsigned newKey);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6707 void (xTruncate)(sqlite3_pcache, unsigned iLimit);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6708 void (xDestroy)(sqlite3_pcache);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6709 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6710
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6711
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6712 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6713 ** CAPI3REF: Online Backup Object
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6714 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6715 ** The sqlite3_backup object records state information about an ongoing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6716 ** online backup operation. ^The sqlite3_backup object is created by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6717 ** a call to [sqlite3_backup_init()] and is destroyed by a call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6718 ** [sqlite3_backup_finish()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6719 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6720 ** See Also: [Using the SQLite Online Backup API]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6721 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6722 typedef struct sqlite3_backup sqlite3_backup;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6723
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6724 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6725 ** CAPI3REF: Online Backup API.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6726 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6727 ** The backup API copies the content of one database into another.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6728 ** It is useful either for creating backups of databases or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6729 ** for copying in-memory databases to or from persistent files.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6730 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6731 ** See Also: [Using the SQLite Online Backup API]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6732 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6733 ** ^SQLite holds a write transaction open on the destination database file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6734 ** for the duration of the backup operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6735 ** ^The source database is read-locked only while it is being read;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6736 ** it is not locked continuously for the entire backup operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6737 ** ^Thus, the backup may be performed on a live source database without
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6738 ** preventing other database connections from
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6739 ** reading or writing to the source database while the backup is underway.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6740 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6741 ** ^(To perform a backup operation:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6742 ** <ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6743 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6744 ** backup,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6745 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6746 ** the data between the two databases, and finally
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6747 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6748 ** associated with the backup operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6749 ** </ol>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6750 ** There should be exactly one call to sqlite3_backup_finish() for each
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6751 ** successful call to sqlite3_backup_init().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6752 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6753 ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6754 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6755 ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6756 ** [database connection] associated with the destination database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6757 ** and the database name, respectively.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6758 ** ^The database name is "main" for the main database, "temp" for the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6759 ** temporary database, or the name specified after the AS keyword in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6760 ** an [ATTACH] statement for an attached database.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6761 ** ^The S and M arguments passed to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6762 ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6763 ** and database name of the source database, respectively.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6764 ** ^The source and destination [database connections] (parameters S and D)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6765 ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6766 ** an error.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6767 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6768 ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6769 ** returned and an error code and error message are stored in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6770 ** destination [database connection] D.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6771 ** ^The error code and message for the failed call to sqlite3_backup_init()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6772 ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6773 ** [sqlite3_errmsg16()] functions.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6774 ** ^A successful call to sqlite3_backup_init() returns a pointer to an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6775 ** [sqlite3_backup] object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6776 ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6777 ** sqlite3_backup_finish() functions to perform the specified backup
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6778 ** operation.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6779 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6780 ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6781 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6782 ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6783 ** the source and destination databases specified by [sqlite3_backup] object B.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6784 ** ^If N is negative, all remaining source pages are copied.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6785 ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6786 ** are still more pages to be copied, then the function returns [SQLITE_OK].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6787 ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6788 ** from source to destination, then it returns [SQLITE_DONE].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6789 ** ^If an error occurs while running sqlite3_backup_step(B,N),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6790 ** then an [error code] is returned. ^As well as [SQLITE_OK] and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6791 ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6792 ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6793 ** [SQLITE_IOERR_ACCESS \| SQLITE_IOERR_XXX] extended error code.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6794 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6795 ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6796 ** <ol>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6797 ** <li> the destination database was opened read-only, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6798 ** <li> the destination database is using write-ahead-log journaling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6799 ** and the destination and source page sizes differ, or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6800 ** <li> the destination database is an in-memory database and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6801 ** destination and source page sizes differ.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6802 ** </ol>)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6803 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6804 ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6805 ** the [sqlite3_busy_handler \| busy-handler function]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6806 ** is invoked (if one is specified). ^If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6807 ** busy-handler returns non-zero before the lock is available, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6808 ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6809 ** sqlite3_backup_step() can be retried later. ^If the source
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6810 ** [database connection]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6811 ** is being used to write to the source database when sqlite3_backup_step()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6812 ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6813 ** case the call to sqlite3_backup_step() can be retried later on. ^(If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6814 ** [SQLITE_IOERR_ACCESS \| SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6815 ** [SQLITE_READONLY] is returned, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6816 ** there is no point in retrying the call to sqlite3_backup_step(). These
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6817 ** errors are considered fatal.)^ The application must accept
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6818 ** that the backup operation has failed and pass the backup operation handle
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6819 ** to the sqlite3_backup_finish() to release associated resources.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6820 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6821 ** ^The first call to sqlite3_backup_step() obtains an exclusive lock
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6822 ** on the destination file. ^The exclusive lock is not released until either
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6823 ** sqlite3_backup_finish() is called or the backup operation is complete
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6824 ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6825 ** sqlite3_backup_step() obtains a [shared lock] on the source database that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6826 ** lasts for the duration of the sqlite3_backup_step() call.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6827 ** ^Because the source database is not locked between calls to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6828 ** sqlite3_backup_step(), the source database may be modified mid-way
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6829 ** through the backup process. ^If the source database is modified by an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6830 ** external process or via a database connection other than the one being
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6831 ** used by the backup operation, then the backup will be automatically
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6832 ** restarted by the next call to sqlite3_backup_step(). ^If the source
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6833 ** database is modified by the using the same database connection as is used
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6834 ** by the backup operation, then the backup database is automatically
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6835 ** updated at the same time.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6836 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6837 ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6838 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6839 ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6840 ** application wishes to abandon the backup operation, the application
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6841 ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6842 ** ^The sqlite3_backup_finish() interfaces releases all
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6843 ** resources associated with the [sqlite3_backup] object.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6844 ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6845 ** active write-transaction on the destination database is rolled back.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6846 ** The [sqlite3_backup] object is invalid
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6847 ** and may not be used following a call to sqlite3_backup_finish().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6848 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6849 ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6850 ** sqlite3_backup_step() errors occurred, regardless or whether or not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6851 ** sqlite3_backup_step() completed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6852 ** ^If an out-of-memory condition or IO error occurred during any prior
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6853 ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6854 ** sqlite3_backup_finish() returns the corresponding [error code].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6855 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6856 ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6857 ** is not a permanent error and does not affect the return value of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6858 ** sqlite3_backup_finish().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6859 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6860 ** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6861 ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6862 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6863 ** ^Each call to sqlite3_backup_step() sets two values inside
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6864 ** the [sqlite3_backup] object: the number of pages still to be backed
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6865 ** up and the total number of pages in the source database file.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6866 ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6867 ** retrieve these two values, respectively.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6868 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6869 ** ^The values returned by these functions are only updated by
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6870 ** sqlite3_backup_step(). ^If the source database is modified during a backup
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6871 ** operation, then the values are not updated to account for any extra
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6872 ** pages that need to be updated or the size of the source database file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6873 ** changing.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6874 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6875 ** <b>Concurrent Usage of Database Handles</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6876 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6877 ** ^The source [database connection] may be used by the application for other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6878 ** purposes while a backup operation is underway or being initialized.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6879 ** ^If SQLite is compiled and configured to support threadsafe database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6880 ** connections, then the source database connection may be used concurrently
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6881 ** from within other threads.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6882 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6883 ** However, the application must guarantee that the destination
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6884 ** [database connection] is not passed to any other API (by any thread) after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6885 ** sqlite3_backup_init() is called and before the corresponding call to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6886 ** sqlite3_backup_finish(). SQLite does not currently check to see
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6887 ** if the application incorrectly accesses the destination [database connection]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6888 ** and so no error code is reported, but the operations may malfunction
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6889 ** nevertheless. Use of the destination database connection while a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6890 ** backup is in progress might also also cause a mutex deadlock.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6891 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6892 ** If running in [shared cache mode], the application must
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6893 ** guarantee that the shared cache used by the destination database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6894 ** is not accessed while the backup is running. In practice this means
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6895 ** that the application must guarantee that the disk file being
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6896 ** backed up to is not accessed by any connection within the process,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6897 ** not just the specific connection that was passed to sqlite3_backup_init().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6898 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6899 ** The [sqlite3_backup] object itself is partially threadsafe. Multiple
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6900 ** threads may safely make multiple concurrent calls to sqlite3_backup_step().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6901 ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6902 ** APIs are not strictly speaking threadsafe. If they are invoked at the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6903 ** same time as another thread is invoking sqlite3_backup_step() it is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6904 ** possible that they return invalid values.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6905 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6906 SQLITE_API sqlite3_backup *sqlite3_backup_init(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6907 sqlite3 pDest, / Destination database handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6908 const char zDestName, / Destination database name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6909 sqlite3 pSource, / Source database handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6910 const char zSourceName / Source database name */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6911 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6912 SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6913 SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6914 SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6915 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6916
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6917 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6918 ** CAPI3REF: Unlock Notification
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6919 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6920 ** ^When running in shared-cache mode, a database operation may fail with
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6921 ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6922 ** individual tables within the shared-cache cannot be obtained. See
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6923 ** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6924 ** ^This API may be used to register a callback that SQLite will invoke
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6925 ** when the connection currently holding the required lock relinquishes it.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6926 ** ^This API is only available if the library was compiled with the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6927 ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6928 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6929 ** See Also: [Using the SQLite Unlock Notification Feature].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6930 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6931 ** ^Shared-cache locks are released when a database connection concludes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6932 ** its current transaction, either by committing it or rolling it back.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6933 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6934 ** ^When a connection (known as the blocked connection) fails to obtain a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6935 ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6936 ** identity of the database connection (the blocking connection) that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6937 ** has locked the required resource is stored internally. ^After an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6938 ** application receives an SQLITE_LOCKED error, it may call the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6939 ** sqlite3_unlock_notify() method with the blocked connection handle as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6940 ** the first argument to register for a callback that will be invoked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6941 ** when the blocking connections current transaction is concluded. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6942 ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6943 ** call that concludes the blocking connections transaction.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6944 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6945 ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6946 ** there is a chance that the blocking connection will have already
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6947 ** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6948 ** If this happens, then the specified callback is invoked immediately,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6949 ** from within the call to sqlite3_unlock_notify().)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6950 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6951 ** ^If the blocked connection is attempting to obtain a write-lock on a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6952 ** shared-cache table, and more than one other connection currently holds
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6953 ** a read-lock on the same table, then SQLite arbitrarily selects one of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6954 ** the other connections to use as the blocking connection.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6955 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6956 ** ^(There may be at most one unlock-notify callback registered by a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6957 ** blocked connection. If sqlite3_unlock_notify() is called when the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6958 ** blocked connection already has a registered unlock-notify callback,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6959 ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6960 ** called with a NULL pointer as its second argument, then any existing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6961 ** unlock-notify callback is canceled. ^The blocked connections
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6962 ** unlock-notify callback may also be canceled by closing the blocked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6963 ** connection using [sqlite3_close()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6964 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6965 ** The unlock-notify callback is not reentrant. If an application invokes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6966 ** any sqlite3_xxx API functions from within an unlock-notify callback, a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6967 ** crash or deadlock may be the result.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6968 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6969 ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6970 ** returns SQLITE_OK.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6971 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6972 ** <b>Callback Invocation Details</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6973 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6974 ** When an unlock-notify callback is registered, the application provides a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6975 ** single void* pointer that is passed to the callback when it is invoked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6976 ** However, the signature of the callback function allows SQLite to pass
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6977 ** it an array of void* context pointers. The first argument passed to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6978 ** an unlock-notify callback is a pointer to an array of void* pointers,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6979 ** and the second is the number of entries in the array.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6980 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6981 ** When a blocking connections transaction is concluded, there may be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6982 ** more than one blocked connection that has registered for an unlock-notify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6983 ** callback. ^If two or more such blocked connections have specified the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6984 ** same callback function, then instead of invoking the callback function
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6985 ** multiple times, it is invoked once with the set of void* context pointers
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6986 ** specified by the blocked connections bundled together into an array.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6987 ** This gives the application an opportunity to prioritize any actions
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6988 ** related to the set of unblocked database connections.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6989 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6990 ** <b>Deadlock Detection</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6991 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6992 ** Assuming that after registering for an unlock-notify callback a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6993 ** database waits for the callback to be issued before taking any further
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6994 ** action (a reasonable assumption), then using this API may cause the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6995 ** application to deadlock. For example, if connection X is waiting for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6996 ** connection Y's transaction to be concluded, and similarly connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6997 ** Y is waiting on connection X's transaction, then neither connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6998 ** will proceed and the system may remain deadlocked indefinitely.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6999 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7000 ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7001 ** detection. ^If a given call to sqlite3_unlock_notify() would put the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7002 ** system in a deadlocked state, then SQLITE_LOCKED is returned and no
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7003 ** unlock-notify callback is registered. The system is said to be in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7004 ** a deadlocked state if connection A has registered for an unlock-notify
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7005 ** callback on the conclusion of connection B's transaction, and connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7006 ** B has itself registered for an unlock-notify callback when connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7007 ** A's transaction is concluded. ^Indirect deadlock is also detected, so
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7008 ** the system is also considered to be deadlocked if connection B has
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7009 ** registered for an unlock-notify callback on the conclusion of connection
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7010 ** C's transaction, where connection C is waiting on connection A. ^Any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7011 ** number of levels of indirection are allowed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7012 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7013 ** <b>The "DROP TABLE" Exception</b>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7014 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7015 ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7016 ** always appropriate to call sqlite3_unlock_notify(). There is however,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7017 ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7018 ** SQLite checks if there are any currently executing SELECT statements
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7019 ** that belong to the same connection. If there are, SQLITE_LOCKED is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7020 ** returned. In this case there is no "blocking connection", so invoking
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7021 ** sqlite3_unlock_notify() results in the unlock-notify callback being
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7022 ** invoked immediately. If the application then re-attempts the "DROP TABLE"
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7023 ** or "DROP INDEX" query, an infinite loop might be the result.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7024 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7025 ** One way around this problem is to check the extended error code returned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7026 ** by an sqlite3_step() call. ^(If there is a blocking connection, then the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7027 ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7028 ** the special "DROP TABLE/INDEX" case, the extended error code is just
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7029 ** SQLITE_LOCKED.)^
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7030 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7031 SQLITE_API int sqlite3_unlock_notify(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7032 sqlite3 pBlocked, / Waiting connection */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7033 void (xNotify)(void apArg, int nArg), / Callback function to invoke */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7034 void pNotifyArg / Argument to pass to xNotify */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7035 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7036
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7037
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7038 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7039 ** CAPI3REF: String Comparison
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7040 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7041 ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7042 ** and extensions to compare the contents of two buffers containing UTF-8
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7043 ** strings in a case-independent fashion, using the same definition of "case
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7044 ** independence" that SQLite uses internally when comparing identifiers.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7045 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7046 SQLITE_API int sqlite3_stricmp(const char , const char );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7047 SQLITE_API int sqlite3_strnicmp(const char , const char , int);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7048
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7049 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7050 ** CAPI3REF: String Globbing
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7051 *
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7052 ** ^The [sqlite3_strglob(P,X)] interface returns zero if string X matches
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7053 ** the glob pattern P, and it returns non-zero if string X does not match
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7054 ** the glob pattern P. ^The definition of glob pattern matching used in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7055 ** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7056 ** SQL dialect used by SQLite. ^The sqlite3_strglob(P,X) function is case
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7057 ** sensitive.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7058 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7059 ** Note that this routine returns zero on a match and non-zero if the strings
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7060 ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7061 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7062 SQLITE_API int sqlite3_strglob(const char zGlob, const char zStr);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7063
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7064 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7065 ** CAPI3REF: Error Logging Interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7066 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7067 ** ^The [sqlite3_log()] interface writes a message into the [error log]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7068 ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7069 ** ^If logging is enabled, the zFormat string and subsequent arguments are
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7070 ** used with [sqlite3_snprintf()] to generate the final output string.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7071 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7072 ** The sqlite3_log() interface is intended for use by extensions such as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7073 ** virtual tables, collating functions, and SQL functions. While there is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7074 ** nothing to prevent an application from calling sqlite3_log(), doing so
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7075 ** is considered bad form.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7076 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7077 ** The zFormat string must not be NULL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7078 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7079 ** To avoid deadlocks and other threading problems, the sqlite3_log() routine
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7080 ** will not use dynamically allocated memory. The log message is stored in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7081 ** a fixed-length buffer on the stack. If the log message is longer than
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7082 ** a few hundred characters, it will be truncated to the length of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7083 ** buffer.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7084 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7085 SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7086
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7087 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7088 ** CAPI3REF: Write-Ahead Log Commit Hook
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7089 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7090 ** ^The [sqlite3_wal_hook()] function is used to register a callback that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7091 ** will be invoked each time a database connection commits data to a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7092 ** [write-ahead log] (i.e. whenever a transaction is committed in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7093 ** [journal_mode \| journal_mode=WAL mode]).
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7094 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7095 ** ^The callback is invoked by SQLite after the commit has taken place and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7096 ** the associated write-lock on the database released, so the implementation
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7097 ** may read, write or [checkpoint] the database as required.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7098 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7099 ** ^The first parameter passed to the callback function when it is invoked
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7100 ** is a copy of the third parameter passed to sqlite3_wal_hook() when
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7101 ** registering the callback. ^The second is a copy of the database handle.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7102 ** ^The third parameter is the name of the database that was written to -
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7103 ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7104 ** is the number of pages currently in the write-ahead log file,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7105 ** including those that were just committed.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7106 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7107 ** The callback function should normally return [SQLITE_OK]. ^If an error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7108 ** code is returned, that error will propagate back up through the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7109 ** SQLite code base to cause the statement that provoked the callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7110 ** to report an error, though the commit will have still occurred. If the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7111 ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7112 ** that does not correspond to any valid SQLite error code, the results
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7113 ** are undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7114 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7115 ** A single database handle may have at most a single write-ahead log callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7116 ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7117 ** previously registered write-ahead log callback. ^Note that the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7118 ** [sqlite3_wal_autocheckpoint()] interface and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7119 ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7120 ** those overwrite any prior [sqlite3_wal_hook()] settings.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7121 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7122 SQLITE_API void *sqlite3_wal_hook(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7123 sqlite3*,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7124 int()(void ,sqlite3,const char,int),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7125 void*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7126 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7127
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7128 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7129 ** CAPI3REF: Configure an auto-checkpoint
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7130 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7131 ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7132 ** [sqlite3_wal_hook()] that causes any database on [database connection] D
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7133 ** to automatically [checkpoint]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7134 ** after committing a transaction if there are N or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7135 ** more frames in the [write-ahead log] file. ^Passing zero or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7136 ** a negative value as the nFrame parameter disables automatic
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7137 ** checkpoints entirely.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7138 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7139 ** ^The callback registered by this function replaces any existing callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7140 ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7141 ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7142 ** configured by this function.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7143 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7144 ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7145 ** from SQL.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7146 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7147 ** ^Every new [database connection] defaults to having the auto-checkpoint
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7148 ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7149 ** pages. The use of this interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7150 ** is only necessary if the default setting is found to be suboptimal
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7151 ** for a particular application.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7152 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7153 SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7154
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7155 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7156 ** CAPI3REF: Checkpoint a database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7157 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7158 ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7159 ** on [database connection] D to be [checkpointed]. ^If X is NULL or an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7160 ** empty string, then a checkpoint is run on all databases of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7161 ** connection D. ^If the database connection D is not in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7162 ** [WAL \| write-ahead log mode] then this interface is a harmless no-op.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7163 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7164 ** ^The [wal_checkpoint pragma] can be used to invoke this interface
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7165 ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7166 ** [wal_autocheckpoint pragma] can be used to cause this interface to be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7167 ** run whenever the WAL reaches a certain size threshold.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7168 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7169 ** See also: [sqlite3_wal_checkpoint_v2()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7170 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7171 SQLITE_API int sqlite3_wal_checkpoint(sqlite3 db, const char zDb);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7172
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7173 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7174 ** CAPI3REF: Checkpoint a database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7175 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7176 ** Run a checkpoint operation on WAL database zDb attached to database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7177 ** handle db. The specific operation is determined by the value of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7178 ** eMode parameter:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7179 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7180 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7181 ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7182 ** Checkpoint as many frames as possible without waiting for any database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7183 ** readers or writers to finish. Sync the db file if all frames in the log
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7184 ** are checkpointed. This mode is the same as calling
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7185 ** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7186 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7187 ** <dt>SQLITE_CHECKPOINT_FULL<dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7188 ** This mode blocks (calls the busy-handler callback) until there is no
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7189 ** database writer and all readers are reading from the most recent database
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7190 ** snapshot. It then checkpoints all frames in the log file and syncs the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7191 ** database file. This call blocks database writers while it is running,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7192 ** but not database readers.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7193 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7194 ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7195 ** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7196 ** checkpointing the log file it blocks (calls the busy-handler callback)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7197 ** until all readers are reading from the database file only. This ensures
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7198 ** that the next client to write to the database file restarts the log file
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7199 ** from the beginning. This call blocks database writers while it is running,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7200 ** but not database readers.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7201 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7202 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7203 ** If pnLog is not NULL, then *pnLog is set to the total number of frames in
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7204 ** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7205 ** the total number of checkpointed frames (including any that were already
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7206 ** checkpointed when this function is called). pnLog and pnCkpt may be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7207 ** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7208 ** If no values are available because of an error, they are both set to -1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7209 ** before returning to communicate this to the caller.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7210 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7211 ** All calls obtain an exclusive "checkpoint" lock on the database file. If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7212 ** any other process is running a checkpoint operation at the same time, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7213 ** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7214 ** busy-handler configured, it will not be invoked in this case.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7215 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7216 ** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7217 ** "writer" lock on the database file. If the writer lock cannot be obtained
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7218 ** immediately, and a busy-handler is configured, it is invoked and the writer
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7219 ** lock retried until either the busy-handler returns 0 or the lock is
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7220 ** successfully obtained. The busy-handler is also invoked while waiting for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7221 ** database readers as described above. If the busy-handler returns 0 before
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7222 ** the writer lock is obtained or while waiting for database readers, the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7223 ** checkpoint operation proceeds from that point in the same way as
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7224 ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7225 ** without blocking any further. SQLITE_BUSY is returned in this case.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7226 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7227 ** If parameter zDb is NULL or points to a zero length string, then the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7228 ** specified operation is attempted on all WAL databases. In this case the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7229 ** values written to output parameters pnLog and pnCkpt are undefined. If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7230 ** an SQLITE_BUSY error is encountered when processing one or more of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7231 ** attached WAL databases, the operation is still attempted on any remaining
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7232 ** attached databases and SQLITE_BUSY is returned to the caller. If any other
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7233 ** error occurs while processing an attached database, processing is abandoned
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7234 ** and the error code returned to the caller immediately. If no error
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7235 ** (SQLITE_BUSY or otherwise) is encountered while processing the attached
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7236 ** databases, SQLITE_OK is returned.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7237 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7238 ** If database zDb is the name of an attached database that is not in WAL
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7239 ** mode, SQLITE_OK is returned and both pnLog and pnCkpt set to -1. If
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7240 ** zDb is not NULL (or a zero length string) and is not the name of any
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7241 ** attached database, SQLITE_ERROR is returned to the caller.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7242 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7243 SQLITE_API int sqlite3_wal_checkpoint_v2(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7244 sqlite3 db, / Database handle */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7245 const char zDb, / Name of attached database (or NULL) */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7246 int eMode, /* SQLITE_CHECKPOINT_* value */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7247 int pnLog, / OUT: Size of WAL log in frames */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7248 int pnCkpt / OUT: Total number of frames checkpointed */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7249 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7250
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7251 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7252 ** CAPI3REF: Checkpoint operation parameters
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7253 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7254 ** These constants can be used as the 3rd parameter to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7255 ** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()]
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7256 ** documentation for additional information about the meaning and use of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7257 ** each of these values.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7258 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7259 #define SQLITE_CHECKPOINT_PASSIVE 0
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7260 #define SQLITE_CHECKPOINT_FULL 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7261 #define SQLITE_CHECKPOINT_RESTART 2
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7262
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7263 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7264 ** CAPI3REF: Virtual Table Interface Configuration
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7265 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7266 ** This function may be called by either the [xConnect] or [xCreate] method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7267 ** of a [virtual table] implementation to configure
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7268 ** various facets of the virtual table interface.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7269 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7270 ** If this interface is invoked outside the context of an xConnect or
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7271 ** xCreate virtual table method then the behavior is undefined.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7272 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7273 ** At present, there is only one option that may be configured using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7274 ** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7275 ** may be added in the future.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7276 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7277 SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7278
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7279 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7280 ** CAPI3REF: Virtual Table Configuration Options
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7281 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7282 ** These macros define the various options to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7283 ** [sqlite3_vtab_config()] interface that [virtual table] implementations
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7284 ** can use to customize and optimize their behavior.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7285 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7286 ** <dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7287 ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7288 ** <dd>Calls of the form
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7289 ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7290 ** where X is an integer. If X is zero, then the [virtual table] whose
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7291 ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7292 ** support constraints. In this configuration (which is the default) if
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7293 ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7294 ** statement is rolled back as if [ON CONFLICT \| OR ABORT] had been
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7295 ** specified as part of the users SQL statement, regardless of the actual
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7296 ** ON CONFLICT mode specified.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7297 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7298 ** If X is non-zero, then the virtual table implementation guarantees
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7299 ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7300 ** any modifications to internal or persistent data structures have been made.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7301 ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7302 ** is able to roll back a statement or database transaction, and abandon
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7303 ** or continue processing the current SQL statement as appropriate.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7304 ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7305 ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7306 ** had been ABORT.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7307 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7308 ** Virtual table implementations that are required to handle OR REPLACE
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7309 ** must do so within the [xUpdate] method. If a call to the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7310 ** [sqlite3_vtab_on_conflict()] function indicates that the current ON
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7311 ** CONFLICT policy is REPLACE, the virtual table implementation should
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7312 ** silently replace the appropriate rows within the xUpdate callback and
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7313 ** return SQLITE_OK. Or, if this is not possible, it may return
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7314 ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7315 ** constraint handling.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7316 ** </dl>
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7317 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7318 #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7319
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7320 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7321 ** CAPI3REF: Determine The Virtual Table Conflict Policy
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7322 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7323 ** This function may only be called from within a call to the [xUpdate] method
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7324 ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7325 ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7326 ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7327 ** of the SQL statement that triggered the call to the [xUpdate] method of the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7328 ** [virtual table].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7329 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7330 SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7331
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7332 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7333 ** CAPI3REF: Conflict resolution modes
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7334 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7335 ** These constants are returned by [sqlite3_vtab_on_conflict()] to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7336 ** inform a [virtual table] implementation what the [ON CONFLICT] mode
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7337 ** is for the SQL statement being evaluated.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7338 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7339 ** Note that the [SQLITE_IGNORE] constant is also used as a potential
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7340 ** return value from the [sqlite3_set_authorizer()] callback and that
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7341 ** [SQLITE_ABORT] is also a [result code].
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7342 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7343 #define SQLITE_ROLLBACK 1
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7344 /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7345 #define SQLITE_FAIL 3
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7346 /* #define SQLITE_ABORT 4 // Also an error code */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7347 #define SQLITE_REPLACE 5
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7348
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7349
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7350
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7351 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7352 ** Undo the hack that converts floating point types to integer for
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7353 ** builds on processors without floating point support.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7354 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7355 #ifdef SQLITE_OMIT_FLOATING_POINT
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7356 # undef double
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7357 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7358
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7359 #ifdef __cplusplus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7360 } /* End of the 'extern "C"' block */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7361 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7362 #endif /* _SQLITE3_H_ */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7363
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7364 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7365 ** 2010 August 30
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7366 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7367 ** The author disclaims copyright to this source code. In place of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7368 ** a legal notice, here is a blessing:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7369 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7370 ** May you do good and not evil.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7371 ** May you find forgiveness for yourself and forgive others.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7372 ** May you share freely, never taking more than you give.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7373 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7374 *************************************************************************
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7375 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7376
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7377 #ifndef _SQLITE3RTREE_H_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7378 #define _SQLITE3RTREE_H_
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7379
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7380
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7381 #ifdef __cplusplus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7382 extern "C" {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7383 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7384
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7385 typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7386 typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7387
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7388 /* The double-precision datatype used by RTree depends on the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7389 ** SQLITE_RTREE_INT_ONLY compile-time option.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7390 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7391 #ifdef SQLITE_RTREE_INT_ONLY
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7392 typedef sqlite3_int64 sqlite3_rtree_dbl;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7393 #else
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7394 typedef double sqlite3_rtree_dbl;
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7395 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7396
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7397 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7398 ** Register a geometry callback named zGeom that can be used as part of an
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7399 ** R-Tree geometry query as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7400 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7401 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7402 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7403 SQLITE_API int sqlite3_rtree_geometry_callback(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7404 sqlite3 *db,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7405 const char *zGeom,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7406 int (xGeom)(sqlite3_rtree_geometry, int, sqlite3_rtree_dbl,int),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7407 void *pContext
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7408 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7409
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7410
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7411 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7412 ** A pointer to a structure of the following type is passed as the first
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7413 ** argument to callbacks registered using rtree_geometry_callback().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7414 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7415 struct sqlite3_rtree_geometry {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7416 void pContext; / Copy of pContext passed to s_r_g_c() */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7417 int nParam; /* Size of array aParam[] */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7418 sqlite3_rtree_dbl aParam; / Parameters passed to SQL geom function */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7419 void pUser; / Callback implementation user data */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7420 void (xDelUser)(void ); /* Called by SQLite to clean up pUser */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7421 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7422
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7423 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7424 ** Register a 2nd-generation geometry callback named zScore that can be
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7425 ** used as part of an R-Tree geometry query as follows:
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7426 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7427 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7428 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7429 SQLITE_API int sqlite3_rtree_query_callback(
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7430 sqlite3 *db,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7431 const char *zQueryFunc,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7432 int (xQueryFunc)(sqlite3_rtree_query_info),
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7433 void *pContext,
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7434 void (xDestructor)(void)
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7435 );
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7436
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7437
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7438 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7439 ** A pointer to a structure of the following type is passed as the
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7440 ** argument to scored geometry callback registered using
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7441 ** sqlite3_rtree_query_callback().
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7442 **
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7443 ** Note that the first 5 fields of this structure are identical to
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7444 ** sqlite3_rtree_geometry. This structure is a subclass of
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7445 ** sqlite3_rtree_geometry.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7446 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7447 struct sqlite3_rtree_query_info {
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7448 void pContext; / pContext from when function registered */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7449 int nParam; /* Number of function parameters */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7450 sqlite3_rtree_dbl aParam; / value of function parameters */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7451 void pUser; / callback can use this, if desired */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7452 void (xDelUser)(void); /* function to free pUser */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7453 sqlite3_rtree_dbl aCoord; / Coordinates of node or entry to check */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7454 unsigned int anQueue; / Number of pending entries in the queue */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7455 int nCoord; /* Number of coordinates */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7456 int iLevel; /* Level of current node or entry */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7457 int mxLevel; /* The largest iLevel value in the tree */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7458 sqlite3_int64 iRowid; /* Rowid for current entry */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7459 sqlite3_rtree_dbl rParentScore; /* Score of parent node */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7460 int eParentWithin; /* Visibility of parent node */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7461 int eWithin; /* OUT: Visiblity */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7462 sqlite3_rtree_dbl rScore; /* OUT: Write the score here */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7463 };
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7464
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7465 /*
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7466 ** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin.
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7467 */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7468 #define NOT_WITHIN 0 /* Object completely outside of query region */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7469 #define PARTLY_WITHIN 1 /* Object partially overlaps query region */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7470 #define FULLY_WITHIN 2 /* Object fully contained within query region */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7471
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7472
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7473 #ifdef __cplusplus
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7474 } /* end of the 'extern "C"' block */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7475 #endif
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7476
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7477 #endif /* ifndef _SQLITE3RTREE_H_ */
1e5118fa0cb1 This is NSS with a Cmake Buildsyste Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7478

Mercurial > trustbridge > nss-cmake-static

annotate sqlite/sqlite3.h @ 0:1e5118fa0cb1