1.1 --- a/extensions/sqlite/sqlite-source/sqlite3.h Fri Aug 03 07:56:31 2012 -0400
1.2 +++ b/extensions/sqlite/sqlite-source/sqlite3.h Fri Aug 03 16:10:28 2012 -0400
1.3 @@ -17,9 +17,9 @@
1.4 **
1.5 ** Some of the definitions that are in this file are marked as
1.6 ** "experimental". Experimental interfaces are normally new
1.7 -** features recently added to SQLite. We do not anticipate changes
1.8 -** to experimental interfaces but reserve to make minor changes if
1.9 -** experience from use "in the wild" suggest such changes are prudent.
1.10 +** features recently added to SQLite. We do not anticipate changes
1.11 +** to experimental interfaces but reserve the right to make minor changes
1.12 +** if experience from use "in the wild" suggest such changes are prudent.
1.13 **
1.14 ** The official C-language API documentation for SQLite is derived
1.15 ** from comments in this file. This file is the authoritative source
1.16 @@ -29,8 +29,6 @@
1.17 ** The makefile makes some minor changes to this file (such as inserting
1.18 ** the version number) and changes its name to "sqlite3.h" as
1.19 ** part of the build process.
1.20 -**
1.21 -** @(#) $Id$
1.22 */
1.23 #ifndef _SQLITE3_H_
1.24 #define _SQLITE3_H_
1.25 @@ -51,9 +49,29 @@
1.26 # define SQLITE_EXTERN extern
1.27 #endif
1.28
1.29 -/*
1.30 -** Make sure these symbols where not defined by some previous header
1.31 -** file.
1.32 +#ifndef SQLITE_API
1.33 +# define SQLITE_API
1.34 +#endif
1.35 +
1.36 +
1.37 +/*
1.38 +** These no-op macros are used in front of interfaces to mark those
1.39 +** interfaces as either deprecated or experimental. New applications
1.40 +** should not use deprecated interfaces - they are support for backwards
1.41 +** compatibility only. Application writers should be aware that
1.42 +** experimental interfaces are subject to change in point releases.
1.43 +**
1.44 +** These macros used to resolve to various kinds of compiler magic that
1.45 +** would generate warning messages when they were used. But that
1.46 +** compiler magic ended up generating such a flurry of bug reports
1.47 +** that we have taken it all out and gone back to using simple
1.48 +** noop macros.
1.49 +*/
1.50 +#define SQLITE_DEPRECATED
1.51 +#define SQLITE_EXPERIMENTAL
1.52 +
1.53 +/*
1.54 +** Ensure these symbols were not defined by some previous header file.
1.55 */
1.56 #ifdef SQLITE_VERSION
1.57 # undef SQLITE_VERSION
1.58 @@ -65,100 +83,164 @@
1.59 /*
1.60 ** CAPI3REF: Compile-Time Library Version Numbers
1.61 **
1.62 -** The version of the SQLite library is contained in the sqlite3.h
1.63 -** header file in a #define named SQLITE_VERSION. The SQLITE_VERSION
1.64 -** macro resolves to a string constant.
1.65 -**
1.66 -** The format of the version string is "X.Y.Z", where
1.67 -** X is the major version number, Y is the minor version number and Z
1.68 -** is the release number. The X.Y.Z might be followed by "alpha" or "beta".
1.69 -** For example "3.1.1beta".
1.70 -**
1.71 -** The X value is always 3 in SQLite. The X value only changes when
1.72 -** backwards compatibility is broken and we intend to never break
1.73 -** backwards compatibility. The Y value only changes when
1.74 -** there are major feature enhancements that are forwards compatible
1.75 -** but not backwards compatible. The Z value is incremented with
1.76 -** each release but resets back to 0 when Y is incremented.
1.77 -**
1.78 -** The SQLITE_VERSION_NUMBER is an integer with the value
1.79 -** (X*1000000 + Y*1000 + Z). For example, for version "3.1.1beta",
1.80 -** SQLITE_VERSION_NUMBER is set to 3001001. To detect if they are using
1.81 -** version 3.1.1 or greater at compile time, programs may use the test
1.82 -** (SQLITE_VERSION_NUMBER>=3001001).
1.83 -**
1.84 -** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()].
1.85 -*/
1.86 -#define SQLITE_VERSION "3.5.1"
1.87 -#define SQLITE_VERSION_NUMBER 3005001
1.88 +** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
1.89 +** evaluates to a string literal that is the SQLite version in the
1.90 +** format "X.Y.Z" where X is the major version number (always 3 for
1.91 +** SQLite3) and Y is the minor version number and Z is the release number.)^
1.92 +** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
1.93 +** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
1.94 +** numbers used in [SQLITE_VERSION].)^
1.95 +** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
1.96 +** be larger than the release from which it is derived. Either Y will
1.97 +** be held constant and Z will be incremented or else Y will be incremented
1.98 +** and Z will be reset to zero.
1.99 +**
1.100 +** Since version 3.6.18, SQLite source code has been stored in the
1.101 +** <a href="http://www.fossil-scm.org/">Fossil configuration management
1.102 +** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
1.103 +** a string which identifies a particular check-in of SQLite
1.104 +** within its configuration management system. ^The SQLITE_SOURCE_ID
1.105 +** string contains the date and time of the check-in (UTC) and an SHA1
1.106 +** hash of the entire source tree.
1.107 +**
1.108 +** See also: [sqlite3_libversion()],
1.109 +** [sqlite3_libversion_number()], [sqlite3_sourceid()],
1.110 +** [sqlite_version()] and [sqlite_source_id()].
1.111 +*/
1.112 +#define SQLITE_VERSION "3.7.13"
1.113 +#define SQLITE_VERSION_NUMBER 3007013
1.114 +#define SQLITE_SOURCE_ID "2012-06-11 02:05:22 f5b5a13f7394dc143aa136f1d4faba6839eaa6dc"
1.115
1.116 /*
1.117 ** CAPI3REF: Run-Time Library Version Numbers
1.118 -**
1.119 -** These routines return values equivalent to the header constants
1.120 -** [SQLITE_VERSION] and [SQLITE_VERSION_NUMBER]. The values returned
1.121 -** by this routines should only be different from the header values
1.122 -** if you compile your program using an sqlite3.h header from a
1.123 -** different version of SQLite that the version of the library you
1.124 -** link against.
1.125 -**
1.126 -** The sqlite3_version[] string constant contains the text of the
1.127 -** [SQLITE_VERSION] string. The sqlite3_libversion() function returns
1.128 -** a poiner to the sqlite3_version[] string constant. The function
1.129 -** is provided for DLL users who can only access functions and not
1.130 -** constants within the DLL.
1.131 -*/
1.132 -SQLITE_EXTERN const char sqlite3_version[];
1.133 -const char *sqlite3_libversion(void);
1.134 -int sqlite3_libversion_number(void);
1.135 +** KEYWORDS: sqlite3_version, sqlite3_sourceid
1.136 +**
1.137 +** These interfaces provide the same information as the [SQLITE_VERSION],
1.138 +** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
1.139 +** but are associated with the library instead of the header file. ^(Cautious
1.140 +** programmers might include assert() statements in their application to
1.141 +** verify that values returned by these interfaces match the macros in
1.142 +** the header, and thus insure that the application is
1.143 +** compiled with matching library and header files.
1.144 +**
1.145 +** <blockquote><pre>
1.146 +** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
1.147 +** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
1.148 +** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
1.149 +** </pre></blockquote>)^
1.150 +**
1.151 +** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
1.152 +** macro. ^The sqlite3_libversion() function returns a pointer to the
1.153 +** to the sqlite3_version[] string constant. The sqlite3_libversion()
1.154 +** function is provided for use in DLLs since DLL users usually do not have
1.155 +** direct access to string constants within the DLL. ^The
1.156 +** sqlite3_libversion_number() function returns an integer equal to
1.157 +** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns
1.158 +** a pointer to a string constant whose value is the same as the
1.159 +** [SQLITE_SOURCE_ID] C preprocessor macro.
1.160 +**
1.161 +** See also: [sqlite_version()] and [sqlite_source_id()].
1.162 +*/
1.163 +SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
1.164 +SQLITE_API const char *sqlite3_libversion(void);
1.165 +SQLITE_API const char *sqlite3_sourceid(void);
1.166 +SQLITE_API int sqlite3_libversion_number(void);
1.167 +
1.168 +/*
1.169 +** CAPI3REF: Run-Time Library Compilation Options Diagnostics
1.170 +**
1.171 +** ^The sqlite3_compileoption_used() function returns 0 or 1
1.172 +** indicating whether the specified option was defined at
1.173 +** compile time. ^The SQLITE_ prefix may be omitted from the
1.174 +** option name passed to sqlite3_compileoption_used().
1.175 +**
1.176 +** ^The sqlite3_compileoption_get() function allows iterating
1.177 +** over the list of options that were defined at compile time by
1.178 +** returning the N-th compile time option string. ^If N is out of range,
1.179 +** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
1.180 +** prefix is omitted from any strings returned by
1.181 +** sqlite3_compileoption_get().
1.182 +**
1.183 +** ^Support for the diagnostic functions sqlite3_compileoption_used()
1.184 +** and sqlite3_compileoption_get() may be omitted by specifying the
1.185 +** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
1.186 +**
1.187 +** See also: SQL functions [sqlite_compileoption_used()] and
1.188 +** [sqlite_compileoption_get()] and the [compile_options pragma].
1.189 +*/
1.190 +#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
1.191 +SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
1.192 +SQLITE_API const char *sqlite3_compileoption_get(int N);
1.193 +#endif
1.194
1.195 /*
1.196 ** CAPI3REF: Test To See If The Library Is Threadsafe
1.197 **
1.198 -** This routine returns TRUE (nonzero) if SQLite was compiled with
1.199 -** all of its mutexes enabled and is thus threadsafe. It returns
1.200 -** zero if the particular build is for single-threaded operation
1.201 -** only.
1.202 -**
1.203 -** Really all this routine does is return true if SQLite was compiled
1.204 -** with the -DSQLITE_THREADSAFE=1 option and false if
1.205 -** compiled with -DSQLITE_THREADSAFE=0. If SQLite uses an
1.206 -** application-defined mutex subsystem, malloc subsystem, collating
1.207 -** sequence, VFS, SQL function, progress callback, commit hook,
1.208 -** extension, or other accessories and these add-ons are not
1.209 -** threadsafe, then clearly the combination will not be threadsafe
1.210 -** either. Hence, this routine never reports that the library
1.211 -** is guaranteed to be threadsafe, only when it is guaranteed not
1.212 -** to be.
1.213 -**
1.214 -** This is an experimental API and may go away or change in future
1.215 -** releases.
1.216 -*/
1.217 -int sqlite3_threadsafe(void);
1.218 +** ^The sqlite3_threadsafe() function returns zero if and only if
1.219 +** SQLite was compiled with mutexing code omitted due to the
1.220 +** [SQLITE_THREADSAFE] compile-time option being set to 0.
1.221 +**
1.222 +** SQLite can be compiled with or without mutexes. When
1.223 +** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
1.224 +** are enabled and SQLite is threadsafe. When the
1.225 +** [SQLITE_THREADSAFE] macro is 0,
1.226 +** the mutexes are omitted. Without the mutexes, it is not safe
1.227 +** to use SQLite concurrently from more than one thread.
1.228 +**
1.229 +** Enabling mutexes incurs a measurable performance penalty.
1.230 +** So if speed is of utmost importance, it makes sense to disable
1.231 +** the mutexes. But for maximum safety, mutexes should be enabled.
1.232 +** ^The default behavior is for mutexes to be enabled.
1.233 +**
1.234 +** This interface can be used by an application to make sure that the
1.235 +** version of SQLite that it is linking against was compiled with
1.236 +** the desired setting of the [SQLITE_THREADSAFE] macro.
1.237 +**
1.238 +** This interface only reports on the compile-time mutex setting
1.239 +** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
1.240 +** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
1.241 +** can be fully or partially disabled using a call to [sqlite3_config()]
1.242 +** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
1.243 +** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the
1.244 +** sqlite3_threadsafe() function shows only the compile-time setting of
1.245 +** thread safety, not any run-time changes to that setting made by
1.246 +** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
1.247 +** is unchanged by calls to sqlite3_config().)^
1.248 +**
1.249 +** See the [threading mode] documentation for additional information.
1.250 +*/
1.251 +SQLITE_API int sqlite3_threadsafe(void);
1.252
1.253 /*
1.254 ** CAPI3REF: Database Connection Handle
1.255 -**
1.256 -** Each open SQLite database is represented by pointer to an instance of the
1.257 -** opaque structure named "sqlite3". It is useful to think of an sqlite3
1.258 +** KEYWORDS: {database connection} {database connections}
1.259 +**
1.260 +** Each open SQLite database is represented by a pointer to an instance of
1.261 +** the opaque structure named "sqlite3". It is useful to think of an sqlite3
1.262 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
1.263 -** [sqlite3_open_v2()] interfaces are its constructors
1.264 -** and [sqlite3_close()] is its destructor. There are many other interfaces
1.265 -** (such as [sqlite3_prepare_v2()], [sqlite3_create_function()], and
1.266 -** [sqlite3_busy_timeout()] to name but three) that are methods on this
1.267 -** object.
1.268 +** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
1.269 +** is its destructor. There are many other interfaces (such as
1.270 +** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
1.271 +** [sqlite3_busy_timeout()] to name but three) that are methods on an
1.272 +** sqlite3 object.
1.273 */
1.274 typedef struct sqlite3 sqlite3;
1.275
1.276 -
1.277 /*
1.278 ** CAPI3REF: 64-Bit Integer Types
1.279 -**
1.280 -** Some compilers do not support the "long long" datatype. So we have
1.281 -** to do compiler-specific typedefs for 64-bit signed and unsigned integers.
1.282 -**
1.283 -** Many SQLite interface functions require a 64-bit integer arguments.
1.284 -** Those interfaces are declared using this typedef.
1.285 +** KEYWORDS: sqlite_int64 sqlite_uint64
1.286 +**
1.287 +** Because there is no cross-platform way to specify 64-bit integer types
1.288 +** SQLite includes typedefs for 64-bit signed and unsigned integers.
1.289 +**
1.290 +** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
1.291 +** The sqlite_int64 and sqlite_uint64 types are supported for backwards
1.292 +** compatibility only.
1.293 +**
1.294 +** ^The sqlite3_int64 and sqlite_int64 types can store integer values
1.295 +** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
1.296 +** sqlite3_uint64 and sqlite_uint64 types can store integer values
1.297 +** between 0 and +18446744073709551615 inclusive.
1.298 */
1.299 #ifdef SQLITE_INT64_TYPE
1.300 typedef SQLITE_INT64_TYPE sqlite_int64;
1.301 @@ -175,7 +257,7 @@
1.302
1.303 /*
1.304 ** If compiling for a processor that lacks floating point support,
1.305 -** substitute integer for floating-point
1.306 +** substitute integer for floating-point.
1.307 */
1.308 #ifdef SQLITE_OMIT_FLOATING_POINT
1.309 # define double sqlite3_int64
1.310 @@ -184,23 +266,28 @@
1.311 /*
1.312 ** CAPI3REF: Closing A Database Connection
1.313 **
1.314 -** Call this function with a pointer to a structure that was previously
1.315 -** returned from [sqlite3_open()], [sqlite3_open16()], or
1.316 -** [sqlite3_open_v2()] and the corresponding database will by
1.317 -** closed.
1.318 -**
1.319 -** All SQL statements prepared using [sqlite3_prepare_v2()] or
1.320 -** [sqlite3_prepare16_v2()] must be destroyed using [sqlite3_finalize()]
1.321 -** before this routine is called. Otherwise, SQLITE_BUSY is returned and the
1.322 -** database connection remains open.
1.323 -**
1.324 -** Passing this routine a database connection that has already been
1.325 -** closed results in undefined behavior. If other interfaces that
1.326 -** reference the same database connection are pending (either in the
1.327 -** same thread or in different threads) when this routine is called,
1.328 -** then the behavior is undefined and is almost certainly undesirable.
1.329 -*/
1.330 -int sqlite3_close(sqlite3 *);
1.331 +** ^The sqlite3_close() routine is the destructor for the [sqlite3] object.
1.332 +** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is
1.333 +** successfully destroyed and all associated resources are deallocated.
1.334 +**
1.335 +** Applications must [sqlite3_finalize | finalize] all [prepared statements]
1.336 +** and [sqlite3_blob_close | close] all [BLOB handles] associated with
1.337 +** the [sqlite3] object prior to attempting to close the object. ^If
1.338 +** sqlite3_close() is called on a [database connection] that still has
1.339 +** outstanding [prepared statements] or [BLOB handles], then it returns
1.340 +** SQLITE_BUSY.
1.341 +**
1.342 +** ^If [sqlite3_close()] is invoked while a transaction is open,
1.343 +** the transaction is automatically rolled back.
1.344 +**
1.345 +** The C parameter to [sqlite3_close(C)] must be either a NULL
1.346 +** pointer or an [sqlite3] object pointer obtained
1.347 +** from [sqlite3_open()], [sqlite3_open16()], or
1.348 +** [sqlite3_open_v2()], and not previously closed.
1.349 +** ^Calling sqlite3_close() with a NULL pointer argument is a
1.350 +** harmless no-op.
1.351 +*/
1.352 +SQLITE_API int sqlite3_close(sqlite3 *);
1.353
1.354 /*
1.355 ** The type for a callback function.
1.356 @@ -212,49 +299,67 @@
1.357 /*
1.358 ** CAPI3REF: One-Step Query Execution Interface
1.359 **
1.360 -** This interface is used to do a one-time evaluatation of zero
1.361 -** or more SQL statements. UTF-8 text of the SQL statements to
1.362 -** be evaluted is passed in as the second parameter. The statements
1.363 -** are prepared one by one using [sqlite3_prepare()], evaluated
1.364 -** using [sqlite3_step()], then destroyed using [sqlite3_finalize()].
1.365 -**
1.366 -** If one or more of the SQL statements are queries, then
1.367 -** the callback function specified by the 3rd parameter is
1.368 -** invoked once for each row of the query result. This callback
1.369 -** should normally return 0. If the callback returns a non-zero
1.370 -** value then the query is aborted, all subsequent SQL statements
1.371 -** are skipped and the sqlite3_exec() function returns the [SQLITE_ABORT].
1.372 -**
1.373 -** The 4th parameter to this interface is an arbitrary pointer that is
1.374 -** passed through to the callback function as its first parameter.
1.375 -**
1.376 -** The 2nd parameter to the callback function is the number of
1.377 -** columns in the query result. The 3rd parameter to the callback
1.378 -** is an array of strings holding the values for each column
1.379 -** as extracted using [sqlite3_column_text()].
1.380 -** The 4th parameter to the callback is an array of strings
1.381 -** obtained using [sqlite3_column_name()] and holding
1.382 -** the names of each column.
1.383 -**
1.384 -** The callback function may be NULL, even for queries. A NULL
1.385 -** callback is not an error. It just means that no callback
1.386 -** will be invoked.
1.387 -**
1.388 -** If an error occurs while parsing or evaluating the SQL (but
1.389 -** not while executing the callback) then an appropriate error
1.390 -** message is written into memory obtained from [sqlite3_malloc()] and
1.391 -** *errmsg is made to point to that message. The calling function
1.392 -** is responsible for freeing the memory using [sqlite3_free()].
1.393 -** If errmsg==NULL, then no error message is ever written.
1.394 -**
1.395 -** The return value is is SQLITE_OK if there are no errors and
1.396 -** some other [SQLITE_OK | return code] if there is an error.
1.397 -** The particular return value depends on the type of error.
1.398 -**
1.399 -*/
1.400 -int sqlite3_exec(
1.401 +** The sqlite3_exec() interface is a convenience wrapper around
1.402 +** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
1.403 +** that allows an application to run multiple statements of SQL
1.404 +** without having to use a lot of C code.
1.405 +**
1.406 +** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
1.407 +** semicolon-separate SQL statements passed into its 2nd argument,
1.408 +** in the context of the [database connection] passed in as its 1st
1.409 +** argument. ^If the callback function of the 3rd argument to
1.410 +** sqlite3_exec() is not NULL, then it is invoked for each result row
1.411 +** coming out of the evaluated SQL statements. ^The 4th argument to
1.412 +** sqlite3_exec() is relayed through to the 1st argument of each
1.413 +** callback invocation. ^If the callback pointer to sqlite3_exec()
1.414 +** is NULL, then no callback is ever invoked and result rows are
1.415 +** ignored.
1.416 +**
1.417 +** ^If an error occurs while evaluating the SQL statements passed into
1.418 +** sqlite3_exec(), then execution of the current statement stops and
1.419 +** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
1.420 +** is not NULL then any error message is written into memory obtained
1.421 +** from [sqlite3_malloc()] and passed back through the 5th parameter.
1.422 +** To avoid memory leaks, the application should invoke [sqlite3_free()]
1.423 +** on error message strings returned through the 5th parameter of
1.424 +** of sqlite3_exec() after the error message string is no longer needed.
1.425 +** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
1.426 +** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
1.427 +** NULL before returning.
1.428 +**
1.429 +** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
1.430 +** routine returns SQLITE_ABORT without invoking the callback again and
1.431 +** without running any subsequent SQL statements.
1.432 +**
1.433 +** ^The 2nd argument to the sqlite3_exec() callback function is the
1.434 +** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
1.435 +** callback is an array of pointers to strings obtained as if from
1.436 +** [sqlite3_column_text()], one for each column. ^If an element of a
1.437 +** result row is NULL then the corresponding string pointer for the
1.438 +** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
1.439 +** sqlite3_exec() callback is an array of pointers to strings where each
1.440 +** entry represents the name of corresponding result column as obtained
1.441 +** from [sqlite3_column_name()].
1.442 +**
1.443 +** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
1.444 +** to an empty string, or a pointer that contains only whitespace and/or
1.445 +** SQL comments, then no SQL statements are evaluated and the database
1.446 +** is not changed.
1.447 +**
1.448 +** Restrictions:
1.449 +**
1.450 +** <ul>
1.451 +** <li> The application must insure that the 1st parameter to sqlite3_exec()
1.452 +** is a valid and open [database connection].
1.453 +** <li> The application must not close [database connection] specified by
1.454 +** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
1.455 +** <li> The application must not modify the SQL statement text passed into
1.456 +** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
1.457 +** </ul>
1.458 +*/
1.459 +SQLITE_API int sqlite3_exec(
1.460 sqlite3*, /* An open database */
1.461 - const char *sql, /* SQL to be evaluted */
1.462 + const char *sql, /* SQL to be evaluated */
1.463 int (*callback)(void*,int,char**,char**), /* Callback function */
1.464 void *, /* 1st argument to callback */
1.465 char **errmsg /* Error msg written here */
1.466 @@ -262,23 +367,21 @@
1.467
1.468 /*
1.469 ** CAPI3REF: Result Codes
1.470 -** KEYWORDS: SQLITE_OK
1.471 +** KEYWORDS: SQLITE_OK {error code} {error codes}
1.472 +** KEYWORDS: {result code} {result codes}
1.473 **
1.474 ** Many SQLite functions return an integer result code from the set shown
1.475 -** above in order to indicates success or failure.
1.476 -**
1.477 -** The result codes above are the only ones returned by SQLite in its
1.478 -** default configuration. However, the [sqlite3_extended_result_codes()]
1.479 -** API can be used to set a database connectoin to return more detailed
1.480 -** result codes.
1.481 -**
1.482 -** See also: [SQLITE_IOERR_READ | extended result codes]
1.483 -**
1.484 +** here in order to indicate success or failure.
1.485 +**
1.486 +** New error codes may be added in future versions of SQLite.
1.487 +**
1.488 +** See also: [SQLITE_IOERR_READ | extended result codes],
1.489 +** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes].
1.490 */
1.491 #define SQLITE_OK 0 /* Successful result */
1.492 /* beginning-of-error-codes */
1.493 #define SQLITE_ERROR 1 /* SQL error or missing database */
1.494 -#define SQLITE_INTERNAL 2 /* NOT USED. Internal logic error in SQLite */
1.495 +#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
1.496 #define SQLITE_PERM 3 /* Access permission denied */
1.497 #define SQLITE_ABORT 4 /* Callback routine requested an abort */
1.498 #define SQLITE_BUSY 5 /* The database file is locked */
1.499 @@ -288,10 +391,10 @@
1.500 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
1.501 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
1.502 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
1.503 -#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
1.504 +#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
1.505 #define SQLITE_FULL 13 /* Insertion failed because database is full */
1.506 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
1.507 -#define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */
1.508 +#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
1.509 #define SQLITE_EMPTY 16 /* Database is empty */
1.510 #define SQLITE_SCHEMA 17 /* The database schema changed */
1.511 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
1.512 @@ -309,71 +412,93 @@
1.513
1.514 /*
1.515 ** CAPI3REF: Extended Result Codes
1.516 +** KEYWORDS: {extended error code} {extended error codes}
1.517 +** KEYWORDS: {extended result code} {extended result codes}
1.518 **
1.519 ** In its default configuration, SQLite API routines return one of 26 integer
1.520 -** result codes described at result-codes. However, experience has shown that
1.521 -** many of these result codes are too course-grained. They do not provide as
1.522 -** much information about problems as users might like. In an effort to
1.523 +** [SQLITE_OK | result codes]. However, experience has shown that many of
1.524 +** these result codes are too coarse-grained. They do not provide as
1.525 +** much information about problems as programmers might like. In an effort to
1.526 ** address this, newer versions of SQLite (version 3.3.8 and later) include
1.527 ** support for additional result codes that provide more detailed information
1.528 -** about errors. The extended result codes are enabled (or disabled) for
1.529 -** each database
1.530 -** connection using the [sqlite3_extended_result_codes()] API.
1.531 -**
1.532 -** Some of the available extended result codes are listed above.
1.533 -** We expect the number of extended result codes will be expand
1.534 +** about errors. The extended result codes are enabled or disabled
1.535 +** on a per database connection basis using the
1.536 +** [sqlite3_extended_result_codes()] API.
1.537 +**
1.538 +** Some of the available extended result codes are listed here.
1.539 +** One may expect the number of extended result codes will be expand
1.540 ** over time. Software that uses extended result codes should expect
1.541 ** to see new result codes in future releases of SQLite.
1.542 -**
1.543 -** The symbolic name for an extended result code always contains a related
1.544 -** primary result code as a prefix. Primary result codes contain a single
1.545 -** "_" character. Extended result codes contain two or more "_" characters.
1.546 -** The numeric value of an extended result code can be converted to its
1.547 -** corresponding primary result code by masking off the lower 8 bytes.
1.548 **
1.549 ** The SQLITE_OK result code will never be extended. It will always
1.550 ** be exactly zero.
1.551 */
1.552 -#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
1.553 -#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
1.554 -#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
1.555 -#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
1.556 -#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
1.557 -#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
1.558 -#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
1.559 -#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
1.560 -#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
1.561 -#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
1.562 -#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
1.563 -#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
1.564 +#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
1.565 +#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
1.566 +#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
1.567 +#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
1.568 +#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
1.569 +#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
1.570 +#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
1.571 +#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
1.572 +#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
1.573 +#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
1.574 +#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
1.575 +#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
1.576 +#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
1.577 +#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
1.578 +#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
1.579 +#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
1.580 +#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
1.581 +#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
1.582 +#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
1.583 +#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
1.584 +#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
1.585 +#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
1.586 +#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
1.587 +#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
1.588 +#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
1.589 +#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8))
1.590 +#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8))
1.591 +#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8))
1.592 +#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8))
1.593 +#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8))
1.594
1.595 /*
1.596 ** CAPI3REF: Flags For File Open Operations
1.597 **
1.598 -** Combination of the following bit values are used as the
1.599 -** third argument to the [sqlite3_open_v2()] interface and
1.600 -** as fourth argument to the xOpen method of the
1.601 -** [sqlite3_vfs] object.
1.602 -**
1.603 -*/
1.604 -#define SQLITE_OPEN_READONLY 0x00000001
1.605 -#define SQLITE_OPEN_READWRITE 0x00000002
1.606 -#define SQLITE_OPEN_CREATE 0x00000004
1.607 -#define SQLITE_OPEN_DELETEONCLOSE 0x00000008
1.608 -#define SQLITE_OPEN_EXCLUSIVE 0x00000010
1.609 -#define SQLITE_OPEN_MAIN_DB 0x00000100
1.610 -#define SQLITE_OPEN_TEMP_DB 0x00000200
1.611 -#define SQLITE_OPEN_TRANSIENT_DB 0x00000400
1.612 -#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800
1.613 -#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000
1.614 -#define SQLITE_OPEN_SUBJOURNAL 0x00002000
1.615 -#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000
1.616 +** These bit values are intended for use in the
1.617 +** 3rd parameter to the [sqlite3_open_v2()] interface and
1.618 +** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
1.619 +*/
1.620 +#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
1.621 +#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
1.622 +#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
1.623 +#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
1.624 +#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
1.625 +#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
1.626 +#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
1.627 +#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
1.628 +#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
1.629 +#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
1.630 +#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
1.631 +#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
1.632 +#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
1.633 +#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
1.634 +#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
1.635 +#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
1.636 +#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
1.637 +#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
1.638 +#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
1.639 +#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
1.640 +
1.641 +/* Reserved: 0x00F00000 */
1.642
1.643 /*
1.644 ** CAPI3REF: Device Characteristics
1.645 **
1.646 -** The xDeviceCapabilities method of the [sqlite3_io_methods]
1.647 -** object returns an integer which is a vector of the following
1.648 +** The xDeviceCharacteristics method of the [sqlite3_io_methods]
1.649 +** object returns an integer which is a vector of the these
1.650 ** bit values expressing I/O characteristics of the mass storage
1.651 ** device that holds the file that the [sqlite3_io_methods]
1.652 ** refers to.
1.653 @@ -387,24 +512,30 @@
1.654 ** first then the size of the file is extended, never the other
1.655 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
1.656 ** information is written to disk in the same order as calls
1.657 -** to xWrite().
1.658 -*/
1.659 -#define SQLITE_IOCAP_ATOMIC 0x00000001
1.660 -#define SQLITE_IOCAP_ATOMIC512 0x00000002
1.661 -#define SQLITE_IOCAP_ATOMIC1K 0x00000004
1.662 -#define SQLITE_IOCAP_ATOMIC2K 0x00000008
1.663 -#define SQLITE_IOCAP_ATOMIC4K 0x00000010
1.664 -#define SQLITE_IOCAP_ATOMIC8K 0x00000020
1.665 -#define SQLITE_IOCAP_ATOMIC16K 0x00000040
1.666 -#define SQLITE_IOCAP_ATOMIC32K 0x00000080
1.667 -#define SQLITE_IOCAP_ATOMIC64K 0x00000100
1.668 -#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
1.669 -#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
1.670 +** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
1.671 +** after reboot following a crash or power loss, the only bytes in a
1.672 +** file that were written at the application level might have changed
1.673 +** and that adjacent bytes, even bytes within the same sector are
1.674 +** guaranteed to be unchanged.
1.675 +*/
1.676 +#define SQLITE_IOCAP_ATOMIC 0x00000001
1.677 +#define SQLITE_IOCAP_ATOMIC512 0x00000002
1.678 +#define SQLITE_IOCAP_ATOMIC1K 0x00000004
1.679 +#define SQLITE_IOCAP_ATOMIC2K 0x00000008
1.680 +#define SQLITE_IOCAP_ATOMIC4K 0x00000010
1.681 +#define SQLITE_IOCAP_ATOMIC8K 0x00000020
1.682 +#define SQLITE_IOCAP_ATOMIC16K 0x00000040
1.683 +#define SQLITE_IOCAP_ATOMIC32K 0x00000080
1.684 +#define SQLITE_IOCAP_ATOMIC64K 0x00000100
1.685 +#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
1.686 +#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
1.687 +#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
1.688 +#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
1.689
1.690 /*
1.691 ** CAPI3REF: File Locking Levels
1.692 **
1.693 -** SQLite uses one of the following integer values as the second
1.694 +** SQLite uses one of these integer values as the second
1.695 ** argument to calls it makes to the xLock() and xUnlock() methods
1.696 ** of an [sqlite3_io_methods] object.
1.697 */
1.698 @@ -417,26 +548,39 @@
1.699 /*
1.700 ** CAPI3REF: Synchronization Type Flags
1.701 **
1.702 -** When SQLite invokes the xSync() method of an [sqlite3_io_methods]
1.703 -** object it uses a combination of the following integer values as
1.704 -** the second argument.
1.705 +** When SQLite invokes the xSync() method of an
1.706 +** [sqlite3_io_methods] object it uses a combination of
1.707 +** these integer values as the second argument.
1.708 **
1.709 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
1.710 ** sync operation only needs to flush data to mass storage. Inode
1.711 -** information need not be flushed. The SQLITE_SYNC_NORMAL means
1.712 -** to use normal fsync() semantics. The SQLITE_SYNC_FULL flag means
1.713 -** to use Mac OS-X style fullsync instead of fsync().
1.714 +** information need not be flushed. If the lower four bits of the flag
1.715 +** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
1.716 +** If the lower four bits equal SQLITE_SYNC_FULL, that means
1.717 +** to use Mac OS X style fullsync instead of fsync().
1.718 +**
1.719 +** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
1.720 +** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
1.721 +** settings. The [synchronous pragma] determines when calls to the
1.722 +** xSync VFS method occur and applies uniformly across all platforms.
1.723 +** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
1.724 +** energetic or rigorous or forceful the sync operations are and
1.725 +** only make a difference on Mac OSX for the default SQLite code.
1.726 +** (Third-party VFS implementations might also make the distinction
1.727 +** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
1.728 +** operating systems natively supported by SQLite, only Mac OSX
1.729 +** cares about the difference.)
1.730 */
1.731 #define SQLITE_SYNC_NORMAL 0x00002
1.732 #define SQLITE_SYNC_FULL 0x00003
1.733 #define SQLITE_SYNC_DATAONLY 0x00010
1.734
1.735 -
1.736 /*
1.737 ** CAPI3REF: OS Interface Open File Handle
1.738 **
1.739 -** An [sqlite3_file] object represents an open file in the OS
1.740 -** interface layer. Individual OS interface implementations will
1.741 +** An [sqlite3_file] object represents an open file in the
1.742 +** [sqlite3_vfs | OS interface layer]. Individual OS interface
1.743 +** implementations will
1.744 ** want to subclass this object by appending additional fields
1.745 ** for their own use. The pMethods entry is a pointer to an
1.746 ** [sqlite3_io_methods] object that defines methods for performing
1.747 @@ -450,17 +594,25 @@
1.748 /*
1.749 ** CAPI3REF: OS Interface File Virtual Methods Object
1.750 **
1.751 -** Every file opened by the [sqlite3_vfs] xOpen method contains a pointer to
1.752 -** an instance of the this object. This object defines the
1.753 -** methods used to perform various operations against the open file.
1.754 +** Every file opened by the [sqlite3_vfs.xOpen] method populates an
1.755 +** [sqlite3_file] object (or, more commonly, a subclass of the
1.756 +** [sqlite3_file] object) with a pointer to an instance of this object.
1.757 +** This object defines the methods used to perform various operations
1.758 +** against the open file represented by the [sqlite3_file] object.
1.759 +**
1.760 +** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
1.761 +** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
1.762 +** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
1.763 +** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
1.764 +** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
1.765 +** to NULL.
1.766 **
1.767 ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
1.768 ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
1.769 -* The second choice is an
1.770 -** OS-X style fullsync. The SQLITE_SYNC_DATA flag may be ORed in to
1.771 -** indicate that only the data of the file and not its inode needs to be
1.772 -** synced.
1.773 -**
1.774 +** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
1.775 +** flag may be ORed in to indicate that only the data of the file
1.776 +** and not its inode needs to be synced.
1.777 +**
1.778 ** The integer values to xLock() and xUnlock() are one of
1.779 ** <ul>
1.780 ** <li> [SQLITE_LOCK_NONE],
1.781 @@ -469,27 +621,27 @@
1.782 ** <li> [SQLITE_LOCK_PENDING], or
1.783 ** <li> [SQLITE_LOCK_EXCLUSIVE].
1.784 ** </ul>
1.785 -** xLock() increases the lock. xUnlock() decreases the lock.
1.786 -** The xCheckReservedLock() method looks
1.787 -** to see if any database connection, either in this
1.788 -** process or in some other process, is holding an RESERVED,
1.789 +** xLock() increases the lock. xUnlock() decreases the lock.
1.790 +** The xCheckReservedLock() method checks whether any database connection,
1.791 +** either in this process or in some other process, is holding a RESERVED,
1.792 ** PENDING, or EXCLUSIVE lock on the file. It returns true
1.793 -** if such a lock exists and false if not.
1.794 -**
1.795 +** if such a lock exists and false otherwise.
1.796 +**
1.797 ** The xFileControl() method is a generic interface that allows custom
1.798 ** VFS implementations to directly control an open file using the
1.799 -** [sqlite3_file_control()] interface. The second "op" argument
1.800 -** is an integer opcode. The third
1.801 -** argument is a generic pointer which is intended to be a pointer
1.802 -** to a structure that may contain arguments or space in which to
1.803 +** [sqlite3_file_control()] interface. The second "op" argument is an
1.804 +** integer opcode. The third argument is a generic pointer intended to
1.805 +** point to a structure that may contain arguments or space in which to
1.806 ** write return values. Potential uses for xFileControl() might be
1.807 ** functions to enable blocking locks with timeouts, to change the
1.808 ** locking strategy (for example to use dot-file locks), to inquire
1.809 ** about the status of a lock, or to break stale locks. The SQLite
1.810 -** core reserves opcodes less than 100 for its own use.
1.811 +** core reserves all opcodes less than 100 for its own use.
1.812 ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
1.813 -** Applications that define a custom xFileControl method should use opcodes
1.814 -** greater than 100 to avoid conflicts.
1.815 +** Applications that define a custom xFileControl method should use opcodes
1.816 +** greater than 100 to avoid conflicts. VFS implementations should
1.817 +** return [SQLITE_NOTFOUND] for file control opcodes that they do not
1.818 +** recognize.
1.819 **
1.820 ** The xSectorSize() method returns the sector size of the
1.821 ** device that underlies the file. The sector size is the
1.822 @@ -522,6 +674,12 @@
1.823 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
1.824 ** information is written to disk in the same order as calls
1.825 ** to xWrite().
1.826 +**
1.827 +** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
1.828 +** in the unread portions of the buffer with zeros. A VFS that
1.829 +** fails to zero-fill short reads might seem to work. However,
1.830 +** failure to zero-fill short reads will eventually lead to
1.831 +** database corruption.
1.832 */
1.833 typedef struct sqlite3_io_methods sqlite3_io_methods;
1.834 struct sqlite3_io_methods {
1.835 @@ -534,10 +692,16 @@
1.836 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
1.837 int (*xLock)(sqlite3_file*, int);
1.838 int (*xUnlock)(sqlite3_file*, int);
1.839 - int (*xCheckReservedLock)(sqlite3_file*);
1.840 + int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
1.841 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
1.842 int (*xSectorSize)(sqlite3_file*);
1.843 int (*xDeviceCharacteristics)(sqlite3_file*);
1.844 + /* Methods above are valid for version 1 */
1.845 + int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
1.846 + int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
1.847 + void (*xShmBarrier)(sqlite3_file*);
1.848 + int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
1.849 + /* Methods above are valid for version 2 */
1.850 /* Additional methods may be added in future releases */
1.851 };
1.852
1.853 @@ -545,18 +709,149 @@
1.854 ** CAPI3REF: Standard File Control Opcodes
1.855 **
1.856 ** These integer constants are opcodes for the xFileControl method
1.857 -** of the [sqlite3_io_methods] object and to the [sqlite3_file_control()]
1.858 +** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
1.859 ** interface.
1.860 **
1.861 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
1.862 -** opcode cases the xFileControl method to write the current state of
1.863 +** opcode causes the xFileControl method to write the current state of
1.864 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
1.865 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
1.866 -** into an integer that the pArg argument points to. This capability
1.867 +** into an integer that the pArg argument points to. This capability
1.868 ** is used during testing and only needs to be supported when SQLITE_TEST
1.869 ** is defined.
1.870 -*/
1.871 -#define SQLITE_FCNTL_LOCKSTATE 1
1.872 +** <ul>
1.873 +** <li>[[SQLITE_FCNTL_SIZE_HINT]]
1.874 +** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
1.875 +** layer a hint of how large the database file will grow to be during the
1.876 +** current transaction. This hint is not guaranteed to be accurate but it
1.877 +** is often close. The underlying VFS might choose to preallocate database
1.878 +** file space based on this hint in order to help writes to the database
1.879 +** file run faster.
1.880 +**
1.881 +** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
1.882 +** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
1.883 +** extends and truncates the database file in chunks of a size specified
1.884 +** by the user. The fourth argument to [sqlite3_file_control()] should
1.885 +** point to an integer (type int) containing the new chunk-size to use
1.886 +** for the nominated database. Allocating database file space in large
1.887 +** chunks (say 1MB at a time), may reduce file-system fragmentation and
1.888 +** improve performance on some systems.
1.889 +**
1.890 +** <li>[[SQLITE_FCNTL_FILE_POINTER]]
1.891 +** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
1.892 +** to the [sqlite3_file] object associated with a particular database
1.893 +** connection. See the [sqlite3_file_control()] documentation for
1.894 +** additional information.
1.895 +**
1.896 +** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
1.897 +** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by
1.898 +** SQLite and sent to all VFSes in place of a call to the xSync method
1.899 +** when the database connection has [PRAGMA synchronous] set to OFF.)^
1.900 +** Some specialized VFSes need this signal in order to operate correctly
1.901 +** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most
1.902 +** VFSes do not need this signal and should silently ignore this opcode.
1.903 +** Applications should not call [sqlite3_file_control()] with this
1.904 +** opcode as doing so may disrupt the operation of the specialized VFSes
1.905 +** that do require it.
1.906 +**
1.907 +** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
1.908 +** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
1.909 +** retry counts and intervals for certain disk I/O operations for the
1.910 +** windows [VFS] in order to provide robustness in the presence of
1.911 +** anti-virus programs. By default, the windows VFS will retry file read,
1.912 +** file write, and file delete operations up to 10 times, with a delay
1.913 +** of 25 milliseconds before the first retry and with the delay increasing
1.914 +** by an additional 25 milliseconds with each subsequent retry. This
1.915 +** opcode allows these two values (10 retries and 25 milliseconds of delay)
1.916 +** to be adjusted. The values are changed for all database connections
1.917 +** within the same process. The argument is a pointer to an array of two
1.918 +** integers where the first integer i the new retry count and the second
1.919 +** integer is the delay. If either integer is negative, then the setting
1.920 +** is not changed but instead the prior value of that setting is written
1.921 +** into the array entry, allowing the current retry settings to be
1.922 +** interrogated. The zDbName parameter is ignored.
1.923 +**
1.924 +** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
1.925 +** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
1.926 +** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
1.927 +** write ahead log and shared memory files used for transaction control
1.928 +** are automatically deleted when the latest connection to the database
1.929 +** closes. Setting persistent WAL mode causes those files to persist after
1.930 +** close. Persisting the files is useful when other processes that do not
1.931 +** have write permission on the directory containing the database file want
1.932 +** to read the database file, as the WAL and shared memory files must exist
1.933 +** in order for the database to be readable. The fourth parameter to
1.934 +** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1.935 +** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
1.936 +** WAL mode. If the integer is -1, then it is overwritten with the current
1.937 +** WAL persistence setting.
1.938 +**
1.939 +** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
1.940 +** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
1.941 +** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
1.942 +** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
1.943 +** xDeviceCharacteristics methods. The fourth parameter to
1.944 +** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1.945 +** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
1.946 +** mode. If the integer is -1, then it is overwritten with the current
1.947 +** zero-damage mode setting.
1.948 +**
1.949 +** <li>[[SQLITE_FCNTL_OVERWRITE]]
1.950 +** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
1.951 +** a write transaction to indicate that, unless it is rolled back for some
1.952 +** reason, the entire database file will be overwritten by the current
1.953 +** transaction. This is used by VACUUM operations.
1.954 +**
1.955 +** <li>[[SQLITE_FCNTL_VFSNAME]]
1.956 +** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
1.957 +** all [VFSes] in the VFS stack. The names are of all VFS shims and the
1.958 +** final bottom-level VFS are written into memory obtained from
1.959 +** [sqlite3_malloc()] and the result is stored in the char* variable
1.960 +** that the fourth parameter of [sqlite3_file_control()] points to.
1.961 +** The caller is responsible for freeing the memory when done. As with
1.962 +** all file-control actions, there is no guarantee that this will actually
1.963 +** do anything. Callers should initialize the char* variable to a NULL
1.964 +** pointer in case this file-control is not implemented. This file-control
1.965 +** is intended for diagnostic use only.
1.966 +**
1.967 +** <li>[[SQLITE_FCNTL_PRAGMA]]
1.968 +** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
1.969 +** file control is sent to the open [sqlite3_file] object corresponding
1.970 +** to the database file to which the pragma statement refers. ^The argument
1.971 +** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
1.972 +** pointers to strings (char**) in which the second element of the array
1.973 +** is the name of the pragma and the third element is the argument to the
1.974 +** pragma or NULL if the pragma has no argument. ^The handler for an
1.975 +** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
1.976 +** of the char** argument point to a string obtained from [sqlite3_mprintf()]
1.977 +** or the equivalent and that string will become the result of the pragma or
1.978 +** the error message if the pragma fails. ^If the
1.979 +** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
1.980 +** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
1.981 +** file control returns [SQLITE_OK], then the parser assumes that the
1.982 +** VFS has handled the PRAGMA itself and the parser generates a no-op
1.983 +** prepared statement. ^If the [SQLITE_FCNTL_PRAGMA] file control returns
1.984 +** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
1.985 +** that the VFS encountered an error while handling the [PRAGMA] and the
1.986 +** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
1.987 +** file control occurs at the beginning of pragma statement analysis and so
1.988 +** it is able to override built-in [PRAGMA] statements.
1.989 +** </ul>
1.990 +*/
1.991 +#define SQLITE_FCNTL_LOCKSTATE 1
1.992 +#define SQLITE_GET_LOCKPROXYFILE 2
1.993 +#define SQLITE_SET_LOCKPROXYFILE 3
1.994 +#define SQLITE_LAST_ERRNO 4
1.995 +#define SQLITE_FCNTL_SIZE_HINT 5
1.996 +#define SQLITE_FCNTL_CHUNK_SIZE 6
1.997 +#define SQLITE_FCNTL_FILE_POINTER 7
1.998 +#define SQLITE_FCNTL_SYNC_OMITTED 8
1.999 +#define SQLITE_FCNTL_WIN32_AV_RETRY 9
1.1000 +#define SQLITE_FCNTL_PERSIST_WAL 10
1.1001 +#define SQLITE_FCNTL_OVERWRITE 11
1.1002 +#define SQLITE_FCNTL_VFSNAME 12
1.1003 +#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
1.1004 +#define SQLITE_FCNTL_PRAGMA 14
1.1005
1.1006 /*
1.1007 ** CAPI3REF: Mutex Handle
1.1008 @@ -573,25 +868,30 @@
1.1009 /*
1.1010 ** CAPI3REF: OS Interface Object
1.1011 **
1.1012 -** An instance of this object defines the interface between the
1.1013 -** SQLite core and the underlying operating system. The "vfs"
1.1014 -** in the name of the object stands for "virtual file system".
1.1015 -**
1.1016 -** The iVersion field is initially 1 but may be larger for future
1.1017 -** versions of SQLite. Additional fields may be appended to this
1.1018 -** object when the iVersion value is increased.
1.1019 +** An instance of the sqlite3_vfs object defines the interface between
1.1020 +** the SQLite core and the underlying operating system. The "vfs"
1.1021 +** in the name of the object stands for "virtual file system". See
1.1022 +** the [VFS | VFS documentation] for further information.
1.1023 +**
1.1024 +** The value of the iVersion field is initially 1 but may be larger in
1.1025 +** future versions of SQLite. Additional fields may be appended to this
1.1026 +** object when the iVersion value is increased. Note that the structure
1.1027 +** of the sqlite3_vfs object changes in the transaction between
1.1028 +** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
1.1029 +** modified.
1.1030 **
1.1031 ** The szOsFile field is the size of the subclassed [sqlite3_file]
1.1032 ** structure used by this VFS. mxPathname is the maximum length of
1.1033 ** a pathname in this VFS.
1.1034 **
1.1035 -** Registered vfs modules are kept on a linked list formed by
1.1036 +** Registered sqlite3_vfs objects are kept on a linked list formed by
1.1037 ** the pNext pointer. The [sqlite3_vfs_register()]
1.1038 ** and [sqlite3_vfs_unregister()] interfaces manage this list
1.1039 ** in a thread-safe way. The [sqlite3_vfs_find()] interface
1.1040 -** searches the list.
1.1041 -**
1.1042 -** The pNext field is the only fields in the sqlite3_vfs
1.1043 +** searches the list. Neither the application code nor the VFS
1.1044 +** implementation should use the pNext pointer.
1.1045 +**
1.1046 +** The pNext field is the only field in the sqlite3_vfs
1.1047 ** structure that SQLite will ever modify. SQLite will only access
1.1048 ** or modify this field while holding a particular static mutex.
1.1049 ** The application should never modify anything within the sqlite3_vfs
1.1050 @@ -600,22 +900,33 @@
1.1051 ** The zName field holds the name of the VFS module. The name must
1.1052 ** be unique across all VFS modules.
1.1053 **
1.1054 -** SQLite will guarantee that the zFilename string passed to
1.1055 -** xOpen() is a full pathname as generated by xFullPathname() and
1.1056 -** that the string will be valid and unchanged until xClose() is
1.1057 -** called. So the [sqlite3_file] can store a pointer to the
1.1058 +** [[sqlite3_vfs.xOpen]]
1.1059 +** ^SQLite guarantees that the zFilename parameter to xOpen
1.1060 +** is either a NULL pointer or string obtained
1.1061 +** from xFullPathname() with an optional suffix added.
1.1062 +** ^If a suffix is added to the zFilename parameter, it will
1.1063 +** consist of a single "-" character followed by no more than
1.1064 +** 11 alphanumeric and/or "-" characters.
1.1065 +** ^SQLite further guarantees that
1.1066 +** the string will be valid and unchanged until xClose() is
1.1067 +** called. Because of the previous sentence,
1.1068 +** the [sqlite3_file] can safely store a pointer to the
1.1069 ** filename if it needs to remember the filename for some reason.
1.1070 -**
1.1071 -** The flags argument to xOpen() is a copy of the flags argument
1.1072 -** to [sqlite3_open_v2()]. If [sqlite3_open()] or [sqlite3_open16()]
1.1073 -** is used, then flags is [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
1.1074 +** If the zFilename parameter to xOpen is a NULL pointer then xOpen
1.1075 +** must invent its own temporary name for the file. ^Whenever the
1.1076 +** xFilename parameter is NULL it will also be the case that the
1.1077 +** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
1.1078 +**
1.1079 +** The flags argument to xOpen() includes all bits set in
1.1080 +** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
1.1081 +** or [sqlite3_open16()] is used, then flags includes at least
1.1082 +** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
1.1083 ** If xOpen() opens a file read-only then it sets *pOutFlags to
1.1084 -** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be
1.1085 -** set.
1.1086 -**
1.1087 -** SQLite will also add one of the following flags to the xOpen()
1.1088 +** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
1.1089 +**
1.1090 +** ^(SQLite will also add one of the following flags to the xOpen()
1.1091 ** call, depending on the object being opened:
1.1092 -**
1.1093 +**
1.1094 ** <ul>
1.1095 ** <li> [SQLITE_OPEN_MAIN_DB]
1.1096 ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
1.1097 @@ -624,66 +935,97 @@
1.1098 ** <li> [SQLITE_OPEN_TRANSIENT_DB]
1.1099 ** <li> [SQLITE_OPEN_SUBJOURNAL]
1.1100 ** <li> [SQLITE_OPEN_MASTER_JOURNAL]
1.1101 -** </ul>
1.1102 +** <li> [SQLITE_OPEN_WAL]
1.1103 +** </ul>)^
1.1104 **
1.1105 ** The file I/O implementation can use the object type flags to
1.1106 -** changes the way it deals with files. For example, an application
1.1107 -** that does not care about crash recovery or rollback, might make
1.1108 -** the open of a journal file a no-op. Writes to this journal are
1.1109 -** also a no-op. Any attempt to read the journal return SQLITE_IOERR.
1.1110 -** Or the implementation might recognize the a database file will
1.1111 -** be doing page-aligned sector reads and writes in a random order
1.1112 -** and set up its I/O subsystem accordingly.
1.1113 -**
1.1114 -** SQLite might also add one of the following flags to the xOpen
1.1115 -** method:
1.1116 -**
1.1117 +** change the way it deals with files. For example, an application
1.1118 +** that does not care about crash recovery or rollback might make
1.1119 +** the open of a journal file a no-op. Writes to this journal would
1.1120 +** also be no-ops, and any attempt to read the journal would return
1.1121 +** SQLITE_IOERR. Or the implementation might recognize that a database
1.1122 +** file will be doing page-aligned sector reads and writes in a random
1.1123 +** order and set up its I/O subsystem accordingly.
1.1124 +**
1.1125 +** SQLite might also add one of the following flags to the xOpen method:
1.1126 +**
1.1127 ** <ul>
1.1128 ** <li> [SQLITE_OPEN_DELETEONCLOSE]
1.1129 ** <li> [SQLITE_OPEN_EXCLUSIVE]
1.1130 ** </ul>
1.1131 -**
1.1132 +**
1.1133 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
1.1134 -** deleted when it is closed. This will always be set for TEMP
1.1135 -** databases and journals and for subjournals. The
1.1136 -** [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened
1.1137 -** for exclusive access. This flag is set for all files except
1.1138 -** for the main database file.
1.1139 -**
1.1140 -** Space to hold the [sqlite3_file] structure passed as the third
1.1141 -** argument to xOpen is allocated by caller (the SQLite core).
1.1142 -** szOsFile bytes are allocated for this object. The xOpen method
1.1143 -** fills in the allocated space.
1.1144 -**
1.1145 -** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
1.1146 -** to test for the existance of a file,
1.1147 -** or [SQLITE_ACCESS_READWRITE] to test to see
1.1148 -** if a file is readable and writable, or [SQLITE_ACCESS_READ]
1.1149 -** to test to see if a file is at least readable. The file can be a
1.1150 +** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
1.1151 +** will be set for TEMP databases and their journals, transient
1.1152 +** databases, and subjournals.
1.1153 +**
1.1154 +** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
1.1155 +** with the [SQLITE_OPEN_CREATE] flag, which are both directly
1.1156 +** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
1.1157 +** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
1.1158 +** SQLITE_OPEN_CREATE, is used to indicate that file should always
1.1159 +** be created, and that it is an error if it already exists.
1.1160 +** It is <i>not</i> used to indicate the file should be opened
1.1161 +** for exclusive access.
1.1162 +**
1.1163 +** ^At least szOsFile bytes of memory are allocated by SQLite
1.1164 +** to hold the [sqlite3_file] structure passed as the third
1.1165 +** argument to xOpen. The xOpen method does not have to
1.1166 +** allocate the structure; it should just fill it in. Note that
1.1167 +** the xOpen method must set the sqlite3_file.pMethods to either
1.1168 +** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
1.1169 +** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
1.1170 +** element will be valid after xOpen returns regardless of the success
1.1171 +** or failure of the xOpen call.
1.1172 +**
1.1173 +** [[sqlite3_vfs.xAccess]]
1.1174 +** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
1.1175 +** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
1.1176 +** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
1.1177 +** to test whether a file is at least readable. The file can be a
1.1178 ** directory.
1.1179 -**
1.1180 -** SQLite will always allocate at least mxPathname+1 byte for
1.1181 -** the output buffers for xGetTempname and xFullPathname. The exact
1.1182 -** size of the output buffer is also passed as a parameter to both
1.1183 -** methods. If the output buffer is not large enough, SQLITE_CANTOPEN
1.1184 -** should be returned. As this is handled as a fatal error by SQLite,
1.1185 -** vfs implementations should endevour to prevent this by setting
1.1186 -** mxPathname to a sufficiently large value.
1.1187 -**
1.1188 -** The xRandomness(), xSleep(), and xCurrentTime() interfaces
1.1189 -** are not strictly a part of the filesystem, but they are
1.1190 +**
1.1191 +** ^SQLite will always allocate at least mxPathname+1 bytes for the
1.1192 +** output buffer xFullPathname. The exact size of the output buffer
1.1193 +** is also passed as a parameter to both methods. If the output buffer
1.1194 +** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
1.1195 +** handled as a fatal error by SQLite, vfs implementations should endeavor
1.1196 +** to prevent this by setting mxPathname to a sufficiently large value.
1.1197 +**
1.1198 +** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
1.1199 +** interfaces are not strictly a part of the filesystem, but they are
1.1200 ** included in the VFS structure for completeness.
1.1201 ** The xRandomness() function attempts to return nBytes bytes
1.1202 ** of good-quality randomness into zOut. The return value is
1.1203 -** the actual number of bytes of randomness obtained. The
1.1204 -** xSleep() method cause the calling thread to sleep for at
1.1205 -** least the number of microseconds given. The xCurrentTime()
1.1206 -** method returns a Julian Day Number for the current date and
1.1207 -** time.
1.1208 +** the actual number of bytes of randomness obtained.
1.1209 +** The xSleep() method causes the calling thread to sleep for at
1.1210 +** least the number of microseconds given. ^The xCurrentTime()
1.1211 +** method returns a Julian Day Number for the current date and time as
1.1212 +** a floating point value.
1.1213 +** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
1.1214 +** Day Number multiplied by 86400000 (the number of milliseconds in
1.1215 +** a 24-hour day).
1.1216 +** ^SQLite will use the xCurrentTimeInt64() method to get the current
1.1217 +** date and time if that method is available (if iVersion is 2 or
1.1218 +** greater and the function pointer is not NULL) and will fall back
1.1219 +** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
1.1220 +**
1.1221 +** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
1.1222 +** are not used by the SQLite core. These optional interfaces are provided
1.1223 +** by some VFSes to facilitate testing of the VFS code. By overriding
1.1224 +** system calls with functions under its control, a test program can
1.1225 +** simulate faults and error conditions that would otherwise be difficult
1.1226 +** or impossible to induce. The set of system calls that can be overridden
1.1227 +** varies from one VFS to another, and from one version of the same VFS to the
1.1228 +** next. Applications that use these interfaces must be prepared for any
1.1229 +** or all of these interfaces to be NULL or for their behavior to change
1.1230 +** from one release to the next. Applications must not attempt to access
1.1231 +** any of these methods if the iVersion of the VFS is less than 3.
1.1232 */
1.1233 typedef struct sqlite3_vfs sqlite3_vfs;
1.1234 +typedef void (*sqlite3_syscall_ptr)(void);
1.1235 struct sqlite3_vfs {
1.1236 - int iVersion; /* Structure version number */
1.1237 + int iVersion; /* Structure version number (currently 3) */
1.1238 int szOsFile; /* Size of subclassed sqlite3_file */
1.1239 int mxPathname; /* Maximum file pathname length */
1.1240 sqlite3_vfs *pNext; /* Next registered VFS */
1.1241 @@ -692,18 +1034,33 @@
1.1242 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
1.1243 int flags, int *pOutFlags);
1.1244 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
1.1245 - int (*xAccess)(sqlite3_vfs*, const char *zName, int flags);
1.1246 - int (*xGetTempname)(sqlite3_vfs*, int nOut, char *zOut);
1.1247 + int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
1.1248 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
1.1249 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
1.1250 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
1.1251 - void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol);
1.1252 + void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
1.1253 void (*xDlClose)(sqlite3_vfs*, void*);
1.1254 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
1.1255 int (*xSleep)(sqlite3_vfs*, int microseconds);
1.1256 int (*xCurrentTime)(sqlite3_vfs*, double*);
1.1257 - /* New fields may be appended in figure versions. The iVersion
1.1258 - ** value will increment whenever this happens. */
1.1259 + int (*xGetLastError)(sqlite3_vfs*, int, char *);
1.1260 + /*
1.1261 + ** The methods above are in version 1 of the sqlite_vfs object
1.1262 + ** definition. Those that follow are added in version 2 or later
1.1263 + */
1.1264 + int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
1.1265 + /*
1.1266 + ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
1.1267 + ** Those below are for version 3 and greater.
1.1268 + */
1.1269 + int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
1.1270 + sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
1.1271 + const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
1.1272 + /*
1.1273 + ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
1.1274 + ** New fields may be appended in figure versions. The iVersion
1.1275 + ** value will increment whenever this happens.
1.1276 + */
1.1277 };
1.1278
1.1279 /*
1.1280 @@ -711,189 +1068,812 @@
1.1281 **
1.1282 ** These integer constants can be used as the third parameter to
1.1283 ** the xAccess method of an [sqlite3_vfs] object. They determine
1.1284 -** the kind of what kind of permissions the xAccess method is
1.1285 -** looking for. With SQLITE_ACCESS_EXISTS, the xAccess method
1.1286 -** simply checks to see if the file exists. With SQLITE_ACCESS_READWRITE,
1.1287 -** the xAccess method checks to see if the file is both readable
1.1288 -** and writable. With SQLITE_ACCESS_READ the xAccess method
1.1289 -** checks to see if the file is readable.
1.1290 +** what kind of permissions the xAccess method is looking for.
1.1291 +** With SQLITE_ACCESS_EXISTS, the xAccess method
1.1292 +** simply checks whether the file exists.
1.1293 +** With SQLITE_ACCESS_READWRITE, the xAccess method
1.1294 +** checks whether the named directory is both readable and writable
1.1295 +** (in other words, if files can be added, removed, and renamed within
1.1296 +** the directory).
1.1297 +** The SQLITE_ACCESS_READWRITE constant is currently used only by the
1.1298 +** [temp_store_directory pragma], though this could change in a future
1.1299 +** release of SQLite.
1.1300 +** With SQLITE_ACCESS_READ, the xAccess method
1.1301 +** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
1.1302 +** currently unused, though it might be used in a future release of
1.1303 +** SQLite.
1.1304 */
1.1305 #define SQLITE_ACCESS_EXISTS 0
1.1306 -#define SQLITE_ACCESS_READWRITE 1
1.1307 -#define SQLITE_ACCESS_READ 2
1.1308 +#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
1.1309 +#define SQLITE_ACCESS_READ 2 /* Unused */
1.1310 +
1.1311 +/*
1.1312 +** CAPI3REF: Flags for the xShmLock VFS method
1.1313 +**
1.1314 +** These integer constants define the various locking operations
1.1315 +** allowed by the xShmLock method of [sqlite3_io_methods]. The
1.1316 +** following are the only legal combinations of flags to the
1.1317 +** xShmLock method:
1.1318 +**
1.1319 +** <ul>
1.1320 +** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
1.1321 +** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
1.1322 +** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
1.1323 +** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
1.1324 +** </ul>
1.1325 +**
1.1326 +** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
1.1327 +** was given no the corresponding lock.
1.1328 +**
1.1329 +** The xShmLock method can transition between unlocked and SHARED or
1.1330 +** between unlocked and EXCLUSIVE. It cannot transition between SHARED
1.1331 +** and EXCLUSIVE.
1.1332 +*/
1.1333 +#define SQLITE_SHM_UNLOCK 1
1.1334 +#define SQLITE_SHM_LOCK 2
1.1335 +#define SQLITE_SHM_SHARED 4
1.1336 +#define SQLITE_SHM_EXCLUSIVE 8
1.1337 +
1.1338 +/*
1.1339 +** CAPI3REF: Maximum xShmLock index
1.1340 +**
1.1341 +** The xShmLock method on [sqlite3_io_methods] may use values
1.1342 +** between 0 and this upper bound as its "offset" argument.
1.1343 +** The SQLite core will never attempt to acquire or release a
1.1344 +** lock outside of this range
1.1345 +*/
1.1346 +#define SQLITE_SHM_NLOCK 8
1.1347 +
1.1348 +
1.1349 +/*
1.1350 +** CAPI3REF: Initialize The SQLite Library
1.1351 +**
1.1352 +** ^The sqlite3_initialize() routine initializes the
1.1353 +** SQLite library. ^The sqlite3_shutdown() routine
1.1354 +** deallocates any resources that were allocated by sqlite3_initialize().
1.1355 +** These routines are designed to aid in process initialization and
1.1356 +** shutdown on embedded systems. Workstation applications using
1.1357 +** SQLite normally do not need to invoke either of these routines.
1.1358 +**
1.1359 +** A call to sqlite3_initialize() is an "effective" call if it is
1.1360 +** the first time sqlite3_initialize() is invoked during the lifetime of
1.1361 +** the process, or if it is the first time sqlite3_initialize() is invoked
1.1362 +** following a call to sqlite3_shutdown(). ^(Only an effective call
1.1363 +** of sqlite3_initialize() does any initialization. All other calls
1.1364 +** are harmless no-ops.)^
1.1365 +**
1.1366 +** A call to sqlite3_shutdown() is an "effective" call if it is the first
1.1367 +** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
1.1368 +** an effective call to sqlite3_shutdown() does any deinitialization.
1.1369 +** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
1.1370 +**
1.1371 +** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
1.1372 +** is not. The sqlite3_shutdown() interface must only be called from a
1.1373 +** single thread. All open [database connections] must be closed and all
1.1374 +** other SQLite resources must be deallocated prior to invoking
1.1375 +** sqlite3_shutdown().
1.1376 +**
1.1377 +** Among other things, ^sqlite3_initialize() will invoke
1.1378 +** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
1.1379 +** will invoke sqlite3_os_end().
1.1380 +**
1.1381 +** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
1.1382 +** ^If for some reason, sqlite3_initialize() is unable to initialize
1.1383 +** the library (perhaps it is unable to allocate a needed resource such
1.1384 +** as a mutex) it returns an [error code] other than [SQLITE_OK].
1.1385 +**
1.1386 +** ^The sqlite3_initialize() routine is called internally by many other
1.1387 +** SQLite interfaces so that an application usually does not need to
1.1388 +** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
1.1389 +** calls sqlite3_initialize() so the SQLite library will be automatically
1.1390 +** initialized when [sqlite3_open()] is called if it has not be initialized
1.1391 +** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
1.1392 +** compile-time option, then the automatic calls to sqlite3_initialize()
1.1393 +** are omitted and the application must call sqlite3_initialize() directly
1.1394 +** prior to using any other SQLite interface. For maximum portability,
1.1395 +** it is recommended that applications always invoke sqlite3_initialize()
1.1396 +** directly prior to using any other SQLite interface. Future releases
1.1397 +** of SQLite may require this. In other words, the behavior exhibited
1.1398 +** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
1.1399 +** default behavior in some future release of SQLite.
1.1400 +**
1.1401 +** The sqlite3_os_init() routine does operating-system specific
1.1402 +** initialization of the SQLite library. The sqlite3_os_end()
1.1403 +** routine undoes the effect of sqlite3_os_init(). Typical tasks
1.1404 +** performed by these routines include allocation or deallocation
1.1405 +** of static resources, initialization of global variables,
1.1406 +** setting up a default [sqlite3_vfs] module, or setting up
1.1407 +** a default configuration using [sqlite3_config()].
1.1408 +**
1.1409 +** The application should never invoke either sqlite3_os_init()
1.1410 +** or sqlite3_os_end() directly. The application should only invoke
1.1411 +** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
1.1412 +** interface is called automatically by sqlite3_initialize() and
1.1413 +** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
1.1414 +** implementations for sqlite3_os_init() and sqlite3_os_end()
1.1415 +** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
1.1416 +** When [custom builds | built for other platforms]
1.1417 +** (using the [SQLITE_OS_OTHER=1] compile-time
1.1418 +** option) the application must supply a suitable implementation for
1.1419 +** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
1.1420 +** implementation of sqlite3_os_init() or sqlite3_os_end()
1.1421 +** must return [SQLITE_OK] on success and some other [error code] upon
1.1422 +** failure.
1.1423 +*/
1.1424 +SQLITE_API int sqlite3_initialize(void);
1.1425 +SQLITE_API int sqlite3_shutdown(void);
1.1426 +SQLITE_API int sqlite3_os_init(void);
1.1427 +SQLITE_API int sqlite3_os_end(void);
1.1428 +
1.1429 +/*
1.1430 +** CAPI3REF: Configuring The SQLite Library
1.1431 +**
1.1432 +** The sqlite3_config() interface is used to make global configuration
1.1433 +** changes to SQLite in order to tune SQLite to the specific needs of
1.1434 +** the application. The default configuration is recommended for most
1.1435 +** applications and so this routine is usually not necessary. It is
1.1436 +** provided to support rare applications with unusual needs.
1.1437 +**
1.1438 +** The sqlite3_config() interface is not threadsafe. The application
1.1439 +** must insure that no other SQLite interfaces are invoked by other
1.1440 +** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
1.1441 +** may only be invoked prior to library initialization using
1.1442 +** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
1.1443 +** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
1.1444 +** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
1.1445 +** Note, however, that ^sqlite3_config() can be called as part of the
1.1446 +** implementation of an application-defined [sqlite3_os_init()].
1.1447 +**
1.1448 +** The first argument to sqlite3_config() is an integer
1.1449 +** [configuration option] that determines
1.1450 +** what property of SQLite is to be configured. Subsequent arguments
1.1451 +** vary depending on the [configuration option]
1.1452 +** in the first argument.
1.1453 +**
1.1454 +** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
1.1455 +** ^If the option is unknown or SQLite is unable to set the option
1.1456 +** then this routine returns a non-zero [error code].
1.1457 +*/
1.1458 +SQLITE_API int sqlite3_config(int, ...);
1.1459 +
1.1460 +/*
1.1461 +** CAPI3REF: Configure database connections
1.1462 +**
1.1463 +** The sqlite3_db_config() interface is used to make configuration
1.1464 +** changes to a [database connection]. The interface is similar to
1.1465 +** [sqlite3_config()] except that the changes apply to a single
1.1466 +** [database connection] (specified in the first argument).
1.1467 +**
1.1468 +** The second argument to sqlite3_db_config(D,V,...) is the
1.1469 +** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
1.1470 +** that indicates what aspect of the [database connection] is being configured.
1.1471 +** Subsequent arguments vary depending on the configuration verb.
1.1472 +**
1.1473 +** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
1.1474 +** the call is considered successful.
1.1475 +*/
1.1476 +SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
1.1477 +
1.1478 +/*
1.1479 +** CAPI3REF: Memory Allocation Routines
1.1480 +**
1.1481 +** An instance of this object defines the interface between SQLite
1.1482 +** and low-level memory allocation routines.
1.1483 +**
1.1484 +** This object is used in only one place in the SQLite interface.
1.1485 +** A pointer to an instance of this object is the argument to
1.1486 +** [sqlite3_config()] when the configuration option is
1.1487 +** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
1.1488 +** By creating an instance of this object
1.1489 +** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
1.1490 +** during configuration, an application can specify an alternative
1.1491 +** memory allocation subsystem for SQLite to use for all of its
1.1492 +** dynamic memory needs.
1.1493 +**
1.1494 +** Note that SQLite comes with several [built-in memory allocators]
1.1495 +** that are perfectly adequate for the overwhelming majority of applications
1.1496 +** and that this object is only useful to a tiny minority of applications
1.1497 +** with specialized memory allocation requirements. This object is
1.1498 +** also used during testing of SQLite in order to specify an alternative
1.1499 +** memory allocator that simulates memory out-of-memory conditions in
1.1500 +** order to verify that SQLite recovers gracefully from such
1.1501 +** conditions.
1.1502 +**
1.1503 +** The xMalloc, xRealloc, and xFree methods must work like the
1.1504 +** malloc(), realloc() and free() functions from the standard C library.
1.1505 +** ^SQLite guarantees that the second argument to
1.1506 +** xRealloc is always a value returned by a prior call to xRoundup.
1.1507 +**
1.1508 +** xSize should return the allocated size of a memory allocation
1.1509 +** previously obtained from xMalloc or xRealloc. The allocated size
1.1510 +** is always at least as big as the requested size but may be larger.
1.1511 +**
1.1512 +** The xRoundup method returns what would be the allocated size of
1.1513 +** a memory allocation given a particular requested size. Most memory
1.1514 +** allocators round up memory allocations at least to the next multiple
1.1515 +** of 8. Some allocators round up to a larger multiple or to a power of 2.
1.1516 +** Every memory allocation request coming in through [sqlite3_malloc()]
1.1517 +** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
1.1518 +** that causes the corresponding memory allocation to fail.
1.1519 +**
1.1520 +** The xInit method initializes the memory allocator. (For example,
1.1521 +** it might allocate any require mutexes or initialize internal data
1.1522 +** structures. The xShutdown method is invoked (indirectly) by
1.1523 +** [sqlite3_shutdown()] and should deallocate any resources acquired
1.1524 +** by xInit. The pAppData pointer is used as the only parameter to
1.1525 +** xInit and xShutdown.
1.1526 +**
1.1527 +** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
1.1528 +** the xInit method, so the xInit method need not be threadsafe. The
1.1529 +** xShutdown method is only called from [sqlite3_shutdown()] so it does
1.1530 +** not need to be threadsafe either. For all other methods, SQLite
1.1531 +** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
1.1532 +** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
1.1533 +** it is by default) and so the methods are automatically serialized.
1.1534 +** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
1.1535 +** methods must be threadsafe or else make their own arrangements for
1.1536 +** serialization.
1.1537 +**
1.1538 +** SQLite will never invoke xInit() more than once without an intervening
1.1539 +** call to xShutdown().
1.1540 +*/
1.1541 +typedef struct sqlite3_mem_methods sqlite3_mem_methods;
1.1542 +struct sqlite3_mem_methods {
1.1543 + void *(*xMalloc)(int); /* Memory allocation function */
1.1544 + void (*xFree)(void*); /* Free a prior allocation */
1.1545 + void *(*xRealloc)(void*,int); /* Resize an allocation */
1.1546 + int (*xSize)(void*); /* Return the size of an allocation */
1.1547 + int (*xRoundup)(int); /* Round up request size to allocation size */
1.1548 + int (*xInit)(void*); /* Initialize the memory allocator */
1.1549 + void (*xShutdown)(void*); /* Deinitialize the memory allocator */
1.1550 + void *pAppData; /* Argument to xInit() and xShutdown() */
1.1551 +};
1.1552 +
1.1553 +/*
1.1554 +** CAPI3REF: Configuration Options
1.1555 +** KEYWORDS: {configuration option}
1.1556 +**
1.1557 +** These constants are the available integer configuration options that
1.1558 +** can be passed as the first argument to the [sqlite3_config()] interface.
1.1559 +**
1.1560 +** New configuration options may be added in future releases of SQLite.
1.1561 +** Existing configuration options might be discontinued. Applications
1.1562 +** should check the return code from [sqlite3_config()] to make sure that
1.1563 +** the call worked. The [sqlite3_config()] interface will return a
1.1564 +** non-zero [error code] if a discontinued or unsupported configuration option
1.1565 +** is invoked.
1.1566 +**
1.1567 +** <dl>
1.1568 +** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
1.1569 +** <dd>There are no arguments to this option. ^This option sets the
1.1570 +** [threading mode] to Single-thread. In other words, it disables
1.1571 +** all mutexing and puts SQLite into a mode where it can only be used
1.1572 +** by a single thread. ^If SQLite is compiled with
1.1573 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1.1574 +** it is not possible to change the [threading mode] from its default
1.1575 +** value of Single-thread and so [sqlite3_config()] will return
1.1576 +** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
1.1577 +** configuration option.</dd>
1.1578 +**
1.1579 +** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
1.1580 +** <dd>There are no arguments to this option. ^This option sets the
1.1581 +** [threading mode] to Multi-thread. In other words, it disables
1.1582 +** mutexing on [database connection] and [prepared statement] objects.
1.1583 +** The application is responsible for serializing access to
1.1584 +** [database connections] and [prepared statements]. But other mutexes
1.1585 +** are enabled so that SQLite will be safe to use in a multi-threaded
1.1586 +** environment as long as no two threads attempt to use the same
1.1587 +** [database connection] at the same time. ^If SQLite is compiled with
1.1588 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1.1589 +** it is not possible to set the Multi-thread [threading mode] and
1.1590 +** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1.1591 +** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
1.1592 +**
1.1593 +** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
1.1594 +** <dd>There are no arguments to this option. ^This option sets the
1.1595 +** [threading mode] to Serialized. In other words, this option enables
1.1596 +** all mutexes including the recursive
1.1597 +** mutexes on [database connection] and [prepared statement] objects.
1.1598 +** In this mode (which is the default when SQLite is compiled with
1.1599 +** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
1.1600 +** to [database connections] and [prepared statements] so that the
1.1601 +** application is free to use the same [database connection] or the
1.1602 +** same [prepared statement] in different threads at the same time.
1.1603 +** ^If SQLite is compiled with
1.1604 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1.1605 +** it is not possible to set the Serialized [threading mode] and
1.1606 +** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1.1607 +** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
1.1608 +**
1.1609 +** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
1.1610 +** <dd> ^(This option takes a single argument which is a pointer to an
1.1611 +** instance of the [sqlite3_mem_methods] structure. The argument specifies
1.1612 +** alternative low-level memory allocation routines to be used in place of
1.1613 +** the memory allocation routines built into SQLite.)^ ^SQLite makes
1.1614 +** its own private copy of the content of the [sqlite3_mem_methods] structure
1.1615 +** before the [sqlite3_config()] call returns.</dd>
1.1616 +**
1.1617 +** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
1.1618 +** <dd> ^(This option takes a single argument which is a pointer to an
1.1619 +** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1.1620 +** structure is filled with the currently defined memory allocation routines.)^
1.1621 +** This option can be used to overload the default memory allocation
1.1622 +** routines with a wrapper that simulations memory allocation failure or
1.1623 +** tracks memory usage, for example. </dd>
1.1624 +**
1.1625 +** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
1.1626 +** <dd> ^This option takes single argument of type int, interpreted as a
1.1627 +** boolean, which enables or disables the collection of memory allocation
1.1628 +** statistics. ^(When memory allocation statistics are disabled, the
1.1629 +** following SQLite interfaces become non-operational:
1.1630 +** <ul>
1.1631 +** <li> [sqlite3_memory_used()]
1.1632 +** <li> [sqlite3_memory_highwater()]
1.1633 +** <li> [sqlite3_soft_heap_limit64()]
1.1634 +** <li> [sqlite3_status()]
1.1635 +** </ul>)^
1.1636 +** ^Memory allocation statistics are enabled by default unless SQLite is
1.1637 +** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
1.1638 +** allocation statistics are disabled by default.
1.1639 +** </dd>
1.1640 +**
1.1641 +** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
1.1642 +** <dd> ^This option specifies a static memory buffer that SQLite can use for
1.1643 +** scratch memory. There are three arguments: A pointer an 8-byte
1.1644 +** aligned memory buffer from which the scratch allocations will be
1.1645 +** drawn, the size of each scratch allocation (sz),
1.1646 +** and the maximum number of scratch allocations (N). The sz
1.1647 +** argument must be a multiple of 16.
1.1648 +** The first argument must be a pointer to an 8-byte aligned buffer
1.1649 +** of at least sz*N bytes of memory.
1.1650 +** ^SQLite will use no more than two scratch buffers per thread. So
1.1651 +** N should be set to twice the expected maximum number of threads.
1.1652 +** ^SQLite will never require a scratch buffer that is more than 6
1.1653 +** times the database page size. ^If SQLite needs needs additional
1.1654 +** scratch memory beyond what is provided by this configuration option, then
1.1655 +** [sqlite3_malloc()] will be used to obtain the memory needed.</dd>
1.1656 +**
1.1657 +** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
1.1658 +** <dd> ^This option specifies a static memory buffer that SQLite can use for
1.1659 +** the database page cache with the default page cache implementation.
1.1660 +** This configuration should not be used if an application-define page
1.1661 +** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option.
1.1662 +** There are three arguments to this option: A pointer to 8-byte aligned
1.1663 +** memory, the size of each page buffer (sz), and the number of pages (N).
1.1664 +** The sz argument should be the size of the largest database page
1.1665 +** (a power of two between 512 and 32768) plus a little extra for each
1.1666 +** page header. ^The page header size is 20 to 40 bytes depending on
1.1667 +** the host architecture. ^It is harmless, apart from the wasted memory,
1.1668 +** to make sz a little too large. The first
1.1669 +** argument should point to an allocation of at least sz*N bytes of memory.
1.1670 +** ^SQLite will use the memory provided by the first argument to satisfy its
1.1671 +** memory needs for the first N pages that it adds to cache. ^If additional
1.1672 +** page cache memory is needed beyond what is provided by this option, then
1.1673 +** SQLite goes to [sqlite3_malloc()] for the additional storage space.
1.1674 +** The pointer in the first argument must
1.1675 +** be aligned to an 8-byte boundary or subsequent behavior of SQLite
1.1676 +** will be undefined.</dd>
1.1677 +**
1.1678 +** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
1.1679 +** <dd> ^This option specifies a static memory buffer that SQLite will use
1.1680 +** for all of its dynamic memory allocation needs beyond those provided
1.1681 +** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
1.1682 +** There are three arguments: An 8-byte aligned pointer to the memory,
1.1683 +** the number of bytes in the memory buffer, and the minimum allocation size.
1.1684 +** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
1.1685 +** to using its default memory allocator (the system malloc() implementation),
1.1686 +** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
1.1687 +** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
1.1688 +** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
1.1689 +** allocator is engaged to handle all of SQLites memory allocation needs.
1.1690 +** The first pointer (the memory pointer) must be aligned to an 8-byte
1.1691 +** boundary or subsequent behavior of SQLite will be undefined.
1.1692 +** The minimum allocation size is capped at 2**12. Reasonable values
1.1693 +** for the minimum allocation size are 2**5 through 2**8.</dd>
1.1694 +**
1.1695 +** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
1.1696 +** <dd> ^(This option takes a single argument which is a pointer to an
1.1697 +** instance of the [sqlite3_mutex_methods] structure. The argument specifies
1.1698 +** alternative low-level mutex routines to be used in place
1.1699 +** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the
1.1700 +** content of the [sqlite3_mutex_methods] structure before the call to
1.1701 +** [sqlite3_config()] returns. ^If SQLite is compiled with
1.1702 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1.1703 +** the entire mutexing subsystem is omitted from the build and hence calls to
1.1704 +** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
1.1705 +** return [SQLITE_ERROR].</dd>
1.1706 +**
1.1707 +** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
1.1708 +** <dd> ^(This option takes a single argument which is a pointer to an
1.1709 +** instance of the [sqlite3_mutex_methods] structure. The
1.1710 +** [sqlite3_mutex_methods]
1.1711 +** structure is filled with the currently defined mutex routines.)^
1.1712 +** This option can be used to overload the default mutex allocation
1.1713 +** routines with a wrapper used to track mutex usage for performance
1.1714 +** profiling or testing, for example. ^If SQLite is compiled with
1.1715 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1.1716 +** the entire mutexing subsystem is omitted from the build and hence calls to
1.1717 +** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
1.1718 +** return [SQLITE_ERROR].</dd>
1.1719 +**
1.1720 +** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1.1721 +** <dd> ^(This option takes two arguments that determine the default
1.1722 +** memory allocation for the lookaside memory allocator on each
1.1723 +** [database connection]. The first argument is the
1.1724 +** size of each lookaside buffer slot and the second is the number of
1.1725 +** slots allocated to each database connection.)^ ^(This option sets the
1.1726 +** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
1.1727 +** verb to [sqlite3_db_config()] can be used to change the lookaside
1.1728 +** configuration on individual connections.)^ </dd>
1.1729 +**
1.1730 +** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
1.1731 +** <dd> ^(This option takes a single argument which is a pointer to
1.1732 +** an [sqlite3_pcache_methods2] object. This object specifies the interface
1.1733 +** to a custom page cache implementation.)^ ^SQLite makes a copy of the
1.1734 +** object and uses it for page cache memory allocations.</dd>
1.1735 +**
1.1736 +** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
1.1737 +** <dd> ^(This option takes a single argument which is a pointer to an
1.1738 +** [sqlite3_pcache_methods2] object. SQLite copies of the current
1.1739 +** page cache implementation into that object.)^ </dd>
1.1740 +**
1.1741 +** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
1.1742 +** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
1.1743 +** function with a call signature of void(*)(void*,int,const char*),
1.1744 +** and a pointer to void. ^If the function pointer is not NULL, it is
1.1745 +** invoked by [sqlite3_log()] to process each logging event. ^If the
1.1746 +** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
1.1747 +** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
1.1748 +** passed through as the first parameter to the application-defined logger
1.1749 +** function whenever that function is invoked. ^The second parameter to
1.1750 +** the logger function is a copy of the first parameter to the corresponding
1.1751 +** [sqlite3_log()] call and is intended to be a [result code] or an
1.1752 +** [extended result code]. ^The third parameter passed to the logger is
1.1753 +** log message after formatting via [sqlite3_snprintf()].
1.1754 +** The SQLite logging interface is not reentrant; the logger function
1.1755 +** supplied by the application must not invoke any SQLite interface.
1.1756 +** In a multi-threaded application, the application-defined logger
1.1757 +** function must be threadsafe. </dd>
1.1758 +**
1.1759 +** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
1.1760 +** <dd> This option takes a single argument of type int. If non-zero, then
1.1761 +** URI handling is globally enabled. If the parameter is zero, then URI handling
1.1762 +** is globally disabled. If URI handling is globally enabled, all filenames
1.1763 +** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or
1.1764 +** specified as part of [ATTACH] commands are interpreted as URIs, regardless
1.1765 +** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
1.1766 +** connection is opened. If it is globally disabled, filenames are
1.1767 +** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
1.1768 +** database connection is opened. By default, URI handling is globally
1.1769 +** disabled. The default value may be changed by compiling with the
1.1770 +** [SQLITE_USE_URI] symbol defined.
1.1771 +**
1.1772 +** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
1.1773 +** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
1.1774 +** <dd> These options are obsolete and should not be used by new code.
1.1775 +** They are retained for backwards compatibility but are now no-ops.
1.1776 +** </dl>
1.1777 +*/
1.1778 +#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1.1779 +#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1.1780 +#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
1.1781 +#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
1.1782 +#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1.1783 +#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
1.1784 +#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
1.1785 +#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
1.1786 +#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1.1787 +#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1.1788 +#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
1.1789 +/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
1.1790 +#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
1.1791 +#define SQLITE_CONFIG_PCACHE 14 /* no-op */
1.1792 +#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
1.1793 +#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
1.1794 +#define SQLITE_CONFIG_URI 17 /* int */
1.1795 +#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
1.1796 +#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
1.1797 +
1.1798 +/*
1.1799 +** CAPI3REF: Database Connection Configuration Options
1.1800 +**
1.1801 +** These constants are the available integer configuration options that
1.1802 +** can be passed as the second argument to the [sqlite3_db_config()] interface.
1.1803 +**
1.1804 +** New configuration options may be added in future releases of SQLite.
1.1805 +** Existing configuration options might be discontinued. Applications
1.1806 +** should check the return code from [sqlite3_db_config()] to make sure that
1.1807 +** the call worked. ^The [sqlite3_db_config()] interface will return a
1.1808 +** non-zero [error code] if a discontinued or unsupported configuration option
1.1809 +** is invoked.
1.1810 +**
1.1811 +** <dl>
1.1812 +** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
1.1813 +** <dd> ^This option takes three additional arguments that determine the
1.1814 +** [lookaside memory allocator] configuration for the [database connection].
1.1815 +** ^The first argument (the third parameter to [sqlite3_db_config()] is a
1.1816 +** pointer to a memory buffer to use for lookaside memory.
1.1817 +** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
1.1818 +** may be NULL in which case SQLite will allocate the
1.1819 +** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
1.1820 +** size of each lookaside buffer slot. ^The third argument is the number of
1.1821 +** slots. The size of the buffer in the first argument must be greater than
1.1822 +** or equal to the product of the second and third arguments. The buffer
1.1823 +** must be aligned to an 8-byte boundary. ^If the second argument to
1.1824 +** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
1.1825 +** rounded down to the next smaller multiple of 8. ^(The lookaside memory
1.1826 +** configuration for a database connection can only be changed when that
1.1827 +** connection is not currently using lookaside memory, or in other words
1.1828 +** when the "current value" returned by
1.1829 +** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
1.1830 +** Any attempt to change the lookaside memory configuration when lookaside
1.1831 +** memory is in use leaves the configuration unchanged and returns
1.1832 +** [SQLITE_BUSY].)^</dd>
1.1833 +**
1.1834 +** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
1.1835 +** <dd> ^This option is used to enable or disable the enforcement of
1.1836 +** [foreign key constraints]. There should be two additional arguments.
1.1837 +** The first argument is an integer which is 0 to disable FK enforcement,
1.1838 +** positive to enable FK enforcement or negative to leave FK enforcement
1.1839 +** unchanged. The second parameter is a pointer to an integer into which
1.1840 +** is written 0 or 1 to indicate whether FK enforcement is off or on
1.1841 +** following this call. The second parameter may be a NULL pointer, in
1.1842 +** which case the FK enforcement setting is not reported back. </dd>
1.1843 +**
1.1844 +** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
1.1845 +** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
1.1846 +** There should be two additional arguments.
1.1847 +** The first argument is an integer which is 0 to disable triggers,
1.1848 +** positive to enable triggers or negative to leave the setting unchanged.
1.1849 +** The second parameter is a pointer to an integer into which
1.1850 +** is written 0 or 1 to indicate whether triggers are disabled or enabled
1.1851 +** following this call. The second parameter may be a NULL pointer, in
1.1852 +** which case the trigger setting is not reported back. </dd>
1.1853 +**
1.1854 +** </dl>
1.1855 +*/
1.1856 +#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
1.1857 +#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
1.1858 +#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
1.1859 +
1.1860
1.1861 /*
1.1862 ** CAPI3REF: Enable Or Disable Extended Result Codes
1.1863 **
1.1864 -** This routine enables or disables the
1.1865 -** [SQLITE_IOERR_READ | extended result codes] feature.
1.1866 -** By default, SQLite API routines return one of only 26 integer
1.1867 -** [SQLITE_OK | result codes]. When extended result codes
1.1868 -** are enabled by this routine, the repetoire of result codes can be
1.1869 -** much larger and can (hopefully) provide more detailed information
1.1870 -** about the cause of an error.
1.1871 -**
1.1872 -** The second argument is a boolean value that turns extended result
1.1873 -** codes on and off. Extended result codes are off by default for
1.1874 -** backwards compatibility with older versions of SQLite.
1.1875 -*/
1.1876 -int sqlite3_extended_result_codes(sqlite3*, int onoff);
1.1877 +** ^The sqlite3_extended_result_codes() routine enables or disables the
1.1878 +** [extended result codes] feature of SQLite. ^The extended result
1.1879 +** codes are disabled by default for historical compatibility.
1.1880 +*/
1.1881 +SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
1.1882
1.1883 /*
1.1884 ** CAPI3REF: Last Insert Rowid
1.1885 **
1.1886 -** Each entry in an SQLite table has a unique 64-bit signed integer key
1.1887 -** called the "rowid". The rowid is always available as an undeclared
1.1888 -** column named ROWID, OID, or _ROWID_. If the table has a column of
1.1889 -** type INTEGER PRIMARY KEY then that column is another an alias for the
1.1890 -** rowid.
1.1891 -**
1.1892 -** This routine returns the rowid of the most recent INSERT into
1.1893 -** the database from the database connection given in the first
1.1894 -** argument. If no inserts have ever occurred on this database
1.1895 -** connection, zero is returned.
1.1896 -**
1.1897 -** If an INSERT occurs within a trigger, then the rowid of the
1.1898 -** inserted row is returned by this routine as long as the trigger
1.1899 -** is running. But once the trigger terminates, the value returned
1.1900 -** by this routine reverts to the last value inserted before the
1.1901 -** trigger fired.
1.1902 -**
1.1903 -** If another thread does a new insert on the same database connection
1.1904 -** while this routine is running and thus changes the last insert rowid,
1.1905 -** then the return value of this routine is undefined.
1.1906 -*/
1.1907 -sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
1.1908 +** ^Each entry in an SQLite table has a unique 64-bit signed
1.1909 +** integer key called the [ROWID | "rowid"]. ^The rowid is always available
1.1910 +** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
1.1911 +** names are not also used by explicitly declared columns. ^If
1.1912 +** the table has a column of type [INTEGER PRIMARY KEY] then that column
1.1913 +** is another alias for the rowid.
1.1914 +**
1.1915 +** ^This routine returns the [rowid] of the most recent
1.1916 +** successful [INSERT] into the database from the [database connection]
1.1917 +** in the first argument. ^As of SQLite version 3.7.7, this routines
1.1918 +** records the last insert rowid of both ordinary tables and [virtual tables].
1.1919 +** ^If no successful [INSERT]s
1.1920 +** have ever occurred on that database connection, zero is returned.
1.1921 +**
1.1922 +** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
1.1923 +** method, then this routine will return the [rowid] of the inserted
1.1924 +** row as long as the trigger or virtual table method is running.
1.1925 +** But once the trigger or virtual table method ends, the value returned
1.1926 +** by this routine reverts to what it was before the trigger or virtual
1.1927 +** table method began.)^
1.1928 +**
1.1929 +** ^An [INSERT] that fails due to a constraint violation is not a
1.1930 +** successful [INSERT] and does not change the value returned by this
1.1931 +** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
1.1932 +** and INSERT OR ABORT make no changes to the return value of this
1.1933 +** routine when their insertion fails. ^(When INSERT OR REPLACE
1.1934 +** encounters a constraint violation, it does not fail. The
1.1935 +** INSERT continues to completion after deleting rows that caused
1.1936 +** the constraint problem so INSERT OR REPLACE will always change
1.1937 +** the return value of this interface.)^
1.1938 +**
1.1939 +** ^For the purposes of this routine, an [INSERT] is considered to
1.1940 +** be successful even if it is subsequently rolled back.
1.1941 +**
1.1942 +** This function is accessible to SQL statements via the
1.1943 +** [last_insert_rowid() SQL function].
1.1944 +**
1.1945 +** If a separate thread performs a new [INSERT] on the same
1.1946 +** database connection while the [sqlite3_last_insert_rowid()]
1.1947 +** function is running and thus changes the last insert [rowid],
1.1948 +** then the value returned by [sqlite3_last_insert_rowid()] is
1.1949 +** unpredictable and might not equal either the old or the new
1.1950 +** last insert [rowid].
1.1951 +*/
1.1952 +SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
1.1953
1.1954 /*
1.1955 ** CAPI3REF: Count The Number Of Rows Modified
1.1956 **
1.1957 -** This function returns the number of database rows that were changed
1.1958 -** (or inserted or deleted) by the most recent SQL statement. Only
1.1959 -** changes that are directly specified by the INSERT, UPDATE, or
1.1960 -** DELETE statement are counted. Auxiliary changes caused by
1.1961 -** triggers are not counted. Use the [sqlite3_total_changes()] function
1.1962 -** to find the total number of changes including changes caused by triggers.
1.1963 -**
1.1964 -** Within the body of a trigger, the sqlite3_changes() interface can be
1.1965 -** called to find the number of
1.1966 +** ^This function returns the number of database rows that were changed
1.1967 +** or inserted or deleted by the most recently completed SQL statement
1.1968 +** on the [database connection] specified by the first parameter.
1.1969 +** ^(Only changes that are directly specified by the [INSERT], [UPDATE],
1.1970 +** or [DELETE] statement are counted. Auxiliary changes caused by
1.1971 +** triggers or [foreign key actions] are not counted.)^ Use the
1.1972 +** [sqlite3_total_changes()] function to find the total number of changes
1.1973 +** including changes caused by triggers and foreign key actions.
1.1974 +**
1.1975 +** ^Changes to a view that are simulated by an [INSTEAD OF trigger]
1.1976 +** are not counted. Only real table changes are counted.
1.1977 +**
1.1978 +** ^(A "row change" is a change to a single row of a single table
1.1979 +** caused by an INSERT, DELETE, or UPDATE statement. Rows that
1.1980 +** are changed as side effects of [REPLACE] constraint resolution,
1.1981 +** rollback, ABORT processing, [DROP TABLE], or by any other
1.1982 +** mechanisms do not count as direct row changes.)^
1.1983 +**
1.1984 +** A "trigger context" is a scope of execution that begins and
1.1985 +** ends with the script of a [CREATE TRIGGER | trigger].
1.1986 +** Most SQL statements are
1.1987 +** evaluated outside of any trigger. This is the "top level"
1.1988 +** trigger context. If a trigger fires from the top level, a
1.1989 +** new trigger context is entered for the duration of that one
1.1990 +** trigger. Subtriggers create subcontexts for their duration.
1.1991 +**
1.1992 +** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1.1993 +** not create a new trigger context.
1.1994 +**
1.1995 +** ^This function returns the number of direct row changes in the
1.1996 +** most recent INSERT, UPDATE, or DELETE statement within the same
1.1997 +** trigger context.
1.1998 +**
1.1999 +** ^Thus, when called from the top level, this function returns the
1.2000 +** number of changes in the most recent INSERT, UPDATE, or DELETE
1.2001 +** that also occurred at the top level. ^(Within the body of a trigger,
1.2002 +** the sqlite3_changes() interface can be called to find the number of
1.2003 ** changes in the most recently completed INSERT, UPDATE, or DELETE
1.2004 -** statement within the body of the trigger.
1.2005 -**
1.2006 -** All changes are counted, even if they were later undone by a
1.2007 -** ROLLBACK or ABORT. Except, changes associated with creating and
1.2008 -** dropping tables are not counted.
1.2009 -**
1.2010 -** If a callback invokes [sqlite3_exec()] or [sqlite3_step()] recursively,
1.2011 -** then the changes in the inner, recursive call are counted together
1.2012 -** with the changes in the outer call.
1.2013 -**
1.2014 -** SQLite implements the command "DELETE FROM table" without a WHERE clause
1.2015 -** by dropping and recreating the table. (This is much faster than going
1.2016 -** through and deleting individual elements from the table.) Because of
1.2017 -** this optimization, the change count for "DELETE FROM table" will be
1.2018 -** zero regardless of the number of elements that were originally in the
1.2019 -** table. To get an accurate count of the number of rows deleted, use
1.2020 -** "DELETE FROM table WHERE 1" instead.
1.2021 -**
1.2022 -** If another thread makes changes on the same database connection
1.2023 -** while this routine is running then the return value of this routine
1.2024 -** is undefined.
1.2025 -*/
1.2026 -int sqlite3_changes(sqlite3*);
1.2027 +** statement within the body of the same trigger.
1.2028 +** However, the number returned does not include changes
1.2029 +** caused by subtriggers since those have their own context.)^
1.2030 +**
1.2031 +** See also the [sqlite3_total_changes()] interface, the
1.2032 +** [count_changes pragma], and the [changes() SQL function].
1.2033 +**
1.2034 +** If a separate thread makes changes on the same database connection
1.2035 +** while [sqlite3_changes()] is running then the value returned
1.2036 +** is unpredictable and not meaningful.
1.2037 +*/
1.2038 +SQLITE_API int sqlite3_changes(sqlite3*);
1.2039
1.2040 /*
1.2041 ** CAPI3REF: Total Number Of Rows Modified
1.2042 -***
1.2043 -** This function returns the number of database rows that have been
1.2044 -** modified by INSERT, UPDATE or DELETE statements since the database handle
1.2045 -** was opened. This includes UPDATE, INSERT and DELETE statements executed
1.2046 -** as part of trigger programs. All changes are counted as soon as the
1.2047 -** statement that makes them is completed (when the statement handle is
1.2048 -** passed to [sqlite3_reset()] or [sqlite3_finalize()]).
1.2049 -**
1.2050 -** See also the [sqlite3_change()] interface.
1.2051 -**
1.2052 -** SQLite implements the command "DELETE FROM table" without a WHERE clause
1.2053 -** by dropping and recreating the table. (This is much faster than going
1.2054 -** through and deleting individual elements form the table.) Because of
1.2055 -** this optimization, the change count for "DELETE FROM table" will be
1.2056 -** zero regardless of the number of elements that were originally in the
1.2057 -** table. To get an accurate count of the number of rows deleted, use
1.2058 -** "DELETE FROM table WHERE 1" instead.
1.2059 -**
1.2060 -** If another thread makes changes on the same database connection
1.2061 -** while this routine is running then the return value of this routine
1.2062 -** is undefined.
1.2063 -*/
1.2064 -int sqlite3_total_changes(sqlite3*);
1.2065 +**
1.2066 +** ^This function returns the number of row changes caused by [INSERT],
1.2067 +** [UPDATE] or [DELETE] statements since the [database connection] was opened.
1.2068 +** ^(The count returned by sqlite3_total_changes() includes all changes
1.2069 +** from all [CREATE TRIGGER | trigger] contexts and changes made by
1.2070 +** [foreign key actions]. However,
1.2071 +** the count does not include changes used to implement [REPLACE] constraints,
1.2072 +** do rollbacks or ABORT processing, or [DROP TABLE] processing. The
1.2073 +** count does not include rows of views that fire an [INSTEAD OF trigger],
1.2074 +** though if the INSTEAD OF trigger makes changes of its own, those changes
1.2075 +** are counted.)^
1.2076 +** ^The sqlite3_total_changes() function counts the changes as soon as
1.2077 +** the statement that makes them is completed (when the statement handle
1.2078 +** is passed to [sqlite3_reset()] or [sqlite3_finalize()]).
1.2079 +**
1.2080 +** See also the [sqlite3_changes()] interface, the
1.2081 +** [count_changes pragma], and the [total_changes() SQL function].
1.2082 +**
1.2083 +** If a separate thread makes changes on the same database connection
1.2084 +** while [sqlite3_total_changes()] is running then the value
1.2085 +** returned is unpredictable and not meaningful.
1.2086 +*/
1.2087 +SQLITE_API int sqlite3_total_changes(sqlite3*);
1.2088
1.2089 /*
1.2090 ** CAPI3REF: Interrupt A Long-Running Query
1.2091 **
1.2092 -** This function causes any pending database operation to abort and
1.2093 -** return at its earliest opportunity. This routine is typically
1.2094 +** ^This function causes any pending database operation to abort and
1.2095 +** return at its earliest opportunity. This routine is typically
1.2096 ** called in response to a user action such as pressing "Cancel"
1.2097 ** or Ctrl-C where the user wants a long query operation to halt
1.2098 ** immediately.
1.2099 **
1.2100 -** It is safe to call this routine from a thread different from the
1.2101 +** ^It is safe to call this routine from a thread different from the
1.2102 ** thread that is currently running the database operation. But it
1.2103 -** is not safe to call this routine with a database connection that
1.2104 +** is not safe to call this routine with a [database connection] that
1.2105 ** is closed or might close before sqlite3_interrupt() returns.
1.2106 **
1.2107 -** The SQL operation that is interrupted will return [SQLITE_INTERRUPT].
1.2108 -** If an interrupted operation was an update that is inside an
1.2109 -** explicit transaction, then the entire transaction will be rolled
1.2110 -** back automatically.
1.2111 -*/
1.2112 -void sqlite3_interrupt(sqlite3*);
1.2113 +** ^If an SQL operation is very nearly finished at the time when
1.2114 +** sqlite3_interrupt() is called, then it might not have an opportunity
1.2115 +** to be interrupted and might continue to completion.
1.2116 +**
1.2117 +** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
1.2118 +** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
1.2119 +** that is inside an explicit transaction, then the entire transaction
1.2120 +** will be rolled back automatically.
1.2121 +**
1.2122 +** ^The sqlite3_interrupt(D) call is in effect until all currently running
1.2123 +** SQL statements on [database connection] D complete. ^Any new SQL statements
1.2124 +** that are started after the sqlite3_interrupt() call and before the
1.2125 +** running statements reaches zero are interrupted as if they had been
1.2126 +** running prior to the sqlite3_interrupt() call. ^New SQL statements
1.2127 +** that are started after the running statement count reaches zero are
1.2128 +** not effected by the sqlite3_interrupt().
1.2129 +** ^A call to sqlite3_interrupt(D) that occurs when there are no running
1.2130 +** SQL statements is a no-op and has no effect on SQL statements
1.2131 +** that are started after the sqlite3_interrupt() call returns.
1.2132 +**
1.2133 +** If the database connection closes while [sqlite3_interrupt()]
1.2134 +** is running then bad things will likely happen.
1.2135 +*/
1.2136 +SQLITE_API void sqlite3_interrupt(sqlite3*);
1.2137
1.2138 /*
1.2139 ** CAPI3REF: Determine If An SQL Statement Is Complete
1.2140 **
1.2141 -** These functions return true if the given input string comprises
1.2142 -** one or more complete SQL statements. For the sqlite3_complete() call,
1.2143 -** the parameter must be a nul-terminated UTF-8 string. For
1.2144 -** sqlite3_complete16(), a nul-terminated machine byte order UTF-16 string
1.2145 -** is required.
1.2146 -**
1.2147 -** These routines are useful for command-line input to determine if the
1.2148 -** currently entered text forms one or more complete SQL statements or
1.2149 -** if additional input is needed before sending the statements into
1.2150 -** SQLite for parsing. The algorithm is simple. If the
1.2151 -** last token other than spaces and comments is a semicolon, then return
1.2152 -** true. Actually, the algorithm is a little more complicated than that
1.2153 -** in order to deal with triggers, but the basic idea is the same: the
1.2154 -** statement is not complete unless it ends in a semicolon.
1.2155 -*/
1.2156 -int sqlite3_complete(const char *sql);
1.2157 -int sqlite3_complete16(const void *sql);
1.2158 +** These routines are useful during command-line input to determine if the
1.2159 +** currently entered text seems to form a complete SQL statement or
1.2160 +** if additional input is needed before sending the text into
1.2161 +** SQLite for parsing. ^These routines return 1 if the input string
1.2162 +** appears to be a complete SQL statement. ^A statement is judged to be
1.2163 +** complete if it ends with a semicolon token and is not a prefix of a
1.2164 +** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
1.2165 +** string literals or quoted identifier names or comments are not
1.2166 +** independent tokens (they are part of the token in which they are
1.2167 +** embedded) and thus do not count as a statement terminator. ^Whitespace
1.2168 +** and comments that follow the final semicolon are ignored.
1.2169 +**
1.2170 +** ^These routines return 0 if the statement is incomplete. ^If a
1.2171 +** memory allocation fails, then SQLITE_NOMEM is returned.
1.2172 +**
1.2173 +** ^These routines do not parse the SQL statements thus
1.2174 +** will not detect syntactically incorrect SQL.
1.2175 +**
1.2176 +** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
1.2177 +** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
1.2178 +** automatically by sqlite3_complete16(). If that initialization fails,
1.2179 +** then the return value from sqlite3_complete16() will be non-zero
1.2180 +** regardless of whether or not the input SQL is complete.)^
1.2181 +**
1.2182 +** The input to [sqlite3_complete()] must be a zero-terminated
1.2183 +** UTF-8 string.
1.2184 +**
1.2185 +** The input to [sqlite3_complete16()] must be a zero-terminated
1.2186 +** UTF-16 string in native byte order.
1.2187 +*/
1.2188 +SQLITE_API int sqlite3_complete(const char *sql);
1.2189 +SQLITE_API int sqlite3_complete16(const void *sql);
1.2190
1.2191 /*
1.2192 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
1.2193 **
1.2194 -** This routine identifies a callback function that might be invoked
1.2195 -** whenever an attempt is made to open a database table
1.2196 -** that another thread or process has locked.
1.2197 -** If the busy callback is NULL, then [SQLITE_BUSY]
1.2198 -** (or sometimes [SQLITE_IOERR_BLOCKED])
1.2199 -** is returned immediately upon encountering the lock.
1.2200 -** If the busy callback is not NULL, then the
1.2201 -** callback will be invoked with two arguments. The
1.2202 -** first argument to the handler is a copy of the void* pointer which
1.2203 -** is the third argument to this routine. The second argument to
1.2204 -** the handler is the number of times that the busy handler has
1.2205 -** been invoked for this locking event. If the
1.2206 +** ^This routine sets a callback function that might be invoked whenever
1.2207 +** an attempt is made to open a database table that another thread
1.2208 +** or process has locked.
1.2209 +**
1.2210 +** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]
1.2211 +** is returned immediately upon encountering the lock. ^If the busy callback
1.2212 +** is not NULL, then the callback might be invoked with two arguments.
1.2213 +**
1.2214 +** ^The first argument to the busy handler is a copy of the void* pointer which
1.2215 +** is the third argument to sqlite3_busy_handler(). ^The second argument to
1.2216 +** the busy handler callback is the number of times that the busy handler has
1.2217 +** been invoked for this locking event. ^If the
1.2218 ** busy callback returns 0, then no additional attempts are made to
1.2219 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
1.2220 -** If the callback returns non-zero, then another attempt is made to open the
1.2221 -** database for reading and the cycle repeats.
1.2222 -**
1.2223 -** The presence of a busy handler does not guarantee that
1.2224 -** it will be invoked when there is lock contention.
1.2225 -** If SQLite determines that invoking the busy handler could result in
1.2226 -** a deadlock, it will return [SQLITE_BUSY] instead.
1.2227 +** ^If the callback returns non-zero, then another attempt
1.2228 +** is made to open the database for reading and the cycle repeats.
1.2229 +**
1.2230 +** The presence of a busy handler does not guarantee that it will be invoked
1.2231 +** when there is lock contention. ^If SQLite determines that invoking the busy
1.2232 +** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
1.2233 +** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler.
1.2234 ** Consider a scenario where one process is holding a read lock that
1.2235 ** it is trying to promote to a reserved lock and
1.2236 ** a second process is holding a reserved lock that it is trying
1.2237 @@ -905,73 +1885,85 @@
1.2238 ** will induce the first process to release its read lock and allow
1.2239 ** the second process to proceed.
1.2240 **
1.2241 -** The default busy callback is NULL.
1.2242 -**
1.2243 -** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] when
1.2244 -** SQLite is in the middle of a large transaction where all the
1.2245 +** ^The default busy callback is NULL.
1.2246 +**
1.2247 +** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
1.2248 +** when SQLite is in the middle of a large transaction where all the
1.2249 ** changes will not fit into the in-memory cache. SQLite will
1.2250 ** already hold a RESERVED lock on the database file, but it needs
1.2251 ** to promote this lock to EXCLUSIVE so that it can spill cache
1.2252 ** pages into the database file without harm to concurrent
1.2253 -** readers. If it is unable to promote the lock, then the in-memory
1.2254 +** readers. ^If it is unable to promote the lock, then the in-memory
1.2255 ** cache will be left in an inconsistent state and so the error
1.2256 ** code is promoted from the relatively benign [SQLITE_BUSY] to
1.2257 -** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion
1.2258 -** forces an automatic rollback of the changes. See the
1.2259 -** <a href="http://www.sqlite.org/cvstrac/wiki?p=CorruptionFollowingBusyError">
1.2260 +** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion
1.2261 +** forces an automatic rollback of the changes. See the
1.2262 +** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
1.2263 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1.2264 ** this is important.
1.2265 -**
1.2266 -** Sqlite is re-entrant, so the busy handler may start a new query.
1.2267 -** (It is not clear why anyone would every want to do this, but it
1.2268 -** is allowed, in theory.) But the busy handler may not close the
1.2269 -** database. Closing the database from a busy handler will delete
1.2270 -** data structures out from under the executing query and will
1.2271 -** probably result in a segmentation fault or other runtime error.
1.2272 -**
1.2273 -** There can only be a single busy handler defined for each database
1.2274 -** connection. Setting a new busy handler clears any previous one.
1.2275 -** Note that calling [sqlite3_busy_timeout()] will also set or clear
1.2276 -** the busy handler.
1.2277 -**
1.2278 -** When operating in [sqlite3_enable_shared_cache | shared cache mode],
1.2279 -** only a single busy handler can be defined for each database file.
1.2280 -** So if two database connections share a single cache, then changing
1.2281 -** the busy handler on one connection will also change the busy
1.2282 -** handler in the other connection. The busy handler is invoked
1.2283 -** in the thread that was running when the SQLITE_BUSY was hit.
1.2284 -*/
1.2285 -int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
1.2286 +**
1.2287 +** ^(There can only be a single busy handler defined for each
1.2288 +** [database connection]. Setting a new busy handler clears any
1.2289 +** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
1.2290 +** will also set or clear the busy handler.
1.2291 +**
1.2292 +** The busy callback should not take any actions which modify the
1.2293 +** database connection that invoked the busy handler. Any such actions
1.2294 +** result in undefined behavior.
1.2295 +**
1.2296 +** A busy handler must not close the database connection
1.2297 +** or [prepared statement] that invoked the busy handler.
1.2298 +*/
1.2299 +SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
1.2300
1.2301 /*
1.2302 ** CAPI3REF: Set A Busy Timeout
1.2303 **
1.2304 -** This routine sets a busy handler that sleeps for a while when a
1.2305 -** table is locked. The handler will sleep multiple times until
1.2306 -** at least "ms" milliseconds of sleeping have been done. After
1.2307 -** "ms" milliseconds of sleeping, the handler returns 0 which
1.2308 -** causes [sqlite3_step()] to return [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
1.2309 -**
1.2310 -** Calling this routine with an argument less than or equal to zero
1.2311 +** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
1.2312 +** for a specified amount of time when a table is locked. ^The handler
1.2313 +** will sleep multiple times until at least "ms" milliseconds of sleeping
1.2314 +** have accumulated. ^After at least "ms" milliseconds of sleeping,
1.2315 +** the handler returns 0 which causes [sqlite3_step()] to return
1.2316 +** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
1.2317 +**
1.2318 +** ^Calling this routine with an argument less than or equal to zero
1.2319 ** turns off all busy handlers.
1.2320 **
1.2321 -** There can only be a single busy handler for a particular database
1.2322 -** connection. If another busy handler was defined
1.2323 -** (using [sqlite3_busy_handler()]) prior to calling
1.2324 -** this routine, that other busy handler is cleared.
1.2325 -*/
1.2326 -int sqlite3_busy_timeout(sqlite3*, int ms);
1.2327 +** ^(There can only be a single busy handler for a particular
1.2328 +** [database connection] any any given moment. If another busy handler
1.2329 +** was defined (using [sqlite3_busy_handler()]) prior to calling
1.2330 +** this routine, that other busy handler is cleared.)^
1.2331 +*/
1.2332 +SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
1.2333
1.2334 /*
1.2335 ** CAPI3REF: Convenience Routines For Running Queries
1.2336 **
1.2337 -** This next routine is a convenience wrapper around [sqlite3_exec()].
1.2338 -** Instead of invoking a user-supplied callback for each row of the
1.2339 -** result, this routine remembers each row of the result in memory
1.2340 -** obtained from [sqlite3_malloc()], then returns all of the result after the
1.2341 -** query has finished.
1.2342 -**
1.2343 -** As an example, suppose the query result where this table:
1.2344 +** This is a legacy interface that is preserved for backwards compatibility.
1.2345 +** Use of this interface is not recommended.
1.2346 +**
1.2347 +** Definition: A <b>result table</b> is memory data structure created by the
1.2348 +** [sqlite3_get_table()] interface. A result table records the
1.2349 +** complete query results from one or more queries.
1.2350 +**
1.2351 +** The table conceptually has a number of rows and columns. But
1.2352 +** these numbers are not part of the result table itself. These
1.2353 +** numbers are obtained separately. Let N be the number of rows
1.2354 +** and M be the number of columns.
1.2355 +**
1.2356 +** A result table is an array of pointers to zero-terminated UTF-8 strings.
1.2357 +** There are (N+1)*M elements in the array. The first M pointers point
1.2358 +** to zero-terminated strings that contain the names of the columns.
1.2359 +** The remaining entries all point to query results. NULL values result
1.2360 +** in NULL pointers. All other values are in their UTF-8 zero-terminated
1.2361 +** string representation as returned by [sqlite3_column_text()].
1.2362 +**
1.2363 +** A result table might consist of one or more memory allocations.
1.2364 +** It is not safe to pass a result table directly to [sqlite3_free()].
1.2365 +** A result table should be deallocated using [sqlite3_free_table()].
1.2366 +**
1.2367 +** ^(As an example of the result table format, suppose a query result
1.2368 +** is as follows:
1.2369 **
1.2370 ** <blockquote><pre>
1.2371 ** Name | Age
1.2372 @@ -981,8 +1973,9 @@
1.2373 ** Cindy | 21
1.2374 ** </pre></blockquote>
1.2375 **
1.2376 -** If the 3rd argument were &azResult then after the function returns
1.2377 -** azResult will contain the following data:
1.2378 +** There are two column (M==2) and three rows (N==3). Thus the
1.2379 +** result table has 8 entries. Suppose the result table is stored
1.2380 +** in an array names azResult. Then azResult holds this content:
1.2381 **
1.2382 ** <blockquote><pre>
1.2383 ** azResult[0] = "Name";
1.2384 @@ -993,76 +1986,84 @@
1.2385 ** azResult[5] = "28";
1.2386 ** azResult[6] = "Cindy";
1.2387 ** azResult[7] = "21";
1.2388 -** </pre></blockquote>
1.2389 -**
1.2390 -** Notice that there is an extra row of data containing the column
1.2391 -** headers. But the *nrow return value is still 3. *ncolumn is
1.2392 -** set to 2. In general, the number of values inserted into azResult
1.2393 -** will be ((*nrow) + 1)*(*ncolumn).
1.2394 -**
1.2395 -** After the calling function has finished using the result, it should
1.2396 -** pass the result data pointer to sqlite3_free_table() in order to
1.2397 -** release the memory that was malloc-ed. Because of the way the
1.2398 -** [sqlite3_malloc()] happens, the calling function must not try to call
1.2399 -** [sqlite3_free()] directly. Only [sqlite3_free_table()] is able to release
1.2400 -** the memory properly and safely.
1.2401 -**
1.2402 -** The return value of this routine is the same as from [sqlite3_exec()].
1.2403 -*/
1.2404 -int sqlite3_get_table(
1.2405 - sqlite3*, /* An open database */
1.2406 - const char *sql, /* SQL to be executed */
1.2407 - char ***resultp, /* Result written to a char *[] that this points to */
1.2408 - int *nrow, /* Number of result rows written here */
1.2409 - int *ncolumn, /* Number of result columns written here */
1.2410 - char **errmsg /* Error msg written here */
1.2411 +** </pre></blockquote>)^
1.2412 +**
1.2413 +** ^The sqlite3_get_table() function evaluates one or more
1.2414 +** semicolon-separated SQL statements in the zero-terminated UTF-8
1.2415 +** string of its 2nd parameter and returns a result table to the
1.2416 +** pointer given in its 3rd parameter.
1.2417 +**
1.2418 +** After the application has finished with the result from sqlite3_get_table(),
1.2419 +** it must pass the result table pointer to sqlite3_free_table() in order to
1.2420 +** release the memory that was malloced. Because of the way the
1.2421 +** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
1.2422 +** function must not try to call [sqlite3_free()] directly. Only
1.2423 +** [sqlite3_free_table()] is able to release the memory properly and safely.
1.2424 +**
1.2425 +** The sqlite3_get_table() interface is implemented as a wrapper around
1.2426 +** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1.2427 +** to any internal data structures of SQLite. It uses only the public
1.2428 +** interface defined here. As a consequence, errors that occur in the
1.2429 +** wrapper layer outside of the internal [sqlite3_exec()] call are not
1.2430 +** reflected in subsequent calls to [sqlite3_errcode()] or
1.2431 +** [sqlite3_errmsg()].
1.2432 +*/
1.2433 +SQLITE_API int sqlite3_get_table(
1.2434 + sqlite3 *db, /* An open database */
1.2435 + const char *zSql, /* SQL to be evaluated */
1.2436 + char ***pazResult, /* Results of the query */
1.2437 + int *pnRow, /* Number of result rows written here */
1.2438 + int *pnColumn, /* Number of result columns written here */
1.2439 + char **pzErrmsg /* Error msg written here */
1.2440 );
1.2441 -void sqlite3_free_table(char **result);
1.2442 +SQLITE_API void sqlite3_free_table(char **result);
1.2443
1.2444 /*
1.2445 ** CAPI3REF: Formatted String Printing Functions
1.2446 **
1.2447 -** These routines are workalikes of the "printf()" family of functions
1.2448 +** These routines are work-alikes of the "printf()" family of functions
1.2449 ** from the standard C library.
1.2450 **
1.2451 -** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
1.2452 +** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
1.2453 ** results into memory obtained from [sqlite3_malloc()].
1.2454 ** The strings returned by these two routines should be
1.2455 -** released by [sqlite3_free()]. Both routines return a
1.2456 +** released by [sqlite3_free()]. ^Both routines return a
1.2457 ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1.2458 ** memory to hold the resulting string.
1.2459 **
1.2460 -** In sqlite3_snprintf() routine is similar to "snprintf()" from
1.2461 +** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
1.2462 ** the standard C library. The result is written into the
1.2463 ** buffer supplied as the second parameter whose size is given by
1.2464 -** the first parameter. Note that the order of the
1.2465 -** first two parameters is reversed from snprintf(). This is an
1.2466 +** the first parameter. Note that the order of the
1.2467 +** first two parameters is reversed from snprintf().)^ This is an
1.2468 ** historical accident that cannot be fixed without breaking
1.2469 -** backwards compatibility. Note also that sqlite3_snprintf()
1.2470 +** backwards compatibility. ^(Note also that sqlite3_snprintf()
1.2471 ** returns a pointer to its buffer instead of the number of
1.2472 -** characters actually written into the buffer. We admit that
1.2473 +** characters actually written into the buffer.)^ We admit that
1.2474 ** the number of characters written would be a more useful return
1.2475 ** value but we cannot change the implementation of sqlite3_snprintf()
1.2476 ** now without breaking compatibility.
1.2477 **
1.2478 -** As long as the buffer size is greater than zero, sqlite3_snprintf()
1.2479 -** guarantees that the buffer is always zero-terminated. The first
1.2480 +** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
1.2481 +** guarantees that the buffer is always zero-terminated. ^The first
1.2482 ** parameter "n" is the total size of the buffer, including space for
1.2483 ** the zero terminator. So the longest string that can be completely
1.2484 ** written will be n-1 characters.
1.2485 **
1.2486 +** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
1.2487 +**
1.2488 ** These routines all implement some additional formatting
1.2489 ** options that are useful for constructing SQL statements.
1.2490 -** All of the usual printf formatting options apply. In addition, there
1.2491 +** All of the usual printf() formatting options apply. In addition, there
1.2492 ** is are "%q", "%Q", and "%z" options.
1.2493 **
1.2494 -** The %q option works like %s in that it substitutes a null-terminated
1.2495 +** ^(The %q option works like %s in that it substitutes a nul-terminated
1.2496 ** string from the argument list. But %q also doubles every '\'' character.
1.2497 -** %q is designed for use inside a string literal. By doubling each '\''
1.2498 +** %q is designed for use inside a string literal.)^ By doubling each '\''
1.2499 ** character it escapes that character and allows it to be inserted into
1.2500 ** the string.
1.2501 **
1.2502 -** For example, so some string variable contains text as follows:
1.2503 +** For example, assume the string variable zText contains text as follows:
1.2504 **
1.2505 ** <blockquote><pre>
1.2506 ** char *zText = "It's a happy day!";
1.2507 @@ -1090,14 +2091,13 @@
1.2508 ** INSERT INTO table1 VALUES('It's a happy day!');
1.2509 ** </pre></blockquote>
1.2510 **
1.2511 -** This second example is an SQL syntax error. As a general rule you
1.2512 -** should always use %q instead of %s when inserting text into a string
1.2513 -** literal.
1.2514 -**
1.2515 -** The %Q option works like %q except it also adds single quotes around
1.2516 -** the outside of the total string. Or if the parameter in the argument
1.2517 -** list is a NULL pointer, %Q substitutes the text "NULL" (without single
1.2518 -** quotes) in place of the %Q option. So, for example, one could say:
1.2519 +** This second example is an SQL syntax error. As a general rule you should
1.2520 +** always use %q instead of %s when inserting text into a string literal.
1.2521 +**
1.2522 +** ^(The %Q option works like %q except it also adds single quotes around
1.2523 +** the outside of the total string. Additionally, if the parameter in the
1.2524 +** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
1.2525 +** single quotes).)^ So, for example, one could say:
1.2526 **
1.2527 ** <blockquote><pre>
1.2528 ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1.2529 @@ -1108,171 +2108,216 @@
1.2530 ** The code above will render a correct SQL statement in the zSQL
1.2531 ** variable even if the zText variable is a NULL pointer.
1.2532 **
1.2533 -** The "%z" formatting option works exactly like "%s" with the
1.2534 +** ^(The "%z" formatting option works like "%s" but with the
1.2535 ** addition that after the string has been read and copied into
1.2536 -** the result, [sqlite3_free()] is called on the input string.
1.2537 -*/
1.2538 -char *sqlite3_mprintf(const char*,...);
1.2539 -char *sqlite3_vmprintf(const char*, va_list);
1.2540 -char *sqlite3_snprintf(int,char*,const char*, ...);
1.2541 +** the result, [sqlite3_free()] is called on the input string.)^
1.2542 +*/
1.2543 +SQLITE_API char *sqlite3_mprintf(const char*,...);
1.2544 +SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
1.2545 +SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
1.2546 +SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
1.2547
1.2548 /*
1.2549 ** CAPI3REF: Memory Allocation Subsystem
1.2550 **
1.2551 ** The SQLite core uses these three routines for all of its own
1.2552 -** internal memory allocation needs. (See the exception below.)
1.2553 -** The default implementation
1.2554 -** of the memory allocation subsystem uses the malloc(), realloc()
1.2555 -** and free() provided by the standard C library. However, if
1.2556 -** SQLite is compiled with the following C preprocessor macro
1.2557 -**
1.2558 -** <blockquote> SQLITE_OMIT_MEMORY_ALLOCATION </blockquote>
1.2559 -**
1.2560 -** then no implementation is provided for these routines by
1.2561 -** SQLite. The application that links against SQLite is
1.2562 -** expected to provide its own implementation. If the application
1.2563 -** does provide its own implementation for these routines, then
1.2564 -** it must also provide an implementations for
1.2565 -** [sqlite3_memory_alarm()], [sqlite3_memory_used()], and
1.2566 -** [sqlite3_memory_highwater()]. The alternative implementations
1.2567 -** for these last three routines need not actually work, but
1.2568 -** stub functions at least are needed to statisfy the linker.
1.2569 -** SQLite never calls [sqlite3_memory_highwater()] itself, but
1.2570 -** the symbol is included in a table as part of the
1.2571 -** [sqlite3_load_extension()] interface. The
1.2572 -** [sqlite3_memory_alarm()] and [sqlite3_memory_used()] interfaces
1.2573 -** are called by [sqlite3_soft_heap_limit()] and working implementations
1.2574 -** of both routines must be provided if [sqlite3_soft_heap_limit()]
1.2575 -** is to operate correctly.
1.2576 -**
1.2577 -** <b>Exception:</b> The windows OS interface layer calls
1.2578 +** internal memory allocation needs. "Core" in the previous sentence
1.2579 +** does not include operating-system specific VFS implementation. The
1.2580 +** Windows VFS uses native malloc() and free() for some operations.
1.2581 +**
1.2582 +** ^The sqlite3_malloc() routine returns a pointer to a block
1.2583 +** of memory at least N bytes in length, where N is the parameter.
1.2584 +** ^If sqlite3_malloc() is unable to obtain sufficient free
1.2585 +** memory, it returns a NULL pointer. ^If the parameter N to
1.2586 +** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1.2587 +** a NULL pointer.
1.2588 +**
1.2589 +** ^Calling sqlite3_free() with a pointer previously returned
1.2590 +** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
1.2591 +** that it might be reused. ^The sqlite3_free() routine is
1.2592 +** a no-op if is called with a NULL pointer. Passing a NULL pointer
1.2593 +** to sqlite3_free() is harmless. After being freed, memory
1.2594 +** should neither be read nor written. Even reading previously freed
1.2595 +** memory might result in a segmentation fault or other severe error.
1.2596 +** Memory corruption, a segmentation fault, or other severe error
1.2597 +** might result if sqlite3_free() is called with a non-NULL pointer that
1.2598 +** was not obtained from sqlite3_malloc() or sqlite3_realloc().
1.2599 +**
1.2600 +** ^(The sqlite3_realloc() interface attempts to resize a
1.2601 +** prior memory allocation to be at least N bytes, where N is the
1.2602 +** second parameter. The memory allocation to be resized is the first
1.2603 +** parameter.)^ ^ If the first parameter to sqlite3_realloc()
1.2604 +** is a NULL pointer then its behavior is identical to calling
1.2605 +** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
1.2606 +** ^If the second parameter to sqlite3_realloc() is zero or
1.2607 +** negative then the behavior is exactly the same as calling
1.2608 +** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
1.2609 +** ^sqlite3_realloc() returns a pointer to a memory allocation
1.2610 +** of at least N bytes in size or NULL if sufficient memory is unavailable.
1.2611 +** ^If M is the size of the prior allocation, then min(N,M) bytes
1.2612 +** of the prior allocation are copied into the beginning of buffer returned
1.2613 +** by sqlite3_realloc() and the prior allocation is freed.
1.2614 +** ^If sqlite3_realloc() returns NULL, then the prior allocation
1.2615 +** is not freed.
1.2616 +**
1.2617 +** ^The memory returned by sqlite3_malloc() and sqlite3_realloc()
1.2618 +** is always aligned to at least an 8 byte boundary, or to a
1.2619 +** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
1.2620 +** option is used.
1.2621 +**
1.2622 +** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1.2623 +** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1.2624 +** implementation of these routines to be omitted. That capability
1.2625 +** is no longer provided. Only built-in memory allocators can be used.
1.2626 +**
1.2627 +** Prior to SQLite version 3.7.10, the Windows OS interface layer called
1.2628 ** the system malloc() and free() directly when converting
1.2629 ** filenames between the UTF-8 encoding used by SQLite
1.2630 -** and whatever filename encoding is used by the particular windows
1.2631 -** installation. Memory allocation errors are detected, but
1.2632 -** they are reported back as [SQLITE_CANTOPEN] or
1.2633 +** and whatever filename encoding is used by the particular Windows
1.2634 +** installation. Memory allocation errors were detected, but
1.2635 +** they were reported back as [SQLITE_CANTOPEN] or
1.2636 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
1.2637 -*/
1.2638 -void *sqlite3_malloc(int);
1.2639 -void *sqlite3_realloc(void*, int);
1.2640 -void sqlite3_free(void*);
1.2641 +**
1.2642 +** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1.2643 +** must be either NULL or else pointers obtained from a prior
1.2644 +** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
1.2645 +** not yet been released.
1.2646 +**
1.2647 +** The application must not read or write any part of
1.2648 +** a block of memory after it has been released using
1.2649 +** [sqlite3_free()] or [sqlite3_realloc()].
1.2650 +*/
1.2651 +SQLITE_API void *sqlite3_malloc(int);
1.2652 +SQLITE_API void *sqlite3_realloc(void*, int);
1.2653 +SQLITE_API void sqlite3_free(void*);
1.2654
1.2655 /*
1.2656 ** CAPI3REF: Memory Allocator Statistics
1.2657 **
1.2658 -** In addition to the basic three allocation routines
1.2659 -** [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()],
1.2660 -** the memory allocation subsystem included with the SQLite
1.2661 -** sources provides the interfaces shown below.
1.2662 -**
1.2663 -** The first of these two routines returns the amount of memory
1.2664 -** currently outstanding (malloced but not freed). The second
1.2665 -** returns the largest instantaneous amount of outstanding
1.2666 -** memory. The highwater mark is reset if the argument is
1.2667 -** true.
1.2668 -**
1.2669 -** The implementation of these routines in the SQLite core
1.2670 -** is omitted if the application is compiled with the
1.2671 -** SQLITE_OMIT_MEMORY_ALLOCATION macro defined. In that case,
1.2672 -** the application that links SQLite must provide its own
1.2673 -** alternative implementation. See the documentation on
1.2674 -** [sqlite3_malloc()] for additional information.
1.2675 -*/
1.2676 -sqlite3_int64 sqlite3_memory_used(void);
1.2677 -sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
1.2678 -
1.2679 -/*
1.2680 -** CAPI3REF: Memory Allocation Alarms
1.2681 -**
1.2682 -** The [sqlite3_memory_alarm] routine is used to register
1.2683 -** a callback on memory allocation events.
1.2684 -**
1.2685 -** This routine registers or clears a callbacks that fires when
1.2686 -** the amount of memory allocated exceeds iThreshold. Only
1.2687 -** a single callback can be registered at a time. Each call
1.2688 -** to [sqlite3_memory_alarm()] overwrites the previous callback.
1.2689 -** The callback is disabled by setting xCallback to a NULL
1.2690 -** pointer.
1.2691 -**
1.2692 -** The parameters to the callback are the pArg value, the
1.2693 -** amount of memory currently in use, and the size of the
1.2694 -** allocation that provoked the callback. The callback will
1.2695 -** presumably invoke [sqlite3_free()] to free up memory space.
1.2696 -** The callback may invoke [sqlite3_malloc()] or [sqlite3_realloc()]
1.2697 -** but if it does, no additional callbacks will be invoked by
1.2698 -** the recursive calls.
1.2699 -**
1.2700 -** The [sqlite3_soft_heap_limit()] interface works by registering
1.2701 -** a memory alarm at the soft heap limit and invoking
1.2702 -** [sqlite3_release_memory()] in the alarm callback. Application
1.2703 -** programs should not attempt to use the [sqlite3_memory_alarm()]
1.2704 -** interface because doing so will interfere with the
1.2705 -** [sqlite3_soft_heap_limit()] module. This interface is exposed
1.2706 -** only so that applications can provide their own
1.2707 -** alternative implementation when the SQLite core is
1.2708 -** compiled with SQLITE_OMIT_MEMORY_ALLOCATION.
1.2709 -*/
1.2710 -int sqlite3_memory_alarm(
1.2711 - void(*xCallback)(void *pArg, sqlite3_int64 used, int N),
1.2712 - void *pArg,
1.2713 - sqlite3_int64 iThreshold
1.2714 -);
1.2715 -
1.2716 +** SQLite provides these two interfaces for reporting on the status
1.2717 +** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
1.2718 +** routines, which form the built-in memory allocation subsystem.
1.2719 +**
1.2720 +** ^The [sqlite3_memory_used()] routine returns the number of bytes
1.2721 +** of memory currently outstanding (malloced but not freed).
1.2722 +** ^The [sqlite3_memory_highwater()] routine returns the maximum
1.2723 +** value of [sqlite3_memory_used()] since the high-water mark
1.2724 +** was last reset. ^The values returned by [sqlite3_memory_used()] and
1.2725 +** [sqlite3_memory_highwater()] include any overhead
1.2726 +** added by SQLite in its implementation of [sqlite3_malloc()],
1.2727 +** but not overhead added by the any underlying system library
1.2728 +** routines that [sqlite3_malloc()] may call.
1.2729 +**
1.2730 +** ^The memory high-water mark is reset to the current value of
1.2731 +** [sqlite3_memory_used()] if and only if the parameter to
1.2732 +** [sqlite3_memory_highwater()] is true. ^The value returned
1.2733 +** by [sqlite3_memory_highwater(1)] is the high-water mark
1.2734 +** prior to the reset.
1.2735 +*/
1.2736 +SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
1.2737 +SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
1.2738 +
1.2739 +/*
1.2740 +** CAPI3REF: Pseudo-Random Number Generator
1.2741 +**
1.2742 +** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
1.2743 +** select random [ROWID | ROWIDs] when inserting new records into a table that
1.2744 +** already uses the largest possible [ROWID]. The PRNG is also used for
1.2745 +** the build-in random() and randomblob() SQL functions. This interface allows
1.2746 +** applications to access the same PRNG for other purposes.
1.2747 +**
1.2748 +** ^A call to this routine stores N bytes of randomness into buffer P.
1.2749 +**
1.2750 +** ^The first time this routine is invoked (either internally or by
1.2751 +** the application) the PRNG is seeded using randomness obtained
1.2752 +** from the xRandomness method of the default [sqlite3_vfs] object.
1.2753 +** ^On all subsequent invocations, the pseudo-randomness is generated
1.2754 +** internally and without recourse to the [sqlite3_vfs] xRandomness
1.2755 +** method.
1.2756 +*/
1.2757 +SQLITE_API void sqlite3_randomness(int N, void *P);
1.2758
1.2759 /*
1.2760 ** CAPI3REF: Compile-Time Authorization Callbacks
1.2761 -***
1.2762 -** This routine registers a authorizer callback with the SQLite library.
1.2763 -** The authorizer callback is invoked as SQL statements are being compiled
1.2764 +**
1.2765 +** ^This routine registers an authorizer callback with a particular
1.2766 +** [database connection], supplied in the first argument.
1.2767 +** ^The authorizer callback is invoked as SQL statements are being compiled
1.2768 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
1.2769 -** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various
1.2770 +** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various
1.2771 ** points during the compilation process, as logic is being created
1.2772 ** to perform various actions, the authorizer callback is invoked to
1.2773 -** see if those actions are allowed. The authorizer callback should
1.2774 -** return SQLITE_OK to allow the action, [SQLITE_IGNORE] to disallow the
1.2775 +** see if those actions are allowed. ^The authorizer callback should
1.2776 +** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
1.2777 ** specific action but allow the SQL statement to continue to be
1.2778 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
1.2779 -** rejected with an error.
1.2780 -**
1.2781 -** Depending on the action, the [SQLITE_IGNORE] and [SQLITE_DENY] return
1.2782 -** codes might mean something different or they might mean the same
1.2783 -** thing. If the action is, for example, to perform a delete opertion,
1.2784 -** then [SQLITE_IGNORE] and [SQLITE_DENY] both cause the statement compilation
1.2785 -** to fail with an error. But if the action is to read a specific column
1.2786 -** from a specific table, then [SQLITE_DENY] will cause the entire
1.2787 -** statement to fail but [SQLITE_IGNORE] will cause a NULL value to be
1.2788 -** read instead of the actual column value.
1.2789 -**
1.2790 -** The first parameter to the authorizer callback is a copy of
1.2791 -** the third parameter to the sqlite3_set_authorizer() interface.
1.2792 -** The second parameter to the callback is an integer
1.2793 -** [SQLITE_COPY | action code] that specifies the particular action
1.2794 -** to be authorized. The available action codes are
1.2795 -** [SQLITE_COPY | documented separately]. The third through sixth
1.2796 -** parameters to the callback are strings that contain additional
1.2797 +** rejected with an error. ^If the authorizer callback returns
1.2798 +** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
1.2799 +** then the [sqlite3_prepare_v2()] or equivalent call that triggered
1.2800 +** the authorizer will fail with an error message.
1.2801 +**
1.2802 +** When the callback returns [SQLITE_OK], that means the operation
1.2803 +** requested is ok. ^When the callback returns [SQLITE_DENY], the
1.2804 +** [sqlite3_prepare_v2()] or equivalent call that triggered the
1.2805 +** authorizer will fail with an error message explaining that
1.2806 +** access is denied.
1.2807 +**
1.2808 +** ^The first parameter to the authorizer callback is a copy of the third
1.2809 +** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
1.2810 +** to the callback is an integer [SQLITE_COPY | action code] that specifies
1.2811 +** the particular action to be authorized. ^The third through sixth parameters
1.2812 +** to the callback are zero-terminated strings that contain additional
1.2813 ** details about the action to be authorized.
1.2814 **
1.2815 -** An authorizer is used when preparing SQL statements from an untrusted
1.2816 -** source, to ensure that the SQL statements do not try to access data
1.2817 -** that they are not allowed to see, or that they do not try to
1.2818 -** execute malicious statements that damage the database. For
1.2819 +** ^If the action code is [SQLITE_READ]
1.2820 +** and the callback returns [SQLITE_IGNORE] then the
1.2821 +** [prepared statement] statement is constructed to substitute
1.2822 +** a NULL value in place of the table column that would have
1.2823 +** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1.2824 +** return can be used to deny an untrusted user access to individual
1.2825 +** columns of a table.
1.2826 +** ^If the action code is [SQLITE_DELETE] and the callback returns
1.2827 +** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
1.2828 +** [truncate optimization] is disabled and all rows are deleted individually.
1.2829 +**
1.2830 +** An authorizer is used when [sqlite3_prepare | preparing]
1.2831 +** SQL statements from an untrusted source, to ensure that the SQL statements
1.2832 +** do not try to access data they are not allowed to see, or that they do not
1.2833 +** try to execute malicious statements that damage the database. For
1.2834 ** example, an application may allow a user to enter arbitrary
1.2835 ** SQL queries for evaluation by a database. But the application does
1.2836 ** not want the user to be able to make arbitrary changes to the
1.2837 ** database. An authorizer could then be put in place while the
1.2838 -** user-entered SQL is being prepared that disallows everything
1.2839 -** except SELECT statements.
1.2840 -**
1.2841 -** Only a single authorizer can be in place on a database connection
1.2842 +** user-entered SQL is being [sqlite3_prepare | prepared] that
1.2843 +** disallows everything except [SELECT] statements.
1.2844 +**
1.2845 +** Applications that need to process SQL from untrusted sources
1.2846 +** might also consider lowering resource limits using [sqlite3_limit()]
1.2847 +** and limiting database size using the [max_page_count] [PRAGMA]
1.2848 +** in addition to using an authorizer.
1.2849 +**
1.2850 +** ^(Only a single authorizer can be in place on a database connection
1.2851 ** at a time. Each call to sqlite3_set_authorizer overrides the
1.2852 -** previous call. A NULL authorizer means that no authorization
1.2853 -** callback is invoked. The default authorizer is NULL.
1.2854 -**
1.2855 -** Note that the authorizer callback is invoked only during
1.2856 +** previous call.)^ ^Disable the authorizer by installing a NULL callback.
1.2857 +** The authorizer is disabled by default.
1.2858 +**
1.2859 +** The authorizer callback must not do anything that will modify
1.2860 +** the database connection that invoked the authorizer callback.
1.2861 +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1.2862 +** database connections for the meaning of "modify" in this paragraph.
1.2863 +**
1.2864 +** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
1.2865 +** statement might be re-prepared during [sqlite3_step()] due to a
1.2866 +** schema change. Hence, the application should ensure that the
1.2867 +** correct authorizer callback remains in place during the [sqlite3_step()].
1.2868 +**
1.2869 +** ^Note that the authorizer callback is invoked only during
1.2870 ** [sqlite3_prepare()] or its variants. Authorization is not
1.2871 -** performed during statement evaluation in [sqlite3_step()].
1.2872 -*/
1.2873 -int sqlite3_set_authorizer(
1.2874 +** performed during statement evaluation in [sqlite3_step()], unless
1.2875 +** as stated in the previous paragraph, sqlite3_step() invokes
1.2876 +** sqlite3_prepare_v2() to reprepare a statement after a schema change.
1.2877 +*/
1.2878 +SQLITE_API int sqlite3_set_authorizer(
1.2879 sqlite3*,
1.2880 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
1.2881 void *pUserData
1.2882 @@ -1286,6 +2331,9 @@
1.2883 ** to signal SQLite whether or not the action is permitted. See the
1.2884 ** [sqlite3_set_authorizer | authorizer documentation] for additional
1.2885 ** information.
1.2886 +**
1.2887 +** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code]
1.2888 +** from the [sqlite3_vtab_on_conflict()] interface.
1.2889 */
1.2890 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
1.2891 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
1.2892 @@ -1294,19 +2342,19 @@
1.2893 ** CAPI3REF: Authorizer Action Codes
1.2894 **
1.2895 ** The [sqlite3_set_authorizer()] interface registers a callback function
1.2896 -** that is invoked to authorizer certain SQL statement actions. The
1.2897 +** that is invoked to authorize certain SQL statement actions. The
1.2898 ** second parameter to the callback is an integer code that specifies
1.2899 ** what action is being authorized. These are the integer action codes that
1.2900 ** the authorizer callback may be passed.
1.2901 **
1.2902 -** These action code values signify what kind of operation is to be
1.2903 -** authorized. The 3rd and 4th parameters to the authorization callback
1.2904 -** function will be parameters or NULL depending on which of these
1.2905 -** codes is used as the second parameter. The 5th parameter to the
1.2906 -** authorizer callback is the name of the database ("main", "temp",
1.2907 -** etc.) if applicable. The 6th parameter to the authorizer callback
1.2908 +** These action code values signify what kind of operation is to be
1.2909 +** authorized. The 3rd and 4th parameters to the authorization
1.2910 +** callback function will be parameters or NULL depending on which of these
1.2911 +** codes is used as the second parameter. ^(The 5th parameter to the
1.2912 +** authorizer callback is the name of the database ("main", "temp",
1.2913 +** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
1.2914 ** is the name of the inner-most trigger or view that is responsible for
1.2915 -** the access attempt or NULL if this access attempt is directly from
1.2916 +** the access attempt or NULL if this access attempt is directly from
1.2917 ** top-level SQL code.
1.2918 */
1.2919 /******************************************* 3rd ************ 4th ***********/
1.2920 @@ -1331,7 +2379,7 @@
1.2921 #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
1.2922 #define SQLITE_READ 20 /* Table Name Column Name */
1.2923 #define SQLITE_SELECT 21 /* NULL NULL */
1.2924 -#define SQLITE_TRANSACTION 22 /* NULL NULL */
1.2925 +#define SQLITE_TRANSACTION 22 /* Operation NULL */
1.2926 #define SQLITE_UPDATE 23 /* Table Name Column Name */
1.2927 #define SQLITE_ATTACH 24 /* Filename NULL */
1.2928 #define SQLITE_DETACH 25 /* Database Name NULL */
1.2929 @@ -1340,7 +2388,8 @@
1.2930 #define SQLITE_ANALYZE 28 /* Table Name NULL */
1.2931 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
1.2932 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
1.2933 -#define SQLITE_FUNCTION 31 /* Function Name NULL */
1.2934 +#define SQLITE_FUNCTION 31 /* NULL Function Name */
1.2935 +#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
1.2936 #define SQLITE_COPY 0 /* No longer used */
1.2937
1.2938 /*
1.2939 @@ -1348,125 +2397,267 @@
1.2940 **
1.2941 ** These routines register callback functions that can be used for
1.2942 ** tracing and profiling the execution of SQL statements.
1.2943 -** The callback function registered by sqlite3_trace() is invoked
1.2944 -** at the first [sqlite3_step()] for the evaluation of an SQL statement.
1.2945 -** The callback function registered by sqlite3_profile() is invoked
1.2946 -** as each SQL statement finishes and includes
1.2947 -** information on how long that statement ran.
1.2948 -**
1.2949 -** The sqlite3_profile() API is currently considered experimental and
1.2950 -** is subject to change.
1.2951 -*/
1.2952 -void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
1.2953 -void *sqlite3_profile(sqlite3*,
1.2954 +**
1.2955 +** ^The callback function registered by sqlite3_trace() is invoked at
1.2956 +** various times when an SQL statement is being run by [sqlite3_step()].
1.2957 +** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
1.2958 +** SQL statement text as the statement first begins executing.
1.2959 +** ^(Additional sqlite3_trace() callbacks might occur
1.2960 +** as each triggered subprogram is entered. The callbacks for triggers
1.2961 +** contain a UTF-8 SQL comment that identifies the trigger.)^
1.2962 +**
1.2963 +** ^The callback function registered by sqlite3_profile() is invoked
1.2964 +** as each SQL statement finishes. ^The profile callback contains
1.2965 +** the original statement text and an estimate of wall-clock time
1.2966 +** of how long that statement took to run. ^The profile callback
1.2967 +** time is in units of nanoseconds, however the current implementation
1.2968 +** is only capable of millisecond resolution so the six least significant
1.2969 +** digits in the time are meaningless. Future versions of SQLite
1.2970 +** might provide greater resolution on the profiler callback. The
1.2971 +** sqlite3_profile() function is considered experimental and is
1.2972 +** subject to change in future versions of SQLite.
1.2973 +*/
1.2974 +SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
1.2975 +SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
1.2976 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
1.2977
1.2978 /*
1.2979 ** CAPI3REF: Query Progress Callbacks
1.2980 **
1.2981 -** This routine configures a callback function - the progress callback - that
1.2982 -** is invoked periodically during long running calls to [sqlite3_exec()],
1.2983 -** [sqlite3_step()] and [sqlite3_get_table()]. An example use for this
1.2984 +** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
1.2985 +** function X to be invoked periodically during long running calls to
1.2986 +** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
1.2987 +** database connection D. An example use for this
1.2988 ** interface is to keep a GUI updated during a large query.
1.2989 **
1.2990 -** The progress callback is invoked once for every N virtual machine opcodes,
1.2991 -** where N is the second argument to this function. The progress callback
1.2992 -** itself is identified by the third argument to this function. The fourth
1.2993 -** argument to this function is a void pointer passed to the progress callback
1.2994 -** function each time it is invoked.
1.2995 -**
1.2996 -** If a call to [sqlite3_exec()], [sqlite3_step()], or [sqlite3_get_table()]
1.2997 -** results in fewer than N opcodes being executed, then the progress
1.2998 -** callback is never invoked.
1.2999 -**
1.3000 -** Only a single progress callback function may be registered for each
1.3001 -** open database connection. Every call to sqlite3_progress_handler()
1.3002 -** overwrites the results of the previous call.
1.3003 -** To remove the progress callback altogether, pass NULL as the third
1.3004 -** argument to this function.
1.3005 -**
1.3006 -** If the progress callback returns a result other than 0, then the current
1.3007 -** query is immediately terminated and any database changes rolled back.
1.3008 -** The containing [sqlite3_exec()], [sqlite3_step()], or
1.3009 -** [sqlite3_get_table()] call returns SQLITE_INTERRUPT. This feature
1.3010 -** can be used, for example, to implement the "Cancel" button on a
1.3011 -** progress dialog box in a GUI.
1.3012 -*/
1.3013 -void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
1.3014 +** ^The parameter P is passed through as the only parameter to the
1.3015 +** callback function X. ^The parameter N is the number of
1.3016 +** [virtual machine instructions] that are evaluated between successive
1.3017 +** invocations of the callback X.
1.3018 +**
1.3019 +** ^Only a single progress handler may be defined at one time per
1.3020 +** [database connection]; setting a new progress handler cancels the
1.3021 +** old one. ^Setting parameter X to NULL disables the progress handler.
1.3022 +** ^The progress handler is also disabled by setting N to a value less
1.3023 +** than 1.
1.3024 +**
1.3025 +** ^If the progress callback returns non-zero, the operation is
1.3026 +** interrupted. This feature can be used to implement a
1.3027 +** "Cancel" button on a GUI progress dialog box.
1.3028 +**
1.3029 +** The progress handler callback must not do anything that will modify
1.3030 +** the database connection that invoked the progress handler.
1.3031 +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1.3032 +** database connections for the meaning of "modify" in this paragraph.
1.3033 +**
1.3034 +*/
1.3035 +SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
1.3036
1.3037 /*
1.3038 ** CAPI3REF: Opening A New Database Connection
1.3039 **
1.3040 -** Open the sqlite database file "filename". The "filename" is UTF-8
1.3041 -** encoded for [sqlite3_open()] and [sqlite3_open_v2()] and UTF-16 encoded
1.3042 -** in the native byte order for [sqlite3_open16()].
1.3043 -** An [sqlite3*] handle is returned in *ppDb, even
1.3044 -** if an error occurs. If the database is opened (or created) successfully,
1.3045 -** then [SQLITE_OK] is returned. Otherwise an error code is returned. The
1.3046 -** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
1.3047 -** an English language description of the error.
1.3048 -**
1.3049 -** The default encoding for the database will be UTF-8 if
1.3050 -** [sqlite3_open()] or [sqlite3_open_v2()] is called and
1.3051 -** UTF-16 if [sqlite3_open16()] is used.
1.3052 -**
1.3053 -** Whether or not an error occurs when it is opened, resources associated
1.3054 -** with the [sqlite3*] handle should be released by passing it to
1.3055 -** [sqlite3_close()] when it is no longer required.
1.3056 -**
1.3057 -** The [sqlite3_open_v2()] interface works like [sqlite3_open()] except that
1.3058 -** provides two additional parameters for additional control over the
1.3059 -** new database connection. The flags parameter can be one of:
1.3060 -**
1.3061 -** <ol>
1.3062 -** <li> [SQLITE_OPEN_READONLY]
1.3063 -** <li> [SQLITE_OPEN_READWRITE]
1.3064 -** <li> [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]
1.3065 -** </ol>
1.3066 -**
1.3067 -** The first value opens the database read-only. If the database does
1.3068 -** not previously exist, an error is returned. The second option opens
1.3069 -** the database for reading and writing if possible, or reading only if
1.3070 -** if the file is write protected. In either case the database must already
1.3071 -** exist or an error is returned. The third option opens the database
1.3072 -** for reading and writing and creates it if it does not already exist.
1.3073 -** The third options is behavior that is always used for [sqlite3_open()]
1.3074 -** and [sqlite3_open16()].
1.3075 -**
1.3076 -** If the filename is ":memory:", then an private
1.3077 -** in-memory database is created for the connection. This in-memory
1.3078 -** database will vanish when the database connection is closed. Future
1.3079 -** version of SQLite might make use of additional special filenames
1.3080 -** that begin with the ":" character. It is recommended that
1.3081 -** when a database filename really does begin with
1.3082 -** ":" that you prefix the filename with a pathname like "./" to
1.3083 -** avoid ambiguity.
1.3084 -**
1.3085 -** If the filename is an empty string, then a private temporary
1.3086 -** on-disk database will be created. This private database will be
1.3087 +** ^These routines open an SQLite database file as specified by the
1.3088 +** filename argument. ^The filename argument is interpreted as UTF-8 for
1.3089 +** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
1.3090 +** order for sqlite3_open16(). ^(A [database connection] handle is usually
1.3091 +** returned in *ppDb, even if an error occurs. The only exception is that
1.3092 +** if SQLite is unable to allocate memory to hold the [sqlite3] object,
1.3093 +** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
1.3094 +** object.)^ ^(If the database is opened (and/or created) successfully, then
1.3095 +** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
1.3096 +** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
1.3097 +** an English language description of the error following a failure of any
1.3098 +** of the sqlite3_open() routines.
1.3099 +**
1.3100 +** ^The default encoding for the database will be UTF-8 if
1.3101 +** sqlite3_open() or sqlite3_open_v2() is called and
1.3102 +** UTF-16 in the native byte order if sqlite3_open16() is used.
1.3103 +**
1.3104 +** Whether or not an error occurs when it is opened, resources
1.3105 +** associated with the [database connection] handle should be released by
1.3106 +** passing it to [sqlite3_close()] when it is no longer required.
1.3107 +**
1.3108 +** The sqlite3_open_v2() interface works like sqlite3_open()
1.3109 +** except that it accepts two additional parameters for additional control
1.3110 +** over the new database connection. ^(The flags parameter to
1.3111 +** sqlite3_open_v2() can take one of
1.3112 +** the following three values, optionally combined with the
1.3113 +** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
1.3114 +** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^
1.3115 +**
1.3116 +** <dl>
1.3117 +** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
1.3118 +** <dd>The database is opened in read-only mode. If the database does not
1.3119 +** already exist, an error is returned.</dd>)^
1.3120 +**
1.3121 +** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
1.3122 +** <dd>The database is opened for reading and writing if possible, or reading
1.3123 +** only if the file is write protected by the operating system. In either
1.3124 +** case the database must already exist, otherwise an error is returned.</dd>)^
1.3125 +**
1.3126 +** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
1.3127 +** <dd>The database is opened for reading and writing, and is created if
1.3128 +** it does not already exist. This is the behavior that is always used for
1.3129 +** sqlite3_open() and sqlite3_open16().</dd>)^
1.3130 +** </dl>
1.3131 +**
1.3132 +** If the 3rd parameter to sqlite3_open_v2() is not one of the
1.3133 +** combinations shown above optionally combined with other
1.3134 +** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
1.3135 +** then the behavior is undefined.
1.3136 +**
1.3137 +** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
1.3138 +** opens in the multi-thread [threading mode] as long as the single-thread
1.3139 +** mode has not been set at compile-time or start-time. ^If the
1.3140 +** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
1.3141 +** in the serialized [threading mode] unless single-thread was
1.3142 +** previously selected at compile-time or start-time.
1.3143 +** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
1.3144 +** eligible to use [shared cache mode], regardless of whether or not shared
1.3145 +** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
1.3146 +** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
1.3147 +** participate in [shared cache mode] even if it is enabled.
1.3148 +**
1.3149 +** ^The fourth parameter to sqlite3_open_v2() is the name of the
1.3150 +** [sqlite3_vfs] object that defines the operating system interface that
1.3151 +** the new database connection should use. ^If the fourth parameter is
1.3152 +** a NULL pointer then the default [sqlite3_vfs] object is used.
1.3153 +**
1.3154 +** ^If the filename is ":memory:", then a private, temporary in-memory database
1.3155 +** is created for the connection. ^This in-memory database will vanish when
1.3156 +** the database connection is closed. Future versions of SQLite might
1.3157 +** make use of additional special filenames that begin with the ":" character.
1.3158 +** It is recommended that when a database filename actually does begin with
1.3159 +** a ":" character you should prefix the filename with a pathname such as
1.3160 +** "./" to avoid ambiguity.
1.3161 +**
1.3162 +** ^If the filename is an empty string, then a private, temporary
1.3163 +** on-disk database will be created. ^This private database will be
1.3164 ** automatically deleted as soon as the database connection is closed.
1.3165 **
1.3166 -** The fourth parameter to sqlite3_open_v2() is the name of the
1.3167 -** [sqlite3_vfs] object that defines the operating system
1.3168 -** interface that the new database connection should use. If the
1.3169 -** fourth parameter is a NULL pointer then the default [sqlite3_vfs]
1.3170 -** object is used.
1.3171 -**
1.3172 -** <b>Note to windows users:</b> The encoding used for the filename argument
1.3173 -** of [sqlite3_open()] and [sqlite3_open_v2()] must be UTF-8, not whatever
1.3174 +** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
1.3175 +**
1.3176 +** ^If [URI filename] interpretation is enabled, and the filename argument
1.3177 +** begins with "file:", then the filename is interpreted as a URI. ^URI
1.3178 +** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
1.3179 +** set in the fourth argument to sqlite3_open_v2(), or if it has
1.3180 +** been enabled globally using the [SQLITE_CONFIG_URI] option with the
1.3181 +** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
1.3182 +** As of SQLite version 3.7.7, URI filename interpretation is turned off
1.3183 +** by default, but future releases of SQLite might enable URI filename
1.3184 +** interpretation by default. See "[URI filenames]" for additional
1.3185 +** information.
1.3186 +**
1.3187 +** URI filenames are parsed according to RFC 3986. ^If the URI contains an
1.3188 +** authority, then it must be either an empty string or the string
1.3189 +** "localhost". ^If the authority is not an empty string or "localhost", an
1.3190 +** error is returned to the caller. ^The fragment component of a URI, if
1.3191 +** present, is ignored.
1.3192 +**
1.3193 +** ^SQLite uses the path component of the URI as the name of the disk file
1.3194 +** which contains the database. ^If the path begins with a '/' character,
1.3195 +** then it is interpreted as an absolute path. ^If the path does not begin
1.3196 +** with a '/' (meaning that the authority section is omitted from the URI)
1.3197 +** then the path is interpreted as a relative path.
1.3198 +** ^On windows, the first component of an absolute path
1.3199 +** is a drive specification (e.g. "C:").
1.3200 +**
1.3201 +** [[core URI query parameters]]
1.3202 +** The query component of a URI may contain parameters that are interpreted
1.3203 +** either by SQLite itself, or by a [VFS | custom VFS implementation].
1.3204 +** SQLite interprets the following three query parameters:
1.3205 +**
1.3206 +** <ul>
1.3207 +** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
1.3208 +** a VFS object that provides the operating system interface that should
1.3209 +** be used to access the database file on disk. ^If this option is set to
1.3210 +** an empty string the default VFS object is used. ^Specifying an unknown
1.3211 +** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
1.3212 +** present, then the VFS specified by the option takes precedence over
1.3213 +** the value passed as the fourth parameter to sqlite3_open_v2().
1.3214 +**
1.3215 +** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
1.3216 +** "rwc", or "memory". Attempting to set it to any other value is
1.3217 +** an error)^.
1.3218 +** ^If "ro" is specified, then the database is opened for read-only
1.3219 +** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
1.3220 +** third argument to sqlite3_prepare_v2(). ^If the mode option is set to
1.3221 +** "rw", then the database is opened for read-write (but not create)
1.3222 +** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
1.3223 +** been set. ^Value "rwc" is equivalent to setting both
1.3224 +** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
1.3225 +** set to "memory" then a pure [in-memory database] that never reads
1.3226 +** or writes from disk is used. ^It is an error to specify a value for
1.3227 +** the mode parameter that is less restrictive than that specified by
1.3228 +** the flags passed in the third parameter to sqlite3_open_v2().
1.3229 +**
1.3230 +** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
1.3231 +** "private". ^Setting it to "shared" is equivalent to setting the
1.3232 +** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
1.3233 +** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
1.3234 +** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
1.3235 +** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
1.3236 +** a URI filename, its value overrides any behaviour requested by setting
1.3237 +** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
1.3238 +** </ul>
1.3239 +**
1.3240 +** ^Specifying an unknown parameter in the query component of a URI is not an
1.3241 +** error. Future versions of SQLite might understand additional query
1.3242 +** parameters. See "[query parameters with special meaning to SQLite]" for
1.3243 +** additional information.
1.3244 +**
1.3245 +** [[URI filename examples]] <h3>URI filename examples</h3>
1.3246 +**
1.3247 +** <table border="1" align=center cellpadding=5>
1.3248 +** <tr><th> URI filenames <th> Results
1.3249 +** <tr><td> file:data.db <td>
1.3250 +** Open the file "data.db" in the current directory.
1.3251 +** <tr><td> file:/home/fred/data.db<br>
1.3252 +** file:///home/fred/data.db <br>
1.3253 +** file://localhost/home/fred/data.db <br> <td>
1.3254 +** Open the database file "/home/fred/data.db".
1.3255 +** <tr><td> file://darkstar/home/fred/data.db <td>
1.3256 +** An error. "darkstar" is not a recognized authority.
1.3257 +** <tr><td style="white-space:nowrap">
1.3258 +** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
1.3259 +** <td> Windows only: Open the file "data.db" on fred's desktop on drive
1.3260 +** C:. Note that the %20 escaping in this example is not strictly
1.3261 +** necessary - space characters can be used literally
1.3262 +** in URI filenames.
1.3263 +** <tr><td> file:data.db?mode=ro&cache=private <td>
1.3264 +** Open file "data.db" in the current directory for read-only access.
1.3265 +** Regardless of whether or not shared-cache mode is enabled by
1.3266 +** default, use a private cache.
1.3267 +** <tr><td> file:/home/fred/data.db?vfs=unix-nolock <td>
1.3268 +** Open file "/home/fred/data.db". Use the special VFS "unix-nolock".
1.3269 +** <tr><td> file:data.db?mode=readonly <td>
1.3270 +** An error. "readonly" is not a valid option for the "mode" parameter.
1.3271 +** </table>
1.3272 +**
1.3273 +** ^URI hexadecimal escape sequences (%HH) are supported within the path and
1.3274 +** query components of a URI. A hexadecimal escape sequence consists of a
1.3275 +** percent sign - "%" - followed by exactly two hexadecimal digits
1.3276 +** specifying an octet value. ^Before the path or query components of a
1.3277 +** URI filename are interpreted, they are encoded using UTF-8 and all
1.3278 +** hexadecimal escape sequences replaced by a single byte containing the
1.3279 +** corresponding octet. If this process generates an invalid UTF-8 encoding,
1.3280 +** the results are undefined.
1.3281 +**
1.3282 +** <b>Note to Windows users:</b> The encoding used for the filename argument
1.3283 +** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
1.3284 ** codepage is currently defined. Filenames containing international
1.3285 ** characters must be converted to UTF-8 prior to passing them into
1.3286 -** [sqlite3_open()] or [sqlite3_open_v2()].
1.3287 -*/
1.3288 -int sqlite3_open(
1.3289 +** sqlite3_open() or sqlite3_open_v2().
1.3290 +*/
1.3291 +SQLITE_API int sqlite3_open(
1.3292 const char *filename, /* Database filename (UTF-8) */
1.3293 sqlite3 **ppDb /* OUT: SQLite db handle */
1.3294 );
1.3295 -int sqlite3_open16(
1.3296 +SQLITE_API int sqlite3_open16(
1.3297 const void *filename, /* Database filename (UTF-16) */
1.3298 sqlite3 **ppDb /* OUT: SQLite db handle */
1.3299 );
1.3300 -int sqlite3_open_v2(
1.3301 +SQLITE_API int sqlite3_open_v2(
1.3302 const char *filename, /* Database filename (UTF-8) */
1.3303 sqlite3 **ppDb, /* OUT: SQLite db handle */
1.3304 int flags, /* Flags */
1.3305 @@ -1474,54 +2665,102 @@
1.3306 );
1.3307
1.3308 /*
1.3309 +** CAPI3REF: Obtain Values For URI Parameters
1.3310 +**
1.3311 +** These are utility routines, useful to VFS implementations, that check
1.3312 +** to see if a database file was a URI that contained a specific query
1.3313 +** parameter, and if so obtains the value of that query parameter.
1.3314 +**
1.3315 +** If F is the database filename pointer passed into the xOpen() method of
1.3316 +** a VFS implementation when the flags parameter to xOpen() has one or
1.3317 +** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
1.3318 +** P is the name of the query parameter, then
1.3319 +** sqlite3_uri_parameter(F,P) returns the value of the P
1.3320 +** parameter if it exists or a NULL pointer if P does not appear as a
1.3321 +** query parameter on F. If P is a query parameter of F
1.3322 +** has no explicit value, then sqlite3_uri_parameter(F,P) returns
1.3323 +** a pointer to an empty string.
1.3324 +**
1.3325 +** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
1.3326 +** parameter and returns true (1) or false (0) according to the value
1.3327 +** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
1.3328 +** value of query parameter P is one of "yes", "true", or "on" in any
1.3329 +** case or if the value begins with a non-zero number. The
1.3330 +** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
1.3331 +** query parameter P is one of "no", "false", or "off" in any case or
1.3332 +** if the value begins with a numeric zero. If P is not a query
1.3333 +** parameter on F or if the value of P is does not match any of the
1.3334 +** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
1.3335 +**
1.3336 +** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
1.3337 +** 64-bit signed integer and returns that integer, or D if P does not
1.3338 +** exist. If the value of P is something other than an integer, then
1.3339 +** zero is returned.
1.3340 +**
1.3341 +** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
1.3342 +** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
1.3343 +** is not a database file pathname pointer that SQLite passed into the xOpen
1.3344 +** VFS method, then the behavior of this routine is undefined and probably
1.3345 +** undesirable.
1.3346 +*/
1.3347 +SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
1.3348 +SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
1.3349 +SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
1.3350 +
1.3351 +
1.3352 +/*
1.3353 ** CAPI3REF: Error Codes And Messages
1.3354 **
1.3355 -** The sqlite3_errcode() interface returns the numeric
1.3356 -** [SQLITE_OK | result code] or [SQLITE_IOERR_READ | extended result code]
1.3357 -** for the most recent failed sqlite3_* API call associated
1.3358 -** with [sqlite3] handle 'db'. If a prior API call failed but the
1.3359 -** most recent API call succeeded, the return value from sqlite3_errcode()
1.3360 -** is undefined.
1.3361 -**
1.3362 -** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
1.3363 -** text that describes the error, as either UTF8 or UTF16 respectively.
1.3364 -** Memory to hold the error message string is managed internally. The
1.3365 -** string may be overwritten or deallocated by subsequent calls to SQLite
1.3366 -** interface functions.
1.3367 -**
1.3368 -** Calls to many sqlite3_* functions set the error code and string returned
1.3369 -** by [sqlite3_errcode()], [sqlite3_errmsg()], and [sqlite3_errmsg16()]
1.3370 -** (overwriting the previous values). Note that calls to [sqlite3_errcode()],
1.3371 -** [sqlite3_errmsg()], and [sqlite3_errmsg16()] themselves do not affect the
1.3372 -** results of future invocations. Calls to API routines that do not return
1.3373 -** an error code (example: [sqlite3_data_count()]) do not
1.3374 -** change the error code returned by this routine. Interfaces that are
1.3375 -** not associated with a specific database connection (examples:
1.3376 -** [sqlite3_mprintf()] or [sqlite3_enable_shared_cache()] do not change
1.3377 -** the return code.
1.3378 -**
1.3379 -** Assuming no other intervening sqlite3_* API calls are made, the error
1.3380 -** code returned by this function is associated with the same error as
1.3381 -** the strings returned by [sqlite3_errmsg()] and [sqlite3_errmsg16()].
1.3382 -*/
1.3383 -int sqlite3_errcode(sqlite3 *db);
1.3384 -const char *sqlite3_errmsg(sqlite3*);
1.3385 -const void *sqlite3_errmsg16(sqlite3*);
1.3386 +** ^The sqlite3_errcode() interface returns the numeric [result code] or
1.3387 +** [extended result code] for the most recent failed sqlite3_* API call
1.3388 +** associated with a [database connection]. If a prior API call failed
1.3389 +** but the most recent API call succeeded, the return value from
1.3390 +** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode()
1.3391 +** interface is the same except that it always returns the
1.3392 +** [extended result code] even when extended result codes are
1.3393 +** disabled.
1.3394 +**
1.3395 +** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
1.3396 +** text that describes the error, as either UTF-8 or UTF-16 respectively.
1.3397 +** ^(Memory to hold the error message string is managed internally.
1.3398 +** The application does not need to worry about freeing the result.
1.3399 +** However, the error string might be overwritten or deallocated by
1.3400 +** subsequent calls to other SQLite interface functions.)^
1.3401 +**
1.3402 +** When the serialized [threading mode] is in use, it might be the
1.3403 +** case that a second error occurs on a separate thread in between
1.3404 +** the time of the first error and the call to these interfaces.
1.3405 +** When that happens, the second error will be reported since these
1.3406 +** interfaces always report the most recent result. To avoid
1.3407 +** this, each thread can obtain exclusive use of the [database connection] D
1.3408 +** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
1.3409 +** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
1.3410 +** all calls to the interfaces listed here are completed.
1.3411 +**
1.3412 +** If an interface fails with SQLITE_MISUSE, that means the interface
1.3413 +** was invoked incorrectly by the application. In that case, the
1.3414 +** error code and message may or may not be set.
1.3415 +*/
1.3416 +SQLITE_API int sqlite3_errcode(sqlite3 *db);
1.3417 +SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
1.3418 +SQLITE_API const char *sqlite3_errmsg(sqlite3*);
1.3419 +SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
1.3420
1.3421 /*
1.3422 ** CAPI3REF: SQL Statement Object
1.3423 -**
1.3424 -** Instance of this object represent single SQL statements. This
1.3425 -** is variously known as a "prepared statement" or a
1.3426 +** KEYWORDS: {prepared statement} {prepared statements}
1.3427 +**
1.3428 +** An instance of this object represents a single SQL statement.
1.3429 +** This object is variously known as a "prepared statement" or a
1.3430 ** "compiled SQL statement" or simply as a "statement".
1.3431 -**
1.3432 +**
1.3433 ** The life of a statement object goes something like this:
1.3434 **
1.3435 ** <ol>
1.3436 ** <li> Create the object using [sqlite3_prepare_v2()] or a related
1.3437 ** function.
1.3438 -** <li> Bind values to host parameters using
1.3439 -** [sqlite3_bind_blob | sqlite3_bind_* interfaces].
1.3440 +** <li> Bind values to [host parameters] using the sqlite3_bind_*()
1.3441 +** interfaces.
1.3442 ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
1.3443 ** <li> Reset the statement using [sqlite3_reset()] then go back
1.3444 ** to step 2. Do this zero or more times.
1.3445 @@ -1534,96 +2773,213 @@
1.3446 typedef struct sqlite3_stmt sqlite3_stmt;
1.3447
1.3448 /*
1.3449 +** CAPI3REF: Run-time Limits
1.3450 +**
1.3451 +** ^(This interface allows the size of various constructs to be limited
1.3452 +** on a connection by connection basis. The first parameter is the
1.3453 +** [database connection] whose limit is to be set or queried. The
1.3454 +** second parameter is one of the [limit categories] that define a
1.3455 +** class of constructs to be size limited. The third parameter is the
1.3456 +** new limit for that construct.)^
1.3457 +**
1.3458 +** ^If the new limit is a negative number, the limit is unchanged.
1.3459 +** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
1.3460 +** [limits | hard upper bound]
1.3461 +** set at compile-time by a C preprocessor macro called
1.3462 +** [limits | SQLITE_MAX_<i>NAME</i>].
1.3463 +** (The "_LIMIT_" in the name is changed to "_MAX_".))^
1.3464 +** ^Attempts to increase a limit above its hard upper bound are
1.3465 +** silently truncated to the hard upper bound.
1.3466 +**
1.3467 +** ^Regardless of whether or not the limit was changed, the
1.3468 +** [sqlite3_limit()] interface returns the prior value of the limit.
1.3469 +** ^Hence, to find the current value of a limit without changing it,
1.3470 +** simply invoke this interface with the third parameter set to -1.
1.3471 +**
1.3472 +** Run-time limits are intended for use in applications that manage
1.3473 +** both their own internal database and also databases that are controlled
1.3474 +** by untrusted external sources. An example application might be a
1.3475 +** web browser that has its own databases for storing history and
1.3476 +** separate databases controlled by JavaScript applications downloaded
1.3477 +** off the Internet. The internal databases can be given the
1.3478 +** large, default limits. Databases managed by external sources can
1.3479 +** be given much smaller limits designed to prevent a denial of service
1.3480 +** attack. Developers might also want to use the [sqlite3_set_authorizer()]
1.3481 +** interface to further control untrusted SQL. The size of the database
1.3482 +** created by an untrusted script can be contained using the
1.3483 +** [max_page_count] [PRAGMA].
1.3484 +**
1.3485 +** New run-time limit categories may be added in future releases.
1.3486 +*/
1.3487 +SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
1.3488 +
1.3489 +/*
1.3490 +** CAPI3REF: Run-Time Limit Categories
1.3491 +** KEYWORDS: {limit category} {*limit categories}
1.3492 +**
1.3493 +** These constants define various performance limits
1.3494 +** that can be lowered at run-time using [sqlite3_limit()].
1.3495 +** The synopsis of the meanings of the various limits is shown below.
1.3496 +** Additional information is available at [limits | Limits in SQLite].
1.3497 +**
1.3498 +** <dl>
1.3499 +** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
1.3500 +** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
1.3501 +**
1.3502 +** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
1.3503 +** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
1.3504 +**
1.3505 +** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
1.3506 +** <dd>The maximum number of columns in a table definition or in the
1.3507 +** result set of a [SELECT] or the maximum number of columns in an index
1.3508 +** or in an ORDER BY or GROUP BY clause.</dd>)^
1.3509 +**
1.3510 +** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
1.3511 +** <dd>The maximum depth of the parse tree on any expression.</dd>)^
1.3512 +**
1.3513 +** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
1.3514 +** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
1.3515 +**
1.3516 +** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
1.3517 +** <dd>The maximum number of instructions in a virtual machine program
1.3518 +** used to implement an SQL statement. This limit is not currently
1.3519 +** enforced, though that might be added in some future release of
1.3520 +** SQLite.</dd>)^
1.3521 +**
1.3522 +** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
1.3523 +** <dd>The maximum number of arguments on a function.</dd>)^
1.3524 +**
1.3525 +** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
1.3526 +** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
1.3527 +**
1.3528 +** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
1.3529 +** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
1.3530 +** <dd>The maximum length of the pattern argument to the [LIKE] or
1.3531 +** [GLOB] operators.</dd>)^
1.3532 +**
1.3533 +** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
1.3534 +** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
1.3535 +** <dd>The maximum index number of any [parameter] in an SQL statement.)^
1.3536 +**
1.3537 +** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
1.3538 +** <dd>The maximum depth of recursion for triggers.</dd>)^
1.3539 +** </dl>
1.3540 +*/
1.3541 +#define SQLITE_LIMIT_LENGTH 0
1.3542 +#define SQLITE_LIMIT_SQL_LENGTH 1
1.3543 +#define SQLITE_LIMIT_COLUMN 2
1.3544 +#define SQLITE_LIMIT_EXPR_DEPTH 3
1.3545 +#define SQLITE_LIMIT_COMPOUND_SELECT 4
1.3546 +#define SQLITE_LIMIT_VDBE_OP 5
1.3547 +#define SQLITE_LIMIT_FUNCTION_ARG 6
1.3548 +#define SQLITE_LIMIT_ATTACHED 7
1.3549 +#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
1.3550 +#define SQLITE_LIMIT_VARIABLE_NUMBER 9
1.3551 +#define SQLITE_LIMIT_TRIGGER_DEPTH 10
1.3552 +
1.3553 +/*
1.3554 ** CAPI3REF: Compiling An SQL Statement
1.3555 +** KEYWORDS: {SQL statement compiler}
1.3556 **
1.3557 ** To execute an SQL query, it must first be compiled into a byte-code
1.3558 -** program using one of these routines.
1.3559 -**
1.3560 -** The first argument "db" is an [sqlite3 | SQLite database handle]
1.3561 -** obtained from a prior call to [sqlite3_open()], [sqlite3_open_v2()]
1.3562 -** or [sqlite3_open16()].
1.3563 -** The second argument "zSql" is the statement to be compiled, encoded
1.3564 +** program using one of these routines.
1.3565 +**
1.3566 +** The first argument, "db", is a [database connection] obtained from a
1.3567 +** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
1.3568 +** [sqlite3_open16()]. The database connection must not have been closed.
1.3569 +**
1.3570 +** The second argument, "zSql", is the statement to be compiled, encoded
1.3571 ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
1.3572 -** interfaces uses UTF-8 and sqlite3_prepare16() and sqlite3_prepare16_v2()
1.3573 +** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
1.3574 ** use UTF-16.
1.3575 **
1.3576 -** If the nByte argument is less
1.3577 -** than zero, then zSql is read up to the first zero terminator. If
1.3578 -** nByte is non-negative, then it is the maximum number of
1.3579 -** bytes read from zSql. When nByte is non-negative, the
1.3580 -** zSql string ends at either the first '\000' character or
1.3581 -** until the nByte-th byte, whichever comes first.
1.3582 -**
1.3583 -** *pzTail is made to point to the first byte past the end of the first
1.3584 -** SQL statement in zSql. This routine only compiles the first statement
1.3585 -** in zSql, so *pzTail is left pointing to what remains uncompiled.
1.3586 -**
1.3587 -** *ppStmt is left pointing to a compiled
1.3588 -** [sqlite3_stmt | SQL statement structure] that can be
1.3589 -** executed using [sqlite3_step()]. Or if there is an error, *ppStmt may be
1.3590 -** set to NULL. If the input text contained no SQL (if the input is and
1.3591 -** empty string or a comment) then *ppStmt is set to NULL. The calling
1.3592 -** procedure is responsible for deleting the compiled SQL statement
1.3593 -** using [sqlite3_finalize()] after it has finished with it.
1.3594 -**
1.3595 -** On success, [SQLITE_OK] is returned. Otherwise an
1.3596 -** [SQLITE_ERROR | error code] is returned.
1.3597 +** ^If the nByte argument is less than zero, then zSql is read up to the
1.3598 +** first zero terminator. ^If nByte is non-negative, then it is the maximum
1.3599 +** number of bytes read from zSql. ^When nByte is non-negative, the
1.3600 +** zSql string ends at either the first '\000' or '\u0000' character or
1.3601 +** the nByte-th byte, whichever comes first. If the caller knows
1.3602 +** that the supplied string is nul-terminated, then there is a small
1.3603 +** performance advantage to be gained by passing an nByte parameter that
1.3604 +** is equal to the number of bytes in the input string <i>including</i>
1.3605 +** the nul-terminator bytes as this saves SQLite from having to
1.3606 +** make a copy of the input string.
1.3607 +**
1.3608 +** ^If pzTail is not NULL then *pzTail is made to point to the first byte
1.3609 +** past the end of the first SQL statement in zSql. These routines only
1.3610 +** compile the first statement in zSql, so *pzTail is left pointing to
1.3611 +** what remains uncompiled.
1.3612 +**
1.3613 +** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
1.3614 +** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
1.3615 +** to NULL. ^If the input text contains no SQL (if the input is an empty
1.3616 +** string or a comment) then *ppStmt is set to NULL.
1.3617 +** The calling procedure is responsible for deleting the compiled
1.3618 +** SQL statement using [sqlite3_finalize()] after it has finished with it.
1.3619 +** ppStmt may not be NULL.
1.3620 +**
1.3621 +** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
1.3622 +** otherwise an [error code] is returned.
1.3623 **
1.3624 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
1.3625 ** recommended for all new programs. The two older interfaces are retained
1.3626 ** for backwards compatibility, but their use is discouraged.
1.3627 -** In the "v2" interfaces, the prepared statement
1.3628 -** that is returned (the [sqlite3_stmt] object) contains a copy of the
1.3629 +** ^In the "v2" interfaces, the prepared statement
1.3630 +** that is returned (the [sqlite3_stmt] object) contains a copy of the
1.3631 ** original SQL text. This causes the [sqlite3_step()] interface to
1.3632 -** behave a differently in two ways:
1.3633 +** behave differently in three ways:
1.3634 **
1.3635 ** <ol>
1.3636 ** <li>
1.3637 -** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
1.3638 +** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
1.3639 ** always used to do, [sqlite3_step()] will automatically recompile the SQL
1.3640 -** statement and try to run it again. If the schema has changed in a way
1.3641 -** that makes the statement no longer valid, [sqlite3_step()] will still
1.3642 -** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is
1.3643 -** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the
1.3644 -** error go away. Note: use [sqlite3_errmsg()] to find the text of the parsing
1.3645 -** error that results in an [SQLITE_SCHEMA] return.
1.3646 +** statement and try to run it again.
1.3647 +** </li>
1.3648 +**
1.3649 +** <li>
1.3650 +** ^When an error occurs, [sqlite3_step()] will return one of the detailed
1.3651 +** [error codes] or [extended error codes]. ^The legacy behavior was that
1.3652 +** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
1.3653 +** and the application would have to make a second call to [sqlite3_reset()]
1.3654 +** in order to find the underlying cause of the problem. With the "v2" prepare
1.3655 +** interfaces, the underlying reason for the error is returned immediately.
1.3656 ** </li>
1.3657 **
1.3658 ** <li>
1.3659 -** When an error occurs,
1.3660 -** [sqlite3_step()] will return one of the detailed
1.3661 -** [SQLITE_ERROR | result codes] or
1.3662 -** [SQLITE_IOERR_READ | extended result codes] such as directly.
1.3663 -** The legacy behavior was that [sqlite3_step()] would only return a generic
1.3664 -** [SQLITE_ERROR] result code and you would have to make a second call to
1.3665 -** [sqlite3_reset()] in order to find the underlying cause of the problem.
1.3666 -** With the "v2" prepare interfaces, the underlying reason for the error is
1.3667 -** returned immediately.
1.3668 +** ^If the specific value bound to [parameter | host parameter] in the
1.3669 +** WHERE clause might influence the choice of query plan for a statement,
1.3670 +** then the statement will be automatically recompiled, as if there had been
1.3671 +** a schema change, on the first [sqlite3_step()] call following any change
1.3672 +** to the [sqlite3_bind_text | bindings] of that [parameter].
1.3673 +** ^The specific value of WHERE-clause [parameter] might influence the
1.3674 +** choice of query plan if the parameter is the left-hand side of a [LIKE]
1.3675 +** or [GLOB] operator or if the parameter is compared to an indexed column
1.3676 +** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
1.3677 +** the
1.3678 ** </li>
1.3679 ** </ol>
1.3680 */
1.3681 -int sqlite3_prepare(
1.3682 +SQLITE_API int sqlite3_prepare(
1.3683 sqlite3 *db, /* Database handle */
1.3684 const char *zSql, /* SQL statement, UTF-8 encoded */
1.3685 int nByte, /* Maximum length of zSql in bytes. */
1.3686 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
1.3687 const char **pzTail /* OUT: Pointer to unused portion of zSql */
1.3688 );
1.3689 -int sqlite3_prepare_v2(
1.3690 +SQLITE_API int sqlite3_prepare_v2(
1.3691 sqlite3 *db, /* Database handle */
1.3692 const char *zSql, /* SQL statement, UTF-8 encoded */
1.3693 int nByte, /* Maximum length of zSql in bytes. */
1.3694 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
1.3695 const char **pzTail /* OUT: Pointer to unused portion of zSql */
1.3696 );
1.3697 -int sqlite3_prepare16(
1.3698 +SQLITE_API int sqlite3_prepare16(
1.3699 sqlite3 *db, /* Database handle */
1.3700 const void *zSql, /* SQL statement, UTF-16 encoded */
1.3701 int nByte, /* Maximum length of zSql in bytes. */
1.3702 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
1.3703 const void **pzTail /* OUT: Pointer to unused portion of zSql */
1.3704 );
1.3705 -int sqlite3_prepare16_v2(
1.3706 +SQLITE_API int sqlite3_prepare16_v2(
1.3707 sqlite3 *db, /* Database handle */
1.3708 const void *zSql, /* SQL statement, UTF-16 encoded */
1.3709 int nByte, /* Maximum length of zSql in bytes. */
1.3710 @@ -1632,367 +2988,516 @@
1.3711 );
1.3712
1.3713 /*
1.3714 -** CAPI3REF: Dynamically Typed Value Object
1.3715 -**
1.3716 -** SQLite uses dynamic typing for the values it stores. Values can
1.3717 -** be integers, floating point values, strings, BLOBs, or NULL. When
1.3718 -** passing around values internally, each value is represented as
1.3719 -** an instance of the sqlite3_value object.
1.3720 +** CAPI3REF: Retrieving Statement SQL
1.3721 +**
1.3722 +** ^This interface can be used to retrieve a saved copy of the original
1.3723 +** SQL text used to create a [prepared statement] if that statement was
1.3724 +** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
1.3725 +*/
1.3726 +SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
1.3727 +
1.3728 +/*
1.3729 +** CAPI3REF: Determine If An SQL Statement Writes The Database
1.3730 +**
1.3731 +** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
1.3732 +** and only if the [prepared statement] X makes no direct changes to
1.3733 +** the content of the database file.
1.3734 +**
1.3735 +** Note that [application-defined SQL functions] or
1.3736 +** [virtual tables] might change the database indirectly as a side effect.
1.3737 +** ^(For example, if an application defines a function "eval()" that
1.3738 +** calls [sqlite3_exec()], then the following SQL statement would
1.3739 +** change the database file through side-effects:
1.3740 +**
1.3741 +** <blockquote><pre>
1.3742 +** SELECT eval('DELETE FROM t1') FROM t2;
1.3743 +** </pre></blockquote>
1.3744 +**
1.3745 +** But because the [SELECT] statement does not change the database file
1.3746 +** directly, sqlite3_stmt_readonly() would still return true.)^
1.3747 +**
1.3748 +** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
1.3749 +** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
1.3750 +** since the statements themselves do not actually modify the database but
1.3751 +** rather they control the timing of when other statements modify the
1.3752 +** database. ^The [ATTACH] and [DETACH] statements also cause
1.3753 +** sqlite3_stmt_readonly() to return true since, while those statements
1.3754 +** change the configuration of a database connection, they do not make
1.3755 +** changes to the content of the database files on disk.
1.3756 +*/
1.3757 +SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
1.3758 +
1.3759 +/*
1.3760 +** CAPI3REF: Determine If A Prepared Statement Has Been Reset
1.3761 +**
1.3762 +** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
1.3763 +** [prepared statement] S has been stepped at least once using
1.3764 +** [sqlite3_step(S)] but has not run to completion and/or has not
1.3765 +** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
1.3766 +** interface returns false if S is a NULL pointer. If S is not a
1.3767 +** NULL pointer and is not a pointer to a valid [prepared statement]
1.3768 +** object, then the behavior is undefined and probably undesirable.
1.3769 +**
1.3770 +** This interface can be used in combination [sqlite3_next_stmt()]
1.3771 +** to locate all prepared statements associated with a database
1.3772 +** connection that are in need of being reset. This can be used,
1.3773 +** for example, in diagnostic routines to search for prepared
1.3774 +** statements that are holding a transaction open.
1.3775 +*/
1.3776 +SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
1.3777 +
1.3778 +/*
1.3779 +** CAPI3REF: Dynamically Typed Value Object
1.3780 +** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
1.3781 +**
1.3782 +** SQLite uses the sqlite3_value object to represent all values
1.3783 +** that can be stored in a database table. SQLite uses dynamic typing
1.3784 +** for the values it stores. ^Values stored in sqlite3_value objects
1.3785 +** can be integers, floating point values, strings, BLOBs, or NULL.
1.3786 +**
1.3787 +** An sqlite3_value object may be either "protected" or "unprotected".
1.3788 +** Some interfaces require a protected sqlite3_value. Other interfaces
1.3789 +** will accept either a protected or an unprotected sqlite3_value.
1.3790 +** Every interface that accepts sqlite3_value arguments specifies
1.3791 +** whether or not it requires a protected sqlite3_value.
1.3792 +**
1.3793 +** The terms "protected" and "unprotected" refer to whether or not
1.3794 +** a mutex is held. An internal mutex is held for a protected
1.3795 +** sqlite3_value object but no mutex is held for an unprotected
1.3796 +** sqlite3_value object. If SQLite is compiled to be single-threaded
1.3797 +** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
1.3798 +** or if SQLite is run in one of reduced mutex modes
1.3799 +** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
1.3800 +** then there is no distinction between protected and unprotected
1.3801 +** sqlite3_value objects and they can be used interchangeably. However,
1.3802 +** for maximum code portability it is recommended that applications
1.3803 +** still make the distinction between protected and unprotected
1.3804 +** sqlite3_value objects even when not strictly required.
1.3805 +**
1.3806 +** ^The sqlite3_value objects that are passed as parameters into the
1.3807 +** implementation of [application-defined SQL functions] are protected.
1.3808 +** ^The sqlite3_value object returned by
1.3809 +** [sqlite3_column_value()] is unprotected.
1.3810 +** Unprotected sqlite3_value objects may only be used with
1.3811 +** [sqlite3_result_value()] and [sqlite3_bind_value()].
1.3812 +** The [sqlite3_value_blob | sqlite3_value_type()] family of
1.3813 +** interfaces require protected sqlite3_value objects.
1.3814 */
1.3815 typedef struct Mem sqlite3_value;
1.3816
1.3817 /*
1.3818 -** CAPI3REF: SQL Function Context Object
1.3819 +** CAPI3REF: SQL Function Context Object
1.3820 **
1.3821 ** The context in which an SQL function executes is stored in an
1.3822 -** sqlite3_context object. A pointer to such an object is the
1.3823 -** first parameter to user-defined SQL functions.
1.3824 +** sqlite3_context object. ^A pointer to an sqlite3_context object
1.3825 +** is always first parameter to [application-defined SQL functions].
1.3826 +** The application-defined SQL function implementation will pass this
1.3827 +** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
1.3828 +** [sqlite3_aggregate_context()], [sqlite3_user_data()],
1.3829 +** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
1.3830 +** and/or [sqlite3_set_auxdata()].
1.3831 */
1.3832 typedef struct sqlite3_context sqlite3_context;
1.3833
1.3834 /*
1.3835 -** CAPI3REF: Binding Values To Prepared Statements
1.3836 -**
1.3837 -** In the SQL strings input to [sqlite3_prepare_v2()] and its variants,
1.3838 -** one or more literals can be replace by a parameter in one of these
1.3839 -** forms:
1.3840 +** CAPI3REF: Binding Values To Prepared Statements
1.3841 +** KEYWORDS: {host parameter} {host parameters} {host parameter name}
1.3842 +** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
1.3843 +**
1.3844 +** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
1.3845 +** literals may be replaced by a [parameter] that matches one of following
1.3846 +** templates:
1.3847 **
1.3848 ** <ul>
1.3849 ** <li> ?
1.3850 ** <li> ?NNN
1.3851 -** <li> :AAA
1.3852 -** <li> @AAA
1.3853 +** <li> :VVV
1.3854 +** <li> @VVV
1.3855 ** <li> $VVV
1.3856 ** </ul>
1.3857 **
1.3858 -** In the parameter forms shown above NNN is an integer literal,
1.3859 -** AAA is an alphanumeric identifier and VVV is a variable name according
1.3860 -** to the syntax rules of the TCL programming language.
1.3861 -** The values of these parameters (also called "host parameter names")
1.3862 +** In the templates above, NNN represents an integer literal,
1.3863 +** and VVV represents an alphanumeric identifier.)^ ^The values of these
1.3864 +** parameters (also called "host parameter names" or "SQL parameters")
1.3865 ** can be set using the sqlite3_bind_*() routines defined here.
1.3866 **
1.3867 -** The first argument to the sqlite3_bind_*() routines always is a pointer
1.3868 -** to the [sqlite3_stmt] object returned from [sqlite3_prepare_v2()] or
1.3869 -** its variants. The second
1.3870 -** argument is the index of the parameter to be set. The first parameter has
1.3871 -** an index of 1. When the same named parameter is used more than once, second
1.3872 -** and subsequent
1.3873 -** occurrences have the same index as the first occurrence. The index for
1.3874 -** named parameters can be looked up using the
1.3875 -** [sqlite3_bind_parameter_name()] API if desired. The index for "?NNN"
1.3876 -** parametes is the value of NNN.
1.3877 -** The NNN value must be between 1 and the compile-time
1.3878 -** parameter SQLITE_MAX_VARIABLE_NUMBER (default value: 999).
1.3879 -** See <a href="limits.html">limits.html</a> for additional information.
1.3880 -**
1.3881 -** The third argument is the value to bind to the parameter.
1.3882 -**
1.3883 -** In those
1.3884 -** routines that have a fourth argument, its value is the number of bytes
1.3885 -** in the parameter. To be clear: the value is the number of bytes in the
1.3886 -** string, not the number of characters. The number
1.3887 -** of bytes does not include the zero-terminator at the end of strings.
1.3888 -** If the fourth parameter is negative, the length of the string is
1.3889 -** number of bytes up to the first zero terminator.
1.3890 -**
1.3891 -** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
1.3892 +** ^The first argument to the sqlite3_bind_*() routines is always
1.3893 +** a pointer to the [sqlite3_stmt] object returned from
1.3894 +** [sqlite3_prepare_v2()] or its variants.
1.3895 +**
1.3896 +** ^The second argument is the index of the SQL parameter to be set.
1.3897 +** ^The leftmost SQL parameter has an index of 1. ^When the same named
1.3898 +** SQL parameter is used more than once, second and subsequent
1.3899 +** occurrences have the same index as the first occurrence.
1.3900 +** ^The index for named parameters can be looked up using the
1.3901 +** [sqlite3_bind_parameter_index()] API if desired. ^The index
1.3902 +** for "?NNN" parameters is the value of NNN.
1.3903 +** ^The NNN value must be between 1 and the [sqlite3_limit()]
1.3904 +** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
1.3905 +**
1.3906 +** ^The third argument is the value to bind to the parameter.
1.3907 +**
1.3908 +** ^(In those routines that have a fourth argument, its value is the
1.3909 +** number of bytes in the parameter. To be clear: the value is the
1.3910 +** number of <u>bytes</u> in the value, not the number of characters.)^
1.3911 +** ^If the fourth parameter is negative, the length of the string is
1.3912 +** the number of bytes up to the first zero terminator.
1.3913 +** If a non-negative fourth parameter is provided to sqlite3_bind_text()
1.3914 +** or sqlite3_bind_text16() then that parameter must be the byte offset
1.3915 +** where the NUL terminator would occur assuming the string were NUL
1.3916 +** terminated. If any NUL characters occur at byte offsets less than
1.3917 +** the value of the fourth parameter then the resulting string value will
1.3918 +** contain embedded NULs. The result of expressions involving strings
1.3919 +** with embedded NULs is undefined.
1.3920 +**
1.3921 +** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
1.3922 ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
1.3923 -** text after SQLite has finished with it. If the fifth argument is the
1.3924 -** special value [SQLITE_STATIC], then the library assumes that the information
1.3925 -** is in static, unmanaged space and does not need to be freed. If the
1.3926 -** fifth argument has the value [SQLITE_TRANSIENT], then SQLite makes its
1.3927 -** own private copy of the data immediately, before the sqlite3_bind_*()
1.3928 -** routine returns.
1.3929 -**
1.3930 -** The sqlite3_bind_zeroblob() routine binds a BLOB of length n that
1.3931 -** is filled with zeros. A zeroblob uses a fixed amount of memory
1.3932 -** (just an integer to hold it size) while it is being processed.
1.3933 -** Zeroblobs are intended to serve as place-holders for BLOBs whose
1.3934 -** content is later written using
1.3935 -** [sqlite3_blob_open | increment BLOB I/O] routines. A negative
1.3936 -** value for the zeroblob results in a zero-length BLOB.
1.3937 -**
1.3938 -** The sqlite3_bind_*() routines must be called after
1.3939 -** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and
1.3940 -** before [sqlite3_step()].
1.3941 -** Bindings are not cleared by the [sqlite3_reset()] routine.
1.3942 -** Unbound parameters are interpreted as NULL.
1.3943 -**
1.3944 -** These routines return [SQLITE_OK] on success or an error code if
1.3945 -** anything goes wrong. [SQLITE_RANGE] is returned if the parameter
1.3946 -** index is out of range. [SQLITE_NOMEM] is returned if malloc fails.
1.3947 -** [SQLITE_MISUSE] is returned if these routines are called on a virtual
1.3948 -** machine that is the wrong state or which has already been finalized.
1.3949 -*/
1.3950 -int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
1.3951 -int sqlite3_bind_double(sqlite3_stmt*, int, double);
1.3952 -int sqlite3_bind_int(sqlite3_stmt*, int, int);
1.3953 -int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
1.3954 -int sqlite3_bind_null(sqlite3_stmt*, int);
1.3955 -int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
1.3956 -int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
1.3957 -int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
1.3958 -int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
1.3959 -
1.3960 -/*
1.3961 -** CAPI3REF: Number Of Host Parameters
1.3962 -**
1.3963 -** Return the largest host parameter index in the precompiled statement given
1.3964 -** as the argument. When the host parameters are of the forms like ":AAA"
1.3965 -** or "?", then they are assigned sequential increasing numbers beginning
1.3966 -** with one, so the value returned is the number of parameters. However
1.3967 -** if the same host parameter name is used multiple times, each occurrance
1.3968 -** is given the same number, so the value returned in that case is the number
1.3969 -** of unique host parameter names. If host parameters of the form "?NNN"
1.3970 -** are used (where NNN is an integer) then there might be gaps in the
1.3971 -** numbering and the value returned by this interface is the index of the
1.3972 -** host parameter with the largest index value.
1.3973 -**
1.3974 -** The prepared statement must not be [sqlite3_finalize | finalized]
1.3975 -** prior to this routine returnning. Otherwise the results are undefined
1.3976 -** and probably undesirable.
1.3977 -*/
1.3978 -int sqlite3_bind_parameter_count(sqlite3_stmt*);
1.3979 +** string after SQLite has finished with it. ^The destructor is called
1.3980 +** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(),
1.3981 +** sqlite3_bind_text(), or sqlite3_bind_text16() fails.
1.3982 +** ^If the fifth argument is
1.3983 +** the special value [SQLITE_STATIC], then SQLite assumes that the
1.3984 +** information is in static, unmanaged space and does not need to be freed.
1.3985 +** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
1.3986 +** SQLite makes its own private copy of the data immediately, before
1.3987 +** the sqlite3_bind_*() routine returns.
1.3988 +**
1.3989 +** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
1.3990 +** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
1.3991 +** (just an integer to hold its size) while it is being processed.
1.3992 +** Zeroblobs are intended to serve as placeholders for BLOBs whose
1.3993 +** content is later written using
1.3994 +** [sqlite3_blob_open | incremental BLOB I/O] routines.
1.3995 +** ^A negative value for the zeroblob results in a zero-length BLOB.
1.3996 +**
1.3997 +** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
1.3998 +** for the [prepared statement] or with a prepared statement for which
1.3999 +** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
1.4000 +** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
1.4001 +** routine is passed a [prepared statement] that has been finalized, the
1.4002 +** result is undefined and probably harmful.
1.4003 +**
1.4004 +** ^Bindings are not cleared by the [sqlite3_reset()] routine.
1.4005 +** ^Unbound parameters are interpreted as NULL.
1.4006 +**
1.4007 +** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
1.4008 +** [error code] if anything goes wrong.
1.4009 +** ^[SQLITE_RANGE] is returned if the parameter
1.4010 +** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
1.4011 +**
1.4012 +** See also: [sqlite3_bind_parameter_count()],
1.4013 +** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
1.4014 +*/
1.4015 +SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
1.4016 +SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
1.4017 +SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
1.4018 +SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
1.4019 +SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
1.4020 +SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
1.4021 +SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
1.4022 +SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
1.4023 +SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
1.4024 +
1.4025 +/*
1.4026 +** CAPI3REF: Number Of SQL Parameters
1.4027 +**
1.4028 +** ^This routine can be used to find the number of [SQL parameters]
1.4029 +** in a [prepared statement]. SQL parameters are tokens of the
1.4030 +** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
1.4031 +** placeholders for values that are [sqlite3_bind_blob | bound]
1.4032 +** to the parameters at a later time.
1.4033 +**
1.4034 +** ^(This routine actually returns the index of the largest (rightmost)
1.4035 +** parameter. For all forms except ?NNN, this will correspond to the
1.4036 +** number of unique parameters. If parameters of the ?NNN form are used,
1.4037 +** there may be gaps in the list.)^
1.4038 +**
1.4039 +** See also: [sqlite3_bind_blob|sqlite3_bind()],
1.4040 +** [sqlite3_bind_parameter_name()], and
1.4041 +** [sqlite3_bind_parameter_index()].
1.4042 +*/
1.4043 +SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
1.4044
1.4045 /*
1.4046 ** CAPI3REF: Name Of A Host Parameter
1.4047 **
1.4048 -** This routine returns a pointer to the name of the n-th parameter in a
1.4049 -** [sqlite3_stmt | prepared statement].
1.4050 -** Host parameters of the form ":AAA" or "@AAA" or "$VVV" have a name
1.4051 -** which is the string ":AAA" or "@AAA" or "$VVV".
1.4052 -** In other words, the initial ":" or "$" or "@"
1.4053 -** is included as part of the name.
1.4054 -** Parameters of the form "?" or "?NNN" have no name.
1.4055 -**
1.4056 -** The first bound parameter has an index of 1, not 0.
1.4057 -**
1.4058 -** If the value n is out of range or if the n-th parameter is nameless,
1.4059 -** then NULL is returned. The returned string is always in the
1.4060 -** UTF-8 encoding even if the named parameter was originally specified
1.4061 -** as UTF-16 in [sqlite3_prepare16()] or [sqlite3_prepare16_v2()].
1.4062 -*/
1.4063 -const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
1.4064 +** ^The sqlite3_bind_parameter_name(P,N) interface returns
1.4065 +** the name of the N-th [SQL parameter] in the [prepared statement] P.
1.4066 +** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
1.4067 +** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
1.4068 +** respectively.
1.4069 +** In other words, the initial ":" or "$" or "@" or "?"
1.4070 +** is included as part of the name.)^
1.4071 +** ^Parameters of the form "?" without a following integer have no name
1.4072 +** and are referred to as "nameless" or "anonymous parameters".
1.4073 +**
1.4074 +** ^The first host parameter has an index of 1, not 0.
1.4075 +**
1.4076 +** ^If the value N is out of range or if the N-th parameter is
1.4077 +** nameless, then NULL is returned. ^The returned string is
1.4078 +** always in UTF-8 encoding even if the named parameter was
1.4079 +** originally specified as UTF-16 in [sqlite3_prepare16()] or
1.4080 +** [sqlite3_prepare16_v2()].
1.4081 +**
1.4082 +** See also: [sqlite3_bind_blob|sqlite3_bind()],
1.4083 +** [sqlite3_bind_parameter_count()], and
1.4084 +** [sqlite3_bind_parameter_index()].
1.4085 +*/
1.4086 +SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
1.4087
1.4088 /*
1.4089 ** CAPI3REF: Index Of A Parameter With A Given Name
1.4090 **
1.4091 -** This routine returns the index of a host parameter with the given name.
1.4092 -** The name must match exactly. If no parameter with the given name is
1.4093 -** found, return 0. Parameter names must be UTF8.
1.4094 -*/
1.4095 -int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
1.4096 +** ^Return the index of an SQL parameter given its name. ^The
1.4097 +** index value returned is suitable for use as the second
1.4098 +** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
1.4099 +** is returned if no matching parameter is found. ^The parameter
1.4100 +** name must be given in UTF-8 even if the original statement
1.4101 +** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
1.4102 +**
1.4103 +** See also: [sqlite3_bind_blob|sqlite3_bind()],
1.4104 +** [sqlite3_bind_parameter_count()], and
1.4105 +** [sqlite3_bind_parameter_index()].
1.4106 +*/
1.4107 +SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
1.4108
1.4109 /*
1.4110 ** CAPI3REF: Reset All Bindings On A Prepared Statement
1.4111 **
1.4112 -** Contrary to the intuition of many, [sqlite3_reset()] does not
1.4113 -** reset the [sqlite3_bind_blob | bindings] on a
1.4114 -** [sqlite3_stmt | prepared statement]. Use this routine to
1.4115 -** reset all host parameters to NULL.
1.4116 -*/
1.4117 -int sqlite3_clear_bindings(sqlite3_stmt*);
1.4118 +** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
1.4119 +** the [sqlite3_bind_blob | bindings] on a [prepared statement].
1.4120 +** ^Use this routine to reset all host parameters to NULL.
1.4121 +*/
1.4122 +SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
1.4123
1.4124 /*
1.4125 ** CAPI3REF: Number Of Columns In A Result Set
1.4126 **
1.4127 -** Return the number of columns in the result set returned by the
1.4128 -** [sqlite3_stmt | compiled SQL statement]. This routine returns 0
1.4129 -** if pStmt is an SQL statement that does not return data (for
1.4130 -** example an UPDATE).
1.4131 -*/
1.4132 -int sqlite3_column_count(sqlite3_stmt *pStmt);
1.4133 +** ^Return the number of columns in the result set returned by the
1.4134 +** [prepared statement]. ^This routine returns 0 if pStmt is an SQL
1.4135 +** statement that does not return data (for example an [UPDATE]).
1.4136 +**
1.4137 +** See also: [sqlite3_data_count()]
1.4138 +*/
1.4139 +SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
1.4140
1.4141 /*
1.4142 ** CAPI3REF: Column Names In A Result Set
1.4143 **
1.4144 -** These routines return the name assigned to a particular column
1.4145 -** in the result set of a SELECT statement. The sqlite3_column_name()
1.4146 -** interface returns a pointer to a UTF8 string and sqlite3_column_name16()
1.4147 -** returns a pointer to a UTF16 string. The first parameter is the
1.4148 -** [sqlite3_stmt | prepared statement] that implements the SELECT statement.
1.4149 -** The second parameter is the column number. The left-most column is
1.4150 -** number 0.
1.4151 -**
1.4152 -** The returned string pointer is valid until either the
1.4153 -** [sqlite3_stmt | prepared statement] is destroyed by [sqlite3_finalize()]
1.4154 -** or until the next call sqlite3_column_name() or sqlite3_column_name16()
1.4155 -** on the same column.
1.4156 -**
1.4157 -** If sqlite3_malloc() fails during the processing of either routine
1.4158 +** ^These routines return the name assigned to a particular column
1.4159 +** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
1.4160 +** interface returns a pointer to a zero-terminated UTF-8 string
1.4161 +** and sqlite3_column_name16() returns a pointer to a zero-terminated
1.4162 +** UTF-16 string. ^The first parameter is the [prepared statement]
1.4163 +** that implements the [SELECT] statement. ^The second parameter is the
1.4164 +** column number. ^The leftmost column is number 0.
1.4165 +**
1.4166 +** ^The returned string pointer is valid until either the [prepared statement]
1.4167 +** is destroyed by [sqlite3_finalize()] or until the statement is automatically
1.4168 +** reprepared by the first call to [sqlite3_step()] for a particular run
1.4169 +** or until the next call to
1.4170 +** sqlite3_column_name() or sqlite3_column_name16() on the same column.
1.4171 +**
1.4172 +** ^If sqlite3_malloc() fails during the processing of either routine
1.4173 ** (for example during a conversion from UTF-8 to UTF-16) then a
1.4174 ** NULL pointer is returned.
1.4175 -*/
1.4176 -const char *sqlite3_column_name(sqlite3_stmt*, int N);
1.4177 -const void *sqlite3_column_name16(sqlite3_stmt*, int N);
1.4178 +**
1.4179 +** ^The name of a result column is the value of the "AS" clause for
1.4180 +** that column, if there is an AS clause. If there is no AS clause
1.4181 +** then the name of the column is unspecified and may change from
1.4182 +** one release of SQLite to the next.
1.4183 +*/
1.4184 +SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
1.4185 +SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
1.4186
1.4187 /*
1.4188 ** CAPI3REF: Source Of Data In A Query Result
1.4189 **
1.4190 -** These routines provide a means to determine what column of what
1.4191 -** table in which database a result of a SELECT statement comes from.
1.4192 -** The name of the database or table or column can be returned as
1.4193 -** either a UTF8 or UTF16 string. The _database_ routines return
1.4194 +** ^These routines provide a means to determine the database, table, and
1.4195 +** table column that is the origin of a particular result column in
1.4196 +** [SELECT] statement.
1.4197 +** ^The name of the database or table or column can be returned as
1.4198 +** either a UTF-8 or UTF-16 string. ^The _database_ routines return
1.4199 ** the database name, the _table_ routines return the table name, and
1.4200 ** the origin_ routines return the column name.
1.4201 -** The returned string is valid until
1.4202 -** the [sqlite3_stmt | prepared statement] is destroyed using
1.4203 -** [sqlite3_finalize()] or until the same information is requested
1.4204 +** ^The returned string is valid until the [prepared statement] is destroyed
1.4205 +** using [sqlite3_finalize()] or until the statement is automatically
1.4206 +** reprepared by the first call to [sqlite3_step()] for a particular run
1.4207 +** or until the same information is requested
1.4208 ** again in a different encoding.
1.4209 **
1.4210 -** The names returned are the original un-aliased names of the
1.4211 +** ^The names returned are the original un-aliased names of the
1.4212 ** database, table, and column.
1.4213 **
1.4214 -** The first argument to the following calls is a
1.4215 -** [sqlite3_stmt | compiled SQL statement].
1.4216 -** These functions return information about the Nth column returned by
1.4217 +** ^The first argument to these interfaces is a [prepared statement].
1.4218 +** ^These functions return information about the Nth result column returned by
1.4219 ** the statement, where N is the second function argument.
1.4220 -**
1.4221 -** If the Nth column returned by the statement is an expression
1.4222 -** or subquery and is not a column value, then all of these functions
1.4223 -** return NULL. Otherwise, they return the
1.4224 -** name of the attached database, table and column that query result
1.4225 -** column was extracted from.
1.4226 -**
1.4227 -** As with all other SQLite APIs, those postfixed with "16" return UTF-16
1.4228 -** encoded strings, the other functions return UTF-8.
1.4229 -**
1.4230 -** These APIs are only available if the library was compiled with the
1.4231 -** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
1.4232 +** ^The left-most column is column 0 for these routines.
1.4233 +**
1.4234 +** ^If the Nth column returned by the statement is an expression or
1.4235 +** subquery and is not a column value, then all of these functions return
1.4236 +** NULL. ^These routine might also return NULL if a memory allocation error
1.4237 +** occurs. ^Otherwise, they return the name of the attached database, table,
1.4238 +** or column that query result column was extracted from.
1.4239 +**
1.4240 +** ^As with all other SQLite APIs, those whose names end with "16" return
1.4241 +** UTF-16 encoded strings and the other functions return UTF-8.
1.4242 +**
1.4243 +** ^These APIs are only available if the library was compiled with the
1.4244 +** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
1.4245 **
1.4246 ** If two or more threads call one or more of these routines against the same
1.4247 ** prepared statement and column at the same time then the results are
1.4248 ** undefined.
1.4249 -*/
1.4250 -const char *sqlite3_column_database_name(sqlite3_stmt*,int);
1.4251 -const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
1.4252 -const char *sqlite3_column_table_name(sqlite3_stmt*,int);
1.4253 -const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
1.4254 -const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
1.4255 -const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
1.4256 +**
1.4257 +** If two or more threads call one or more
1.4258 +** [sqlite3_column_database_name | column metadata interfaces]
1.4259 +** for the same [prepared statement] and result column
1.4260 +** at the same time then the results are undefined.
1.4261 +*/
1.4262 +SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
1.4263 +SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
1.4264 +SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
1.4265 +SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
1.4266 +SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
1.4267 +SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
1.4268
1.4269 /*
1.4270 ** CAPI3REF: Declared Datatype Of A Query Result
1.4271 **
1.4272 -** The first parameter is a [sqlite3_stmt | compiled SQL statement].
1.4273 -** If this statement is a SELECT statement and the Nth column of the
1.4274 -** returned result set of that SELECT is a table column (not an
1.4275 +** ^(The first parameter is a [prepared statement].
1.4276 +** If this statement is a [SELECT] statement and the Nth column of the
1.4277 +** returned result set of that [SELECT] is a table column (not an
1.4278 ** expression or subquery) then the declared type of the table
1.4279 -** column is returned. If the Nth column of the result set is an
1.4280 +** column is returned.)^ ^If the Nth column of the result set is an
1.4281 ** expression or subquery, then a NULL pointer is returned.
1.4282 -** The returned string is always UTF-8 encoded. For example, in
1.4283 -** the database schema:
1.4284 +** ^The returned string is always UTF-8 encoded.
1.4285 +**
1.4286 +** ^(For example, given the database schema:
1.4287 **
1.4288 ** CREATE TABLE t1(c1 VARIANT);
1.4289 **
1.4290 -** And the following statement compiled:
1.4291 +** and the following statement to be compiled:
1.4292 **
1.4293 ** SELECT c1 + 1, c1 FROM t1;
1.4294 **
1.4295 -** Then this routine would return the string "VARIANT" for the second
1.4296 -** result column (i==1), and a NULL pointer for the first result column
1.4297 -** (i==0).
1.4298 -**
1.4299 -** SQLite uses dynamic run-time typing. So just because a column
1.4300 +** this routine would return the string "VARIANT" for the second result
1.4301 +** column (i==1), and a NULL pointer for the first result column (i==0).)^
1.4302 +**
1.4303 +** ^SQLite uses dynamic run-time typing. ^So just because a column
1.4304 ** is declared to contain a particular type does not mean that the
1.4305 ** data stored in that column is of the declared type. SQLite is
1.4306 -** strongly typed, but the typing is dynamic not static. Type
1.4307 +** strongly typed, but the typing is dynamic not static. ^Type
1.4308 ** is associated with individual values, not with the containers
1.4309 ** used to hold those values.
1.4310 */
1.4311 -const char *sqlite3_column_decltype(sqlite3_stmt *, int i);
1.4312 -const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
1.4313 -
1.4314 -/*
1.4315 -** CAPI3REF: Evaluate An SQL Statement
1.4316 -**
1.4317 -** After an [sqlite3_stmt | SQL statement] has been prepared with a call
1.4318 -** to either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or to one of
1.4319 -** the legacy interfaces [sqlite3_prepare()] or [sqlite3_prepare16()],
1.4320 -** then this function must be called one or more times to evaluate the
1.4321 -** statement.
1.4322 -**
1.4323 -** The details of the behavior of this sqlite3_step() interface depend
1.4324 +SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
1.4325 +SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
1.4326 +
1.4327 +/*
1.4328 +** CAPI3REF: Evaluate An SQL Statement
1.4329 +**
1.4330 +** After a [prepared statement] has been prepared using either
1.4331 +** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
1.4332 +** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
1.4333 +** must be called one or more times to evaluate the statement.
1.4334 +**
1.4335 +** The details of the behavior of the sqlite3_step() interface depend
1.4336 ** on whether the statement was prepared using the newer "v2" interface
1.4337 ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
1.4338 ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
1.4339 ** new "v2" interface is recommended for new applications but the legacy
1.4340 ** interface will continue to be supported.
1.4341 **
1.4342 -** In the lagacy interface, the return value will be either [SQLITE_BUSY],
1.4343 +** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
1.4344 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
1.4345 -** With the "v2" interface, any of the other [SQLITE_OK | result code]
1.4346 -** or [SQLITE_IOERR_READ | extended result code] might be returned as
1.4347 -** well.
1.4348 -**
1.4349 -** [SQLITE_BUSY] means that the database engine was unable to acquire the
1.4350 -** database locks it needs to do its job. If the statement is a COMMIT
1.4351 +** ^With the "v2" interface, any of the other [result codes] or
1.4352 +** [extended result codes] might be returned as well.
1.4353 +**
1.4354 +** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
1.4355 +** database locks it needs to do its job. ^If the statement is a [COMMIT]
1.4356 ** or occurs outside of an explicit transaction, then you can retry the
1.4357 -** statement. If the statement is not a COMMIT and occurs within a
1.4358 +** statement. If the statement is not a [COMMIT] and occurs within an
1.4359 ** explicit transaction then you should rollback the transaction before
1.4360 ** continuing.
1.4361 **
1.4362 -** [SQLITE_DONE] means that the statement has finished executing
1.4363 +** ^[SQLITE_DONE] means that the statement has finished executing
1.4364 ** successfully. sqlite3_step() should not be called again on this virtual
1.4365 ** machine without first calling [sqlite3_reset()] to reset the virtual
1.4366 ** machine back to its initial state.
1.4367 **
1.4368 -** If the SQL statement being executed returns any data, then
1.4369 -** [SQLITE_ROW] is returned each time a new row of data is ready
1.4370 -** for processing by the caller. The values may be accessed using
1.4371 -** the [sqlite3_column_int | column access functions].
1.4372 +** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
1.4373 +** is returned each time a new row of data is ready for processing by the
1.4374 +** caller. The values may be accessed using the [column access functions].
1.4375 ** sqlite3_step() is called again to retrieve the next row of data.
1.4376 -**
1.4377 -** [SQLITE_ERROR] means that a run-time error (such as a constraint
1.4378 +**
1.4379 +** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
1.4380 ** violation) has occurred. sqlite3_step() should not be called again on
1.4381 ** the VM. More information may be found by calling [sqlite3_errmsg()].
1.4382 -** With the legacy interface, a more specific error code (example:
1.4383 +** ^With the legacy interface, a more specific error code (for example,
1.4384 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
1.4385 ** can be obtained by calling [sqlite3_reset()] on the
1.4386 -** [sqlite3_stmt | prepared statement]. In the "v2" interface,
1.4387 +** [prepared statement]. ^In the "v2" interface,
1.4388 ** the more specific error code is returned directly by sqlite3_step().
1.4389 **
1.4390 ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
1.4391 -** Perhaps it was called on a [sqlite3_stmt | prepared statement] that has
1.4392 -** already been [sqlite3_finalize | finalized] or on one that had
1.4393 +** Perhaps it was called on a [prepared statement] that has
1.4394 +** already been [sqlite3_finalize | finalized] or on one that had
1.4395 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
1.4396 ** be the case that the same database connection is being used by two or
1.4397 ** more threads at the same moment in time.
1.4398 **
1.4399 -** <b>Goofy Interface Alert:</b>
1.4400 -** In the legacy interface,
1.4401 -** the sqlite3_step() API always returns a generic error code,
1.4402 -** [SQLITE_ERROR], following any error other than [SQLITE_BUSY]
1.4403 -** and [SQLITE_MISUSE]. You must call [sqlite3_reset()] or
1.4404 -** [sqlite3_finalize()] in order to find one of the specific
1.4405 -** [SQLITE_ERROR | result codes] that better describes the error.
1.4406 +** For all versions of SQLite up to and including 3.6.23.1, a call to
1.4407 +** [sqlite3_reset()] was required after sqlite3_step() returned anything
1.4408 +** other than [SQLITE_ROW] before any subsequent invocation of
1.4409 +** sqlite3_step(). Failure to reset the prepared statement using
1.4410 +** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
1.4411 +** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began
1.4412 +** calling [sqlite3_reset()] automatically in this circumstance rather
1.4413 +** than returning [SQLITE_MISUSE]. This is not considered a compatibility
1.4414 +** break because any application that ever receives an SQLITE_MISUSE error
1.4415 +** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
1.4416 +** can be used to restore the legacy behavior.
1.4417 +**
1.4418 +** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
1.4419 +** API always returns a generic error code, [SQLITE_ERROR], following any
1.4420 +** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
1.4421 +** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
1.4422 +** specific [error codes] that better describes the error.
1.4423 ** We admit that this is a goofy design. The problem has been fixed
1.4424 ** with the "v2" interface. If you prepare all of your SQL statements
1.4425 ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
1.4426 -** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()], then the
1.4427 -** more specific [SQLITE_ERROR | result codes] are returned directly
1.4428 +** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
1.4429 +** then the more specific [error codes] are returned directly
1.4430 ** by sqlite3_step(). The use of the "v2" interface is recommended.
1.4431 */
1.4432 -int sqlite3_step(sqlite3_stmt*);
1.4433 -
1.4434 -/*
1.4435 -** CAPI3REF:
1.4436 -**
1.4437 -** Return the number of values in the current row of the result set.
1.4438 -**
1.4439 -** After a call to [sqlite3_step()] that returns [SQLITE_ROW], this routine
1.4440 -** will return the same value as the [sqlite3_column_count()] function.
1.4441 -** After [sqlite3_step()] has returned an [SQLITE_DONE], [SQLITE_BUSY], or
1.4442 -** a [SQLITE_ERROR | error code], or before [sqlite3_step()] has been
1.4443 -** called on the [sqlite3_stmt | prepared statement] for the first time,
1.4444 -** this routine returns zero.
1.4445 -*/
1.4446 -int sqlite3_data_count(sqlite3_stmt *pStmt);
1.4447 +SQLITE_API int sqlite3_step(sqlite3_stmt*);
1.4448 +
1.4449 +/*
1.4450 +** CAPI3REF: Number of columns in a result set
1.4451 +**
1.4452 +** ^The sqlite3_data_count(P) interface returns the number of columns in the
1.4453 +** current row of the result set of [prepared statement] P.
1.4454 +** ^If prepared statement P does not have results ready to return
1.4455 +** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
1.4456 +** interfaces) then sqlite3_data_count(P) returns 0.
1.4457 +** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
1.4458 +** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
1.4459 +** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
1.4460 +** will return non-zero if previous call to [sqlite3_step](P) returned
1.4461 +** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
1.4462 +** where it always returns zero since each step of that multi-step
1.4463 +** pragma returns 0 columns of data.
1.4464 +**
1.4465 +** See also: [sqlite3_column_count()]
1.4466 +*/
1.4467 +SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
1.4468
1.4469 /*
1.4470 ** CAPI3REF: Fundamental Datatypes
1.4471 -**
1.4472 -** Every value in SQLite has one of five fundamental datatypes:
1.4473 +** KEYWORDS: SQLITE_TEXT
1.4474 +**
1.4475 +** ^(Every value in SQLite has one of five fundamental datatypes:
1.4476 **
1.4477 ** <ul>
1.4478 ** <li> 64-bit signed integer
1.4479 @@ -2000,13 +3505,13 @@
1.4480 ** <li> string
1.4481 ** <li> BLOB
1.4482 ** <li> NULL
1.4483 -** </ul>
1.4484 +** </ul>)^
1.4485 **
1.4486 ** These constants are codes for each of those types.
1.4487 **
1.4488 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
1.4489 ** for a completely different meaning. Software that links against both
1.4490 -** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT not
1.4491 +** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
1.4492 ** SQLITE_TEXT.
1.4493 */
1.4494 #define SQLITE_INTEGER 1
1.4495 @@ -2021,33 +3526,35 @@
1.4496 #define SQLITE3_TEXT 3
1.4497
1.4498 /*
1.4499 -** CAPI3REF: Results Values From A Query
1.4500 -**
1.4501 -** These routines return information about
1.4502 -** a single column of the current result row of a query. In every
1.4503 -** case the first argument is a pointer to the
1.4504 -** [sqlite3_stmt | SQL statement] that is being
1.4505 -** evaluated (the [sqlite3_stmt*] that was returned from
1.4506 -** [sqlite3_prepare_v2()] or one of its variants) and
1.4507 -** the second argument is the index of the column for which information
1.4508 -** should be returned. The left-most column of the result set
1.4509 -** has an index of 0.
1.4510 -**
1.4511 -** If the SQL statement is not currently point to a valid row, or if the
1.4512 -** the column index is out of range, the result is undefined.
1.4513 +** CAPI3REF: Result Values From A Query
1.4514 +** KEYWORDS: {column access functions}
1.4515 +**
1.4516 +** These routines form the "result set" interface.
1.4517 +**
1.4518 +** ^These routines return information about a single column of the current
1.4519 +** result row of a query. ^In every case the first argument is a pointer
1.4520 +** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
1.4521 +** that was returned from [sqlite3_prepare_v2()] or one of its variants)
1.4522 +** and the second argument is the index of the column for which information
1.4523 +** should be returned. ^The leftmost column of the result set has the index 0.
1.4524 +** ^The number of columns in the result can be determined using
1.4525 +** [sqlite3_column_count()].
1.4526 +**
1.4527 +** If the SQL statement does not currently point to a valid row, or if the
1.4528 +** column index is out of range, the result is undefined.
1.4529 ** These routines may only be called when the most recent call to
1.4530 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
1.4531 -** [sqlite3_reset()] nor [sqlite3_finalize()] has been call subsequently.
1.4532 +** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
1.4533 ** If any of these routines are called after [sqlite3_reset()] or
1.4534 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
1.4535 ** something other than [SQLITE_ROW], the results are undefined.
1.4536 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
1.4537 ** are called from a different thread while any of these routines
1.4538 -** are pending, then the results are undefined.
1.4539 -**
1.4540 -** The sqlite3_column_type() routine returns
1.4541 +** are pending, then the results are undefined.
1.4542 +**
1.4543 +** ^The sqlite3_column_type() routine returns the
1.4544 ** [SQLITE_INTEGER | datatype code] for the initial data type
1.4545 -** of the result column. The returned value is one of [SQLITE_INTEGER],
1.4546 +** of the result column. ^The returned value is one of [SQLITE_INTEGER],
1.4547 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
1.4548 ** returned by sqlite3_column_type() is only meaningful if no type
1.4549 ** conversions have occurred as described below. After a type conversion,
1.4550 @@ -2055,31 +3562,47 @@
1.4551 ** versions of SQLite may change the behavior of sqlite3_column_type()
1.4552 ** following a type conversion.
1.4553 **
1.4554 -** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
1.4555 +** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
1.4556 ** routine returns the number of bytes in that BLOB or string.
1.4557 -** If the result is a UTF-16 string, then sqlite3_column_bytes() converts
1.4558 +** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
1.4559 ** the string to UTF-8 and then returns the number of bytes.
1.4560 -** If the result is a numeric value then sqlite3_column_bytes() uses
1.4561 +** ^If the result is a numeric value then sqlite3_column_bytes() uses
1.4562 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
1.4563 ** the number of bytes in that string.
1.4564 -** The value returned does not include the zero terminator at the end
1.4565 -** of the string. For clarity: the value returned is the number of
1.4566 +** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
1.4567 +**
1.4568 +** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
1.4569 +** routine returns the number of bytes in that BLOB or string.
1.4570 +** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
1.4571 +** the string to UTF-16 and then returns the number of bytes.
1.4572 +** ^If the result is a numeric value then sqlite3_column_bytes16() uses
1.4573 +** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
1.4574 +** the number of bytes in that string.
1.4575 +** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
1.4576 +**
1.4577 +** ^The values returned by [sqlite3_column_bytes()] and
1.4578 +** [sqlite3_column_bytes16()] do not include the zero terminators at the end
1.4579 +** of the string. ^For clarity: the values returned by
1.4580 +** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
1.4581 ** bytes in the string, not the number of characters.
1.4582 **
1.4583 -** Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
1.4584 -** even zero-length strings, are always zero terminated. The return
1.4585 -** value from sqlite3_column_blob() for a zero-length blob is an arbitrary
1.4586 -** pointer, possibly even a NULL pointer.
1.4587 -**
1.4588 -** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes()
1.4589 -** but leaves the result in UTF-16 instead of UTF-8.
1.4590 -** The zero terminator is not included in this count.
1.4591 -**
1.4592 -** These routines attempt to convert the value where appropriate. For
1.4593 +** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
1.4594 +** even empty strings, are always zero-terminated. ^The return
1.4595 +** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
1.4596 +**
1.4597 +** ^The object returned by [sqlite3_column_value()] is an
1.4598 +** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
1.4599 +** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
1.4600 +** If the [unprotected sqlite3_value] object returned by
1.4601 +** [sqlite3_column_value()] is used in any other way, including calls
1.4602 +** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
1.4603 +** or [sqlite3_value_bytes()], then the behavior is undefined.
1.4604 +**
1.4605 +** These routines attempt to convert the value where appropriate. ^For
1.4606 ** example, if the internal representation is FLOAT and a text result
1.4607 -** is requested, [sqlite3_snprintf()] is used internally to do the conversion
1.4608 -** automatically. The following table details the conversions that
1.4609 -** are applied:
1.4610 +** is requested, [sqlite3_snprintf()] is used internally to perform the
1.4611 +** conversion automatically. ^(The following table details the conversions
1.4612 +** that are applied:
1.4613 **
1.4614 ** <blockquote>
1.4615 ** <table border="1">
1.4616 @@ -2091,7 +3614,7 @@
1.4617 ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
1.4618 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
1.4619 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
1.4620 -** <tr><td> INTEGER <td> BLOB <td> Same as for INTEGER->TEXT
1.4621 +** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
1.4622 ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
1.4623 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
1.4624 ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
1.4625 @@ -2102,190 +3625,251 @@
1.4626 ** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
1.4627 ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
1.4628 ** </table>
1.4629 -** </blockquote>
1.4630 +** </blockquote>)^
1.4631 **
1.4632 ** The table above makes reference to standard C library functions atoi()
1.4633 ** and atof(). SQLite does not really use these functions. It has its
1.4634 -** on equavalent internal routines. The atoi() and atof() names are
1.4635 +** own equivalent internal routines. The atoi() and atof() names are
1.4636 ** used in the table for brevity and because they are familiar to most
1.4637 ** C programmers.
1.4638 **
1.4639 ** Note that when type conversions occur, pointers returned by prior
1.4640 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
1.4641 -** sqlite3_column_text16() may be invalidated.
1.4642 +** sqlite3_column_text16() may be invalidated.
1.4643 ** Type conversions and pointer invalidations might occur
1.4644 ** in the following cases:
1.4645 **
1.4646 ** <ul>
1.4647 -** <li><p> The initial content is a BLOB and sqlite3_column_text()
1.4648 -** or sqlite3_column_text16() is called. A zero-terminator might
1.4649 -** need to be added to the string.</p></li>
1.4650 -**
1.4651 -** <li><p> The initial content is UTF-8 text and sqlite3_column_bytes16() or
1.4652 -** sqlite3_column_text16() is called. The content must be converted
1.4653 -** to UTF-16.</p></li>
1.4654 -**
1.4655 -** <li><p> The initial content is UTF-16 text and sqlite3_column_bytes() or
1.4656 -** sqlite3_column_text() is called. The content must be converted
1.4657 -** to UTF-8.</p></li>
1.4658 +** <li> The initial content is a BLOB and sqlite3_column_text() or
1.4659 +** sqlite3_column_text16() is called. A zero-terminator might
1.4660 +** need to be added to the string.</li>
1.4661 +** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
1.4662 +** sqlite3_column_text16() is called. The content must be converted
1.4663 +** to UTF-16.</li>
1.4664 +** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
1.4665 +** sqlite3_column_text() is called. The content must be converted
1.4666 +** to UTF-8.</li>
1.4667 ** </ul>
1.4668 **
1.4669 -** Conversions between UTF-16be and UTF-16le are always done in place and do
1.4670 +** ^Conversions between UTF-16be and UTF-16le are always done in place and do
1.4671 ** not invalidate a prior pointer, though of course the content of the buffer
1.4672 -** that the prior pointer points to will have been modified. Other kinds
1.4673 -** of conversion are done in place when it is possible, but sometime it is
1.4674 -** not possible and in those cases prior pointers are invalidated.
1.4675 +** that the prior pointer references will have been modified. Other kinds
1.4676 +** of conversion are done in place when it is possible, but sometimes they
1.4677 +** are not possible and in those cases prior pointers are invalidated.
1.4678 **
1.4679 ** The safest and easiest to remember policy is to invoke these routines
1.4680 ** in one of the following ways:
1.4681 **
1.4682 -** <ul>
1.4683 +** <ul>
1.4684 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
1.4685 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
1.4686 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
1.4687 -** </ul>
1.4688 -**
1.4689 -** In other words, you should call sqlite3_column_text(), sqlite3_column_blob(),
1.4690 -** or sqlite3_column_text16() first to force the result into the desired
1.4691 -** format, then invoke sqlite3_column_bytes() or sqlite3_column_bytes16() to
1.4692 -** find the size of the result. Do not mix call to sqlite3_column_text() or
1.4693 -** sqlite3_column_blob() with calls to sqlite3_column_bytes16(). And do not
1.4694 -** mix calls to sqlite3_column_text16() with calls to sqlite3_column_bytes().
1.4695 -**
1.4696 -** The pointers returned are valid until a type conversion occurs as
1.4697 +** </ul>
1.4698 +**
1.4699 +** In other words, you should call sqlite3_column_text(),
1.4700 +** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
1.4701 +** into the desired format, then invoke sqlite3_column_bytes() or
1.4702 +** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
1.4703 +** to sqlite3_column_text() or sqlite3_column_blob() with calls to
1.4704 +** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
1.4705 +** with calls to sqlite3_column_bytes().
1.4706 +**
1.4707 +** ^The pointers returned are valid until a type conversion occurs as
1.4708 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
1.4709 -** [sqlite3_finalize()] is called. The memory space used to hold strings
1.4710 -** and blobs is freed automatically. Do <b>not</b> pass the pointers returned
1.4711 -** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
1.4712 +** [sqlite3_finalize()] is called. ^The memory space used to hold strings
1.4713 +** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
1.4714 +** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
1.4715 ** [sqlite3_free()].
1.4716 **
1.4717 -** If a memory allocation error occurs during the evaluation of any
1.4718 +** ^(If a memory allocation error occurs during the evaluation of any
1.4719 ** of these routines, a default value is returned. The default value
1.4720 ** is either the integer 0, the floating point number 0.0, or a NULL
1.4721 ** pointer. Subsequent calls to [sqlite3_errcode()] will return
1.4722 -** [SQLITE_NOMEM].
1.4723 -*/
1.4724 -const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
1.4725 -int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
1.4726 -int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
1.4727 -double sqlite3_column_double(sqlite3_stmt*, int iCol);
1.4728 -int sqlite3_column_int(sqlite3_stmt*, int iCol);
1.4729 -sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
1.4730 -const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
1.4731 -const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
1.4732 -int sqlite3_column_type(sqlite3_stmt*, int iCol);
1.4733 -sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
1.4734 +** [SQLITE_NOMEM].)^
1.4735 +*/
1.4736 +SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
1.4737 +SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
1.4738 +SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
1.4739 +SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
1.4740 +SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
1.4741 +SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
1.4742 +SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
1.4743 +SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
1.4744 +SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
1.4745 +SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
1.4746
1.4747 /*
1.4748 ** CAPI3REF: Destroy A Prepared Statement Object
1.4749 **
1.4750 -** The sqlite3_finalize() function is called to delete a
1.4751 -** [sqlite3_stmt | compiled SQL statement]. If the statement was
1.4752 -** executed successfully, or not executed at all, then SQLITE_OK is returned.
1.4753 -** If execution of the statement failed then an
1.4754 -** [SQLITE_ERROR | error code] or [SQLITE_IOERR_READ | extended error code]
1.4755 -** is returned.
1.4756 -**
1.4757 -** This routine can be called at any point during the execution of the
1.4758 -** [sqlite3_stmt | virtual machine]. If the virtual machine has not
1.4759 -** completed execution when this routine is called, that is like
1.4760 -** encountering an error or an interrupt. (See [sqlite3_interrupt()].)
1.4761 -** Incomplete updates may be rolled back and transactions cancelled,
1.4762 -** depending on the circumstances, and the
1.4763 -** [SQLITE_ERROR | result code] returned will be [SQLITE_ABORT].
1.4764 -*/
1.4765 -int sqlite3_finalize(sqlite3_stmt *pStmt);
1.4766 +** ^The sqlite3_finalize() function is called to delete a [prepared statement].
1.4767 +** ^If the most recent evaluation of the statement encountered no errors
1.4768 +** or if the statement is never been evaluated, then sqlite3_finalize() returns
1.4769 +** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
1.4770 +** sqlite3_finalize(S) returns the appropriate [error code] or
1.4771 +** [extended error code].
1.4772 +**
1.4773 +** ^The sqlite3_finalize(S) routine can be called at any point during
1.4774 +** the life cycle of [prepared statement] S:
1.4775 +** before statement S is ever evaluated, after
1.4776 +** one or more calls to [sqlite3_reset()], or after any call
1.4777 +** to [sqlite3_step()] regardless of whether or not the statement has
1.4778 +** completed execution.
1.4779 +**
1.4780 +** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
1.4781 +**
1.4782 +** The application must finalize every [prepared statement] in order to avoid
1.4783 +** resource leaks. It is a grievous error for the application to try to use
1.4784 +** a prepared statement after it has been finalized. Any use of a prepared
1.4785 +** statement after it has been finalized can result in undefined and
1.4786 +** undesirable behavior such as segfaults and heap corruption.
1.4787 +*/
1.4788 +SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
1.4789
1.4790 /*
1.4791 ** CAPI3REF: Reset A Prepared Statement Object
1.4792 **
1.4793 -** The sqlite3_reset() function is called to reset a
1.4794 -** [sqlite3_stmt | compiled SQL statement] object.
1.4795 -** back to it's initial state, ready to be re-executed.
1.4796 -** Any SQL statement variables that had values bound to them using
1.4797 +** The sqlite3_reset() function is called to reset a [prepared statement]
1.4798 +** object back to its initial state, ready to be re-executed.
1.4799 +** ^Any SQL statement variables that had values bound to them using
1.4800 ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
1.4801 ** Use [sqlite3_clear_bindings()] to reset the bindings.
1.4802 -*/
1.4803 -int sqlite3_reset(sqlite3_stmt *pStmt);
1.4804 +**
1.4805 +** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
1.4806 +** back to the beginning of its program.
1.4807 +**
1.4808 +** ^If the most recent call to [sqlite3_step(S)] for the
1.4809 +** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
1.4810 +** or if [sqlite3_step(S)] has never before been called on S,
1.4811 +** then [sqlite3_reset(S)] returns [SQLITE_OK].
1.4812 +**
1.4813 +** ^If the most recent call to [sqlite3_step(S)] for the
1.4814 +** [prepared statement] S indicated an error, then
1.4815 +** [sqlite3_reset(S)] returns an appropriate [error code].
1.4816 +**
1.4817 +** ^The [sqlite3_reset(S)] interface does not change the values
1.4818 +** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
1.4819 +*/
1.4820 +SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
1.4821
1.4822 /*
1.4823 ** CAPI3REF: Create Or Redefine SQL Functions
1.4824 -**
1.4825 -** The following two functions are used to add SQL functions or aggregates
1.4826 -** or to redefine the behavior of existing SQL functions or aggregates. The
1.4827 -** difference only between the two is that the second parameter, the
1.4828 -** name of the (scalar) function or aggregate, is encoded in UTF-8 for
1.4829 -** sqlite3_create_function() and UTF-16 for sqlite3_create_function16().
1.4830 -**
1.4831 -** The first argument is the [sqlite3 | database handle] that holds the
1.4832 -** SQL function or aggregate is to be added or redefined. If a single
1.4833 -** program uses more than one database handle internally, then SQL
1.4834 -** functions or aggregates must be added individually to each database
1.4835 -** handle with which they will be used.
1.4836 -**
1.4837 -** The second parameter is the name of the SQL function to be created
1.4838 -** or redefined.
1.4839 -** The length of the name is limited to 255 bytes, exclusive of the
1.4840 -** zero-terminator. Note that the name length limit is in bytes, not
1.4841 -** characters. Any attempt to create a function with a longer name
1.4842 -** will result in an SQLITE_ERROR error.
1.4843 -**
1.4844 -** The third parameter is the number of arguments that the SQL function or
1.4845 -** aggregate takes. If this parameter is negative, then the SQL function or
1.4846 -** aggregate may take any number of arguments.
1.4847 -**
1.4848 -** The fourth parameter, eTextRep, specifies what
1.4849 +** KEYWORDS: {function creation routines}
1.4850 +** KEYWORDS: {application-defined SQL function}
1.4851 +** KEYWORDS: {application-defined SQL functions}
1.4852 +**
1.4853 +** ^These functions (collectively known as "function creation routines")
1.4854 +** are used to add SQL functions or aggregates or to redefine the behavior
1.4855 +** of existing SQL functions or aggregates. The only differences between
1.4856 +** these routines are the text encoding expected for
1.4857 +** the second parameter (the name of the function being created)
1.4858 +** and the presence or absence of a destructor callback for
1.4859 +** the application data pointer.
1.4860 +**
1.4861 +** ^The first parameter is the [database connection] to which the SQL
1.4862 +** function is to be added. ^If an application uses more than one database
1.4863 +** connection then application-defined SQL functions must be added
1.4864 +** to each database connection separately.
1.4865 +**
1.4866 +** ^The second parameter is the name of the SQL function to be created or
1.4867 +** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
1.4868 +** representation, exclusive of the zero-terminator. ^Note that the name
1.4869 +** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
1.4870 +** ^Any attempt to create a function with a longer name
1.4871 +** will result in [SQLITE_MISUSE] being returned.
1.4872 +**
1.4873 +** ^The third parameter (nArg)
1.4874 +** is the number of arguments that the SQL function or
1.4875 +** aggregate takes. ^If this parameter is -1, then the SQL function or
1.4876 +** aggregate may take any number of arguments between 0 and the limit
1.4877 +** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
1.4878 +** parameter is less than -1 or greater than 127 then the behavior is
1.4879 +** undefined.
1.4880 +**
1.4881 +** ^The fourth parameter, eTextRep, specifies what
1.4882 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
1.4883 -** its parameters. Any SQL function implementation should be able to work
1.4884 -** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
1.4885 -** more efficient with one encoding than another. It is allowed to
1.4886 +** its parameters. Every SQL function implementation must be able to work
1.4887 +** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
1.4888 +** more efficient with one encoding than another. ^An application may
1.4889 ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
1.4890 ** times with the same function but with different values of eTextRep.
1.4891 -** When multiple implementations of the same function are available, SQLite
1.4892 +** ^When multiple implementations of the same function are available, SQLite
1.4893 ** will pick the one that involves the least amount of data conversion.
1.4894 -** If there is only a single implementation which does not care what
1.4895 -** text encoding is used, then the fourth argument should be
1.4896 -** [SQLITE_ANY].
1.4897 -**
1.4898 -** The fifth parameter is an arbitrary pointer. The implementation
1.4899 -** of the function can gain access to this pointer using
1.4900 -** [sqlite3_user_data()].
1.4901 -**
1.4902 -** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
1.4903 -** pointers to C-language functions that implement the SQL
1.4904 -** function or aggregate. A scalar SQL function requires an implementation of
1.4905 -** the xFunc callback only, NULL pointers should be passed as the xStep
1.4906 -** and xFinal parameters. An aggregate SQL function requires an implementation
1.4907 -** of xStep and xFinal and NULL should be passed for xFunc. To delete an
1.4908 -** existing SQL function or aggregate, pass NULL for all three function
1.4909 -** callback.
1.4910 -**
1.4911 -** It is permitted to register multiple implementations of the same
1.4912 +** If there is only a single implementation which does not care what text
1.4913 +** encoding is used, then the fourth argument should be [SQLITE_ANY].
1.4914 +**
1.4915 +** ^(The fifth parameter is an arbitrary pointer. The implementation of the
1.4916 +** function can gain access to this pointer using [sqlite3_user_data()].)^
1.4917 +**
1.4918 +** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
1.4919 +** pointers to C-language functions that implement the SQL function or
1.4920 +** aggregate. ^A scalar SQL function requires an implementation of the xFunc
1.4921 +** callback only; NULL pointers must be passed as the xStep and xFinal
1.4922 +** parameters. ^An aggregate SQL function requires an implementation of xStep
1.4923 +** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
1.4924 +** SQL function or aggregate, pass NULL pointers for all three function
1.4925 +** callbacks.
1.4926 +**
1.4927 +** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL,
1.4928 +** then it is destructor for the application data pointer.
1.4929 +** The destructor is invoked when the function is deleted, either by being
1.4930 +** overloaded or when the database connection closes.)^
1.4931 +** ^The destructor is also invoked if the call to
1.4932 +** sqlite3_create_function_v2() fails.
1.4933 +** ^When the destructor callback of the tenth parameter is invoked, it
1.4934 +** is passed a single argument which is a copy of the application data
1.4935 +** pointer which was the fifth parameter to sqlite3_create_function_v2().
1.4936 +**
1.4937 +** ^It is permitted to register multiple implementations of the same
1.4938 ** functions with the same name but with either differing numbers of
1.4939 -** arguments or differing perferred text encodings. SQLite will use
1.4940 -** the implementation most closely matches the way in which the
1.4941 -** SQL function is used.
1.4942 -*/
1.4943 -int sqlite3_create_function(
1.4944 - sqlite3 *,
1.4945 +** arguments or differing preferred text encodings. ^SQLite will use
1.4946 +** the implementation that most closely matches the way in which the
1.4947 +** SQL function is used. ^A function implementation with a non-negative
1.4948 +** nArg parameter is a better match than a function implementation with
1.4949 +** a negative nArg. ^A function where the preferred text encoding
1.4950 +** matches the database encoding is a better
1.4951 +** match than a function where the encoding is different.
1.4952 +** ^A function where the encoding difference is between UTF16le and UTF16be
1.4953 +** is a closer match than a function where the encoding difference is
1.4954 +** between UTF8 and UTF16.
1.4955 +**
1.4956 +** ^Built-in functions may be overloaded by new application-defined functions.
1.4957 +**
1.4958 +** ^An application-defined function is permitted to call other
1.4959 +** SQLite interfaces. However, such calls must not
1.4960 +** close the database connection nor finalize or reset the prepared
1.4961 +** statement in which the function is running.
1.4962 +*/
1.4963 +SQLITE_API int sqlite3_create_function(
1.4964 + sqlite3 *db,
1.4965 const char *zFunctionName,
1.4966 int nArg,
1.4967 int eTextRep,
1.4968 - void*,
1.4969 + void *pApp,
1.4970 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1.4971 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1.4972 void (*xFinal)(sqlite3_context*)
1.4973 );
1.4974 -int sqlite3_create_function16(
1.4975 - sqlite3*,
1.4976 +SQLITE_API int sqlite3_create_function16(
1.4977 + sqlite3 *db,
1.4978 const void *zFunctionName,
1.4979 int nArg,
1.4980 int eTextRep,
1.4981 - void*,
1.4982 + void *pApp,
1.4983 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1.4984 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1.4985 void (*xFinal)(sqlite3_context*)
1.4986 );
1.4987 +SQLITE_API int sqlite3_create_function_v2(
1.4988 + sqlite3 *db,
1.4989 + const char *zFunctionName,
1.4990 + int nArg,
1.4991 + int eTextRep,
1.4992 + void *pApp,
1.4993 + void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1.4994 + void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1.4995 + void (*xFinal)(sqlite3_context*),
1.4996 + void(*xDestroy)(void*)
1.4997 +);
1.4998
1.4999 /*
1.5000 ** CAPI3REF: Text Encodings
1.5001 @@ -2301,19 +3885,23 @@
1.5002 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
1.5003
1.5004 /*
1.5005 -** CAPI3REF: Obsolete Functions
1.5006 -**
1.5007 -** These functions are all now obsolete. In order to maintain
1.5008 -** backwards compatibility with older code, we continue to support
1.5009 -** these functions. However, new development projects should avoid
1.5010 +** CAPI3REF: Deprecated Functions
1.5011 +** DEPRECATED
1.5012 +**
1.5013 +** These functions are [deprecated]. In order to maintain
1.5014 +** backwards compatibility with older code, these functions continue
1.5015 +** to be supported. However, new applications should avoid
1.5016 ** the use of these functions. To help encourage people to avoid
1.5017 -** using these functions, we are not going to tell you want they do.
1.5018 -*/
1.5019 -int sqlite3_aggregate_count(sqlite3_context*);
1.5020 -int sqlite3_expired(sqlite3_stmt*);
1.5021 -int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
1.5022 -int sqlite3_global_recover(void);
1.5023 -void sqlite3_thread_cleanup(void);
1.5024 +** using these functions, we are not going to tell you what they do.
1.5025 +*/
1.5026 +#ifndef SQLITE_OMIT_DEPRECATED
1.5027 +SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
1.5028 +SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
1.5029 +SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
1.5030 +SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
1.5031 +SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
1.5032 +SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
1.5033 +#endif
1.5034
1.5035 /*
1.5036 ** CAPI3REF: Obtaining SQL Function Parameter Values
1.5037 @@ -2325,134 +3913,173 @@
1.5038 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters
1.5039 ** to [sqlite3_create_function()] and [sqlite3_create_function16()]
1.5040 ** define callbacks that implement the SQL functions and aggregates.
1.5041 -** The 4th parameter to these callbacks is an array of pointers to
1.5042 -** [sqlite3_value] objects. There is one [sqlite3_value] object for
1.5043 +** The 3rd parameter to these callbacks is an array of pointers to
1.5044 +** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
1.5045 ** each parameter to the SQL function. These routines are used to
1.5046 ** extract values from the [sqlite3_value] objects.
1.5047 **
1.5048 -** These routines work just like the corresponding
1.5049 -** [sqlite3_column_blob | sqlite3_column_* routines] except that
1.5050 -** these routines take a single [sqlite3_value*] pointer instead
1.5051 -** of an [sqlite3_stmt*] pointer and an integer column number.
1.5052 -**
1.5053 -** The sqlite3_value_text16() interface extracts a UTF16 string
1.5054 -** in the native byte-order of the host machine. The
1.5055 +** These routines work only with [protected sqlite3_value] objects.
1.5056 +** Any attempt to use these routines on an [unprotected sqlite3_value]
1.5057 +** object results in undefined behavior.
1.5058 +**
1.5059 +** ^These routines work just like the corresponding [column access functions]
1.5060 +** except that these routines take a single [protected sqlite3_value] object
1.5061 +** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
1.5062 +**
1.5063 +** ^The sqlite3_value_text16() interface extracts a UTF-16 string
1.5064 +** in the native byte-order of the host machine. ^The
1.5065 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
1.5066 -** extract UTF16 strings as big-endian and little-endian respectively.
1.5067 -**
1.5068 -** The sqlite3_value_numeric_type() interface attempts to apply
1.5069 +** extract UTF-16 strings as big-endian and little-endian respectively.
1.5070 +**
1.5071 +** ^(The sqlite3_value_numeric_type() interface attempts to apply
1.5072 ** numeric affinity to the value. This means that an attempt is
1.5073 ** made to convert the value to an integer or floating point. If
1.5074 -** such a conversion is possible without loss of information (in order
1.5075 -** words if the value is original a string that looks like a number)
1.5076 -** then it is done. Otherwise no conversion occurs. The
1.5077 -** [SQLITE_INTEGER | datatype] after conversion is returned.
1.5078 -**
1.5079 -** Please pay particular attention to the fact that the pointer that
1.5080 -** is returned from [sqlite3_value_blob()], [sqlite3_value_text()], or
1.5081 +** such a conversion is possible without loss of information (in other
1.5082 +** words, if the value is a string that looks like a number)
1.5083 +** then the conversion is performed. Otherwise no conversion occurs.
1.5084 +** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
1.5085 +**
1.5086 +** Please pay particular attention to the fact that the pointer returned
1.5087 +** from [sqlite3_value_blob()], [sqlite3_value_text()], or
1.5088 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
1.5089 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
1.5090 -** or [sqlite3_value_text16()].
1.5091 +** or [sqlite3_value_text16()].
1.5092 **
1.5093 ** These routines must be called from the same thread as
1.5094 -** the SQL function that supplied the sqlite3_value* parameters.
1.5095 -** Or, if the sqlite3_value* argument comes from the [sqlite3_column_value()]
1.5096 -** interface, then these routines should be called from the same thread
1.5097 -** that ran [sqlite3_column_value()].
1.5098 -*/
1.5099 -const void *sqlite3_value_blob(sqlite3_value*);
1.5100 -int sqlite3_value_bytes(sqlite3_value*);
1.5101 -int sqlite3_value_bytes16(sqlite3_value*);
1.5102 -double sqlite3_value_double(sqlite3_value*);
1.5103 -int sqlite3_value_int(sqlite3_value*);
1.5104 -sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
1.5105 -const unsigned char *sqlite3_value_text(sqlite3_value*);
1.5106 -const void *sqlite3_value_text16(sqlite3_value*);
1.5107 -const void *sqlite3_value_text16le(sqlite3_value*);
1.5108 -const void *sqlite3_value_text16be(sqlite3_value*);
1.5109 -int sqlite3_value_type(sqlite3_value*);
1.5110 -int sqlite3_value_numeric_type(sqlite3_value*);
1.5111 +** the SQL function that supplied the [sqlite3_value*] parameters.
1.5112 +*/
1.5113 +SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
1.5114 +SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
1.5115 +SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
1.5116 +SQLITE_API double sqlite3_value_double(sqlite3_value*);
1.5117 +SQLITE_API int sqlite3_value_int(sqlite3_value*);
1.5118 +SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
1.5119 +SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
1.5120 +SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
1.5121 +SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
1.5122 +SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
1.5123 +SQLITE_API int sqlite3_value_type(sqlite3_value*);
1.5124 +SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
1.5125
1.5126 /*
1.5127 ** CAPI3REF: Obtain Aggregate Function Context
1.5128 **
1.5129 -** The implementation of aggregate SQL functions use this routine to allocate
1.5130 -** a structure for storing their state. The first time this routine
1.5131 -** is called for a particular aggregate, a new structure of size nBytes
1.5132 -** is allocated, zeroed, and returned. On subsequent calls (for the
1.5133 -** same aggregate instance) the same buffer is returned. The implementation
1.5134 -** of the aggregate can use the returned buffer to accumulate data.
1.5135 -**
1.5136 -** The buffer allocated is freed automatically by SQLite whan the aggregate
1.5137 -** query concludes.
1.5138 -**
1.5139 -** The first parameter should be a copy of the
1.5140 -** [sqlite3_context | SQL function context] that is the first
1.5141 -** parameter to the callback routine that implements the aggregate
1.5142 +** Implementations of aggregate SQL functions use this
1.5143 +** routine to allocate memory for storing their state.
1.5144 +**
1.5145 +** ^The first time the sqlite3_aggregate_context(C,N) routine is called
1.5146 +** for a particular aggregate function, SQLite
1.5147 +** allocates N of memory, zeroes out that memory, and returns a pointer
1.5148 +** to the new memory. ^On second and subsequent calls to
1.5149 +** sqlite3_aggregate_context() for the same aggregate function instance,
1.5150 +** the same buffer is returned. Sqlite3_aggregate_context() is normally
1.5151 +** called once for each invocation of the xStep callback and then one
1.5152 +** last time when the xFinal callback is invoked. ^(When no rows match
1.5153 +** an aggregate query, the xStep() callback of the aggregate function
1.5154 +** implementation is never called and xFinal() is called exactly once.
1.5155 +** In those cases, sqlite3_aggregate_context() might be called for the
1.5156 +** first time from within xFinal().)^
1.5157 +**
1.5158 +** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is
1.5159 +** less than or equal to zero or if a memory allocate error occurs.
1.5160 +**
1.5161 +** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
1.5162 +** determined by the N parameter on first successful call. Changing the
1.5163 +** value of N in subsequent call to sqlite3_aggregate_context() within
1.5164 +** the same aggregate function instance will not resize the memory
1.5165 +** allocation.)^
1.5166 +**
1.5167 +** ^SQLite automatically frees the memory allocated by
1.5168 +** sqlite3_aggregate_context() when the aggregate query concludes.
1.5169 +**
1.5170 +** The first parameter must be a copy of the
1.5171 +** [sqlite3_context | SQL function context] that is the first parameter
1.5172 +** to the xStep or xFinal callback routine that implements the aggregate
1.5173 ** function.
1.5174 **
1.5175 ** This routine must be called from the same thread in which
1.5176 ** the aggregate SQL function is running.
1.5177 */
1.5178 -void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
1.5179 +SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
1.5180
1.5181 /*
1.5182 ** CAPI3REF: User Data For Functions
1.5183 **
1.5184 -** The pUserData parameter to the [sqlite3_create_function()]
1.5185 -** and [sqlite3_create_function16()] routines
1.5186 -** used to register user functions is available to
1.5187 -** the implementation of the function using this call.
1.5188 +** ^The sqlite3_user_data() interface returns a copy of
1.5189 +** the pointer that was the pUserData parameter (the 5th parameter)
1.5190 +** of the [sqlite3_create_function()]
1.5191 +** and [sqlite3_create_function16()] routines that originally
1.5192 +** registered the application defined function.
1.5193 **
1.5194 ** This routine must be called from the same thread in which
1.5195 -** the SQL function is running.
1.5196 -*/
1.5197 -void *sqlite3_user_data(sqlite3_context*);
1.5198 +** the application-defined function is running.
1.5199 +*/
1.5200 +SQLITE_API void *sqlite3_user_data(sqlite3_context*);
1.5201 +
1.5202 +/*
1.5203 +** CAPI3REF: Database Connection For Functions
1.5204 +**
1.5205 +** ^The sqlite3_context_db_handle() interface returns a copy of
1.5206 +** the pointer to the [database connection] (the 1st parameter)
1.5207 +** of the [sqlite3_create_function()]
1.5208 +** and [sqlite3_create_function16()] routines that originally
1.5209 +** registered the application defined function.
1.5210 +*/
1.5211 +SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
1.5212
1.5213 /*
1.5214 ** CAPI3REF: Function Auxiliary Data
1.5215 **
1.5216 ** The following two functions may be used by scalar SQL functions to
1.5217 -** associate meta-data with argument values. If the same value is passed to
1.5218 +** associate metadata with argument values. If the same value is passed to
1.5219 ** multiple invocations of the same SQL function during query execution, under
1.5220 -** some circumstances the associated meta-data may be preserved. This may
1.5221 +** some circumstances the associated metadata may be preserved. This may
1.5222 ** be used, for example, to add a regular-expression matching scalar
1.5223 ** function. The compiled version of the regular expression is stored as
1.5224 -** meta-data associated with the SQL value passed as the regular expression
1.5225 +** metadata associated with the SQL value passed as the regular expression
1.5226 ** pattern. The compiled regular expression can be reused on multiple
1.5227 ** invocations of the same function so that the original pattern string
1.5228 ** does not need to be recompiled on each invocation.
1.5229 **
1.5230 -** The sqlite3_get_auxdata() interface returns a pointer to the meta-data
1.5231 -** associated with the Nth argument value to the current SQL function
1.5232 -** call, where N is the second parameter. If no meta-data has been set for
1.5233 -** that value, then a NULL pointer is returned.
1.5234 -**
1.5235 -** The sqlite3_set_auxdata() is used to associate meta-data with an SQL
1.5236 -** function argument. The third parameter is a pointer to the meta-data
1.5237 -** to be associated with the Nth user function argument value. The fourth
1.5238 -** parameter specifies a destructor that will be called on the meta-
1.5239 -** data pointer to release it when it is no longer required. If the
1.5240 -** destructor is NULL, it is not invoked.
1.5241 -**
1.5242 -** In practice, meta-data is preserved between function calls for
1.5243 +** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
1.5244 +** associated by the sqlite3_set_auxdata() function with the Nth argument
1.5245 +** value to the application-defined function. ^If no metadata has been ever
1.5246 +** been set for the Nth argument of the function, or if the corresponding
1.5247 +** function parameter has changed since the meta-data was set,
1.5248 +** then sqlite3_get_auxdata() returns a NULL pointer.
1.5249 +**
1.5250 +** ^The sqlite3_set_auxdata() interface saves the metadata
1.5251 +** pointed to by its 3rd parameter as the metadata for the N-th
1.5252 +** argument of the application-defined function. Subsequent
1.5253 +** calls to sqlite3_get_auxdata() might return this data, if it has
1.5254 +** not been destroyed.
1.5255 +** ^If it is not NULL, SQLite will invoke the destructor
1.5256 +** function given by the 4th parameter to sqlite3_set_auxdata() on
1.5257 +** the metadata when the corresponding function parameter changes
1.5258 +** or when the SQL statement completes, whichever comes first.
1.5259 +**
1.5260 +** SQLite is free to call the destructor and drop metadata on any
1.5261 +** parameter of any function at any time. ^The only guarantee is that
1.5262 +** the destructor will be called before the metadata is dropped.
1.5263 +**
1.5264 +** ^(In practice, metadata is preserved between function calls for
1.5265 ** expressions that are constant at compile time. This includes literal
1.5266 -** values and SQL variables.
1.5267 +** values and [parameters].)^
1.5268 **
1.5269 ** These routines must be called from the same thread in which
1.5270 ** the SQL function is running.
1.5271 */
1.5272 -void *sqlite3_get_auxdata(sqlite3_context*, int);
1.5273 -void sqlite3_set_auxdata(sqlite3_context*, int, void*, void (*)(void*));
1.5274 +SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
1.5275 +SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
1.5276
1.5277
1.5278 /*
1.5279 ** CAPI3REF: Constants Defining Special Destructor Behavior
1.5280 **
1.5281 -** These are special value for the destructor that is passed in as the
1.5282 -** final argument to routines like [sqlite3_result_blob()]. If the destructor
1.5283 +** These are special values for the destructor that is passed in as the
1.5284 +** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
1.5285 ** argument is SQLITE_STATIC, it means that the content pointer is constant
1.5286 -** and will never change. It does not need to be destroyed. The
1.5287 +** and will never change. It does not need to be destroyed. ^The
1.5288 ** SQLITE_TRANSIENT value means that the content will likely change in
1.5289 ** the near future and that SQLite should make its own private copy of
1.5290 ** the content before returning.
1.5291 @@ -2472,143 +4099,265 @@
1.5292 ** [sqlite3_create_function()] and [sqlite3_create_function16()]
1.5293 ** for additional information.
1.5294 **
1.5295 -** These functions work very much like the
1.5296 -** [sqlite3_bind_blob | sqlite3_bind_*] family of functions used
1.5297 -** to bind values to host parameters in prepared statements.
1.5298 -** Refer to the
1.5299 -** [sqlite3_bind_blob | sqlite3_bind_* documentation] for
1.5300 -** additional information.
1.5301 -**
1.5302 -** The sqlite3_result_error() and sqlite3_result_error16() functions
1.5303 -** cause the implemented SQL function to throw an exception. The
1.5304 -** parameter to sqlite3_result_error() or sqlite3_result_error16()
1.5305 -** is the text of an error message.
1.5306 -**
1.5307 -** The sqlite3_result_toobig() cause the function implementation
1.5308 -** to throw and error indicating that a string or BLOB is to long
1.5309 -** to represent.
1.5310 -**
1.5311 -** These routines must be called from within the same thread as
1.5312 -** the SQL function associated with the [sqlite3_context] pointer.
1.5313 -*/
1.5314 -void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
1.5315 -void sqlite3_result_double(sqlite3_context*, double);
1.5316 -void sqlite3_result_error(sqlite3_context*, const char*, int);
1.5317 -void sqlite3_result_error16(sqlite3_context*, const void*, int);
1.5318 -void sqlite3_result_error_toobig(sqlite3_context*);
1.5319 -void sqlite3_result_error_nomem(sqlite3_context*);
1.5320 -void sqlite3_result_int(sqlite3_context*, int);
1.5321 -void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
1.5322 -void sqlite3_result_null(sqlite3_context*);
1.5323 -void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
1.5324 -void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
1.5325 -void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
1.5326 -void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
1.5327 -void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
1.5328 -void sqlite3_result_zeroblob(sqlite3_context*, int n);
1.5329 +** These functions work very much like the [parameter binding] family of
1.5330 +** functions used to bind values to host parameters in prepared statements.
1.5331 +** Refer to the [SQL parameter] documentation for additional information.
1.5332 +**
1.5333 +** ^The sqlite3_result_blob() interface sets the result from
1.5334 +** an application-defined function to be the BLOB whose content is pointed
1.5335 +** to by the second parameter and which is N bytes long where N is the
1.5336 +** third parameter.
1.5337 +**
1.5338 +** ^The sqlite3_result_zeroblob() interfaces set the result of
1.5339 +** the application-defined function to be a BLOB containing all zero
1.5340 +** bytes and N bytes in size, where N is the value of the 2nd parameter.
1.5341 +**
1.5342 +** ^The sqlite3_result_double() interface sets the result from
1.5343 +** an application-defined function to be a floating point value specified
1.5344 +** by its 2nd argument.
1.5345 +**
1.5346 +** ^The sqlite3_result_error() and sqlite3_result_error16() functions
1.5347 +** cause the implemented SQL function to throw an exception.
1.5348 +** ^SQLite uses the string pointed to by the
1.5349 +** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
1.5350 +** as the text of an error message. ^SQLite interprets the error
1.5351 +** message string from sqlite3_result_error() as UTF-8. ^SQLite
1.5352 +** interprets the string from sqlite3_result_error16() as UTF-16 in native
1.5353 +** byte order. ^If the third parameter to sqlite3_result_error()
1.5354 +** or sqlite3_result_error16() is negative then SQLite takes as the error
1.5355 +** message all text up through the first zero character.
1.5356 +** ^If the third parameter to sqlite3_result_error() or
1.5357 +** sqlite3_result_error16() is non-negative then SQLite takes that many
1.5358 +** bytes (not characters) from the 2nd parameter as the error message.
1.5359 +** ^The sqlite3_result_error() and sqlite3_result_error16()
1.5360 +** routines make a private copy of the error message text before
1.5361 +** they return. Hence, the calling function can deallocate or
1.5362 +** modify the text after they return without harm.
1.5363 +** ^The sqlite3_result_error_code() function changes the error code
1.5364 +** returned by SQLite as a result of an error in a function. ^By default,
1.5365 +** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
1.5366 +** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
1.5367 +**
1.5368 +** ^The sqlite3_result_toobig() interface causes SQLite to throw an error
1.5369 +** indicating that a string or BLOB is too long to represent.
1.5370 +**
1.5371 +** ^The sqlite3_result_nomem() interface causes SQLite to throw an error
1.5372 +** indicating that a memory allocation failed.
1.5373 +**
1.5374 +** ^The sqlite3_result_int() interface sets the return value
1.5375 +** of the application-defined function to be the 32-bit signed integer
1.5376 +** value given in the 2nd argument.
1.5377 +** ^The sqlite3_result_int64() interface sets the return value
1.5378 +** of the application-defined function to be the 64-bit signed integer
1.5379 +** value given in the 2nd argument.
1.5380 +**
1.5381 +** ^The sqlite3_result_null() interface sets the return value
1.5382 +** of the application-defined function to be NULL.
1.5383 +**
1.5384 +** ^The sqlite3_result_text(), sqlite3_result_text16(),
1.5385 +** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
1.5386 +** set the return value of the application-defined function to be
1.5387 +** a text string which is represented as UTF-8, UTF-16 native byte order,
1.5388 +** UTF-16 little endian, or UTF-16 big endian, respectively.
1.5389 +** ^SQLite takes the text result from the application from
1.5390 +** the 2nd parameter of the sqlite3_result_text* interfaces.
1.5391 +** ^If the 3rd parameter to the sqlite3_result_text* interfaces
1.5392 +** is negative, then SQLite takes result text from the 2nd parameter
1.5393 +** through the first zero character.
1.5394 +** ^If the 3rd parameter to the sqlite3_result_text* interfaces
1.5395 +** is non-negative, then as many bytes (not characters) of the text
1.5396 +** pointed to by the 2nd parameter are taken as the application-defined
1.5397 +** function result. If the 3rd parameter is non-negative, then it
1.5398 +** must be the byte offset into the string where the NUL terminator would
1.5399 +** appear if the string where NUL terminated. If any NUL characters occur
1.5400 +** in the string at a byte offset that is less than the value of the 3rd
1.5401 +** parameter, then the resulting string will contain embedded NULs and the
1.5402 +** result of expressions operating on strings with embedded NULs is undefined.
1.5403 +** ^If the 4th parameter to the sqlite3_result_text* interfaces
1.5404 +** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
1.5405 +** function as the destructor on the text or BLOB result when it has
1.5406 +** finished using that result.
1.5407 +** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
1.5408 +** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
1.5409 +** assumes that the text or BLOB result is in constant space and does not
1.5410 +** copy the content of the parameter nor call a destructor on the content
1.5411 +** when it has finished using that result.
1.5412 +** ^If the 4th parameter to the sqlite3_result_text* interfaces
1.5413 +** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
1.5414 +** then SQLite makes a copy of the result into space obtained from
1.5415 +** from [sqlite3_malloc()] before it returns.
1.5416 +**
1.5417 +** ^The sqlite3_result_value() interface sets the result of
1.5418 +** the application-defined function to be a copy the
1.5419 +** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
1.5420 +** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
1.5421 +** so that the [sqlite3_value] specified in the parameter may change or
1.5422 +** be deallocated after sqlite3_result_value() returns without harm.
1.5423 +** ^A [protected sqlite3_value] object may always be used where an
1.5424 +** [unprotected sqlite3_value] object is required, so either
1.5425 +** kind of [sqlite3_value] object can be used with this interface.
1.5426 +**
1.5427 +** If these routines are called from within the different thread
1.5428 +** than the one containing the application-defined function that received
1.5429 +** the [sqlite3_context] pointer, the results are undefined.
1.5430 +*/
1.5431 +SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
1.5432 +SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
1.5433 +SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
1.5434 +SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
1.5435 +SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
1.5436 +SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
1.5437 +SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
1.5438 +SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
1.5439 +SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
1.5440 +SQLITE_API void sqlite3_result_null(sqlite3_context*);
1.5441 +SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
1.5442 +SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
1.5443 +SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
1.5444 +SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
1.5445 +SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
1.5446 +SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
1.5447
1.5448 /*
1.5449 ** CAPI3REF: Define New Collating Sequences
1.5450 **
1.5451 -** These functions are used to add new collation sequences to the
1.5452 -** [sqlite3*] handle specified as the first argument.
1.5453 -**
1.5454 -** The name of the new collation sequence is specified as a UTF-8 string
1.5455 +** ^These functions add, remove, or modify a [collation] associated
1.5456 +** with the [database connection] specified as the first argument.
1.5457 +**
1.5458 +** ^The name of the collation is a UTF-8 string
1.5459 ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
1.5460 -** and a UTF-16 string for sqlite3_create_collation16(). In all cases
1.5461 -** the name is passed as the second function argument.
1.5462 -**
1.5463 -** The third argument must be one of the constants [SQLITE_UTF8],
1.5464 -** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied
1.5465 -** routine expects to be passed pointers to strings encoded using UTF-8,
1.5466 -** UTF-16 little-endian or UTF-16 big-endian respectively.
1.5467 -**
1.5468 -** A pointer to the user supplied routine must be passed as the fifth
1.5469 -** argument. If it is NULL, this is the same as deleting the collation
1.5470 -** sequence (so that SQLite cannot call it anymore). Each time the user
1.5471 -** supplied function is invoked, it is passed a copy of the void* passed as
1.5472 -** the fourth argument to sqlite3_create_collation() or
1.5473 -** sqlite3_create_collation16() as its first parameter.
1.5474 -**
1.5475 -** The remaining arguments to the user-supplied routine are two strings,
1.5476 -** each represented by a [length, data] pair and encoded in the encoding
1.5477 -** that was passed as the third argument when the collation sequence was
1.5478 -** registered. The user routine should return negative, zero or positive if
1.5479 -** the first string is less than, equal to, or greater than the second
1.5480 -** string. i.e. (STRING1 - STRING2).
1.5481 -**
1.5482 -** The sqlite3_create_collation_v2() works like sqlite3_create_collation()
1.5483 -** excapt that it takes an extra argument which is a destructor for
1.5484 -** the collation. The destructor is called when the collation is
1.5485 -** destroyed and is passed a copy of the fourth parameter void* pointer
1.5486 -** of the sqlite3_create_collation_v2(). Collations are destroyed when
1.5487 -** they are overridden by later calls to the collation creation functions
1.5488 -** or when the [sqlite3*] database handle is closed using [sqlite3_close()].
1.5489 -**
1.5490 -** The sqlite3_create_collation_v2() interface is experimental and
1.5491 -** subject to change in future releases. The other collation creation
1.5492 -** functions are stable.
1.5493 -*/
1.5494 -int sqlite3_create_collation(
1.5495 +** and a UTF-16 string in native byte order for sqlite3_create_collation16().
1.5496 +** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
1.5497 +** considered to be the same name.
1.5498 +**
1.5499 +** ^(The third argument (eTextRep) must be one of the constants:
1.5500 +** <ul>
1.5501 +** <li> [SQLITE_UTF8],
1.5502 +** <li> [SQLITE_UTF16LE],
1.5503 +** <li> [SQLITE_UTF16BE],
1.5504 +** <li> [SQLITE_UTF16], or
1.5505 +** <li> [SQLITE_UTF16_ALIGNED].
1.5506 +** </ul>)^
1.5507 +** ^The eTextRep argument determines the encoding of strings passed
1.5508 +** to the collating function callback, xCallback.
1.5509 +** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
1.5510 +** force strings to be UTF16 with native byte order.
1.5511 +** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
1.5512 +** on an even byte address.
1.5513 +**
1.5514 +** ^The fourth argument, pArg, is an application data pointer that is passed
1.5515 +** through as the first argument to the collating function callback.
1.5516 +**
1.5517 +** ^The fifth argument, xCallback, is a pointer to the collating function.
1.5518 +** ^Multiple collating functions can be registered using the same name but
1.5519 +** with different eTextRep parameters and SQLite will use whichever
1.5520 +** function requires the least amount of data transformation.
1.5521 +** ^If the xCallback argument is NULL then the collating function is
1.5522 +** deleted. ^When all collating functions having the same name are deleted,
1.5523 +** that collation is no longer usable.
1.5524 +**
1.5525 +** ^The collating function callback is invoked with a copy of the pArg
1.5526 +** application data pointer and with two strings in the encoding specified
1.5527 +** by the eTextRep argument. The collating function must return an
1.5528 +** integer that is negative, zero, or positive
1.5529 +** if the first string is less than, equal to, or greater than the second,
1.5530 +** respectively. A collating function must always return the same answer
1.5531 +** given the same inputs. If two or more collating functions are registered
1.5532 +** to the same collation name (using different eTextRep values) then all
1.5533 +** must give an equivalent answer when invoked with equivalent strings.
1.5534 +** The collating function must obey the following properties for all
1.5535 +** strings A, B, and C:
1.5536 +**
1.5537 +** <ol>
1.5538 +** <li> If A==B then B==A.
1.5539 +** <li> If A==B and B==C then A==C.
1.5540 +** <li> If A<B THEN B>A.
1.5541 +** <li> If A<B and B<C then A<C.
1.5542 +** </ol>
1.5543 +**
1.5544 +** If a collating function fails any of the above constraints and that
1.5545 +** collating function is registered and used, then the behavior of SQLite
1.5546 +** is undefined.
1.5547 +**
1.5548 +** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
1.5549 +** with the addition that the xDestroy callback is invoked on pArg when
1.5550 +** the collating function is deleted.
1.5551 +** ^Collating functions are deleted when they are overridden by later
1.5552 +** calls to the collation creation functions or when the
1.5553 +** [database connection] is closed using [sqlite3_close()].
1.5554 +**
1.5555 +** ^The xDestroy callback is <u>not</u> called if the
1.5556 +** sqlite3_create_collation_v2() function fails. Applications that invoke
1.5557 +** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
1.5558 +** check the return code and dispose of the application data pointer
1.5559 +** themselves rather than expecting SQLite to deal with it for them.
1.5560 +** This is different from every other SQLite interface. The inconsistency
1.5561 +** is unfortunate but cannot be changed without breaking backwards
1.5562 +** compatibility.
1.5563 +**
1.5564 +** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
1.5565 +*/
1.5566 +SQLITE_API int sqlite3_create_collation(
1.5567 sqlite3*,
1.5568 const char *zName,
1.5569 int eTextRep,
1.5570 - void*,
1.5571 + void *pArg,
1.5572 int(*xCompare)(void*,int,const void*,int,const void*)
1.5573 );
1.5574 -int sqlite3_create_collation_v2(
1.5575 +SQLITE_API int sqlite3_create_collation_v2(
1.5576 sqlite3*,
1.5577 const char *zName,
1.5578 int eTextRep,
1.5579 - void*,
1.5580 + void *pArg,
1.5581 int(*xCompare)(void*,int,const void*,int,const void*),
1.5582 void(*xDestroy)(void*)
1.5583 );
1.5584 -int sqlite3_create_collation16(
1.5585 +SQLITE_API int sqlite3_create_collation16(
1.5586 sqlite3*,
1.5587 - const char *zName,
1.5588 + const void *zName,
1.5589 int eTextRep,
1.5590 - void*,
1.5591 + void *pArg,
1.5592 int(*xCompare)(void*,int,const void*,int,const void*)
1.5593 );
1.5594
1.5595 /*
1.5596 ** CAPI3REF: Collation Needed Callbacks
1.5597 **
1.5598 -** To avoid having to register all collation sequences before a database
1.5599 +** ^To avoid having to register all collation sequences before a database
1.5600 ** can be used, a single callback function may be registered with the
1.5601 -** database handle to be called whenever an undefined collation sequence is
1.5602 -** required.
1.5603 -**
1.5604 -** If the function is registered using the sqlite3_collation_needed() API,
1.5605 +** [database connection] to be invoked whenever an undefined collation
1.5606 +** sequence is required.
1.5607 +**
1.5608 +** ^If the function is registered using the sqlite3_collation_needed() API,
1.5609 ** then it is passed the names of undefined collation sequences as strings
1.5610 -** encoded in UTF-8. If sqlite3_collation_needed16() is used, the names
1.5611 -** are passed as UTF-16 in machine native byte order. A call to either
1.5612 -** function replaces any existing callback.
1.5613 -**
1.5614 -** When the callback is invoked, the first argument passed is a copy
1.5615 +** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
1.5616 +** the names are passed as UTF-16 in machine native byte order.
1.5617 +** ^A call to either function replaces the existing collation-needed callback.
1.5618 +**
1.5619 +** ^(When the callback is invoked, the first argument passed is a copy
1.5620 ** of the second argument to sqlite3_collation_needed() or
1.5621 -** sqlite3_collation_needed16(). The second argument is the database
1.5622 -** handle. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], or
1.5623 -** [SQLITE_UTF16LE], indicating the most desirable form of the collation
1.5624 -** sequence function required. The fourth parameter is the name of the
1.5625 -** required collation sequence.
1.5626 +** sqlite3_collation_needed16(). The second argument is the database
1.5627 +** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
1.5628 +** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
1.5629 +** sequence function required. The fourth parameter is the name of the
1.5630 +** required collation sequence.)^
1.5631 **
1.5632 ** The callback function should register the desired collation using
1.5633 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
1.5634 ** [sqlite3_create_collation_v2()].
1.5635 */
1.5636 -int sqlite3_collation_needed(
1.5637 +SQLITE_API int sqlite3_collation_needed(
1.5638 sqlite3*,
1.5639 void*,
1.5640 void(*)(void*,sqlite3*,int eTextRep,const char*)
1.5641 );
1.5642 -int sqlite3_collation_needed16(
1.5643 +SQLITE_API int sqlite3_collation_needed16(
1.5644 sqlite3*,
1.5645 void*,
1.5646 void(*)(void*,sqlite3*,int eTextRep,const void*)
1.5647 );
1.5648
1.5649 +#ifdef SQLITE_HAS_CODEC
1.5650 /*
1.5651 ** Specify the key for an encrypted database. This routine should be
1.5652 ** called right after sqlite3_open().
1.5653 @@ -2616,7 +4365,7 @@
1.5654 ** The code to implement this API is not available in the public release
1.5655 ** of SQLite.
1.5656 */
1.5657 -int sqlite3_key(
1.5658 +SQLITE_API int sqlite3_key(
1.5659 sqlite3 *db, /* Database to be rekeyed */
1.5660 const void *pKey, int nKey /* The key */
1.5661 );
1.5662 @@ -2629,256 +4378,459 @@
1.5663 ** The code to implement this API is not available in the public release
1.5664 ** of SQLite.
1.5665 */
1.5666 -int sqlite3_rekey(
1.5667 +SQLITE_API int sqlite3_rekey(
1.5668 sqlite3 *db, /* Database to be rekeyed */
1.5669 const void *pKey, int nKey /* The new key */
1.5670 );
1.5671
1.5672 /*
1.5673 -** CAPI3REF: Suspend Execution For A Short Time
1.5674 -**
1.5675 -** This function causes the current thread to suspend execution
1.5676 -** a number of milliseconds specified in its parameter.
1.5677 -**
1.5678 -** If the operating system does not support sleep requests with
1.5679 -** millisecond time resolution, then the time will be rounded up to
1.5680 -** the nearest second. The number of milliseconds of sleep actually
1.5681 +** Specify the activation key for a SEE database. Unless
1.5682 +** activated, none of the SEE routines will work.
1.5683 +*/
1.5684 +SQLITE_API void sqlite3_activate_see(
1.5685 + const char *zPassPhrase /* Activation phrase */
1.5686 +);
1.5687 +#endif
1.5688 +
1.5689 +#ifdef SQLITE_ENABLE_CEROD
1.5690 +/*
1.5691 +** Specify the activation key for a CEROD database. Unless
1.5692 +** activated, none of the CEROD routines will work.
1.5693 +*/
1.5694 +SQLITE_API void sqlite3_activate_cerod(
1.5695 + const char *zPassPhrase /* Activation phrase */
1.5696 +);
1.5697 +#endif
1.5698 +
1.5699 +/*
1.5700 +** CAPI3REF: Suspend Execution For A Short Time
1.5701 +**
1.5702 +** The sqlite3_sleep() function causes the current thread to suspend execution
1.5703 +** for at least a number of milliseconds specified in its parameter.
1.5704 +**
1.5705 +** If the operating system does not support sleep requests with
1.5706 +** millisecond time resolution, then the time will be rounded up to
1.5707 +** the nearest second. The number of milliseconds of sleep actually
1.5708 ** requested from the operating system is returned.
1.5709 **
1.5710 -** SQLite implements this interface by calling the xSleep()
1.5711 -** method of the default [sqlite3_vfs] object.
1.5712 -*/
1.5713 -int sqlite3_sleep(int);
1.5714 -
1.5715 -/*
1.5716 -** CAPI3REF: Name Of The Folder Holding Temporary Files
1.5717 -**
1.5718 -** If this global variable is made to point to a string which is
1.5719 -** the name of a folder (a.ka. directory), then all temporary files
1.5720 -** created by SQLite will be placed in that directory. If this variable
1.5721 -** is NULL pointer, then SQLite does a search for an appropriate temporary
1.5722 -** file directory.
1.5723 -**
1.5724 -** It is not safe to modify this variable once a database connection
1.5725 -** has been opened. It is intended that this variable be set once
1.5726 +** ^SQLite implements this interface by calling the xSleep()
1.5727 +** method of the default [sqlite3_vfs] object. If the xSleep() method
1.5728 +** of the default VFS is not implemented correctly, or not implemented at
1.5729 +** all, then the behavior of sqlite3_sleep() may deviate from the description
1.5730 +** in the previous paragraphs.
1.5731 +*/
1.5732 +SQLITE_API int sqlite3_sleep(int);
1.5733 +
1.5734 +/*
1.5735 +** CAPI3REF: Name Of The Folder Holding Temporary Files
1.5736 +**
1.5737 +** ^(If this global variable is made to point to a string which is
1.5738 +** the name of a folder (a.k.a. directory), then all temporary files
1.5739 +** created by SQLite when using a built-in [sqlite3_vfs | VFS]
1.5740 +** will be placed in that directory.)^ ^If this variable
1.5741 +** is a NULL pointer, then SQLite performs a search for an appropriate
1.5742 +** temporary file directory.
1.5743 +**
1.5744 +** It is not safe to read or modify this variable in more than one
1.5745 +** thread at a time. It is not safe to read or modify this variable
1.5746 +** if a [database connection] is being used at the same time in a separate
1.5747 +** thread.
1.5748 +** It is intended that this variable be set once
1.5749 ** as part of process initialization and before any SQLite interface
1.5750 -** routines have been call and remain unchanged thereafter.
1.5751 -*/
1.5752 -SQLITE_EXTERN char *sqlite3_temp_directory;
1.5753 -
1.5754 -/*
1.5755 -** CAPI3REF: Test To See If The Database Is In Auto-Commit Mode
1.5756 -**
1.5757 -** Test to see whether or not the database connection is in autocommit
1.5758 -** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1.5759 -** by default. Autocommit is disabled by a BEGIN statement and reenabled
1.5760 -** by the next COMMIT or ROLLBACK.
1.5761 +** routines have been called and that this variable remain unchanged
1.5762 +** thereafter.
1.5763 +**
1.5764 +** ^The [temp_store_directory pragma] may modify this variable and cause
1.5765 +** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
1.5766 +** the [temp_store_directory pragma] always assumes that any string
1.5767 +** that this variable points to is held in memory obtained from
1.5768 +** [sqlite3_malloc] and the pragma may attempt to free that memory
1.5769 +** using [sqlite3_free].
1.5770 +** Hence, if this variable is modified directly, either it should be
1.5771 +** made NULL or made to point to memory obtained from [sqlite3_malloc]
1.5772 +** or else the use of the [temp_store_directory pragma] should be avoided.
1.5773 +*/
1.5774 +SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
1.5775 +
1.5776 +/*
1.5777 +** CAPI3REF: Name Of The Folder Holding Database Files
1.5778 +**
1.5779 +** ^(If this global variable is made to point to a string which is
1.5780 +** the name of a folder (a.k.a. directory), then all database files
1.5781 +** specified with a relative pathname and created or accessed by
1.5782 +** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
1.5783 +** to be relative to that directory.)^ ^If this variable is a NULL
1.5784 +** pointer, then SQLite assumes that all database files specified
1.5785 +** with a relative pathname are relative to the current directory
1.5786 +** for the process. Only the windows VFS makes use of this global
1.5787 +** variable; it is ignored by the unix VFS.
1.5788 +**
1.5789 +** Changing the value of this variable while a database connection is
1.5790 +** open can result in a corrupt database.
1.5791 +**
1.5792 +** It is not safe to read or modify this variable in more than one
1.5793 +** thread at a time. It is not safe to read or modify this variable
1.5794 +** if a [database connection] is being used at the same time in a separate
1.5795 +** thread.
1.5796 +** It is intended that this variable be set once
1.5797 +** as part of process initialization and before any SQLite interface
1.5798 +** routines have been called and that this variable remain unchanged
1.5799 +** thereafter.
1.5800 +**
1.5801 +** ^The [data_store_directory pragma] may modify this variable and cause
1.5802 +** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
1.5803 +** the [data_store_directory pragma] always assumes that any string
1.5804 +** that this variable points to is held in memory obtained from
1.5805 +** [sqlite3_malloc] and the pragma may attempt to free that memory
1.5806 +** using [sqlite3_free].
1.5807 +** Hence, if this variable is modified directly, either it should be
1.5808 +** made NULL or made to point to memory obtained from [sqlite3_malloc]
1.5809 +** or else the use of the [data_store_directory pragma] should be avoided.
1.5810 +*/
1.5811 +SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory;
1.5812 +
1.5813 +/*
1.5814 +** CAPI3REF: Test For Auto-Commit Mode
1.5815 +** KEYWORDS: {autocommit mode}
1.5816 +**
1.5817 +** ^The sqlite3_get_autocommit() interface returns non-zero or
1.5818 +** zero if the given database connection is or is not in autocommit mode,
1.5819 +** respectively. ^Autocommit mode is on by default.
1.5820 +** ^Autocommit mode is disabled by a [BEGIN] statement.
1.5821 +** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
1.5822 **
1.5823 ** If certain kinds of errors occur on a statement within a multi-statement
1.5824 -** transactions (errors including [SQLITE_FULL], [SQLITE_IOERR],
1.5825 +** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
1.5826 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
1.5827 ** transaction might be rolled back automatically. The only way to
1.5828 -** find out if SQLite automatically rolled back the transaction after
1.5829 +** find out whether SQLite automatically rolled back the transaction after
1.5830 ** an error is to use this function.
1.5831 **
1.5832 ** If another thread changes the autocommit status of the database
1.5833 ** connection while this routine is running, then the return value
1.5834 ** is undefined.
1.5835 */
1.5836 -int sqlite3_get_autocommit(sqlite3*);
1.5837 -
1.5838 -/*
1.5839 -** CAPI3REF: Find The Database Handle Associated With A Prepared Statement
1.5840 -**
1.5841 -** Return the [sqlite3*] database handle to which a
1.5842 -** [sqlite3_stmt | prepared statement] belongs.
1.5843 -** This is the same database handle that was
1.5844 -** the first argument to the [sqlite3_prepare_v2()] or its variants
1.5845 -** that was used to create the statement in the first place.
1.5846 -*/
1.5847 -sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
1.5848 -
1.5849 +SQLITE_API int sqlite3_get_autocommit(sqlite3*);
1.5850 +
1.5851 +/*
1.5852 +** CAPI3REF: Find The Database Handle Of A Prepared Statement
1.5853 +**
1.5854 +** ^The sqlite3_db_handle interface returns the [database connection] handle
1.5855 +** to which a [prepared statement] belongs. ^The [database connection]
1.5856 +** returned by sqlite3_db_handle is the same [database connection]
1.5857 +** that was the first argument
1.5858 +** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
1.5859 +** create the statement in the first place.
1.5860 +*/
1.5861 +SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
1.5862 +
1.5863 +/*
1.5864 +** CAPI3REF: Return The Filename For A Database Connection
1.5865 +**
1.5866 +** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
1.5867 +** associated with database N of connection D. ^The main database file
1.5868 +** has the name "main". If there is no attached database N on the database
1.5869 +** connection D, or if database N is a temporary or in-memory database, then
1.5870 +** a NULL pointer is returned.
1.5871 +**
1.5872 +** ^The filename returned by this function is the output of the
1.5873 +** xFullPathname method of the [VFS]. ^In other words, the filename
1.5874 +** will be an absolute pathname, even if the filename used
1.5875 +** to open the database originally was a URI or relative pathname.
1.5876 +*/
1.5877 +SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
1.5878 +
1.5879 +/*
1.5880 +** CAPI3REF: Determine if a database is read-only
1.5881 +**
1.5882 +** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
1.5883 +** of connection D is read-only, 0 if it is read/write, or -1 if N is not
1.5884 +** the name of a database on connection D.
1.5885 +*/
1.5886 +SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
1.5887 +
1.5888 +/*
1.5889 +** CAPI3REF: Find the next prepared statement
1.5890 +**
1.5891 +** ^This interface returns a pointer to the next [prepared statement] after
1.5892 +** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
1.5893 +** then this interface returns a pointer to the first prepared statement
1.5894 +** associated with the database connection pDb. ^If no prepared statement
1.5895 +** satisfies the conditions of this routine, it returns NULL.
1.5896 +**
1.5897 +** The [database connection] pointer D in a call to
1.5898 +** [sqlite3_next_stmt(D,S)] must refer to an open database
1.5899 +** connection and in particular must not be a NULL pointer.
1.5900 +*/
1.5901 +SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
1.5902
1.5903 /*
1.5904 ** CAPI3REF: Commit And Rollback Notification Callbacks
1.5905 **
1.5906 -** These routines
1.5907 -** register callback functions to be invoked whenever a transaction
1.5908 -** is committed or rolled back. The pArg argument is passed through
1.5909 -** to the callback. If the callback on a commit hook function
1.5910 -** returns non-zero, then the commit is converted into a rollback.
1.5911 -**
1.5912 -** If another function was previously registered, its pArg value is returned.
1.5913 -** Otherwise NULL is returned.
1.5914 -**
1.5915 -** Registering a NULL function disables the callback.
1.5916 -**
1.5917 -** For the purposes of this API, a transaction is said to have been
1.5918 +** ^The sqlite3_commit_hook() interface registers a callback
1.5919 +** function to be invoked whenever a transaction is [COMMIT | committed].
1.5920 +** ^Any callback set by a previous call to sqlite3_commit_hook()
1.5921 +** for the same database connection is overridden.
1.5922 +** ^The sqlite3_rollback_hook() interface registers a callback
1.5923 +** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
1.5924 +** ^Any callback set by a previous call to sqlite3_rollback_hook()
1.5925 +** for the same database connection is overridden.
1.5926 +** ^The pArg argument is passed through to the callback.
1.5927 +** ^If the callback on a commit hook function returns non-zero,
1.5928 +** then the commit is converted into a rollback.
1.5929 +**
1.5930 +** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
1.5931 +** return the P argument from the previous call of the same function
1.5932 +** on the same [database connection] D, or NULL for
1.5933 +** the first call for each function on D.
1.5934 +**
1.5935 +** The commit and rollback hook callbacks are not reentrant.
1.5936 +** The callback implementation must not do anything that will modify
1.5937 +** the database connection that invoked the callback. Any actions
1.5938 +** to modify the database connection must be deferred until after the
1.5939 +** completion of the [sqlite3_step()] call that triggered the commit
1.5940 +** or rollback hook in the first place.
1.5941 +** Note that running any other SQL statements, including SELECT statements,
1.5942 +** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
1.5943 +** the database connections for the meaning of "modify" in this paragraph.
1.5944 +**
1.5945 +** ^Registering a NULL function disables the callback.
1.5946 +**
1.5947 +** ^When the commit hook callback routine returns zero, the [COMMIT]
1.5948 +** operation is allowed to continue normally. ^If the commit hook
1.5949 +** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
1.5950 +** ^The rollback hook is invoked on a rollback that results from a commit
1.5951 +** hook returning non-zero, just as it would be with any other rollback.
1.5952 +**
1.5953 +** ^For the purposes of this API, a transaction is said to have been
1.5954 ** rolled back if an explicit "ROLLBACK" statement is executed, or
1.5955 -** an error or constraint causes an implicit rollback to occur. The
1.5956 -** callback is not invoked if a transaction is automatically rolled
1.5957 -** back because the database connection is closed.
1.5958 -**
1.5959 -** These are experimental interfaces and are subject to change.
1.5960 -*/
1.5961 -void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
1.5962 -void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
1.5963 +** an error or constraint causes an implicit rollback to occur.
1.5964 +** ^The rollback callback is not invoked if a transaction is
1.5965 +** automatically rolled back because the database connection is closed.
1.5966 +**
1.5967 +** See also the [sqlite3_update_hook()] interface.
1.5968 +*/
1.5969 +SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
1.5970 +SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
1.5971
1.5972 /*
1.5973 ** CAPI3REF: Data Change Notification Callbacks
1.5974 **
1.5975 -** Register a callback function with the database connection identified by the
1.5976 -** first argument to be invoked whenever a row is updated, inserted or deleted.
1.5977 -** Any callback set by a previous call to this function for the same
1.5978 -** database connection is overridden.
1.5979 -**
1.5980 -** The second argument is a pointer to the function to invoke when a
1.5981 -** row is updated, inserted or deleted. The first argument to the callback is
1.5982 -** a copy of the third argument to sqlite3_update_hook(). The second callback
1.5983 -** argument is one of SQLITE_INSERT, SQLITE_DELETE or SQLITE_UPDATE, depending
1.5984 -** on the operation that caused the callback to be invoked. The third and
1.5985 -** fourth arguments to the callback contain pointers to the database and
1.5986 -** table name containing the affected row. The final callback parameter is
1.5987 -** the rowid of the row. In the case of an update, this is the rowid after
1.5988 -** the update takes place.
1.5989 -**
1.5990 -** The update hook is not invoked when internal system tables are
1.5991 -** modified (i.e. sqlite_master and sqlite_sequence).
1.5992 -**
1.5993 -** If another function was previously registered, its pArg value is returned.
1.5994 -** Otherwise NULL is returned.
1.5995 -*/
1.5996 -void *sqlite3_update_hook(
1.5997 +** ^The sqlite3_update_hook() interface registers a callback function
1.5998 +** with the [database connection] identified by the first argument
1.5999 +** to be invoked whenever a row is updated, inserted or deleted.
1.6000 +** ^Any callback set by a previous call to this function
1.6001 +** for the same database connection is overridden.
1.6002 +**
1.6003 +** ^The second argument is a pointer to the function to invoke when a
1.6004 +** row is updated, inserted or deleted.
1.6005 +** ^The first argument to the callback is a copy of the third argument
1.6006 +** to sqlite3_update_hook().
1.6007 +** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
1.6008 +** or [SQLITE_UPDATE], depending on the operation that caused the callback
1.6009 +** to be invoked.
1.6010 +** ^The third and fourth arguments to the callback contain pointers to the
1.6011 +** database and table name containing the affected row.
1.6012 +** ^The final callback parameter is the [rowid] of the row.
1.6013 +** ^In the case of an update, this is the [rowid] after the update takes place.
1.6014 +**
1.6015 +** ^(The update hook is not invoked when internal system tables are
1.6016 +** modified (i.e. sqlite_master and sqlite_sequence).)^
1.6017 +**
1.6018 +** ^In the current implementation, the update hook
1.6019 +** is not invoked when duplication rows are deleted because of an
1.6020 +** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
1.6021 +** invoked when rows are deleted using the [truncate optimization].
1.6022 +** The exceptions defined in this paragraph might change in a future
1.6023 +** release of SQLite.
1.6024 +**
1.6025 +** The update hook implementation must not do anything that will modify
1.6026 +** the database connection that invoked the update hook. Any actions
1.6027 +** to modify the database connection must be deferred until after the
1.6028 +** completion of the [sqlite3_step()] call that triggered the update hook.
1.6029 +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1.6030 +** database connections for the meaning of "modify" in this paragraph.
1.6031 +**
1.6032 +** ^The sqlite3_update_hook(D,C,P) function
1.6033 +** returns the P argument from the previous call
1.6034 +** on the same [database connection] D, or NULL for
1.6035 +** the first call on D.
1.6036 +**
1.6037 +** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
1.6038 +** interfaces.
1.6039 +*/
1.6040 +SQLITE_API void *sqlite3_update_hook(
1.6041 sqlite3*,
1.6042 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
1.6043 void*
1.6044 );
1.6045
1.6046 /*
1.6047 -** CAPI3REF: Enable Or Disable Shared Pager Cache
1.6048 -**
1.6049 -** This routine enables or disables the sharing of the database cache
1.6050 -** and schema data structures between connections to the same database.
1.6051 -** Sharing is enabled if the argument is true and disabled if the argument
1.6052 -** is false.
1.6053 -**
1.6054 -** Beginning in SQLite version 3.5.0, cache sharing is enabled and disabled
1.6055 -** for an entire process. In prior versions of SQLite, sharing was
1.6056 -** enabled or disabled for each thread separately.
1.6057 -**
1.6058 -** The cache sharing mode set by this interface effects all subsequent
1.6059 +** CAPI3REF: Enable Or Disable Shared Pager Cache
1.6060 +**
1.6061 +** ^(This routine enables or disables the sharing of the database cache
1.6062 +** and schema data structures between [database connection | connections]
1.6063 +** to the same database. Sharing is enabled if the argument is true
1.6064 +** and disabled if the argument is false.)^
1.6065 +**
1.6066 +** ^Cache sharing is enabled and disabled for an entire process.
1.6067 +** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
1.6068 +** sharing was enabled or disabled for each thread separately.
1.6069 +**
1.6070 +** ^(The cache sharing mode set by this interface effects all subsequent
1.6071 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
1.6072 -** Existing database connections continue use the sharing mode that was
1.6073 -** in effect at the time they were opened.
1.6074 -**
1.6075 -** Virtual tables cannot be used with a shared cache. When shared
1.6076 -** cache is enabled, the [sqlite3_create_module()] API used to register
1.6077 -** virtual tables will always return an error.
1.6078 -**
1.6079 -** This routine returns [SQLITE_OK] if shared cache was
1.6080 -** enabled or disabled successfully. An [SQLITE_ERROR | error code]
1.6081 -** is returned otherwise.
1.6082 -**
1.6083 -** Shared cache is disabled by default. But this might change in
1.6084 +** Existing database connections continue use the sharing mode
1.6085 +** that was in effect at the time they were opened.)^
1.6086 +**
1.6087 +** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
1.6088 +** successfully. An [error code] is returned otherwise.)^
1.6089 +**
1.6090 +** ^Shared cache is disabled by default. But this might change in
1.6091 ** future releases of SQLite. Applications that care about shared
1.6092 ** cache setting should set it explicitly.
1.6093 -*/
1.6094 -int sqlite3_enable_shared_cache(int);
1.6095 -
1.6096 -/*
1.6097 -** CAPI3REF: Attempt To Free Heap Memory
1.6098 -**
1.6099 -** Attempt to free N bytes of heap memory by deallocating non-essential
1.6100 -** memory allocations held by the database library (example: memory
1.6101 -** used to cache database pages to improve performance).
1.6102 -*/
1.6103 -int sqlite3_release_memory(int);
1.6104 -
1.6105 -/*
1.6106 -** CAPI3REF: Impose A Limit On Heap Size
1.6107 -**
1.6108 -** Place a "soft" limit on the amount of heap memory that may be allocated
1.6109 -** by SQLite. If an internal allocation is requested
1.6110 -** that would exceed the specified limit, [sqlite3_release_memory()] is
1.6111 -** invoked one or more times to free up some space before the allocation
1.6112 -** is made.
1.6113 -**
1.6114 -** The limit is called "soft", because if [sqlite3_release_memory()] cannot
1.6115 -** free sufficient memory to prevent the limit from being exceeded,
1.6116 -** the memory is allocated anyway and the current operation proceeds.
1.6117 -**
1.6118 -** A negative or zero value for N means that there is no soft heap limit and
1.6119 -** [sqlite3_release_memory()] will only be called when memory is exhausted.
1.6120 -** The default value for the soft heap limit is zero.
1.6121 -**
1.6122 -** SQLite makes a best effort to honor the soft heap limit. But if it
1.6123 -** is unable to reduce memory usage below the soft limit, execution will
1.6124 -** continue without error or notification. This is why the limit is
1.6125 -** called a "soft" limit. It is advisory only.
1.6126 -**
1.6127 -** The soft heap limit is implemented using the [sqlite3_memory_alarm()]
1.6128 -** interface. Only a single memory alarm is available in the default
1.6129 -** implementation. This means that if the application also uses the
1.6130 -** memory alarm interface it will interfere with the operation of the
1.6131 -** soft heap limit and undefined behavior will result.
1.6132 -**
1.6133 -** Prior to SQLite version 3.5.0, this routine only constrained the memory
1.6134 -** allocated by a single thread - the same thread in which this routine
1.6135 -** runs. Beginning with SQLite version 3.5.0, the soft heap limit is
1.6136 -** applied to all threads. The value specified for the soft heap limit
1.6137 -** is an upper bound on the total memory allocation for all threads. In
1.6138 -** version 3.5.0 there is no mechanism for limiting the heap usage for
1.6139 -** individual threads.
1.6140 -*/
1.6141 -void sqlite3_soft_heap_limit(int);
1.6142 -
1.6143 -/*
1.6144 -** CAPI3REF: Extract Metadata About A Column Of A Table
1.6145 -**
1.6146 -** This routine
1.6147 -** returns meta-data about a specific column of a specific database
1.6148 -** table accessible using the connection handle passed as the first function
1.6149 -** argument.
1.6150 -**
1.6151 -** The column is identified by the second, third and fourth parameters to
1.6152 -** this function. The second parameter is either the name of the database
1.6153 -** (i.e. "main", "temp" or an attached database) containing the specified
1.6154 -** table or NULL. If it is NULL, then all attached databases are searched
1.6155 -** for the table using the same algorithm as the database engine uses to
1.6156 +**
1.6157 +** See Also: [SQLite Shared-Cache Mode]
1.6158 +*/
1.6159 +SQLITE_API int sqlite3_enable_shared_cache(int);
1.6160 +
1.6161 +/*
1.6162 +** CAPI3REF: Attempt To Free Heap Memory
1.6163 +**
1.6164 +** ^The sqlite3_release_memory() interface attempts to free N bytes
1.6165 +** of heap memory by deallocating non-essential memory allocations
1.6166 +** held by the database library. Memory used to cache database
1.6167 +** pages to improve performance is an example of non-essential memory.
1.6168 +** ^sqlite3_release_memory() returns the number of bytes actually freed,
1.6169 +** which might be more or less than the amount requested.
1.6170 +** ^The sqlite3_release_memory() routine is a no-op returning zero
1.6171 +** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
1.6172 +**
1.6173 +** See also: [sqlite3_db_release_memory()]
1.6174 +*/
1.6175 +SQLITE_API int sqlite3_release_memory(int);
1.6176 +
1.6177 +/*
1.6178 +** CAPI3REF: Free Memory Used By A Database Connection
1.6179 +**
1.6180 +** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
1.6181 +** memory as possible from database connection D. Unlike the
1.6182 +** [sqlite3_release_memory()] interface, this interface is effect even
1.6183 +** when then [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
1.6184 +** omitted.
1.6185 +**
1.6186 +** See also: [sqlite3_release_memory()]
1.6187 +*/
1.6188 +SQLITE_API int sqlite3_db_release_memory(sqlite3*);
1.6189 +
1.6190 +/*
1.6191 +** CAPI3REF: Impose A Limit On Heap Size
1.6192 +**
1.6193 +** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
1.6194 +** soft limit on the amount of heap memory that may be allocated by SQLite.
1.6195 +** ^SQLite strives to keep heap memory utilization below the soft heap
1.6196 +** limit by reducing the number of pages held in the page cache
1.6197 +** as heap memory usages approaches the limit.
1.6198 +** ^The soft heap limit is "soft" because even though SQLite strives to stay
1.6199 +** below the limit, it will exceed the limit rather than generate
1.6200 +** an [SQLITE_NOMEM] error. In other words, the soft heap limit
1.6201 +** is advisory only.
1.6202 +**
1.6203 +** ^The return value from sqlite3_soft_heap_limit64() is the size of
1.6204 +** the soft heap limit prior to the call, or negative in the case of an
1.6205 +** error. ^If the argument N is negative
1.6206 +** then no change is made to the soft heap limit. Hence, the current
1.6207 +** size of the soft heap limit can be determined by invoking
1.6208 +** sqlite3_soft_heap_limit64() with a negative argument.
1.6209 +**
1.6210 +** ^If the argument N is zero then the soft heap limit is disabled.
1.6211 +**
1.6212 +** ^(The soft heap limit is not enforced in the current implementation
1.6213 +** if one or more of following conditions are true:
1.6214 +**
1.6215 +** <ul>
1.6216 +** <li> The soft heap limit is set to zero.
1.6217 +** <li> Memory accounting is disabled using a combination of the
1.6218 +** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
1.6219 +** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
1.6220 +** <li> An alternative page cache implementation is specified using
1.6221 +** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
1.6222 +** <li> The page cache allocates from its own memory pool supplied
1.6223 +** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
1.6224 +** from the heap.
1.6225 +** </ul>)^
1.6226 +**
1.6227 +** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
1.6228 +** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
1.6229 +** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
1.6230 +** the soft heap limit is enforced on every memory allocation. Without
1.6231 +** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
1.6232 +** when memory is allocated by the page cache. Testing suggests that because
1.6233 +** the page cache is the predominate memory user in SQLite, most
1.6234 +** applications will achieve adequate soft heap limit enforcement without
1.6235 +** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
1.6236 +**
1.6237 +** The circumstances under which SQLite will enforce the soft heap limit may
1.6238 +** changes in future releases of SQLite.
1.6239 +*/
1.6240 +SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
1.6241 +
1.6242 +/*
1.6243 +** CAPI3REF: Deprecated Soft Heap Limit Interface
1.6244 +** DEPRECATED
1.6245 +**
1.6246 +** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
1.6247 +** interface. This routine is provided for historical compatibility
1.6248 +** only. All new applications should use the
1.6249 +** [sqlite3_soft_heap_limit64()] interface rather than this one.
1.6250 +*/
1.6251 +SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
1.6252 +
1.6253 +
1.6254 +/*
1.6255 +** CAPI3REF: Extract Metadata About A Column Of A Table
1.6256 +**
1.6257 +** ^This routine returns metadata about a specific column of a specific
1.6258 +** database table accessible using the [database connection] handle
1.6259 +** passed as the first function argument.
1.6260 +**
1.6261 +** ^The column is identified by the second, third and fourth parameters to
1.6262 +** this function. ^The second parameter is either the name of the database
1.6263 +** (i.e. "main", "temp", or an attached database) containing the specified
1.6264 +** table or NULL. ^If it is NULL, then all attached databases are searched
1.6265 +** for the table using the same algorithm used by the database engine to
1.6266 ** resolve unqualified table references.
1.6267 **
1.6268 -** The third and fourth parameters to this function are the table and column
1.6269 -** name of the desired column, respectively. Neither of these parameters
1.6270 +** ^The third and fourth parameters to this function are the table and column
1.6271 +** name of the desired column, respectively. Neither of these parameters
1.6272 ** may be NULL.
1.6273 **
1.6274 -** Meta information is returned by writing to the memory locations passed as
1.6275 -** the 5th and subsequent parameters to this function. Any of these
1.6276 -** arguments may be NULL, in which case the corresponding element of meta
1.6277 -** information is ommitted.
1.6278 -**
1.6279 -** <pre>
1.6280 -** Parameter Output Type Description
1.6281 -** -----------------------------------
1.6282 -**
1.6283 -** 5th const char* Data type
1.6284 -** 6th const char* Name of the default collation sequence
1.6285 -** 7th int True if the column has a NOT NULL constraint
1.6286 -** 8th int True if the column is part of the PRIMARY KEY
1.6287 -** 9th int True if the column is AUTOINCREMENT
1.6288 -** </pre>
1.6289 -**
1.6290 -**
1.6291 -** The memory pointed to by the character pointers returned for the
1.6292 -** declaration type and collation sequence is valid only until the next
1.6293 -** call to any sqlite API function.
1.6294 -**
1.6295 -** If the specified table is actually a view, then an error is returned.
1.6296 -**
1.6297 -** If the specified column is "rowid", "oid" or "_rowid_" and an
1.6298 -** INTEGER PRIMARY KEY column has been explicitly declared, then the output
1.6299 -** parameters are set for the explicitly declared column. If there is no
1.6300 -** explicitly declared IPK column, then the output parameters are set as
1.6301 -** follows:
1.6302 +** ^Metadata is returned by writing to the memory locations passed as the 5th
1.6303 +** and subsequent parameters to this function. ^Any of these arguments may be
1.6304 +** NULL, in which case the corresponding element of metadata is omitted.
1.6305 +**
1.6306 +** ^(<blockquote>
1.6307 +** <table border="1">
1.6308 +** <tr><th> Parameter <th> Output<br>Type <th> Description
1.6309 +**
1.6310 +** <tr><td> 5th <td> const char* <td> Data type
1.6311 +** <tr><td> 6th <td> const char* <td> Name of default collation sequence
1.6312 +** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
1.6313 +** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
1.6314 +** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
1.6315 +** </table>
1.6316 +** </blockquote>)^
1.6317 +**
1.6318 +** ^The memory pointed to by the character pointers returned for the
1.6319 +** declaration type and collation sequence is valid only until the next
1.6320 +** call to any SQLite API function.
1.6321 +**
1.6322 +** ^If the specified table is actually a view, an [error code] is returned.
1.6323 +**
1.6324 +** ^If the specified column is "rowid", "oid" or "_rowid_" and an
1.6325 +** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
1.6326 +** parameters are set for the explicitly declared column. ^(If there is no
1.6327 +** explicitly declared [INTEGER PRIMARY KEY] column, then the output
1.6328 +** parameters are set as follows:
1.6329 **
1.6330 ** <pre>
1.6331 ** data type: "INTEGER"
1.6332 @@ -2886,17 +4838,17 @@
1.6333 ** not null: 0
1.6334 ** primary key: 1
1.6335 ** auto increment: 0
1.6336 -** </pre>
1.6337 -**
1.6338 -** This function may load one or more schemas from database files. If an
1.6339 +** </pre>)^
1.6340 +**
1.6341 +** ^(This function may load one or more schemas from database files. If an
1.6342 ** error occurs during this process, or if the requested table or column
1.6343 -** cannot be found, an SQLITE error code is returned and an error message
1.6344 -** left in the database handle (to be retrieved using sqlite3_errmsg()).
1.6345 -**
1.6346 -** This API is only available if the library was compiled with the
1.6347 -** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
1.6348 -*/
1.6349 -int sqlite3_table_column_metadata(
1.6350 +** cannot be found, an [error code] is returned and an error message left
1.6351 +** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^
1.6352 +**
1.6353 +** ^This API is only available if the library was compiled with the
1.6354 +** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
1.6355 +*/
1.6356 +SQLITE_API int sqlite3_table_column_metadata(
1.6357 sqlite3 *db, /* Connection handle */
1.6358 const char *zDbName, /* Database name or NULL */
1.6359 const char *zTableName, /* Table name */
1.6360 @@ -2911,20 +4863,29 @@
1.6361 /*
1.6362 ** CAPI3REF: Load An Extension
1.6363 **
1.6364 -** Attempt to load an SQLite extension library contained in the file
1.6365 -** zFile. The entry point is zProc. zProc may be 0 in which case the
1.6366 -** name of the entry point defaults to "sqlite3_extension_init".
1.6367 -**
1.6368 -** Return [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
1.6369 -**
1.6370 -** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
1.6371 -** error message text. The calling function should free this memory
1.6372 -** by calling [sqlite3_free()].
1.6373 -**
1.6374 -** Extension loading must be enabled using [sqlite3_enable_load_extension()]
1.6375 -** prior to calling this API or an error will be returned.
1.6376 -*/
1.6377 -int sqlite3_load_extension(
1.6378 +** ^This interface loads an SQLite extension library from the named file.
1.6379 +**
1.6380 +** ^The sqlite3_load_extension() interface attempts to load an
1.6381 +** SQLite extension library contained in the file zFile.
1.6382 +**
1.6383 +** ^The entry point is zProc.
1.6384 +** ^zProc may be 0, in which case the name of the entry point
1.6385 +** defaults to "sqlite3_extension_init".
1.6386 +** ^The sqlite3_load_extension() interface returns
1.6387 +** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
1.6388 +** ^If an error occurs and pzErrMsg is not 0, then the
1.6389 +** [sqlite3_load_extension()] interface shall attempt to
1.6390 +** fill *pzErrMsg with error message text stored in memory
1.6391 +** obtained from [sqlite3_malloc()]. The calling function
1.6392 +** should free this memory by calling [sqlite3_free()].
1.6393 +**
1.6394 +** ^Extension loading must be enabled using
1.6395 +** [sqlite3_enable_load_extension()] prior to calling this API,
1.6396 +** otherwise an error will be returned.
1.6397 +**
1.6398 +** See also the [load_extension() SQL function].
1.6399 +*/
1.6400 +SQLITE_API int sqlite3_load_extension(
1.6401 sqlite3 *db, /* Load the extension into this database connection */
1.6402 const char *zFile, /* Name of the shared library containing extension */
1.6403 const char *zProc, /* Entry point. Derived from zFile if 0 */
1.6404 @@ -2932,70 +4893,71 @@
1.6405 );
1.6406
1.6407 /*
1.6408 -** CAPI3REF: Enable Or Disable Extension Loading
1.6409 -**
1.6410 -** So as not to open security holes in older applications that are
1.6411 +** CAPI3REF: Enable Or Disable Extension Loading
1.6412 +**
1.6413 +** ^So as not to open security holes in older applications that are
1.6414 ** unprepared to deal with extension loading, and as a means of disabling
1.6415 -** extension loading while evaluating user-entered SQL, the following
1.6416 -** API is provided to turn the [sqlite3_load_extension()] mechanism on and
1.6417 -** off. It is off by default. See ticket #1863.
1.6418 -**
1.6419 -** Call this routine with onoff==1 to turn extension loading on
1.6420 -** and call it with onoff==0 to turn it back off again.
1.6421 -*/
1.6422 -int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
1.6423 -
1.6424 -/*
1.6425 -** CAPI3REF: Make Arrangements To Automatically Load An Extension
1.6426 -**
1.6427 -** Register an extension entry point that is automatically invoked
1.6428 -** whenever a new database connection is opened using
1.6429 -** [sqlite3_open()], [sqlite3_open16()], or [sqlite3_open_v2()].
1.6430 -**
1.6431 -** This API can be invoked at program startup in order to register
1.6432 -** one or more statically linked extensions that will be available
1.6433 -** to all new database connections.
1.6434 -**
1.6435 -** Duplicate extensions are detected so calling this routine multiple
1.6436 -** times with the same extension is harmless.
1.6437 -**
1.6438 -** This routine stores a pointer to the extension in an array
1.6439 -** that is obtained from malloc(). If you run a memory leak
1.6440 -** checker on your program and it reports a leak because of this
1.6441 -** array, then invoke [sqlite3_automatic_extension_reset()] prior
1.6442 -** to shutdown to free the memory.
1.6443 -**
1.6444 -** Automatic extensions apply across all threads.
1.6445 -**
1.6446 -** This interface is experimental and is subject to change or
1.6447 -** removal in future releases of SQLite.
1.6448 -*/
1.6449 -int sqlite3_auto_extension(void *xEntryPoint);
1.6450 -
1.6451 +** extension loading while evaluating user-entered SQL, the following API
1.6452 +** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
1.6453 +**
1.6454 +** ^Extension loading is off by default. See ticket #1863.
1.6455 +** ^Call the sqlite3_enable_load_extension() routine with onoff==1
1.6456 +** to turn extension loading on and call it with onoff==0 to turn
1.6457 +** it back off again.
1.6458 +*/
1.6459 +SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
1.6460 +
1.6461 +/*
1.6462 +** CAPI3REF: Automatically Load Statically Linked Extensions
1.6463 +**
1.6464 +** ^This interface causes the xEntryPoint() function to be invoked for
1.6465 +** each new [database connection] that is created. The idea here is that
1.6466 +** xEntryPoint() is the entry point for a statically linked SQLite extension
1.6467 +** that is to be automatically loaded into all new database connections.
1.6468 +**
1.6469 +** ^(Even though the function prototype shows that xEntryPoint() takes
1.6470 +** no arguments and returns void, SQLite invokes xEntryPoint() with three
1.6471 +** arguments and expects and integer result as if the signature of the
1.6472 +** entry point where as follows:
1.6473 +**
1.6474 +** <blockquote><pre>
1.6475 +** int xEntryPoint(
1.6476 +** sqlite3 *db,
1.6477 +** const char **pzErrMsg,
1.6478 +** const struct sqlite3_api_routines *pThunk
1.6479 +** );
1.6480 +** </pre></blockquote>)^
1.6481 +**
1.6482 +** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
1.6483 +** point to an appropriate error message (obtained from [sqlite3_mprintf()])
1.6484 +** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
1.6485 +** is NULL before calling the xEntryPoint(). ^SQLite will invoke
1.6486 +** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
1.6487 +** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
1.6488 +** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
1.6489 +**
1.6490 +** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
1.6491 +** on the list of automatic extensions is a harmless no-op. ^No entry point
1.6492 +** will be called more than once for each database connection that is opened.
1.6493 +**
1.6494 +** See also: [sqlite3_reset_auto_extension()].
1.6495 +*/
1.6496 +SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void));
1.6497
1.6498 /*
1.6499 ** CAPI3REF: Reset Automatic Extension Loading
1.6500 **
1.6501 -** Disable all previously registered automatic extensions. This
1.6502 -** routine undoes the effect of all prior [sqlite3_automatic_extension()]
1.6503 -** calls.
1.6504 -**
1.6505 -** This call disabled automatic extensions in all threads.
1.6506 -**
1.6507 -** This interface is experimental and is subject to change or
1.6508 -** removal in future releases of SQLite.
1.6509 -*/
1.6510 -void sqlite3_reset_auto_extension(void);
1.6511 -
1.6512 -
1.6513 -/*
1.6514 -****** EXPERIMENTAL - subject to change without notice **************
1.6515 -**
1.6516 +** ^This interface disables all automatic extensions previously
1.6517 +** registered using [sqlite3_auto_extension()].
1.6518 +*/
1.6519 +SQLITE_API void sqlite3_reset_auto_extension(void);
1.6520 +
1.6521 +/*
1.6522 ** The interface to the virtual-table mechanism is currently considered
1.6523 ** to be experimental. The interface might change in incompatible ways.
1.6524 ** If this is a problem for you, do not use the interface at this time.
1.6525 **
1.6526 -** When the virtual-table mechanism stablizes, we will declare the
1.6527 +** When the virtual-table mechanism stabilizes, we will declare the
1.6528 ** interface fixed, support it indefinitely, and remove this comment.
1.6529 */
1.6530
1.6531 @@ -3008,9 +4970,20 @@
1.6532 typedef struct sqlite3_module sqlite3_module;
1.6533
1.6534 /*
1.6535 -** A module is a class of virtual tables. Each module is defined
1.6536 -** by an instance of the following structure. This structure consists
1.6537 -** mostly of methods for the module.
1.6538 +** CAPI3REF: Virtual Table Object
1.6539 +** KEYWORDS: sqlite3_module {virtual table module}
1.6540 +**
1.6541 +** This structure, sometimes called a "virtual table module",
1.6542 +** defines the implementation of a [virtual tables].
1.6543 +** This structure consists mostly of methods for the module.
1.6544 +**
1.6545 +** ^A virtual table module is created by filling in a persistent
1.6546 +** instance of this structure and passing a pointer to that instance
1.6547 +** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
1.6548 +** ^The registration remains valid until it is replaced by a different
1.6549 +** module or until the [database connection] closes. The content
1.6550 +** of this structure must not change while it is registered with
1.6551 +** any database connection.
1.6552 */
1.6553 struct sqlite3_module {
1.6554 int iVersion;
1.6555 @@ -3039,52 +5012,63 @@
1.6556 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
1.6557 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
1.6558 void **ppArg);
1.6559 -
1.6560 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
1.6561 + /* The methods above are in version 1 of the sqlite_module object. Those
1.6562 + ** below are for version 2 and greater. */
1.6563 + int (*xSavepoint)(sqlite3_vtab *pVTab, int);
1.6564 + int (*xRelease)(sqlite3_vtab *pVTab, int);
1.6565 + int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
1.6566 };
1.6567
1.6568 /*
1.6569 -** The sqlite3_index_info structure and its substructures is used to
1.6570 -** pass information into and receive the reply from the xBestIndex
1.6571 -** method of an sqlite3_module. The fields under **Inputs** are the
1.6572 +** CAPI3REF: Virtual Table Indexing Information
1.6573 +** KEYWORDS: sqlite3_index_info
1.6574 +**
1.6575 +** The sqlite3_index_info structure and its substructures is used as part
1.6576 +** of the [virtual table] interface to
1.6577 +** pass information into and receive the reply from the [xBestIndex]
1.6578 +** method of a [virtual table module]. The fields under **Inputs** are the
1.6579 ** inputs to xBestIndex and are read-only. xBestIndex inserts its
1.6580 ** results into the **Outputs** fields.
1.6581 **
1.6582 -** The aConstraint[] array records WHERE clause constraints of the
1.6583 -** form:
1.6584 -**
1.6585 -** column OP expr
1.6586 -**
1.6587 -** Where OP is =, <, <=, >, or >=. The particular operator is stored
1.6588 -** in aConstraint[].op. The index of the column is stored in
1.6589 -** aConstraint[].iColumn. aConstraint[].usable is TRUE if the
1.6590 +** ^(The aConstraint[] array records WHERE clause constraints of the form:
1.6591 +**
1.6592 +** <blockquote>column OP expr</blockquote>
1.6593 +**
1.6594 +** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is
1.6595 +** stored in aConstraint[].op using one of the
1.6596 +** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
1.6597 +** ^(The index of the column is stored in
1.6598 +** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
1.6599 ** expr on the right-hand side can be evaluated (and thus the constraint
1.6600 -** is usable) and false if it cannot.
1.6601 -**
1.6602 -** The optimizer automatically inverts terms of the form "expr OP column"
1.6603 +** is usable) and false if it cannot.)^
1.6604 +**
1.6605 +** ^The optimizer automatically inverts terms of the form "expr OP column"
1.6606 ** and makes other simplifications to the WHERE clause in an attempt to
1.6607 ** get as many WHERE clause terms into the form shown above as possible.
1.6608 -** The aConstraint[] array only reports WHERE clause terms in the correct
1.6609 -** form that refer to the particular virtual table being queried.
1.6610 -**
1.6611 -** Information about the ORDER BY clause is stored in aOrderBy[].
1.6612 -** Each term of aOrderBy records a column of the ORDER BY clause.
1.6613 -**
1.6614 -** The xBestIndex method must fill aConstraintUsage[] with information
1.6615 -** about what parameters to pass to xFilter. If argvIndex>0 then
1.6616 +** ^The aConstraint[] array only reports WHERE clause terms that are
1.6617 +** relevant to the particular virtual table being queried.
1.6618 +**
1.6619 +** ^Information about the ORDER BY clause is stored in aOrderBy[].
1.6620 +** ^Each term of aOrderBy records a column of the ORDER BY clause.
1.6621 +**
1.6622 +** The [xBestIndex] method must fill aConstraintUsage[] with information
1.6623 +** about what parameters to pass to xFilter. ^If argvIndex>0 then
1.6624 ** the right-hand side of the corresponding aConstraint[] is evaluated
1.6625 -** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit
1.6626 +** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
1.6627 ** is true, then the constraint is assumed to be fully handled by the
1.6628 -** virtual table and is not checked again by SQLite.
1.6629 -**
1.6630 -** The idxNum and idxPtr values are recorded and passed into xFilter.
1.6631 -** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true.
1.6632 -**
1.6633 -** The orderByConsumed means that output from xFilter will occur in
1.6634 +** virtual table and is not checked again by SQLite.)^
1.6635 +**
1.6636 +** ^The idxNum and idxPtr values are recorded and passed into the
1.6637 +** [xFilter] method.
1.6638 +** ^[sqlite3_free()] is used to free idxPtr if and only if
1.6639 +** needToFreeIdxPtr is true.
1.6640 +**
1.6641 +** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
1.6642 ** the correct order to satisfy the ORDER BY clause so that no separate
1.6643 ** sorting step is required.
1.6644 **
1.6645 -** The estimatedCost value is an estimate of the cost of doing the
1.6646 +** ^The estimatedCost value is an estimate of the cost of doing the
1.6647 ** particular lookup. A full scan of a table with N entries should have
1.6648 ** a cost of N. A binary search of a table of N entries should have a
1.6649 ** cost of approximately log(N).
1.6650 @@ -3103,7 +5087,6 @@
1.6651 int iColumn; /* Column number */
1.6652 unsigned char desc; /* True for DESC. False for ASC. */
1.6653 } *aOrderBy; /* The ORDER BY clause */
1.6654 -
1.6655 /* Outputs */
1.6656 struct sqlite3_index_constraint_usage {
1.6657 int argvIndex; /* if >0, constraint is part of argv to xFilter */
1.6658 @@ -3115,6 +5098,15 @@
1.6659 int orderByConsumed; /* True if output is already ordered */
1.6660 double estimatedCost; /* Estimated cost of using this index */
1.6661 };
1.6662 +
1.6663 +/*
1.6664 +** CAPI3REF: Virtual Table Constraint Operator Codes
1.6665 +**
1.6666 +** These macros defined the allowed values for the
1.6667 +** [sqlite3_index_info].aConstraint[].op field. Each value represents
1.6668 +** an operator that is part of a constraint term in the wHERE clause of
1.6669 +** a query that uses a [virtual table].
1.6670 +*/
1.6671 #define SQLITE_INDEX_CONSTRAINT_EQ 2
1.6672 #define SQLITE_INDEX_CONSTRAINT_GT 4
1.6673 #define SQLITE_INDEX_CONSTRAINT_LE 8
1.6674 @@ -3123,59 +5115,81 @@
1.6675 #define SQLITE_INDEX_CONSTRAINT_MATCH 64
1.6676
1.6677 /*
1.6678 -** This routine is used to register a new module name with an SQLite
1.6679 -** connection. Module names must be registered before creating new
1.6680 -** virtual tables on the module, or before using preexisting virtual
1.6681 -** tables of the module.
1.6682 -*/
1.6683 -int sqlite3_create_module(
1.6684 - sqlite3 *db, /* SQLite connection to register module with */
1.6685 - const char *zName, /* Name of the module */
1.6686 - const sqlite3_module *, /* Methods for the module */
1.6687 - void * /* Client data for xCreate/xConnect */
1.6688 -);
1.6689 -
1.6690 -/*
1.6691 -** This routine is identical to the sqlite3_create_module() method above,
1.6692 -** except that it allows a destructor function to be specified. It is
1.6693 -** even more experimental than the rest of the virtual tables API.
1.6694 -*/
1.6695 -int sqlite3_create_module_v2(
1.6696 +** CAPI3REF: Register A Virtual Table Implementation
1.6697 +**
1.6698 +** ^These routines are used to register a new [virtual table module] name.
1.6699 +** ^Module names must be registered before
1.6700 +** creating a new [virtual table] using the module and before using a
1.6701 +** preexisting [virtual table] for the module.
1.6702 +**
1.6703 +** ^The module name is registered on the [database connection] specified
1.6704 +** by the first parameter. ^The name of the module is given by the
1.6705 +** second parameter. ^The third parameter is a pointer to
1.6706 +** the implementation of the [virtual table module]. ^The fourth
1.6707 +** parameter is an arbitrary client data pointer that is passed through
1.6708 +** into the [xCreate] and [xConnect] methods of the virtual table module
1.6709 +** when a new virtual table is be being created or reinitialized.
1.6710 +**
1.6711 +** ^The sqlite3_create_module_v2() interface has a fifth parameter which
1.6712 +** is a pointer to a destructor for the pClientData. ^SQLite will
1.6713 +** invoke the destructor function (if it is not NULL) when SQLite
1.6714 +** no longer needs the pClientData pointer. ^The destructor will also
1.6715 +** be invoked if the call to sqlite3_create_module_v2() fails.
1.6716 +** ^The sqlite3_create_module()
1.6717 +** interface is equivalent to sqlite3_create_module_v2() with a NULL
1.6718 +** destructor.
1.6719 +*/
1.6720 +SQLITE_API int sqlite3_create_module(
1.6721 sqlite3 *db, /* SQLite connection to register module with */
1.6722 const char *zName, /* Name of the module */
1.6723 - const sqlite3_module *, /* Methods for the module */
1.6724 - void *, /* Client data for xCreate/xConnect */
1.6725 + const sqlite3_module *p, /* Methods for the module */
1.6726 + void *pClientData /* Client data for xCreate/xConnect */
1.6727 +);
1.6728 +SQLITE_API int sqlite3_create_module_v2(
1.6729 + sqlite3 *db, /* SQLite connection to register module with */
1.6730 + const char *zName, /* Name of the module */
1.6731 + const sqlite3_module *p, /* Methods for the module */
1.6732 + void *pClientData, /* Client data for xCreate/xConnect */
1.6733 void(*xDestroy)(void*) /* Module destructor function */
1.6734 );
1.6735
1.6736 /*
1.6737 -** Every module implementation uses a subclass of the following structure
1.6738 -** to describe a particular instance of the module. Each subclass will
1.6739 -** be tailored to the specific needs of the module implementation. The
1.6740 -** purpose of this superclass is to define certain fields that are common
1.6741 -** to all module implementations.
1.6742 -**
1.6743 -** Virtual tables methods can set an error message by assigning a
1.6744 -** string obtained from sqlite3_mprintf() to zErrMsg. The method should
1.6745 -** take care that any prior string is freed by a call to sqlite3_free()
1.6746 -** prior to assigning a new string to zErrMsg. After the error message
1.6747 +** CAPI3REF: Virtual Table Instance Object
1.6748 +** KEYWORDS: sqlite3_vtab
1.6749 +**
1.6750 +** Every [virtual table module] implementation uses a subclass
1.6751 +** of this object to describe a particular instance
1.6752 +** of the [virtual table]. Each subclass will
1.6753 +** be tailored to the specific needs of the module implementation.
1.6754 +** The purpose of this superclass is to define certain fields that are
1.6755 +** common to all module implementations.
1.6756 +**
1.6757 +** ^Virtual tables methods can set an error message by assigning a
1.6758 +** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
1.6759 +** take care that any prior string is freed by a call to [sqlite3_free()]
1.6760 +** prior to assigning a new string to zErrMsg. ^After the error message
1.6761 ** is delivered up to the client application, the string will be automatically
1.6762 -** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note
1.6763 -** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field
1.6764 -** since virtual tables are commonly implemented in loadable extensions which
1.6765 -** do not have access to sqlite3MPrintf() or sqlite3Free().
1.6766 +** freed by sqlite3_free() and the zErrMsg field will be zeroed.
1.6767 */
1.6768 struct sqlite3_vtab {
1.6769 const sqlite3_module *pModule; /* The module for this virtual table */
1.6770 - int nRef; /* Used internally */
1.6771 + int nRef; /* NO LONGER USED */
1.6772 char *zErrMsg; /* Error message from sqlite3_mprintf() */
1.6773 /* Virtual table implementations will typically add additional fields */
1.6774 };
1.6775
1.6776 -/* Every module implementation uses a subclass of the following structure
1.6777 -** to describe cursors that point into the virtual table and are used
1.6778 +/*
1.6779 +** CAPI3REF: Virtual Table Cursor Object
1.6780 +** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
1.6781 +**
1.6782 +** Every [virtual table module] implementation uses a subclass of the
1.6783 +** following structure to describe cursors that point into the
1.6784 +** [virtual table] and are used
1.6785 ** to loop through the virtual table. Cursors are created using the
1.6786 -** xOpen method of the module. Each module implementation will define
1.6787 +** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
1.6788 +** by the [sqlite3_module.xClose | xClose] method. Cursors are used
1.6789 +** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
1.6790 +** of the module. Each module implementation will define
1.6791 ** the content of a cursor structure to suit its own needs.
1.6792 **
1.6793 ** This superclass exists in order to define fields of the cursor that
1.6794 @@ -3187,29 +5201,32 @@
1.6795 };
1.6796
1.6797 /*
1.6798 -** The xCreate and xConnect methods of a module use the following API
1.6799 +** CAPI3REF: Declare The Schema Of A Virtual Table
1.6800 +**
1.6801 +** ^The [xCreate] and [xConnect] methods of a
1.6802 +** [virtual table module] call this interface
1.6803 ** to declare the format (the names and datatypes of the columns) of
1.6804 ** the virtual tables they implement.
1.6805 */
1.6806 -int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable);
1.6807 -
1.6808 -/*
1.6809 -** Virtual tables can provide alternative implementations of functions
1.6810 -** using the xFindFunction method. But global versions of those functions
1.6811 -** must exist in order to be overloaded.
1.6812 -**
1.6813 -** This API makes sure a global version of a function with a particular
1.6814 +SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
1.6815 +
1.6816 +/*
1.6817 +** CAPI3REF: Overload A Function For A Virtual Table
1.6818 +**
1.6819 +** ^(Virtual tables can provide alternative implementations of functions
1.6820 +** using the [xFindFunction] method of the [virtual table module].
1.6821 +** But global versions of those functions
1.6822 +** must exist in order to be overloaded.)^
1.6823 +**
1.6824 +** ^(This API makes sure a global version of a function with a particular
1.6825 ** name and number of parameters exists. If no such function exists
1.6826 -** before this API is called, a new function is created. The implementation
1.6827 +** before this API is called, a new function is created.)^ ^The implementation
1.6828 ** of the new function always causes an exception to be thrown. So
1.6829 ** the new function is not good for anything by itself. Its only
1.6830 -** purpose is to be a place-holder function that can be overloaded
1.6831 -** by virtual tables.
1.6832 -**
1.6833 -** This API should be considered part of the virtual table interface,
1.6834 -** which is experimental and subject to change.
1.6835 -*/
1.6836 -int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
1.6837 +** purpose is to be a placeholder function that can be overloaded
1.6838 +** by a [virtual table].
1.6839 +*/
1.6840 +SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
1.6841
1.6842 /*
1.6843 ** The interface to the virtual-table mechanism defined above (back up
1.6844 @@ -3219,46 +5236,79 @@
1.6845 **
1.6846 ** When the virtual-table mechanism stabilizes, we will declare the
1.6847 ** interface fixed, support it indefinitely, and remove this comment.
1.6848 -**
1.6849 -****** EXPERIMENTAL - subject to change without notice **************
1.6850 */
1.6851
1.6852 /*
1.6853 ** CAPI3REF: A Handle To An Open BLOB
1.6854 -**
1.6855 -** An instance of the following opaque structure is used to
1.6856 -** represent an blob-handle. A blob-handle is created by
1.6857 -** [sqlite3_blob_open()] and destroyed by [sqlite3_blob_close()].
1.6858 -** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
1.6859 -** can be used to read or write small subsections of the blob.
1.6860 -** The [sqlite3_blob_bytes()] interface returns the size of the
1.6861 -** blob in bytes.
1.6862 +** KEYWORDS: {BLOB handle} {BLOB handles}
1.6863 +**
1.6864 +** An instance of this object represents an open BLOB on which
1.6865 +** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
1.6866 +** ^Objects of this type are created by [sqlite3_blob_open()]
1.6867 +** and destroyed by [sqlite3_blob_close()].
1.6868 +** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
1.6869 +** can be used to read or write small subsections of the BLOB.
1.6870 +** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
1.6871 */
1.6872 typedef struct sqlite3_blob sqlite3_blob;
1.6873
1.6874 /*
1.6875 ** CAPI3REF: Open A BLOB For Incremental I/O
1.6876 **
1.6877 -** Open a handle to the blob located in row iRow,, column zColumn,
1.6878 -** table zTable in database zDb. i.e. the same blob that would
1.6879 -** be selected by:
1.6880 +** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
1.6881 +** in row iRow, column zColumn, table zTable in database zDb;
1.6882 +** in other words, the same BLOB that would be selected by:
1.6883 **
1.6884 ** <pre>
1.6885 -** SELECT zColumn FROM zDb.zTable WHERE rowid = iRow;
1.6886 -** </pre>
1.6887 -**
1.6888 -** If the flags parameter is non-zero, the blob is opened for
1.6889 -** read and write access. If it is zero, the blob is opened for read
1.6890 -** access.
1.6891 -**
1.6892 -** On success, [SQLITE_OK] is returned and the new
1.6893 -** [sqlite3_blob | blob handle] is written to *ppBlob.
1.6894 -** Otherwise an error code is returned and
1.6895 -** any value written to *ppBlob should not be used by the caller.
1.6896 -** This function sets the database-handle error code and message
1.6897 -** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()].
1.6898 -*/
1.6899 -int sqlite3_blob_open(
1.6900 +** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
1.6901 +** </pre>)^
1.6902 +**
1.6903 +** ^If the flags parameter is non-zero, then the BLOB is opened for read
1.6904 +** and write access. ^If it is zero, the BLOB is opened for read access.
1.6905 +** ^It is not possible to open a column that is part of an index or primary
1.6906 +** key for writing. ^If [foreign key constraints] are enabled, it is
1.6907 +** not possible to open a column that is part of a [child key] for writing.
1.6908 +**
1.6909 +** ^Note that the database name is not the filename that contains
1.6910 +** the database but rather the symbolic name of the database that
1.6911 +** appears after the AS keyword when the database is connected using [ATTACH].
1.6912 +** ^For the main database file, the database name is "main".
1.6913 +** ^For TEMP tables, the database name is "temp".
1.6914 +**
1.6915 +** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
1.6916 +** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
1.6917 +** to be a null pointer.)^
1.6918 +** ^This function sets the [database connection] error code and message
1.6919 +** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
1.6920 +** functions. ^Note that the *ppBlob variable is always initialized in a
1.6921 +** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
1.6922 +** regardless of the success or failure of this routine.
1.6923 +**
1.6924 +** ^(If the row that a BLOB handle points to is modified by an
1.6925 +** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
1.6926 +** then the BLOB handle is marked as "expired".
1.6927 +** This is true if any column of the row is changed, even a column
1.6928 +** other than the one the BLOB handle is open on.)^
1.6929 +** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
1.6930 +** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
1.6931 +** ^(Changes written into a BLOB prior to the BLOB expiring are not
1.6932 +** rolled back by the expiration of the BLOB. Such changes will eventually
1.6933 +** commit if the transaction continues to completion.)^
1.6934 +**
1.6935 +** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
1.6936 +** the opened blob. ^The size of a blob may not be changed by this
1.6937 +** interface. Use the [UPDATE] SQL command to change the size of a
1.6938 +** blob.
1.6939 +**
1.6940 +** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
1.6941 +** and the built-in [zeroblob] SQL function can be used, if desired,
1.6942 +** to create an empty, zero-filled blob in which to read or write using
1.6943 +** this interface.
1.6944 +**
1.6945 +** To avoid a resource leak, every open [BLOB handle] should eventually
1.6946 +** be released by a call to [sqlite3_blob_close()].
1.6947 +*/
1.6948 +SQLITE_API int sqlite3_blob_open(
1.6949 sqlite3*,
1.6950 const char *zDb,
1.6951 const char *zTable,
1.6952 @@ -3269,128 +5319,205 @@
1.6953 );
1.6954
1.6955 /*
1.6956 -** CAPI3REF: Close A BLOB Handle
1.6957 -**
1.6958 -** Close an open [sqlite3_blob | blob handle].
1.6959 -*/
1.6960 -int sqlite3_blob_close(sqlite3_blob *);
1.6961 -
1.6962 -/*
1.6963 -** CAPI3REF: Return The Size Of An Open BLOB
1.6964 -**
1.6965 -** Return the size in bytes of the blob accessible via the open
1.6966 -** [sqlite3_blob | blob-handle] passed as an argument.
1.6967 -*/
1.6968 -int sqlite3_blob_bytes(sqlite3_blob *);
1.6969 -
1.6970 -/*
1.6971 -** CAPI3REF: Read Data From A BLOB Incrementally
1.6972 -**
1.6973 -** This function is used to read data from an open
1.6974 -** [sqlite3_blob | blob-handle] into a caller supplied buffer.
1.6975 -** n bytes of data are copied into buffer
1.6976 -** z from the open blob, starting at offset iOffset.
1.6977 -**
1.6978 -** On success, SQLITE_OK is returned. Otherwise, an
1.6979 -** [SQLITE_ERROR | SQLite error code] or an
1.6980 -** [SQLITE_IOERR_READ | extended error code] is returned.
1.6981 -*/
1.6982 -int sqlite3_blob_read(sqlite3_blob *, void *z, int n, int iOffset);
1.6983 -
1.6984 -/*
1.6985 -** CAPI3REF: Write Data Into A BLOB Incrementally
1.6986 -**
1.6987 -** This function is used to write data into an open
1.6988 -** [sqlite3_blob | blob-handle] from a user supplied buffer.
1.6989 -** n bytes of data are copied from the buffer
1.6990 -** pointed to by z into the open blob, starting at offset iOffset.
1.6991 -**
1.6992 -** If the [sqlite3_blob | blob-handle] passed as the first argument
1.6993 -** was not opened for writing (the flags parameter to [sqlite3_blob_open()]
1.6994 -*** was zero), this function returns [SQLITE_READONLY].
1.6995 -**
1.6996 -** This function may only modify the contents of the blob, it is
1.6997 -** not possible to increase the size of a blob using this API. If
1.6998 -** offset iOffset is less than n bytes from the end of the blob,
1.6999 -** [SQLITE_ERROR] is returned and no data is written.
1.7000 -**
1.7001 -** On success, SQLITE_OK is returned. Otherwise, an
1.7002 -** [SQLITE_ERROR | SQLite error code] or an
1.7003 -** [SQLITE_IOERR_READ | extended error code] is returned.
1.7004 -*/
1.7005 -int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
1.7006 -
1.7007 -/*
1.7008 -** CAPI3REF: Virtual File System Objects
1.7009 +** CAPI3REF: Move a BLOB Handle to a New Row
1.7010 +**
1.7011 +** ^This function is used to move an existing blob handle so that it points
1.7012 +** to a different row of the same database table. ^The new row is identified
1.7013 +** by the rowid value passed as the second argument. Only the row can be
1.7014 +** changed. ^The database, table and column on which the blob handle is open
1.7015 +** remain the same. Moving an existing blob handle to a new row can be
1.7016 +** faster than closing the existing handle and opening a new one.
1.7017 +**
1.7018 +** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
1.7019 +** it must exist and there must be either a blob or text value stored in
1.7020 +** the nominated column.)^ ^If the new row is not present in the table, or if
1.7021 +** it does not contain a blob or text value, or if another error occurs, an
1.7022 +** SQLite error code is returned and the blob handle is considered aborted.
1.7023 +** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
1.7024 +** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
1.7025 +** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
1.7026 +** always returns zero.
1.7027 +**
1.7028 +** ^This function sets the database handle error code and message.
1.7029 +*/
1.7030 +SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
1.7031 +
1.7032 +/*
1.7033 +** CAPI3REF: Close A BLOB Handle
1.7034 +**
1.7035 +** ^Closes an open [BLOB handle].
1.7036 +**
1.7037 +** ^Closing a BLOB shall cause the current transaction to commit
1.7038 +** if there are no other BLOBs, no pending prepared statements, and the
1.7039 +** database connection is in [autocommit mode].
1.7040 +** ^If any writes were made to the BLOB, they might be held in cache
1.7041 +** until the close operation if they will fit.
1.7042 +**
1.7043 +** ^(Closing the BLOB often forces the changes
1.7044 +** out to disk and so if any I/O errors occur, they will likely occur
1.7045 +** at the time when the BLOB is closed. Any errors that occur during
1.7046 +** closing are reported as a non-zero return value.)^
1.7047 +**
1.7048 +** ^(The BLOB is closed unconditionally. Even if this routine returns
1.7049 +** an error code, the BLOB is still closed.)^
1.7050 +**
1.7051 +** ^Calling this routine with a null pointer (such as would be returned
1.7052 +** by a failed call to [sqlite3_blob_open()]) is a harmless no-op.
1.7053 +*/
1.7054 +SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
1.7055 +
1.7056 +/*
1.7057 +** CAPI3REF: Return The Size Of An Open BLOB
1.7058 +**
1.7059 +** ^Returns the size in bytes of the BLOB accessible via the
1.7060 +** successfully opened [BLOB handle] in its only argument. ^The
1.7061 +** incremental blob I/O routines can only read or overwriting existing
1.7062 +** blob content; they cannot change the size of a blob.
1.7063 +**
1.7064 +** This routine only works on a [BLOB handle] which has been created
1.7065 +** by a prior successful call to [sqlite3_blob_open()] and which has not
1.7066 +** been closed by [sqlite3_blob_close()]. Passing any other pointer in
1.7067 +** to this routine results in undefined and probably undesirable behavior.
1.7068 +*/
1.7069 +SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
1.7070 +
1.7071 +/*
1.7072 +** CAPI3REF: Read Data From A BLOB Incrementally
1.7073 +**
1.7074 +** ^(This function is used to read data from an open [BLOB handle] into a
1.7075 +** caller-supplied buffer. N bytes of data are copied into buffer Z
1.7076 +** from the open BLOB, starting at offset iOffset.)^
1.7077 +**
1.7078 +** ^If offset iOffset is less than N bytes from the end of the BLOB,
1.7079 +** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
1.7080 +** less than zero, [SQLITE_ERROR] is returned and no data is read.
1.7081 +** ^The size of the blob (and hence the maximum value of N+iOffset)
1.7082 +** can be determined using the [sqlite3_blob_bytes()] interface.
1.7083 +**
1.7084 +** ^An attempt to read from an expired [BLOB handle] fails with an
1.7085 +** error code of [SQLITE_ABORT].
1.7086 +**
1.7087 +** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
1.7088 +** Otherwise, an [error code] or an [extended error code] is returned.)^
1.7089 +**
1.7090 +** This routine only works on a [BLOB handle] which has been created
1.7091 +** by a prior successful call to [sqlite3_blob_open()] and which has not
1.7092 +** been closed by [sqlite3_blob_close()]. Passing any other pointer in
1.7093 +** to this routine results in undefined and probably undesirable behavior.
1.7094 +**
1.7095 +** See also: [sqlite3_blob_write()].
1.7096 +*/
1.7097 +SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
1.7098 +
1.7099 +/*
1.7100 +** CAPI3REF: Write Data Into A BLOB Incrementally
1.7101 +**
1.7102 +** ^This function is used to write data into an open [BLOB handle] from a
1.7103 +** caller-supplied buffer. ^N bytes of data are copied from the buffer Z
1.7104 +** into the open BLOB, starting at offset iOffset.
1.7105 +**
1.7106 +** ^If the [BLOB handle] passed as the first argument was not opened for
1.7107 +** writing (the flags parameter to [sqlite3_blob_open()] was zero),
1.7108 +** this function returns [SQLITE_READONLY].
1.7109 +**
1.7110 +** ^This function may only modify the contents of the BLOB; it is
1.7111 +** not possible to increase the size of a BLOB using this API.
1.7112 +** ^If offset iOffset is less than N bytes from the end of the BLOB,
1.7113 +** [SQLITE_ERROR] is returned and no data is written. ^If N is
1.7114 +** less than zero [SQLITE_ERROR] is returned and no data is written.
1.7115 +** The size of the BLOB (and hence the maximum value of N+iOffset)
1.7116 +** can be determined using the [sqlite3_blob_bytes()] interface.
1.7117 +**
1.7118 +** ^An attempt to write to an expired [BLOB handle] fails with an
1.7119 +** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
1.7120 +** before the [BLOB handle] expired are not rolled back by the
1.7121 +** expiration of the handle, though of course those changes might
1.7122 +** have been overwritten by the statement that expired the BLOB handle
1.7123 +** or by other independent statements.
1.7124 +**
1.7125 +** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
1.7126 +** Otherwise, an [error code] or an [extended error code] is returned.)^
1.7127 +**
1.7128 +** This routine only works on a [BLOB handle] which has been created
1.7129 +** by a prior successful call to [sqlite3_blob_open()] and which has not
1.7130 +** been closed by [sqlite3_blob_close()]. Passing any other pointer in
1.7131 +** to this routine results in undefined and probably undesirable behavior.
1.7132 +**
1.7133 +** See also: [sqlite3_blob_read()].
1.7134 +*/
1.7135 +SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
1.7136 +
1.7137 +/*
1.7138 +** CAPI3REF: Virtual File System Objects
1.7139 **
1.7140 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
1.7141 ** that SQLite uses to interact
1.7142 -** with the underlying operating system. Most builds come with a
1.7143 +** with the underlying operating system. Most SQLite builds come with a
1.7144 ** single default VFS that is appropriate for the host computer.
1.7145 ** New VFSes can be registered and existing VFSes can be unregistered.
1.7146 ** The following interfaces are provided.
1.7147 **
1.7148 -** The sqlite3_vfs_find() interface returns a pointer to a VFS given its
1.7149 -** name. Names are case sensitive. If there is no match, a NULL
1.7150 -** pointer is returned. If zVfsName is NULL then the default
1.7151 -** VFS is returned.
1.7152 -**
1.7153 -** New VFSes are registered with sqlite3_vfs_register(). Each
1.7154 -** new VFS becomes the default VFS if the makeDflt flag is set.
1.7155 -** The same VFS can be registered multiple times without injury.
1.7156 -** To make an existing VFS into the default VFS, register it again
1.7157 +** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
1.7158 +** ^Names are case sensitive.
1.7159 +** ^Names are zero-terminated UTF-8 strings.
1.7160 +** ^If there is no match, a NULL pointer is returned.
1.7161 +** ^If zVfsName is NULL then the default VFS is returned.
1.7162 +**
1.7163 +** ^New VFSes are registered with sqlite3_vfs_register().
1.7164 +** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
1.7165 +** ^The same VFS can be registered multiple times without injury.
1.7166 +** ^To make an existing VFS into the default VFS, register it again
1.7167 ** with the makeDflt flag set. If two different VFSes with the
1.7168 ** same name are registered, the behavior is undefined. If a
1.7169 ** VFS is registered with a name that is NULL or an empty string,
1.7170 ** then the behavior is undefined.
1.7171 -**
1.7172 -** Unregister a VFS with the sqlite3_vfs_unregister() interface.
1.7173 -** If the default VFS is unregistered, another VFS is chosen as
1.7174 -** the default. The choice for the new VFS is arbitrary.
1.7175 -*/
1.7176 -sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
1.7177 -int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
1.7178 -int sqlite3_vfs_unregister(sqlite3_vfs*);
1.7179 +**
1.7180 +** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
1.7181 +** ^(If the default VFS is unregistered, another VFS is chosen as
1.7182 +** the default. The choice for the new VFS is arbitrary.)^
1.7183 +*/
1.7184 +SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
1.7185 +SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
1.7186 +SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
1.7187
1.7188 /*
1.7189 ** CAPI3REF: Mutexes
1.7190 **
1.7191 ** The SQLite core uses these routines for thread
1.7192 -** synchronization. Though they are intended for internal
1.7193 +** synchronization. Though they are intended for internal
1.7194 ** use by SQLite, code that links against SQLite is
1.7195 ** permitted to use any of these routines.
1.7196 **
1.7197 -** The SQLite source code contains multiple implementations
1.7198 +** The SQLite source code contains multiple implementations
1.7199 ** of these mutex routines. An appropriate implementation
1.7200 -** is selected automatically at compile-time. The following
1.7201 +** is selected automatically at compile-time. ^(The following
1.7202 ** implementations are available in the SQLite core:
1.7203 **
1.7204 ** <ul>
1.7205 ** <li> SQLITE_MUTEX_OS2
1.7206 -** <li> SQLITE_MUTEX_PTHREAD
1.7207 +** <li> SQLITE_MUTEX_PTHREADS
1.7208 ** <li> SQLITE_MUTEX_W32
1.7209 ** <li> SQLITE_MUTEX_NOOP
1.7210 -** </ul>
1.7211 -**
1.7212 -** The SQLITE_MUTEX_NOOP implementation is a set of routines
1.7213 -** that does no real locking and is appropriate for use in
1.7214 -** a single-threaded application. The SQLITE_MUTEX_OS2,
1.7215 -** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
1.7216 -** are appropriate for use on os/2, unix, and windows.
1.7217 -**
1.7218 -** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
1.7219 +** </ul>)^
1.7220 +**
1.7221 +** ^The SQLITE_MUTEX_NOOP implementation is a set of routines
1.7222 +** that does no real locking and is appropriate for use in
1.7223 +** a single-threaded application. ^The SQLITE_MUTEX_OS2,
1.7224 +** SQLITE_MUTEX_PTHREADS, and SQLITE_MUTEX_W32 implementations
1.7225 +** are appropriate for use on OS/2, Unix, and Windows.
1.7226 +**
1.7227 +** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
1.7228 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
1.7229 -** implementation is included with the library. The
1.7230 -** mutex interface routines defined here become external
1.7231 -** references in the SQLite library for which implementations
1.7232 -** must be provided by the application. This facility allows an
1.7233 -** application that links against SQLite to provide its own mutex
1.7234 -** implementation without having to modify the SQLite core.
1.7235 -**
1.7236 -** The sqlite3_mutex_alloc() routine allocates a new
1.7237 -** mutex and returns a pointer to it. If it returns NULL
1.7238 -** that means that a mutex could not be allocated. SQLite
1.7239 -** will unwind its stack and return an error. The argument
1.7240 +** implementation is included with the library. In this case the
1.7241 +** application must supply a custom mutex implementation using the
1.7242 +** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
1.7243 +** before calling sqlite3_initialize() or any other public sqlite3_
1.7244 +** function that calls sqlite3_initialize().)^
1.7245 +**
1.7246 +** ^The sqlite3_mutex_alloc() routine allocates a new
1.7247 +** mutex and returns a pointer to it. ^If it returns NULL
1.7248 +** that means that a mutex could not be allocated. ^SQLite
1.7249 +** will unwind its stack and return an error. ^(The argument
1.7250 ** to sqlite3_mutex_alloc() is one of these integer constants:
1.7251 **
1.7252 ** <ul>
1.7253 @@ -3401,133 +5528,246 @@
1.7254 ** <li> SQLITE_MUTEX_STATIC_MEM2
1.7255 ** <li> SQLITE_MUTEX_STATIC_PRNG
1.7256 ** <li> SQLITE_MUTEX_STATIC_LRU
1.7257 -** </ul>
1.7258 -**
1.7259 -** The first two constants cause sqlite3_mutex_alloc() to create
1.7260 -** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
1.7261 +** <li> SQLITE_MUTEX_STATIC_LRU2
1.7262 +** </ul>)^
1.7263 +**
1.7264 +** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
1.7265 +** cause sqlite3_mutex_alloc() to create
1.7266 +** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
1.7267 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
1.7268 ** The mutex implementation does not need to make a distinction
1.7269 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
1.7270 -** not want to. But SQLite will only request a recursive mutex in
1.7271 -** cases where it really needs one. If a faster non-recursive mutex
1.7272 +** not want to. ^SQLite will only request a recursive mutex in
1.7273 +** cases where it really needs one. ^If a faster non-recursive mutex
1.7274 ** implementation is available on the host platform, the mutex subsystem
1.7275 ** might return such a mutex in response to SQLITE_MUTEX_FAST.
1.7276 **
1.7277 -** The other allowed parameters to sqlite3_mutex_alloc() each return
1.7278 -** a pointer to a static preexisting mutex. Four static mutexes are
1.7279 +** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
1.7280 +** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
1.7281 +** a pointer to a static preexisting mutex. ^Six static mutexes are
1.7282 ** used by the current version of SQLite. Future versions of SQLite
1.7283 ** may add additional static mutexes. Static mutexes are for internal
1.7284 ** use by SQLite only. Applications that use SQLite mutexes should
1.7285 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
1.7286 ** SQLITE_MUTEX_RECURSIVE.
1.7287 **
1.7288 -** Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
1.7289 +** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
1.7290 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
1.7291 -** returns a different mutex on every call. But for the static
1.7292 +** returns a different mutex on every call. ^But for the static
1.7293 ** mutex types, the same mutex is returned on every call that has
1.7294 ** the same type number.
1.7295 **
1.7296 -** The sqlite3_mutex_free() routine deallocates a previously
1.7297 -** allocated dynamic mutex. SQLite is careful to deallocate every
1.7298 -** dynamic mutex that it allocates. The dynamic mutexes must not be in
1.7299 +** ^The sqlite3_mutex_free() routine deallocates a previously
1.7300 +** allocated dynamic mutex. ^SQLite is careful to deallocate every
1.7301 +** dynamic mutex that it allocates. The dynamic mutexes must not be in
1.7302 ** use when they are deallocated. Attempting to deallocate a static
1.7303 -** mutex results in undefined behavior. SQLite never deallocates
1.7304 +** mutex results in undefined behavior. ^SQLite never deallocates
1.7305 ** a static mutex.
1.7306 **
1.7307 -** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
1.7308 -** to enter a mutex. If another thread is already within the mutex,
1.7309 +** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
1.7310 +** to enter a mutex. ^If another thread is already within the mutex,
1.7311 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
1.7312 -** SQLITE_BUSY. The sqlite3_mutex_try() interface returns SQLITE_OK
1.7313 -** upon successful entry. Mutexes created using SQLITE_MUTEX_RECURSIVE can
1.7314 -** be entered multiple times by the same thread. In such cases the,
1.7315 +** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
1.7316 +** upon successful entry. ^(Mutexes created using
1.7317 +** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
1.7318 +** In such cases the,
1.7319 ** mutex must be exited an equal number of times before another thread
1.7320 -** can enter. If the same thread tries to enter any other kind of mutex
1.7321 -** more than once, the behavior is undefined. SQLite will never exhibit
1.7322 -** such behavior in its own use of mutexes.
1.7323 -**
1.7324 -** Some systems (ex: windows95) do not the operation implemented by
1.7325 -** sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() will
1.7326 -** always return SQLITE_BUSY. The SQLite core only ever uses
1.7327 -** sqlite3_mutex_try() as an optimization so this is acceptable behavior.
1.7328 -**
1.7329 -** The sqlite3_mutex_leave() routine exits a mutex that was
1.7330 -** previously entered by the same thread. The behavior
1.7331 +** can enter.)^ ^(If the same thread tries to enter any other
1.7332 +** kind of mutex more than once, the behavior is undefined.
1.7333 +** SQLite will never exhibit
1.7334 +** such behavior in its own use of mutexes.)^
1.7335 +**
1.7336 +** ^(Some systems (for example, Windows 95) do not support the operation
1.7337 +** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
1.7338 +** will always return SQLITE_BUSY. The SQLite core only ever uses
1.7339 +** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^
1.7340 +**
1.7341 +** ^The sqlite3_mutex_leave() routine exits a mutex that was
1.7342 +** previously entered by the same thread. ^(The behavior
1.7343 ** is undefined if the mutex is not currently entered by the
1.7344 ** calling thread or is not currently allocated. SQLite will
1.7345 -** never do either.
1.7346 +** never do either.)^
1.7347 +**
1.7348 +** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
1.7349 +** sqlite3_mutex_leave() is a NULL pointer, then all three routines
1.7350 +** behave as no-ops.
1.7351 **
1.7352 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
1.7353 */
1.7354 -sqlite3_mutex *sqlite3_mutex_alloc(int);
1.7355 -void sqlite3_mutex_free(sqlite3_mutex*);
1.7356 -void sqlite3_mutex_enter(sqlite3_mutex*);
1.7357 -int sqlite3_mutex_try(sqlite3_mutex*);
1.7358 -void sqlite3_mutex_leave(sqlite3_mutex*);
1.7359 -
1.7360 -/*
1.7361 -** CAPI3REF: Mutex Verifcation Routines
1.7362 +SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
1.7363 +SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
1.7364 +SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
1.7365 +SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
1.7366 +SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
1.7367 +
1.7368 +/*
1.7369 +** CAPI3REF: Mutex Methods Object
1.7370 +**
1.7371 +** An instance of this structure defines the low-level routines
1.7372 +** used to allocate and use mutexes.
1.7373 +**
1.7374 +** Usually, the default mutex implementations provided by SQLite are
1.7375 +** sufficient, however the user has the option of substituting a custom
1.7376 +** implementation for specialized deployments or systems for which SQLite
1.7377 +** does not provide a suitable implementation. In this case, the user
1.7378 +** creates and populates an instance of this structure to pass
1.7379 +** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
1.7380 +** Additionally, an instance of this structure can be used as an
1.7381 +** output variable when querying the system for the current mutex
1.7382 +** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
1.7383 +**
1.7384 +** ^The xMutexInit method defined by this structure is invoked as
1.7385 +** part of system initialization by the sqlite3_initialize() function.
1.7386 +** ^The xMutexInit routine is called by SQLite exactly once for each
1.7387 +** effective call to [sqlite3_initialize()].
1.7388 +**
1.7389 +** ^The xMutexEnd method defined by this structure is invoked as
1.7390 +** part of system shutdown by the sqlite3_shutdown() function. The
1.7391 +** implementation of this method is expected to release all outstanding
1.7392 +** resources obtained by the mutex methods implementation, especially
1.7393 +** those obtained by the xMutexInit method. ^The xMutexEnd()
1.7394 +** interface is invoked exactly once for each call to [sqlite3_shutdown()].
1.7395 +**
1.7396 +** ^(The remaining seven methods defined by this structure (xMutexAlloc,
1.7397 +** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
1.7398 +** xMutexNotheld) implement the following interfaces (respectively):
1.7399 +**
1.7400 +** <ul>
1.7401 +** <li> [sqlite3_mutex_alloc()] </li>
1.7402 +** <li> [sqlite3_mutex_free()] </li>
1.7403 +** <li> [sqlite3_mutex_enter()] </li>
1.7404 +** <li> [sqlite3_mutex_try()] </li>
1.7405 +** <li> [sqlite3_mutex_leave()] </li>
1.7406 +** <li> [sqlite3_mutex_held()] </li>
1.7407 +** <li> [sqlite3_mutex_notheld()] </li>
1.7408 +** </ul>)^
1.7409 +**
1.7410 +** The only difference is that the public sqlite3_XXX functions enumerated
1.7411 +** above silently ignore any invocations that pass a NULL pointer instead
1.7412 +** of a valid mutex handle. The implementations of the methods defined
1.7413 +** by this structure are not required to handle this case, the results
1.7414 +** of passing a NULL pointer instead of a valid mutex handle are undefined
1.7415 +** (i.e. it is acceptable to provide an implementation that segfaults if
1.7416 +** it is passed a NULL pointer).
1.7417 +**
1.7418 +** The xMutexInit() method must be threadsafe. ^It must be harmless to
1.7419 +** invoke xMutexInit() multiple times within the same process and without
1.7420 +** intervening calls to xMutexEnd(). Second and subsequent calls to
1.7421 +** xMutexInit() must be no-ops.
1.7422 +**
1.7423 +** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
1.7424 +** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory
1.7425 +** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
1.7426 +** memory allocation for a fast or recursive mutex.
1.7427 +**
1.7428 +** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
1.7429 +** called, but only if the prior call to xMutexInit returned SQLITE_OK.
1.7430 +** If xMutexInit fails in any way, it is expected to clean up after itself
1.7431 +** prior to returning.
1.7432 +*/
1.7433 +typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
1.7434 +struct sqlite3_mutex_methods {
1.7435 + int (*xMutexInit)(void);
1.7436 + int (*xMutexEnd)(void);
1.7437 + sqlite3_mutex *(*xMutexAlloc)(int);
1.7438 + void (*xMutexFree)(sqlite3_mutex *);
1.7439 + void (*xMutexEnter)(sqlite3_mutex *);
1.7440 + int (*xMutexTry)(sqlite3_mutex *);
1.7441 + void (*xMutexLeave)(sqlite3_mutex *);
1.7442 + int (*xMutexHeld)(sqlite3_mutex *);
1.7443 + int (*xMutexNotheld)(sqlite3_mutex *);
1.7444 +};
1.7445 +
1.7446 +/*
1.7447 +** CAPI3REF: Mutex Verification Routines
1.7448 **
1.7449 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
1.7450 -** are intended for use inside assert() statements. The SQLite core
1.7451 +** are intended for use inside assert() statements. ^The SQLite core
1.7452 ** never uses these routines except inside an assert() and applications
1.7453 -** are advised to follow the lead of the core. The core only
1.7454 +** are advised to follow the lead of the core. ^The SQLite core only
1.7455 ** provides implementations for these routines when it is compiled
1.7456 -** with the SQLITE_DEBUG flag. External mutex implementations
1.7457 +** with the SQLITE_DEBUG flag. ^External mutex implementations
1.7458 ** are only required to provide these routines if SQLITE_DEBUG is
1.7459 ** defined and if NDEBUG is not defined.
1.7460 **
1.7461 -** These routines should return true if the mutex in their argument
1.7462 +** ^These routines should return true if the mutex in their argument
1.7463 ** is held or not held, respectively, by the calling thread.
1.7464 **
1.7465 -** The implementation is not required to provided versions of these
1.7466 -** routines that actually work.
1.7467 -** If the implementation does not provide working
1.7468 -** versions of these routines, it should at least provide stubs
1.7469 -** that always return true so that one does not get spurious
1.7470 -** assertion failures.
1.7471 -**
1.7472 -** If the argument to sqlite3_mutex_held() is a NULL pointer then
1.7473 -** the routine should return 1. This seems counter-intuitive since
1.7474 -** clearly the mutex cannot be held if it does not exist. But the
1.7475 +** ^The implementation is not required to provide versions of these
1.7476 +** routines that actually work. If the implementation does not provide working
1.7477 +** versions of these routines, it should at least provide stubs that always
1.7478 +** return true so that one does not get spurious assertion failures.
1.7479 +**
1.7480 +** ^If the argument to sqlite3_mutex_held() is a NULL pointer then
1.7481 +** the routine should return 1. This seems counter-intuitive since
1.7482 +** clearly the mutex cannot be held if it does not exist. But
1.7483 ** the reason the mutex does not exist is because the build is not
1.7484 ** using mutexes. And we do not want the assert() containing the
1.7485 ** call to sqlite3_mutex_held() to fail, so a non-zero return is
1.7486 -** the appropriate thing to do. The sqlite3_mutex_notheld()
1.7487 +** the appropriate thing to do. ^The sqlite3_mutex_notheld()
1.7488 ** interface should also return 1 when given a NULL pointer.
1.7489 */
1.7490 -int sqlite3_mutex_held(sqlite3_mutex*);
1.7491 -int sqlite3_mutex_notheld(sqlite3_mutex*);
1.7492 +#ifndef NDEBUG
1.7493 +SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
1.7494 +SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
1.7495 +#endif
1.7496
1.7497 /*
1.7498 ** CAPI3REF: Mutex Types
1.7499 **
1.7500 ** The [sqlite3_mutex_alloc()] interface takes a single argument
1.7501 ** which is one of these integer constants.
1.7502 +**
1.7503 +** The set of static mutexes may change from one SQLite release to the
1.7504 +** next. Applications that override the built-in mutex logic must be
1.7505 +** prepared to accommodate additional static mutexes.
1.7506 */
1.7507 #define SQLITE_MUTEX_FAST 0
1.7508 #define SQLITE_MUTEX_RECURSIVE 1
1.7509 #define SQLITE_MUTEX_STATIC_MASTER 2
1.7510 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
1.7511 -#define SQLITE_MUTEX_STATIC_MEM2 4 /* sqlite3_release_memory() */
1.7512 +#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
1.7513 +#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
1.7514 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
1.7515 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
1.7516 +#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
1.7517 +#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
1.7518 +
1.7519 +/*
1.7520 +** CAPI3REF: Retrieve the mutex for a database connection
1.7521 +**
1.7522 +** ^This interface returns a pointer the [sqlite3_mutex] object that
1.7523 +** serializes access to the [database connection] given in the argument
1.7524 +** when the [threading mode] is Serialized.
1.7525 +** ^If the [threading mode] is Single-thread or Multi-thread then this
1.7526 +** routine returns a NULL pointer.
1.7527 +*/
1.7528 +SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
1.7529
1.7530 /*
1.7531 ** CAPI3REF: Low-Level Control Of Database Files
1.7532 **
1.7533 -** The [sqlite3_file_control()] interface makes a direct call to the
1.7534 +** ^The [sqlite3_file_control()] interface makes a direct call to the
1.7535 ** xFileControl method for the [sqlite3_io_methods] object associated
1.7536 -** with a particular database identified by the second argument. The
1.7537 -** name of the database is the name assigned to the database by the
1.7538 -** <a href="lang_attach.html">ATTACH</a> SQL command that opened the
1.7539 -** database. To control the main database file, use the name "main"
1.7540 -** or a NULL pointer. The third and fourth parameters to this routine
1.7541 +** with a particular database identified by the second argument. ^The
1.7542 +** name of the database is "main" for the main database or "temp" for the
1.7543 +** TEMP database, or the name that appears after the AS keyword for
1.7544 +** databases that are added using the [ATTACH] SQL command.
1.7545 +** ^A NULL pointer can be used in place of "main" to refer to the
1.7546 +** main database file.
1.7547 +** ^The third and fourth parameters to this routine
1.7548 ** are passed directly through to the second and third parameters of
1.7549 -** the xFileControl method. The return value of the xFileControl
1.7550 +** the xFileControl method. ^The return value of the xFileControl
1.7551 ** method becomes the return value of this routine.
1.7552 **
1.7553 -** If the second parameter (zDbName) does not match the name of any
1.7554 -** open database file, then SQLITE_ERROR is returned. This error
1.7555 +** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes
1.7556 +** a pointer to the underlying [sqlite3_file] object to be written into
1.7557 +** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER
1.7558 +** case is a short-circuit path which does not actually invoke the
1.7559 +** underlying sqlite3_io_methods.xFileControl method.
1.7560 +**
1.7561 +** ^If the second parameter (zDbName) does not match the name of any
1.7562 +** open database file, then SQLITE_ERROR is returned. ^This error
1.7563 ** code is not remembered and will not be recalled by [sqlite3_errcode()]
1.7564 ** or [sqlite3_errmsg()]. The underlying xFileControl method might
1.7565 ** also return SQLITE_ERROR. There is no way to distinguish between
1.7566 @@ -3536,7 +5776,1209 @@
1.7567 **
1.7568 ** See also: [SQLITE_FCNTL_LOCKSTATE]
1.7569 */
1.7570 -int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
1.7571 +SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
1.7572 +
1.7573 +/*
1.7574 +** CAPI3REF: Testing Interface
1.7575 +**
1.7576 +** ^The sqlite3_test_control() interface is used to read out internal
1.7577 +** state of SQLite and to inject faults into SQLite for testing
1.7578 +** purposes. ^The first parameter is an operation code that determines
1.7579 +** the number, meaning, and operation of all subsequent parameters.
1.7580 +**
1.7581 +** This interface is not for use by applications. It exists solely
1.7582 +** for verifying the correct operation of the SQLite library. Depending
1.7583 +** on how the SQLite library is compiled, this interface might not exist.
1.7584 +**
1.7585 +** The details of the operation codes, their meanings, the parameters
1.7586 +** they take, and what they do are all subject to change without notice.
1.7587 +** Unlike most of the SQLite API, this function is not guaranteed to
1.7588 +** operate consistently from one release to the next.
1.7589 +*/
1.7590 +SQLITE_API int sqlite3_test_control(int op, ...);
1.7591 +
1.7592 +/*
1.7593 +** CAPI3REF: Testing Interface Operation Codes
1.7594 +**
1.7595 +** These constants are the valid operation code parameters used
1.7596 +** as the first argument to [sqlite3_test_control()].
1.7597 +**
1.7598 +** These parameters and their meanings are subject to change
1.7599 +** without notice. These values are for testing purposes only.
1.7600 +** Applications should not use any of these parameters or the
1.7601 +** [sqlite3_test_control()] interface.
1.7602 +*/
1.7603 +#define SQLITE_TESTCTRL_FIRST 5
1.7604 +#define SQLITE_TESTCTRL_PRNG_SAVE 5
1.7605 +#define SQLITE_TESTCTRL_PRNG_RESTORE 6
1.7606 +#define SQLITE_TESTCTRL_PRNG_RESET 7
1.7607 +#define SQLITE_TESTCTRL_BITVEC_TEST 8
1.7608 +#define SQLITE_TESTCTRL_FAULT_INSTALL 9
1.7609 +#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
1.7610 +#define SQLITE_TESTCTRL_PENDING_BYTE 11
1.7611 +#define SQLITE_TESTCTRL_ASSERT 12
1.7612 +#define SQLITE_TESTCTRL_ALWAYS 13
1.7613 +#define SQLITE_TESTCTRL_RESERVE 14
1.7614 +#define SQLITE_TESTCTRL_OPTIMIZATIONS 15
1.7615 +#define SQLITE_TESTCTRL_ISKEYWORD 16
1.7616 +#define SQLITE_TESTCTRL_SCRATCHMALLOC 17
1.7617 +#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
1.7618 +#define SQLITE_TESTCTRL_EXPLAIN_STMT 19
1.7619 +#define SQLITE_TESTCTRL_LAST 19
1.7620 +
1.7621 +/*
1.7622 +** CAPI3REF: SQLite Runtime Status
1.7623 +**
1.7624 +** ^This interface is used to retrieve runtime status information
1.7625 +** about the performance of SQLite, and optionally to reset various
1.7626 +** highwater marks. ^The first argument is an integer code for
1.7627 +** the specific parameter to measure. ^(Recognized integer codes
1.7628 +** are of the form [status parameters | SQLITE_STATUS_...].)^
1.7629 +** ^The current value of the parameter is returned into *pCurrent.
1.7630 +** ^The highest recorded value is returned in *pHighwater. ^If the
1.7631 +** resetFlag is true, then the highest record value is reset after
1.7632 +** *pHighwater is written. ^(Some parameters do not record the highest
1.7633 +** value. For those parameters
1.7634 +** nothing is written into *pHighwater and the resetFlag is ignored.)^
1.7635 +** ^(Other parameters record only the highwater mark and not the current
1.7636 +** value. For these latter parameters nothing is written into *pCurrent.)^
1.7637 +**
1.7638 +** ^The sqlite3_status() routine returns SQLITE_OK on success and a
1.7639 +** non-zero [error code] on failure.
1.7640 +**
1.7641 +** This routine is threadsafe but is not atomic. This routine can be
1.7642 +** called while other threads are running the same or different SQLite
1.7643 +** interfaces. However the values returned in *pCurrent and
1.7644 +** *pHighwater reflect the status of SQLite at different points in time
1.7645 +** and it is possible that another thread might change the parameter
1.7646 +** in between the times when *pCurrent and *pHighwater are written.
1.7647 +**
1.7648 +** See also: [sqlite3_db_status()]
1.7649 +*/
1.7650 +SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
1.7651 +
1.7652 +
1.7653 +/*
1.7654 +** CAPI3REF: Status Parameters
1.7655 +** KEYWORDS: {status parameters}
1.7656 +**
1.7657 +** These integer constants designate various run-time status parameters
1.7658 +** that can be returned by [sqlite3_status()].
1.7659 +**
1.7660 +** <dl>
1.7661 +** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
1.7662 +** <dd>This parameter is the current amount of memory checked out
1.7663 +** using [sqlite3_malloc()], either directly or indirectly. The
1.7664 +** figure includes calls made to [sqlite3_malloc()] by the application
1.7665 +** and internal memory usage by the SQLite library. Scratch memory
1.7666 +** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
1.7667 +** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
1.7668 +** this parameter. The amount returned is the sum of the allocation
1.7669 +** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
1.7670 +**
1.7671 +** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
1.7672 +** <dd>This parameter records the largest memory allocation request
1.7673 +** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
1.7674 +** internal equivalents). Only the value returned in the
1.7675 +** *pHighwater parameter to [sqlite3_status()] is of interest.
1.7676 +** The value written into the *pCurrent parameter is undefined.</dd>)^
1.7677 +**
1.7678 +** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
1.7679 +** <dd>This parameter records the number of separate memory allocations
1.7680 +** currently checked out.</dd>)^
1.7681 +**
1.7682 +** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
1.7683 +** <dd>This parameter returns the number of pages used out of the
1.7684 +** [pagecache memory allocator] that was configured using
1.7685 +** [SQLITE_CONFIG_PAGECACHE]. The
1.7686 +** value returned is in pages, not in bytes.</dd>)^
1.7687 +**
1.7688 +** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
1.7689 +** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
1.7690 +** <dd>This parameter returns the number of bytes of page cache
1.7691 +** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
1.7692 +** buffer and where forced to overflow to [sqlite3_malloc()]. The
1.7693 +** returned value includes allocations that overflowed because they
1.7694 +** where too large (they were larger than the "sz" parameter to
1.7695 +** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
1.7696 +** no space was left in the page cache.</dd>)^
1.7697 +**
1.7698 +** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
1.7699 +** <dd>This parameter records the largest memory allocation request
1.7700 +** handed to [pagecache memory allocator]. Only the value returned in the
1.7701 +** *pHighwater parameter to [sqlite3_status()] is of interest.
1.7702 +** The value written into the *pCurrent parameter is undefined.</dd>)^
1.7703 +**
1.7704 +** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
1.7705 +** <dd>This parameter returns the number of allocations used out of the
1.7706 +** [scratch memory allocator] configured using
1.7707 +** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
1.7708 +** in bytes. Since a single thread may only have one scratch allocation
1.7709 +** outstanding at time, this parameter also reports the number of threads
1.7710 +** using scratch memory at the same time.</dd>)^
1.7711 +**
1.7712 +** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
1.7713 +** <dd>This parameter returns the number of bytes of scratch memory
1.7714 +** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
1.7715 +** buffer and where forced to overflow to [sqlite3_malloc()]. The values
1.7716 +** returned include overflows because the requested allocation was too
1.7717 +** larger (that is, because the requested allocation was larger than the
1.7718 +** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
1.7719 +** slots were available.
1.7720 +** </dd>)^
1.7721 +**
1.7722 +** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
1.7723 +** <dd>This parameter records the largest memory allocation request
1.7724 +** handed to [scratch memory allocator]. Only the value returned in the
1.7725 +** *pHighwater parameter to [sqlite3_status()] is of interest.
1.7726 +** The value written into the *pCurrent parameter is undefined.</dd>)^
1.7727 +**
1.7728 +** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
1.7729 +** <dd>This parameter records the deepest parser stack. It is only
1.7730 +** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
1.7731 +** </dl>
1.7732 +**
1.7733 +** New status parameters may be added from time to time.
1.7734 +*/
1.7735 +#define SQLITE_STATUS_MEMORY_USED 0
1.7736 +#define SQLITE_STATUS_PAGECACHE_USED 1
1.7737 +#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
1.7738 +#define SQLITE_STATUS_SCRATCH_USED 3
1.7739 +#define SQLITE_STATUS_SCRATCH_OVERFLOW 4
1.7740 +#define SQLITE_STATUS_MALLOC_SIZE 5
1.7741 +#define SQLITE_STATUS_PARSER_STACK 6
1.7742 +#define SQLITE_STATUS_PAGECACHE_SIZE 7
1.7743 +#define SQLITE_STATUS_SCRATCH_SIZE 8
1.7744 +#define SQLITE_STATUS_MALLOC_COUNT 9
1.7745 +
1.7746 +/*
1.7747 +** CAPI3REF: Database Connection Status
1.7748 +**
1.7749 +** ^This interface is used to retrieve runtime status information
1.7750 +** about a single [database connection]. ^The first argument is the
1.7751 +** database connection object to be interrogated. ^The second argument
1.7752 +** is an integer constant, taken from the set of
1.7753 +** [SQLITE_DBSTATUS options], that
1.7754 +** determines the parameter to interrogate. The set of
1.7755 +** [SQLITE_DBSTATUS options] is likely
1.7756 +** to grow in future releases of SQLite.
1.7757 +**
1.7758 +** ^The current value of the requested parameter is written into *pCur
1.7759 +** and the highest instantaneous value is written into *pHiwtr. ^If
1.7760 +** the resetFlg is true, then the highest instantaneous value is
1.7761 +** reset back down to the current value.
1.7762 +**
1.7763 +** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
1.7764 +** non-zero [error code] on failure.
1.7765 +**
1.7766 +** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
1.7767 +*/
1.7768 +SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
1.7769 +
1.7770 +/*
1.7771 +** CAPI3REF: Status Parameters for database connections
1.7772 +** KEYWORDS: {SQLITE_DBSTATUS options}
1.7773 +**
1.7774 +** These constants are the available integer "verbs" that can be passed as
1.7775 +** the second argument to the [sqlite3_db_status()] interface.
1.7776 +**
1.7777 +** New verbs may be added in future releases of SQLite. Existing verbs
1.7778 +** might be discontinued. Applications should check the return code from
1.7779 +** [sqlite3_db_status()] to make sure that the call worked.
1.7780 +** The [sqlite3_db_status()] interface will return a non-zero error code
1.7781 +** if a discontinued or unsupported verb is invoked.
1.7782 +**
1.7783 +** <dl>
1.7784 +** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
1.7785 +** <dd>This parameter returns the number of lookaside memory slots currently
1.7786 +** checked out.</dd>)^
1.7787 +**
1.7788 +** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
1.7789 +** <dd>This parameter returns the number malloc attempts that were
1.7790 +** satisfied using lookaside memory. Only the high-water value is meaningful;
1.7791 +** the current value is always zero.)^
1.7792 +**
1.7793 +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
1.7794 +** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
1.7795 +** <dd>This parameter returns the number malloc attempts that might have
1.7796 +** been satisfied using lookaside memory but failed due to the amount of
1.7797 +** memory requested being larger than the lookaside slot size.
1.7798 +** Only the high-water value is meaningful;
1.7799 +** the current value is always zero.)^
1.7800 +**
1.7801 +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
1.7802 +** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
1.7803 +** <dd>This parameter returns the number malloc attempts that might have
1.7804 +** been satisfied using lookaside memory but failed due to all lookaside
1.7805 +** memory already being in use.
1.7806 +** Only the high-water value is meaningful;
1.7807 +** the current value is always zero.)^
1.7808 +**
1.7809 +** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
1.7810 +** <dd>This parameter returns the approximate number of of bytes of heap
1.7811 +** memory used by all pager caches associated with the database connection.)^
1.7812 +** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
1.7813 +**
1.7814 +** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
1.7815 +** <dd>This parameter returns the approximate number of of bytes of heap
1.7816 +** memory used to store the schema for all databases associated
1.7817 +** with the connection - main, temp, and any [ATTACH]-ed databases.)^
1.7818 +** ^The full amount of memory used by the schemas is reported, even if the
1.7819 +** schema memory is shared with other database connections due to
1.7820 +** [shared cache mode] being enabled.
1.7821 +** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
1.7822 +**
1.7823 +** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
1.7824 +** <dd>This parameter returns the approximate number of of bytes of heap
1.7825 +** and lookaside memory used by all prepared statements associated with
1.7826 +** the database connection.)^
1.7827 +** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
1.7828 +** </dd>
1.7829 +**
1.7830 +** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
1.7831 +** <dd>This parameter returns the number of pager cache hits that have
1.7832 +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
1.7833 +** is always 0.
1.7834 +** </dd>
1.7835 +**
1.7836 +** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
1.7837 +** <dd>This parameter returns the number of pager cache misses that have
1.7838 +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
1.7839 +** is always 0.
1.7840 +** </dd>
1.7841 +**
1.7842 +** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
1.7843 +** <dd>This parameter returns the number of dirty cache entries that have
1.7844 +** been written to disk. Specifically, the number of pages written to the
1.7845 +** wal file in wal mode databases, or the number of pages written to the
1.7846 +** database file in rollback mode databases. Any pages written as part of
1.7847 +** transaction rollback or database recovery operations are not included.
1.7848 +** If an IO or other error occurs while writing a page to disk, the effect
1.7849 +** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
1.7850 +** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
1.7851 +** </dd>
1.7852 +** </dl>
1.7853 +*/
1.7854 +#define SQLITE_DBSTATUS_LOOKASIDE_USED 0
1.7855 +#define SQLITE_DBSTATUS_CACHE_USED 1
1.7856 +#define SQLITE_DBSTATUS_SCHEMA_USED 2
1.7857 +#define SQLITE_DBSTATUS_STMT_USED 3
1.7858 +#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
1.7859 +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
1.7860 +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
1.7861 +#define SQLITE_DBSTATUS_CACHE_HIT 7
1.7862 +#define SQLITE_DBSTATUS_CACHE_MISS 8
1.7863 +#define SQLITE_DBSTATUS_CACHE_WRITE 9
1.7864 +#define SQLITE_DBSTATUS_MAX 9 /* Largest defined DBSTATUS */
1.7865 +
1.7866 +
1.7867 +/*
1.7868 +** CAPI3REF: Prepared Statement Status
1.7869 +**
1.7870 +** ^(Each prepared statement maintains various
1.7871 +** [SQLITE_STMTSTATUS counters] that measure the number
1.7872 +** of times it has performed specific operations.)^ These counters can
1.7873 +** be used to monitor the performance characteristics of the prepared
1.7874 +** statements. For example, if the number of table steps greatly exceeds
1.7875 +** the number of table searches or result rows, that would tend to indicate
1.7876 +** that the prepared statement is using a full table scan rather than
1.7877 +** an index.
1.7878 +**
1.7879 +** ^(This interface is used to retrieve and reset counter values from
1.7880 +** a [prepared statement]. The first argument is the prepared statement
1.7881 +** object to be interrogated. The second argument
1.7882 +** is an integer code for a specific [SQLITE_STMTSTATUS counter]
1.7883 +** to be interrogated.)^
1.7884 +** ^The current value of the requested counter is returned.
1.7885 +** ^If the resetFlg is true, then the counter is reset to zero after this
1.7886 +** interface call returns.
1.7887 +**
1.7888 +** See also: [sqlite3_status()] and [sqlite3_db_status()].
1.7889 +*/
1.7890 +SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
1.7891 +
1.7892 +/*
1.7893 +** CAPI3REF: Status Parameters for prepared statements
1.7894 +** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
1.7895 +**
1.7896 +** These preprocessor macros define integer codes that name counter
1.7897 +** values associated with the [sqlite3_stmt_status()] interface.
1.7898 +** The meanings of the various counters are as follows:
1.7899 +**
1.7900 +** <dl>
1.7901 +** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
1.7902 +** <dd>^This is the number of times that SQLite has stepped forward in
1.7903 +** a table as part of a full table scan. Large numbers for this counter
1.7904 +** may indicate opportunities for performance improvement through
1.7905 +** careful use of indices.</dd>
1.7906 +**
1.7907 +** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
1.7908 +** <dd>^This is the number of sort operations that have occurred.
1.7909 +** A non-zero value in this counter may indicate an opportunity to
1.7910 +** improvement performance through careful use of indices.</dd>
1.7911 +**
1.7912 +** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
1.7913 +** <dd>^This is the number of rows inserted into transient indices that
1.7914 +** were created automatically in order to help joins run faster.
1.7915 +** A non-zero value in this counter may indicate an opportunity to
1.7916 +** improvement performance by adding permanent indices that do not
1.7917 +** need to be reinitialized each time the statement is run.</dd>
1.7918 +** </dl>
1.7919 +*/
1.7920 +#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
1.7921 +#define SQLITE_STMTSTATUS_SORT 2
1.7922 +#define SQLITE_STMTSTATUS_AUTOINDEX 3
1.7923 +
1.7924 +/*
1.7925 +** CAPI3REF: Custom Page Cache Object
1.7926 +**
1.7927 +** The sqlite3_pcache type is opaque. It is implemented by
1.7928 +** the pluggable module. The SQLite core has no knowledge of
1.7929 +** its size or internal structure and never deals with the
1.7930 +** sqlite3_pcache object except by holding and passing pointers
1.7931 +** to the object.
1.7932 +**
1.7933 +** See [sqlite3_pcache_methods2] for additional information.
1.7934 +*/
1.7935 +typedef struct sqlite3_pcache sqlite3_pcache;
1.7936 +
1.7937 +/*
1.7938 +** CAPI3REF: Custom Page Cache Object
1.7939 +**
1.7940 +** The sqlite3_pcache_page object represents a single page in the
1.7941 +** page cache. The page cache will allocate instances of this
1.7942 +** object. Various methods of the page cache use pointers to instances
1.7943 +** of this object as parameters or as their return value.
1.7944 +**
1.7945 +** See [sqlite3_pcache_methods2] for additional information.
1.7946 +*/
1.7947 +typedef struct sqlite3_pcache_page sqlite3_pcache_page;
1.7948 +struct sqlite3_pcache_page {
1.7949 + void *pBuf; /* The content of the page */
1.7950 + void *pExtra; /* Extra information associated with the page */
1.7951 +};
1.7952 +
1.7953 +/*
1.7954 +** CAPI3REF: Application Defined Page Cache.
1.7955 +** KEYWORDS: {page cache}
1.7956 +**
1.7957 +** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
1.7958 +** register an alternative page cache implementation by passing in an
1.7959 +** instance of the sqlite3_pcache_methods2 structure.)^
1.7960 +** In many applications, most of the heap memory allocated by
1.7961 +** SQLite is used for the page cache.
1.7962 +** By implementing a
1.7963 +** custom page cache using this API, an application can better control
1.7964 +** the amount of memory consumed by SQLite, the way in which
1.7965 +** that memory is allocated and released, and the policies used to
1.7966 +** determine exactly which parts of a database file are cached and for
1.7967 +** how long.
1.7968 +**
1.7969 +** The alternative page cache mechanism is an
1.7970 +** extreme measure that is only needed by the most demanding applications.
1.7971 +** The built-in page cache is recommended for most uses.
1.7972 +**
1.7973 +** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
1.7974 +** internal buffer by SQLite within the call to [sqlite3_config]. Hence
1.7975 +** the application may discard the parameter after the call to
1.7976 +** [sqlite3_config()] returns.)^
1.7977 +**
1.7978 +** [[the xInit() page cache method]]
1.7979 +** ^(The xInit() method is called once for each effective
1.7980 +** call to [sqlite3_initialize()])^
1.7981 +** (usually only once during the lifetime of the process). ^(The xInit()
1.7982 +** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
1.7983 +** The intent of the xInit() method is to set up global data structures
1.7984 +** required by the custom page cache implementation.
1.7985 +** ^(If the xInit() method is NULL, then the
1.7986 +** built-in default page cache is used instead of the application defined
1.7987 +** page cache.)^
1.7988 +**
1.7989 +** [[the xShutdown() page cache method]]
1.7990 +** ^The xShutdown() method is called by [sqlite3_shutdown()].
1.7991 +** It can be used to clean up
1.7992 +** any outstanding resources before process shutdown, if required.
1.7993 +** ^The xShutdown() method may be NULL.
1.7994 +**
1.7995 +** ^SQLite automatically serializes calls to the xInit method,
1.7996 +** so the xInit method need not be threadsafe. ^The
1.7997 +** xShutdown method is only called from [sqlite3_shutdown()] so it does
1.7998 +** not need to be threadsafe either. All other methods must be threadsafe
1.7999 +** in multithreaded applications.
1.8000 +**
1.8001 +** ^SQLite will never invoke xInit() more than once without an intervening
1.8002 +** call to xShutdown().
1.8003 +**
1.8004 +** [[the xCreate() page cache methods]]
1.8005 +** ^SQLite invokes the xCreate() method to construct a new cache instance.
1.8006 +** SQLite will typically create one cache instance for each open database file,
1.8007 +** though this is not guaranteed. ^The
1.8008 +** first parameter, szPage, is the size in bytes of the pages that must
1.8009 +** be allocated by the cache. ^szPage will always a power of two. ^The
1.8010 +** second parameter szExtra is a number of bytes of extra storage
1.8011 +** associated with each page cache entry. ^The szExtra parameter will
1.8012 +** a number less than 250. SQLite will use the
1.8013 +** extra szExtra bytes on each page to store metadata about the underlying
1.8014 +** database page on disk. The value passed into szExtra depends
1.8015 +** on the SQLite version, the target platform, and how SQLite was compiled.
1.8016 +** ^The third argument to xCreate(), bPurgeable, is true if the cache being
1.8017 +** created will be used to cache database pages of a file stored on disk, or
1.8018 +** false if it is used for an in-memory database. The cache implementation
1.8019 +** does not have to do anything special based with the value of bPurgeable;
1.8020 +** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
1.8021 +** never invoke xUnpin() except to deliberately delete a page.
1.8022 +** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
1.8023 +** false will always have the "discard" flag set to true.
1.8024 +** ^Hence, a cache created with bPurgeable false will
1.8025 +** never contain any unpinned pages.
1.8026 +**
1.8027 +** [[the xCachesize() page cache method]]
1.8028 +** ^(The xCachesize() method may be called at any time by SQLite to set the
1.8029 +** suggested maximum cache-size (number of pages stored by) the cache
1.8030 +** instance passed as the first argument. This is the value configured using
1.8031 +** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
1.8032 +** parameter, the implementation is not required to do anything with this
1.8033 +** value; it is advisory only.
1.8034 +**
1.8035 +** [[the xPagecount() page cache methods]]
1.8036 +** The xPagecount() method must return the number of pages currently
1.8037 +** stored in the cache, both pinned and unpinned.
1.8038 +**
1.8039 +** [[the xFetch() page cache methods]]
1.8040 +** The xFetch() method locates a page in the cache and returns a pointer to
1.8041 +** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
1.8042 +** The pBuf element of the returned sqlite3_pcache_page object will be a
1.8043 +** pointer to a buffer of szPage bytes used to store the content of a
1.8044 +** single database page. The pExtra element of sqlite3_pcache_page will be
1.8045 +** a pointer to the szExtra bytes of extra storage that SQLite has requested
1.8046 +** for each entry in the page cache.
1.8047 +**
1.8048 +** The page to be fetched is determined by the key. ^The minimum key value
1.8049 +** is 1. After it has been retrieved using xFetch, the page is considered
1.8050 +** to be "pinned".
1.8051 +**
1.8052 +** If the requested page is already in the page cache, then the page cache
1.8053 +** implementation must return a pointer to the page buffer with its content
1.8054 +** intact. If the requested page is not already in the cache, then the
1.8055 +** cache implementation should use the value of the createFlag
1.8056 +** parameter to help it determined what action to take:
1.8057 +**
1.8058 +** <table border=1 width=85% align=center>
1.8059 +** <tr><th> createFlag <th> Behaviour when page is not already in cache
1.8060 +** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
1.8061 +** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
1.8062 +** Otherwise return NULL.
1.8063 +** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
1.8064 +** NULL if allocating a new page is effectively impossible.
1.8065 +** </table>
1.8066 +**
1.8067 +** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
1.8068 +** will only use a createFlag of 2 after a prior call with a createFlag of 1
1.8069 +** failed.)^ In between the to xFetch() calls, SQLite may
1.8070 +** attempt to unpin one or more cache pages by spilling the content of
1.8071 +** pinned pages to disk and synching the operating system disk cache.
1.8072 +**
1.8073 +** [[the xUnpin() page cache method]]
1.8074 +** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
1.8075 +** as its second argument. If the third parameter, discard, is non-zero,
1.8076 +** then the page must be evicted from the cache.
1.8077 +** ^If the discard parameter is
1.8078 +** zero, then the page may be discarded or retained at the discretion of
1.8079 +** page cache implementation. ^The page cache implementation
1.8080 +** may choose to evict unpinned pages at any time.
1.8081 +**
1.8082 +** The cache must not perform any reference counting. A single
1.8083 +** call to xUnpin() unpins the page regardless of the number of prior calls
1.8084 +** to xFetch().
1.8085 +**
1.8086 +** [[the xRekey() page cache methods]]
1.8087 +** The xRekey() method is used to change the key value associated with the
1.8088 +** page passed as the second argument. If the cache
1.8089 +** previously contains an entry associated with newKey, it must be
1.8090 +** discarded. ^Any prior cache entry associated with newKey is guaranteed not
1.8091 +** to be pinned.
1.8092 +**
1.8093 +** When SQLite calls the xTruncate() method, the cache must discard all
1.8094 +** existing cache entries with page numbers (keys) greater than or equal
1.8095 +** to the value of the iLimit parameter passed to xTruncate(). If any
1.8096 +** of these pages are pinned, they are implicitly unpinned, meaning that
1.8097 +** they can be safely discarded.
1.8098 +**
1.8099 +** [[the xDestroy() page cache method]]
1.8100 +** ^The xDestroy() method is used to delete a cache allocated by xCreate().
1.8101 +** All resources associated with the specified cache should be freed. ^After
1.8102 +** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
1.8103 +** handle invalid, and will not use it with any other sqlite3_pcache_methods2
1.8104 +** functions.
1.8105 +**
1.8106 +** [[the xShrink() page cache method]]
1.8107 +** ^SQLite invokes the xShrink() method when it wants the page cache to
1.8108 +** free up as much of heap memory as possible. The page cache implementation
1.8109 +** is not obligated to free any memory, but well-behaved implementations should
1.8110 +** do their best.
1.8111 +*/
1.8112 +typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
1.8113 +struct sqlite3_pcache_methods2 {
1.8114 + int iVersion;
1.8115 + void *pArg;
1.8116 + int (*xInit)(void*);
1.8117 + void (*xShutdown)(void*);
1.8118 + sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
1.8119 + void (*xCachesize)(sqlite3_pcache*, int nCachesize);
1.8120 + int (*xPagecount)(sqlite3_pcache*);
1.8121 + sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
1.8122 + void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
1.8123 + void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
1.8124 + unsigned oldKey, unsigned newKey);
1.8125 + void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
1.8126 + void (*xDestroy)(sqlite3_pcache*);
1.8127 + void (*xShrink)(sqlite3_pcache*);
1.8128 +};
1.8129 +
1.8130 +/*
1.8131 +** This is the obsolete pcache_methods object that has now been replaced
1.8132 +** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
1.8133 +** retained in the header file for backwards compatibility only.
1.8134 +*/
1.8135 +typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
1.8136 +struct sqlite3_pcache_methods {
1.8137 + void *pArg;
1.8138 + int (*xInit)(void*);
1.8139 + void (*xShutdown)(void*);
1.8140 + sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
1.8141 + void (*xCachesize)(sqlite3_pcache*, int nCachesize);
1.8142 + int (*xPagecount)(sqlite3_pcache*);
1.8143 + void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
1.8144 + void (*xUnpin)(sqlite3_pcache*, void*, int discard);
1.8145 + void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
1.8146 + void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
1.8147 + void (*xDestroy)(sqlite3_pcache*);
1.8148 +};
1.8149 +
1.8150 +
1.8151 +/*
1.8152 +** CAPI3REF: Online Backup Object
1.8153 +**
1.8154 +** The sqlite3_backup object records state information about an ongoing
1.8155 +** online backup operation. ^The sqlite3_backup object is created by
1.8156 +** a call to [sqlite3_backup_init()] and is destroyed by a call to
1.8157 +** [sqlite3_backup_finish()].
1.8158 +**
1.8159 +** See Also: [Using the SQLite Online Backup API]
1.8160 +*/
1.8161 +typedef struct sqlite3_backup sqlite3_backup;
1.8162 +
1.8163 +/*
1.8164 +** CAPI3REF: Online Backup API.
1.8165 +**
1.8166 +** The backup API copies the content of one database into another.
1.8167 +** It is useful either for creating backups of databases or
1.8168 +** for copying in-memory databases to or from persistent files.
1.8169 +**
1.8170 +** See Also: [Using the SQLite Online Backup API]
1.8171 +**
1.8172 +** ^SQLite holds a write transaction open on the destination database file
1.8173 +** for the duration of the backup operation.
1.8174 +** ^The source database is read-locked only while it is being read;
1.8175 +** it is not locked continuously for the entire backup operation.
1.8176 +** ^Thus, the backup may be performed on a live source database without
1.8177 +** preventing other database connections from
1.8178 +** reading or writing to the source database while the backup is underway.
1.8179 +**
1.8180 +** ^(To perform a backup operation:
1.8181 +** <ol>
1.8182 +** <li><b>sqlite3_backup_init()</b> is called once to initialize the
1.8183 +** backup,
1.8184 +** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
1.8185 +** the data between the two databases, and finally
1.8186 +** <li><b>sqlite3_backup_finish()</b> is called to release all resources
1.8187 +** associated with the backup operation.
1.8188 +** </ol>)^
1.8189 +** There should be exactly one call to sqlite3_backup_finish() for each
1.8190 +** successful call to sqlite3_backup_init().
1.8191 +**
1.8192 +** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
1.8193 +**
1.8194 +** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
1.8195 +** [database connection] associated with the destination database
1.8196 +** and the database name, respectively.
1.8197 +** ^The database name is "main" for the main database, "temp" for the
1.8198 +** temporary database, or the name specified after the AS keyword in
1.8199 +** an [ATTACH] statement for an attached database.
1.8200 +** ^The S and M arguments passed to
1.8201 +** sqlite3_backup_init(D,N,S,M) identify the [database connection]
1.8202 +** and database name of the source database, respectively.
1.8203 +** ^The source and destination [database connections] (parameters S and D)
1.8204 +** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
1.8205 +** an error.
1.8206 +**
1.8207 +** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
1.8208 +** returned and an error code and error message are stored in the
1.8209 +** destination [database connection] D.
1.8210 +** ^The error code and message for the failed call to sqlite3_backup_init()
1.8211 +** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
1.8212 +** [sqlite3_errmsg16()] functions.
1.8213 +** ^A successful call to sqlite3_backup_init() returns a pointer to an
1.8214 +** [sqlite3_backup] object.
1.8215 +** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
1.8216 +** sqlite3_backup_finish() functions to perform the specified backup
1.8217 +** operation.
1.8218 +**
1.8219 +** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
1.8220 +**
1.8221 +** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
1.8222 +** the source and destination databases specified by [sqlite3_backup] object B.
1.8223 +** ^If N is negative, all remaining source pages are copied.
1.8224 +** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
1.8225 +** are still more pages to be copied, then the function returns [SQLITE_OK].
1.8226 +** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
1.8227 +** from source to destination, then it returns [SQLITE_DONE].
1.8228 +** ^If an error occurs while running sqlite3_backup_step(B,N),
1.8229 +** then an [error code] is returned. ^As well as [SQLITE_OK] and
1.8230 +** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
1.8231 +** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
1.8232 +** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
1.8233 +**
1.8234 +** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
1.8235 +** <ol>
1.8236 +** <li> the destination database was opened read-only, or
1.8237 +** <li> the destination database is using write-ahead-log journaling
1.8238 +** and the destination and source page sizes differ, or
1.8239 +** <li> the destination database is an in-memory database and the
1.8240 +** destination and source page sizes differ.
1.8241 +** </ol>)^
1.8242 +**
1.8243 +** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
1.8244 +** the [sqlite3_busy_handler | busy-handler function]
1.8245 +** is invoked (if one is specified). ^If the
1.8246 +** busy-handler returns non-zero before the lock is available, then
1.8247 +** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
1.8248 +** sqlite3_backup_step() can be retried later. ^If the source
1.8249 +** [database connection]
1.8250 +** is being used to write to the source database when sqlite3_backup_step()
1.8251 +** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
1.8252 +** case the call to sqlite3_backup_step() can be retried later on. ^(If
1.8253 +** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
1.8254 +** [SQLITE_READONLY] is returned, then
1.8255 +** there is no point in retrying the call to sqlite3_backup_step(). These
1.8256 +** errors are considered fatal.)^ The application must accept
1.8257 +** that the backup operation has failed and pass the backup operation handle
1.8258 +** to the sqlite3_backup_finish() to release associated resources.
1.8259 +**
1.8260 +** ^The first call to sqlite3_backup_step() obtains an exclusive lock
1.8261 +** on the destination file. ^The exclusive lock is not released until either
1.8262 +** sqlite3_backup_finish() is called or the backup operation is complete
1.8263 +** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
1.8264 +** sqlite3_backup_step() obtains a [shared lock] on the source database that
1.8265 +** lasts for the duration of the sqlite3_backup_step() call.
1.8266 +** ^Because the source database is not locked between calls to
1.8267 +** sqlite3_backup_step(), the source database may be modified mid-way
1.8268 +** through the backup process. ^If the source database is modified by an
1.8269 +** external process or via a database connection other than the one being
1.8270 +** used by the backup operation, then the backup will be automatically
1.8271 +** restarted by the next call to sqlite3_backup_step(). ^If the source
1.8272 +** database is modified by the using the same database connection as is used
1.8273 +** by the backup operation, then the backup database is automatically
1.8274 +** updated at the same time.
1.8275 +**
1.8276 +** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
1.8277 +**
1.8278 +** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
1.8279 +** application wishes to abandon the backup operation, the application
1.8280 +** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
1.8281 +** ^The sqlite3_backup_finish() interfaces releases all
1.8282 +** resources associated with the [sqlite3_backup] object.
1.8283 +** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
1.8284 +** active write-transaction on the destination database is rolled back.
1.8285 +** The [sqlite3_backup] object is invalid
1.8286 +** and may not be used following a call to sqlite3_backup_finish().
1.8287 +**
1.8288 +** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
1.8289 +** sqlite3_backup_step() errors occurred, regardless or whether or not
1.8290 +** sqlite3_backup_step() completed.
1.8291 +** ^If an out-of-memory condition or IO error occurred during any prior
1.8292 +** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
1.8293 +** sqlite3_backup_finish() returns the corresponding [error code].
1.8294 +**
1.8295 +** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
1.8296 +** is not a permanent error and does not affect the return value of
1.8297 +** sqlite3_backup_finish().
1.8298 +**
1.8299 +** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]]
1.8300 +** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
1.8301 +**
1.8302 +** ^Each call to sqlite3_backup_step() sets two values inside
1.8303 +** the [sqlite3_backup] object: the number of pages still to be backed
1.8304 +** up and the total number of pages in the source database file.
1.8305 +** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces
1.8306 +** retrieve these two values, respectively.
1.8307 +**
1.8308 +** ^The values returned by these functions are only updated by
1.8309 +** sqlite3_backup_step(). ^If the source database is modified during a backup
1.8310 +** operation, then the values are not updated to account for any extra
1.8311 +** pages that need to be updated or the size of the source database file
1.8312 +** changing.
1.8313 +**
1.8314 +** <b>Concurrent Usage of Database Handles</b>
1.8315 +**
1.8316 +** ^The source [database connection] may be used by the application for other
1.8317 +** purposes while a backup operation is underway or being initialized.
1.8318 +** ^If SQLite is compiled and configured to support threadsafe database
1.8319 +** connections, then the source database connection may be used concurrently
1.8320 +** from within other threads.
1.8321 +**
1.8322 +** However, the application must guarantee that the destination
1.8323 +** [database connection] is not passed to any other API (by any thread) after
1.8324 +** sqlite3_backup_init() is called and before the corresponding call to
1.8325 +** sqlite3_backup_finish(). SQLite does not currently check to see
1.8326 +** if the application incorrectly accesses the destination [database connection]
1.8327 +** and so no error code is reported, but the operations may malfunction
1.8328 +** nevertheless. Use of the destination database connection while a
1.8329 +** backup is in progress might also also cause a mutex deadlock.
1.8330 +**
1.8331 +** If running in [shared cache mode], the application must
1.8332 +** guarantee that the shared cache used by the destination database
1.8333 +** is not accessed while the backup is running. In practice this means
1.8334 +** that the application must guarantee that the disk file being
1.8335 +** backed up to is not accessed by any connection within the process,
1.8336 +** not just the specific connection that was passed to sqlite3_backup_init().
1.8337 +**
1.8338 +** The [sqlite3_backup] object itself is partially threadsafe. Multiple
1.8339 +** threads may safely make multiple concurrent calls to sqlite3_backup_step().
1.8340 +** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
1.8341 +** APIs are not strictly speaking threadsafe. If they are invoked at the
1.8342 +** same time as another thread is invoking sqlite3_backup_step() it is
1.8343 +** possible that they return invalid values.
1.8344 +*/
1.8345 +SQLITE_API sqlite3_backup *sqlite3_backup_init(
1.8346 + sqlite3 *pDest, /* Destination database handle */
1.8347 + const char *zDestName, /* Destination database name */
1.8348 + sqlite3 *pSource, /* Source database handle */
1.8349 + const char *zSourceName /* Source database name */
1.8350 +);
1.8351 +SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
1.8352 +SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
1.8353 +SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
1.8354 +SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
1.8355 +
1.8356 +/*
1.8357 +** CAPI3REF: Unlock Notification
1.8358 +**
1.8359 +** ^When running in shared-cache mode, a database operation may fail with
1.8360 +** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
1.8361 +** individual tables within the shared-cache cannot be obtained. See
1.8362 +** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
1.8363 +** ^This API may be used to register a callback that SQLite will invoke
1.8364 +** when the connection currently holding the required lock relinquishes it.
1.8365 +** ^This API is only available if the library was compiled with the
1.8366 +** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
1.8367 +**
1.8368 +** See Also: [Using the SQLite Unlock Notification Feature].
1.8369 +**
1.8370 +** ^Shared-cache locks are released when a database connection concludes
1.8371 +** its current transaction, either by committing it or rolling it back.
1.8372 +**
1.8373 +** ^When a connection (known as the blocked connection) fails to obtain a
1.8374 +** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
1.8375 +** identity of the database connection (the blocking connection) that
1.8376 +** has locked the required resource is stored internally. ^After an
1.8377 +** application receives an SQLITE_LOCKED error, it may call the
1.8378 +** sqlite3_unlock_notify() method with the blocked connection handle as
1.8379 +** the first argument to register for a callback that will be invoked
1.8380 +** when the blocking connections current transaction is concluded. ^The
1.8381 +** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
1.8382 +** call that concludes the blocking connections transaction.
1.8383 +**
1.8384 +** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
1.8385 +** there is a chance that the blocking connection will have already
1.8386 +** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
1.8387 +** If this happens, then the specified callback is invoked immediately,
1.8388 +** from within the call to sqlite3_unlock_notify().)^
1.8389 +**
1.8390 +** ^If the blocked connection is attempting to obtain a write-lock on a
1.8391 +** shared-cache table, and more than one other connection currently holds
1.8392 +** a read-lock on the same table, then SQLite arbitrarily selects one of
1.8393 +** the other connections to use as the blocking connection.
1.8394 +**
1.8395 +** ^(There may be at most one unlock-notify callback registered by a
1.8396 +** blocked connection. If sqlite3_unlock_notify() is called when the
1.8397 +** blocked connection already has a registered unlock-notify callback,
1.8398 +** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
1.8399 +** called with a NULL pointer as its second argument, then any existing
1.8400 +** unlock-notify callback is canceled. ^The blocked connections
1.8401 +** unlock-notify callback may also be canceled by closing the blocked
1.8402 +** connection using [sqlite3_close()].
1.8403 +**
1.8404 +** The unlock-notify callback is not reentrant. If an application invokes
1.8405 +** any sqlite3_xxx API functions from within an unlock-notify callback, a
1.8406 +** crash or deadlock may be the result.
1.8407 +**
1.8408 +** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
1.8409 +** returns SQLITE_OK.
1.8410 +**
1.8411 +** <b>Callback Invocation Details</b>
1.8412 +**
1.8413 +** When an unlock-notify callback is registered, the application provides a
1.8414 +** single void* pointer that is passed to the callback when it is invoked.
1.8415 +** However, the signature of the callback function allows SQLite to pass
1.8416 +** it an array of void* context pointers. The first argument passed to
1.8417 +** an unlock-notify callback is a pointer to an array of void* pointers,
1.8418 +** and the second is the number of entries in the array.
1.8419 +**
1.8420 +** When a blocking connections transaction is concluded, there may be
1.8421 +** more than one blocked connection that has registered for an unlock-notify
1.8422 +** callback. ^If two or more such blocked connections have specified the
1.8423 +** same callback function, then instead of invoking the callback function
1.8424 +** multiple times, it is invoked once with the set of void* context pointers
1.8425 +** specified by the blocked connections bundled together into an array.
1.8426 +** This gives the application an opportunity to prioritize any actions
1.8427 +** related to the set of unblocked database connections.
1.8428 +**
1.8429 +** <b>Deadlock Detection</b>
1.8430 +**
1.8431 +** Assuming that after registering for an unlock-notify callback a
1.8432 +** database waits for the callback to be issued before taking any further
1.8433 +** action (a reasonable assumption), then using this API may cause the
1.8434 +** application to deadlock. For example, if connection X is waiting for
1.8435 +** connection Y's transaction to be concluded, and similarly connection
1.8436 +** Y is waiting on connection X's transaction, then neither connection
1.8437 +** will proceed and the system may remain deadlocked indefinitely.
1.8438 +**
1.8439 +** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
1.8440 +** detection. ^If a given call to sqlite3_unlock_notify() would put the
1.8441 +** system in a deadlocked state, then SQLITE_LOCKED is returned and no
1.8442 +** unlock-notify callback is registered. The system is said to be in
1.8443 +** a deadlocked state if connection A has registered for an unlock-notify
1.8444 +** callback on the conclusion of connection B's transaction, and connection
1.8445 +** B has itself registered for an unlock-notify callback when connection
1.8446 +** A's transaction is concluded. ^Indirect deadlock is also detected, so
1.8447 +** the system is also considered to be deadlocked if connection B has
1.8448 +** registered for an unlock-notify callback on the conclusion of connection
1.8449 +** C's transaction, where connection C is waiting on connection A. ^Any
1.8450 +** number of levels of indirection are allowed.
1.8451 +**
1.8452 +** <b>The "DROP TABLE" Exception</b>
1.8453 +**
1.8454 +** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
1.8455 +** always appropriate to call sqlite3_unlock_notify(). There is however,
1.8456 +** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
1.8457 +** SQLite checks if there are any currently executing SELECT statements
1.8458 +** that belong to the same connection. If there are, SQLITE_LOCKED is
1.8459 +** returned. In this case there is no "blocking connection", so invoking
1.8460 +** sqlite3_unlock_notify() results in the unlock-notify callback being
1.8461 +** invoked immediately. If the application then re-attempts the "DROP TABLE"
1.8462 +** or "DROP INDEX" query, an infinite loop might be the result.
1.8463 +**
1.8464 +** One way around this problem is to check the extended error code returned
1.8465 +** by an sqlite3_step() call. ^(If there is a blocking connection, then the
1.8466 +** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
1.8467 +** the special "DROP TABLE/INDEX" case, the extended error code is just
1.8468 +** SQLITE_LOCKED.)^
1.8469 +*/
1.8470 +SQLITE_API int sqlite3_unlock_notify(
1.8471 + sqlite3 *pBlocked, /* Waiting connection */
1.8472 + void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
1.8473 + void *pNotifyArg /* Argument to pass to xNotify */
1.8474 +);
1.8475 +
1.8476 +
1.8477 +/*
1.8478 +** CAPI3REF: String Comparison
1.8479 +**
1.8480 +** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
1.8481 +** and extensions to compare the contents of two buffers containing UTF-8
1.8482 +** strings in a case-independent fashion, using the same definition of "case
1.8483 +** independence" that SQLite uses internally when comparing identifiers.
1.8484 +*/
1.8485 +SQLITE_API int sqlite3_stricmp(const char *, const char *);
1.8486 +SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);
1.8487 +
1.8488 +/*
1.8489 +** CAPI3REF: Error Logging Interface
1.8490 +**
1.8491 +** ^The [sqlite3_log()] interface writes a message into the error log
1.8492 +** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
1.8493 +** ^If logging is enabled, the zFormat string and subsequent arguments are
1.8494 +** used with [sqlite3_snprintf()] to generate the final output string.
1.8495 +**
1.8496 +** The sqlite3_log() interface is intended for use by extensions such as
1.8497 +** virtual tables, collating functions, and SQL functions. While there is
1.8498 +** nothing to prevent an application from calling sqlite3_log(), doing so
1.8499 +** is considered bad form.
1.8500 +**
1.8501 +** The zFormat string must not be NULL.
1.8502 +**
1.8503 +** To avoid deadlocks and other threading problems, the sqlite3_log() routine
1.8504 +** will not use dynamically allocated memory. The log message is stored in
1.8505 +** a fixed-length buffer on the stack. If the log message is longer than
1.8506 +** a few hundred characters, it will be truncated to the length of the
1.8507 +** buffer.
1.8508 +*/
1.8509 +SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
1.8510 +
1.8511 +/*
1.8512 +** CAPI3REF: Write-Ahead Log Commit Hook
1.8513 +**
1.8514 +** ^The [sqlite3_wal_hook()] function is used to register a callback that
1.8515 +** will be invoked each time a database connection commits data to a
1.8516 +** [write-ahead log] (i.e. whenever a transaction is committed in
1.8517 +** [journal_mode | journal_mode=WAL mode]).
1.8518 +**
1.8519 +** ^The callback is invoked by SQLite after the commit has taken place and
1.8520 +** the associated write-lock on the database released, so the implementation
1.8521 +** may read, write or [checkpoint] the database as required.
1.8522 +**
1.8523 +** ^The first parameter passed to the callback function when it is invoked
1.8524 +** is a copy of the third parameter passed to sqlite3_wal_hook() when
1.8525 +** registering the callback. ^The second is a copy of the database handle.
1.8526 +** ^The third parameter is the name of the database that was written to -
1.8527 +** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
1.8528 +** is the number of pages currently in the write-ahead log file,
1.8529 +** including those that were just committed.
1.8530 +**
1.8531 +** The callback function should normally return [SQLITE_OK]. ^If an error
1.8532 +** code is returned, that error will propagate back up through the
1.8533 +** SQLite code base to cause the statement that provoked the callback
1.8534 +** to report an error, though the commit will have still occurred. If the
1.8535 +** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
1.8536 +** that does not correspond to any valid SQLite error code, the results
1.8537 +** are undefined.
1.8538 +**
1.8539 +** A single database handle may have at most a single write-ahead log callback
1.8540 +** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
1.8541 +** previously registered write-ahead log callback. ^Note that the
1.8542 +** [sqlite3_wal_autocheckpoint()] interface and the
1.8543 +** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
1.8544 +** those overwrite any prior [sqlite3_wal_hook()] settings.
1.8545 +*/
1.8546 +SQLITE_API void *sqlite3_wal_hook(
1.8547 + sqlite3*,
1.8548 + int(*)(void *,sqlite3*,const char*,int),
1.8549 + void*
1.8550 +);
1.8551 +
1.8552 +/*
1.8553 +** CAPI3REF: Configure an auto-checkpoint
1.8554 +**
1.8555 +** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
1.8556 +** [sqlite3_wal_hook()] that causes any database on [database connection] D
1.8557 +** to automatically [checkpoint]
1.8558 +** after committing a transaction if there are N or
1.8559 +** more frames in the [write-ahead log] file. ^Passing zero or
1.8560 +** a negative value as the nFrame parameter disables automatic
1.8561 +** checkpoints entirely.
1.8562 +**
1.8563 +** ^The callback registered by this function replaces any existing callback
1.8564 +** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
1.8565 +** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
1.8566 +** configured by this function.
1.8567 +**
1.8568 +** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
1.8569 +** from SQL.
1.8570 +**
1.8571 +** ^Every new [database connection] defaults to having the auto-checkpoint
1.8572 +** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
1.8573 +** pages. The use of this interface
1.8574 +** is only necessary if the default setting is found to be suboptimal
1.8575 +** for a particular application.
1.8576 +*/
1.8577 +SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
1.8578 +
1.8579 +/*
1.8580 +** CAPI3REF: Checkpoint a database
1.8581 +**
1.8582 +** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X
1.8583 +** on [database connection] D to be [checkpointed]. ^If X is NULL or an
1.8584 +** empty string, then a checkpoint is run on all databases of
1.8585 +** connection D. ^If the database connection D is not in
1.8586 +** [WAL | write-ahead log mode] then this interface is a harmless no-op.
1.8587 +**
1.8588 +** ^The [wal_checkpoint pragma] can be used to invoke this interface
1.8589 +** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the
1.8590 +** [wal_autocheckpoint pragma] can be used to cause this interface to be
1.8591 +** run whenever the WAL reaches a certain size threshold.
1.8592 +**
1.8593 +** See also: [sqlite3_wal_checkpoint_v2()]
1.8594 +*/
1.8595 +SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
1.8596 +
1.8597 +/*
1.8598 +** CAPI3REF: Checkpoint a database
1.8599 +**
1.8600 +** Run a checkpoint operation on WAL database zDb attached to database
1.8601 +** handle db. The specific operation is determined by the value of the
1.8602 +** eMode parameter:
1.8603 +**
1.8604 +** <dl>
1.8605 +** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
1.8606 +** Checkpoint as many frames as possible without waiting for any database
1.8607 +** readers or writers to finish. Sync the db file if all frames in the log
1.8608 +** are checkpointed. This mode is the same as calling
1.8609 +** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked.
1.8610 +**
1.8611 +** <dt>SQLITE_CHECKPOINT_FULL<dd>
1.8612 +** This mode blocks (calls the busy-handler callback) until there is no
1.8613 +** database writer and all readers are reading from the most recent database
1.8614 +** snapshot. It then checkpoints all frames in the log file and syncs the
1.8615 +** database file. This call blocks database writers while it is running,
1.8616 +** but not database readers.
1.8617 +**
1.8618 +** <dt>SQLITE_CHECKPOINT_RESTART<dd>
1.8619 +** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after
1.8620 +** checkpointing the log file it blocks (calls the busy-handler callback)
1.8621 +** until all readers are reading from the database file only. This ensures
1.8622 +** that the next client to write to the database file restarts the log file
1.8623 +** from the beginning. This call blocks database writers while it is running,
1.8624 +** but not database readers.
1.8625 +** </dl>
1.8626 +**
1.8627 +** If pnLog is not NULL, then *pnLog is set to the total number of frames in
1.8628 +** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to
1.8629 +** the total number of checkpointed frames (including any that were already
1.8630 +** checkpointed when this function is called). *pnLog and *pnCkpt may be
1.8631 +** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK.
1.8632 +** If no values are available because of an error, they are both set to -1
1.8633 +** before returning to communicate this to the caller.
1.8634 +**
1.8635 +** All calls obtain an exclusive "checkpoint" lock on the database file. If
1.8636 +** any other process is running a checkpoint operation at the same time, the
1.8637 +** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a
1.8638 +** busy-handler configured, it will not be invoked in this case.
1.8639 +**
1.8640 +** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive
1.8641 +** "writer" lock on the database file. If the writer lock cannot be obtained
1.8642 +** immediately, and a busy-handler is configured, it is invoked and the writer
1.8643 +** lock retried until either the busy-handler returns 0 or the lock is
1.8644 +** successfully obtained. The busy-handler is also invoked while waiting for
1.8645 +** database readers as described above. If the busy-handler returns 0 before
1.8646 +** the writer lock is obtained or while waiting for database readers, the
1.8647 +** checkpoint operation proceeds from that point in the same way as
1.8648 +** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
1.8649 +** without blocking any further. SQLITE_BUSY is returned in this case.
1.8650 +**
1.8651 +** If parameter zDb is NULL or points to a zero length string, then the
1.8652 +** specified operation is attempted on all WAL databases. In this case the
1.8653 +** values written to output parameters *pnLog and *pnCkpt are undefined. If
1.8654 +** an SQLITE_BUSY error is encountered when processing one or more of the
1.8655 +** attached WAL databases, the operation is still attempted on any remaining
1.8656 +** attached databases and SQLITE_BUSY is returned to the caller. If any other
1.8657 +** error occurs while processing an attached database, processing is abandoned
1.8658 +** and the error code returned to the caller immediately. If no error
1.8659 +** (SQLITE_BUSY or otherwise) is encountered while processing the attached
1.8660 +** databases, SQLITE_OK is returned.
1.8661 +**
1.8662 +** If database zDb is the name of an attached database that is not in WAL
1.8663 +** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If
1.8664 +** zDb is not NULL (or a zero length string) and is not the name of any
1.8665 +** attached database, SQLITE_ERROR is returned to the caller.
1.8666 +*/
1.8667 +SQLITE_API int sqlite3_wal_checkpoint_v2(
1.8668 + sqlite3 *db, /* Database handle */
1.8669 + const char *zDb, /* Name of attached database (or NULL) */
1.8670 + int eMode, /* SQLITE_CHECKPOINT_* value */
1.8671 + int *pnLog, /* OUT: Size of WAL log in frames */
1.8672 + int *pnCkpt /* OUT: Total number of frames checkpointed */
1.8673 +);
1.8674 +
1.8675 +/*
1.8676 +** CAPI3REF: Checkpoint operation parameters
1.8677 +**
1.8678 +** These constants can be used as the 3rd parameter to
1.8679 +** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()]
1.8680 +** documentation for additional information about the meaning and use of
1.8681 +** each of these values.
1.8682 +*/
1.8683 +#define SQLITE_CHECKPOINT_PASSIVE 0
1.8684 +#define SQLITE_CHECKPOINT_FULL 1
1.8685 +#define SQLITE_CHECKPOINT_RESTART 2
1.8686 +
1.8687 +/*
1.8688 +** CAPI3REF: Virtual Table Interface Configuration
1.8689 +**
1.8690 +** This function may be called by either the [xConnect] or [xCreate] method
1.8691 +** of a [virtual table] implementation to configure
1.8692 +** various facets of the virtual table interface.
1.8693 +**
1.8694 +** If this interface is invoked outside the context of an xConnect or
1.8695 +** xCreate virtual table method then the behavior is undefined.
1.8696 +**
1.8697 +** At present, there is only one option that may be configured using
1.8698 +** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options
1.8699 +** may be added in the future.
1.8700 +*/
1.8701 +SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
1.8702 +
1.8703 +/*
1.8704 +** CAPI3REF: Virtual Table Configuration Options
1.8705 +**
1.8706 +** These macros define the various options to the
1.8707 +** [sqlite3_vtab_config()] interface that [virtual table] implementations
1.8708 +** can use to customize and optimize their behavior.
1.8709 +**
1.8710 +** <dl>
1.8711 +** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT
1.8712 +** <dd>Calls of the form
1.8713 +** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
1.8714 +** where X is an integer. If X is zero, then the [virtual table] whose
1.8715 +** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
1.8716 +** support constraints. In this configuration (which is the default) if
1.8717 +** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
1.8718 +** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
1.8719 +** specified as part of the users SQL statement, regardless of the actual
1.8720 +** ON CONFLICT mode specified.
1.8721 +**
1.8722 +** If X is non-zero, then the virtual table implementation guarantees
1.8723 +** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
1.8724 +** any modifications to internal or persistent data structures have been made.
1.8725 +** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
1.8726 +** is able to roll back a statement or database transaction, and abandon
1.8727 +** or continue processing the current SQL statement as appropriate.
1.8728 +** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
1.8729 +** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
1.8730 +** had been ABORT.
1.8731 +**
1.8732 +** Virtual table implementations that are required to handle OR REPLACE
1.8733 +** must do so within the [xUpdate] method. If a call to the
1.8734 +** [sqlite3_vtab_on_conflict()] function indicates that the current ON
1.8735 +** CONFLICT policy is REPLACE, the virtual table implementation should
1.8736 +** silently replace the appropriate rows within the xUpdate callback and
1.8737 +** return SQLITE_OK. Or, if this is not possible, it may return
1.8738 +** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
1.8739 +** constraint handling.
1.8740 +** </dl>
1.8741 +*/
1.8742 +#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
1.8743 +
1.8744 +/*
1.8745 +** CAPI3REF: Determine The Virtual Table Conflict Policy
1.8746 +**
1.8747 +** This function may only be called from within a call to the [xUpdate] method
1.8748 +** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
1.8749 +** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
1.8750 +** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
1.8751 +** of the SQL statement that triggered the call to the [xUpdate] method of the
1.8752 +** [virtual table].
1.8753 +*/
1.8754 +SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
1.8755 +
1.8756 +/*
1.8757 +** CAPI3REF: Conflict resolution modes
1.8758 +**
1.8759 +** These constants are returned by [sqlite3_vtab_on_conflict()] to
1.8760 +** inform a [virtual table] implementation what the [ON CONFLICT] mode
1.8761 +** is for the SQL statement being evaluated.
1.8762 +**
1.8763 +** Note that the [SQLITE_IGNORE] constant is also used as a potential
1.8764 +** return value from the [sqlite3_set_authorizer()] callback and that
1.8765 +** [SQLITE_ABORT] is also a [result code].
1.8766 +*/
1.8767 +#define SQLITE_ROLLBACK 1
1.8768 +/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
1.8769 +#define SQLITE_FAIL 3
1.8770 +/* #define SQLITE_ABORT 4 // Also an error code */
1.8771 +#define SQLITE_REPLACE 5
1.8772 +
1.8773 +
1.8774
1.8775 /*
1.8776 ** Undo the hack that converts floating point types to integer for
1.8777 @@ -3550,3 +6992,64 @@
1.8778 } /* End of the 'extern "C"' block */
1.8779 #endif
1.8780 #endif
1.8781 +
1.8782 +/*
1.8783 +** 2010 August 30
1.8784 +**
1.8785 +** The author disclaims copyright to this source code. In place of
1.8786 +** a legal notice, here is a blessing:
1.8787 +**
1.8788 +** May you do good and not evil.
1.8789 +** May you find forgiveness for yourself and forgive others.
1.8790 +** May you share freely, never taking more than you give.
1.8791 +**
1.8792 +*************************************************************************
1.8793 +*/
1.8794 +
1.8795 +#ifndef _SQLITE3RTREE_H_
1.8796 +#define _SQLITE3RTREE_H_
1.8797 +
1.8798 +
1.8799 +#ifdef __cplusplus
1.8800 +extern "C" {
1.8801 +#endif
1.8802 +
1.8803 +typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
1.8804 +
1.8805 +/*
1.8806 +** Register a geometry callback named zGeom that can be used as part of an
1.8807 +** R-Tree geometry query as follows:
1.8808 +**
1.8809 +** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
1.8810 +*/
1.8811 +SQLITE_API int sqlite3_rtree_geometry_callback(
1.8812 + sqlite3 *db,
1.8813 + const char *zGeom,
1.8814 +#ifdef SQLITE_RTREE_INT_ONLY
1.8815 + int (*xGeom)(sqlite3_rtree_geometry*, int n, sqlite3_int64 *a, int *pRes),
1.8816 +#else
1.8817 + int (*xGeom)(sqlite3_rtree_geometry*, int n, double *a, int *pRes),
1.8818 +#endif
1.8819 + void *pContext
1.8820 +);
1.8821 +
1.8822 +
1.8823 +/*
1.8824 +** A pointer to a structure of the following type is passed as the first
1.8825 +** argument to callbacks registered using rtree_geometry_callback().
1.8826 +*/
1.8827 +struct sqlite3_rtree_geometry {
1.8828 + void *pContext; /* Copy of pContext passed to s_r_g_c() */
1.8829 + int nParam; /* Size of array aParam[] */
1.8830 + double *aParam; /* Parameters passed to SQL geom function */
1.8831 + void *pUser; /* Callback implementation user data */
1.8832 + void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */
1.8833 +};
1.8834 +
1.8835 +
1.8836 +#ifdef __cplusplus
1.8837 +} /* end of the 'extern "C"' block */
1.8838 +#endif
1.8839 +
1.8840 +#endif /* ifndef _SQLITE3RTREE_H_ */
1.8841 +
