| 1 |
/* |
| 2 |
** 2001 September 15 |
| 3 |
** |
| 4 |
** The author disclaims copyright to this source code. In place of |
| 5 |
** a legal notice, here is a blessing: |
| 6 |
** |
| 7 |
** May you do good and not evil. |
| 8 |
** May you find forgiveness for yourself and forgive others. |
| 9 |
** May you share freely, never taking more than you give. |
| 10 |
** |
| 11 |
************************************************************************* |
| 12 |
** This header file defines the interface that the SQLite library |
| 13 |
** presents to client programs. If a C-function, structure, datatype, |
| 14 |
** or constant definition does not appear in this file, then it is |
| 15 |
** not a published API of SQLite, is subject to change without |
| 16 |
** notice, and should not be referenced by programs that use SQLite. |
| 17 |
** |
| 18 |
** Some of the definitions that are in this file are marked as |
| 19 |
** "experimental". Experimental interfaces are normally new |
| 20 |
** features recently added to SQLite. We do not anticipate changes |
| 21 |
** to experimental interfaces but reserve the right to make minor changes |
| 22 |
** if experience from use "in the wild" suggest such changes are prudent. |
| 23 |
** |
| 24 |
** The official C-language API documentation for SQLite is derived |
| 25 |
** from comments in this file. This file is the authoritative source |
| 26 |
** on how SQLite interfaces are supposed to operate. |
| 27 |
** |
| 28 |
** The name of this file under configuration management is "sqlite.h.in". |
| 29 |
** The makefile makes some minor changes to this file (such as inserting |
| 30 |
** the version number) and changes its name to "sqlite3.h" as |
| 31 |
** part of the build process. |
| 32 |
*/ |
| 33 |
#ifndef SQLITE3_H |
| 34 |
#define SQLITE3_H |
| 35 |
#include <stdarg.h> /* Needed for the definition of va_list */ |
| 36 |
|
| 37 |
/* |
| 38 |
** Make sure we can call this stuff from C++. |
| 39 |
*/ |
| 40 |
#ifdef __cplusplus |
| 41 |
extern "C" { |
| 42 |
#endif |
| 43 |
|
| 44 |
|
| 45 |
/* |
| 46 |
** Provide the ability to override linkage features of the interface. |
| 47 |
*/ |
| 48 |
#ifndef SQLITE_EXTERN |
| 49 |
# define SQLITE_EXTERN extern |
| 50 |
#endif |
| 51 |
#ifndef SQLITE_API |
| 52 |
# define SQLITE_API |
| 53 |
#endif |
| 54 |
#ifndef SQLITE_CDECL |
| 55 |
# define SQLITE_CDECL |
| 56 |
#endif |
| 57 |
#ifndef SQLITE_APICALL |
| 58 |
# define SQLITE_APICALL |
| 59 |
#endif |
| 60 |
#ifndef SQLITE_STDCALL |
| 61 |
# define SQLITE_STDCALL SQLITE_APICALL |
| 62 |
#endif |
| 63 |
#ifndef SQLITE_CALLBACK |
| 64 |
# define SQLITE_CALLBACK |
| 65 |
#endif |
| 66 |
#ifndef SQLITE_SYSAPI |
| 67 |
# define SQLITE_SYSAPI |
| 68 |
#endif |
| 69 |
|
| 70 |
/* |
| 71 |
** These no-op macros are used in front of interfaces to mark those |
| 72 |
** interfaces as either deprecated or experimental. New applications |
| 73 |
** should not use deprecated interfaces - they are supported for backwards |
| 74 |
** compatibility only. Application writers should be aware that |
| 75 |
** experimental interfaces are subject to change in point releases. |
| 76 |
** |
| 77 |
** These macros used to resolve to various kinds of compiler magic that |
| 78 |
** would generate warning messages when they were used. But that |
| 79 |
** compiler magic ended up generating such a flurry of bug reports |
| 80 |
** that we have taken it all out and gone back to using simple |
| 81 |
** noop macros. |
| 82 |
*/ |
| 83 |
#define SQLITE_DEPRECATED |
| 84 |
#define SQLITE_EXPERIMENTAL |
| 85 |
|
| 86 |
/* |
| 87 |
** Ensure these symbols were not defined by some previous header file. |
| 88 |
*/ |
| 89 |
#ifdef SQLITE_VERSION |
| 90 |
# undef SQLITE_VERSION |
| 91 |
#endif |
| 92 |
#ifdef SQLITE_VERSION_NUMBER |
| 93 |
# undef SQLITE_VERSION_NUMBER |
| 94 |
#endif |
| 95 |
|
| 96 |
/* |
| 97 |
** CAPI3REF: Compile-Time Library Version Numbers |
| 98 |
** |
| 99 |
** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header |
| 100 |
** evaluates to a string literal that is the SQLite version in the |
| 101 |
** format "X.Y.Z" where X is the major version number (always 3 for |
| 102 |
** SQLite3) and Y is the minor version number and Z is the release number.)^ |
| 103 |
** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer |
| 104 |
** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same |
| 105 |
** numbers used in [SQLITE_VERSION].)^ |
| 106 |
** The SQLITE_VERSION_NUMBER for any given release of SQLite will also |
| 107 |
** be larger than the release from which it is derived. Either Y will |
| 108 |
** be held constant and Z will be incremented or else Y will be incremented |
| 109 |
** and Z will be reset to zero. |
| 110 |
** |
| 111 |
** Since [version 3.6.18] ([dateof:3.6.18]), |
| 112 |
** SQLite source code has been stored in the |
| 113 |
** <a href="http://www.fossil-scm.org/">Fossil configuration management |
| 114 |
** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to |
| 115 |
** a string which identifies a particular check-in of SQLite |
| 116 |
** within its configuration management system. ^The SQLITE_SOURCE_ID |
| 117 |
** string contains the date and time of the check-in (UTC) and an SHA1 |
| 118 |
** hash of the entire source tree. |
| 119 |
** |
| 120 |
** See also: [sqlite3_libversion()], |
| 121 |
** [sqlite3_libversion_number()], [sqlite3_sourceid()], |
| 122 |
** [sqlite_version()] and [sqlite_source_id()]. |
| 123 |
*/ |
| 124 |
#define SQLITE_VERSION "3.15.1" |
| 125 |
#define SQLITE_VERSION_NUMBER 3015001 |
| 126 |
#define SQLITE_SOURCE_ID "2016-11-04 12:08:49 1136863c76576110e710dd5d69ab6bf347c65e36" |
| 127 |
|
| 128 |
/* |
| 129 |
** CAPI3REF: Run-Time Library Version Numbers |
| 130 |
** KEYWORDS: sqlite3_version, sqlite3_sourceid |
| 131 |
** |
| 132 |
** These interfaces provide the same information as the [SQLITE_VERSION], |
| 133 |
** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros |
| 134 |
** but are associated with the library instead of the header file. ^(Cautious |
| 135 |
** programmers might include assert() statements in their application to |
| 136 |
** verify that values returned by these interfaces match the macros in |
| 137 |
** the header, and thus ensure that the application is |
| 138 |
** compiled with matching library and header files. |
| 139 |
** |
| 140 |
** <blockquote><pre> |
| 141 |
** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); |
| 142 |
** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); |
| 143 |
** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); |
| 144 |
** </pre></blockquote>)^ |
| 145 |
** |
| 146 |
** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] |
| 147 |
** macro. ^The sqlite3_libversion() function returns a pointer to the |
| 148 |
** to the sqlite3_version[] string constant. The sqlite3_libversion() |
| 149 |
** function is provided for use in DLLs since DLL users usually do not have |
| 150 |
** direct access to string constants within the DLL. ^The |
| 151 |
** sqlite3_libversion_number() function returns an integer equal to |
| 152 |
** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns |
| 153 |
** a pointer to a string constant whose value is the same as the |
| 154 |
** [SQLITE_SOURCE_ID] C preprocessor macro. |
| 155 |
** |
| 156 |
** See also: [sqlite_version()] and [sqlite_source_id()]. |
| 157 |
*/ |
| 158 |
SQLITE_API SQLITE_EXTERN const char sqlite3_version[]; |
| 159 |
SQLITE_API const char *sqlite3_libversion(void); |
| 160 |
SQLITE_API const char *sqlite3_sourceid(void); |
| 161 |
SQLITE_API int sqlite3_libversion_number(void); |
| 162 |
|
| 163 |
/* |
| 164 |
** CAPI3REF: Run-Time Library Compilation Options Diagnostics |
| 165 |
** |
| 166 |
** ^The sqlite3_compileoption_used() function returns 0 or 1 |
| 167 |
** indicating whether the specified option was defined at |
| 168 |
** compile time. ^The SQLITE_ prefix may be omitted from the |
| 169 |
** option name passed to sqlite3_compileoption_used(). |
| 170 |
** |
| 171 |
** ^The sqlite3_compileoption_get() function allows iterating |
| 172 |
** over the list of options that were defined at compile time by |
| 173 |
** returning the N-th compile time option string. ^If N is out of range, |
| 174 |
** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ |
| 175 |
** prefix is omitted from any strings returned by |
| 176 |
** sqlite3_compileoption_get(). |
| 177 |
** |
| 178 |
** ^Support for the diagnostic functions sqlite3_compileoption_used() |
| 179 |
** and sqlite3_compileoption_get() may be omitted by specifying the |
| 180 |
** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. |
| 181 |
** |
| 182 |
** See also: SQL functions [sqlite_compileoption_used()] and |
| 183 |
** [sqlite_compileoption_get()] and the [compile_options pragma]. |
| 184 |
*/ |
| 185 |
#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS |
| 186 |
SQLITE_API int sqlite3_compileoption_used(const char *zOptName); |
| 187 |
SQLITE_API const char *sqlite3_compileoption_get(int N); |
| 188 |
#endif |
| 189 |
|
| 190 |
/* |
| 191 |
** CAPI3REF: Test To See If The Library Is Threadsafe |
| 192 |
** |
| 193 |
** ^The sqlite3_threadsafe() function returns zero if and only if |
| 194 |
** SQLite was compiled with mutexing code omitted due to the |
| 195 |
** [SQLITE_THREADSAFE] compile-time option being set to 0. |
| 196 |
** |
| 197 |
** SQLite can be compiled with or without mutexes. When |
| 198 |
** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes |
| 199 |
** are enabled and SQLite is threadsafe. When the |
| 200 |
** [SQLITE_THREADSAFE] macro is 0, |
| 201 |
** the mutexes are omitted. Without the mutexes, it is not safe |
| 202 |
** to use SQLite concurrently from more than one thread. |
| 203 |
** |
| 204 |
** Enabling mutexes incurs a measurable performance penalty. |
| 205 |
** So if speed is of utmost importance, it makes sense to disable |
| 206 |
** the mutexes. But for maximum safety, mutexes should be enabled. |
| 207 |
** ^The default behavior is for mutexes to be enabled. |
| 208 |
** |
| 209 |
** This interface can be used by an application to make sure that the |
| 210 |
** version of SQLite that it is linking against was compiled with |
| 211 |
** the desired setting of the [SQLITE_THREADSAFE] macro. |
| 212 |
** |
| 213 |
** This interface only reports on the compile-time mutex setting |
| 214 |
** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with |
| 215 |
** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but |
| 216 |
** can be fully or partially disabled using a call to [sqlite3_config()] |
| 217 |
** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], |
| 218 |
** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the |
| 219 |
** sqlite3_threadsafe() function shows only the compile-time setting of |
| 220 |
** thread safety, not any run-time changes to that setting made by |
| 221 |
** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() |
| 222 |
** is unchanged by calls to sqlite3_config().)^ |
| 223 |
** |
| 224 |
** See the [threading mode] documentation for additional information. |
| 225 |
*/ |
| 226 |
SQLITE_API int sqlite3_threadsafe(void); |
| 227 |
|
| 228 |
/* |
| 229 |
** CAPI3REF: Database Connection Handle |
| 230 |
** KEYWORDS: {database connection} {database connections} |
| 231 |
** |
| 232 |
** Each open SQLite database is represented by a pointer to an instance of |
| 233 |
** the opaque structure named "sqlite3". It is useful to think of an sqlite3 |
| 234 |
** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and |
| 235 |
** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] |
| 236 |
** and [sqlite3_close_v2()] are its destructors. There are many other |
| 237 |
** interfaces (such as |
| 238 |
** [sqlite3_prepare_v2()], [sqlite3_create_function()], and |
| 239 |
** [sqlite3_busy_timeout()] to name but three) that are methods on an |
| 240 |
** sqlite3 object. |
| 241 |
*/ |
| 242 |
typedef struct sqlite3 sqlite3; |
| 243 |
|
| 244 |
/* |
| 245 |
** CAPI3REF: 64-Bit Integer Types |
| 246 |
** KEYWORDS: sqlite_int64 sqlite_uint64 |
| 247 |
** |
| 248 |
** Because there is no cross-platform way to specify 64-bit integer types |
| 249 |
** SQLite includes typedefs for 64-bit signed and unsigned integers. |
| 250 |
** |
| 251 |
** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. |
| 252 |
** The sqlite_int64 and sqlite_uint64 types are supported for backwards |
| 253 |
** compatibility only. |
| 254 |
** |
| 255 |
** ^The sqlite3_int64 and sqlite_int64 types can store integer values |
| 256 |
** between -9223372036854775808 and +9223372036854775807 inclusive. ^The |
| 257 |
** sqlite3_uint64 and sqlite_uint64 types can store integer values |
| 258 |
** between 0 and +18446744073709551615 inclusive. |
| 259 |
*/ |
| 260 |
#ifdef SQLITE_INT64_TYPE |
| 261 |
typedef SQLITE_INT64_TYPE sqlite_int64; |
| 262 |
typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; |
| 263 |
#elif defined(_MSC_VER) || defined(__BORLANDC__) |
| 264 |
typedef __int64 sqlite_int64; |
| 265 |
typedef unsigned __int64 sqlite_uint64; |
| 266 |
#else |
| 267 |
typedef long long int sqlite_int64; |
| 268 |
typedef unsigned long long int sqlite_uint64; |
| 269 |
#endif |
| 270 |
typedef sqlite_int64 sqlite3_int64; |
| 271 |
typedef sqlite_uint64 sqlite3_uint64; |
| 272 |
|
| 273 |
/* |
| 274 |
** If compiling for a processor that lacks floating point support, |
| 275 |
** substitute integer for floating-point. |
| 276 |
*/ |
| 277 |
#ifdef SQLITE_OMIT_FLOATING_POINT |
| 278 |
# define double sqlite3_int64 |
| 279 |
#endif |
| 280 |
|
| 281 |
/* |
| 282 |
** CAPI3REF: Closing A Database Connection |
| 283 |
** DESTRUCTOR: sqlite3 |
| 284 |
** |
| 285 |
** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors |
| 286 |
** for the [sqlite3] object. |
| 287 |
** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if |
| 288 |
** the [sqlite3] object is successfully destroyed and all associated |
| 289 |
** resources are deallocated. |
| 290 |
** |
| 291 |
** ^If the database connection is associated with unfinalized prepared |
| 292 |
** statements or unfinished sqlite3_backup objects then sqlite3_close() |
| 293 |
** will leave the database connection open and return [SQLITE_BUSY]. |
| 294 |
** ^If sqlite3_close_v2() is called with unfinalized prepared statements |
| 295 |
** and/or unfinished sqlite3_backups, then the database connection becomes |
| 296 |
** an unusable "zombie" which will automatically be deallocated when the |
| 297 |
** last prepared statement is finalized or the last sqlite3_backup is |
| 298 |
** finished. The sqlite3_close_v2() interface is intended for use with |
| 299 |
** host languages that are garbage collected, and where the order in which |
| 300 |
** destructors are called is arbitrary. |
| 301 |
** |
| 302 |
** Applications should [sqlite3_finalize | finalize] all [prepared statements], |
| 303 |
** [sqlite3_blob_close | close] all [BLOB handles], and |
| 304 |
** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated |
| 305 |
** with the [sqlite3] object prior to attempting to close the object. ^If |
| 306 |
** sqlite3_close_v2() is called on a [database connection] that still has |
| 307 |
** outstanding [prepared statements], [BLOB handles], and/or |
| 308 |
** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation |
| 309 |
** of resources is deferred until all [prepared statements], [BLOB handles], |
| 310 |
** and [sqlite3_backup] objects are also destroyed. |
| 311 |
** |
| 312 |
** ^If an [sqlite3] object is destroyed while a transaction is open, |
| 313 |
** the transaction is automatically rolled back. |
| 314 |
** |
| 315 |
** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)] |
| 316 |
** must be either a NULL |
| 317 |
** pointer or an [sqlite3] object pointer obtained |
| 318 |
** from [sqlite3_open()], [sqlite3_open16()], or |
| 319 |
** [sqlite3_open_v2()], and not previously closed. |
| 320 |
** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer |
| 321 |
** argument is a harmless no-op. |
| 322 |
*/ |
| 323 |
SQLITE_API int sqlite3_close(sqlite3*); |
| 324 |
SQLITE_API int sqlite3_close_v2(sqlite3*); |
| 325 |
|
| 326 |
/* |
| 327 |
** The type for a callback function. |
| 328 |
** This is legacy and deprecated. It is included for historical |
| 329 |
** compatibility and is not documented. |
| 330 |
*/ |
| 331 |
typedef int (*sqlite3_callback)(void*,int,char**, char**); |
| 332 |
|
| 333 |
/* |
| 334 |
** CAPI3REF: One-Step Query Execution Interface |
| 335 |
** METHOD: sqlite3 |
| 336 |
** |
| 337 |
** The sqlite3_exec() interface is a convenience wrapper around |
| 338 |
** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], |
| 339 |
** that allows an application to run multiple statements of SQL |
| 340 |
** without having to use a lot of C code. |
| 341 |
** |
| 342 |
** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, |
| 343 |
** semicolon-separate SQL statements passed into its 2nd argument, |
| 344 |
** in the context of the [database connection] passed in as its 1st |
| 345 |
** argument. ^If the callback function of the 3rd argument to |
| 346 |
** sqlite3_exec() is not NULL, then it is invoked for each result row |
| 347 |
** coming out of the evaluated SQL statements. ^The 4th argument to |
| 348 |
** sqlite3_exec() is relayed through to the 1st argument of each |
| 349 |
** callback invocation. ^If the callback pointer to sqlite3_exec() |
| 350 |
** is NULL, then no callback is ever invoked and result rows are |
| 351 |
** ignored. |
| 352 |
** |
| 353 |
** ^If an error occurs while evaluating the SQL statements passed into |
| 354 |
** sqlite3_exec(), then execution of the current statement stops and |
| 355 |
** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() |
| 356 |
** is not NULL then any error message is written into memory obtained |
| 357 |
** from [sqlite3_malloc()] and passed back through the 5th parameter. |
| 358 |
** To avoid memory leaks, the application should invoke [sqlite3_free()] |
| 359 |
** on error message strings returned through the 5th parameter of |
| 360 |
** sqlite3_exec() after the error message string is no longer needed. |
| 361 |
** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors |
| 362 |
** occur, then sqlite3_exec() sets the pointer in its 5th parameter to |
| 363 |
** NULL before returning. |
| 364 |
** |
| 365 |
** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() |
| 366 |
** routine returns SQLITE_ABORT without invoking the callback again and |
| 367 |
** without running any subsequent SQL statements. |
| 368 |
** |
| 369 |
** ^The 2nd argument to the sqlite3_exec() callback function is the |
| 370 |
** number of columns in the result. ^The 3rd argument to the sqlite3_exec() |
| 371 |
** callback is an array of pointers to strings obtained as if from |
| 372 |
** [sqlite3_column_text()], one for each column. ^If an element of a |
| 373 |
** result row is NULL then the corresponding string pointer for the |
| 374 |
** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the |
| 375 |
** sqlite3_exec() callback is an array of pointers to strings where each |
| 376 |
** entry represents the name of corresponding result column as obtained |
| 377 |
** from [sqlite3_column_name()]. |
| 378 |
** |
| 379 |
** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer |
| 380 |
** to an empty string, or a pointer that contains only whitespace and/or |
| 381 |
** SQL comments, then no SQL statements are evaluated and the database |
| 382 |
** is not changed. |
| 383 |
** |
| 384 |
** Restrictions: |
| 385 |
** |
| 386 |
** <ul> |
| 387 |
** <li> The application must ensure that the 1st parameter to sqlite3_exec() |
| 388 |
** is a valid and open [database connection]. |
| 389 |
** <li> The application must not close the [database connection] specified by |
| 390 |
** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. |
| 391 |
** <li> The application must not modify the SQL statement text passed into |
| 392 |
** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. |
| 393 |
** </ul> |
| 394 |
*/ |
| 395 |
SQLITE_API int sqlite3_exec( |
| 396 |
sqlite3*, /* An open database */ |
| 397 |
const char *sql, /* SQL to be evaluated */ |
| 398 |
int (*callback)(void*,int,char**,char**), /* Callback function */ |
| 399 |
void *, /* 1st argument to callback */ |
| 400 |
char **errmsg /* Error msg written here */ |
| 401 |
); |
| 402 |
|
| 403 |
/* |
| 404 |
** CAPI3REF: Result Codes |
| 405 |
** KEYWORDS: {result code definitions} |
| 406 |
** |
| 407 |
** Many SQLite functions return an integer result code from the set shown |
| 408 |
** here in order to indicate success or failure. |
| 409 |
** |
| 410 |
** New error codes may be added in future versions of SQLite. |
| 411 |
** |
| 412 |
** See also: [extended result code definitions] |
| 413 |
*/ |
| 414 |
#define SQLITE_OK 0 /* Successful result */ |
| 415 |
/* beginning-of-error-codes */ |
| 416 |
#define SQLITE_ERROR 1 /* SQL error or missing database */ |
| 417 |
#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ |
| 418 |
#define SQLITE_PERM 3 /* Access permission denied */ |
| 419 |
#define SQLITE_ABORT 4 /* Callback routine requested an abort */ |
| 420 |
#define SQLITE_BUSY 5 /* The database file is locked */ |
| 421 |
#define SQLITE_LOCKED 6 /* A table in the database is locked */ |
| 422 |
#define SQLITE_NOMEM 7 /* A malloc() failed */ |
| 423 |
#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ |
| 424 |
#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ |
| 425 |
#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ |
| 426 |
#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ |
| 427 |
#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ |
| 428 |
#define SQLITE_FULL 13 /* Insertion failed because database is full */ |
| 429 |
#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ |
| 430 |
#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ |
| 431 |
#define SQLITE_EMPTY 16 /* Database is empty */ |
| 432 |
#define SQLITE_SCHEMA 17 /* The database schema changed */ |
| 433 |
#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ |
| 434 |
#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ |
| 435 |
#define SQLITE_MISMATCH 20 /* Data type mismatch */ |
| 436 |
#define SQLITE_MISUSE 21 /* Library used incorrectly */ |
| 437 |
#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ |
| 438 |
#define SQLITE_AUTH 23 /* Authorization denied */ |
| 439 |
#define SQLITE_FORMAT 24 /* Auxiliary database format error */ |
| 440 |
#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ |
| 441 |
#define SQLITE_NOTADB 26 /* File opened that is not a database file */ |
| 442 |
#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */ |
| 443 |
#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */ |
| 444 |
#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ |
| 445 |
#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ |
| 446 |
/* end-of-error-codes */ |
| 447 |
|
| 448 |
/* |
| 449 |
** CAPI3REF: Extended Result Codes |
| 450 |
** KEYWORDS: {extended result code definitions} |
| 451 |
** |
| 452 |
** In its default configuration, SQLite API routines return one of 30 integer |
| 453 |
** [result codes]. However, experience has shown that many of |
| 454 |
** these result codes are too coarse-grained. They do not provide as |
| 455 |
** much information about problems as programmers might like. In an effort to |
| 456 |
** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8] |
| 457 |
** and later) include |
| 458 |
** support for additional result codes that provide more detailed information |
| 459 |
** about errors. These [extended result codes] are enabled or disabled |
| 460 |
** on a per database connection basis using the |
| 461 |
** [sqlite3_extended_result_codes()] API. Or, the extended code for |
| 462 |
** the most recent error can be obtained using |
| 463 |
** [sqlite3_extended_errcode()]. |
| 464 |
*/ |
| 465 |
#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) |
| 466 |
#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) |
| 467 |
#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) |
| 468 |
#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) |
| 469 |
#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) |
| 470 |
#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) |
| 471 |
#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) |
| 472 |
#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) |
| 473 |
#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) |
| 474 |
#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) |
| 475 |
#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) |
| 476 |
#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) |
| 477 |
#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) |
| 478 |
#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) |
| 479 |
#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) |
| 480 |
#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) |
| 481 |
#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) |
| 482 |
#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) |
| 483 |
#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) |
| 484 |
#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) |
| 485 |
#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) |
| 486 |
#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) |
| 487 |
#define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8)) |
| 488 |
#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8)) |
| 489 |
#define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8)) |
| 490 |
#define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8)) |
| 491 |
#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8)) |
| 492 |
#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8)) |
| 493 |
#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) |
| 494 |
#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) |
| 495 |
#define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8)) |
| 496 |
#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) |
| 497 |
#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) |
| 498 |
#define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8)) |
| 499 |
#define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8)) |
| 500 |
#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) |
| 501 |
#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) |
| 502 |
#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) |
| 503 |
#define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8)) |
| 504 |
#define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8)) |
| 505 |
#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) |
| 506 |
#define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8)) |
| 507 |
#define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8)) |
| 508 |
#define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8)) |
| 509 |
#define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8)) |
| 510 |
#define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8)) |
| 511 |
#define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8)) |
| 512 |
#define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8)) |
| 513 |
#define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8)) |
| 514 |
#define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8)) |
| 515 |
#define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8)) |
| 516 |
#define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8)) |
| 517 |
#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8)) |
| 518 |
#define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8)) |
| 519 |
#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8)) |
| 520 |
#define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8)) |
| 521 |
|
| 522 |
/* |
| 523 |
** CAPI3REF: Flags For File Open Operations |
| 524 |
** |
| 525 |
** These bit values are intended for use in the |
| 526 |
** 3rd parameter to the [sqlite3_open_v2()] interface and |
| 527 |
** in the 4th parameter to the [sqlite3_vfs.xOpen] method. |
| 528 |
*/ |
| 529 |
#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ |
| 530 |
#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ |
| 531 |
#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ |
| 532 |
#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ |
| 533 |
#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ |
| 534 |
#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ |
| 535 |
#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ |
| 536 |
#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */ |
| 537 |
#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ |
| 538 |
#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ |
| 539 |
#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ |
| 540 |
#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ |
| 541 |
#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ |
| 542 |
#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ |
| 543 |
#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ |
| 544 |
#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ |
| 545 |
#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ |
| 546 |
#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ |
| 547 |
#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ |
| 548 |
#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ |
| 549 |
|
| 550 |
/* Reserved: 0x00F00000 */ |
| 551 |
|
| 552 |
/* |
| 553 |
** CAPI3REF: Device Characteristics |
| 554 |
** |
| 555 |
** The xDeviceCharacteristics method of the [sqlite3_io_methods] |
| 556 |
** object returns an integer which is a vector of these |
| 557 |
** bit values expressing I/O characteristics of the mass storage |
| 558 |
** device that holds the file that the [sqlite3_io_methods] |
| 559 |
** refers to. |
| 560 |
** |
| 561 |
** The SQLITE_IOCAP_ATOMIC property means that all writes of |
| 562 |
** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values |
| 563 |
** mean that writes of blocks that are nnn bytes in size and |
| 564 |
** are aligned to an address which is an integer multiple of |
| 565 |
** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means |
| 566 |
** that when data is appended to a file, the data is appended |
| 567 |
** first then the size of the file is extended, never the other |
| 568 |
** way around. The SQLITE_IOCAP_SEQUENTIAL property means that |
| 569 |
** information is written to disk in the same order as calls |
| 570 |
** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that |
| 571 |
** after reboot following a crash or power loss, the only bytes in a |
| 572 |
** file that were written at the application level might have changed |
| 573 |
** and that adjacent bytes, even bytes within the same sector are |
| 574 |
** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN |
| 575 |
** flag indicate that a file cannot be deleted when open. The |
| 576 |
** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on |
| 577 |
** read-only media and cannot be changed even by processes with |
| 578 |
** elevated privileges. |
| 579 |
*/ |
| 580 |
#define SQLITE_IOCAP_ATOMIC 0x00000001 |
| 581 |
#define SQLITE_IOCAP_ATOMIC512 0x00000002 |
| 582 |
#define SQLITE_IOCAP_ATOMIC1K 0x00000004 |
| 583 |
#define SQLITE_IOCAP_ATOMIC2K 0x00000008 |
| 584 |
#define SQLITE_IOCAP_ATOMIC4K 0x00000010 |
| 585 |
#define SQLITE_IOCAP_ATOMIC8K 0x00000020 |
| 586 |
#define SQLITE_IOCAP_ATOMIC16K 0x00000040 |
| 587 |
#define SQLITE_IOCAP_ATOMIC32K 0x00000080 |
| 588 |
#define SQLITE_IOCAP_ATOMIC64K 0x00000100 |
| 589 |
#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 |
| 590 |
#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 |
| 591 |
#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 |
| 592 |
#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 |
| 593 |
#define SQLITE_IOCAP_IMMUTABLE 0x00002000 |
| 594 |
|
| 595 |
/* |
| 596 |
** CAPI3REF: File Locking Levels |
| 597 |
** |
| 598 |
** SQLite uses one of these integer values as the second |
| 599 |
** argument to calls it makes to the xLock() and xUnlock() methods |
| 600 |
** of an [sqlite3_io_methods] object. |
| 601 |
*/ |
| 602 |
#define SQLITE_LOCK_NONE 0 |
| 603 |
#define SQLITE_LOCK_SHARED 1 |
| 604 |
#define SQLITE_LOCK_RESERVED 2 |
| 605 |
#define SQLITE_LOCK_PENDING 3 |
| 606 |
#define SQLITE_LOCK_EXCLUSIVE 4 |
| 607 |
|
| 608 |
/* |
| 609 |
** CAPI3REF: Synchronization Type Flags |
| 610 |
** |
| 611 |
** When SQLite invokes the xSync() method of an |
| 612 |
** [sqlite3_io_methods] object it uses a combination of |
| 613 |
** these integer values as the second argument. |
| 614 |
** |
| 615 |
** When the SQLITE_SYNC_DATAONLY flag is used, it means that the |
| 616 |
** sync operation only needs to flush data to mass storage. Inode |
| 617 |
** information need not be flushed. If the lower four bits of the flag |
| 618 |
** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. |
| 619 |
** If the lower four bits equal SQLITE_SYNC_FULL, that means |
| 620 |
** to use Mac OS X style fullsync instead of fsync(). |
| 621 |
** |
| 622 |
** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags |
| 623 |
** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL |
| 624 |
** settings. The [synchronous pragma] determines when calls to the |
| 625 |
** xSync VFS method occur and applies uniformly across all platforms. |
| 626 |
** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how |
| 627 |
** energetic or rigorous or forceful the sync operations are and |
| 628 |
** only make a difference on Mac OSX for the default SQLite code. |
| 629 |
** (Third-party VFS implementations might also make the distinction |
| 630 |
** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the |
| 631 |
** operating systems natively supported by SQLite, only Mac OSX |
| 632 |
** cares about the difference.) |
| 633 |
*/ |
| 634 |
#define SQLITE_SYNC_NORMAL 0x00002 |
| 635 |
#define SQLITE_SYNC_FULL 0x00003 |
| 636 |
#define SQLITE_SYNC_DATAONLY 0x00010 |
| 637 |
|
| 638 |
/* |
| 639 |
** CAPI3REF: OS Interface Open File Handle |
| 640 |
** |
| 641 |
** An [sqlite3_file] object represents an open file in the |
| 642 |
** [sqlite3_vfs | OS interface layer]. Individual OS interface |
| 643 |
** implementations will |
| 644 |
** want to subclass this object by appending additional fields |
| 645 |
** for their own use. The pMethods entry is a pointer to an |
| 646 |
** [sqlite3_io_methods] object that defines methods for performing |
| 647 |
** I/O operations on the open file. |
| 648 |
*/ |
| 649 |
typedef struct sqlite3_file sqlite3_file; |
| 650 |
struct sqlite3_file { |
| 651 |
const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ |
| 652 |
}; |
| 653 |
|
| 654 |
/* |
| 655 |
** CAPI3REF: OS Interface File Virtual Methods Object |
| 656 |
** |
| 657 |
** Every file opened by the [sqlite3_vfs.xOpen] method populates an |
| 658 |
** [sqlite3_file] object (or, more commonly, a subclass of the |
| 659 |
** [sqlite3_file] object) with a pointer to an instance of this object. |
| 660 |
** This object defines the methods used to perform various operations |
| 661 |
** against the open file represented by the [sqlite3_file] object. |
| 662 |
** |
| 663 |
** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element |
| 664 |
** to a non-NULL pointer, then the sqlite3_io_methods.xClose method |
| 665 |
** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The |
| 666 |
** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] |
| 667 |
** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element |
| 668 |
** to NULL. |
| 669 |
** |
| 670 |
** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or |
| 671 |
** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). |
| 672 |
** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] |
| 673 |
** flag may be ORed in to indicate that only the data of the file |
| 674 |
** and not its inode needs to be synced. |
| 675 |
** |
| 676 |
** The integer values to xLock() and xUnlock() are one of |
| 677 |
** <ul> |
| 678 |
** <li> [SQLITE_LOCK_NONE], |
| 679 |
** <li> [SQLITE_LOCK_SHARED], |
| 680 |
** <li> [SQLITE_LOCK_RESERVED], |
| 681 |
** <li> [SQLITE_LOCK_PENDING], or |
| 682 |
** <li> [SQLITE_LOCK_EXCLUSIVE]. |
| 683 |
** </ul> |
| 684 |
** xLock() increases the lock. xUnlock() decreases the lock. |
| 685 |
** The xCheckReservedLock() method checks whether any database connection, |
| 686 |
** either in this process or in some other process, is holding a RESERVED, |
| 687 |
** PENDING, or EXCLUSIVE lock on the file. It returns true |
| 688 |
** if such a lock exists and false otherwise. |
| 689 |
** |
| 690 |
** The xFileControl() method is a generic interface that allows custom |
| 691 |
** VFS implementations to directly control an open file using the |
| 692 |
** [sqlite3_file_control()] interface. The second "op" argument is an |
| 693 |
** integer opcode. The third argument is a generic pointer intended to |
| 694 |
** point to a structure that may contain arguments or space in which to |
| 695 |
** write return values. Potential uses for xFileControl() might be |
| 696 |
** functions to enable blocking locks with timeouts, to change the |
| 697 |
** locking strategy (for example to use dot-file locks), to inquire |
| 698 |
** about the status of a lock, or to break stale locks. The SQLite |
| 699 |
** core reserves all opcodes less than 100 for its own use. |
| 700 |
** A [file control opcodes | list of opcodes] less than 100 is available. |
| 701 |
** Applications that define a custom xFileControl method should use opcodes |
| 702 |
** greater than 100 to avoid conflicts. VFS implementations should |
| 703 |
** return [SQLITE_NOTFOUND] for file control opcodes that they do not |
| 704 |
** recognize. |
| 705 |
** |
| 706 |
** The xSectorSize() method returns the sector size of the |
| 707 |
** device that underlies the file. The sector size is the |
| 708 |
** minimum write that can be performed without disturbing |
| 709 |
** other bytes in the file. The xDeviceCharacteristics() |
| 710 |
** method returns a bit vector describing behaviors of the |
| 711 |
** underlying device: |
| 712 |
** |
| 713 |
** <ul> |
| 714 |
** <li> [SQLITE_IOCAP_ATOMIC] |
| 715 |
** <li> [SQLITE_IOCAP_ATOMIC512] |
| 716 |
** <li> [SQLITE_IOCAP_ATOMIC1K] |
| 717 |
** <li> [SQLITE_IOCAP_ATOMIC2K] |
| 718 |
** <li> [SQLITE_IOCAP_ATOMIC4K] |
| 719 |
** <li> [SQLITE_IOCAP_ATOMIC8K] |
| 720 |
** <li> [SQLITE_IOCAP_ATOMIC16K] |
| 721 |
** <li> [SQLITE_IOCAP_ATOMIC32K] |
| 722 |
** <li> [SQLITE_IOCAP_ATOMIC64K] |
| 723 |
** <li> [SQLITE_IOCAP_SAFE_APPEND] |
| 724 |
** <li> [SQLITE_IOCAP_SEQUENTIAL] |
| 725 |
** </ul> |
| 726 |
** |
| 727 |
** The SQLITE_IOCAP_ATOMIC property means that all writes of |
| 728 |
** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values |
| 729 |
** mean that writes of blocks that are nnn bytes in size and |
| 730 |
** are aligned to an address which is an integer multiple of |
| 731 |
** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means |
| 732 |
** that when data is appended to a file, the data is appended |
| 733 |
** first then the size of the file is extended, never the other |
| 734 |
** way around. The SQLITE_IOCAP_SEQUENTIAL property means that |
| 735 |
** information is written to disk in the same order as calls |
| 736 |
** to xWrite(). |
| 737 |
** |
| 738 |
** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill |
| 739 |
** in the unread portions of the buffer with zeros. A VFS that |
| 740 |
** fails to zero-fill short reads might seem to work. However, |
| 741 |
** failure to zero-fill short reads will eventually lead to |
| 742 |
** database corruption. |
| 743 |
*/ |
| 744 |
typedef struct sqlite3_io_methods sqlite3_io_methods; |
| 745 |
struct sqlite3_io_methods { |
| 746 |
int iVersion; |
| 747 |
int (*xClose)(sqlite3_file*); |
| 748 |
int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); |
| 749 |
int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); |
| 750 |
int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); |
| 751 |
int (*xSync)(sqlite3_file*, int flags); |
| 752 |
int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); |
| 753 |
int (*xLock)(sqlite3_file*, int); |
| 754 |
int (*xUnlock)(sqlite3_file*, int); |
| 755 |
int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); |
| 756 |
int (*xFileControl)(sqlite3_file*, int op, void *pArg); |
| 757 |
int (*xSectorSize)(sqlite3_file*); |
| 758 |
int (*xDeviceCharacteristics)(sqlite3_file*); |
| 759 |
/* Methods above are valid for version 1 */ |
| 760 |
int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); |
| 761 |
int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); |
| 762 |
void (*xShmBarrier)(sqlite3_file*); |
| 763 |
int (*xShmUnmap)(sqlite3_file*, int deleteFlag); |
| 764 |
/* Methods above are valid for version 2 */ |
| 765 |
int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp); |
| 766 |
int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p); |
| 767 |
/* Methods above are valid for version 3 */ |
| 768 |
/* Additional methods may be added in future releases */ |
| 769 |
}; |
| 770 |
|
| 771 |
/* |
| 772 |
** CAPI3REF: Standard File Control Opcodes |
| 773 |
** KEYWORDS: {file control opcodes} {file control opcode} |
| 774 |
** |
| 775 |
** These integer constants are opcodes for the xFileControl method |
| 776 |
** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] |
| 777 |
** interface. |
| 778 |
** |
| 779 |
** <ul> |
| 780 |
** <li>[[SQLITE_FCNTL_LOCKSTATE]] |
| 781 |
** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This |
| 782 |
** opcode causes the xFileControl method to write the current state of |
| 783 |
** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], |
| 784 |
** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) |
| 785 |
** into an integer that the pArg argument points to. This capability |
| 786 |
** is used during testing and is only available when the SQLITE_TEST |
| 787 |
** compile-time option is used. |
| 788 |
** |
| 789 |
** <li>[[SQLITE_FCNTL_SIZE_HINT]] |
| 790 |
** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS |
| 791 |
** layer a hint of how large the database file will grow to be during the |
| 792 |
** current transaction. This hint is not guaranteed to be accurate but it |
| 793 |
** is often close. The underlying VFS might choose to preallocate database |
| 794 |
** file space based on this hint in order to help writes to the database |
| 795 |
** file run faster. |
| 796 |
** |
| 797 |
** <li>[[SQLITE_FCNTL_CHUNK_SIZE]] |
| 798 |
** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS |
| 799 |
** extends and truncates the database file in chunks of a size specified |
| 800 |
** by the user. The fourth argument to [sqlite3_file_control()] should |
| 801 |
** point to an integer (type int) containing the new chunk-size to use |
| 802 |
** for the nominated database. Allocating database file space in large |
| 803 |
** chunks (say 1MB at a time), may reduce file-system fragmentation and |
| 804 |
** improve performance on some systems. |
| 805 |
** |
| 806 |
** <li>[[SQLITE_FCNTL_FILE_POINTER]] |
| 807 |
** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer |
| 808 |
** to the [sqlite3_file] object associated with a particular database |
| 809 |
** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER]. |
| 810 |
** |
| 811 |
** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]] |
| 812 |
** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer |
| 813 |
** to the [sqlite3_file] object associated with the journal file (either |
| 814 |
** the [rollback journal] or the [write-ahead log]) for a particular database |
| 815 |
** connection. See also [SQLITE_FCNTL_FILE_POINTER]. |
| 816 |
** |
| 817 |
** <li>[[SQLITE_FCNTL_SYNC_OMITTED]] |
| 818 |
** No longer in use. |
| 819 |
** |
| 820 |
** <li>[[SQLITE_FCNTL_SYNC]] |
| 821 |
** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and |
| 822 |
** sent to the VFS immediately before the xSync method is invoked on a |
| 823 |
** database file descriptor. Or, if the xSync method is not invoked |
| 824 |
** because the user has configured SQLite with |
| 825 |
** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place |
| 826 |
** of the xSync method. In most cases, the pointer argument passed with |
| 827 |
** this file-control is NULL. However, if the database file is being synced |
| 828 |
** as part of a multi-database commit, the argument points to a nul-terminated |
| 829 |
** string containing the transactions master-journal file name. VFSes that |
| 830 |
** do not need this signal should silently ignore this opcode. Applications |
| 831 |
** should not call [sqlite3_file_control()] with this opcode as doing so may |
| 832 |
** disrupt the operation of the specialized VFSes that do require it. |
| 833 |
** |
| 834 |
** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]] |
| 835 |
** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite |
| 836 |
** and sent to the VFS after a transaction has been committed immediately |
| 837 |
** but before the database is unlocked. VFSes that do not need this signal |
| 838 |
** should silently ignore this opcode. Applications should not call |
| 839 |
** [sqlite3_file_control()] with this opcode as doing so may disrupt the |
| 840 |
** operation of the specialized VFSes that do require it. |
| 841 |
** |
| 842 |
** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]] |
| 843 |
** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic |
| 844 |
** retry counts and intervals for certain disk I/O operations for the |
| 845 |
** windows [VFS] in order to provide robustness in the presence of |
| 846 |
** anti-virus programs. By default, the windows VFS will retry file read, |
| 847 |
** file write, and file delete operations up to 10 times, with a delay |
| 848 |
** of 25 milliseconds before the first retry and with the delay increasing |
| 849 |
** by an additional 25 milliseconds with each subsequent retry. This |
| 850 |
** opcode allows these two values (10 retries and 25 milliseconds of delay) |
| 851 |
** to be adjusted. The values are changed for all database connections |
| 852 |
** within the same process. The argument is a pointer to an array of two |
| 853 |
** integers where the first integer i the new retry count and the second |
| 854 |
** integer is the delay. If either integer is negative, then the setting |
| 855 |
** is not changed but instead the prior value of that setting is written |
| 856 |
** into the array entry, allowing the current retry settings to be |
| 857 |
** interrogated. The zDbName parameter is ignored. |
| 858 |
** |
| 859 |
** <li>[[SQLITE_FCNTL_PERSIST_WAL]] |
| 860 |
** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the |
| 861 |
** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary |
| 862 |
** write ahead log and shared memory files used for transaction control |
| 863 |
** are automatically deleted when the latest connection to the database |
| 864 |
** closes. Setting persistent WAL mode causes those files to persist after |
| 865 |
** close. Persisting the files is useful when other processes that do not |
| 866 |
** have write permission on the directory containing the database file want |
| 867 |
** to read the database file, as the WAL and shared memory files must exist |
| 868 |
** in order for the database to be readable. The fourth parameter to |
| 869 |
** [sqlite3_file_control()] for this opcode should be a pointer to an integer. |
| 870 |
** That integer is 0 to disable persistent WAL mode or 1 to enable persistent |
| 871 |
** WAL mode. If the integer is -1, then it is overwritten with the current |
| 872 |
** WAL persistence setting. |
| 873 |
** |
| 874 |
** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] |
| 875 |
** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the |
| 876 |
** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting |
| 877 |
** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the |
| 878 |
** xDeviceCharacteristics methods. The fourth parameter to |
| 879 |
** [sqlite3_file_control()] for this opcode should be a pointer to an integer. |
| 880 |
** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage |
| 881 |
** mode. If the integer is -1, then it is overwritten with the current |
| 882 |
** zero-damage mode setting. |
| 883 |
** |
| 884 |
** <li>[[SQLITE_FCNTL_OVERWRITE]] |
| 885 |
** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening |
| 886 |
** a write transaction to indicate that, unless it is rolled back for some |
| 887 |
** reason, the entire database file will be overwritten by the current |
| 888 |
** transaction. This is used by VACUUM operations. |
| 889 |
** |
| 890 |
** <li>[[SQLITE_FCNTL_VFSNAME]] |
| 891 |
** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of |
| 892 |
** all [VFSes] in the VFS stack. The names are of all VFS shims and the |
| 893 |
** final bottom-level VFS are written into memory obtained from |
| 894 |
** [sqlite3_malloc()] and the result is stored in the char* variable |
| 895 |
** that the fourth parameter of [sqlite3_file_control()] points to. |
| 896 |
** The caller is responsible for freeing the memory when done. As with |
| 897 |
** all file-control actions, there is no guarantee that this will actually |
| 898 |
** do anything. Callers should initialize the char* variable to a NULL |
| 899 |
** pointer in case this file-control is not implemented. This file-control |
| 900 |
** is intended for diagnostic use only. |
| 901 |
** |
| 902 |
** <li>[[SQLITE_FCNTL_VFS_POINTER]] |
| 903 |
** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level |
| 904 |
** [VFSes] currently in use. ^(The argument X in |
| 905 |
** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be |
| 906 |
** of type "[sqlite3_vfs] **". This opcodes will set *X |
| 907 |
** to a pointer to the top-level VFS.)^ |
| 908 |
** ^When there are multiple VFS shims in the stack, this opcode finds the |
| 909 |
** upper-most shim only. |
| 910 |
** |
| 911 |
** <li>[[SQLITE_FCNTL_PRAGMA]] |
| 912 |
** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] |
| 913 |
** file control is sent to the open [sqlite3_file] object corresponding |
| 914 |
** to the database file to which the pragma statement refers. ^The argument |
| 915 |
** to the [SQLITE_FCNTL_PRAGMA] file control is an array of |
| 916 |
** pointers to strings (char**) in which the second element of the array |
| 917 |
** is the name of the pragma and the third element is the argument to the |
| 918 |
** pragma or NULL if the pragma has no argument. ^The handler for an |
| 919 |
** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element |
| 920 |
** of the char** argument point to a string obtained from [sqlite3_mprintf()] |
| 921 |
** or the equivalent and that string will become the result of the pragma or |
| 922 |
** the error message if the pragma fails. ^If the |
| 923 |
** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal |
| 924 |
** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] |
| 925 |
** file control returns [SQLITE_OK], then the parser assumes that the |
| 926 |
** VFS has handled the PRAGMA itself and the parser generates a no-op |
| 927 |
** prepared statement if result string is NULL, or that returns a copy |
| 928 |
** of the result string if the string is non-NULL. |
| 929 |
** ^If the [SQLITE_FCNTL_PRAGMA] file control returns |
| 930 |
** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means |
| 931 |
** that the VFS encountered an error while handling the [PRAGMA] and the |
| 932 |
** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] |
| 933 |
** file control occurs at the beginning of pragma statement analysis and so |
| 934 |
** it is able to override built-in [PRAGMA] statements. |
| 935 |
** |
| 936 |
** <li>[[SQLITE_FCNTL_BUSYHANDLER]] |
| 937 |
** ^The [SQLITE_FCNTL_BUSYHANDLER] |
| 938 |
** file-control may be invoked by SQLite on the database file handle |
| 939 |
** shortly after it is opened in order to provide a custom VFS with access |
| 940 |
** to the connections busy-handler callback. The argument is of type (void **) |
| 941 |
** - an array of two (void *) values. The first (void *) actually points |
| 942 |
** to a function of type (int (*)(void *)). In order to invoke the connections |
| 943 |
** busy-handler, this function should be invoked with the second (void *) in |
| 944 |
** the array as the only argument. If it returns non-zero, then the operation |
| 945 |
** should be retried. If it returns zero, the custom VFS should abandon the |
| 946 |
** current operation. |
| 947 |
** |
| 948 |
** <li>[[SQLITE_FCNTL_TEMPFILENAME]] |
| 949 |
** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control |
| 950 |
** to have SQLite generate a |
| 951 |
** temporary filename using the same algorithm that is followed to generate |
| 952 |
** temporary filenames for TEMP tables and other internal uses. The |
| 953 |
** argument should be a char** which will be filled with the filename |
| 954 |
** written into memory obtained from [sqlite3_malloc()]. The caller should |
| 955 |
** invoke [sqlite3_free()] on the result to avoid a memory leak. |
| 956 |
** |
| 957 |
** <li>[[SQLITE_FCNTL_MMAP_SIZE]] |
| 958 |
** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the |
| 959 |
** maximum number of bytes that will be used for memory-mapped I/O. |
| 960 |
** The argument is a pointer to a value of type sqlite3_int64 that |
| 961 |
** is an advisory maximum number of bytes in the file to memory map. The |
| 962 |
** pointer is overwritten with the old value. The limit is not changed if |
| 963 |
** the value originally pointed to is negative, and so the current limit |
| 964 |
** can be queried by passing in a pointer to a negative number. This |
| 965 |
** file-control is used internally to implement [PRAGMA mmap_size]. |
| 966 |
** |
| 967 |
** <li>[[SQLITE_FCNTL_TRACE]] |
| 968 |
** The [SQLITE_FCNTL_TRACE] file control provides advisory information |
| 969 |
** to the VFS about what the higher layers of the SQLite stack are doing. |
| 970 |
** This file control is used by some VFS activity tracing [shims]. |
| 971 |
** The argument is a zero-terminated string. Higher layers in the |
| 972 |
** SQLite stack may generate instances of this file control if |
| 973 |
** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled. |
| 974 |
** |
| 975 |
** <li>[[SQLITE_FCNTL_HAS_MOVED]] |
| 976 |
** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a |
| 977 |
** pointer to an integer and it writes a boolean into that integer depending |
| 978 |
** on whether or not the file has been renamed, moved, or deleted since it |
| 979 |
** was first opened. |
| 980 |
** |
| 981 |
** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]] |
| 982 |
** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the |
| 983 |
** underlying native file handle associated with a file handle. This file |
| 984 |
** control interprets its argument as a pointer to a native file handle and |
| 985 |
** writes the resulting value there. |
| 986 |
** |
| 987 |
** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]] |
| 988 |
** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This |
| 989 |
** opcode causes the xFileControl method to swap the file handle with the one |
| 990 |
** pointed to by the pArg argument. This capability is used during testing |
| 991 |
** and only needs to be supported when SQLITE_TEST is defined. |
| 992 |
** |
| 993 |
** <li>[[SQLITE_FCNTL_WAL_BLOCK]] |
| 994 |
** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might |
| 995 |
** be advantageous to block on the next WAL lock if the lock is not immediately |
| 996 |
** available. The WAL subsystem issues this signal during rare |
| 997 |
** circumstances in order to fix a problem with priority inversion. |
| 998 |
** Applications should <em>not</em> use this file-control. |
| 999 |
** |
| 1000 |
** <li>[[SQLITE_FCNTL_ZIPVFS]] |
| 1001 |
** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other |
| 1002 |
** VFS should return SQLITE_NOTFOUND for this opcode. |
| 1003 |
** |
| 1004 |
** <li>[[SQLITE_FCNTL_RBU]] |
| 1005 |
** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by |
| 1006 |
** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for |
| 1007 |
** this opcode. |
| 1008 |
** </ul> |
| 1009 |
*/ |
| 1010 |
#define SQLITE_FCNTL_LOCKSTATE 1 |
| 1011 |
#define SQLITE_FCNTL_GET_LOCKPROXYFILE 2 |
| 1012 |
#define SQLITE_FCNTL_SET_LOCKPROXYFILE 3 |
| 1013 |
#define SQLITE_FCNTL_LAST_ERRNO 4 |
| 1014 |
#define SQLITE_FCNTL_SIZE_HINT 5 |
| 1015 |
#define SQLITE_FCNTL_CHUNK_SIZE 6 |
| 1016 |
#define SQLITE_FCNTL_FILE_POINTER 7 |
| 1017 |
#define SQLITE_FCNTL_SYNC_OMITTED 8 |
| 1018 |
#define SQLITE_FCNTL_WIN32_AV_RETRY 9 |
| 1019 |
#define SQLITE_FCNTL_PERSIST_WAL 10 |
| 1020 |
#define SQLITE_FCNTL_OVERWRITE 11 |
| 1021 |
#define SQLITE_FCNTL_VFSNAME 12 |
| 1022 |
#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 |
| 1023 |
#define SQLITE_FCNTL_PRAGMA 14 |
| 1024 |
#define SQLITE_FCNTL_BUSYHANDLER 15 |
| 1025 |
#define SQLITE_FCNTL_TEMPFILENAME 16 |
| 1026 |
#define SQLITE_FCNTL_MMAP_SIZE 18 |
| 1027 |
#define SQLITE_FCNTL_TRACE 19 |
| 1028 |
#define SQLITE_FCNTL_HAS_MOVED 20 |
| 1029 |
#define SQLITE_FCNTL_SYNC 21 |
| 1030 |
#define SQLITE_FCNTL_COMMIT_PHASETWO 22 |
| 1031 |
#define SQLITE_FCNTL_WIN32_SET_HANDLE 23 |
| 1032 |
#define SQLITE_FCNTL_WAL_BLOCK 24 |
| 1033 |
#define SQLITE_FCNTL_ZIPVFS 25 |
| 1034 |
#define SQLITE_FCNTL_RBU 26 |
| 1035 |
#define SQLITE_FCNTL_VFS_POINTER 27 |
| 1036 |
#define SQLITE_FCNTL_JOURNAL_POINTER 28 |
| 1037 |
#define SQLITE_FCNTL_WIN32_GET_HANDLE 29 |
| 1038 |
|
| 1039 |
/* deprecated names */ |
| 1040 |
#define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE |
| 1041 |
#define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE |
| 1042 |
#define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO |
| 1043 |
|
| 1044 |
|
| 1045 |
/* |
| 1046 |
** CAPI3REF: Mutex Handle |
| 1047 |
** |
| 1048 |
** The mutex module within SQLite defines [sqlite3_mutex] to be an |
| 1049 |
** abstract type for a mutex object. The SQLite core never looks |
| 1050 |
** at the internal representation of an [sqlite3_mutex]. It only |
| 1051 |
** deals with pointers to the [sqlite3_mutex] object. |
| 1052 |
** |
| 1053 |
** Mutexes are created using [sqlite3_mutex_alloc()]. |
| 1054 |
*/ |
| 1055 |
typedef struct sqlite3_mutex sqlite3_mutex; |
| 1056 |
|
| 1057 |
/* |
| 1058 |
** CAPI3REF: Loadable Extension Thunk |
| 1059 |
** |
| 1060 |
** A pointer to the opaque sqlite3_api_routines structure is passed as |
| 1061 |
** the third parameter to entry points of [loadable extensions]. This |
| 1062 |
** structure must be typedefed in order to work around compiler warnings |
| 1063 |
** on some platforms. |
| 1064 |
*/ |
| 1065 |
typedef struct sqlite3_api_routines sqlite3_api_routines; |
| 1066 |
|
| 1067 |
/* |
| 1068 |
** CAPI3REF: OS Interface Object |
| 1069 |
** |
| 1070 |
** An instance of the sqlite3_vfs object defines the interface between |
| 1071 |
** the SQLite core and the underlying operating system. The "vfs" |
| 1072 |
** in the name of the object stands for "virtual file system". See |
| 1073 |
** the [VFS | VFS documentation] for further information. |
| 1074 |
** |
| 1075 |
** The value of the iVersion field is initially 1 but may be larger in |
| 1076 |
** future versions of SQLite. Additional fields may be appended to this |
| 1077 |
** object when the iVersion value is increased. Note that the structure |
| 1078 |
** of the sqlite3_vfs object changes in the transaction between |
| 1079 |
** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not |
| 1080 |
** modified. |
| 1081 |
** |
| 1082 |
** The szOsFile field is the size of the subclassed [sqlite3_file] |
| 1083 |
** structure used by this VFS. mxPathname is the maximum length of |
| 1084 |
** a pathname in this VFS. |
| 1085 |
** |
| 1086 |
** Registered sqlite3_vfs objects are kept on a linked list formed by |
| 1087 |
** the pNext pointer. The [sqlite3_vfs_register()] |
| 1088 |
** and [sqlite3_vfs_unregister()] interfaces manage this list |
| 1089 |
** in a thread-safe way. The [sqlite3_vfs_find()] interface |
| 1090 |
** searches the list. Neither the application code nor the VFS |
| 1091 |
** implementation should use the pNext pointer. |
| 1092 |
** |
| 1093 |
** The pNext field is the only field in the sqlite3_vfs |
| 1094 |
** structure that SQLite will ever modify. SQLite will only access |
| 1095 |
** or modify this field while holding a particular static mutex. |
| 1096 |
** The application should never modify anything within the sqlite3_vfs |
| 1097 |
** object once the object has been registered. |
| 1098 |
** |
| 1099 |
** The zName field holds the name of the VFS module. The name must |
| 1100 |
** be unique across all VFS modules. |
| 1101 |
** |
| 1102 |
** [[sqlite3_vfs.xOpen]] |
| 1103 |
** ^SQLite guarantees that the zFilename parameter to xOpen |
| 1104 |
** is either a NULL pointer or string obtained |
| 1105 |
** from xFullPathname() with an optional suffix added. |
| 1106 |
** ^If a suffix is added to the zFilename parameter, it will |
| 1107 |
** consist of a single "-" character followed by no more than |
| 1108 |
** 11 alphanumeric and/or "-" characters. |
| 1109 |
** ^SQLite further guarantees that |
| 1110 |
** the string will be valid and unchanged until xClose() is |
| 1111 |
** called. Because of the previous sentence, |
| 1112 |
** the [sqlite3_file] can safely store a pointer to the |
| 1113 |
** filename if it needs to remember the filename for some reason. |
| 1114 |
** If the zFilename parameter to xOpen is a NULL pointer then xOpen |
| 1115 |
** must invent its own temporary name for the file. ^Whenever the |
| 1116 |
** xFilename parameter is NULL it will also be the case that the |
| 1117 |
** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. |
| 1118 |
** |
| 1119 |
** The flags argument to xOpen() includes all bits set in |
| 1120 |
** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] |
| 1121 |
** or [sqlite3_open16()] is used, then flags includes at least |
| 1122 |
** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. |
| 1123 |
** If xOpen() opens a file read-only then it sets *pOutFlags to |
| 1124 |
** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. |
| 1125 |
** |
| 1126 |
** ^(SQLite will also add one of the following flags to the xOpen() |
| 1127 |
** call, depending on the object being opened: |
| 1128 |
** |
| 1129 |
** <ul> |
| 1130 |
** <li> [SQLITE_OPEN_MAIN_DB] |
| 1131 |
** <li> [SQLITE_OPEN_MAIN_JOURNAL] |
| 1132 |
** <li> [SQLITE_OPEN_TEMP_DB] |
| 1133 |
** <li> [SQLITE_OPEN_TEMP_JOURNAL] |
| 1134 |
** <li> [SQLITE_OPEN_TRANSIENT_DB] |
| 1135 |
** <li> [SQLITE_OPEN_SUBJOURNAL] |
| 1136 |
** <li> [SQLITE_OPEN_MASTER_JOURNAL] |
| 1137 |
** <li> [SQLITE_OPEN_WAL] |
| 1138 |
** </ul>)^ |
| 1139 |
** |
| 1140 |
** The file I/O implementation can use the object type flags to |
| 1141 |
** change the way it deals with files. For example, an application |
| 1142 |
** that does not care about crash recovery or rollback might make |
| 1143 |
** the open of a journal file a no-op. Writes to this journal would |
| 1144 |
** also be no-ops, and any attempt to read the journal would return |
| 1145 |
** SQLITE_IOERR. Or the implementation might recognize that a database |
| 1146 |
** file will be doing page-aligned sector reads and writes in a random |
| 1147 |
** order and set up its I/O subsystem accordingly. |
| 1148 |
** |
| 1149 |
** SQLite might also add one of the following flags to the xOpen method: |
| 1150 |
** |
| 1151 |
** <ul> |
| 1152 |
** <li> [SQLITE_OPEN_DELETEONCLOSE] |
| 1153 |
** <li> [SQLITE_OPEN_EXCLUSIVE] |
| 1154 |
** </ul> |
| 1155 |
** |
| 1156 |
** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be |
| 1157 |
** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] |
| 1158 |
** will be set for TEMP databases and their journals, transient |
| 1159 |
** databases, and subjournals. |
| 1160 |
** |
| 1161 |
** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction |
| 1162 |
** with the [SQLITE_OPEN_CREATE] flag, which are both directly |
| 1163 |
** analogous to the O_EXCL and O_CREAT flags of the POSIX open() |
| 1164 |
** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the |
| 1165 |
** SQLITE_OPEN_CREATE, is used to indicate that file should always |
| 1166 |
** be created, and that it is an error if it already exists. |
| 1167 |
** It is <i>not</i> used to indicate the file should be opened |
| 1168 |
** for exclusive access. |
| 1169 |
** |
| 1170 |
** ^At least szOsFile bytes of memory are allocated by SQLite |
| 1171 |
** to hold the [sqlite3_file] structure passed as the third |
| 1172 |
** argument to xOpen. The xOpen method does not have to |
| 1173 |
** allocate the structure; it should just fill it in. Note that |
| 1174 |
** the xOpen method must set the sqlite3_file.pMethods to either |
| 1175 |
** a valid [sqlite3_io_methods] object or to NULL. xOpen must do |
| 1176 |
** this even if the open fails. SQLite expects that the sqlite3_file.pMethods |
| 1177 |
** element will be valid after xOpen returns regardless of the success |
| 1178 |
** or failure of the xOpen call. |
| 1179 |
** |
| 1180 |
** [[sqlite3_vfs.xAccess]] |
| 1181 |
** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] |
| 1182 |
** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to |
| 1183 |
** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] |
| 1184 |
** to test whether a file is at least readable. The file can be a |
| 1185 |
** directory. |
| 1186 |
** |
| 1187 |
** ^SQLite will always allocate at least mxPathname+1 bytes for the |
| 1188 |
** output buffer xFullPathname. The exact size of the output buffer |
| 1189 |
** is also passed as a parameter to both methods. If the output buffer |
| 1190 |
** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is |
| 1191 |
** handled as a fatal error by SQLite, vfs implementations should endeavor |
| 1192 |
** to prevent this by setting mxPathname to a sufficiently large value. |
| 1193 |
** |
| 1194 |
** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() |
| 1195 |
** interfaces are not strictly a part of the filesystem, but they are |
| 1196 |
** included in the VFS structure for completeness. |
| 1197 |
** The xRandomness() function attempts to return nBytes bytes |
| 1198 |
** of good-quality randomness into zOut. The return value is |
| 1199 |
** the actual number of bytes of randomness obtained. |
| 1200 |
** The xSleep() method causes the calling thread to sleep for at |
| 1201 |
** least the number of microseconds given. ^The xCurrentTime() |
| 1202 |
** method returns a Julian Day Number for the current date and time as |
| 1203 |
** a floating point value. |
| 1204 |
** ^The xCurrentTimeInt64() method returns, as an integer, the Julian |
| 1205 |
** Day Number multiplied by 86400000 (the number of milliseconds in |
| 1206 |
** a 24-hour day). |
| 1207 |
** ^SQLite will use the xCurrentTimeInt64() method to get the current |
| 1208 |
** date and time if that method is available (if iVersion is 2 or |
| 1209 |
** greater and the function pointer is not NULL) and will fall back |
| 1210 |
** to xCurrentTime() if xCurrentTimeInt64() is unavailable. |
| 1211 |
** |
| 1212 |
** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces |
| 1213 |
** are not used by the SQLite core. These optional interfaces are provided |
| 1214 |
** by some VFSes to facilitate testing of the VFS code. By overriding |
| 1215 |
** system calls with functions under its control, a test program can |
| 1216 |
** simulate faults and error conditions that would otherwise be difficult |
| 1217 |
** or impossible to induce. The set of system calls that can be overridden |
| 1218 |
** varies from one VFS to another, and from one version of the same VFS to the |
| 1219 |
** next. Applications that use these interfaces must be prepared for any |
| 1220 |
** or all of these interfaces to be NULL or for their behavior to change |
| 1221 |
** from one release to the next. Applications must not attempt to access |
| 1222 |
** any of these methods if the iVersion of the VFS is less than 3. |
| 1223 |
*/ |
| 1224 |
typedef struct sqlite3_vfs sqlite3_vfs; |
| 1225 |
typedef void (*sqlite3_syscall_ptr)(void); |
| 1226 |
struct sqlite3_vfs { |
| 1227 |
int iVersion; /* Structure version number (currently 3) */ |
| 1228 |
int szOsFile; /* Size of subclassed sqlite3_file */ |
| 1229 |
int mxPathname; /* Maximum file pathname length */ |
| 1230 |
sqlite3_vfs *pNext; /* Next registered VFS */ |
| 1231 |
const char *zName; /* Name of this virtual file system */ |
| 1232 |
void *pAppData; /* Pointer to application-specific data */ |
| 1233 |
int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, |
| 1234 |
int flags, int *pOutFlags); |
| 1235 |
int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); |
| 1236 |
int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); |
| 1237 |
int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); |
| 1238 |
void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); |
| 1239 |
void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); |
| 1240 |
void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); |
| 1241 |
void (*xDlClose)(sqlite3_vfs*, void*); |
| 1242 |
int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); |
| 1243 |
int (*xSleep)(sqlite3_vfs*, int microseconds); |
| 1244 |
int (*xCurrentTime)(sqlite3_vfs*, double*); |
| 1245 |
int (*xGetLastError)(sqlite3_vfs*, int, char *); |
| 1246 |
/* |
| 1247 |
** The methods above are in version 1 of the sqlite_vfs object |
| 1248 |
** definition. Those that follow are added in version 2 or later |
| 1249 |
*/ |
| 1250 |
int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); |
| 1251 |
/* |
| 1252 |
** The methods above are in versions 1 and 2 of the sqlite_vfs object. |
| 1253 |
** Those below are for version 3 and greater. |
| 1254 |
*/ |
| 1255 |
int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); |
| 1256 |
sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); |
| 1257 |
const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); |
| 1258 |
/* |
| 1259 |
** The methods above are in versions 1 through 3 of the sqlite_vfs object. |
| 1260 |
** New fields may be appended in future versions. The iVersion |
| 1261 |
** value will increment whenever this happens. |
| 1262 |
*/ |
| 1263 |
}; |
| 1264 |
|
| 1265 |
/* |
| 1266 |
** CAPI3REF: Flags for the xAccess VFS method |
| 1267 |
** |
| 1268 |
** These integer constants can be used as the third parameter to |
| 1269 |
** the xAccess method of an [sqlite3_vfs] object. They determine |
| 1270 |
** what kind of permissions the xAccess method is looking for. |
| 1271 |
** With SQLITE_ACCESS_EXISTS, the xAccess method |
| 1272 |
** simply checks whether the file exists. |
| 1273 |
** With SQLITE_ACCESS_READWRITE, the xAccess method |
| 1274 |
** checks whether the named directory is both readable and writable |
| 1275 |
** (in other words, if files can be added, removed, and renamed within |
| 1276 |
** the directory). |
| 1277 |
** The SQLITE_ACCESS_READWRITE constant is currently used only by the |
| 1278 |
** [temp_store_directory pragma], though this could change in a future |
| 1279 |
** release of SQLite. |
| 1280 |
** With SQLITE_ACCESS_READ, the xAccess method |
| 1281 |
** checks whether the file is readable. The SQLITE_ACCESS_READ constant is |
| 1282 |
** currently unused, though it might be used in a future release of |
| 1283 |
** SQLite. |
| 1284 |
*/ |
| 1285 |
#define SQLITE_ACCESS_EXISTS 0 |
| 1286 |
#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ |
| 1287 |
#define SQLITE_ACCESS_READ 2 /* Unused */ |
| 1288 |
|
| 1289 |
/* |
| 1290 |
** CAPI3REF: Flags for the xShmLock VFS method |
| 1291 |
** |
| 1292 |
** These integer constants define the various locking operations |
| 1293 |
** allowed by the xShmLock method of [sqlite3_io_methods]. The |
| 1294 |
** following are the only legal combinations of flags to the |
| 1295 |
** xShmLock method: |
| 1296 |
** |
| 1297 |
** <ul> |
| 1298 |
** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED |
| 1299 |
** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE |
| 1300 |
** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED |
| 1301 |
** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE |
| 1302 |
** </ul> |
| 1303 |
** |
| 1304 |
** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as |
| 1305 |
** was given on the corresponding lock. |
| 1306 |
** |
| 1307 |
** The xShmLock method can transition between unlocked and SHARED or |
| 1308 |
** between unlocked and EXCLUSIVE. It cannot transition between SHARED |
| 1309 |
** and EXCLUSIVE. |
| 1310 |
*/ |
| 1311 |
#define SQLITE_SHM_UNLOCK 1 |
| 1312 |
#define SQLITE_SHM_LOCK 2 |
| 1313 |
#define SQLITE_SHM_SHARED 4 |
| 1314 |
#define SQLITE_SHM_EXCLUSIVE 8 |
| 1315 |
|
| 1316 |
/* |
| 1317 |
** CAPI3REF: Maximum xShmLock index |
| 1318 |
** |
| 1319 |
** The xShmLock method on [sqlite3_io_methods] may use values |
| 1320 |
** between 0 and this upper bound as its "offset" argument. |
| 1321 |
** The SQLite core will never attempt to acquire or release a |
| 1322 |
** lock outside of this range |
| 1323 |
*/ |
| 1324 |
#define SQLITE_SHM_NLOCK 8 |
| 1325 |
|
| 1326 |
|
| 1327 |
/* |
| 1328 |
** CAPI3REF: Initialize The SQLite Library |
| 1329 |
** |
| 1330 |
** ^The sqlite3_initialize() routine initializes the |
| 1331 |
** SQLite library. ^The sqlite3_shutdown() routine |
| 1332 |
** deallocates any resources that were allocated by sqlite3_initialize(). |
| 1333 |
** These routines are designed to aid in process initialization and |
| 1334 |
** shutdown on embedded systems. Workstation applications using |
| 1335 |
** SQLite normally do not need to invoke either of these routines. |
| 1336 |
** |
| 1337 |
** A call to sqlite3_initialize() is an "effective" call if it is |
| 1338 |
** the first time sqlite3_initialize() is invoked during the lifetime of |
| 1339 |
** the process, or if it is the first time sqlite3_initialize() is invoked |
| 1340 |
** following a call to sqlite3_shutdown(). ^(Only an effective call |
| 1341 |
** of sqlite3_initialize() does any initialization. All other calls |
| 1342 |
** are harmless no-ops.)^ |
| 1343 |
** |
| 1344 |
** A call to sqlite3_shutdown() is an "effective" call if it is the first |
| 1345 |
** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only |
| 1346 |
** an effective call to sqlite3_shutdown() does any deinitialization. |
| 1347 |
** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ |
| 1348 |
** |
| 1349 |
** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() |
| 1350 |
** is not. The sqlite3_shutdown() interface must only be called from a |
| 1351 |
** single thread. All open [database connections] must be closed and all |
| 1352 |
** other SQLite resources must be deallocated prior to invoking |
| 1353 |
** sqlite3_shutdown(). |
| 1354 |
** |
| 1355 |
** Among other things, ^sqlite3_initialize() will invoke |
| 1356 |
** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() |
| 1357 |
** will invoke sqlite3_os_end(). |
| 1358 |
** |
| 1359 |
** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. |
| 1360 |
** ^If for some reason, sqlite3_initialize() is unable to initialize |
| 1361 |
** the library (perhaps it is unable to allocate a needed resource such |
| 1362 |
** as a mutex) it returns an [error code] other than [SQLITE_OK]. |
| 1363 |
** |
| 1364 |
** ^The sqlite3_initialize() routine is called internally by many other |
| 1365 |
** SQLite interfaces so that an application usually does not need to |
| 1366 |
** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] |
| 1367 |
** calls sqlite3_initialize() so the SQLite library will be automatically |
| 1368 |
** initialized when [sqlite3_open()] is called if it has not be initialized |
| 1369 |
** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] |
| 1370 |
** compile-time option, then the automatic calls to sqlite3_initialize() |
| 1371 |
** are omitted and the application must call sqlite3_initialize() directly |
| 1372 |
** prior to using any other SQLite interface. For maximum portability, |
| 1373 |
** it is recommended that applications always invoke sqlite3_initialize() |
| 1374 |
** directly prior to using any other SQLite interface. Future releases |
| 1375 |
** of SQLite may require this. In other words, the behavior exhibited |
| 1376 |
** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the |
| 1377 |
** default behavior in some future release of SQLite. |
| 1378 |
** |
| 1379 |
** The sqlite3_os_init() routine does operating-system specific |
| 1380 |
** initialization of the SQLite library. The sqlite3_os_end() |
| 1381 |
** routine undoes the effect of sqlite3_os_init(). Typical tasks |
| 1382 |
** performed by these routines include allocation or deallocation |
| 1383 |
** of static resources, initialization of global variables, |
| 1384 |
** setting up a default [sqlite3_vfs] module, or setting up |
| 1385 |
** a default configuration using [sqlite3_config()]. |
| 1386 |
** |
| 1387 |
** The application should never invoke either sqlite3_os_init() |
| 1388 |
** or sqlite3_os_end() directly. The application should only invoke |
| 1389 |
** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() |
| 1390 |
** interface is called automatically by sqlite3_initialize() and |
| 1391 |
** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate |
| 1392 |
** implementations for sqlite3_os_init() and sqlite3_os_end() |
| 1393 |
** are built into SQLite when it is compiled for Unix, Windows, or OS/2. |
| 1394 |
** When [custom builds | built for other platforms] |
| 1395 |
** (using the [SQLITE_OS_OTHER=1] compile-time |
| 1396 |
** option) the application must supply a suitable implementation for |
| 1397 |
** sqlite3_os_init() and sqlite3_os_end(). An application-supplied |
| 1398 |
** implementation of sqlite3_os_init() or sqlite3_os_end() |
| 1399 |
** must return [SQLITE_OK] on success and some other [error code] upon |
| 1400 |
** failure. |
| 1401 |
*/ |
| 1402 |
SQLITE_API int sqlite3_initialize(void); |
| 1403 |
SQLITE_API int sqlite3_shutdown(void); |
| 1404 |
SQLITE_API int sqlite3_os_init(void); |
| 1405 |
SQLITE_API int sqlite3_os_end(void); |
| 1406 |
|
| 1407 |
/* |
| 1408 |
** CAPI3REF: Configuring The SQLite Library |
| 1409 |
** |
| 1410 |
** The sqlite3_config() interface is used to make global configuration |
| 1411 |
** changes to SQLite in order to tune SQLite to the specific needs of |
| 1412 |
** the application. The default configuration is recommended for most |
| 1413 |
** applications and so this routine is usually not necessary. It is |
| 1414 |
** provided to support rare applications with unusual needs. |
| 1415 |
** |
| 1416 |
** <b>The sqlite3_config() interface is not threadsafe. The application |
| 1417 |
** must ensure that no other SQLite interfaces are invoked by other |
| 1418 |
** threads while sqlite3_config() is running.</b> |
| 1419 |
** |
| 1420 |
** The sqlite3_config() interface |
| 1421 |
** may only be invoked prior to library initialization using |
| 1422 |
** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. |
| 1423 |
** ^If sqlite3_config() is called after [sqlite3_initialize()] and before |
| 1424 |
** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. |
| 1425 |
** Note, however, that ^sqlite3_config() can be called as part of the |
| 1426 |
** implementation of an application-defined [sqlite3_os_init()]. |
| 1427 |
** |
| 1428 |
** The first argument to sqlite3_config() is an integer |
| 1429 |
** [configuration option] that determines |
| 1430 |
** what property of SQLite is to be configured. Subsequent arguments |
| 1431 |
** vary depending on the [configuration option] |
| 1432 |
** in the first argument. |
| 1433 |
** |
| 1434 |
** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. |
| 1435 |
** ^If the option is unknown or SQLite is unable to set the option |
| 1436 |
** then this routine returns a non-zero [error code]. |
| 1437 |
*/ |
| 1438 |
SQLITE_API int sqlite3_config(int, ...); |
| 1439 |
|
| 1440 |
/* |
| 1441 |
** CAPI3REF: Configure database connections |
| 1442 |
** METHOD: sqlite3 |
| 1443 |
** |
| 1444 |
** The sqlite3_db_config() interface is used to make configuration |
| 1445 |
** changes to a [database connection]. The interface is similar to |
| 1446 |
** [sqlite3_config()] except that the changes apply to a single |
| 1447 |
** [database connection] (specified in the first argument). |
| 1448 |
** |
| 1449 |
** The second argument to sqlite3_db_config(D,V,...) is the |
| 1450 |
** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code |
| 1451 |
** that indicates what aspect of the [database connection] is being configured. |
| 1452 |
** Subsequent arguments vary depending on the configuration verb. |
| 1453 |
** |
| 1454 |
** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if |
| 1455 |
** the call is considered successful. |
| 1456 |
*/ |
| 1457 |
SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...); |
| 1458 |
|
| 1459 |
/* |
| 1460 |
** CAPI3REF: Memory Allocation Routines |
| 1461 |
** |
| 1462 |
** An instance of this object defines the interface between SQLite |
| 1463 |
** and low-level memory allocation routines. |
| 1464 |
** |
| 1465 |
** This object is used in only one place in the SQLite interface. |
| 1466 |
** A pointer to an instance of this object is the argument to |
| 1467 |
** [sqlite3_config()] when the configuration option is |
| 1468 |
** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. |
| 1469 |
** By creating an instance of this object |
| 1470 |
** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) |
| 1471 |
** during configuration, an application can specify an alternative |
| 1472 |
** memory allocation subsystem for SQLite to use for all of its |
| 1473 |
** dynamic memory needs. |
| 1474 |
** |
| 1475 |
** Note that SQLite comes with several [built-in memory allocators] |
| 1476 |
** that are perfectly adequate for the overwhelming majority of applications |
| 1477 |
** and that this object is only useful to a tiny minority of applications |
| 1478 |
** with specialized memory allocation requirements. This object is |
| 1479 |
** also used during testing of SQLite in order to specify an alternative |
| 1480 |
** memory allocator that simulates memory out-of-memory conditions in |
| 1481 |
** order to verify that SQLite recovers gracefully from such |
| 1482 |
** conditions. |
| 1483 |
** |
| 1484 |
** The xMalloc, xRealloc, and xFree methods must work like the |
| 1485 |
** malloc(), realloc() and free() functions from the standard C library. |
| 1486 |
** ^SQLite guarantees that the second argument to |
| 1487 |
** xRealloc is always a value returned by a prior call to xRoundup. |
| 1488 |
** |
| 1489 |
** xSize should return the allocated size of a memory allocation |
| 1490 |
** previously obtained from xMalloc or xRealloc. The allocated size |
| 1491 |
** is always at least as big as the requested size but may be larger. |
| 1492 |
** |
| 1493 |
** The xRoundup method returns what would be the allocated size of |
| 1494 |
** a memory allocation given a particular requested size. Most memory |
| 1495 |
** allocators round up memory allocations at least to the next multiple |
| 1496 |
** of 8. Some allocators round up to a larger multiple or to a power of 2. |
| 1497 |
** Every memory allocation request coming in through [sqlite3_malloc()] |
| 1498 |
** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, |
| 1499 |
** that causes the corresponding memory allocation to fail. |
| 1500 |
** |
| 1501 |
** The xInit method initializes the memory allocator. For example, |
| 1502 |
** it might allocate any require mutexes or initialize internal data |
| 1503 |
** structures. The xShutdown method is invoked (indirectly) by |
| 1504 |
** [sqlite3_shutdown()] and should deallocate any resources acquired |
| 1505 |
** by xInit. The pAppData pointer is used as the only parameter to |
| 1506 |
** xInit and xShutdown. |
| 1507 |
** |
| 1508 |
** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes |
| 1509 |
** the xInit method, so the xInit method need not be threadsafe. The |
| 1510 |
** xShutdown method is only called from [sqlite3_shutdown()] so it does |
| 1511 |
** not need to be threadsafe either. For all other methods, SQLite |
| 1512 |
** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the |
| 1513 |
** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which |
| 1514 |
** it is by default) and so the methods are automatically serialized. |
| 1515 |
** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other |
| 1516 |
** methods must be threadsafe or else make their own arrangements for |
| 1517 |
** serialization. |
| 1518 |
** |
| 1519 |
** SQLite will never invoke xInit() more than once without an intervening |
| 1520 |
** call to xShutdown(). |
| 1521 |
*/ |
| 1522 |
typedef struct sqlite3_mem_methods sqlite3_mem_methods; |
| 1523 |
struct sqlite3_mem_methods { |
| 1524 |
void *(*xMalloc)(int); /* Memory allocation function */ |
| 1525 |
void (*xFree)(void*); /* Free a prior allocation */ |
| 1526 |
void *(*xRealloc)(void*,int); /* Resize an allocation */ |
| 1527 |
int (*xSize)(void*); /* Return the size of an allocation */ |
| 1528 |
int (*xRoundup)(int); /* Round up request size to allocation size */ |
| 1529 |
int (*xInit)(void*); /* Initialize the memory allocator */ |
| 1530 |
void (*xShutdown)(void*); /* Deinitialize the memory allocator */ |
| 1531 |
void *pAppData; /* Argument to xInit() and xShutdown() */ |
| 1532 |
}; |
| 1533 |
|
| 1534 |
/* |
| 1535 |
** CAPI3REF: Configuration Options |
| 1536 |
** KEYWORDS: {configuration option} |
| 1537 |
** |
| 1538 |
** These constants are the available integer configuration options that |
| 1539 |
** can be passed as the first argument to the [sqlite3_config()] interface. |
| 1540 |
** |
| 1541 |
** New configuration options may be added in future releases of SQLite. |
| 1542 |
** Existing configuration options might be discontinued. Applications |
| 1543 |
** should check the return code from [sqlite3_config()] to make sure that |
| 1544 |
** the call worked. The [sqlite3_config()] interface will return a |
| 1545 |
** non-zero [error code] if a discontinued or unsupported configuration option |
| 1546 |
** is invoked. |
| 1547 |
** |
| 1548 |
** <dl> |
| 1549 |
** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt> |
| 1550 |
** <dd>There are no arguments to this option. ^This option sets the |
| 1551 |
** [threading mode] to Single-thread. In other words, it disables |
| 1552 |
** all mutexing and puts SQLite into a mode where it can only be used |
| 1553 |
** by a single thread. ^If SQLite is compiled with |
| 1554 |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1555 |
** it is not possible to change the [threading mode] from its default |
| 1556 |
** value of Single-thread and so [sqlite3_config()] will return |
| 1557 |
** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD |
| 1558 |
** configuration option.</dd> |
| 1559 |
** |
| 1560 |
** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt> |
| 1561 |
** <dd>There are no arguments to this option. ^This option sets the |
| 1562 |
** [threading mode] to Multi-thread. In other words, it disables |
| 1563 |
** mutexing on [database connection] and [prepared statement] objects. |
| 1564 |
** The application is responsible for serializing access to |
| 1565 |
** [database connections] and [prepared statements]. But other mutexes |
| 1566 |
** are enabled so that SQLite will be safe to use in a multi-threaded |
| 1567 |
** environment as long as no two threads attempt to use the same |
| 1568 |
** [database connection] at the same time. ^If SQLite is compiled with |
| 1569 |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1570 |
** it is not possible to set the Multi-thread [threading mode] and |
| 1571 |
** [sqlite3_config()] will return [SQLITE_ERROR] if called with the |
| 1572 |
** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> |
| 1573 |
** |
| 1574 |
** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt> |
| 1575 |
** <dd>There are no arguments to this option. ^This option sets the |
| 1576 |
** [threading mode] to Serialized. In other words, this option enables |
| 1577 |
** all mutexes including the recursive |
| 1578 |
** mutexes on [database connection] and [prepared statement] objects. |
| 1579 |
** In this mode (which is the default when SQLite is compiled with |
| 1580 |
** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access |
| 1581 |
** to [database connections] and [prepared statements] so that the |
| 1582 |
** application is free to use the same [database connection] or the |
| 1583 |
** same [prepared statement] in different threads at the same time. |
| 1584 |
** ^If SQLite is compiled with |
| 1585 |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1586 |
** it is not possible to set the Serialized [threading mode] and |
| 1587 |
** [sqlite3_config()] will return [SQLITE_ERROR] if called with the |
| 1588 |
** SQLITE_CONFIG_SERIALIZED configuration option.</dd> |
| 1589 |
** |
| 1590 |
** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> |
| 1591 |
** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is |
| 1592 |
** a pointer to an instance of the [sqlite3_mem_methods] structure. |
| 1593 |
** The argument specifies |
| 1594 |
** alternative low-level memory allocation routines to be used in place of |
| 1595 |
** the memory allocation routines built into SQLite.)^ ^SQLite makes |
| 1596 |
** its own private copy of the content of the [sqlite3_mem_methods] structure |
| 1597 |
** before the [sqlite3_config()] call returns.</dd> |
| 1598 |
** |
| 1599 |
** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> |
| 1600 |
** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which |
| 1601 |
** is a pointer to an instance of the [sqlite3_mem_methods] structure. |
| 1602 |
** The [sqlite3_mem_methods] |
| 1603 |
** structure is filled with the currently defined memory allocation routines.)^ |
| 1604 |
** This option can be used to overload the default memory allocation |
| 1605 |
** routines with a wrapper that simulations memory allocation failure or |
| 1606 |
** tracks memory usage, for example. </dd> |
| 1607 |
** |
| 1608 |
** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> |
| 1609 |
** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int, |
| 1610 |
** interpreted as a boolean, which enables or disables the collection of |
| 1611 |
** memory allocation statistics. ^(When memory allocation statistics are |
| 1612 |
** disabled, the following SQLite interfaces become non-operational: |
| 1613 |
** <ul> |
| 1614 |
** <li> [sqlite3_memory_used()] |
| 1615 |
** <li> [sqlite3_memory_highwater()] |
| 1616 |
** <li> [sqlite3_soft_heap_limit64()] |
| 1617 |
** <li> [sqlite3_status64()] |
| 1618 |
** </ul>)^ |
| 1619 |
** ^Memory allocation statistics are enabled by default unless SQLite is |
| 1620 |
** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory |
| 1621 |
** allocation statistics are disabled by default. |
| 1622 |
** </dd> |
| 1623 |
** |
| 1624 |
** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> |
| 1625 |
** <dd> ^The SQLITE_CONFIG_SCRATCH option specifies a static memory buffer |
| 1626 |
** that SQLite can use for scratch memory. ^(There are three arguments |
| 1627 |
** to SQLITE_CONFIG_SCRATCH: A pointer an 8-byte |
| 1628 |
** aligned memory buffer from which the scratch allocations will be |
| 1629 |
** drawn, the size of each scratch allocation (sz), |
| 1630 |
** and the maximum number of scratch allocations (N).)^ |
| 1631 |
** The first argument must be a pointer to an 8-byte aligned buffer |
| 1632 |
** of at least sz*N bytes of memory. |
| 1633 |
** ^SQLite will not use more than one scratch buffers per thread. |
| 1634 |
** ^SQLite will never request a scratch buffer that is more than 6 |
| 1635 |
** times the database page size. |
| 1636 |
** ^If SQLite needs needs additional |
| 1637 |
** scratch memory beyond what is provided by this configuration option, then |
| 1638 |
** [sqlite3_malloc()] will be used to obtain the memory needed.<p> |
| 1639 |
** ^When the application provides any amount of scratch memory using |
| 1640 |
** SQLITE_CONFIG_SCRATCH, SQLite avoids unnecessary large |
| 1641 |
** [sqlite3_malloc|heap allocations]. |
| 1642 |
** This can help [Robson proof|prevent memory allocation failures] due to heap |
| 1643 |
** fragmentation in low-memory embedded systems. |
| 1644 |
** </dd> |
| 1645 |
** |
| 1646 |
** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> |
| 1647 |
** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool |
| 1648 |
** that SQLite can use for the database page cache with the default page |
| 1649 |
** cache implementation. |
| 1650 |
** This configuration option is a no-op if an application-define page |
| 1651 |
** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2]. |
| 1652 |
** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to |
| 1653 |
** 8-byte aligned memory (pMem), the size of each page cache line (sz), |
| 1654 |
** and the number of cache lines (N). |
| 1655 |
** The sz argument should be the size of the largest database page |
| 1656 |
** (a power of two between 512 and 65536) plus some extra bytes for each |
| 1657 |
** page header. ^The number of extra bytes needed by the page header |
| 1658 |
** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ]. |
| 1659 |
** ^It is harmless, apart from the wasted memory, |
| 1660 |
** for the sz parameter to be larger than necessary. The pMem |
| 1661 |
** argument must be either a NULL pointer or a pointer to an 8-byte |
| 1662 |
** aligned block of memory of at least sz*N bytes, otherwise |
| 1663 |
** subsequent behavior is undefined. |
| 1664 |
** ^When pMem is not NULL, SQLite will strive to use the memory provided |
| 1665 |
** to satisfy page cache needs, falling back to [sqlite3_malloc()] if |
| 1666 |
** a page cache line is larger than sz bytes or if all of the pMem buffer |
| 1667 |
** is exhausted. |
| 1668 |
** ^If pMem is NULL and N is non-zero, then each database connection |
| 1669 |
** does an initial bulk allocation for page cache memory |
| 1670 |
** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or |
| 1671 |
** of -1024*N bytes if N is negative, . ^If additional |
| 1672 |
** page cache memory is needed beyond what is provided by the initial |
| 1673 |
** allocation, then SQLite goes to [sqlite3_malloc()] separately for each |
| 1674 |
** additional cache line. </dd> |
| 1675 |
** |
| 1676 |
** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> |
| 1677 |
** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer |
| 1678 |
** that SQLite will use for all of its dynamic memory allocation needs |
| 1679 |
** beyond those provided for by [SQLITE_CONFIG_SCRATCH] and |
| 1680 |
** [SQLITE_CONFIG_PAGECACHE]. |
| 1681 |
** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled |
| 1682 |
** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns |
| 1683 |
** [SQLITE_ERROR] if invoked otherwise. |
| 1684 |
** ^There are three arguments to SQLITE_CONFIG_HEAP: |
| 1685 |
** An 8-byte aligned pointer to the memory, |
| 1686 |
** the number of bytes in the memory buffer, and the minimum allocation size. |
| 1687 |
** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts |
| 1688 |
** to using its default memory allocator (the system malloc() implementation), |
| 1689 |
** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the |
| 1690 |
** memory pointer is not NULL then the alternative memory |
| 1691 |
** allocator is engaged to handle all of SQLites memory allocation needs. |
| 1692 |
** The first pointer (the memory pointer) must be aligned to an 8-byte |
| 1693 |
** boundary or subsequent behavior of SQLite will be undefined. |
| 1694 |
** The minimum allocation size is capped at 2**12. Reasonable values |
| 1695 |
** for the minimum allocation size are 2**5 through 2**8.</dd> |
| 1696 |
** |
| 1697 |
** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> |
| 1698 |
** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a |
| 1699 |
** pointer to an instance of the [sqlite3_mutex_methods] structure. |
| 1700 |
** The argument specifies alternative low-level mutex routines to be used |
| 1701 |
** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of |
| 1702 |
** the content of the [sqlite3_mutex_methods] structure before the call to |
| 1703 |
** [sqlite3_config()] returns. ^If SQLite is compiled with |
| 1704 |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1705 |
** the entire mutexing subsystem is omitted from the build and hence calls to |
| 1706 |
** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will |
| 1707 |
** return [SQLITE_ERROR].</dd> |
| 1708 |
** |
| 1709 |
** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> |
| 1710 |
** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which |
| 1711 |
** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The |
| 1712 |
** [sqlite3_mutex_methods] |
| 1713 |
** structure is filled with the currently defined mutex routines.)^ |
| 1714 |
** This option can be used to overload the default mutex allocation |
| 1715 |
** routines with a wrapper used to track mutex usage for performance |
| 1716 |
** profiling or testing, for example. ^If SQLite is compiled with |
| 1717 |
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1718 |
** the entire mutexing subsystem is omitted from the build and hence calls to |
| 1719 |
** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will |
| 1720 |
** return [SQLITE_ERROR].</dd> |
| 1721 |
** |
| 1722 |
** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> |
| 1723 |
** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine |
| 1724 |
** the default size of lookaside memory on each [database connection]. |
| 1725 |
** The first argument is the |
| 1726 |
** size of each lookaside buffer slot and the second is the number of |
| 1727 |
** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE |
| 1728 |
** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] |
| 1729 |
** option to [sqlite3_db_config()] can be used to change the lookaside |
| 1730 |
** configuration on individual connections.)^ </dd> |
| 1731 |
** |
| 1732 |
** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> |
| 1733 |
** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is |
| 1734 |
** a pointer to an [sqlite3_pcache_methods2] object. This object specifies |
| 1735 |
** the interface to a custom page cache implementation.)^ |
| 1736 |
** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd> |
| 1737 |
** |
| 1738 |
** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> |
| 1739 |
** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which |
| 1740 |
** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of |
| 1741 |
** the current page cache implementation into that object.)^ </dd> |
| 1742 |
** |
| 1743 |
** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> |
| 1744 |
** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite |
| 1745 |
** global [error log]. |
| 1746 |
** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a |
| 1747 |
** function with a call signature of void(*)(void*,int,const char*), |
| 1748 |
** and a pointer to void. ^If the function pointer is not NULL, it is |
| 1749 |
** invoked by [sqlite3_log()] to process each logging event. ^If the |
| 1750 |
** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. |
| 1751 |
** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is |
| 1752 |
** passed through as the first parameter to the application-defined logger |
| 1753 |
** function whenever that function is invoked. ^The second parameter to |
| 1754 |
** the logger function is a copy of the first parameter to the corresponding |
| 1755 |
** [sqlite3_log()] call and is intended to be a [result code] or an |
| 1756 |
** [extended result code]. ^The third parameter passed to the logger is |
| 1757 |
** log message after formatting via [sqlite3_snprintf()]. |
| 1758 |
** The SQLite logging interface is not reentrant; the logger function |
| 1759 |
** supplied by the application must not invoke any SQLite interface. |
| 1760 |
** In a multi-threaded application, the application-defined logger |
| 1761 |
** function must be threadsafe. </dd> |
| 1762 |
** |
| 1763 |
** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI |
| 1764 |
** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int. |
| 1765 |
** If non-zero, then URI handling is globally enabled. If the parameter is zero, |
| 1766 |
** then URI handling is globally disabled.)^ ^If URI handling is globally |
| 1767 |
** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()], |
| 1768 |
** [sqlite3_open16()] or |
| 1769 |
** specified as part of [ATTACH] commands are interpreted as URIs, regardless |
| 1770 |
** of whether or not the [SQLITE_OPEN_URI] flag is set when the database |
| 1771 |
** connection is opened. ^If it is globally disabled, filenames are |
| 1772 |
** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the |
| 1773 |
** database connection is opened. ^(By default, URI handling is globally |
| 1774 |
** disabled. The default value may be changed by compiling with the |
| 1775 |
** [SQLITE_USE_URI] symbol defined.)^ |
| 1776 |
** |
| 1777 |
** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN |
| 1778 |
** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer |
| 1779 |
** argument which is interpreted as a boolean in order to enable or disable |
| 1780 |
** the use of covering indices for full table scans in the query optimizer. |
| 1781 |
** ^The default setting is determined |
| 1782 |
** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on" |
| 1783 |
** if that compile-time option is omitted. |
| 1784 |
** The ability to disable the use of covering indices for full table scans |
| 1785 |
** is because some incorrectly coded legacy applications might malfunction |
| 1786 |
** when the optimization is enabled. Providing the ability to |
| 1787 |
** disable the optimization allows the older, buggy application code to work |
| 1788 |
** without change even with newer versions of SQLite. |
| 1789 |
** |
| 1790 |
** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] |
| 1791 |
** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE |
| 1792 |
** <dd> These options are obsolete and should not be used by new code. |
| 1793 |
** They are retained for backwards compatibility but are now no-ops. |
| 1794 |
** </dd> |
| 1795 |
** |
| 1796 |
** [[SQLITE_CONFIG_SQLLOG]] |
| 1797 |
** <dt>SQLITE_CONFIG_SQLLOG |
| 1798 |
** <dd>This option is only available if sqlite is compiled with the |
| 1799 |
** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should |
| 1800 |
** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int). |
| 1801 |
** The second should be of type (void*). The callback is invoked by the library |
| 1802 |
** in three separate circumstances, identified by the value passed as the |
| 1803 |
** fourth parameter. If the fourth parameter is 0, then the database connection |
| 1804 |
** passed as the second argument has just been opened. The third argument |
| 1805 |
** points to a buffer containing the name of the main database file. If the |
| 1806 |
** fourth parameter is 1, then the SQL statement that the third parameter |
| 1807 |
** points to has just been executed. Or, if the fourth parameter is 2, then |
| 1808 |
** the connection being passed as the second parameter is being closed. The |
| 1809 |
** third parameter is passed NULL In this case. An example of using this |
| 1810 |
** configuration option can be seen in the "test_sqllog.c" source file in |
| 1811 |
** the canonical SQLite source tree.</dd> |
| 1812 |
** |
| 1813 |
** [[SQLITE_CONFIG_MMAP_SIZE]] |
| 1814 |
** <dt>SQLITE_CONFIG_MMAP_SIZE |
| 1815 |
** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values |
| 1816 |
** that are the default mmap size limit (the default setting for |
| 1817 |
** [PRAGMA mmap_size]) and the maximum allowed mmap size limit. |
| 1818 |
** ^The default setting can be overridden by each database connection using |
| 1819 |
** either the [PRAGMA mmap_size] command, or by using the |
| 1820 |
** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size |
| 1821 |
** will be silently truncated if necessary so that it does not exceed the |
| 1822 |
** compile-time maximum mmap size set by the |
| 1823 |
** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^ |
| 1824 |
** ^If either argument to this option is negative, then that argument is |
| 1825 |
** changed to its compile-time default. |
| 1826 |
** |
| 1827 |
** [[SQLITE_CONFIG_WIN32_HEAPSIZE]] |
| 1828 |
** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE |
| 1829 |
** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is |
| 1830 |
** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro |
| 1831 |
** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value |
| 1832 |
** that specifies the maximum size of the created heap. |
| 1833 |
** |
| 1834 |
** [[SQLITE_CONFIG_PCACHE_HDRSZ]] |
| 1835 |
** <dt>SQLITE_CONFIG_PCACHE_HDRSZ |
| 1836 |
** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which |
| 1837 |
** is a pointer to an integer and writes into that integer the number of extra |
| 1838 |
** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE]. |
| 1839 |
** The amount of extra space required can change depending on the compiler, |
| 1840 |
** target platform, and SQLite version. |
| 1841 |
** |
| 1842 |
** [[SQLITE_CONFIG_PMASZ]] |
| 1843 |
** <dt>SQLITE_CONFIG_PMASZ |
| 1844 |
** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which |
| 1845 |
** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded |
| 1846 |
** sorter to that integer. The default minimum PMA Size is set by the |
| 1847 |
** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched |
| 1848 |
** to help with sort operations when multithreaded sorting |
| 1849 |
** is enabled (using the [PRAGMA threads] command) and the amount of content |
| 1850 |
** to be sorted exceeds the page size times the minimum of the |
| 1851 |
** [PRAGMA cache_size] setting and this value. |
| 1852 |
** |
| 1853 |
** [[SQLITE_CONFIG_STMTJRNL_SPILL]] |
| 1854 |
** <dt>SQLITE_CONFIG_STMTJRNL_SPILL |
| 1855 |
** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which |
| 1856 |
** becomes the [statement journal] spill-to-disk threshold. |
| 1857 |
** [Statement journals] are held in memory until their size (in bytes) |
| 1858 |
** exceeds this threshold, at which point they are written to disk. |
| 1859 |
** Or if the threshold is -1, statement journals are always held |
| 1860 |
** exclusively in memory. |
| 1861 |
** Since many statement journals never become large, setting the spill |
| 1862 |
** threshold to a value such as 64KiB can greatly reduce the amount of |
| 1863 |
** I/O required to support statement rollback. |
| 1864 |
** The default value for this setting is controlled by the |
| 1865 |
** [SQLITE_STMTJRNL_SPILL] compile-time option. |
| 1866 |
** </dl> |
| 1867 |
*/ |
| 1868 |
#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ |
| 1869 |
#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ |
| 1870 |
#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ |
| 1871 |
#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ |
| 1872 |
#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ |
| 1873 |
#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ |
| 1874 |
#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ |
| 1875 |
#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ |
| 1876 |
#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ |
| 1877 |
#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ |
| 1878 |
#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ |
| 1879 |
/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ |
| 1880 |
#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ |
| 1881 |
#define SQLITE_CONFIG_PCACHE 14 /* no-op */ |
| 1882 |
#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ |
| 1883 |
#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ |
| 1884 |
#define SQLITE_CONFIG_URI 17 /* int */ |
| 1885 |
#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ |
| 1886 |
#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ |
| 1887 |
#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */ |
| 1888 |
#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */ |
| 1889 |
#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */ |
| 1890 |
#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */ |
| 1891 |
#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */ |
| 1892 |
#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */ |
| 1893 |
#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */ |
| 1894 |
|
| 1895 |
/* |
| 1896 |
** CAPI3REF: Database Connection Configuration Options |
| 1897 |
** |
| 1898 |
** These constants are the available integer configuration options that |
| 1899 |
** can be passed as the second argument to the [sqlite3_db_config()] interface. |
| 1900 |
** |
| 1901 |
** New configuration options may be added in future releases of SQLite. |
| 1902 |
** Existing configuration options might be discontinued. Applications |
| 1903 |
** should check the return code from [sqlite3_db_config()] to make sure that |
| 1904 |
** the call worked. ^The [sqlite3_db_config()] interface will return a |
| 1905 |
** non-zero [error code] if a discontinued or unsupported configuration option |
| 1906 |
** is invoked. |
| 1907 |
** |
| 1908 |
** <dl> |
| 1909 |
** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> |
| 1910 |
** <dd> ^This option takes three additional arguments that determine the |
| 1911 |
** [lookaside memory allocator] configuration for the [database connection]. |
| 1912 |
** ^The first argument (the third parameter to [sqlite3_db_config()] is a |
| 1913 |
** pointer to a memory buffer to use for lookaside memory. |
| 1914 |
** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb |
| 1915 |
** may be NULL in which case SQLite will allocate the |
| 1916 |
** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the |
| 1917 |
** size of each lookaside buffer slot. ^The third argument is the number of |
| 1918 |
** slots. The size of the buffer in the first argument must be greater than |
| 1919 |
** or equal to the product of the second and third arguments. The buffer |
| 1920 |
** must be aligned to an 8-byte boundary. ^If the second argument to |
| 1921 |
** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally |
| 1922 |
** rounded down to the next smaller multiple of 8. ^(The lookaside memory |
| 1923 |
** configuration for a database connection can only be changed when that |
| 1924 |
** connection is not currently using lookaside memory, or in other words |
| 1925 |
** when the "current value" returned by |
| 1926 |
** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. |
| 1927 |
** Any attempt to change the lookaside memory configuration when lookaside |
| 1928 |
** memory is in use leaves the configuration unchanged and returns |
| 1929 |
** [SQLITE_BUSY].)^</dd> |
| 1930 |
** |
| 1931 |
** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> |
| 1932 |
** <dd> ^This option is used to enable or disable the enforcement of |
| 1933 |
** [foreign key constraints]. There should be two additional arguments. |
| 1934 |
** The first argument is an integer which is 0 to disable FK enforcement, |
| 1935 |
** positive to enable FK enforcement or negative to leave FK enforcement |
| 1936 |
** unchanged. The second parameter is a pointer to an integer into which |
| 1937 |
** is written 0 or 1 to indicate whether FK enforcement is off or on |
| 1938 |
** following this call. The second parameter may be a NULL pointer, in |
| 1939 |
** which case the FK enforcement setting is not reported back. </dd> |
| 1940 |
** |
| 1941 |
** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> |
| 1942 |
** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. |
| 1943 |
** There should be two additional arguments. |
| 1944 |
** The first argument is an integer which is 0 to disable triggers, |
| 1945 |
** positive to enable triggers or negative to leave the setting unchanged. |
| 1946 |
** The second parameter is a pointer to an integer into which |
| 1947 |
** is written 0 or 1 to indicate whether triggers are disabled or enabled |
| 1948 |
** following this call. The second parameter may be a NULL pointer, in |
| 1949 |
** which case the trigger setting is not reported back. </dd> |
| 1950 |
** |
| 1951 |
** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt> |
| 1952 |
** <dd> ^This option is used to enable or disable the two-argument |
| 1953 |
** version of the [fts3_tokenizer()] function which is part of the |
| 1954 |
** [FTS3] full-text search engine extension. |
| 1955 |
** There should be two additional arguments. |
| 1956 |
** The first argument is an integer which is 0 to disable fts3_tokenizer() or |
| 1957 |
** positive to enable fts3_tokenizer() or negative to leave the setting |
| 1958 |
** unchanged. |
| 1959 |
** The second parameter is a pointer to an integer into which |
| 1960 |
** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled |
| 1961 |
** following this call. The second parameter may be a NULL pointer, in |
| 1962 |
** which case the new setting is not reported back. </dd> |
| 1963 |
** |
| 1964 |
** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt> |
| 1965 |
** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()] |
| 1966 |
** interface independently of the [load_extension()] SQL function. |
| 1967 |
** The [sqlite3_enable_load_extension()] API enables or disables both the |
| 1968 |
** C-API [sqlite3_load_extension()] and the SQL function [load_extension()]. |
| 1969 |
** There should be two additional arguments. |
| 1970 |
** When the first argument to this interface is 1, then only the C-API is |
| 1971 |
** enabled and the SQL function remains disabled. If the first argument to |
| 1972 |
** this interface is 0, then both the C-API and the SQL function are disabled. |
| 1973 |
** If the first argument is -1, then no changes are made to state of either the |
| 1974 |
** C-API or the SQL function. |
| 1975 |
** The second parameter is a pointer to an integer into which |
| 1976 |
** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface |
| 1977 |
** is disabled or enabled following this call. The second parameter may |
| 1978 |
** be a NULL pointer, in which case the new setting is not reported back. |
| 1979 |
** </dd> |
| 1980 |
** |
| 1981 |
** <dt>SQLITE_DBCONFIG_MAINDBNAME</dt> |
| 1982 |
** <dd> ^This option is used to change the name of the "main" database |
| 1983 |
** schema. ^The sole argument is a pointer to a constant UTF8 string |
| 1984 |
** which will become the new schema name in place of "main". ^SQLite |
| 1985 |
** does not make a copy of the new main schema name string, so the application |
| 1986 |
** must ensure that the argument passed into this DBCONFIG option is unchanged |
| 1987 |
** until after the database connection closes. |
| 1988 |
** </dd> |
| 1989 |
** |
| 1990 |
** </dl> |
| 1991 |
*/ |
| 1992 |
#define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */ |
| 1993 |
#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ |
| 1994 |
#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ |
| 1995 |
#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ |
| 1996 |
#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */ |
| 1997 |
#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */ |
| 1998 |
|
| 1999 |
|
| 2000 |
/* |
| 2001 |
** CAPI3REF: Enable Or Disable Extended Result Codes |
| 2002 |
** METHOD: sqlite3 |
| 2003 |
** |
| 2004 |
** ^The sqlite3_extended_result_codes() routine enables or disables the |
| 2005 |
** [extended result codes] feature of SQLite. ^The extended result |
| 2006 |
** codes are disabled by default for historical compatibility. |
| 2007 |
*/ |
| 2008 |
SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); |
| 2009 |
|
| 2010 |
/* |
| 2011 |
** CAPI3REF: Last Insert Rowid |
| 2012 |
** METHOD: sqlite3 |
| 2013 |
** |
| 2014 |
** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables) |
| 2015 |
** has a unique 64-bit signed |
| 2016 |
** integer key called the [ROWID | "rowid"]. ^The rowid is always available |
| 2017 |
** as an undeclared column named ROWID, OID, or _ROWID_ as long as those |
| 2018 |
** names are not also used by explicitly declared columns. ^If |
| 2019 |
** the table has a column of type [INTEGER PRIMARY KEY] then that column |
| 2020 |
** is another alias for the rowid. |
| 2021 |
** |
| 2022 |
** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the |
| 2023 |
** most recent successful [INSERT] into a rowid table or [virtual table] |
| 2024 |
** on database connection D. |
| 2025 |
** ^Inserts into [WITHOUT ROWID] tables are not recorded. |
| 2026 |
** ^If no successful [INSERT]s into rowid tables |
| 2027 |
** have ever occurred on the database connection D, |
| 2028 |
** then sqlite3_last_insert_rowid(D) returns zero. |
| 2029 |
** |
| 2030 |
** ^(If an [INSERT] occurs within a trigger or within a [virtual table] |
| 2031 |
** method, then this routine will return the [rowid] of the inserted |
| 2032 |
** row as long as the trigger or virtual table method is running. |
| 2033 |
** But once the trigger or virtual table method ends, the value returned |
| 2034 |
** by this routine reverts to what it was before the trigger or virtual |
| 2035 |
** table method began.)^ |
| 2036 |
** |
| 2037 |
** ^An [INSERT] that fails due to a constraint violation is not a |
| 2038 |
** successful [INSERT] and does not change the value returned by this |
| 2039 |
** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, |
| 2040 |
** and INSERT OR ABORT make no changes to the return value of this |
| 2041 |
** routine when their insertion fails. ^(When INSERT OR REPLACE |
| 2042 |
** encounters a constraint violation, it does not fail. The |
| 2043 |
** INSERT continues to completion after deleting rows that caused |
| 2044 |
** the constraint problem so INSERT OR REPLACE will always change |
| 2045 |
** the return value of this interface.)^ |
| 2046 |
** |
| 2047 |
** ^For the purposes of this routine, an [INSERT] is considered to |
| 2048 |
** be successful even if it is subsequently rolled back. |
| 2049 |
** |
| 2050 |
** This function is accessible to SQL statements via the |
| 2051 |
** [last_insert_rowid() SQL function]. |
| 2052 |
** |
| 2053 |
** If a separate thread performs a new [INSERT] on the same |
| 2054 |
** database connection while the [sqlite3_last_insert_rowid()] |
| 2055 |
** function is running and thus changes the last insert [rowid], |
| 2056 |
** then the value returned by [sqlite3_last_insert_rowid()] is |
| 2057 |
** unpredictable and might not equal either the old or the new |
| 2058 |
** last insert [rowid]. |
| 2059 |
*/ |
| 2060 |
SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); |
| 2061 |
|
| 2062 |
/* |
| 2063 |
** CAPI3REF: Count The Number Of Rows Modified |
| 2064 |
** METHOD: sqlite3 |
| 2065 |
** |
| 2066 |
** ^This function returns the number of rows modified, inserted or |
| 2067 |
** deleted by the most recently completed INSERT, UPDATE or DELETE |
| 2068 |
** statement on the database connection specified by the only parameter. |
| 2069 |
** ^Executing any other type of SQL statement does not modify the value |
| 2070 |
** returned by this function. |
| 2071 |
** |
| 2072 |
** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are |
| 2073 |
** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], |
| 2074 |
** [foreign key actions] or [REPLACE] constraint resolution are not counted. |
| 2075 |
** |
| 2076 |
** Changes to a view that are intercepted by |
| 2077 |
** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value |
| 2078 |
** returned by sqlite3_changes() immediately after an INSERT, UPDATE or |
| 2079 |
** DELETE statement run on a view is always zero. Only changes made to real |
| 2080 |
** tables are counted. |
| 2081 |
** |
| 2082 |
** Things are more complicated if the sqlite3_changes() function is |
| 2083 |
** executed while a trigger program is running. This may happen if the |
| 2084 |
** program uses the [changes() SQL function], or if some other callback |
| 2085 |
** function invokes sqlite3_changes() directly. Essentially: |
| 2086 |
** |
| 2087 |
** <ul> |
| 2088 |
** <li> ^(Before entering a trigger program the value returned by |
| 2089 |
** sqlite3_changes() function is saved. After the trigger program |
| 2090 |
** has finished, the original value is restored.)^ |
| 2091 |
** |
| 2092 |
** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE |
| 2093 |
** statement sets the value returned by sqlite3_changes() |
| 2094 |
** upon completion as normal. Of course, this value will not include |
| 2095 |
** any changes performed by sub-triggers, as the sqlite3_changes() |
| 2096 |
** value will be saved and restored after each sub-trigger has run.)^ |
| 2097 |
** </ul> |
| 2098 |
** |
| 2099 |
** ^This means that if the changes() SQL function (or similar) is used |
| 2100 |
** by the first INSERT, UPDATE or DELETE statement within a trigger, it |
| 2101 |
** returns the value as set when the calling statement began executing. |
| 2102 |
** ^If it is used by the second or subsequent such statement within a trigger |
| 2103 |
** program, the value returned reflects the number of rows modified by the |
| 2104 |
** previous INSERT, UPDATE or DELETE statement within the same trigger. |
| 2105 |
** |
| 2106 |
** See also the [sqlite3_total_changes()] interface, the |
| 2107 |
** [count_changes pragma], and the [changes() SQL function]. |
| 2108 |
** |
| 2109 |
** If a separate thread makes changes on the same database connection |
| 2110 |
** while [sqlite3_changes()] is running then the value returned |
| 2111 |
** is unpredictable and not meaningful. |
| 2112 |
*/ |
| 2113 |
SQLITE_API int sqlite3_changes(sqlite3*); |
| 2114 |
|
| 2115 |
/* |
| 2116 |
** CAPI3REF: Total Number Of Rows Modified |
| 2117 |
** METHOD: sqlite3 |
| 2118 |
** |
| 2119 |
** ^This function returns the total number of rows inserted, modified or |
| 2120 |
** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed |
| 2121 |
** since the database connection was opened, including those executed as |
| 2122 |
** part of trigger programs. ^Executing any other type of SQL statement |
| 2123 |
** does not affect the value returned by sqlite3_total_changes(). |
| 2124 |
** |
| 2125 |
** ^Changes made as part of [foreign key actions] are included in the |
| 2126 |
** count, but those made as part of REPLACE constraint resolution are |
| 2127 |
** not. ^Changes to a view that are intercepted by INSTEAD OF triggers |
| 2128 |
** are not counted. |
| 2129 |
** |
| 2130 |
** See also the [sqlite3_changes()] interface, the |
| 2131 |
** [count_changes pragma], and the [total_changes() SQL function]. |
| 2132 |
** |
| 2133 |
** If a separate thread makes changes on the same database connection |
| 2134 |
** while [sqlite3_total_changes()] is running then the value |
| 2135 |
** returned is unpredictable and not meaningful. |
| 2136 |
*/ |
| 2137 |
SQLITE_API int sqlite3_total_changes(sqlite3*); |
| 2138 |
|
| 2139 |
/* |
| 2140 |
** CAPI3REF: Interrupt A Long-Running Query |
| 2141 |
** METHOD: sqlite3 |
| 2142 |
** |
| 2143 |
** ^This function causes any pending database operation to abort and |
| 2144 |
** return at its earliest opportunity. This routine is typically |
| 2145 |
** called in response to a user action such as pressing "Cancel" |
| 2146 |
** or Ctrl-C where the user wants a long query operation to halt |
| 2147 |
** immediately. |
| 2148 |
** |
| 2149 |
** ^It is safe to call this routine from a thread different from the |
| 2150 |
** thread that is currently running the database operation. But it |
| 2151 |
** is not safe to call this routine with a [database connection] that |
| 2152 |
** is closed or might close before sqlite3_interrupt() returns. |
| 2153 |
** |
| 2154 |
** ^If an SQL operation is very nearly finished at the time when |
| 2155 |
** sqlite3_interrupt() is called, then it might not have an opportunity |
| 2156 |
** to be interrupted and might continue to completion. |
| 2157 |
** |
| 2158 |
** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. |
| 2159 |
** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE |
| 2160 |
** that is inside an explicit transaction, then the entire transaction |
| 2161 |
** will be rolled back automatically. |
| 2162 |
** |
| 2163 |
** ^The sqlite3_interrupt(D) call is in effect until all currently running |
| 2164 |
** SQL statements on [database connection] D complete. ^Any new SQL statements |
| 2165 |
** that are started after the sqlite3_interrupt() call and before the |
| 2166 |
** running statements reaches zero are interrupted as if they had been |
| 2167 |
** running prior to the sqlite3_interrupt() call. ^New SQL statements |
| 2168 |
** that are started after the running statement count reaches zero are |
| 2169 |
** not effected by the sqlite3_interrupt(). |
| 2170 |
** ^A call to sqlite3_interrupt(D) that occurs when there are no running |
| 2171 |
** SQL statements is a no-op and has no effect on SQL statements |
| 2172 |
** that are started after the sqlite3_interrupt() call returns. |
| 2173 |
** |
| 2174 |
** If the database connection closes while [sqlite3_interrupt()] |
| 2175 |
** is running then bad things will likely happen. |
| 2176 |
*/ |
| 2177 |
SQLITE_API void sqlite3_interrupt(sqlite3*); |
| 2178 |
|
| 2179 |
/* |
| 2180 |
** CAPI3REF: Determine If An SQL Statement Is Complete |
| 2181 |
** |
| 2182 |
** These routines are useful during command-line input to determine if the |
| 2183 |
** currently entered text seems to form a complete SQL statement or |
| 2184 |
** if additional input is needed before sending the text into |
| 2185 |
** SQLite for parsing. ^These routines return 1 if the input string |
| 2186 |
** appears to be a complete SQL statement. ^A statement is judged to be |
| 2187 |
** complete if it ends with a semicolon token and is not a prefix of a |
| 2188 |
** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within |
| 2189 |
** string literals or quoted identifier names or comments are not |
| 2190 |
** independent tokens (they are part of the token in which they are |
| 2191 |
** embedded) and thus do not count as a statement terminator. ^Whitespace |
| 2192 |
** and comments that follow the final semicolon are ignored. |
| 2193 |
** |
| 2194 |
** ^These routines return 0 if the statement is incomplete. ^If a |
| 2195 |
** memory allocation fails, then SQLITE_NOMEM is returned. |
| 2196 |
** |
| 2197 |
** ^These routines do not parse the SQL statements thus |
| 2198 |
** will not detect syntactically incorrect SQL. |
| 2199 |
** |
| 2200 |
** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior |
| 2201 |
** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked |
| 2202 |
** automatically by sqlite3_complete16(). If that initialization fails, |
| 2203 |
** then the return value from sqlite3_complete16() will be non-zero |
| 2204 |
** regardless of whether or not the input SQL is complete.)^ |
| 2205 |
** |
| 2206 |
** The input to [sqlite3_complete()] must be a zero-terminated |
| 2207 |
** UTF-8 string. |
| 2208 |
** |
| 2209 |
** The input to [sqlite3_complete16()] must be a zero-terminated |
| 2210 |
** UTF-16 string in native byte order. |
| 2211 |
*/ |
| 2212 |
SQLITE_API int sqlite3_complete(const char *sql); |
| 2213 |
SQLITE_API int sqlite3_complete16(const void *sql); |
| 2214 |
|
| 2215 |
/* |
| 2216 |
** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors |
| 2217 |
** KEYWORDS: {busy-handler callback} {busy handler} |
| 2218 |
** METHOD: sqlite3 |
| 2219 |
** |
| 2220 |
** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X |
| 2221 |
** that might be invoked with argument P whenever |
| 2222 |
** an attempt is made to access a database table associated with |
| 2223 |
** [database connection] D when another thread |
| 2224 |
** or process has the table locked. |
| 2225 |
** The sqlite3_busy_handler() interface is used to implement |
| 2226 |
** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout]. |
| 2227 |
** |
| 2228 |
** ^If the busy callback is NULL, then [SQLITE_BUSY] |
| 2229 |
** is returned immediately upon encountering the lock. ^If the busy callback |
| 2230 |
** is not NULL, then the callback might be invoked with two arguments. |
| 2231 |
** |
| 2232 |
** ^The first argument to the busy handler is a copy of the void* pointer which |
| 2233 |
** is the third argument to sqlite3_busy_handler(). ^The second argument to |
| 2234 |
** the busy handler callback is the number of times that the busy handler has |
| 2235 |
** been invoked previously for the same locking event. ^If the |
| 2236 |
** busy callback returns 0, then no additional attempts are made to |
| 2237 |
** access the database and [SQLITE_BUSY] is returned |
| 2238 |
** to the application. |
| 2239 |
** ^If the callback returns non-zero, then another attempt |
| 2240 |
** is made to access the database and the cycle repeats. |
| 2241 |
** |
| 2242 |
** The presence of a busy handler does not guarantee that it will be invoked |
| 2243 |
** when there is lock contention. ^If SQLite determines that invoking the busy |
| 2244 |
** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] |
| 2245 |
** to the application instead of invoking the |
| 2246 |
** busy handler. |
| 2247 |
** Consider a scenario where one process is holding a read lock that |
| 2248 |
** it is trying to promote to a reserved lock and |
| 2249 |
** a second process is holding a reserved lock that it is trying |
| 2250 |
** to promote to an exclusive lock. The first process cannot proceed |
| 2251 |
** because it is blocked by the second and the second process cannot |
| 2252 |
** proceed because it is blocked by the first. If both processes |
| 2253 |
** invoke the busy handlers, neither will make any progress. Therefore, |
| 2254 |
** SQLite returns [SQLITE_BUSY] for the first process, hoping that this |
| 2255 |
** will induce the first process to release its read lock and allow |
| 2256 |
** the second process to proceed. |
| 2257 |
** |
| 2258 |
** ^The default busy callback is NULL. |
| 2259 |
** |
| 2260 |
** ^(There can only be a single busy handler defined for each |
| 2261 |
** [database connection]. Setting a new busy handler clears any |
| 2262 |
** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] |
| 2263 |
** or evaluating [PRAGMA busy_timeout=N] will change the |
| 2264 |
** busy handler and thus clear any previously set busy handler. |
| 2265 |
** |
| 2266 |
** The busy callback should not take any actions which modify the |
| 2267 |
** database connection that invoked the busy handler. In other words, |
| 2268 |
** the busy handler is not reentrant. Any such actions |
| 2269 |
** result in undefined behavior. |
| 2270 |
** |
| 2271 |
** A busy handler must not close the database connection |
| 2272 |
** or [prepared statement] that invoked the busy handler. |
| 2273 |
*/ |
| 2274 |
SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*); |
| 2275 |
|
| 2276 |
/* |
| 2277 |
** CAPI3REF: Set A Busy Timeout |
| 2278 |
** METHOD: sqlite3 |
| 2279 |
** |
| 2280 |
** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps |
| 2281 |
** for a specified amount of time when a table is locked. ^The handler |
| 2282 |
** will sleep multiple times until at least "ms" milliseconds of sleeping |
| 2283 |
** have accumulated. ^After at least "ms" milliseconds of sleeping, |
| 2284 |
** the handler returns 0 which causes [sqlite3_step()] to return |
| 2285 |
** [SQLITE_BUSY]. |
| 2286 |
** |
| 2287 |
** ^Calling this routine with an argument less than or equal to zero |
| 2288 |
** turns off all busy handlers. |
| 2289 |
** |
| 2290 |
** ^(There can only be a single busy handler for a particular |
| 2291 |
** [database connection] at any given moment. If another busy handler |
| 2292 |
** was defined (using [sqlite3_busy_handler()]) prior to calling |
| 2293 |
** this routine, that other busy handler is cleared.)^ |
| 2294 |
** |
| 2295 |
** See also: [PRAGMA busy_timeout] |
| 2296 |
*/ |
| 2297 |
SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); |
| 2298 |
|
| 2299 |
/* |
| 2300 |
** CAPI3REF: Convenience Routines For Running Queries |
| 2301 |
** METHOD: sqlite3 |
| 2302 |
** |
| 2303 |
** This is a legacy interface that is preserved for backwards compatibility. |
| 2304 |
** Use of this interface is not recommended. |
| 2305 |
** |
| 2306 |
** Definition: A <b>result table</b> is memory data structure created by the |
| 2307 |
** [sqlite3_get_table()] interface. A result table records the |
| 2308 |
** complete query results from one or more queries. |
| 2309 |
** |
| 2310 |
** The table conceptually has a number of rows and columns. But |
| 2311 |
** these numbers are not part of the result table itself. These |
| 2312 |
** numbers are obtained separately. Let N be the number of rows |
| 2313 |
** and M be the number of columns. |
| 2314 |
** |
| 2315 |
** A result table is an array of pointers to zero-terminated UTF-8 strings. |
| 2316 |
** There are (N+1)*M elements in the array. The first M pointers point |
| 2317 |
** to zero-terminated strings that contain the names of the columns. |
| 2318 |
** The remaining entries all point to query results. NULL values result |
| 2319 |
** in NULL pointers. All other values are in their UTF-8 zero-terminated |
| 2320 |
** string representation as returned by [sqlite3_column_text()]. |
| 2321 |
** |
| 2322 |
** A result table might consist of one or more memory allocations. |
| 2323 |
** It is not safe to pass a result table directly to [sqlite3_free()]. |
| 2324 |
** A result table should be deallocated using [sqlite3_free_table()]. |
| 2325 |
** |
| 2326 |
** ^(As an example of the result table format, suppose a query result |
| 2327 |
** is as follows: |
| 2328 |
** |
| 2329 |
** <blockquote><pre> |
| 2330 |
** Name | Age |
| 2331 |
** ----------------------- |
| 2332 |
** Alice | 43 |
| 2333 |
** Bob | 28 |
| 2334 |
** Cindy | 21 |
| 2335 |
** </pre></blockquote> |
| 2336 |
** |
| 2337 |
** There are two column (M==2) and three rows (N==3). Thus the |
| 2338 |
** result table has 8 entries. Suppose the result table is stored |
| 2339 |
** in an array names azResult. Then azResult holds this content: |
| 2340 |
** |
| 2341 |
** <blockquote><pre> |
| 2342 |
** azResult[0] = "Name"; |
| 2343 |
** azResult[1] = "Age"; |
| 2344 |
** azResult[2] = "Alice"; |
| 2345 |
** azResult[3] = "43"; |
| 2346 |
** azResult[4] = "Bob"; |
| 2347 |
** azResult[5] = "28"; |
| 2348 |
** azResult[6] = "Cindy"; |
| 2349 |
** azResult[7] = "21"; |
| 2350 |
** </pre></blockquote>)^ |
| 2351 |
** |
| 2352 |
** ^The sqlite3_get_table() function evaluates one or more |
| 2353 |
** semicolon-separated SQL statements in the zero-terminated UTF-8 |
| 2354 |
** string of its 2nd parameter and returns a result table to the |
| 2355 |
** pointer given in its 3rd parameter. |
| 2356 |
** |
| 2357 |
** After the application has finished with the result from sqlite3_get_table(), |
| 2358 |
** it must pass the result table pointer to sqlite3_free_table() in order to |
| 2359 |
** release the memory that was malloced. Because of the way the |
| 2360 |
** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling |
| 2361 |
** function must not try to call [sqlite3_free()] directly. Only |
| 2362 |
** [sqlite3_free_table()] is able to release the memory properly and safely. |
| 2363 |
** |
| 2364 |
** The sqlite3_get_table() interface is implemented as a wrapper around |
| 2365 |
** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access |
| 2366 |
** to any internal data structures of SQLite. It uses only the public |
| 2367 |
** interface defined here. As a consequence, errors that occur in the |
| 2368 |
** wrapper layer outside of the internal [sqlite3_exec()] call are not |
| 2369 |
** reflected in subsequent calls to [sqlite3_errcode()] or |
| 2370 |
** [sqlite3_errmsg()]. |
| 2371 |
*/ |
| 2372 |
SQLITE_API int sqlite3_get_table( |
| 2373 |
sqlite3 *db, /* An open database */ |
| 2374 |
const char *zSql, /* SQL to be evaluated */ |
| 2375 |
char ***pazResult, /* Results of the query */ |
| 2376 |
int *pnRow, /* Number of result rows written here */ |
| 2377 |
int *pnColumn, /* Number of result columns written here */ |
| 2378 |
char **pzErrmsg /* Error msg written here */ |
| 2379 |
); |
| 2380 |
SQLITE_API void sqlite3_free_table(char **result); |
| 2381 |
|
| 2382 |
/* |
| 2383 |
** CAPI3REF: Formatted String Printing Functions |
| 2384 |
** |
| 2385 |
** These routines are work-alikes of the "printf()" family of functions |
| 2386 |
** from the standard C library. |
| 2387 |
** These routines understand most of the common K&R formatting options, |
| 2388 |
** plus some additional non-standard formats, detailed below. |
| 2389 |
** Note that some of the more obscure formatting options from recent |
| 2390 |
** C-library standards are omitted from this implementation. |
| 2391 |
** |
| 2392 |
** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their |
| 2393 |
** results into memory obtained from [sqlite3_malloc()]. |
| 2394 |
** The strings returned by these two routines should be |
| 2395 |
** released by [sqlite3_free()]. ^Both routines return a |
| 2396 |
** NULL pointer if [sqlite3_malloc()] is unable to allocate enough |
| 2397 |
** memory to hold the resulting string. |
| 2398 |
** |
| 2399 |
** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from |
| 2400 |
** the standard C library. The result is written into the |
| 2401 |
** buffer supplied as the second parameter whose size is given by |
| 2402 |
** the first parameter. Note that the order of the |
| 2403 |
** first two parameters is reversed from snprintf().)^ This is an |
| 2404 |
** historical accident that cannot be fixed without breaking |
| 2405 |
** backwards compatibility. ^(Note also that sqlite3_snprintf() |
| 2406 |
** returns a pointer to its buffer instead of the number of |
| 2407 |
** characters actually written into the buffer.)^ We admit that |
| 2408 |
** the number of characters written would be a more useful return |
| 2409 |
** value but we cannot change the implementation of sqlite3_snprintf() |
| 2410 |
** now without breaking compatibility. |
| 2411 |
** |
| 2412 |
** ^As long as the buffer size is greater than zero, sqlite3_snprintf() |
| 2413 |
** guarantees that the buffer is always zero-terminated. ^The first |
| 2414 |
** parameter "n" is the total size of the buffer, including space for |
| 2415 |
** the zero terminator. So the longest string that can be completely |
| 2416 |
** written will be n-1 characters. |
| 2417 |
** |
| 2418 |
** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). |
| 2419 |
** |
| 2420 |
** These routines all implement some additional formatting |
| 2421 |
** options that are useful for constructing SQL statements. |
| 2422 |
** All of the usual printf() formatting options apply. In addition, there |
| 2423 |
** is are "%q", "%Q", "%w" and "%z" options. |
| 2424 |
** |
| 2425 |
** ^(The %q option works like %s in that it substitutes a nul-terminated |
| 2426 |
** string from the argument list. But %q also doubles every '\'' character. |
| 2427 |
** %q is designed for use inside a string literal.)^ By doubling each '\'' |
| 2428 |
** character it escapes that character and allows it to be inserted into |
| 2429 |
** the string. |
| 2430 |
** |
| 2431 |
** For example, assume the string variable zText contains text as follows: |
| 2432 |
** |
| 2433 |
** <blockquote><pre> |
| 2434 |
** char *zText = "It's a happy day!"; |
| 2435 |
** </pre></blockquote> |
| 2436 |
** |
| 2437 |
** One can use this text in an SQL statement as follows: |
| 2438 |
** |
| 2439 |
** <blockquote><pre> |
| 2440 |
** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); |
| 2441 |
** sqlite3_exec(db, zSQL, 0, 0, 0); |
| 2442 |
** sqlite3_free(zSQL); |
| 2443 |
** </pre></blockquote> |
| 2444 |
** |
| 2445 |
** Because the %q format string is used, the '\'' character in zText |
| 2446 |
** is escaped and the SQL generated is as follows: |
| 2447 |
** |
| 2448 |
** <blockquote><pre> |
| 2449 |
** INSERT INTO table1 VALUES('It''s a happy day!') |
| 2450 |
** </pre></blockquote> |
| 2451 |
** |
| 2452 |
** This is correct. Had we used %s instead of %q, the generated SQL |
| 2453 |
** would have looked like this: |
| 2454 |
** |
| 2455 |
** <blockquote><pre> |
| 2456 |
** INSERT INTO table1 VALUES('It's a happy day!'); |
| 2457 |
** </pre></blockquote> |
| 2458 |
** |
| 2459 |
** This second example is an SQL syntax error. As a general rule you should |
| 2460 |
** always use %q instead of %s when inserting text into a string literal. |
| 2461 |
** |
| 2462 |
** ^(The %Q option works like %q except it also adds single quotes around |
| 2463 |
** the outside of the total string. Additionally, if the parameter in the |
| 2464 |
** argument list is a NULL pointer, %Q substitutes the text "NULL" (without |
| 2465 |
** single quotes).)^ So, for example, one could say: |
| 2466 |
** |
| 2467 |
** <blockquote><pre> |
| 2468 |
** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); |
| 2469 |
** sqlite3_exec(db, zSQL, 0, 0, 0); |
| 2470 |
** sqlite3_free(zSQL); |
| 2471 |
** </pre></blockquote> |
| 2472 |
** |
| 2473 |
** The code above will render a correct SQL statement in the zSQL |
| 2474 |
** variable even if the zText variable is a NULL pointer. |
| 2475 |
** |
| 2476 |
** ^(The "%w" formatting option is like "%q" except that it expects to |
| 2477 |
** be contained within double-quotes instead of single quotes, and it |
| 2478 |
** escapes the double-quote character instead of the single-quote |
| 2479 |
** character.)^ The "%w" formatting option is intended for safely inserting |
| 2480 |
** table and column names into a constructed SQL statement. |
| 2481 |
** |
| 2482 |
** ^(The "%z" formatting option works like "%s" but with the |
| 2483 |
** addition that after the string has been read and copied into |
| 2484 |
** the result, [sqlite3_free()] is called on the input string.)^ |
| 2485 |
*/ |
| 2486 |
SQLITE_API char *sqlite3_mprintf(const char*,...); |
| 2487 |
SQLITE_API char *sqlite3_vmprintf(const char*, va_list); |
| 2488 |
SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); |
| 2489 |
SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list); |
| 2490 |
|
| 2491 |
/* |
| 2492 |
** CAPI3REF: Memory Allocation Subsystem |
| 2493 |
** |
| 2494 |
** The SQLite core uses these three routines for all of its own |
| 2495 |
** internal memory allocation needs. "Core" in the previous sentence |
| 2496 |
** does not include operating-system specific VFS implementation. The |
| 2497 |
** Windows VFS uses native malloc() and free() for some operations. |
| 2498 |
** |
| 2499 |
** ^The sqlite3_malloc() routine returns a pointer to a block |
| 2500 |
** of memory at least N bytes in length, where N is the parameter. |
| 2501 |
** ^If sqlite3_malloc() is unable to obtain sufficient free |
| 2502 |
** memory, it returns a NULL pointer. ^If the parameter N to |
| 2503 |
** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns |
| 2504 |
** a NULL pointer. |
| 2505 |
** |
| 2506 |
** ^The sqlite3_malloc64(N) routine works just like |
| 2507 |
** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead |
| 2508 |
** of a signed 32-bit integer. |
| 2509 |
** |
| 2510 |
** ^Calling sqlite3_free() with a pointer previously returned |
| 2511 |
** by sqlite3_malloc() or sqlite3_realloc() releases that memory so |
| 2512 |
** that it might be reused. ^The sqlite3_free() routine is |
| 2513 |
** a no-op if is called with a NULL pointer. Passing a NULL pointer |
| 2514 |
** to sqlite3_free() is harmless. After being freed, memory |
| 2515 |
** should neither be read nor written. Even reading previously freed |
| 2516 |
** memory might result in a segmentation fault or other severe error. |
| 2517 |
** Memory corruption, a segmentation fault, or other severe error |
| 2518 |
** might result if sqlite3_free() is called with a non-NULL pointer that |
| 2519 |
** was not obtained from sqlite3_malloc() or sqlite3_realloc(). |
| 2520 |
** |
| 2521 |
** ^The sqlite3_realloc(X,N) interface attempts to resize a |
| 2522 |
** prior memory allocation X to be at least N bytes. |
| 2523 |
** ^If the X parameter to sqlite3_realloc(X,N) |
| 2524 |
** is a NULL pointer then its behavior is identical to calling |
| 2525 |
** sqlite3_malloc(N). |
| 2526 |
** ^If the N parameter to sqlite3_realloc(X,N) is zero or |
| 2527 |
** negative then the behavior is exactly the same as calling |
| 2528 |
** sqlite3_free(X). |
| 2529 |
** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation |
| 2530 |
** of at least N bytes in size or NULL if insufficient memory is available. |
| 2531 |
** ^If M is the size of the prior allocation, then min(N,M) bytes |
| 2532 |
** of the prior allocation are copied into the beginning of buffer returned |
| 2533 |
** by sqlite3_realloc(X,N) and the prior allocation is freed. |
| 2534 |
** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the |
| 2535 |
** prior allocation is not freed. |
| 2536 |
** |
| 2537 |
** ^The sqlite3_realloc64(X,N) interfaces works the same as |
| 2538 |
** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead |
| 2539 |
** of a 32-bit signed integer. |
| 2540 |
** |
| 2541 |
** ^If X is a memory allocation previously obtained from sqlite3_malloc(), |
| 2542 |
** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then |
| 2543 |
** sqlite3_msize(X) returns the size of that memory allocation in bytes. |
| 2544 |
** ^The value returned by sqlite3_msize(X) might be larger than the number |
| 2545 |
** of bytes requested when X was allocated. ^If X is a NULL pointer then |
| 2546 |
** sqlite3_msize(X) returns zero. If X points to something that is not |
| 2547 |
** the beginning of memory allocation, or if it points to a formerly |
| 2548 |
** valid memory allocation that has now been freed, then the behavior |
| 2549 |
** of sqlite3_msize(X) is undefined and possibly harmful. |
| 2550 |
** |
| 2551 |
** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(), |
| 2552 |
** sqlite3_malloc64(), and sqlite3_realloc64() |
| 2553 |
** is always aligned to at least an 8 byte boundary, or to a |
| 2554 |
** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time |
| 2555 |
** option is used. |
| 2556 |
** |
| 2557 |
** In SQLite version 3.5.0 and 3.5.1, it was possible to define |
| 2558 |
** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in |
| 2559 |
** implementation of these routines to be omitted. That capability |
| 2560 |
** is no longer provided. Only built-in memory allocators can be used. |
| 2561 |
** |
| 2562 |
** Prior to SQLite version 3.7.10, the Windows OS interface layer called |
| 2563 |
** the system malloc() and free() directly when converting |
| 2564 |
** filenames between the UTF-8 encoding used by SQLite |
| 2565 |
** and whatever filename encoding is used by the particular Windows |
| 2566 |
** installation. Memory allocation errors were detected, but |
| 2567 |
** they were reported back as [SQLITE_CANTOPEN] or |
| 2568 |
** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. |
| 2569 |
** |
| 2570 |
** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] |
| 2571 |
** must be either NULL or else pointers obtained from a prior |
| 2572 |
** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have |
| 2573 |
** not yet been released. |
| 2574 |
** |
| 2575 |
** The application must not read or write any part of |
| 2576 |
** a block of memory after it has been released using |
| 2577 |
** [sqlite3_free()] or [sqlite3_realloc()]. |
| 2578 |
*/ |
| 2579 |
SQLITE_API void *sqlite3_malloc(int); |
| 2580 |
SQLITE_API void *sqlite3_malloc64(sqlite3_uint64); |
| 2581 |
SQLITE_API void *sqlite3_realloc(void*, int); |
| 2582 |
SQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64); |
| 2583 |
SQLITE_API void sqlite3_free(void*); |
| 2584 |
SQLITE_API sqlite3_uint64 sqlite3_msize(void*); |
| 2585 |
|
| 2586 |
/* |
| 2587 |
** CAPI3REF: Memory Allocator Statistics |
| 2588 |
** |
| 2589 |
** SQLite provides these two interfaces for reporting on the status |
| 2590 |
** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] |
| 2591 |
** routines, which form the built-in memory allocation subsystem. |
| 2592 |
** |
| 2593 |
** ^The [sqlite3_memory_used()] routine returns the number of bytes |
| 2594 |
** of memory currently outstanding (malloced but not freed). |
| 2595 |
** ^The [sqlite3_memory_highwater()] routine returns the maximum |
| 2596 |
** value of [sqlite3_memory_used()] since the high-water mark |
| 2597 |
** was last reset. ^The values returned by [sqlite3_memory_used()] and |
| 2598 |
** [sqlite3_memory_highwater()] include any overhead |
| 2599 |
** added by SQLite in its implementation of [sqlite3_malloc()], |
| 2600 |
** but not overhead added by the any underlying system library |
| 2601 |
** routines that [sqlite3_malloc()] may call. |
| 2602 |
** |
| 2603 |
** ^The memory high-water mark is reset to the current value of |
| 2604 |
** [sqlite3_memory_used()] if and only if the parameter to |
| 2605 |
** [sqlite3_memory_highwater()] is true. ^The value returned |
| 2606 |
** by [sqlite3_memory_highwater(1)] is the high-water mark |
| 2607 |
** prior to the reset. |
| 2608 |
*/ |
| 2609 |
SQLITE_API sqlite3_int64 sqlite3_memory_used(void); |
| 2610 |
SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); |
| 2611 |
|
| 2612 |
/* |
| 2613 |
** CAPI3REF: Pseudo-Random Number Generator |
| 2614 |
** |
| 2615 |
** SQLite contains a high-quality pseudo-random number generator (PRNG) used to |
| 2616 |
** select random [ROWID | ROWIDs] when inserting new records into a table that |
| 2617 |
** already uses the largest possible [ROWID]. The PRNG is also used for |
| 2618 |
** the build-in random() and randomblob() SQL functions. This interface allows |
| 2619 |
** applications to access the same PRNG for other purposes. |
| 2620 |
** |
| 2621 |
** ^A call to this routine stores N bytes of randomness into buffer P. |
| 2622 |
** ^The P parameter can be a NULL pointer. |
| 2623 |
** |
| 2624 |
** ^If this routine has not been previously called or if the previous |
| 2625 |
** call had N less than one or a NULL pointer for P, then the PRNG is |
| 2626 |
** seeded using randomness obtained from the xRandomness method of |
| 2627 |
** the default [sqlite3_vfs] object. |
| 2628 |
** ^If the previous call to this routine had an N of 1 or more and a |
| 2629 |
** non-NULL P then the pseudo-randomness is generated |
| 2630 |
** internally and without recourse to the [sqlite3_vfs] xRandomness |
| 2631 |
** method. |
| 2632 |
*/ |
| 2633 |
SQLITE_API void sqlite3_randomness(int N, void *P); |
| 2634 |
|
| 2635 |
/* |
| 2636 |
** CAPI3REF: Compile-Time Authorization Callbacks |
| 2637 |
** METHOD: sqlite3 |
| 2638 |
** |
| 2639 |
** ^This routine registers an authorizer callback with a particular |
| 2640 |
** [database connection], supplied in the first argument. |
| 2641 |
** ^The authorizer callback is invoked as SQL statements are being compiled |
| 2642 |
** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], |
| 2643 |
** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various |
| 2644 |
** points during the compilation process, as logic is being created |
| 2645 |
** to perform various actions, the authorizer callback is invoked to |
| 2646 |
** see if those actions are allowed. ^The authorizer callback should |
| 2647 |
** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the |
| 2648 |
** specific action but allow the SQL statement to continue to be |
| 2649 |
** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be |
| 2650 |
** rejected with an error. ^If the authorizer callback returns |
| 2651 |
** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] |
| 2652 |
** then the [sqlite3_prepare_v2()] or equivalent call that triggered |
| 2653 |
** the authorizer will fail with an error message. |
| 2654 |
** |
| 2655 |
** When the callback returns [SQLITE_OK], that means the operation |
| 2656 |
** requested is ok. ^When the callback returns [SQLITE_DENY], the |
| 2657 |
** [sqlite3_prepare_v2()] or equivalent call that triggered the |
| 2658 |
** authorizer will fail with an error message explaining that |
| 2659 |
** access is denied. |
| 2660 |
** |
| 2661 |
** ^The first parameter to the authorizer callback is a copy of the third |
| 2662 |
** parameter to the sqlite3_set_authorizer() interface. ^The second parameter |
| 2663 |
** to the callback is an integer [SQLITE_COPY | action code] that specifies |
| 2664 |
** the particular action to be authorized. ^The third through sixth parameters |
| 2665 |
** to the callback are zero-terminated strings that contain additional |
| 2666 |
** details about the action to be authorized. |
| 2667 |
** |
| 2668 |
** ^If the action code is [SQLITE_READ] |
| 2669 |
** and the callback returns [SQLITE_IGNORE] then the |
| 2670 |
** [prepared statement] statement is constructed to substitute |
| 2671 |
** a NULL value in place of the table column that would have |
| 2672 |
** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] |
| 2673 |
** return can be used to deny an untrusted user access to individual |
| 2674 |
** columns of a table. |
| 2675 |
** ^If the action code is [SQLITE_DELETE] and the callback returns |
| 2676 |
** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the |
| 2677 |
** [truncate optimization] is disabled and all rows are deleted individually. |
| 2678 |
** |
| 2679 |
** An authorizer is used when [sqlite3_prepare | preparing] |
| 2680 |
** SQL statements from an untrusted source, to ensure that the SQL statements |
| 2681 |
** do not try to access data they are not allowed to see, or that they do not |
| 2682 |
** try to execute malicious statements that damage the database. For |
| 2683 |
** example, an application may allow a user to enter arbitrary |
| 2684 |
** SQL queries for evaluation by a database. But the application does |
| 2685 |
** not want the user to be able to make arbitrary changes to the |
| 2686 |
** database. An authorizer could then be put in place while the |
| 2687 |
** user-entered SQL is being [sqlite3_prepare | prepared] that |
| 2688 |
** disallows everything except [SELECT] statements. |
| 2689 |
** |
| 2690 |
** Applications that need to process SQL from untrusted sources |
| 2691 |
** might also consider lowering resource limits using [sqlite3_limit()] |
| 2692 |
** and limiting database size using the [max_page_count] [PRAGMA] |
| 2693 |
** in addition to using an authorizer. |
| 2694 |
** |
| 2695 |
** ^(Only a single authorizer can be in place on a database connection |
| 2696 |
** at a time. Each call to sqlite3_set_authorizer overrides the |
| 2697 |
** previous call.)^ ^Disable the authorizer by installing a NULL callback. |
| 2698 |
** The authorizer is disabled by default. |
| 2699 |
** |
| 2700 |
** The authorizer callback must not do anything that will modify |
| 2701 |
** the database connection that invoked the authorizer callback. |
| 2702 |
** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
| 2703 |
** database connections for the meaning of "modify" in this paragraph. |
| 2704 |
** |
| 2705 |
** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the |
| 2706 |
** statement might be re-prepared during [sqlite3_step()] due to a |
| 2707 |
** schema change. Hence, the application should ensure that the |
| 2708 |
** correct authorizer callback remains in place during the [sqlite3_step()]. |
| 2709 |
** |
| 2710 |
** ^Note that the authorizer callback is invoked only during |
| 2711 |
** [sqlite3_prepare()] or its variants. Authorization is not |
| 2712 |
** performed during statement evaluation in [sqlite3_step()], unless |
| 2713 |
** as stated in the previous paragraph, sqlite3_step() invokes |
| 2714 |
** sqlite3_prepare_v2() to reprepare a statement after a schema change. |
| 2715 |
*/ |
| 2716 |
SQLITE_API int sqlite3_set_authorizer( |
| 2717 |
sqlite3*, |
| 2718 |
int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), |
| 2719 |
void *pUserData |
| 2720 |
); |
| 2721 |
|
| 2722 |
/* |
| 2723 |
** CAPI3REF: Authorizer Return Codes |
| 2724 |
** |
| 2725 |
** The [sqlite3_set_authorizer | authorizer callback function] must |
| 2726 |
** return either [SQLITE_OK] or one of these two constants in order |
| 2727 |
** to signal SQLite whether or not the action is permitted. See the |
| 2728 |
** [sqlite3_set_authorizer | authorizer documentation] for additional |
| 2729 |
** information. |
| 2730 |
** |
| 2731 |
** Note that SQLITE_IGNORE is also used as a [conflict resolution mode] |
| 2732 |
** returned from the [sqlite3_vtab_on_conflict()] interface. |
| 2733 |
*/ |
| 2734 |
#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ |
| 2735 |
#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ |
| 2736 |
|
| 2737 |
/* |
| 2738 |
** CAPI3REF: Authorizer Action Codes |
| 2739 |
** |
| 2740 |
** The [sqlite3_set_authorizer()] interface registers a callback function |
| 2741 |
** that is invoked to authorize certain SQL statement actions. The |
| 2742 |
** second parameter to the callback is an integer code that specifies |
| 2743 |
** what action is being authorized. These are the integer action codes that |
| 2744 |
** the authorizer callback may be passed. |
| 2745 |
** |
| 2746 |
** These action code values signify what kind of operation is to be |
| 2747 |
** authorized. The 3rd and 4th parameters to the authorization |
| 2748 |
** callback function will be parameters or NULL depending on which of these |
| 2749 |
** codes is used as the second parameter. ^(The 5th parameter to the |
| 2750 |
** authorizer callback is the name of the database ("main", "temp", |
| 2751 |
** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback |
| 2752 |
** is the name of the inner-most trigger or view that is responsible for |
| 2753 |
** the access attempt or NULL if this access attempt is directly from |
| 2754 |
** top-level SQL code. |
| 2755 |
*/ |
| 2756 |
/******************************************* 3rd ************ 4th ***********/ |
| 2757 |
#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ |
| 2758 |
#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ |
| 2759 |
#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ |
| 2760 |
#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ |
| 2761 |
#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ |
| 2762 |
#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ |
| 2763 |
#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ |
| 2764 |
#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ |
| 2765 |
#define SQLITE_DELETE 9 /* Table Name NULL */ |
| 2766 |
#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ |
| 2767 |
#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ |
| 2768 |
#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ |
| 2769 |
#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ |
| 2770 |
#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ |
| 2771 |
#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ |
| 2772 |
#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ |
| 2773 |
#define SQLITE_DROP_VIEW 17 /* View Name NULL */ |
| 2774 |
#define SQLITE_INSERT 18 /* Table Name NULL */ |
| 2775 |
#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ |
| 2776 |
#define SQLITE_READ 20 /* Table Name Column Name */ |
| 2777 |
#define SQLITE_SELECT 21 /* NULL NULL */ |
| 2778 |
#define SQLITE_TRANSACTION 22 /* Operation NULL */ |
| 2779 |
#define SQLITE_UPDATE 23 /* Table Name Column Name */ |
| 2780 |
#define SQLITE_ATTACH 24 /* Filename NULL */ |
| 2781 |
#define SQLITE_DETACH 25 /* Database Name NULL */ |
| 2782 |
#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ |
| 2783 |
#define SQLITE_REINDEX 27 /* Index Name NULL */ |
| 2784 |
#define SQLITE_ANALYZE 28 /* Table Name NULL */ |
| 2785 |
#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ |
| 2786 |
#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ |
| 2787 |
#define SQLITE_FUNCTION 31 /* NULL Function Name */ |
| 2788 |
#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ |
| 2789 |
#define SQLITE_COPY 0 /* No longer used */ |
| 2790 |
#define SQLITE_RECURSIVE 33 /* NULL NULL */ |
| 2791 |
|
| 2792 |
/* |
| 2793 |
** CAPI3REF: Tracing And Profiling Functions |
| 2794 |
** METHOD: sqlite3 |
| 2795 |
** |
| 2796 |
** These routines are deprecated. Use the [sqlite3_trace_v2()] interface |
| 2797 |
** instead of the routines described here. |
| 2798 |
** |
| 2799 |
** These routines register callback functions that can be used for |
| 2800 |
** tracing and profiling the execution of SQL statements. |
| 2801 |
** |
| 2802 |
** ^The callback function registered by sqlite3_trace() is invoked at |
| 2803 |
** various times when an SQL statement is being run by [sqlite3_step()]. |
| 2804 |
** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the |
| 2805 |
** SQL statement text as the statement first begins executing. |
| 2806 |
** ^(Additional sqlite3_trace() callbacks might occur |
| 2807 |
** as each triggered subprogram is entered. The callbacks for triggers |
| 2808 |
** contain a UTF-8 SQL comment that identifies the trigger.)^ |
| 2809 |
** |
| 2810 |
** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit |
| 2811 |
** the length of [bound parameter] expansion in the output of sqlite3_trace(). |
| 2812 |
** |
| 2813 |
** ^The callback function registered by sqlite3_profile() is invoked |
| 2814 |
** as each SQL statement finishes. ^The profile callback contains |
| 2815 |
** the original statement text and an estimate of wall-clock time |
| 2816 |
** of how long that statement took to run. ^The profile callback |
| 2817 |
** time is in units of nanoseconds, however the current implementation |
| 2818 |
** is only capable of millisecond resolution so the six least significant |
| 2819 |
** digits in the time are meaningless. Future versions of SQLite |
| 2820 |
** might provide greater resolution on the profiler callback. The |
| 2821 |
** sqlite3_profile() function is considered experimental and is |
| 2822 |
** subject to change in future versions of SQLite. |
| 2823 |
*/ |
| 2824 |
SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*, |
| 2825 |
void(*xTrace)(void*,const char*), void*); |
| 2826 |
SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*, |
| 2827 |
void(*xProfile)(void*,const char*,sqlite3_uint64), void*); |
| 2828 |
|
| 2829 |
/* |
| 2830 |
** CAPI3REF: SQL Trace Event Codes |
| 2831 |
** KEYWORDS: SQLITE_TRACE |
| 2832 |
** |
| 2833 |
** These constants identify classes of events that can be monitored |
| 2834 |
** using the [sqlite3_trace_v2()] tracing logic. The third argument |
| 2835 |
** to [sqlite3_trace_v2()] is an OR-ed combination of one or more of |
| 2836 |
** the following constants. ^The first argument to the trace callback |
| 2837 |
** is one of the following constants. |
| 2838 |
** |
| 2839 |
** New tracing constants may be added in future releases. |
| 2840 |
** |
| 2841 |
** ^A trace callback has four arguments: xCallback(T,C,P,X). |
| 2842 |
** ^The T argument is one of the integer type codes above. |
| 2843 |
** ^The C argument is a copy of the context pointer passed in as the |
| 2844 |
** fourth argument to [sqlite3_trace_v2()]. |
| 2845 |
** The P and X arguments are pointers whose meanings depend on T. |
| 2846 |
** |
| 2847 |
** <dl> |
| 2848 |
** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt> |
| 2849 |
** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement |
| 2850 |
** first begins running and possibly at other times during the |
| 2851 |
** execution of the prepared statement, such as at the start of each |
| 2852 |
** trigger subprogram. ^The P argument is a pointer to the |
| 2853 |
** [prepared statement]. ^The X argument is a pointer to a string which |
| 2854 |
** is the unexpanded SQL text of the prepared statement or an SQL comment |
| 2855 |
** that indicates the invocation of a trigger. ^The callback can compute |
| 2856 |
** the same text that would have been returned by the legacy [sqlite3_trace()] |
| 2857 |
** interface by using the X argument when X begins with "--" and invoking |
| 2858 |
** [sqlite3_expanded_sql(P)] otherwise. |
| 2859 |
** |
| 2860 |
** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt> |
| 2861 |
** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same |
| 2862 |
** information as is provided by the [sqlite3_profile()] callback. |
| 2863 |
** ^The P argument is a pointer to the [prepared statement] and the |
| 2864 |
** X argument points to a 64-bit integer which is the estimated of |
| 2865 |
** the number of nanosecond that the prepared statement took to run. |
| 2866 |
** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes. |
| 2867 |
** |
| 2868 |
** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt> |
| 2869 |
** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared |
| 2870 |
** statement generates a single row of result. |
| 2871 |
** ^The P argument is a pointer to the [prepared statement] and the |
| 2872 |
** X argument is unused. |
| 2873 |
** |
| 2874 |
** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt> |
| 2875 |
** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database |
| 2876 |
** connection closes. |
| 2877 |
** ^The P argument is a pointer to the [database connection] object |
| 2878 |
** and the X argument is unused. |
| 2879 |
** </dl> |
| 2880 |
*/ |
| 2881 |
#define SQLITE_TRACE_STMT 0x01 |
| 2882 |
#define SQLITE_TRACE_PROFILE 0x02 |
| 2883 |
#define SQLITE_TRACE_ROW 0x04 |
| 2884 |
#define SQLITE_TRACE_CLOSE 0x08 |
| 2885 |
|
| 2886 |
/* |
| 2887 |
** CAPI3REF: SQL Trace Hook |
| 2888 |
** METHOD: sqlite3 |
| 2889 |
** |
| 2890 |
** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback |
| 2891 |
** function X against [database connection] D, using property mask M |
| 2892 |
** and context pointer P. ^If the X callback is |
| 2893 |
** NULL or if the M mask is zero, then tracing is disabled. The |
| 2894 |
** M argument should be the bitwise OR-ed combination of |
| 2895 |
** zero or more [SQLITE_TRACE] constants. |
| 2896 |
** |
| 2897 |
** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides |
| 2898 |
** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2(). |
| 2899 |
** |
| 2900 |
** ^The X callback is invoked whenever any of the events identified by |
| 2901 |
** mask M occur. ^The integer return value from the callback is currently |
| 2902 |
** ignored, though this may change in future releases. Callback |
| 2903 |
** implementations should return zero to ensure future compatibility. |
| 2904 |
** |
| 2905 |
** ^A trace callback is invoked with four arguments: callback(T,C,P,X). |
| 2906 |
** ^The T argument is one of the [SQLITE_TRACE] |
| 2907 |
** constants to indicate why the callback was invoked. |
| 2908 |
** ^The C argument is a copy of the context pointer. |
| 2909 |
** The P and X arguments are pointers whose meanings depend on T. |
| 2910 |
** |
| 2911 |
** The sqlite3_trace_v2() interface is intended to replace the legacy |
| 2912 |
** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which |
| 2913 |
** are deprecated. |
| 2914 |
*/ |
| 2915 |
SQLITE_API int sqlite3_trace_v2( |
| 2916 |
sqlite3*, |
| 2917 |
unsigned uMask, |
| 2918 |
int(*xCallback)(unsigned,void*,void*,void*), |
| 2919 |
void *pCtx |
| 2920 |
); |
| 2921 |
|
| 2922 |
/* |
| 2923 |
** CAPI3REF: Query Progress Callbacks |
| 2924 |
** METHOD: sqlite3 |
| 2925 |
** |
| 2926 |
** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback |
| 2927 |
** function X to be invoked periodically during long running calls to |
| 2928 |
** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for |
| 2929 |
** database connection D. An example use for this |
| 2930 |
** interface is to keep a GUI updated during a large query. |
| 2931 |
** |
| 2932 |
** ^The parameter P is passed through as the only parameter to the |
| 2933 |
** callback function X. ^The parameter N is the approximate number of |
| 2934 |
** [virtual machine instructions] that are evaluated between successive |
| 2935 |
** invocations of the callback X. ^If N is less than one then the progress |
| 2936 |
** handler is disabled. |
| 2937 |
** |
| 2938 |
** ^Only a single progress handler may be defined at one time per |
| 2939 |
** [database connection]; setting a new progress handler cancels the |
| 2940 |
** old one. ^Setting parameter X to NULL disables the progress handler. |
| 2941 |
** ^The progress handler is also disabled by setting N to a value less |
| 2942 |
** than 1. |
| 2943 |
** |
| 2944 |
** ^If the progress callback returns non-zero, the operation is |
| 2945 |
** interrupted. This feature can be used to implement a |
| 2946 |
** "Cancel" button on a GUI progress dialog box. |
| 2947 |
** |
| 2948 |
** The progress handler callback must not do anything that will modify |
| 2949 |
** the database connection that invoked the progress handler. |
| 2950 |
** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
| 2951 |
** database connections for the meaning of "modify" in this paragraph. |
| 2952 |
** |
| 2953 |
*/ |
| 2954 |
SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); |
| 2955 |
|
| 2956 |
/* |
| 2957 |
** CAPI3REF: Opening A New Database Connection |
| 2958 |
** CONSTRUCTOR: sqlite3 |
| 2959 |
** |
| 2960 |
** ^These routines open an SQLite database file as specified by the |
| 2961 |
** filename argument. ^The filename argument is interpreted as UTF-8 for |
| 2962 |
** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte |
| 2963 |
** order for sqlite3_open16(). ^(A [database connection] handle is usually |
| 2964 |
** returned in *ppDb, even if an error occurs. The only exception is that |
| 2965 |
** if SQLite is unable to allocate memory to hold the [sqlite3] object, |
| 2966 |
** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] |
| 2967 |
** object.)^ ^(If the database is opened (and/or created) successfully, then |
| 2968 |
** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The |
| 2969 |
** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain |
| 2970 |
** an English language description of the error following a failure of any |
| 2971 |
** of the sqlite3_open() routines. |
| 2972 |
** |
| 2973 |
** ^The default encoding will be UTF-8 for databases created using |
| 2974 |
** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases |
| 2975 |
** created using sqlite3_open16() will be UTF-16 in the native byte order. |
| 2976 |
** |
| 2977 |
** Whether or not an error occurs when it is opened, resources |
| 2978 |
** associated with the [database connection] handle should be released by |
| 2979 |
** passing it to [sqlite3_close()] when it is no longer required. |
| 2980 |
** |
| 2981 |
** The sqlite3_open_v2() interface works like sqlite3_open() |
| 2982 |
** except that it accepts two additional parameters for additional control |
| 2983 |
** over the new database connection. ^(The flags parameter to |
| 2984 |
** sqlite3_open_v2() can take one of |
| 2985 |
** the following three values, optionally combined with the |
| 2986 |
** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], |
| 2987 |
** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ |
| 2988 |
** |
| 2989 |
** <dl> |
| 2990 |
** ^(<dt>[SQLITE_OPEN_READONLY]</dt> |
| 2991 |
** <dd>The database is opened in read-only mode. If the database does not |
| 2992 |
** already exist, an error is returned.</dd>)^ |
| 2993 |
** |
| 2994 |
** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> |
| 2995 |
** <dd>The database is opened for reading and writing if possible, or reading |
| 2996 |
** only if the file is write protected by the operating system. In either |
| 2997 |
** case the database must already exist, otherwise an error is returned.</dd>)^ |
| 2998 |
** |
| 2999 |
** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> |
| 3000 |
** <dd>The database is opened for reading and writing, and is created if |
| 3001 |
** it does not already exist. This is the behavior that is always used for |
| 3002 |
** sqlite3_open() and sqlite3_open16().</dd>)^ |
| 3003 |
** </dl> |
| 3004 |
** |
| 3005 |
** If the 3rd parameter to sqlite3_open_v2() is not one of the |
| 3006 |
** combinations shown above optionally combined with other |
| 3007 |
** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] |
| 3008 |
** then the behavior is undefined. |
| 3009 |
** |
| 3010 |
** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection |
| 3011 |
** opens in the multi-thread [threading mode] as long as the single-thread |
| 3012 |
** mode has not been set at compile-time or start-time. ^If the |
| 3013 |
** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens |
| 3014 |
** in the serialized [threading mode] unless single-thread was |
| 3015 |
** previously selected at compile-time or start-time. |
| 3016 |
** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be |
| 3017 |
** eligible to use [shared cache mode], regardless of whether or not shared |
| 3018 |
** cache is enabled using [sqlite3_enable_shared_cache()]. ^The |
| 3019 |
** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not |
| 3020 |
** participate in [shared cache mode] even if it is enabled. |
| 3021 |
** |
| 3022 |
** ^The fourth parameter to sqlite3_open_v2() is the name of the |
| 3023 |
** [sqlite3_vfs] object that defines the operating system interface that |
| 3024 |
** the new database connection should use. ^If the fourth parameter is |
| 3025 |
** a NULL pointer then the default [sqlite3_vfs] object is used. |
| 3026 |
** |
| 3027 |
** ^If the filename is ":memory:", then a private, temporary in-memory database |
| 3028 |
** is created for the connection. ^This in-memory database will vanish when |
| 3029 |
** the database connection is closed. Future versions of SQLite might |
| 3030 |
** make use of additional special filenames that begin with the ":" character. |
| 3031 |
** It is recommended that when a database filename actually does begin with |
| 3032 |
** a ":" character you should prefix the filename with a pathname such as |
| 3033 |
** "./" to avoid ambiguity. |
| 3034 |
** |
| 3035 |
** ^If the filename is an empty string, then a private, temporary |
| 3036 |
** on-disk database will be created. ^This private database will be |
| 3037 |
** automatically deleted as soon as the database connection is closed. |
| 3038 |
** |
| 3039 |
** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3> |
| 3040 |
** |
| 3041 |
** ^If [URI filename] interpretation is enabled, and the filename argument |
| 3042 |
** begins with "file:", then the filename is interpreted as a URI. ^URI |
| 3043 |
** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is |
| 3044 |
** set in the fourth argument to sqlite3_open_v2(), or if it has |
| 3045 |
** been enabled globally using the [SQLITE_CONFIG_URI] option with the |
| 3046 |
** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. |
| 3047 |
** As of SQLite version 3.7.7, URI filename interpretation is turned off |
| 3048 |
** by default, but future releases of SQLite might enable URI filename |
| 3049 |
** interpretation by default. See "[URI filenames]" for additional |
| 3050 |
** information. |
| 3051 |
** |
| 3052 |
** URI filenames are parsed according to RFC 3986. ^If the URI contains an |
| 3053 |
** authority, then it must be either an empty string or the string |
| 3054 |
** "localhost". ^If the authority is not an empty string or "localhost", an |
| 3055 |
** error is returned to the caller. ^The fragment component of a URI, if |
| 3056 |
** present, is ignored. |
| 3057 |
** |
| 3058 |
** ^SQLite uses the path component of the URI as the name of the disk file |
| 3059 |
** which contains the database. ^If the path begins with a '/' character, |
| 3060 |
** then it is interpreted as an absolute path. ^If the path does not begin |
| 3061 |
** with a '/' (meaning that the authority section is omitted from the URI) |
| 3062 |
** then the path is interpreted as a relative path. |
| 3063 |
** ^(On windows, the first component of an absolute path |
| 3064 |
** is a drive specification (e.g. "C:").)^ |
| 3065 |
** |
| 3066 |
** [[core URI query parameters]] |
| 3067 |
** The query component of a URI may contain parameters that are interpreted |
| 3068 |
** either by SQLite itself, or by a [VFS | custom VFS implementation]. |
| 3069 |
** SQLite and its built-in [VFSes] interpret the |
| 3070 |
** following query parameters: |
| 3071 |
** |
| 3072 |
** <ul> |
| 3073 |
** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of |
| 3074 |
** a VFS object that provides the operating system interface that should |
| 3075 |
** be used to access the database file on disk. ^If this option is set to |
| 3076 |
** an empty string the default VFS object is used. ^Specifying an unknown |
| 3077 |
** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is |
| 3078 |
** present, then the VFS specified by the option takes precedence over |
| 3079 |
** the value passed as the fourth parameter to sqlite3_open_v2(). |
| 3080 |
** |
| 3081 |
** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw", |
| 3082 |
** "rwc", or "memory". Attempting to set it to any other value is |
| 3083 |
** an error)^. |
| 3084 |
** ^If "ro" is specified, then the database is opened for read-only |
| 3085 |
** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the |
| 3086 |
** third argument to sqlite3_open_v2(). ^If the mode option is set to |
| 3087 |
** "rw", then the database is opened for read-write (but not create) |
| 3088 |
** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had |
| 3089 |
** been set. ^Value "rwc" is equivalent to setting both |
| 3090 |
** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is |
| 3091 |
** set to "memory" then a pure [in-memory database] that never reads |
| 3092 |
** or writes from disk is used. ^It is an error to specify a value for |
| 3093 |
** the mode parameter that is less restrictive than that specified by |
| 3094 |
** the flags passed in the third parameter to sqlite3_open_v2(). |
| 3095 |
** |
| 3096 |
** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or |
| 3097 |
** "private". ^Setting it to "shared" is equivalent to setting the |
| 3098 |
** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to |
| 3099 |
** sqlite3_open_v2(). ^Setting the cache parameter to "private" is |
| 3100 |
** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. |
| 3101 |
** ^If sqlite3_open_v2() is used and the "cache" parameter is present in |
| 3102 |
** a URI filename, its value overrides any behavior requested by setting |
| 3103 |
** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. |
| 3104 |
** |
| 3105 |
** <li> <b>psow</b>: ^The psow parameter indicates whether or not the |
| 3106 |
** [powersafe overwrite] property does or does not apply to the |
| 3107 |
** storage media on which the database file resides. |
| 3108 |
** |
| 3109 |
** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter |
| 3110 |
** which if set disables file locking in rollback journal modes. This |
| 3111 |
** is useful for accessing a database on a filesystem that does not |
| 3112 |
** support locking. Caution: Database corruption might result if two |
| 3113 |
** or more processes write to the same database and any one of those |
| 3114 |
** processes uses nolock=1. |
| 3115 |
** |
| 3116 |
** <li> <b>immutable</b>: ^The immutable parameter is a boolean query |
| 3117 |
** parameter that indicates that the database file is stored on |
| 3118 |
** read-only media. ^When immutable is set, SQLite assumes that the |
| 3119 |
** database file cannot be changed, even by a process with higher |
| 3120 |
** privilege, and so the database is opened read-only and all locking |
| 3121 |
** and change detection is disabled. Caution: Setting the immutable |
| 3122 |
** property on a database file that does in fact change can result |
| 3123 |
** in incorrect query results and/or [SQLITE_CORRUPT] errors. |
| 3124 |
** See also: [SQLITE_IOCAP_IMMUTABLE]. |
| 3125 |
** |
| 3126 |
** </ul> |
| 3127 |
** |
| 3128 |
** ^Specifying an unknown parameter in the query component of a URI is not an |
| 3129 |
** error. Future versions of SQLite might understand additional query |
| 3130 |
** parameters. See "[query parameters with special meaning to SQLite]" for |
| 3131 |
** additional information. |
| 3132 |
** |
| 3133 |
** [[URI filename examples]] <h3>URI filename examples</h3> |
| 3134 |
** |
| 3135 |
** <table border="1" align=center cellpadding=5> |
| 3136 |
** <tr><th> URI filenames <th> Results |
| 3137 |
** <tr><td> file:data.db <td> |
| 3138 |
** Open the file "data.db" in the current directory. |
| 3139 |
** <tr><td> file:/home/fred/data.db<br> |
| 3140 |
** file:///home/fred/data.db <br> |
| 3141 |
** file://localhost/home/fred/data.db <br> <td> |
| 3142 |
** Open the database file "/home/fred/data.db". |
| 3143 |
** <tr><td> file://darkstar/home/fred/data.db <td> |
| 3144 |
** An error. "darkstar" is not a recognized authority. |
| 3145 |
** <tr><td style="white-space:nowrap"> |
| 3146 |
** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db |
| 3147 |
** <td> Windows only: Open the file "data.db" on fred's desktop on drive |
| 3148 |
** C:. Note that the %20 escaping in this example is not strictly |
| 3149 |
** necessary - space characters can be used literally |
| 3150 |
** in URI filenames. |
| 3151 |
** <tr><td> file:data.db?mode=ro&cache=private <td> |
| 3152 |
** Open file "data.db" in the current directory for read-only access. |
| 3153 |
** Regardless of whether or not shared-cache mode is enabled by |
| 3154 |
** default, use a private cache. |
| 3155 |
** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td> |
| 3156 |
** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile" |
| 3157 |
** that uses dot-files in place of posix advisory locking. |
| 3158 |
** <tr><td> file:data.db?mode=readonly <td> |
| 3159 |
** An error. "readonly" is not a valid option for the "mode" parameter. |
| 3160 |
** </table> |
| 3161 |
** |
| 3162 |
** ^URI hexadecimal escape sequences (%HH) are supported within the path and |
| 3163 |
** query components of a URI. A hexadecimal escape sequence consists of a |
| 3164 |
** percent sign - "%" - followed by exactly two hexadecimal digits |
| 3165 |
** specifying an octet value. ^Before the path or query components of a |
| 3166 |
** URI filename are interpreted, they are encoded using UTF-8 and all |
| 3167 |
** hexadecimal escape sequences replaced by a single byte containing the |
| 3168 |
** corresponding octet. If this process generates an invalid UTF-8 encoding, |
| 3169 |
** the results are undefined. |
| 3170 |
** |
| 3171 |
** <b>Note to Windows users:</b> The encoding used for the filename argument |
| 3172 |
** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever |
| 3173 |
** codepage is currently defined. Filenames containing international |
| 3174 |
** characters must be converted to UTF-8 prior to passing them into |
| 3175 |
** sqlite3_open() or sqlite3_open_v2(). |
| 3176 |
** |
| 3177 |
** <b>Note to Windows Runtime users:</b> The temporary directory must be set |
| 3178 |
** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various |
| 3179 |
** features that require the use of temporary files may fail. |
| 3180 |
** |
| 3181 |
** See also: [sqlite3_temp_directory] |
| 3182 |
*/ |
| 3183 |
SQLITE_API int sqlite3_open( |
| 3184 |
const char *filename, /* Database filename (UTF-8) */ |
| 3185 |
sqlite3 **ppDb /* OUT: SQLite db handle */ |
| 3186 |
); |
| 3187 |
SQLITE_API int sqlite3_open16( |
| 3188 |
const void *filename, /* Database filename (UTF-16) */ |
| 3189 |
sqlite3 **ppDb /* OUT: SQLite db handle */ |
| 3190 |
); |
| 3191 |
SQLITE_API int sqlite3_open_v2( |
| 3192 |
const char *filename, /* Database filename (UTF-8) */ |
| 3193 |
sqlite3 **ppDb, /* OUT: SQLite db handle */ |
| 3194 |
int flags, /* Flags */ |
| 3195 |
const char *zVfs /* Name of VFS module to use */ |
| 3196 |
); |
| 3197 |
|
| 3198 |
/* |
| 3199 |
** CAPI3REF: Obtain Values For URI Parameters |
| 3200 |
** |
| 3201 |
** These are utility routines, useful to VFS implementations, that check |
| 3202 |
** to see if a database file was a URI that contained a specific query |
| 3203 |
** parameter, and if so obtains the value of that query parameter. |
| 3204 |
** |
| 3205 |
** If F is the database filename pointer passed into the xOpen() method of |
| 3206 |
** a VFS implementation when the flags parameter to xOpen() has one or |
| 3207 |
** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and |
| 3208 |
** P is the name of the query parameter, then |
| 3209 |
** sqlite3_uri_parameter(F,P) returns the value of the P |
| 3210 |
** parameter if it exists or a NULL pointer if P does not appear as a |
| 3211 |
** query parameter on F. If P is a query parameter of F |
| 3212 |
** has no explicit value, then sqlite3_uri_parameter(F,P) returns |
| 3213 |
** a pointer to an empty string. |
| 3214 |
** |
| 3215 |
** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean |
| 3216 |
** parameter and returns true (1) or false (0) according to the value |
| 3217 |
** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the |
| 3218 |
** value of query parameter P is one of "yes", "true", or "on" in any |
| 3219 |
** case or if the value begins with a non-zero number. The |
| 3220 |
** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of |
| 3221 |
** query parameter P is one of "no", "false", or "off" in any case or |
| 3222 |
** if the value begins with a numeric zero. If P is not a query |
| 3223 |
** parameter on F or if the value of P is does not match any of the |
| 3224 |
** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). |
| 3225 |
** |
| 3226 |
** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a |
| 3227 |
** 64-bit signed integer and returns that integer, or D if P does not |
| 3228 |
** exist. If the value of P is something other than an integer, then |
| 3229 |
** zero is returned. |
| 3230 |
** |
| 3231 |
** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and |
| 3232 |
** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and |
| 3233 |
** is not a database file pathname pointer that SQLite passed into the xOpen |
| 3234 |
** VFS method, then the behavior of this routine is undefined and probably |
| 3235 |
** undesirable. |
| 3236 |
*/ |
| 3237 |
SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); |
| 3238 |
SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); |
| 3239 |
SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); |
| 3240 |
|
| 3241 |
|
| 3242 |
/* |
| 3243 |
** CAPI3REF: Error Codes And Messages |
| 3244 |
** METHOD: sqlite3 |
| 3245 |
** |
| 3246 |
** ^If the most recent sqlite3_* API call associated with |
| 3247 |
** [database connection] D failed, then the sqlite3_errcode(D) interface |
| 3248 |
** returns the numeric [result code] or [extended result code] for that |
| 3249 |
** API call. |
| 3250 |
** If the most recent API call was successful, |
| 3251 |
** then the return value from sqlite3_errcode() is undefined. |
| 3252 |
** ^The sqlite3_extended_errcode() |
| 3253 |
** interface is the same except that it always returns the |
| 3254 |
** [extended result code] even when extended result codes are |
| 3255 |
** disabled. |
| 3256 |
** |
| 3257 |
** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language |
| 3258 |
** text that describes the error, as either UTF-8 or UTF-16 respectively. |
| 3259 |
** ^(Memory to hold the error message string is managed internally. |
| 3260 |
** The application does not need to worry about freeing the result. |
| 3261 |
** However, the error string might be overwritten or deallocated by |
| 3262 |
** subsequent calls to other SQLite interface functions.)^ |
| 3263 |
** |
| 3264 |
** ^The sqlite3_errstr() interface returns the English-language text |
| 3265 |
** that describes the [result code], as UTF-8. |
| 3266 |
** ^(Memory to hold the error message string is managed internally |
| 3267 |
** and must not be freed by the application)^. |
| 3268 |
** |
| 3269 |
** When the serialized [threading mode] is in use, it might be the |
| 3270 |
** case that a second error occurs on a separate thread in between |
| 3271 |
** the time of the first error and the call to these interfaces. |
| 3272 |
** When that happens, the second error will be reported since these |
| 3273 |
** interfaces always report the most recent result. To avoid |
| 3274 |
** this, each thread can obtain exclusive use of the [database connection] D |
| 3275 |
** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning |
| 3276 |
** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after |
| 3277 |
** all calls to the interfaces listed here are completed. |
| 3278 |
** |
| 3279 |
** If an interface fails with SQLITE_MISUSE, that means the interface |
| 3280 |
** was invoked incorrectly by the application. In that case, the |
| 3281 |
** error code and message may or may not be set. |
| 3282 |
*/ |
| 3283 |
SQLITE_API int sqlite3_errcode(sqlite3 *db); |
| 3284 |
SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); |
| 3285 |
SQLITE_API const char *sqlite3_errmsg(sqlite3*); |
| 3286 |
SQLITE_API const void *sqlite3_errmsg16(sqlite3*); |
| 3287 |
SQLITE_API const char *sqlite3_errstr(int); |
| 3288 |
|
| 3289 |
/* |
| 3290 |
** CAPI3REF: Prepared Statement Object |
| 3291 |
** KEYWORDS: {prepared statement} {prepared statements} |
| 3292 |
** |
| 3293 |
** An instance of this object represents a single SQL statement that |
| 3294 |
** has been compiled into binary form and is ready to be evaluated. |
| 3295 |
** |
| 3296 |
** Think of each SQL statement as a separate computer program. The |
| 3297 |
** original SQL text is source code. A prepared statement object |
| 3298 |
** is the compiled object code. All SQL must be converted into a |
| 3299 |
** prepared statement before it can be run. |
| 3300 |
** |
| 3301 |
** The life-cycle of a prepared statement object usually goes like this: |
| 3302 |
** |
| 3303 |
** <ol> |
| 3304 |
** <li> Create the prepared statement object using [sqlite3_prepare_v2()]. |
| 3305 |
** <li> Bind values to [parameters] using the sqlite3_bind_*() |
| 3306 |
** interfaces. |
| 3307 |
** <li> Run the SQL by calling [sqlite3_step()] one or more times. |
| 3308 |
** <li> Reset the prepared statement using [sqlite3_reset()] then go back |
| 3309 |
** to step 2. Do this zero or more times. |
| 3310 |
** <li> Destroy the object using [sqlite3_finalize()]. |
| 3311 |
** </ol> |
| 3312 |
*/ |
| 3313 |
typedef struct sqlite3_stmt sqlite3_stmt; |
| 3314 |
|
| 3315 |
/* |
| 3316 |
** CAPI3REF: Run-time Limits |
| 3317 |
** METHOD: sqlite3 |
| 3318 |
** |
| 3319 |
** ^(This interface allows the size of various constructs to be limited |
| 3320 |
** on a connection by connection basis. The first parameter is the |
| 3321 |
** [database connection] whose limit is to be set or queried. The |
| 3322 |
** second parameter is one of the [limit categories] that define a |
| 3323 |
** class of constructs to be size limited. The third parameter is the |
| 3324 |
** new limit for that construct.)^ |
| 3325 |
** |
| 3326 |
** ^If the new limit is a negative number, the limit is unchanged. |
| 3327 |
** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a |
| 3328 |
** [limits | hard upper bound] |
| 3329 |
** set at compile-time by a C preprocessor macro called |
| 3330 |
** [limits | SQLITE_MAX_<i>NAME</i>]. |
| 3331 |
** (The "_LIMIT_" in the name is changed to "_MAX_".))^ |
| 3332 |
** ^Attempts to increase a limit above its hard upper bound are |
| 3333 |
** silently truncated to the hard upper bound. |
| 3334 |
** |
| 3335 |
** ^Regardless of whether or not the limit was changed, the |
| 3336 |
** [sqlite3_limit()] interface returns the prior value of the limit. |
| 3337 |
** ^Hence, to find the current value of a limit without changing it, |
| 3338 |
** simply invoke this interface with the third parameter set to -1. |
| 3339 |
** |
| 3340 |
** Run-time limits are intended for use in applications that manage |
| 3341 |
** both their own internal database and also databases that are controlled |
| 3342 |
** by untrusted external sources. An example application might be a |
| 3343 |
** web browser that has its own databases for storing history and |
| 3344 |
** separate databases controlled by JavaScript applications downloaded |
| 3345 |
** off the Internet. The internal databases can be given the |
| 3346 |
** large, default limits. Databases managed by external sources can |
| 3347 |
** be given much smaller limits designed to prevent a denial of service |
| 3348 |
** attack. Developers might also want to use the [sqlite3_set_authorizer()] |
| 3349 |
** interface to further control untrusted SQL. The size of the database |
| 3350 |
** created by an untrusted script can be contained using the |
| 3351 |
** [max_page_count] [PRAGMA]. |
| 3352 |
** |
| 3353 |
** New run-time limit categories may be added in future releases. |
| 3354 |
*/ |
| 3355 |
SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); |
| 3356 |
|
| 3357 |
/* |
| 3358 |
** CAPI3REF: Run-Time Limit Categories |
| 3359 |
** KEYWORDS: {limit category} {*limit categories} |
| 3360 |
** |
| 3361 |
** These constants define various performance limits |
| 3362 |
** that can be lowered at run-time using [sqlite3_limit()]. |
| 3363 |
** The synopsis of the meanings of the various limits is shown below. |
| 3364 |
** Additional information is available at [limits | Limits in SQLite]. |
| 3365 |
** |
| 3366 |
** <dl> |
| 3367 |
** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt> |
| 3368 |
** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ |
| 3369 |
** |
| 3370 |
** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> |
| 3371 |
** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ |
| 3372 |
** |
| 3373 |
** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt> |
| 3374 |
** <dd>The maximum number of columns in a table definition or in the |
| 3375 |
** result set of a [SELECT] or the maximum number of columns in an index |
| 3376 |
** or in an ORDER BY or GROUP BY clause.</dd>)^ |
| 3377 |
** |
| 3378 |
** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> |
| 3379 |
** <dd>The maximum depth of the parse tree on any expression.</dd>)^ |
| 3380 |
** |
| 3381 |
** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> |
| 3382 |
** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ |
| 3383 |
** |
| 3384 |
** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> |
| 3385 |
** <dd>The maximum number of instructions in a virtual machine program |
| 3386 |
** used to implement an SQL statement. This limit is not currently |
| 3387 |
** enforced, though that might be added in some future release of |
| 3388 |
** SQLite.</dd>)^ |
| 3389 |
** |
| 3390 |
** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> |
| 3391 |
** <dd>The maximum number of arguments on a function.</dd>)^ |
| 3392 |
** |
| 3393 |
** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt> |
| 3394 |
** <dd>The maximum number of [ATTACH | attached databases].)^</dd> |
| 3395 |
** |
| 3396 |
** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] |
| 3397 |
** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> |
| 3398 |
** <dd>The maximum length of the pattern argument to the [LIKE] or |
| 3399 |
** [GLOB] operators.</dd>)^ |
| 3400 |
** |
| 3401 |
** [[SQLITE_LIMIT_VARIABLE_NUMBER]] |
| 3402 |
** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> |
| 3403 |
** <dd>The maximum index number of any [parameter] in an SQL statement.)^ |
| 3404 |
** |
| 3405 |
** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> |
| 3406 |
** <dd>The maximum depth of recursion for triggers.</dd>)^ |
| 3407 |
** |
| 3408 |
** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt> |
| 3409 |
** <dd>The maximum number of auxiliary worker threads that a single |
| 3410 |
** [prepared statement] may start.</dd>)^ |
| 3411 |
** </dl> |
| 3412 |
*/ |
| 3413 |
#define SQLITE_LIMIT_LENGTH 0 |
| 3414 |
#define SQLITE_LIMIT_SQL_LENGTH 1 |
| 3415 |
#define SQLITE_LIMIT_COLUMN 2 |
| 3416 |
#define SQLITE_LIMIT_EXPR_DEPTH 3 |
| 3417 |
#define SQLITE_LIMIT_COMPOUND_SELECT 4 |
| 3418 |
#define SQLITE_LIMIT_VDBE_OP 5 |
| 3419 |
#define SQLITE_LIMIT_FUNCTION_ARG 6 |
| 3420 |
#define SQLITE_LIMIT_ATTACHED 7 |
| 3421 |
#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 |
| 3422 |
#define SQLITE_LIMIT_VARIABLE_NUMBER 9 |
| 3423 |
#define SQLITE_LIMIT_TRIGGER_DEPTH 10 |
| 3424 |
#define SQLITE_LIMIT_WORKER_THREADS 11 |
| 3425 |
|
| 3426 |
/* |
| 3427 |
** CAPI3REF: Compiling An SQL Statement |
| 3428 |
** KEYWORDS: {SQL statement compiler} |
| 3429 |
** METHOD: sqlite3 |
| 3430 |
** CONSTRUCTOR: sqlite3_stmt |
| 3431 |
** |
| 3432 |
** To execute an SQL query, it must first be compiled into a byte-code |
| 3433 |
** program using one of these routines. |
| 3434 |
** |
| 3435 |
** The first argument, "db", is a [database connection] obtained from a |
| 3436 |
** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or |
| 3437 |
** [sqlite3_open16()]. The database connection must not have been closed. |
| 3438 |
** |
| 3439 |
** The second argument, "zSql", is the statement to be compiled, encoded |
| 3440 |
** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() |
| 3441 |
** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() |
| 3442 |
** use UTF-16. |
| 3443 |
** |
| 3444 |
** ^If the nByte argument is negative, then zSql is read up to the |
| 3445 |
** first zero terminator. ^If nByte is positive, then it is the |
| 3446 |
** number of bytes read from zSql. ^If nByte is zero, then no prepared |
| 3447 |
** statement is generated. |
| 3448 |
** If the caller knows that the supplied string is nul-terminated, then |
| 3449 |
** there is a small performance advantage to passing an nByte parameter that |
| 3450 |
** is the number of bytes in the input string <i>including</i> |
| 3451 |
** the nul-terminator. |
| 3452 |
** |
| 3453 |
** ^If pzTail is not NULL then *pzTail is made to point to the first byte |
| 3454 |
** past the end of the first SQL statement in zSql. These routines only |
| 3455 |
** compile the first statement in zSql, so *pzTail is left pointing to |
| 3456 |
** what remains uncompiled. |
| 3457 |
** |
| 3458 |
** ^*ppStmt is left pointing to a compiled [prepared statement] that can be |
| 3459 |
** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set |
| 3460 |
** to NULL. ^If the input text contains no SQL (if the input is an empty |
| 3461 |
** string or a comment) then *ppStmt is set to NULL. |
| 3462 |
** The calling procedure is responsible for deleting the compiled |
| 3463 |
** SQL statement using [sqlite3_finalize()] after it has finished with it. |
| 3464 |
** ppStmt may not be NULL. |
| 3465 |
** |
| 3466 |
** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; |
| 3467 |
** otherwise an [error code] is returned. |
| 3468 |
** |
| 3469 |
** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are |
| 3470 |
** recommended for all new programs. The two older interfaces are retained |
| 3471 |
** for backwards compatibility, but their use is discouraged. |
| 3472 |
** ^In the "v2" interfaces, the prepared statement |
| 3473 |
** that is returned (the [sqlite3_stmt] object) contains a copy of the |
| 3474 |
** original SQL text. This causes the [sqlite3_step()] interface to |
| 3475 |
** behave differently in three ways: |
| 3476 |
** |
| 3477 |
** <ol> |
| 3478 |
** <li> |
| 3479 |
** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it |
| 3480 |
** always used to do, [sqlite3_step()] will automatically recompile the SQL |
| 3481 |
** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY] |
| 3482 |
** retries will occur before sqlite3_step() gives up and returns an error. |
| 3483 |
** </li> |
| 3484 |
** |
| 3485 |
** <li> |
| 3486 |
** ^When an error occurs, [sqlite3_step()] will return one of the detailed |
| 3487 |
** [error codes] or [extended error codes]. ^The legacy behavior was that |
| 3488 |
** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code |
| 3489 |
** and the application would have to make a second call to [sqlite3_reset()] |
| 3490 |
** in order to find the underlying cause of the problem. With the "v2" prepare |
| 3491 |
** interfaces, the underlying reason for the error is returned immediately. |
| 3492 |
** </li> |
| 3493 |
** |
| 3494 |
** <li> |
| 3495 |
** ^If the specific value bound to [parameter | host parameter] in the |
| 3496 |
** WHERE clause might influence the choice of query plan for a statement, |
| 3497 |
** then the statement will be automatically recompiled, as if there had been |
| 3498 |
** a schema change, on the first [sqlite3_step()] call following any change |
| 3499 |
** to the [sqlite3_bind_text | bindings] of that [parameter]. |
| 3500 |
** ^The specific value of WHERE-clause [parameter] might influence the |
| 3501 |
** choice of query plan if the parameter is the left-hand side of a [LIKE] |
| 3502 |
** or [GLOB] operator or if the parameter is compared to an indexed column |
| 3503 |
** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled. |
| 3504 |
** </li> |
| 3505 |
** </ol> |
| 3506 |
*/ |
| 3507 |
SQLITE_API int sqlite3_prepare( |
| 3508 |
sqlite3 *db, /* Database handle */ |
| 3509 |
const char *zSql, /* SQL statement, UTF-8 encoded */ |
| 3510 |
int nByte, /* Maximum length of zSql in bytes. */ |
| 3511 |
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
| 3512 |
const char **pzTail /* OUT: Pointer to unused portion of zSql */ |
| 3513 |
); |
| 3514 |
SQLITE_API int sqlite3_prepare_v2( |
| 3515 |
sqlite3 *db, /* Database handle */ |
| 3516 |
const char *zSql, /* SQL statement, UTF-8 encoded */ |
| 3517 |
int nByte, /* Maximum length of zSql in bytes. */ |
| 3518 |
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
| 3519 |
const char **pzTail /* OUT: Pointer to unused portion of zSql */ |
| 3520 |
); |
| 3521 |
SQLITE_API int sqlite3_prepare16( |
| 3522 |
sqlite3 *db, /* Database handle */ |
| 3523 |
const void *zSql, /* SQL statement, UTF-16 encoded */ |
| 3524 |
int nByte, /* Maximum length of zSql in bytes. */ |
| 3525 |
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
| 3526 |
const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
| 3527 |
); |
| 3528 |
SQLITE_API int sqlite3_prepare16_v2( |
| 3529 |
sqlite3 *db, /* Database handle */ |
| 3530 |
const void *zSql, /* SQL statement, UTF-16 encoded */ |
| 3531 |
int nByte, /* Maximum length of zSql in bytes. */ |
| 3532 |
sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
| 3533 |
const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
| 3534 |
); |
| 3535 |
|
| 3536 |
/* |
| 3537 |
** CAPI3REF: Retrieving Statement SQL |
| 3538 |
** METHOD: sqlite3_stmt |
| 3539 |
** |
| 3540 |
** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8 |
| 3541 |
** SQL text used to create [prepared statement] P if P was |
| 3542 |
** created by either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. |
| 3543 |
** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8 |
| 3544 |
** string containing the SQL text of prepared statement P with |
| 3545 |
** [bound parameters] expanded. |
| 3546 |
** |
| 3547 |
** ^(For example, if a prepared statement is created using the SQL |
| 3548 |
** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345 |
| 3549 |
** and parameter :xyz is unbound, then sqlite3_sql() will return |
| 3550 |
** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql() |
| 3551 |
** will return "SELECT 2345,NULL".)^ |
| 3552 |
** |
| 3553 |
** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory |
| 3554 |
** is available to hold the result, or if the result would exceed the |
| 3555 |
** the maximum string length determined by the [SQLITE_LIMIT_LENGTH]. |
| 3556 |
** |
| 3557 |
** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of |
| 3558 |
** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time |
| 3559 |
** option causes sqlite3_expanded_sql() to always return NULL. |
| 3560 |
** |
| 3561 |
** ^The string returned by sqlite3_sql(P) is managed by SQLite and is |
| 3562 |
** automatically freed when the prepared statement is finalized. |
| 3563 |
** ^The string returned by sqlite3_expanded_sql(P), on the other hand, |
| 3564 |
** is obtained from [sqlite3_malloc()] and must be free by the application |
| 3565 |
** by passing it to [sqlite3_free()]. |
| 3566 |
*/ |
| 3567 |
SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); |
| 3568 |
SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt); |
| 3569 |
|
| 3570 |
/* |
| 3571 |
** CAPI3REF: Determine If An SQL Statement Writes The Database |
| 3572 |
** METHOD: sqlite3_stmt |
| 3573 |
** |
| 3574 |
** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if |
| 3575 |
** and only if the [prepared statement] X makes no direct changes to |
| 3576 |
** the content of the database file. |
| 3577 |
** |
| 3578 |
** Note that [application-defined SQL functions] or |
| 3579 |
** [virtual tables] might change the database indirectly as a side effect. |
| 3580 |
** ^(For example, if an application defines a function "eval()" that |
| 3581 |
** calls [sqlite3_exec()], then the following SQL statement would |
| 3582 |
** change the database file through side-effects: |
| 3583 |
** |
| 3584 |
** <blockquote><pre> |
| 3585 |
** SELECT eval('DELETE FROM t1') FROM t2; |
| 3586 |
** </pre></blockquote> |
| 3587 |
** |
| 3588 |
** But because the [SELECT] statement does not change the database file |
| 3589 |
** directly, sqlite3_stmt_readonly() would still return true.)^ |
| 3590 |
** |
| 3591 |
** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], |
| 3592 |
** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, |
| 3593 |
** since the statements themselves do not actually modify the database but |
| 3594 |
** rather they control the timing of when other statements modify the |
| 3595 |
** database. ^The [ATTACH] and [DETACH] statements also cause |
| 3596 |
** sqlite3_stmt_readonly() to return true since, while those statements |
| 3597 |
** change the configuration of a database connection, they do not make |
| 3598 |
** changes to the content of the database files on disk. |
| 3599 |
*/ |
| 3600 |
SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); |
| 3601 |
|
| 3602 |
/* |
| 3603 |
** CAPI3REF: Determine If A Prepared Statement Has Been Reset |
| 3604 |
** METHOD: sqlite3_stmt |
| 3605 |
** |
| 3606 |
** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the |
| 3607 |
** [prepared statement] S has been stepped at least once using |
| 3608 |
** [sqlite3_step(S)] but has neither run to completion (returned |
| 3609 |
** [SQLITE_DONE] from [sqlite3_step(S)]) nor |
| 3610 |
** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) |
| 3611 |
** interface returns false if S is a NULL pointer. If S is not a |
| 3612 |
** NULL pointer and is not a pointer to a valid [prepared statement] |
| 3613 |
** object, then the behavior is undefined and probably undesirable. |
| 3614 |
** |
| 3615 |
** This interface can be used in combination [sqlite3_next_stmt()] |
| 3616 |
** to locate all prepared statements associated with a database |
| 3617 |
** connection that are in need of being reset. This can be used, |
| 3618 |
** for example, in diagnostic routines to search for prepared |
| 3619 |
** statements that are holding a transaction open. |
| 3620 |
*/ |
| 3621 |
SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); |
| 3622 |
|
| 3623 |
/* |
| 3624 |
** CAPI3REF: Dynamically Typed Value Object |
| 3625 |
** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} |
| 3626 |
** |
| 3627 |
** SQLite uses the sqlite3_value object to represent all values |
| 3628 |
** that can be stored in a database table. SQLite uses dynamic typing |
| 3629 |
** for the values it stores. ^Values stored in sqlite3_value objects |
| 3630 |
** can be integers, floating point values, strings, BLOBs, or NULL. |
| 3631 |
** |
| 3632 |
** An sqlite3_value object may be either "protected" or "unprotected". |
| 3633 |
** Some interfaces require a protected sqlite3_value. Other interfaces |
| 3634 |
** will accept either a protected or an unprotected sqlite3_value. |
| 3635 |
** Every interface that accepts sqlite3_value arguments specifies |
| 3636 |
** whether or not it requires a protected sqlite3_value. The |
| 3637 |
** [sqlite3_value_dup()] interface can be used to construct a new |
| 3638 |
** protected sqlite3_value from an unprotected sqlite3_value. |
| 3639 |
** |
| 3640 |
** The terms "protected" and "unprotected" refer to whether or not |
| 3641 |
** a mutex is held. An internal mutex is held for a protected |
| 3642 |
** sqlite3_value object but no mutex is held for an unprotected |
| 3643 |
** sqlite3_value object. If SQLite is compiled to be single-threaded |
| 3644 |
** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) |
| 3645 |
** or if SQLite is run in one of reduced mutex modes |
| 3646 |
** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] |
| 3647 |
** then there is no distinction between protected and unprotected |
| 3648 |
** sqlite3_value objects and they can be used interchangeably. However, |
| 3649 |
** for maximum code portability it is recommended that applications |
| 3650 |
** still make the distinction between protected and unprotected |
| 3651 |
** sqlite3_value objects even when not strictly required. |
| 3652 |
** |
| 3653 |
** ^The sqlite3_value objects that are passed as parameters into the |
| 3654 |
** implementation of [application-defined SQL functions] are protected. |
| 3655 |
** ^The sqlite3_value object returned by |
| 3656 |
** [sqlite3_column_value()] is unprotected. |
| 3657 |
** Unprotected sqlite3_value objects may only be used with |
| 3658 |
** [sqlite3_result_value()] and [sqlite3_bind_value()]. |
| 3659 |
** The [sqlite3_value_blob | sqlite3_value_type()] family of |
| 3660 |
** interfaces require protected sqlite3_value objects. |
| 3661 |
*/ |
| 3662 |
typedef struct Mem sqlite3_value; |
| 3663 |
|
| 3664 |
/* |
| 3665 |
** CAPI3REF: SQL Function Context Object |
| 3666 |
** |
| 3667 |
** The context in which an SQL function executes is stored in an |
| 3668 |
** sqlite3_context object. ^A pointer to an sqlite3_context object |
| 3669 |
** is always first parameter to [application-defined SQL functions]. |
| 3670 |
** The application-defined SQL function implementation will pass this |
| 3671 |
** pointer through into calls to [sqlite3_result_int | sqlite3_result()], |
| 3672 |
** [sqlite3_aggregate_context()], [sqlite3_user_data()], |
| 3673 |
** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], |
| 3674 |
** and/or [sqlite3_set_auxdata()]. |
| 3675 |
*/ |
| 3676 |
typedef struct sqlite3_context sqlite3_context; |
| 3677 |
|
| 3678 |
/* |
| 3679 |
** CAPI3REF: Binding Values To Prepared Statements |
| 3680 |
** KEYWORDS: {host parameter} {host parameters} {host parameter name} |
| 3681 |
** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} |
| 3682 |
** METHOD: sqlite3_stmt |
| 3683 |
** |
| 3684 |
** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, |
| 3685 |
** literals may be replaced by a [parameter] that matches one of following |
| 3686 |
** templates: |
| 3687 |
** |
| 3688 |
** <ul> |
| 3689 |
** <li> ? |
| 3690 |
** <li> ?NNN |
| 3691 |
** <li> :VVV |
| 3692 |
** <li> @VVV |
| 3693 |
** <li> $VVV |
| 3694 |
** </ul> |
| 3695 |
** |
| 3696 |
** In the templates above, NNN represents an integer literal, |
| 3697 |
** and VVV represents an alphanumeric identifier.)^ ^The values of these |
| 3698 |
** parameters (also called "host parameter names" or "SQL parameters") |
| 3699 |
** can be set using the sqlite3_bind_*() routines defined here. |
| 3700 |
** |
| 3701 |
** ^The first argument to the sqlite3_bind_*() routines is always |
| 3702 |
** a pointer to the [sqlite3_stmt] object returned from |
| 3703 |
** [sqlite3_prepare_v2()] or its variants. |
| 3704 |
** |
| 3705 |
** ^The second argument is the index of the SQL parameter to be set. |
| 3706 |
** ^The leftmost SQL parameter has an index of 1. ^When the same named |
| 3707 |
** SQL parameter is used more than once, second and subsequent |
| 3708 |
** occurrences have the same index as the first occurrence. |
| 3709 |
** ^The index for named parameters can be looked up using the |
| 3710 |
** [sqlite3_bind_parameter_index()] API if desired. ^The index |
| 3711 |
** for "?NNN" parameters is the value of NNN. |
| 3712 |
** ^The NNN value must be between 1 and the [sqlite3_limit()] |
| 3713 |
** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). |
| 3714 |
** |
| 3715 |
** ^The third argument is the value to bind to the parameter. |
| 3716 |
** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16() |
| 3717 |
** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter |
| 3718 |
** is ignored and the end result is the same as sqlite3_bind_null(). |
| 3719 |
** |
| 3720 |
** ^(In those routines that have a fourth argument, its value is the |
| 3721 |
** number of bytes in the parameter. To be clear: the value is the |
| 3722 |
** number of <u>bytes</u> in the value, not the number of characters.)^ |
| 3723 |
** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16() |
| 3724 |
** is negative, then the length of the string is |
| 3725 |
** the number of bytes up to the first zero terminator. |
| 3726 |
** If the fourth parameter to sqlite3_bind_blob() is negative, then |
| 3727 |
** the behavior is undefined. |
| 3728 |
** If a non-negative fourth parameter is provided to sqlite3_bind_text() |
| 3729 |
** or sqlite3_bind_text16() or sqlite3_bind_text64() then |
| 3730 |
** that parameter must be the byte offset |
| 3731 |
** where the NUL terminator would occur assuming the string were NUL |
| 3732 |
** terminated. If any NUL characters occur at byte offsets less than |
| 3733 |
** the value of the fourth parameter then the resulting string value will |
| 3734 |
** contain embedded NULs. The result of expressions involving strings |
| 3735 |
** with embedded NULs is undefined. |
| 3736 |
** |
| 3737 |
** ^The fifth argument to the BLOB and string binding interfaces |
| 3738 |
** is a destructor used to dispose of the BLOB or |
| 3739 |
** string after SQLite has finished with it. ^The destructor is called |
| 3740 |
** to dispose of the BLOB or string even if the call to bind API fails. |
| 3741 |
** ^If the fifth argument is |
| 3742 |
** the special value [SQLITE_STATIC], then SQLite assumes that the |
| 3743 |
** information is in static, unmanaged space and does not need to be freed. |
| 3744 |
** ^If the fifth argument has the value [SQLITE_TRANSIENT], then |
| 3745 |
** SQLite makes its own private copy of the data immediately, before |
| 3746 |
** the sqlite3_bind_*() routine returns. |
| 3747 |
** |
| 3748 |
** ^The sixth argument to sqlite3_bind_text64() must be one of |
| 3749 |
** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE] |
| 3750 |
** to specify the encoding of the text in the third parameter. If |
| 3751 |
** the sixth argument to sqlite3_bind_text64() is not one of the |
| 3752 |
** allowed values shown above, or if the text encoding is different |
| 3753 |
** from the encoding specified by the sixth parameter, then the behavior |
| 3754 |
** is undefined. |
| 3755 |
** |
| 3756 |
** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that |
| 3757 |
** is filled with zeroes. ^A zeroblob uses a fixed amount of memory |
| 3758 |
** (just an integer to hold its size) while it is being processed. |
| 3759 |
** Zeroblobs are intended to serve as placeholders for BLOBs whose |
| 3760 |
** content is later written using |
| 3761 |
** [sqlite3_blob_open | incremental BLOB I/O] routines. |
| 3762 |
** ^A negative value for the zeroblob results in a zero-length BLOB. |
| 3763 |
** |
| 3764 |
** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer |
| 3765 |
** for the [prepared statement] or with a prepared statement for which |
| 3766 |
** [sqlite3_step()] has been called more recently than [sqlite3_reset()], |
| 3767 |
** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() |
| 3768 |
** routine is passed a [prepared statement] that has been finalized, the |
| 3769 |
** result is undefined and probably harmful. |
| 3770 |
** |
| 3771 |
** ^Bindings are not cleared by the [sqlite3_reset()] routine. |
| 3772 |
** ^Unbound parameters are interpreted as NULL. |
| 3773 |
** |
| 3774 |
** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an |
| 3775 |
** [error code] if anything goes wrong. |
| 3776 |
** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB |
| 3777 |
** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or |
| 3778 |
** [SQLITE_MAX_LENGTH]. |
| 3779 |
** ^[SQLITE_RANGE] is returned if the parameter |
| 3780 |
** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. |
| 3781 |
** |
| 3782 |
** See also: [sqlite3_bind_parameter_count()], |
| 3783 |
** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. |
| 3784 |
*/ |
| 3785 |
SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); |
| 3786 |
SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64, |
| 3787 |
void(*)(void*)); |
| 3788 |
SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); |
| 3789 |
SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); |
| 3790 |
SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); |
| 3791 |
SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); |
| 3792 |
SQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*)); |
| 3793 |
SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); |
| 3794 |
SQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64, |
| 3795 |
void(*)(void*), unsigned char encoding); |
| 3796 |
SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); |
| 3797 |
SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); |
| 3798 |
SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64); |
| 3799 |
|
| 3800 |
/* |
| 3801 |
** CAPI3REF: Number Of SQL Parameters |
| 3802 |
** METHOD: sqlite3_stmt |
| 3803 |
** |
| 3804 |
** ^This routine can be used to find the number of [SQL parameters] |
| 3805 |
** in a [prepared statement]. SQL parameters are tokens of the |
| 3806 |
** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as |
| 3807 |
** placeholders for values that are [sqlite3_bind_blob | bound] |
| 3808 |
** to the parameters at a later time. |
| 3809 |
** |
| 3810 |
** ^(This routine actually returns the index of the largest (rightmost) |
| 3811 |
** parameter. For all forms except ?NNN, this will correspond to the |
| 3812 |
** number of unique parameters. If parameters of the ?NNN form are used, |
| 3813 |
** there may be gaps in the list.)^ |
| 3814 |
** |
| 3815 |
** See also: [sqlite3_bind_blob|sqlite3_bind()], |
| 3816 |
** [sqlite3_bind_parameter_name()], and |
| 3817 |
** [sqlite3_bind_parameter_index()]. |
| 3818 |
*/ |
| 3819 |
SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); |
| 3820 |
|
| 3821 |
/* |
| 3822 |
** CAPI3REF: Name Of A Host Parameter |
| 3823 |
** METHOD: sqlite3_stmt |
| 3824 |
** |
| 3825 |
** ^The sqlite3_bind_parameter_name(P,N) interface returns |
| 3826 |
** the name of the N-th [SQL parameter] in the [prepared statement] P. |
| 3827 |
** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" |
| 3828 |
** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" |
| 3829 |
** respectively. |
| 3830 |
** In other words, the initial ":" or "$" or "@" or "?" |
| 3831 |
** is included as part of the name.)^ |
| 3832 |
** ^Parameters of the form "?" without a following integer have no name |
| 3833 |
** and are referred to as "nameless" or "anonymous parameters". |
| 3834 |
** |
| 3835 |
** ^The first host parameter has an index of 1, not 0. |
| 3836 |
** |
| 3837 |
** ^If the value N is out of range or if the N-th parameter is |
| 3838 |
** nameless, then NULL is returned. ^The returned string is |
| 3839 |
** always in UTF-8 encoding even if the named parameter was |
| 3840 |
** originally specified as UTF-16 in [sqlite3_prepare16()] or |
| 3841 |
** [sqlite3_prepare16_v2()]. |
| 3842 |
** |
| 3843 |
** See also: [sqlite3_bind_blob|sqlite3_bind()], |
| 3844 |
** [sqlite3_bind_parameter_count()], and |
| 3845 |
** [sqlite3_bind_parameter_index()]. |
| 3846 |
*/ |
| 3847 |
SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); |
| 3848 |
|
| 3849 |
/* |
| 3850 |
** CAPI3REF: Index Of A Parameter With A Given Name |
| 3851 |
** METHOD: sqlite3_stmt |
| 3852 |
** |
| 3853 |
** ^Return the index of an SQL parameter given its name. ^The |
| 3854 |
** index value returned is suitable for use as the second |
| 3855 |
** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero |
| 3856 |
** is returned if no matching parameter is found. ^The parameter |
| 3857 |
** name must be given in UTF-8 even if the original statement |
| 3858 |
** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. |
| 3859 |
** |
| 3860 |
** See also: [sqlite3_bind_blob|sqlite3_bind()], |
| 3861 |
** [sqlite3_bind_parameter_count()], and |
| 3862 |
** [sqlite3_bind_parameter_name()]. |
| 3863 |
*/ |
| 3864 |
SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); |
| 3865 |
|
| 3866 |
/* |
| 3867 |
** CAPI3REF: Reset All Bindings On A Prepared Statement |
| 3868 |
** METHOD: sqlite3_stmt |
| 3869 |
** |
| 3870 |
** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset |
| 3871 |
** the [sqlite3_bind_blob | bindings] on a [prepared statement]. |
| 3872 |
** ^Use this routine to reset all host parameters to NULL. |
| 3873 |
*/ |
| 3874 |
SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); |
| 3875 |
|
| 3876 |
/* |
| 3877 |
** CAPI3REF: Number Of Columns In A Result Set |
| 3878 |
** METHOD: sqlite3_stmt |
| 3879 |
** |
| 3880 |
** ^Return the number of columns in the result set returned by the |
| 3881 |
** [prepared statement]. ^This routine returns 0 if pStmt is an SQL |
| 3882 |
** statement that does not return data (for example an [UPDATE]). |
| 3883 |
** |
| 3884 |
** See also: [sqlite3_data_count()] |
| 3885 |
*/ |
| 3886 |
SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); |
| 3887 |
|
| 3888 |
/* |
| 3889 |
** CAPI3REF: Column Names In A Result Set |
| 3890 |
** METHOD: sqlite3_stmt |
| 3891 |
** |
| 3892 |
** ^These routines return the name assigned to a particular column |
| 3893 |
** in the result set of a [SELECT] statement. ^The sqlite3_column_name() |
| 3894 |
** interface returns a pointer to a zero-terminated UTF-8 string |
| 3895 |
** and sqlite3_column_name16() returns a pointer to a zero-terminated |
| 3896 |
** UTF-16 string. ^The first parameter is the [prepared statement] |
| 3897 |
** that implements the [SELECT] statement. ^The second parameter is the |
| 3898 |
** column number. ^The leftmost column is number 0. |
| 3899 |
** |
| 3900 |
** ^The returned string pointer is valid until either the [prepared statement] |
| 3901 |
** is destroyed by [sqlite3_finalize()] or until the statement is automatically |
| 3902 |
** reprepared by the first call to [sqlite3_step()] for a particular run |
| 3903 |
** or until the next call to |
| 3904 |
** sqlite3_column_name() or sqlite3_column_name16() on the same column. |
| 3905 |
** |
| 3906 |
** ^If sqlite3_malloc() fails during the processing of either routine |
| 3907 |
** (for example during a conversion from UTF-8 to UTF-16) then a |
| 3908 |
** NULL pointer is returned. |
| 3909 |
** |
| 3910 |
** ^The name of a result column is the value of the "AS" clause for |
| 3911 |
** that column, if there is an AS clause. If there is no AS clause |
| 3912 |
** then the name of the column is unspecified and may change from |
| 3913 |
** one release of SQLite to the next. |
| 3914 |
*/ |
| 3915 |
SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); |
| 3916 |
SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); |
| 3917 |
|
| 3918 |
/* |
| 3919 |
** CAPI3REF: Source Of Data In A Query Result |
| 3920 |
** METHOD: sqlite3_stmt |
| 3921 |
** |
| 3922 |
** ^These routines provide a means to determine the database, table, and |
| 3923 |
** table column that is the origin of a particular result column in |
| 3924 |
** [SELECT] statement. |
| 3925 |
** ^The name of the database or table or column can be returned as |
| 3926 |
** either a UTF-8 or UTF-16 string. ^The _database_ routines return |
| 3927 |
** the database name, the _table_ routines return the table name, and |
| 3928 |
** the origin_ routines return the column name. |
| 3929 |
** ^The returned string is valid until the [prepared statement] is destroyed |
| 3930 |
** using [sqlite3_finalize()] or until the statement is automatically |
| 3931 |
** reprepared by the first call to [sqlite3_step()] for a particular run |
| 3932 |
** or until the same information is requested |
| 3933 |
** again in a different encoding. |
| 3934 |
** |
| 3935 |
** ^The names returned are the original un-aliased names of the |
| 3936 |
** database, table, and column. |
| 3937 |
** |
| 3938 |
** ^The first argument to these interfaces is a [prepared statement]. |
| 3939 |
** ^These functions return information about the Nth result column returned by |
| 3940 |
** the statement, where N is the second function argument. |
| 3941 |
** ^The left-most column is column 0 for these routines. |
| 3942 |
** |
| 3943 |
** ^If the Nth column returned by the statement is an expression or |
| 3944 |
** subquery and is not a column value, then all of these functions return |
| 3945 |
** NULL. ^These routine might also return NULL if a memory allocation error |
| 3946 |
** occurs. ^Otherwise, they return the name of the attached database, table, |
| 3947 |
** or column that query result column was extracted from. |
| 3948 |
** |
| 3949 |
** ^As with all other SQLite APIs, those whose names end with "16" return |
| 3950 |
** UTF-16 encoded strings and the other functions return UTF-8. |
| 3951 |
** |
| 3952 |
** ^These APIs are only available if the library was compiled with the |
| 3953 |
** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. |
| 3954 |
** |
| 3955 |
** If two or more threads call one or more of these routines against the same |
| 3956 |
** prepared statement and column at the same time then the results are |
| 3957 |
** undefined. |
| 3958 |
** |
| 3959 |
** If two or more threads call one or more |
| 3960 |
** [sqlite3_column_database_name | column metadata interfaces] |
| 3961 |
** for the same [prepared statement] and result column |
| 3962 |
** at the same time then the results are undefined. |
| 3963 |
*/ |
| 3964 |
SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); |
| 3965 |
SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); |
| 3966 |
SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); |
| 3967 |
SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); |
| 3968 |
SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); |
| 3969 |
SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); |
| 3970 |
|
| 3971 |
/* |
| 3972 |
** CAPI3REF: Declared Datatype Of A Query Result |
| 3973 |
** METHOD: sqlite3_stmt |
| 3974 |
** |
| 3975 |
** ^(The first parameter is a [prepared statement]. |
| 3976 |
** If this statement is a [SELECT] statement and the Nth column of the |
| 3977 |
** returned result set of that [SELECT] is a table column (not an |
| 3978 |
** expression or subquery) then the declared type of the table |
| 3979 |
** column is returned.)^ ^If the Nth column of the result set is an |
| 3980 |
** expression or subquery, then a NULL pointer is returned. |
| 3981 |
** ^The returned string is always UTF-8 encoded. |
| 3982 |
** |
| 3983 |
** ^(For example, given the database schema: |
| 3984 |
** |
| 3985 |
** CREATE TABLE t1(c1 VARIANT); |
| 3986 |
** |
| 3987 |
** and the following statement to be compiled: |
| 3988 |
** |
| 3989 |
** SELECT c1 + 1, c1 FROM t1; |
| 3990 |
** |
| 3991 |
** this routine would return the string "VARIANT" for the second result |
| 3992 |
** column (i==1), and a NULL pointer for the first result column (i==0).)^ |
| 3993 |
** |
| 3994 |
** ^SQLite uses dynamic run-time typing. ^So just because a column |
| 3995 |
** is declared to contain a particular type does not mean that the |
| 3996 |
** data stored in that column is of the declared type. SQLite is |
| 3997 |
** strongly typed, but the typing is dynamic not static. ^Type |
| 3998 |
** is associated with individual values, not with the containers |
| 3999 |
** used to hold those values. |
| 4000 |
*/ |
| 4001 |
SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); |
| 4002 |
SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); |
| 4003 |
|
| 4004 |
/* |
| 4005 |
** CAPI3REF: Evaluate An SQL Statement |
| 4006 |
** METHOD: sqlite3_stmt |
| 4007 |
** |
| 4008 |
** After a [prepared statement] has been prepared using either |
| 4009 |
** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy |
| 4010 |
** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function |
| 4011 |
** must be called one or more times to evaluate the statement. |
| 4012 |
** |
| 4013 |
** The details of the behavior of the sqlite3_step() interface depend |
| 4014 |
** on whether the statement was prepared using the newer "v2" interface |
| 4015 |
** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy |
| 4016 |
** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the |
| 4017 |
** new "v2" interface is recommended for new applications but the legacy |
| 4018 |
** interface will continue to be supported. |
| 4019 |
** |
| 4020 |
** ^In the legacy interface, the return value will be either [SQLITE_BUSY], |
| 4021 |
** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. |
| 4022 |
** ^With the "v2" interface, any of the other [result codes] or |
| 4023 |
** [extended result codes] might be returned as well. |
| 4024 |
** |
| 4025 |
** ^[SQLITE_BUSY] means that the database engine was unable to acquire the |
| 4026 |
** database locks it needs to do its job. ^If the statement is a [COMMIT] |
| 4027 |
** or occurs outside of an explicit transaction, then you can retry the |
| 4028 |
** statement. If the statement is not a [COMMIT] and occurs within an |
| 4029 |
** explicit transaction then you should rollback the transaction before |
| 4030 |
** continuing. |
| 4031 |
** |
| 4032 |
** ^[SQLITE_DONE] means that the statement has finished executing |
| 4033 |
** successfully. sqlite3_step() should not be called again on this virtual |
| 4034 |
** machine without first calling [sqlite3_reset()] to reset the virtual |
| 4035 |
** machine back to its initial state. |
| 4036 |
** |
| 4037 |
** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] |
| 4038 |
** is returned each time a new row of data is ready for processing by the |
| 4039 |
** caller. The values may be accessed using the [column access functions]. |
| 4040 |
** sqlite3_step() is called again to retrieve the next row of data. |
| 4041 |
** |
| 4042 |
** ^[SQLITE_ERROR] means that a run-time error (such as a constraint |
| 4043 |
** violation) has occurred. sqlite3_step() should not be called again on |
| 4044 |
** the VM. More information may be found by calling [sqlite3_errmsg()]. |
| 4045 |
** ^With the legacy interface, a more specific error code (for example, |
| 4046 |
** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) |
| 4047 |
** can be obtained by calling [sqlite3_reset()] on the |
| 4048 |
** [prepared statement]. ^In the "v2" interface, |
| 4049 |
** the more specific error code is returned directly by sqlite3_step(). |
| 4050 |
** |
| 4051 |
** [SQLITE_MISUSE] means that the this routine was called inappropriately. |
| 4052 |
** Perhaps it was called on a [prepared statement] that has |
| 4053 |
** already been [sqlite3_finalize | finalized] or on one that had |
| 4054 |
** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could |
| 4055 |
** be the case that the same database connection is being used by two or |
| 4056 |
** more threads at the same moment in time. |
| 4057 |
** |
| 4058 |
** For all versions of SQLite up to and including 3.6.23.1, a call to |
| 4059 |
** [sqlite3_reset()] was required after sqlite3_step() returned anything |
| 4060 |
** other than [SQLITE_ROW] before any subsequent invocation of |
| 4061 |
** sqlite3_step(). Failure to reset the prepared statement using |
| 4062 |
** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from |
| 4063 |
** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1], |
| 4064 |
** sqlite3_step() began |
| 4065 |
** calling [sqlite3_reset()] automatically in this circumstance rather |
| 4066 |
** than returning [SQLITE_MISUSE]. This is not considered a compatibility |
| 4067 |
** break because any application that ever receives an SQLITE_MISUSE error |
| 4068 |
** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option |
| 4069 |
** can be used to restore the legacy behavior. |
| 4070 |
** |
| 4071 |
** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() |
| 4072 |
** API always returns a generic error code, [SQLITE_ERROR], following any |
| 4073 |
** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call |
| 4074 |
** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the |
| 4075 |
** specific [error codes] that better describes the error. |
| 4076 |
** We admit that this is a goofy design. The problem has been fixed |
| 4077 |
** with the "v2" interface. If you prepare all of your SQL statements |
| 4078 |
** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead |
| 4079 |
** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, |
| 4080 |
** then the more specific [error codes] are returned directly |
| 4081 |
** by sqlite3_step(). The use of the "v2" interface is recommended. |
| 4082 |
*/ |
| 4083 |
SQLITE_API int sqlite3_step(sqlite3_stmt*); |
| 4084 |
|
| 4085 |
/* |
| 4086 |
** CAPI3REF: Number of columns in a result set |
| 4087 |
** METHOD: sqlite3_stmt |
| 4088 |
** |
| 4089 |
** ^The sqlite3_data_count(P) interface returns the number of columns in the |
| 4090 |
** current row of the result set of [prepared statement] P. |
| 4091 |
** ^If prepared statement P does not have results ready to return |
| 4092 |
** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of |
| 4093 |
** interfaces) then sqlite3_data_count(P) returns 0. |
| 4094 |
** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. |
| 4095 |
** ^The sqlite3_data_count(P) routine returns 0 if the previous call to |
| 4096 |
** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P) |
| 4097 |
** will return non-zero if previous call to [sqlite3_step](P) returned |
| 4098 |
** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] |
| 4099 |
** where it always returns zero since each step of that multi-step |
| 4100 |
** pragma returns 0 columns of data. |
| 4101 |
** |
| 4102 |
** See also: [sqlite3_column_count()] |
| 4103 |
*/ |
| 4104 |
SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); |
| 4105 |
|
| 4106 |
/* |
| 4107 |
** CAPI3REF: Fundamental Datatypes |
| 4108 |
** KEYWORDS: SQLITE_TEXT |
| 4109 |
** |
| 4110 |
** ^(Every value in SQLite has one of five fundamental datatypes: |
| 4111 |
** |
| 4112 |
** <ul> |
| 4113 |
** <li> 64-bit signed integer |
| 4114 |
** <li> 64-bit IEEE floating point number |
| 4115 |
** <li> string |
| 4116 |
** <li> BLOB |
| 4117 |
** <li> NULL |
| 4118 |
** </ul>)^ |
| 4119 |
** |
| 4120 |
** These constants are codes for each of those types. |
| 4121 |
** |
| 4122 |
** Note that the SQLITE_TEXT constant was also used in SQLite version 2 |
| 4123 |
** for a completely different meaning. Software that links against both |
| 4124 |
** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not |
| 4125 |
** SQLITE_TEXT. |
| 4126 |
*/ |
| 4127 |
#define SQLITE_INTEGER 1 |
| 4128 |
#define SQLITE_FLOAT 2 |
| 4129 |
#define SQLITE_BLOB 4 |
| 4130 |
#define SQLITE_NULL 5 |
| 4131 |
#ifdef SQLITE_TEXT |
| 4132 |
# undef SQLITE_TEXT |
| 4133 |
#else |
| 4134 |
# define SQLITE_TEXT 3 |
| 4135 |
#endif |
| 4136 |
#define SQLITE3_TEXT 3 |
| 4137 |
|
| 4138 |
/* |
| 4139 |
** CAPI3REF: Result Values From A Query |
| 4140 |
** KEYWORDS: {column access functions} |
| 4141 |
** METHOD: sqlite3_stmt |
| 4142 |
** |
| 4143 |
** ^These routines return information about a single column of the current |
| 4144 |
** result row of a query. ^In every case the first argument is a pointer |
| 4145 |
** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] |
| 4146 |
** that was returned from [sqlite3_prepare_v2()] or one of its variants) |
| 4147 |
** and the second argument is the index of the column for which information |
| 4148 |
** should be returned. ^The leftmost column of the result set has the index 0. |
| 4149 |
** ^The number of columns in the result can be determined using |
| 4150 |
** [sqlite3_column_count()]. |
| 4151 |
** |
| 4152 |
** If the SQL statement does not currently point to a valid row, or if the |
| 4153 |
** column index is out of range, the result is undefined. |
| 4154 |
** These routines may only be called when the most recent call to |
| 4155 |
** [sqlite3_step()] has returned [SQLITE_ROW] and neither |
| 4156 |
** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. |
| 4157 |
** If any of these routines are called after [sqlite3_reset()] or |
| 4158 |
** [sqlite3_finalize()] or after [sqlite3_step()] has returned |
| 4159 |
** something other than [SQLITE_ROW], the results are undefined. |
| 4160 |
** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] |
| 4161 |
** are called from a different thread while any of these routines |
| 4162 |
** are pending, then the results are undefined. |
| 4163 |
** |
| 4164 |
** ^The sqlite3_column_type() routine returns the |
| 4165 |
** [SQLITE_INTEGER | datatype code] for the initial data type |
| 4166 |
** of the result column. ^The returned value is one of [SQLITE_INTEGER], |
| 4167 |
** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value |
| 4168 |
** returned by sqlite3_column_type() is only meaningful if no type |
| 4169 |
** conversions have occurred as described below. After a type conversion, |
| 4170 |
** the value returned by sqlite3_column_type() is undefined. Future |
| 4171 |
** versions of SQLite may change the behavior of sqlite3_column_type() |
| 4172 |
** following a type conversion. |
| 4173 |
** |
| 4174 |
** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() |
| 4175 |
** routine returns the number of bytes in that BLOB or string. |
| 4176 |
** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts |
| 4177 |
** the string to UTF-8 and then returns the number of bytes. |
| 4178 |
** ^If the result is a numeric value then sqlite3_column_bytes() uses |
| 4179 |
** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns |
| 4180 |
** the number of bytes in that string. |
| 4181 |
** ^If the result is NULL, then sqlite3_column_bytes() returns zero. |
| 4182 |
** |
| 4183 |
** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() |
| 4184 |
** routine returns the number of bytes in that BLOB or string. |
| 4185 |
** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts |
| 4186 |
** the string to UTF-16 and then returns the number of bytes. |
| 4187 |
** ^If the result is a numeric value then sqlite3_column_bytes16() uses |
| 4188 |
** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns |
| 4189 |
** the number of bytes in that string. |
| 4190 |
** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. |
| 4191 |
** |
| 4192 |
** ^The values returned by [sqlite3_column_bytes()] and |
| 4193 |
** [sqlite3_column_bytes16()] do not include the zero terminators at the end |
| 4194 |
** of the string. ^For clarity: the values returned by |
| 4195 |
** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of |
| 4196 |
** bytes in the string, not the number of characters. |
| 4197 |
** |
| 4198 |
** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), |
| 4199 |
** even empty strings, are always zero-terminated. ^The return |
| 4200 |
** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. |
| 4201 |
** |
| 4202 |
** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an |
| 4203 |
** [unprotected sqlite3_value] object. In a multithreaded environment, |
| 4204 |
** an unprotected sqlite3_value object may only be used safely with |
| 4205 |
** [sqlite3_bind_value()] and [sqlite3_result_value()]. |
| 4206 |
** If the [unprotected sqlite3_value] object returned by |
| 4207 |
** [sqlite3_column_value()] is used in any other way, including calls |
| 4208 |
** to routines like [sqlite3_value_int()], [sqlite3_value_text()], |
| 4209 |
** or [sqlite3_value_bytes()], the behavior is not threadsafe. |
| 4210 |
** |
| 4211 |
** These routines attempt to convert the value where appropriate. ^For |
| 4212 |
** example, if the internal representation is FLOAT and a text result |
| 4213 |
** is requested, [sqlite3_snprintf()] is used internally to perform the |
| 4214 |
** conversion automatically. ^(The following table details the conversions |
| 4215 |
** that are applied: |
| 4216 |
** |
| 4217 |
** <blockquote> |
| 4218 |
** <table border="1"> |
| 4219 |
** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion |
| 4220 |
** |
| 4221 |
** <tr><td> NULL <td> INTEGER <td> Result is 0 |
| 4222 |
** <tr><td> NULL <td> FLOAT <td> Result is 0.0 |
| 4223 |
** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer |
| 4224 |
** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer |
| 4225 |
** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float |
| 4226 |
** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer |
| 4227 |
** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT |
| 4228 |
** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER |
| 4229 |
** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float |
| 4230 |
** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB |
| 4231 |
** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER |
| 4232 |
** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL |
| 4233 |
** <tr><td> TEXT <td> BLOB <td> No change |
| 4234 |
** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER |
| 4235 |
** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL |
| 4236 |
** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed |
| 4237 |
** </table> |
| 4238 |
** </blockquote>)^ |
| 4239 |
** |
| 4240 |
** Note that when type conversions occur, pointers returned by prior |
| 4241 |
** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or |
| 4242 |
** sqlite3_column_text16() may be invalidated. |
| 4243 |
** Type conversions and pointer invalidations might occur |
| 4244 |
** in the following cases: |
| 4245 |
** |
| 4246 |
** <ul> |
| 4247 |
** <li> The initial content is a BLOB and sqlite3_column_text() or |
| 4248 |
** sqlite3_column_text16() is called. A zero-terminator might |
| 4249 |
** need to be added to the string.</li> |
| 4250 |
** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or |
| 4251 |
** sqlite3_column_text16() is called. The content must be converted |
| 4252 |
** to UTF-16.</li> |
| 4253 |
** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or |
| 4254 |
** sqlite3_column_text() is called. The content must be converted |
| 4255 |
** to UTF-8.</li> |
| 4256 |
** </ul> |
| 4257 |
** |
| 4258 |
** ^Conversions between UTF-16be and UTF-16le are always done in place and do |
| 4259 |
** not invalidate a prior pointer, though of course the content of the buffer |
| 4260 |
** that the prior pointer references will have been modified. Other kinds |
| 4261 |
** of conversion are done in place when it is possible, but sometimes they |
| 4262 |
** are not possible and in those cases prior pointers are invalidated. |
| 4263 |
** |
| 4264 |
** The safest policy is to invoke these routines |
| 4265 |
** in one of the following ways: |
| 4266 |
** |
| 4267 |
** <ul> |
| 4268 |
** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> |
| 4269 |
** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> |
| 4270 |
** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> |
| 4271 |
** </ul> |
| 4272 |
** |
| 4273 |
** In other words, you should call sqlite3_column_text(), |
| 4274 |
** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result |
| 4275 |
** into the desired format, then invoke sqlite3_column_bytes() or |
| 4276 |
** sqlite3_column_bytes16() to find the size of the result. Do not mix calls |
| 4277 |
** to sqlite3_column_text() or sqlite3_column_blob() with calls to |
| 4278 |
** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() |
| 4279 |
** with calls to sqlite3_column_bytes(). |
| 4280 |
** |
| 4281 |
** ^The pointers returned are valid until a type conversion occurs as |
| 4282 |
** described above, or until [sqlite3_step()] or [sqlite3_reset()] or |
| 4283 |
** [sqlite3_finalize()] is called. ^The memory space used to hold strings |
| 4284 |
** and BLOBs is freed automatically. Do <em>not</em> pass the pointers returned |
| 4285 |
** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into |
| 4286 |
** [sqlite3_free()]. |
| 4287 |
** |
| 4288 |
** ^(If a memory allocation error occurs during the evaluation of any |
| 4289 |
** of these routines, a default value is returned. The default value |
| 4290 |
** is either the integer 0, the floating point number 0.0, or a NULL |
| 4291 |
** pointer. Subsequent calls to [sqlite3_errcode()] will return |
| 4292 |
** [SQLITE_NOMEM].)^ |
| 4293 |
*/ |
| 4294 |
SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); |
| 4295 |
SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); |
| 4296 |
SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); |
| 4297 |
SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); |
| 4298 |
SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); |
| 4299 |
SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); |
| 4300 |
SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); |
| 4301 |
SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); |
| 4302 |
SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); |
| 4303 |
SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); |
| 4304 |
|
| 4305 |
/* |
| 4306 |
** CAPI3REF: Destroy A Prepared Statement Object |
| 4307 |
** DESTRUCTOR: sqlite3_stmt |
| 4308 |
** |
| 4309 |
** ^The sqlite3_finalize() function is called to delete a [prepared statement]. |
| 4310 |
** ^If the most recent evaluation of the statement encountered no errors |
| 4311 |
** or if the statement is never been evaluated, then sqlite3_finalize() returns |
| 4312 |
** SQLITE_OK. ^If the most recent evaluation of statement S failed, then |
| 4313 |
** sqlite3_finalize(S) returns the appropriate [error code] or |
| 4314 |
** [extended error code]. |
| 4315 |
** |
| 4316 |
** ^The sqlite3_finalize(S) routine can be called at any point during |
| 4317 |
** the life cycle of [prepared statement] S: |
| 4318 |
** before statement S is ever evaluated, after |
| 4319 |
** one or more calls to [sqlite3_reset()], or after any call |
| 4320 |
** to [sqlite3_step()] regardless of whether or not the statement has |
| 4321 |
** completed execution. |
| 4322 |
** |
| 4323 |
** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. |
| 4324 |
** |
| 4325 |
** The application must finalize every [prepared statement] in order to avoid |
| 4326 |
** resource leaks. It is a grievous error for the application to try to use |
| 4327 |
** a prepared statement after it has been finalized. Any use of a prepared |
| 4328 |
** statement after it has been finalized can result in undefined and |
| 4329 |
** undesirable behavior such as segfaults and heap corruption. |
| 4330 |
*/ |
| 4331 |
SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); |
| 4332 |
|
| 4333 |
/* |
| 4334 |
** CAPI3REF: Reset A Prepared Statement Object |
| 4335 |
** METHOD: sqlite3_stmt |
| 4336 |
** |
| 4337 |
** The sqlite3_reset() function is called to reset a [prepared statement] |
| 4338 |
** object back to its initial state, ready to be re-executed. |
| 4339 |
** ^Any SQL statement variables that had values bound to them using |
| 4340 |
** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. |
| 4341 |
** Use [sqlite3_clear_bindings()] to reset the bindings. |
| 4342 |
** |
| 4343 |
** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S |
| 4344 |
** back to the beginning of its program. |
| 4345 |
** |
| 4346 |
** ^If the most recent call to [sqlite3_step(S)] for the |
| 4347 |
** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], |
| 4348 |
** or if [sqlite3_step(S)] has never before been called on S, |
| 4349 |
** then [sqlite3_reset(S)] returns [SQLITE_OK]. |
| 4350 |
** |
| 4351 |
** ^If the most recent call to [sqlite3_step(S)] for the |
| 4352 |
** [prepared statement] S indicated an error, then |
| 4353 |
** [sqlite3_reset(S)] returns an appropriate [error code]. |
| 4354 |
** |
| 4355 |
** ^The [sqlite3_reset(S)] interface does not change the values |
| 4356 |
** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. |
| 4357 |
*/ |
| 4358 |
SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); |
| 4359 |
|
| 4360 |
/* |
| 4361 |
** CAPI3REF: Create Or Redefine SQL Functions |
| 4362 |
** KEYWORDS: {function creation routines} |
| 4363 |
** KEYWORDS: {application-defined SQL function} |
| 4364 |
** KEYWORDS: {application-defined SQL functions} |
| 4365 |
** METHOD: sqlite3 |
| 4366 |
** |
| 4367 |
** ^These functions (collectively known as "function creation routines") |
| 4368 |
** are used to add SQL functions or aggregates or to redefine the behavior |
| 4369 |
** of existing SQL functions or aggregates. The only differences between |
| 4370 |
** these routines are the text encoding expected for |
| 4371 |
** the second parameter (the name of the function being created) |
| 4372 |
** and the presence or absence of a destructor callback for |
| 4373 |
** the application data pointer. |
| 4374 |
** |
| 4375 |
** ^The first parameter is the [database connection] to which the SQL |
| 4376 |
** function is to be added. ^If an application uses more than one database |
| 4377 |
** connection then application-defined SQL functions must be added |
| 4378 |
** to each database connection separately. |
| 4379 |
** |
| 4380 |
** ^The second parameter is the name of the SQL function to be created or |
| 4381 |
** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 |
| 4382 |
** representation, exclusive of the zero-terminator. ^Note that the name |
| 4383 |
** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. |
| 4384 |
** ^Any attempt to create a function with a longer name |
| 4385 |
** will result in [SQLITE_MISUSE] being returned. |
| 4386 |
** |
| 4387 |
** ^The third parameter (nArg) |
| 4388 |
** is the number of arguments that the SQL function or |
| 4389 |
** aggregate takes. ^If this parameter is -1, then the SQL function or |
| 4390 |
** aggregate may take any number of arguments between 0 and the limit |
| 4391 |
** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third |
| 4392 |
** parameter is less than -1 or greater than 127 then the behavior is |
| 4393 |
** undefined. |
| 4394 |
** |
| 4395 |
** ^The fourth parameter, eTextRep, specifies what |
| 4396 |
** [SQLITE_UTF8 | text encoding] this SQL function prefers for |
| 4397 |
** its parameters. The application should set this parameter to |
| 4398 |
** [SQLITE_UTF16LE] if the function implementation invokes |
| 4399 |
** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the |
| 4400 |
** implementation invokes [sqlite3_value_text16be()] on an input, or |
| 4401 |
** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8] |
| 4402 |
** otherwise. ^The same SQL function may be registered multiple times using |
| 4403 |
** different preferred text encodings, with different implementations for |
| 4404 |
** each encoding. |
| 4405 |
** ^When multiple implementations of the same function are available, SQLite |
| 4406 |
** will pick the one that involves the least amount of data conversion. |
| 4407 |
** |
| 4408 |
** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC] |
| 4409 |
** to signal that the function will always return the same result given |
| 4410 |
** the same inputs within a single SQL statement. Most SQL functions are |
| 4411 |
** deterministic. The built-in [random()] SQL function is an example of a |
| 4412 |
** function that is not deterministic. The SQLite query planner is able to |
| 4413 |
** perform additional optimizations on deterministic functions, so use |
| 4414 |
** of the [SQLITE_DETERMINISTIC] flag is recommended where possible. |
| 4415 |
** |
| 4416 |
** ^(The fifth parameter is an arbitrary pointer. The implementation of the |
| 4417 |
** function can gain access to this pointer using [sqlite3_user_data()].)^ |
| 4418 |
** |
| 4419 |
** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are |
| 4420 |
** pointers to C-language functions that implement the SQL function or |
| 4421 |
** aggregate. ^A scalar SQL function requires an implementation of the xFunc |
| 4422 |
** callback only; NULL pointers must be passed as the xStep and xFinal |
| 4423 |
** parameters. ^An aggregate SQL function requires an implementation of xStep |
| 4424 |
** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing |
| 4425 |
** SQL function or aggregate, pass NULL pointers for all three function |
| 4426 |
** callbacks. |
| 4427 |
** |
| 4428 |
** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, |
| 4429 |
** then it is destructor for the application data pointer. |
| 4430 |
** The destructor is invoked when the function is deleted, either by being |
| 4431 |
** overloaded or when the database connection closes.)^ |
| 4432 |
** ^The destructor is also invoked if the call to |
| 4433 |
** sqlite3_create_function_v2() fails. |
| 4434 |
** ^When the destructor callback of the tenth parameter is invoked, it |
| 4435 |
** is passed a single argument which is a copy of the application data |
| 4436 |
** pointer which was the fifth parameter to sqlite3_create_function_v2(). |
| 4437 |
** |
| 4438 |
** ^It is permitted to register multiple implementations of the same |
| 4439 |
** functions with the same name but with either differing numbers of |
| 4440 |
** arguments or differing preferred text encodings. ^SQLite will use |
| 4441 |
** the implementation that most closely matches the way in which the |
| 4442 |
** SQL function is used. ^A function implementation with a non-negative |
| 4443 |
** nArg parameter is a better match than a function implementation with |
| 4444 |
** a negative nArg. ^A function where the preferred text encoding |
| 4445 |
** matches the database encoding is a better |
| 4446 |
** match than a function where the encoding is different. |
| 4447 |
** ^A function where the encoding difference is between UTF16le and UTF16be |
| 4448 |
** is a closer match than a function where the encoding difference is |
| 4449 |
** between UTF8 and UTF16. |
| 4450 |
** |
| 4451 |
** ^Built-in functions may be overloaded by new application-defined functions. |
| 4452 |
** |
| 4453 |
** ^An application-defined function is permitted to call other |
| 4454 |
** SQLite interfaces. However, such calls must not |
| 4455 |
** close the database connection nor finalize or reset the prepared |
| 4456 |
** statement in which the function is running. |
| 4457 |
*/ |
| 4458 |
SQLITE_API int sqlite3_create_function( |
| 4459 |
sqlite3 *db, |
| 4460 |
const char *zFunctionName, |
| 4461 |
int nArg, |
| 4462 |
int eTextRep, |
| 4463 |
void *pApp, |
| 4464 |
void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
| 4465 |
void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
| 4466 |
void (*xFinal)(sqlite3_context*) |
| 4467 |
); |
| 4468 |
SQLITE_API int sqlite3_create_function16( |
| 4469 |
sqlite3 *db, |
| 4470 |
const void *zFunctionName, |
| 4471 |
int nArg, |
| 4472 |
int eTextRep, |
| 4473 |
void *pApp, |
| 4474 |
void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
| 4475 |
void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
| 4476 |
void (*xFinal)(sqlite3_context*) |
| 4477 |
); |
| 4478 |
SQLITE_API int sqlite3_create_function_v2( |
| 4479 |
sqlite3 *db, |
| 4480 |
const char *zFunctionName, |
| 4481 |
int nArg, |
| 4482 |
int eTextRep, |
| 4483 |
void *pApp, |
| 4484 |
void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
| 4485 |
void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
| 4486 |
void (*xFinal)(sqlite3_context*), |
| 4487 |
void(*xDestroy)(void*) |
| 4488 |
); |
| 4489 |
|
| 4490 |
/* |
| 4491 |
** CAPI3REF: Text Encodings |
| 4492 |
** |
| 4493 |
** These constant define integer codes that represent the various |
| 4494 |
** text encodings supported by SQLite. |
| 4495 |
*/ |
| 4496 |
#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */ |
| 4497 |
#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */ |
| 4498 |
#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */ |
| 4499 |
#define SQLITE_UTF16 4 /* Use native byte order */ |
| 4500 |
#define SQLITE_ANY 5 /* Deprecated */ |
| 4501 |
#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ |
| 4502 |
|
| 4503 |
/* |
| 4504 |
** CAPI3REF: Function Flags |
| 4505 |
** |
| 4506 |
** These constants may be ORed together with the |
| 4507 |
** [SQLITE_UTF8 | preferred text encoding] as the fourth argument |
| 4508 |
** to [sqlite3_create_function()], [sqlite3_create_function16()], or |
| 4509 |
** [sqlite3_create_function_v2()]. |
| 4510 |
*/ |
| 4511 |
#define SQLITE_DETERMINISTIC 0x800 |
| 4512 |
|
| 4513 |
/* |
| 4514 |
** CAPI3REF: Deprecated Functions |
| 4515 |
** DEPRECATED |
| 4516 |
** |
| 4517 |
** These functions are [deprecated]. In order to maintain |
| 4518 |
** backwards compatibility with older code, these functions continue |
| 4519 |
** to be supported. However, new applications should avoid |
| 4520 |
** the use of these functions. To encourage programmers to avoid |
| 4521 |
** these functions, we will not explain what they do. |
| 4522 |
*/ |
| 4523 |
#ifndef SQLITE_OMIT_DEPRECATED |
| 4524 |
SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); |
| 4525 |
SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); |
| 4526 |
SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); |
| 4527 |
SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); |
| 4528 |
SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); |
| 4529 |
SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int), |
| 4530 |
void*,sqlite3_int64); |
| 4531 |
#endif |
| 4532 |
|
| 4533 |
/* |
| 4534 |
** CAPI3REF: Obtaining SQL Values |
| 4535 |
** METHOD: sqlite3_value |
| 4536 |
** |
| 4537 |
** The C-language implementation of SQL functions and aggregates uses |
| 4538 |
** this set of interface routines to access the parameter values on |
| 4539 |
** the function or aggregate. |
| 4540 |
** |
| 4541 |
** The xFunc (for scalar functions) or xStep (for aggregates) parameters |
| 4542 |
** to [sqlite3_create_function()] and [sqlite3_create_function16()] |
| 4543 |
** define callbacks that implement the SQL functions and aggregates. |
| 4544 |
** The 3rd parameter to these callbacks is an array of pointers to |
| 4545 |
** [protected sqlite3_value] objects. There is one [sqlite3_value] object for |
| 4546 |
** each parameter to the SQL function. These routines are used to |
| 4547 |
** extract values from the [sqlite3_value] objects. |
| 4548 |
** |
| 4549 |
** These routines work only with [protected sqlite3_value] objects. |
| 4550 |
** Any attempt to use these routines on an [unprotected sqlite3_value] |
| 4551 |
** object results in undefined behavior. |
| 4552 |
** |
| 4553 |
** ^These routines work just like the corresponding [column access functions] |
| 4554 |
** except that these routines take a single [protected sqlite3_value] object |
| 4555 |
** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. |
| 4556 |
** |
| 4557 |
** ^The sqlite3_value_text16() interface extracts a UTF-16 string |
| 4558 |
** in the native byte-order of the host machine. ^The |
| 4559 |
** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces |
| 4560 |
** extract UTF-16 strings as big-endian and little-endian respectively. |
| 4561 |
** |
| 4562 |
** ^(The sqlite3_value_numeric_type() interface attempts to apply |
| 4563 |
** numeric affinity to the value. This means that an attempt is |
| 4564 |
** made to convert the value to an integer or floating point. If |
| 4565 |
** such a conversion is possible without loss of information (in other |
| 4566 |
** words, if the value is a string that looks like a number) |
| 4567 |
** then the conversion is performed. Otherwise no conversion occurs. |
| 4568 |
** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ |
| 4569 |
** |
| 4570 |
** Please pay particular attention to the fact that the pointer returned |
| 4571 |
** from [sqlite3_value_blob()], [sqlite3_value_text()], or |
| 4572 |
** [sqlite3_value_text16()] can be invalidated by a subsequent call to |
| 4573 |
** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], |
| 4574 |
** or [sqlite3_value_text16()]. |
| 4575 |
** |
| 4576 |
** These routines must be called from the same thread as |
| 4577 |
** the SQL function that supplied the [sqlite3_value*] parameters. |
| 4578 |
*/ |
| 4579 |
SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); |
| 4580 |
SQLITE_API int sqlite3_value_bytes(sqlite3_value*); |
| 4581 |
SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); |
| 4582 |
SQLITE_API double sqlite3_value_double(sqlite3_value*); |
| 4583 |
SQLITE_API int sqlite3_value_int(sqlite3_value*); |
| 4584 |
SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); |
| 4585 |
SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); |
| 4586 |
SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); |
| 4587 |
SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); |
| 4588 |
SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); |
| 4589 |
SQLITE_API int sqlite3_value_type(sqlite3_value*); |
| 4590 |
SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); |
| 4591 |
|
| 4592 |
/* |
| 4593 |
** CAPI3REF: Finding The Subtype Of SQL Values |
| 4594 |
** METHOD: sqlite3_value |
| 4595 |
** |
| 4596 |
** The sqlite3_value_subtype(V) function returns the subtype for |
| 4597 |
** an [application-defined SQL function] argument V. The subtype |
| 4598 |
** information can be used to pass a limited amount of context from |
| 4599 |
** one SQL function to another. Use the [sqlite3_result_subtype()] |
| 4600 |
** routine to set the subtype for the return value of an SQL function. |
| 4601 |
** |
| 4602 |
** SQLite makes no use of subtype itself. It merely passes the subtype |
| 4603 |
** from the result of one [application-defined SQL function] into the |
| 4604 |
** input of another. |
| 4605 |
*/ |
| 4606 |
SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*); |
| 4607 |
|
| 4608 |
/* |
| 4609 |
** CAPI3REF: Copy And Free SQL Values |
| 4610 |
** METHOD: sqlite3_value |
| 4611 |
** |
| 4612 |
** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value] |
| 4613 |
** object D and returns a pointer to that copy. ^The [sqlite3_value] returned |
| 4614 |
** is a [protected sqlite3_value] object even if the input is not. |
| 4615 |
** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a |
| 4616 |
** memory allocation fails. |
| 4617 |
** |
| 4618 |
** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object |
| 4619 |
** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer |
| 4620 |
** then sqlite3_value_free(V) is a harmless no-op. |
| 4621 |
*/ |
| 4622 |
SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*); |
| 4623 |
SQLITE_API void sqlite3_value_free(sqlite3_value*); |
| 4624 |
|
| 4625 |
/* |
| 4626 |
** CAPI3REF: Obtain Aggregate Function Context |
| 4627 |
** METHOD: sqlite3_context |
| 4628 |
** |
| 4629 |
** Implementations of aggregate SQL functions use this |
| 4630 |
** routine to allocate memory for storing their state. |
| 4631 |
** |
| 4632 |
** ^The first time the sqlite3_aggregate_context(C,N) routine is called |
| 4633 |
** for a particular aggregate function, SQLite |
| 4634 |
** allocates N of memory, zeroes out that memory, and returns a pointer |
| 4635 |
** to the new memory. ^On second and subsequent calls to |
| 4636 |
** sqlite3_aggregate_context() for the same aggregate function instance, |
| 4637 |
** the same buffer is returned. Sqlite3_aggregate_context() is normally |
| 4638 |
** called once for each invocation of the xStep callback and then one |
| 4639 |
** last time when the xFinal callback is invoked. ^(When no rows match |
| 4640 |
** an aggregate query, the xStep() callback of the aggregate function |
| 4641 |
** implementation is never called and xFinal() is called exactly once. |
| 4642 |
** In those cases, sqlite3_aggregate_context() might be called for the |
| 4643 |
** first time from within xFinal().)^ |
| 4644 |
** |
| 4645 |
** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer |
| 4646 |
** when first called if N is less than or equal to zero or if a memory |
| 4647 |
** allocate error occurs. |
| 4648 |
** |
| 4649 |
** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is |
| 4650 |
** determined by the N parameter on first successful call. Changing the |
| 4651 |
** value of N in subsequent call to sqlite3_aggregate_context() within |
| 4652 |
** the same aggregate function instance will not resize the memory |
| 4653 |
** allocation.)^ Within the xFinal callback, it is customary to set |
| 4654 |
** N=0 in calls to sqlite3_aggregate_context(C,N) so that no |
| 4655 |
** pointless memory allocations occur. |
| 4656 |
** |
| 4657 |
** ^SQLite automatically frees the memory allocated by |
| 4658 |
** sqlite3_aggregate_context() when the aggregate query concludes. |
| 4659 |
** |
| 4660 |
** The first parameter must be a copy of the |
| 4661 |
** [sqlite3_context | SQL function context] that is the first parameter |
| 4662 |
** to the xStep or xFinal callback routine that implements the aggregate |
| 4663 |
** function. |
| 4664 |
** |
| 4665 |
** This routine must be called from the same thread in which |
| 4666 |
** the aggregate SQL function is running. |
| 4667 |
*/ |
| 4668 |
SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); |
| 4669 |
|
| 4670 |
/* |
| 4671 |
** CAPI3REF: User Data For Functions |
| 4672 |
** METHOD: sqlite3_context |
| 4673 |
** |
| 4674 |
** ^The sqlite3_user_data() interface returns a copy of |
| 4675 |
** the pointer that was the pUserData parameter (the 5th parameter) |
| 4676 |
** of the [sqlite3_create_function()] |
| 4677 |
** and [sqlite3_create_function16()] routines that originally |
| 4678 |
** registered the application defined function. |
| 4679 |
** |
| 4680 |
** This routine must be called from the same thread in which |
| 4681 |
** the application-defined function is running. |
| 4682 |
*/ |
| 4683 |
SQLITE_API void *sqlite3_user_data(sqlite3_context*); |
| 4684 |
|
| 4685 |
/* |
| 4686 |
** CAPI3REF: Database Connection For Functions |
| 4687 |
** METHOD: sqlite3_context |
| 4688 |
** |
| 4689 |
** ^The sqlite3_context_db_handle() interface returns a copy of |
| 4690 |
** the pointer to the [database connection] (the 1st parameter) |
| 4691 |
** of the [sqlite3_create_function()] |
| 4692 |
** and [sqlite3_create_function16()] routines that originally |
| 4693 |
** registered the application defined function. |
| 4694 |
*/ |
| 4695 |
SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); |
| 4696 |
|
| 4697 |
/* |
| 4698 |
** CAPI3REF: Function Auxiliary Data |
| 4699 |
** METHOD: sqlite3_context |
| 4700 |
** |
| 4701 |
** These functions may be used by (non-aggregate) SQL functions to |
| 4702 |
** associate metadata with argument values. If the same value is passed to |
| 4703 |
** multiple invocations of the same SQL function during query execution, under |
| 4704 |
** some circumstances the associated metadata may be preserved. An example |
| 4705 |
** of where this might be useful is in a regular-expression matching |
| 4706 |
** function. The compiled version of the regular expression can be stored as |
| 4707 |
** metadata associated with the pattern string. |
| 4708 |
** Then as long as the pattern string remains the same, |
| 4709 |
** the compiled regular expression can be reused on multiple |
| 4710 |
** invocations of the same function. |
| 4711 |
** |
| 4712 |
** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata |
| 4713 |
** associated by the sqlite3_set_auxdata() function with the Nth argument |
| 4714 |
** value to the application-defined function. ^If there is no metadata |
| 4715 |
** associated with the function argument, this sqlite3_get_auxdata() interface |
| 4716 |
** returns a NULL pointer. |
| 4717 |
** |
| 4718 |
** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th |
| 4719 |
** argument of the application-defined function. ^Subsequent |
| 4720 |
** calls to sqlite3_get_auxdata(C,N) return P from the most recent |
| 4721 |
** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or |
| 4722 |
** NULL if the metadata has been discarded. |
| 4723 |
** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL, |
| 4724 |
** SQLite will invoke the destructor function X with parameter P exactly |
| 4725 |
** once, when the metadata is discarded. |
| 4726 |
** SQLite is free to discard the metadata at any time, including: <ul> |
| 4727 |
** <li> ^(when the corresponding function parameter changes)^, or |
| 4728 |
** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the |
| 4729 |
** SQL statement)^, or |
| 4730 |
** <li> ^(when sqlite3_set_auxdata() is invoked again on the same |
| 4731 |
** parameter)^, or |
| 4732 |
** <li> ^(during the original sqlite3_set_auxdata() call when a memory |
| 4733 |
** allocation error occurs.)^ </ul> |
| 4734 |
** |
| 4735 |
** Note the last bullet in particular. The destructor X in |
| 4736 |
** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the |
| 4737 |
** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata() |
| 4738 |
** should be called near the end of the function implementation and the |
| 4739 |
** function implementation should not make any use of P after |
| 4740 |
** sqlite3_set_auxdata() has been called. |
| 4741 |
** |
| 4742 |
** ^(In practice, metadata is preserved between function calls for |
| 4743 |
** function parameters that are compile-time constants, including literal |
| 4744 |
** values and [parameters] and expressions composed from the same.)^ |
| 4745 |
** |
| 4746 |
** These routines must be called from the same thread in which |
| 4747 |
** the SQL function is running. |
| 4748 |
*/ |
| 4749 |
SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); |
| 4750 |
SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); |
| 4751 |
|
| 4752 |
|
| 4753 |
/* |
| 4754 |
** CAPI3REF: Constants Defining Special Destructor Behavior |
| 4755 |
** |
| 4756 |
** These are special values for the destructor that is passed in as the |
| 4757 |
** final argument to routines like [sqlite3_result_blob()]. ^If the destructor |
| 4758 |
** argument is SQLITE_STATIC, it means that the content pointer is constant |
| 4759 |
** and will never change. It does not need to be destroyed. ^The |
| 4760 |
** SQLITE_TRANSIENT value means that the content will likely change in |
| 4761 |
** the near future and that SQLite should make its own private copy of |
| 4762 |
** the content before returning. |
| 4763 |
** |
| 4764 |
** The typedef is necessary to work around problems in certain |
| 4765 |
** C++ compilers. |
| 4766 |
*/ |
| 4767 |
typedef void (*sqlite3_destructor_type)(void*); |
| 4768 |
#define SQLITE_STATIC ((sqlite3_destructor_type)0) |
| 4769 |
#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) |
| 4770 |
|
| 4771 |
/* |
| 4772 |
** CAPI3REF: Setting The Result Of An SQL Function |
| 4773 |
** METHOD: sqlite3_context |
| 4774 |
** |
| 4775 |
** These routines are used by the xFunc or xFinal callbacks that |
| 4776 |
** implement SQL functions and aggregates. See |
| 4777 |
** [sqlite3_create_function()] and [sqlite3_create_function16()] |
| 4778 |
** for additional information. |
| 4779 |
** |
| 4780 |
** These functions work very much like the [parameter binding] family of |
| 4781 |
** functions used to bind values to host parameters in prepared statements. |
| 4782 |
** Refer to the [SQL parameter] documentation for additional information. |
| 4783 |
** |
| 4784 |
** ^The sqlite3_result_blob() interface sets the result from |
| 4785 |
** an application-defined function to be the BLOB whose content is pointed |
| 4786 |
** to by the second parameter and which is N bytes long where N is the |
| 4787 |
** third parameter. |
| 4788 |
** |
| 4789 |
** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N) |
| 4790 |
** interfaces set the result of the application-defined function to be |
| 4791 |
** a BLOB containing all zero bytes and N bytes in size. |
| 4792 |
** |
| 4793 |
** ^The sqlite3_result_double() interface sets the result from |
| 4794 |
** an application-defined function to be a floating point value specified |
| 4795 |
** by its 2nd argument. |
| 4796 |
** |
| 4797 |
** ^The sqlite3_result_error() and sqlite3_result_error16() functions |
| 4798 |
** cause the implemented SQL function to throw an exception. |
| 4799 |
** ^SQLite uses the string pointed to by the |
| 4800 |
** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() |
| 4801 |
** as the text of an error message. ^SQLite interprets the error |
| 4802 |
** message string from sqlite3_result_error() as UTF-8. ^SQLite |
| 4803 |
** interprets the string from sqlite3_result_error16() as UTF-16 in native |
| 4804 |
** byte order. ^If the third parameter to sqlite3_result_error() |
| 4805 |
** or sqlite3_result_error16() is negative then SQLite takes as the error |
| 4806 |
** message all text up through the first zero character. |
| 4807 |
** ^If the third parameter to sqlite3_result_error() or |
| 4808 |
** sqlite3_result_error16() is non-negative then SQLite takes that many |
| 4809 |
** bytes (not characters) from the 2nd parameter as the error message. |
| 4810 |
** ^The sqlite3_result_error() and sqlite3_result_error16() |
| 4811 |
** routines make a private copy of the error message text before |
| 4812 |
** they return. Hence, the calling function can deallocate or |
| 4813 |
** modify the text after they return without harm. |
| 4814 |
** ^The sqlite3_result_error_code() function changes the error code |
| 4815 |
** returned by SQLite as a result of an error in a function. ^By default, |
| 4816 |
** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() |
| 4817 |
** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. |
| 4818 |
** |
| 4819 |
** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an |
| 4820 |
** error indicating that a string or BLOB is too long to represent. |
| 4821 |
** |
| 4822 |
** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an |
| 4823 |
** error indicating that a memory allocation failed. |
| 4824 |
** |
| 4825 |
** ^The sqlite3_result_int() interface sets the return value |
| 4826 |
** of the application-defined function to be the 32-bit signed integer |
| 4827 |
** value given in the 2nd argument. |
| 4828 |
** ^The sqlite3_result_int64() interface sets the return value |
| 4829 |
** of the application-defined function to be the 64-bit signed integer |
| 4830 |
** value given in the 2nd argument. |
| 4831 |
** |
| 4832 |
** ^The sqlite3_result_null() interface sets the return value |
| 4833 |
** of the application-defined function to be NULL. |
| 4834 |
** |
| 4835 |
** ^The sqlite3_result_text(), sqlite3_result_text16(), |
| 4836 |
** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces |
| 4837 |
** set the return value of the application-defined function to be |
| 4838 |
** a text string which is represented as UTF-8, UTF-16 native byte order, |
| 4839 |
** UTF-16 little endian, or UTF-16 big endian, respectively. |
| 4840 |
** ^The sqlite3_result_text64() interface sets the return value of an |
| 4841 |
** application-defined function to be a text string in an encoding |
| 4842 |
** specified by the fifth (and last) parameter, which must be one |
| 4843 |
** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]. |
| 4844 |
** ^SQLite takes the text result from the application from |
| 4845 |
** the 2nd parameter of the sqlite3_result_text* interfaces. |
| 4846 |
** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
| 4847 |
** is negative, then SQLite takes result text from the 2nd parameter |
| 4848 |
** through the first zero character. |
| 4849 |
** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
| 4850 |
** is non-negative, then as many bytes (not characters) of the text |
| 4851 |
** pointed to by the 2nd parameter are taken as the application-defined |
| 4852 |
** function result. If the 3rd parameter is non-negative, then it |
| 4853 |
** must be the byte offset into the string where the NUL terminator would |
| 4854 |
** appear if the string where NUL terminated. If any NUL characters occur |
| 4855 |
** in the string at a byte offset that is less than the value of the 3rd |
| 4856 |
** parameter, then the resulting string will contain embedded NULs and the |
| 4857 |
** result of expressions operating on strings with embedded NULs is undefined. |
| 4858 |
** ^If the 4th parameter to the sqlite3_result_text* interfaces |
| 4859 |
** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that |
| 4860 |
** function as the destructor on the text or BLOB result when it has |
| 4861 |
** finished using that result. |
| 4862 |
** ^If the 4th parameter to the sqlite3_result_text* interfaces or to |
| 4863 |
** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite |
| 4864 |
** assumes that the text or BLOB result is in constant space and does not |
| 4865 |
** copy the content of the parameter nor call a destructor on the content |
| 4866 |
** when it has finished using that result. |
| 4867 |
** ^If the 4th parameter to the sqlite3_result_text* interfaces |
| 4868 |
** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT |
| 4869 |
** then SQLite makes a copy of the result into space obtained from |
| 4870 |
** from [sqlite3_malloc()] before it returns. |
| 4871 |
** |
| 4872 |
** ^The sqlite3_result_value() interface sets the result of |
| 4873 |
** the application-defined function to be a copy of the |
| 4874 |
** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The |
| 4875 |
** sqlite3_result_value() interface makes a copy of the [sqlite3_value] |
| 4876 |
** so that the [sqlite3_value] specified in the parameter may change or |
| 4877 |
** be deallocated after sqlite3_result_value() returns without harm. |
| 4878 |
** ^A [protected sqlite3_value] object may always be used where an |
| 4879 |
** [unprotected sqlite3_value] object is required, so either |
| 4880 |
** kind of [sqlite3_value] object can be used with this interface. |
| 4881 |
** |
| 4882 |
** If these routines are called from within the different thread |
| 4883 |
** than the one containing the application-defined function that received |
| 4884 |
** the [sqlite3_context] pointer, the results are undefined. |
| 4885 |
*/ |
| 4886 |
SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); |
| 4887 |
SQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*, |
| 4888 |
sqlite3_uint64,void(*)(void*)); |
| 4889 |
SQLITE_API void sqlite3_result_double(sqlite3_context*, double); |
| 4890 |
SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); |
| 4891 |
SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); |
| 4892 |
SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); |
| 4893 |
SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); |
| 4894 |
SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); |
| 4895 |
SQLITE_API void sqlite3_result_int(sqlite3_context*, int); |
| 4896 |
SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); |
| 4897 |
SQLITE_API void sqlite3_result_null(sqlite3_context*); |
| 4898 |
SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); |
| 4899 |
SQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64, |
| 4900 |
void(*)(void*), unsigned char encoding); |
| 4901 |
SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); |
| 4902 |
SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); |
| 4903 |
SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); |
| 4904 |
SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); |
| 4905 |
SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); |
| 4906 |
SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n); |
| 4907 |
|
| 4908 |
|
| 4909 |
/* |
| 4910 |
** CAPI3REF: Setting The Subtype Of An SQL Function |
| 4911 |
** METHOD: sqlite3_context |
| 4912 |
** |
| 4913 |
** The sqlite3_result_subtype(C,T) function causes the subtype of |
| 4914 |
** the result from the [application-defined SQL function] with |
| 4915 |
** [sqlite3_context] C to be the value T. Only the lower 8 bits |
| 4916 |
** of the subtype T are preserved in current versions of SQLite; |
| 4917 |
** higher order bits are discarded. |
| 4918 |
** The number of subtype bytes preserved by SQLite might increase |
| 4919 |
** in future releases of SQLite. |
| 4920 |
*/ |
| 4921 |
SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int); |
| 4922 |
|
| 4923 |
/* |
| 4924 |
** CAPI3REF: Define New Collating Sequences |
| 4925 |
** METHOD: sqlite3 |
| 4926 |
** |
| 4927 |
** ^These functions add, remove, or modify a [collation] associated |
| 4928 |
** with the [database connection] specified as the first argument. |
| 4929 |
** |
| 4930 |
** ^The name of the collation is a UTF-8 string |
| 4931 |
** for sqlite3_create_collation() and sqlite3_create_collation_v2() |
| 4932 |
** and a UTF-16 string in native byte order for sqlite3_create_collation16(). |
| 4933 |
** ^Collation names that compare equal according to [sqlite3_strnicmp()] are |
| 4934 |
** considered to be the same name. |
| 4935 |
** |
| 4936 |
** ^(The third argument (eTextRep) must be one of the constants: |
| 4937 |
** <ul> |
| 4938 |
** <li> [SQLITE_UTF8], |
| 4939 |
** <li> [SQLITE_UTF16LE], |
| 4940 |
** <li> [SQLITE_UTF16BE], |
| 4941 |
** <li> [SQLITE_UTF16], or |
| 4942 |
** <li> [SQLITE_UTF16_ALIGNED]. |
| 4943 |
** </ul>)^ |
| 4944 |
** ^The eTextRep argument determines the encoding of strings passed |
| 4945 |
** to the collating function callback, xCallback. |
| 4946 |
** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep |
| 4947 |
** force strings to be UTF16 with native byte order. |
| 4948 |
** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin |
| 4949 |
** on an even byte address. |
| 4950 |
** |
| 4951 |
** ^The fourth argument, pArg, is an application data pointer that is passed |
| 4952 |
** through as the first argument to the collating function callback. |
| 4953 |
** |
| 4954 |
** ^The fifth argument, xCallback, is a pointer to the collating function. |
| 4955 |
** ^Multiple collating functions can be registered using the same name but |
| 4956 |
** with different eTextRep parameters and SQLite will use whichever |
| 4957 |
** function requires the least amount of data transformation. |
| 4958 |
** ^If the xCallback argument is NULL then the collating function is |
| 4959 |
** deleted. ^When all collating functions having the same name are deleted, |
| 4960 |
** that collation is no longer usable. |
| 4961 |
** |
| 4962 |
** ^The collating function callback is invoked with a copy of the pArg |
| 4963 |
** application data pointer and with two strings in the encoding specified |
| 4964 |
** by the eTextRep argument. The collating function must return an |
| 4965 |
** integer that is negative, zero, or positive |
| 4966 |
** if the first string is less than, equal to, or greater than the second, |
| 4967 |
** respectively. A collating function must always return the same answer |
| 4968 |
** given the same inputs. If two or more collating functions are registered |
| 4969 |
** to the same collation name (using different eTextRep values) then all |
| 4970 |
** must give an equivalent answer when invoked with equivalent strings. |
| 4971 |
** The collating function must obey the following properties for all |
| 4972 |
** strings A, B, and C: |
| 4973 |
** |
| 4974 |
** <ol> |
| 4975 |
** <li> If A==B then B==A. |
| 4976 |
** <li> If A==B and B==C then A==C. |
| 4977 |
** <li> If A<B THEN B>A. |
| 4978 |
** <li> If A<B and B<C then A<C. |
| 4979 |
** </ol> |
| 4980 |
** |
| 4981 |
** If a collating function fails any of the above constraints and that |
| 4982 |
** collating function is registered and used, then the behavior of SQLite |
| 4983 |
** is undefined. |
| 4984 |
** |
| 4985 |
** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() |
| 4986 |
** with the addition that the xDestroy callback is invoked on pArg when |
| 4987 |
** the collating function is deleted. |
| 4988 |
** ^Collating functions are deleted when they are overridden by later |
| 4989 |
** calls to the collation creation functions or when the |
| 4990 |
** [database connection] is closed using [sqlite3_close()]. |
| 4991 |
** |
| 4992 |
** ^The xDestroy callback is <u>not</u> called if the |
| 4993 |
** sqlite3_create_collation_v2() function fails. Applications that invoke |
| 4994 |
** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should |
| 4995 |
** check the return code and dispose of the application data pointer |
| 4996 |
** themselves rather than expecting SQLite to deal with it for them. |
| 4997 |
** This is different from every other SQLite interface. The inconsistency |
| 4998 |
** is unfortunate but cannot be changed without breaking backwards |
| 4999 |
** compatibility. |
| 5000 |
** |
| 5001 |
** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. |
| 5002 |
*/ |
| 5003 |
SQLITE_API int sqlite3_create_collation( |
| 5004 |
sqlite3*, |
| 5005 |
const char *zName, |
| 5006 |
int eTextRep, |
| 5007 |
void *pArg, |
| 5008 |
int(*xCompare)(void*,int,const void*,int,const void*) |
| 5009 |
); |
| 5010 |
SQLITE_API int sqlite3_create_collation_v2( |
| 5011 |
sqlite3*, |
| 5012 |
const char *zName, |
| 5013 |
int eTextRep, |
| 5014 |
void *pArg, |
| 5015 |
int(*xCompare)(void*,int,const void*,int,const void*), |
| 5016 |
void(*xDestroy)(void*) |
| 5017 |
); |
| 5018 |
SQLITE_API int sqlite3_create_collation16( |
| 5019 |
sqlite3*, |
| 5020 |
const void *zName, |
| 5021 |
int eTextRep, |
| 5022 |
void *pArg, |
| 5023 |
int(*xCompare)(void*,int,const void*,int,const void*) |
| 5024 |
); |
| 5025 |
|
| 5026 |
/* |
| 5027 |
** CAPI3REF: Collation Needed Callbacks |
| 5028 |
** METHOD: sqlite3 |
| 5029 |
** |
| 5030 |
** ^To avoid having to register all collation sequences before a database |
| 5031 |
** can be used, a single callback function may be registered with the |
| 5032 |
** [database connection] to be invoked whenever an undefined collation |
| 5033 |
** sequence is required. |
| 5034 |
** |
| 5035 |
** ^If the function is registered using the sqlite3_collation_needed() API, |
| 5036 |
** then it is passed the names of undefined collation sequences as strings |
| 5037 |
** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, |
| 5038 |
** the names are passed as UTF-16 in machine native byte order. |
| 5039 |
** ^A call to either function replaces the existing collation-needed callback. |
| 5040 |
** |
| 5041 |
** ^(When the callback is invoked, the first argument passed is a copy |
| 5042 |
** of the second argument to sqlite3_collation_needed() or |
| 5043 |
** sqlite3_collation_needed16(). The second argument is the database |
| 5044 |
** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], |
| 5045 |
** or [SQLITE_UTF16LE], indicating the most desirable form of the collation |
| 5046 |
** sequence function required. The fourth parameter is the name of the |
| 5047 |
** required collation sequence.)^ |
| 5048 |
** |
| 5049 |
** The callback function should register the desired collation using |
| 5050 |
** [sqlite3_create_collation()], [sqlite3_create_collation16()], or |
| 5051 |
** [sqlite3_create_collation_v2()]. |
| 5052 |
*/ |
| 5053 |
SQLITE_API int sqlite3_collation_needed( |
| 5054 |
sqlite3*, |
| 5055 |
void*, |
| 5056 |
void(*)(void*,sqlite3*,int eTextRep,const char*) |
| 5057 |
); |
| 5058 |
SQLITE_API int sqlite3_collation_needed16( |
| 5059 |
sqlite3*, |
| 5060 |
void*, |
| 5061 |
void(*)(void*,sqlite3*,int eTextRep,const void*) |
| 5062 |
); |
| 5063 |
|
| 5064 |
#ifdef SQLITE_HAS_CODEC |
| 5065 |
/* |
| 5066 |
** Specify the key for an encrypted database. This routine should be |
| 5067 |
** called right after sqlite3_open(). |
| 5068 |
** |
| 5069 |
** The code to implement this API is not available in the public release |
| 5070 |
** of SQLite. |
| 5071 |
*/ |
| 5072 |
SQLITE_API int sqlite3_key( |
| 5073 |
sqlite3 *db, /* Database to be rekeyed */ |
| 5074 |
const void *pKey, int nKey /* The key */ |
| 5075 |
); |
| 5076 |
SQLITE_API int sqlite3_key_v2( |
| 5077 |
sqlite3 *db, /* Database to be rekeyed */ |
| 5078 |
const char *zDbName, /* Name of the database */ |
| 5079 |
const void *pKey, int nKey /* The key */ |
| 5080 |
); |
| 5081 |
|
| 5082 |
/* |
| 5083 |
** Change the key on an open database. If the current database is not |
| 5084 |
** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the |
| 5085 |
** database is decrypted. |
| 5086 |
** |
| 5087 |
** The code to implement this API is not available in the public release |
| 5088 |
** of SQLite. |
| 5089 |
*/ |
| 5090 |
SQLITE_API int sqlite3_rekey( |
| 5091 |
sqlite3 *db, /* Database to be rekeyed */ |
| 5092 |
const void *pKey, int nKey /* The new key */ |
| 5093 |
); |
| 5094 |
SQLITE_API int sqlite3_rekey_v2( |
| 5095 |
sqlite3 *db, /* Database to be rekeyed */ |
| 5096 |
const char *zDbName, /* Name of the database */ |
| 5097 |
const void *pKey, int nKey /* The new key */ |
| 5098 |
); |
| 5099 |
|
| 5100 |
/* |
| 5101 |
** Specify the activation key for a SEE database. Unless |
| 5102 |
** activated, none of the SEE routines will work. |
| 5103 |
*/ |
| 5104 |
SQLITE_API void sqlite3_activate_see( |
| 5105 |
const char *zPassPhrase /* Activation phrase */ |
| 5106 |
); |
| 5107 |
#endif |
| 5108 |
|
| 5109 |
#ifdef SQLITE_ENABLE_CEROD |
| 5110 |
/* |
| 5111 |
** Specify the activation key for a CEROD database. Unless |
| 5112 |
** activated, none of the CEROD routines will work. |
| 5113 |
*/ |
| 5114 |
SQLITE_API void sqlite3_activate_cerod( |
| 5115 |
const char *zPassPhrase /* Activation phrase */ |
| 5116 |
); |
| 5117 |
#endif |
| 5118 |
|
| 5119 |
/* |
| 5120 |
** CAPI3REF: Suspend Execution For A Short Time |
| 5121 |
** |
| 5122 |
** The sqlite3_sleep() function causes the current thread to suspend execution |
| 5123 |
** for at least a number of milliseconds specified in its parameter. |
| 5124 |
** |
| 5125 |
** If the operating system does not support sleep requests with |
| 5126 |
** millisecond time resolution, then the time will be rounded up to |
| 5127 |
** the nearest second. The number of milliseconds of sleep actually |
| 5128 |
** requested from the operating system is returned. |
| 5129 |
** |
| 5130 |
** ^SQLite implements this interface by calling the xSleep() |
| 5131 |
** method of the default [sqlite3_vfs] object. If the xSleep() method |
| 5132 |
** of the default VFS is not implemented correctly, or not implemented at |
| 5133 |
** all, then the behavior of sqlite3_sleep() may deviate from the description |
| 5134 |
** in the previous paragraphs. |
| 5135 |
*/ |
| 5136 |
SQLITE_API int sqlite3_sleep(int); |
| 5137 |
|
| 5138 |
/* |
| 5139 |
** CAPI3REF: Name Of The Folder Holding Temporary Files |
| 5140 |
** |
| 5141 |
** ^(If this global variable is made to point to a string which is |
| 5142 |
** the name of a folder (a.k.a. directory), then all temporary files |
| 5143 |
** created by SQLite when using a built-in [sqlite3_vfs | VFS] |
| 5144 |
** will be placed in that directory.)^ ^If this variable |
| 5145 |
** is a NULL pointer, then SQLite performs a search for an appropriate |
| 5146 |
** temporary file directory. |
| 5147 |
** |
| 5148 |
** Applications are strongly discouraged from using this global variable. |
| 5149 |
** It is required to set a temporary folder on Windows Runtime (WinRT). |
| 5150 |
** But for all other platforms, it is highly recommended that applications |
| 5151 |
** neither read nor write this variable. This global variable is a relic |
| 5152 |
** that exists for backwards compatibility of legacy applications and should |
| 5153 |
** be avoided in new projects. |
| 5154 |
** |
| 5155 |
** It is not safe to read or modify this variable in more than one |
| 5156 |
** thread at a time. It is not safe to read or modify this variable |
| 5157 |
** if a [database connection] is being used at the same time in a separate |
| 5158 |
** thread. |
| 5159 |
** It is intended that this variable be set once |
| 5160 |
** as part of process initialization and before any SQLite interface |
| 5161 |
** routines have been called and that this variable remain unchanged |
| 5162 |
** thereafter. |
| 5163 |
** |
| 5164 |
** ^The [temp_store_directory pragma] may modify this variable and cause |
| 5165 |
** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, |
| 5166 |
** the [temp_store_directory pragma] always assumes that any string |
| 5167 |
** that this variable points to is held in memory obtained from |
| 5168 |
** [sqlite3_malloc] and the pragma may attempt to free that memory |
| 5169 |
** using [sqlite3_free]. |
| 5170 |
** Hence, if this variable is modified directly, either it should be |
| 5171 |
** made NULL or made to point to memory obtained from [sqlite3_malloc] |
| 5172 |
** or else the use of the [temp_store_directory pragma] should be avoided. |
| 5173 |
** Except when requested by the [temp_store_directory pragma], SQLite |
| 5174 |
** does not free the memory that sqlite3_temp_directory points to. If |
| 5175 |
** the application wants that memory to be freed, it must do |
| 5176 |
** so itself, taking care to only do so after all [database connection] |
| 5177 |
** objects have been destroyed. |
| 5178 |
** |
| 5179 |
** <b>Note to Windows Runtime users:</b> The temporary directory must be set |
| 5180 |
** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various |
| 5181 |
** features that require the use of temporary files may fail. Here is an |
| 5182 |
** example of how to do this using C++ with the Windows Runtime: |
| 5183 |
** |
| 5184 |
** <blockquote><pre> |
| 5185 |
** LPCWSTR zPath = Windows::Storage::ApplicationData::Current-> |
| 5186 |
** TemporaryFolder->Path->Data(); |
| 5187 |
** char zPathBuf[MAX_PATH + 1]; |
| 5188 |
** memset(zPathBuf, 0, sizeof(zPathBuf)); |
| 5189 |
** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf), |
| 5190 |
** NULL, NULL); |
| 5191 |
** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf); |
| 5192 |
** </pre></blockquote> |
| 5193 |
*/ |
| 5194 |
SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; |
| 5195 |
|
| 5196 |
/* |
| 5197 |
** CAPI3REF: Name Of The Folder Holding Database Files |
| 5198 |
** |
| 5199 |
** ^(If this global variable is made to point to a string which is |
| 5200 |
** the name of a folder (a.k.a. directory), then all database files |
| 5201 |
** specified with a relative pathname and created or accessed by |
| 5202 |
** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed |
| 5203 |
** to be relative to that directory.)^ ^If this variable is a NULL |
| 5204 |
** pointer, then SQLite assumes that all database files specified |
| 5205 |
** with a relative pathname are relative to the current directory |
| 5206 |
** for the process. Only the windows VFS makes use of this global |
| 5207 |
** variable; it is ignored by the unix VFS. |
| 5208 |
** |
| 5209 |
** Changing the value of this variable while a database connection is |
| 5210 |
** open can result in a corrupt database. |
| 5211 |
** |
| 5212 |
** It is not safe to read or modify this variable in more than one |
| 5213 |
** thread at a time. It is not safe to read or modify this variable |
| 5214 |
** if a [database connection] is being used at the same time in a separate |
| 5215 |
** thread. |
| 5216 |
** It is intended that this variable be set once |
| 5217 |
** as part of process initialization and before any SQLite interface |
| 5218 |
** routines have been called and that this variable remain unchanged |
| 5219 |
** thereafter. |
| 5220 |
** |
| 5221 |
** ^The [data_store_directory pragma] may modify this variable and cause |
| 5222 |
** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, |
| 5223 |
** the [data_store_directory pragma] always assumes that any string |
| 5224 |
** that this variable points to is held in memory obtained from |
| 5225 |
** [sqlite3_malloc] and the pragma may attempt to free that memory |
| 5226 |
** using [sqlite3_free]. |
| 5227 |
** Hence, if this variable is modified directly, either it should be |
| 5228 |
** made NULL or made to point to memory obtained from [sqlite3_malloc] |
| 5229 |
** or else the use of the [data_store_directory pragma] should be avoided. |
| 5230 |
*/ |
| 5231 |
SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory; |
| 5232 |
|
| 5233 |
/* |
| 5234 |
** CAPI3REF: Test For Auto-Commit Mode |
| 5235 |
** KEYWORDS: {autocommit mode} |
| 5236 |
** METHOD: sqlite3 |
| 5237 |
** |
| 5238 |
** ^The sqlite3_get_autocommit() interface returns non-zero or |
| 5239 |
** zero if the given database connection is or is not in autocommit mode, |
| 5240 |
** respectively. ^Autocommit mode is on by default. |
| 5241 |
** ^Autocommit mode is disabled by a [BEGIN] statement. |
| 5242 |
** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. |
| 5243 |
** |
| 5244 |
** If certain kinds of errors occur on a statement within a multi-statement |
| 5245 |
** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], |
| 5246 |
** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the |
| 5247 |
** transaction might be rolled back automatically. The only way to |
| 5248 |
** find out whether SQLite automatically rolled back the transaction after |
| 5249 |
** an error is to use this function. |
| 5250 |
** |
| 5251 |
** If another thread changes the autocommit status of the database |
| 5252 |
** connection while this routine is running, then the return value |
| 5253 |
** is undefined. |
| 5254 |
*/ |
| 5255 |
SQLITE_API int sqlite3_get_autocommit(sqlite3*); |
| 5256 |
|
| 5257 |
/* |
| 5258 |
** CAPI3REF: Find The Database Handle Of A Prepared Statement |
| 5259 |
** METHOD: sqlite3_stmt |
| 5260 |
** |
| 5261 |
** ^The sqlite3_db_handle interface returns the [database connection] handle |
| 5262 |
** to which a [prepared statement] belongs. ^The [database connection] |
| 5263 |
** returned by sqlite3_db_handle is the same [database connection] |
| 5264 |
** that was the first argument |
| 5265 |
** to the [sqlite3_prepare_v2()] call (or its variants) that was used to |
| 5266 |
** create the statement in the first place. |
| 5267 |
*/ |
| 5268 |
SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); |
| 5269 |
|
| 5270 |
/* |
| 5271 |
** CAPI3REF: Return The Filename For A Database Connection |
| 5272 |
** METHOD: sqlite3 |
| 5273 |
** |
| 5274 |
** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename |
| 5275 |
** associated with database N of connection D. ^The main database file |
| 5276 |
** has the name "main". If there is no attached database N on the database |
| 5277 |
** connection D, or if database N is a temporary or in-memory database, then |
| 5278 |
** a NULL pointer is returned. |
| 5279 |
** |
| 5280 |
** ^The filename returned by this function is the output of the |
| 5281 |
** xFullPathname method of the [VFS]. ^In other words, the filename |
| 5282 |
** will be an absolute pathname, even if the filename used |
| 5283 |
** to open the database originally was a URI or relative pathname. |
| 5284 |
*/ |
| 5285 |
SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); |
| 5286 |
|
| 5287 |
/* |
| 5288 |
** CAPI3REF: Determine if a database is read-only |
| 5289 |
** METHOD: sqlite3 |
| 5290 |
** |
| 5291 |
** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N |
| 5292 |
** of connection D is read-only, 0 if it is read/write, or -1 if N is not |
| 5293 |
** the name of a database on connection D. |
| 5294 |
*/ |
| 5295 |
SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName); |
| 5296 |
|
| 5297 |
/* |
| 5298 |
** CAPI3REF: Find the next prepared statement |
| 5299 |
** METHOD: sqlite3 |
| 5300 |
** |
| 5301 |
** ^This interface returns a pointer to the next [prepared statement] after |
| 5302 |
** pStmt associated with the [database connection] pDb. ^If pStmt is NULL |
| 5303 |
** then this interface returns a pointer to the first prepared statement |
| 5304 |
** associated with the database connection pDb. ^If no prepared statement |
| 5305 |
** satisfies the conditions of this routine, it returns NULL. |
| 5306 |
** |
| 5307 |
** The [database connection] pointer D in a call to |
| 5308 |
** [sqlite3_next_stmt(D,S)] must refer to an open database |
| 5309 |
** connection and in particular must not be a NULL pointer. |
| 5310 |
*/ |
| 5311 |
SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); |
| 5312 |
|
| 5313 |
/* |
| 5314 |
** CAPI3REF: Commit And Rollback Notification Callbacks |
| 5315 |
** METHOD: sqlite3 |
| 5316 |
** |
| 5317 |
** ^The sqlite3_commit_hook() interface registers a callback |
| 5318 |
** function to be invoked whenever a transaction is [COMMIT | committed]. |
| 5319 |
** ^Any callback set by a previous call to sqlite3_commit_hook() |
| 5320 |
** for the same database connection is overridden. |
| 5321 |
** ^The sqlite3_rollback_hook() interface registers a callback |
| 5322 |
** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. |
| 5323 |
** ^Any callback set by a previous call to sqlite3_rollback_hook() |
| 5324 |
** for the same database connection is overridden. |
| 5325 |
** ^The pArg argument is passed through to the callback. |
| 5326 |
** ^If the callback on a commit hook function returns non-zero, |
| 5327 |
** then the commit is converted into a rollback. |
| 5328 |
** |
| 5329 |
** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions |
| 5330 |
** return the P argument from the previous call of the same function |
| 5331 |
** on the same [database connection] D, or NULL for |
| 5332 |
** the first call for each function on D. |
| 5333 |
** |
| 5334 |
** The commit and rollback hook callbacks are not reentrant. |
| 5335 |
** The callback implementation must not do anything that will modify |
| 5336 |
** the database connection that invoked the callback. Any actions |
| 5337 |
** to modify the database connection must be deferred until after the |
| 5338 |
** completion of the [sqlite3_step()] call that triggered the commit |
| 5339 |
** or rollback hook in the first place. |
| 5340 |
** Note that running any other SQL statements, including SELECT statements, |
| 5341 |
** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify |
| 5342 |
** the database connections for the meaning of "modify" in this paragraph. |
| 5343 |
** |
| 5344 |
** ^Registering a NULL function disables the callback. |
| 5345 |
** |
| 5346 |
** ^When the commit hook callback routine returns zero, the [COMMIT] |
| 5347 |
** operation is allowed to continue normally. ^If the commit hook |
| 5348 |
** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. |
| 5349 |
** ^The rollback hook is invoked on a rollback that results from a commit |
| 5350 |
** hook returning non-zero, just as it would be with any other rollback. |
| 5351 |
** |
| 5352 |
** ^For the purposes of this API, a transaction is said to have been |
| 5353 |
** rolled back if an explicit "ROLLBACK" statement is executed, or |
| 5354 |
** an error or constraint causes an implicit rollback to occur. |
| 5355 |
** ^The rollback callback is not invoked if a transaction is |
| 5356 |
** automatically rolled back because the database connection is closed. |
| 5357 |
** |
| 5358 |
** See also the [sqlite3_update_hook()] interface. |
| 5359 |
*/ |
| 5360 |
SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); |
| 5361 |
SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); |
| 5362 |
|
| 5363 |
/* |
| 5364 |
** CAPI3REF: Data Change Notification Callbacks |
| 5365 |
** METHOD: sqlite3 |
| 5366 |
** |
| 5367 |
** ^The sqlite3_update_hook() interface registers a callback function |
| 5368 |
** with the [database connection] identified by the first argument |
| 5369 |
** to be invoked whenever a row is updated, inserted or deleted in |
| 5370 |
** a [rowid table]. |
| 5371 |
** ^Any callback set by a previous call to this function |
| 5372 |
** for the same database connection is overridden. |
| 5373 |
** |
| 5374 |
** ^The second argument is a pointer to the function to invoke when a |
| 5375 |
** row is updated, inserted or deleted in a rowid table. |
| 5376 |
** ^The first argument to the callback is a copy of the third argument |
| 5377 |
** to sqlite3_update_hook(). |
| 5378 |
** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], |
| 5379 |
** or [SQLITE_UPDATE], depending on the operation that caused the callback |
| 5380 |
** to be invoked. |
| 5381 |
** ^The third and fourth arguments to the callback contain pointers to the |
| 5382 |
** database and table name containing the affected row. |
| 5383 |
** ^The final callback parameter is the [rowid] of the row. |
| 5384 |
** ^In the case of an update, this is the [rowid] after the update takes place. |
| 5385 |
** |
| 5386 |
** ^(The update hook is not invoked when internal system tables are |
| 5387 |
** modified (i.e. sqlite_master and sqlite_sequence).)^ |
| 5388 |
** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified. |
| 5389 |
** |
| 5390 |
** ^In the current implementation, the update hook |
| 5391 |
** is not invoked when duplication rows are deleted because of an |
| 5392 |
** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook |
| 5393 |
** invoked when rows are deleted using the [truncate optimization]. |
| 5394 |
** The exceptions defined in this paragraph might change in a future |
| 5395 |
** release of SQLite. |
| 5396 |
** |
| 5397 |
** The update hook implementation must not do anything that will modify |
| 5398 |
** the database connection that invoked the update hook. Any actions |
| 5399 |
** to modify the database connection must be deferred until after the |
| 5400 |
** completion of the [sqlite3_step()] call that triggered the update hook. |
| 5401 |
** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
| 5402 |
** database connections for the meaning of "modify" in this paragraph. |
| 5403 |
** |
| 5404 |
** ^The sqlite3_update_hook(D,C,P) function |
| 5405 |
** returns the P argument from the previous call |
| 5406 |
** on the same [database connection] D, or NULL for |
| 5407 |
** the first call on D. |
| 5408 |
** |
| 5409 |
** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()], |
| 5410 |
** and [sqlite3_preupdate_hook()] interfaces. |
| 5411 |
*/ |
| 5412 |
SQLITE_API void *sqlite3_update_hook( |
| 5413 |
sqlite3*, |
| 5414 |
void(*)(void *,int ,char const *,char const *,sqlite3_int64), |
| 5415 |
void* |
| 5416 |
); |
| 5417 |
|
| 5418 |
/* |
| 5419 |
** CAPI3REF: Enable Or Disable Shared Pager Cache |
| 5420 |
** |
| 5421 |
** ^(This routine enables or disables the sharing of the database cache |
| 5422 |
** and schema data structures between [database connection | connections] |
| 5423 |
** to the same database. Sharing is enabled if the argument is true |
| 5424 |
** and disabled if the argument is false.)^ |
| 5425 |
** |
| 5426 |
** ^Cache sharing is enabled and disabled for an entire process. |
| 5427 |
** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]). |
| 5428 |
** In prior versions of SQLite, |
| 5429 |
** sharing was enabled or disabled for each thread separately. |
| 5430 |
** |
| 5431 |
** ^(The cache sharing mode set by this interface effects all subsequent |
| 5432 |
** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. |
| 5433 |
** Existing database connections continue use the sharing mode |
| 5434 |
** that was in effect at the time they were opened.)^ |
| 5435 |
** |
| 5436 |
** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled |
| 5437 |
** successfully. An [error code] is returned otherwise.)^ |
| 5438 |
** |
| 5439 |
** ^Shared cache is disabled by default. But this might change in |
| 5440 |
** future releases of SQLite. Applications that care about shared |
| 5441 |
** cache setting should set it explicitly. |
| 5442 |
** |
| 5443 |
** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0 |
| 5444 |
** and will always return SQLITE_MISUSE. On those systems, |
| 5445 |
** shared cache mode should be enabled per-database connection via |
| 5446 |
** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE]. |
| 5447 |
** |
| 5448 |
** This interface is threadsafe on processors where writing a |
| 5449 |
** 32-bit integer is atomic. |
| 5450 |
** |
| 5451 |
** See Also: [SQLite Shared-Cache Mode] |
| 5452 |
*/ |
| 5453 |
SQLITE_API int sqlite3_enable_shared_cache(int); |
| 5454 |
|
| 5455 |
/* |
| 5456 |
** CAPI3REF: Attempt To Free Heap Memory |
| 5457 |
** |
| 5458 |
** ^The sqlite3_release_memory() interface attempts to free N bytes |
| 5459 |
** of heap memory by deallocating non-essential memory allocations |
| 5460 |
** held by the database library. Memory used to cache database |
| 5461 |
** pages to improve performance is an example of non-essential memory. |
| 5462 |
** ^sqlite3_release_memory() returns the number of bytes actually freed, |
| 5463 |
** which might be more or less than the amount requested. |
| 5464 |
** ^The sqlite3_release_memory() routine is a no-op returning zero |
| 5465 |
** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. |
| 5466 |
** |
| 5467 |
** See also: [sqlite3_db_release_memory()] |
| 5468 |
*/ |
| 5469 |
SQLITE_API int sqlite3_release_memory(int); |
| 5470 |
|
| 5471 |
/* |
| 5472 |
** CAPI3REF: Free Memory Used By A Database Connection |
| 5473 |
** METHOD: sqlite3 |
| 5474 |
** |
| 5475 |
** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap |
| 5476 |
** memory as possible from database connection D. Unlike the |
| 5477 |
** [sqlite3_release_memory()] interface, this interface is in effect even |
| 5478 |
** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is |
| 5479 |
** omitted. |
| 5480 |
** |
| 5481 |
** See also: [sqlite3_release_memory()] |
| 5482 |
*/ |
| 5483 |
SQLITE_API int sqlite3_db_release_memory(sqlite3*); |
| 5484 |
|
| 5485 |
/* |
| 5486 |
** CAPI3REF: Impose A Limit On Heap Size |
| 5487 |
** |
| 5488 |
** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the |
| 5489 |
** soft limit on the amount of heap memory that may be allocated by SQLite. |
| 5490 |
** ^SQLite strives to keep heap memory utilization below the soft heap |
| 5491 |
** limit by reducing the number of pages held in the page cache |
| 5492 |
** as heap memory usages approaches the limit. |
| 5493 |
** ^The soft heap limit is "soft" because even though SQLite strives to stay |
| 5494 |
** below the limit, it will exceed the limit rather than generate |
| 5495 |
** an [SQLITE_NOMEM] error. In other words, the soft heap limit |
| 5496 |
** is advisory only. |
| 5497 |
** |
| 5498 |
** ^The return value from sqlite3_soft_heap_limit64() is the size of |
| 5499 |
** the soft heap limit prior to the call, or negative in the case of an |
| 5500 |
** error. ^If the argument N is negative |
| 5501 |
** then no change is made to the soft heap limit. Hence, the current |
| 5502 |
** size of the soft heap limit can be determined by invoking |
| 5503 |
** sqlite3_soft_heap_limit64() with a negative argument. |
| 5504 |
** |
| 5505 |
** ^If the argument N is zero then the soft heap limit is disabled. |
| 5506 |
** |
| 5507 |
** ^(The soft heap limit is not enforced in the current implementation |
| 5508 |
** if one or more of following conditions are true: |
| 5509 |
** |
| 5510 |
** <ul> |
| 5511 |
** <li> The soft heap limit is set to zero. |
| 5512 |
** <li> Memory accounting is disabled using a combination of the |
| 5513 |
** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and |
| 5514 |
** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. |
| 5515 |
** <li> An alternative page cache implementation is specified using |
| 5516 |
** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...). |
| 5517 |
** <li> The page cache allocates from its own memory pool supplied |
| 5518 |
** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than |
| 5519 |
** from the heap. |
| 5520 |
** </ul>)^ |
| 5521 |
** |
| 5522 |
** Beginning with SQLite [version 3.7.3] ([dateof:3.7.3]), |
| 5523 |
** the soft heap limit is enforced |
| 5524 |
** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] |
| 5525 |
** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], |
| 5526 |
** the soft heap limit is enforced on every memory allocation. Without |
| 5527 |
** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced |
| 5528 |
** when memory is allocated by the page cache. Testing suggests that because |
| 5529 |
** the page cache is the predominate memory user in SQLite, most |
| 5530 |
** applications will achieve adequate soft heap limit enforcement without |
| 5531 |
** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. |
| 5532 |
** |
| 5533 |
** The circumstances under which SQLite will enforce the soft heap limit may |
| 5534 |
** changes in future releases of SQLite. |
| 5535 |
*/ |
| 5536 |
SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); |
| 5537 |
|
| 5538 |
/* |
| 5539 |
** CAPI3REF: Deprecated Soft Heap Limit Interface |
| 5540 |
** DEPRECATED |
| 5541 |
** |
| 5542 |
** This is a deprecated version of the [sqlite3_soft_heap_limit64()] |
| 5543 |
** interface. This routine is provided for historical compatibility |
| 5544 |
** only. All new applications should use the |
| 5545 |
** [sqlite3_soft_heap_limit64()] interface rather than this one. |
| 5546 |
*/ |
| 5547 |
SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); |
| 5548 |
|
| 5549 |
|
| 5550 |
/* |
| 5551 |
** CAPI3REF: Extract Metadata About A Column Of A Table |
| 5552 |
** METHOD: sqlite3 |
| 5553 |
** |
| 5554 |
** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns |
| 5555 |
** information about column C of table T in database D |
| 5556 |
** on [database connection] X.)^ ^The sqlite3_table_column_metadata() |
| 5557 |
** interface returns SQLITE_OK and fills in the non-NULL pointers in |
| 5558 |
** the final five arguments with appropriate values if the specified |
| 5559 |
** column exists. ^The sqlite3_table_column_metadata() interface returns |
| 5560 |
** SQLITE_ERROR and if the specified column does not exist. |
| 5561 |
** ^If the column-name parameter to sqlite3_table_column_metadata() is a |
| 5562 |
** NULL pointer, then this routine simply checks for the existence of the |
| 5563 |
** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it |
| 5564 |
** does not. |
| 5565 |
** |
| 5566 |
** ^The column is identified by the second, third and fourth parameters to |
| 5567 |
** this function. ^(The second parameter is either the name of the database |
| 5568 |
** (i.e. "main", "temp", or an attached database) containing the specified |
| 5569 |
** table or NULL.)^ ^If it is NULL, then all attached databases are searched |
| 5570 |
** for the table using the same algorithm used by the database engine to |
| 5571 |
** resolve unqualified table references. |
| 5572 |
** |
| 5573 |
** ^The third and fourth parameters to this function are the table and column |
| 5574 |
** name of the desired column, respectively. |
| 5575 |
** |
| 5576 |
** ^Metadata is returned by writing to the memory locations passed as the 5th |
| 5577 |
** and subsequent parameters to this function. ^Any of these arguments may be |
| 5578 |
** NULL, in which case the corresponding element of metadata is omitted. |
| 5579 |
** |
| 5580 |
** ^(<blockquote> |
| 5581 |
** <table border="1"> |
| 5582 |
** <tr><th> Parameter <th> Output<br>Type <th> Description |
| 5583 |
** |
| 5584 |
** <tr><td> 5th <td> const char* <td> Data type |
| 5585 |
** <tr><td> 6th <td> const char* <td> Name of default collation sequence |
| 5586 |
** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint |
| 5587 |
** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY |
| 5588 |
** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] |
| 5589 |
** </table> |
| 5590 |
** </blockquote>)^ |
| 5591 |
** |
| 5592 |
** ^The memory pointed to by the character pointers returned for the |
| 5593 |
** declaration type and collation sequence is valid until the next |
| 5594 |
** call to any SQLite API function. |
| 5595 |
** |
| 5596 |
** ^If the specified table is actually a view, an [error code] is returned. |
| 5597 |
** |
| 5598 |
** ^If the specified column is "rowid", "oid" or "_rowid_" and the table |
| 5599 |
** is not a [WITHOUT ROWID] table and an |
| 5600 |
** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output |
| 5601 |
** parameters are set for the explicitly declared column. ^(If there is no |
| 5602 |
** [INTEGER PRIMARY KEY] column, then the outputs |
| 5603 |
** for the [rowid] are set as follows: |
| 5604 |
** |
| 5605 |
** <pre> |
| 5606 |
** data type: "INTEGER" |
| 5607 |
** collation sequence: "BINARY" |
| 5608 |
** not null: 0 |
| 5609 |
** primary key: 1 |
| 5610 |
** auto increment: 0 |
| 5611 |
** </pre>)^ |
| 5612 |
** |
| 5613 |
** ^This function causes all database schemas to be read from disk and |
| 5614 |
** parsed, if that has not already been done, and returns an error if |
| 5615 |
** any errors are encountered while loading the schema. |
| 5616 |
*/ |
| 5617 |
SQLITE_API int sqlite3_table_column_metadata( |
| 5618 |
sqlite3 *db, /* Connection handle */ |
| 5619 |
const char *zDbName, /* Database name or NULL */ |
| 5620 |
const char *zTableName, /* Table name */ |
| 5621 |
const char *zColumnName, /* Column name */ |
| 5622 |
char const **pzDataType, /* OUTPUT: Declared data type */ |
| 5623 |
char const **pzCollSeq, /* OUTPUT: Collation sequence name */ |
| 5624 |
int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ |
| 5625 |
int *pPrimaryKey, /* OUTPUT: True if column part of PK */ |
| 5626 |
int *pAutoinc /* OUTPUT: True if column is auto-increment */ |
| 5627 |
); |
| 5628 |
|
| 5629 |
/* |
| 5630 |
** CAPI3REF: Load An Extension |
| 5631 |
** METHOD: sqlite3 |
| 5632 |
** |
| 5633 |
** ^This interface loads an SQLite extension library from the named file. |
| 5634 |
** |
| 5635 |
** ^The sqlite3_load_extension() interface attempts to load an |
| 5636 |
** [SQLite extension] library contained in the file zFile. If |
| 5637 |
** the file cannot be loaded directly, attempts are made to load |
| 5638 |
** with various operating-system specific extensions added. |
| 5639 |
** So for example, if "samplelib" cannot be loaded, then names like |
| 5640 |
** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might |
| 5641 |
** be tried also. |
| 5642 |
** |
| 5643 |
** ^The entry point is zProc. |
| 5644 |
** ^(zProc may be 0, in which case SQLite will try to come up with an |
| 5645 |
** entry point name on its own. It first tries "sqlite3_extension_init". |
| 5646 |
** If that does not work, it constructs a name "sqlite3_X_init" where the |
| 5647 |
** X is consists of the lower-case equivalent of all ASCII alphabetic |
| 5648 |
** characters in the filename from the last "/" to the first following |
| 5649 |
** "." and omitting any initial "lib".)^ |
| 5650 |
** ^The sqlite3_load_extension() interface returns |
| 5651 |
** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. |
| 5652 |
** ^If an error occurs and pzErrMsg is not 0, then the |
| 5653 |
** [sqlite3_load_extension()] interface shall attempt to |
| 5654 |
** fill *pzErrMsg with error message text stored in memory |
| 5655 |
** obtained from [sqlite3_malloc()]. The calling function |
| 5656 |
** should free this memory by calling [sqlite3_free()]. |
| 5657 |
** |
| 5658 |
** ^Extension loading must be enabled using |
| 5659 |
** [sqlite3_enable_load_extension()] or |
| 5660 |
** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL) |
| 5661 |
** prior to calling this API, |
| 5662 |
** otherwise an error will be returned. |
| 5663 |
** |
| 5664 |
** <b>Security warning:</b> It is recommended that the |
| 5665 |
** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this |
| 5666 |
** interface. The use of the [sqlite3_enable_load_extension()] interface |
| 5667 |
** should be avoided. This will keep the SQL function [load_extension()] |
| 5668 |
** disabled and prevent SQL injections from giving attackers |
| 5669 |
** access to extension loading capabilities. |
| 5670 |
** |
| 5671 |
** See also the [load_extension() SQL function]. |
| 5672 |
*/ |
| 5673 |
SQLITE_API int sqlite3_load_extension( |
| 5674 |
sqlite3 *db, /* Load the extension into this database connection */ |
| 5675 |
const char *zFile, /* Name of the shared library containing extension */ |
| 5676 |
const char *zProc, /* Entry point. Derived from zFile if 0 */ |
| 5677 |
char **pzErrMsg /* Put error message here if not 0 */ |
| 5678 |
); |
| 5679 |
|
| 5680 |
/* |
| 5681 |
** CAPI3REF: Enable Or Disable Extension Loading |
| 5682 |
** METHOD: sqlite3 |
| 5683 |
** |
| 5684 |
** ^So as not to open security holes in older applications that are |
| 5685 |
** unprepared to deal with [extension loading], and as a means of disabling |
| 5686 |
** [extension loading] while evaluating user-entered SQL, the following API |
| 5687 |
** is provided to turn the [sqlite3_load_extension()] mechanism on and off. |
| 5688 |
** |
| 5689 |
** ^Extension loading is off by default. |
| 5690 |
** ^Call the sqlite3_enable_load_extension() routine with onoff==1 |
| 5691 |
** to turn extension loading on and call it with onoff==0 to turn |
| 5692 |
** it back off again. |
| 5693 |
** |
| 5694 |
** ^This interface enables or disables both the C-API |
| 5695 |
** [sqlite3_load_extension()] and the SQL function [load_extension()]. |
| 5696 |
** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..) |
| 5697 |
** to enable or disable only the C-API.)^ |
| 5698 |
** |
| 5699 |
** <b>Security warning:</b> It is recommended that extension loading |
| 5700 |
** be disabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method |
| 5701 |
** rather than this interface, so the [load_extension()] SQL function |
| 5702 |
** remains disabled. This will prevent SQL injections from giving attackers |
| 5703 |
** access to extension loading capabilities. |
| 5704 |
*/ |
| 5705 |
SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); |
| 5706 |
|
| 5707 |
/* |
| 5708 |
** CAPI3REF: Automatically Load Statically Linked Extensions |
| 5709 |
** |
| 5710 |
** ^This interface causes the xEntryPoint() function to be invoked for |
| 5711 |
** each new [database connection] that is created. The idea here is that |
| 5712 |
** xEntryPoint() is the entry point for a statically linked [SQLite extension] |
| 5713 |
** that is to be automatically loaded into all new database connections. |
| 5714 |
** |
| 5715 |
** ^(Even though the function prototype shows that xEntryPoint() takes |
| 5716 |
** no arguments and returns void, SQLite invokes xEntryPoint() with three |
| 5717 |
** arguments and expects an integer result as if the signature of the |
| 5718 |
** entry point where as follows: |
| 5719 |
** |
| 5720 |
** <blockquote><pre> |
| 5721 |
** int xEntryPoint( |
| 5722 |
** sqlite3 *db, |
| 5723 |
** const char **pzErrMsg, |
| 5724 |
** const struct sqlite3_api_routines *pThunk |
| 5725 |
** ); |
| 5726 |
** </pre></blockquote>)^ |
| 5727 |
** |
| 5728 |
** If the xEntryPoint routine encounters an error, it should make *pzErrMsg |
| 5729 |
** point to an appropriate error message (obtained from [sqlite3_mprintf()]) |
| 5730 |
** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg |
| 5731 |
** is NULL before calling the xEntryPoint(). ^SQLite will invoke |
| 5732 |
** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any |
| 5733 |
** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], |
| 5734 |
** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. |
| 5735 |
** |
| 5736 |
** ^Calling sqlite3_auto_extension(X) with an entry point X that is already |
| 5737 |
** on the list of automatic extensions is a harmless no-op. ^No entry point |
| 5738 |
** will be called more than once for each database connection that is opened. |
| 5739 |
** |
| 5740 |
** See also: [sqlite3_reset_auto_extension()] |
| 5741 |
** and [sqlite3_cancel_auto_extension()] |
| 5742 |
*/ |
| 5743 |
SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void)); |
| 5744 |
|
| 5745 |
/* |
| 5746 |
** CAPI3REF: Cancel Automatic Extension Loading |
| 5747 |
** |
| 5748 |
** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the |
| 5749 |
** initialization routine X that was registered using a prior call to |
| 5750 |
** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)] |
| 5751 |
** routine returns 1 if initialization routine X was successfully |
| 5752 |
** unregistered and it returns 0 if X was not on the list of initialization |
| 5753 |
** routines. |
| 5754 |
*/ |
| 5755 |
SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void)); |
| 5756 |
|
| 5757 |
/* |
| 5758 |
** CAPI3REF: Reset Automatic Extension Loading |
| 5759 |
** |
| 5760 |
** ^This interface disables all automatic extensions previously |
| 5761 |
** registered using [sqlite3_auto_extension()]. |
| 5762 |
*/ |
| 5763 |
SQLITE_API void sqlite3_reset_auto_extension(void); |
| 5764 |
|
| 5765 |
/* |
| 5766 |
** The interface to the virtual-table mechanism is currently considered |
| 5767 |
** to be experimental. The interface might change in incompatible ways. |
| 5768 |
** If this is a problem for you, do not use the interface at this time. |
| 5769 |
** |
| 5770 |
** When the virtual-table mechanism stabilizes, we will declare the |
| 5771 |
** interface fixed, support it indefinitely, and remove this comment. |
| 5772 |
*/ |
| 5773 |
|
| 5774 |
/* |
| 5775 |
** Structures used by the virtual table interface |
| 5776 |
*/ |
| 5777 |
typedef struct sqlite3_vtab sqlite3_vtab; |
| 5778 |
typedef struct sqlite3_index_info sqlite3_index_info; |
| 5779 |
typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; |
| 5780 |
typedef struct sqlite3_module sqlite3_module; |
| 5781 |
|
| 5782 |
/* |
| 5783 |
** CAPI3REF: Virtual Table Object |
| 5784 |
** KEYWORDS: sqlite3_module {virtual table module} |
| 5785 |
** |
| 5786 |
** This structure, sometimes called a "virtual table module", |
| 5787 |
** defines the implementation of a [virtual tables]. |
| 5788 |
** This structure consists mostly of methods for the module. |
| 5789 |
** |
| 5790 |
** ^A virtual table module is created by filling in a persistent |
| 5791 |
** instance of this structure and passing a pointer to that instance |
| 5792 |
** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. |
| 5793 |
** ^The registration remains valid until it is replaced by a different |
| 5794 |
** module or until the [database connection] closes. The content |
| 5795 |
** of this structure must not change while it is registered with |
| 5796 |
** any database connection. |
| 5797 |
*/ |
| 5798 |
struct sqlite3_module { |
| 5799 |
int iVersion; |
| 5800 |
int (*xCreate)(sqlite3*, void *pAux, |
| 5801 |
int argc, const char *const*argv, |
| 5802 |
sqlite3_vtab **ppVTab, char**); |
| 5803 |
int (*xConnect)(sqlite3*, void *pAux, |
| 5804 |
int argc, const char *const*argv, |
| 5805 |
sqlite3_vtab **ppVTab, char**); |
| 5806 |
int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); |
| 5807 |
int (*xDisconnect)(sqlite3_vtab *pVTab); |
| 5808 |
int (*xDestroy)(sqlite3_vtab *pVTab); |
| 5809 |
int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); |
| 5810 |
int (*xClose)(sqlite3_vtab_cursor*); |
| 5811 |
int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, |
| 5812 |
int argc, sqlite3_value **argv); |
| 5813 |
int (*xNext)(sqlite3_vtab_cursor*); |
| 5814 |
int (*xEof)(sqlite3_vtab_cursor*); |
| 5815 |
int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); |
| 5816 |
int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); |
| 5817 |
int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); |
| 5818 |
int (*xBegin)(sqlite3_vtab *pVTab); |
| 5819 |
int (*xSync)(sqlite3_vtab *pVTab); |
| 5820 |
int (*xCommit)(sqlite3_vtab *pVTab); |
| 5821 |
int (*xRollback)(sqlite3_vtab *pVTab); |
| 5822 |
int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, |
| 5823 |
void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), |
| 5824 |
void **ppArg); |
| 5825 |
int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); |
| 5826 |
/* The methods above are in version 1 of the sqlite_module object. Those |
| 5827 |
** below are for version 2 and greater. */ |
| 5828 |
int (*xSavepoint)(sqlite3_vtab *pVTab, int); |
| 5829 |
int (*xRelease)(sqlite3_vtab *pVTab, int); |
| 5830 |
int (*xRollbackTo)(sqlite3_vtab *pVTab, int); |
| 5831 |
}; |
| 5832 |
|
| 5833 |
/* |
| 5834 |
** CAPI3REF: Virtual Table Indexing Information |
| 5835 |
** KEYWORDS: sqlite3_index_info |
| 5836 |
** |
| 5837 |
** The sqlite3_index_info structure and its substructures is used as part |
| 5838 |
** of the [virtual table] interface to |
| 5839 |
** pass information into and receive the reply from the [xBestIndex] |
| 5840 |
** method of a [virtual table module]. The fields under **Inputs** are the |
| 5841 |
** inputs to xBestIndex and are read-only. xBestIndex inserts its |
| 5842 |
** results into the **Outputs** fields. |
| 5843 |
** |
| 5844 |
** ^(The aConstraint[] array records WHERE clause constraints of the form: |
| 5845 |
** |
| 5846 |
** <blockquote>column OP expr</blockquote> |
| 5847 |
** |
| 5848 |
** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is |
| 5849 |
** stored in aConstraint[].op using one of the |
| 5850 |
** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ |
| 5851 |
** ^(The index of the column is stored in |
| 5852 |
** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the |
| 5853 |
** expr on the right-hand side can be evaluated (and thus the constraint |
| 5854 |
** is usable) and false if it cannot.)^ |
| 5855 |
** |
| 5856 |
** ^The optimizer automatically inverts terms of the form "expr OP column" |
| 5857 |
** and makes other simplifications to the WHERE clause in an attempt to |
| 5858 |
** get as many WHERE clause terms into the form shown above as possible. |
| 5859 |
** ^The aConstraint[] array only reports WHERE clause terms that are |
| 5860 |
** relevant to the particular virtual table being queried. |
| 5861 |
** |
| 5862 |
** ^Information about the ORDER BY clause is stored in aOrderBy[]. |
| 5863 |
** ^Each term of aOrderBy records a column of the ORDER BY clause. |
| 5864 |
** |
| 5865 |
** The colUsed field indicates which columns of the virtual table may be |
| 5866 |
** required by the current scan. Virtual table columns are numbered from |
| 5867 |
** zero in the order in which they appear within the CREATE TABLE statement |
| 5868 |
** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), |
| 5869 |
** the corresponding bit is set within the colUsed mask if the column may be |
| 5870 |
** required by SQLite. If the table has at least 64 columns and any column |
| 5871 |
** to the right of the first 63 is required, then bit 63 of colUsed is also |
| 5872 |
** set. In other words, column iCol may be required if the expression |
| 5873 |
** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to |
| 5874 |
** non-zero. |
| 5875 |
** |
| 5876 |
** The [xBestIndex] method must fill aConstraintUsage[] with information |
| 5877 |
** about what parameters to pass to xFilter. ^If argvIndex>0 then |
| 5878 |
** the right-hand side of the corresponding aConstraint[] is evaluated |
| 5879 |
** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit |
| 5880 |
** is true, then the constraint is assumed to be fully handled by the |
| 5881 |
** virtual table and is not checked again by SQLite.)^ |
| 5882 |
** |
| 5883 |
** ^The idxNum and idxPtr values are recorded and passed into the |
| 5884 |
** [xFilter] method. |
| 5885 |
** ^[sqlite3_free()] is used to free idxPtr if and only if |
| 5886 |
** needToFreeIdxPtr is true. |
| 5887 |
** |
| 5888 |
** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in |
| 5889 |
** the correct order to satisfy the ORDER BY clause so that no separate |
| 5890 |
** sorting step is required. |
| 5891 |
** |
| 5892 |
** ^The estimatedCost value is an estimate of the cost of a particular |
| 5893 |
** strategy. A cost of N indicates that the cost of the strategy is similar |
| 5894 |
** to a linear scan of an SQLite table with N rows. A cost of log(N) |
| 5895 |
** indicates that the expense of the operation is similar to that of a |
| 5896 |
** binary search on a unique indexed field of an SQLite table with N rows. |
| 5897 |
** |
| 5898 |
** ^The estimatedRows value is an estimate of the number of rows that |
| 5899 |
** will be returned by the strategy. |
| 5900 |
** |
| 5901 |
** The xBestIndex method may optionally populate the idxFlags field with a |
| 5902 |
** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag - |
| 5903 |
** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite |
| 5904 |
** assumes that the strategy may visit at most one row. |
| 5905 |
** |
| 5906 |
** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then |
| 5907 |
** SQLite also assumes that if a call to the xUpdate() method is made as |
| 5908 |
** part of the same statement to delete or update a virtual table row and the |
| 5909 |
** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback |
| 5910 |
** any database changes. In other words, if the xUpdate() returns |
| 5911 |
** SQLITE_CONSTRAINT, the database contents must be exactly as they were |
| 5912 |
** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not |
| 5913 |
** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by |
| 5914 |
** the xUpdate method are automatically rolled back by SQLite. |
| 5915 |
** |
| 5916 |
** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info |
| 5917 |
** structure for SQLite [version 3.8.2] ([dateof:3.8.2]). |
| 5918 |
** If a virtual table extension is |
| 5919 |
** used with an SQLite version earlier than 3.8.2, the results of attempting |
| 5920 |
** to read or write the estimatedRows field are undefined (but are likely |
| 5921 |
** to included crashing the application). The estimatedRows field should |
| 5922 |
** therefore only be used if [sqlite3_libversion_number()] returns a |
| 5923 |
** value greater than or equal to 3008002. Similarly, the idxFlags field |
| 5924 |
** was added for [version 3.9.0] ([dateof:3.9.0]). |
| 5925 |
** It may therefore only be used if |
| 5926 |
** sqlite3_libversion_number() returns a value greater than or equal to |
| 5927 |
** 3009000. |
| 5928 |
*/ |
| 5929 |
struct sqlite3_index_info { |
| 5930 |
/* Inputs */ |
| 5931 |
int nConstraint; /* Number of entries in aConstraint */ |
| 5932 |
struct sqlite3_index_constraint { |
| 5933 |
int iColumn; /* Column constrained. -1 for ROWID */ |
| 5934 |
unsigned char op; /* Constraint operator */ |
| 5935 |
unsigned char usable; /* True if this constraint is usable */ |
| 5936 |
int iTermOffset; /* Used internally - xBestIndex should ignore */ |
| 5937 |
} *aConstraint; /* Table of WHERE clause constraints */ |
| 5938 |
int nOrderBy; /* Number of terms in the ORDER BY clause */ |
| 5939 |
struct sqlite3_index_orderby { |
| 5940 |
int iColumn; /* Column number */ |
| 5941 |
unsigned char desc; /* True for DESC. False for ASC. */ |
| 5942 |
} *aOrderBy; /* The ORDER BY clause */ |
| 5943 |
/* Outputs */ |
| 5944 |
struct sqlite3_index_constraint_usage { |
| 5945 |
int argvIndex; /* if >0, constraint is part of argv to xFilter */ |
| 5946 |
unsigned char omit; /* Do not code a test for this constraint */ |
| 5947 |
} *aConstraintUsage; |
| 5948 |
int idxNum; /* Number used to identify the index */ |
| 5949 |
char *idxStr; /* String, possibly obtained from sqlite3_malloc */ |
| 5950 |
int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ |
| 5951 |
int orderByConsumed; /* True if output is already ordered */ |
| 5952 |
double estimatedCost; /* Estimated cost of using this index */ |
| 5953 |
/* Fields below are only available in SQLite 3.8.2 and later */ |
| 5954 |
sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ |
| 5955 |
/* Fields below are only available in SQLite 3.9.0 and later */ |
| 5956 |
int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ |
| 5957 |
/* Fields below are only available in SQLite 3.10.0 and later */ |
| 5958 |
sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ |
| 5959 |
}; |
| 5960 |
|
| 5961 |
/* |
| 5962 |
** CAPI3REF: Virtual Table Scan Flags |
| 5963 |
*/ |
| 5964 |
#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ |
| 5965 |
|
| 5966 |
/* |
| 5967 |
** CAPI3REF: Virtual Table Constraint Operator Codes |
| 5968 |
** |
| 5969 |
** These macros defined the allowed values for the |
| 5970 |
** [sqlite3_index_info].aConstraint[].op field. Each value represents |
| 5971 |
** an operator that is part of a constraint term in the wHERE clause of |
| 5972 |
** a query that uses a [virtual table]. |
| 5973 |
*/ |
| 5974 |
#define SQLITE_INDEX_CONSTRAINT_EQ 2 |
| 5975 |
#define SQLITE_INDEX_CONSTRAINT_GT 4 |
| 5976 |
#define SQLITE_INDEX_CONSTRAINT_LE 8 |
| 5977 |
#define SQLITE_INDEX_CONSTRAINT_LT 16 |
| 5978 |
#define SQLITE_INDEX_CONSTRAINT_GE 32 |
| 5979 |
#define SQLITE_INDEX_CONSTRAINT_MATCH 64 |
| 5980 |
#define SQLITE_INDEX_CONSTRAINT_LIKE 65 |
| 5981 |
#define SQLITE_INDEX_CONSTRAINT_GLOB 66 |
| 5982 |
#define SQLITE_INDEX_CONSTRAINT_REGEXP 67 |
| 5983 |
|
| 5984 |
/* |
| 5985 |
** CAPI3REF: Register A Virtual Table Implementation |
| 5986 |
** METHOD: sqlite3 |
| 5987 |
** |
| 5988 |
** ^These routines are used to register a new [virtual table module] name. |
| 5989 |
** ^Module names must be registered before |
| 5990 |
** creating a new [virtual table] using the module and before using a |
| 5991 |
** preexisting [virtual table] for the module. |
| 5992 |
** |
| 5993 |
** ^The module name is registered on the [database connection] specified |
| 5994 |
** by the first parameter. ^The name of the module is given by the |
| 5995 |
** second parameter. ^The third parameter is a pointer to |
| 5996 |
** the implementation of the [virtual table module]. ^The fourth |
| 5997 |
** parameter is an arbitrary client data pointer that is passed through |
| 5998 |
** into the [xCreate] and [xConnect] methods of the virtual table module |
| 5999 |
** when a new virtual table is be being created or reinitialized. |
| 6000 |
** |
| 6001 |
** ^The sqlite3_create_module_v2() interface has a fifth parameter which |
| 6002 |
** is a pointer to a destructor for the pClientData. ^SQLite will |
| 6003 |
** invoke the destructor function (if it is not NULL) when SQLite |
| 6004 |
** no longer needs the pClientData pointer. ^The destructor will also |
| 6005 |
** be invoked if the call to sqlite3_create_module_v2() fails. |
| 6006 |
** ^The sqlite3_create_module() |
| 6007 |
** interface is equivalent to sqlite3_create_module_v2() with a NULL |
| 6008 |
** destructor. |
| 6009 |
*/ |
| 6010 |
SQLITE_API int sqlite3_create_module( |
| 6011 |
sqlite3 *db, /* SQLite connection to register module with */ |
| 6012 |
const char *zName, /* Name of the module */ |
| 6013 |
const sqlite3_module *p, /* Methods for the module */ |
| 6014 |
void *pClientData /* Client data for xCreate/xConnect */ |
| 6015 |
); |
| 6016 |
SQLITE_API int sqlite3_create_module_v2( |
| 6017 |
sqlite3 *db, /* SQLite connection to register module with */ |
| 6018 |
const char *zName, /* Name of the module */ |
| 6019 |
const sqlite3_module *p, /* Methods for the module */ |
| 6020 |
void *pClientData, /* Client data for xCreate/xConnect */ |
| 6021 |
void(*xDestroy)(void*) /* Module destructor function */ |
| 6022 |
); |
| 6023 |
|
| 6024 |
/* |
| 6025 |
** CAPI3REF: Virtual Table Instance Object |
| 6026 |
** KEYWORDS: sqlite3_vtab |
| 6027 |
** |
| 6028 |
** Every [virtual table module] implementation uses a subclass |
| 6029 |
** of this object to describe a particular instance |
| 6030 |
** of the [virtual table]. Each subclass will |
| 6031 |
** be tailored to the specific needs of the module implementation. |
| 6032 |
** The purpose of this superclass is to define certain fields that are |
| 6033 |
** common to all module implementations. |
| 6034 |
** |
| 6035 |
** ^Virtual tables methods can set an error message by assigning a |
| 6036 |
** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should |
| 6037 |
** take care that any prior string is freed by a call to [sqlite3_free()] |
| 6038 |
** prior to assigning a new string to zErrMsg. ^After the error message |
| 6039 |
** is delivered up to the client application, the string will be automatically |
| 6040 |
** freed by sqlite3_free() and the zErrMsg field will be zeroed. |
| 6041 |
*/ |
| 6042 |
struct sqlite3_vtab { |
| 6043 |
const sqlite3_module *pModule; /* The module for this virtual table */ |
| 6044 |
int nRef; /* Number of open cursors */ |
| 6045 |
char *zErrMsg; /* Error message from sqlite3_mprintf() */ |
| 6046 |
/* Virtual table implementations will typically add additional fields */ |
| 6047 |
}; |
| 6048 |
|
| 6049 |
/* |
| 6050 |
** CAPI3REF: Virtual Table Cursor Object |
| 6051 |
** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} |
| 6052 |
** |
| 6053 |
** Every [virtual table module] implementation uses a subclass of the |
| 6054 |
** following structure to describe cursors that point into the |
| 6055 |
** [virtual table] and are used |
| 6056 |
** to loop through the virtual table. Cursors are created using the |
| 6057 |
** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed |
| 6058 |
** by the [sqlite3_module.xClose | xClose] method. Cursors are used |
| 6059 |
** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods |
| 6060 |
** of the module. Each module implementation will define |
| 6061 |
** the content of a cursor structure to suit its own needs. |
| 6062 |
** |
| 6063 |
** This superclass exists in order to define fields of the cursor that |
| 6064 |
** are common to all implementations. |
| 6065 |
*/ |
| 6066 |
struct sqlite3_vtab_cursor { |
| 6067 |
sqlite3_vtab *pVtab; /* Virtual table of this cursor */ |
| 6068 |
/* Virtual table implementations will typically add additional fields */ |
| 6069 |
}; |
| 6070 |
|
| 6071 |
/* |
| 6072 |
** CAPI3REF: Declare The Schema Of A Virtual Table |
| 6073 |
** |
| 6074 |
** ^The [xCreate] and [xConnect] methods of a |
| 6075 |
** [virtual table module] call this interface |
| 6076 |
** to declare the format (the names and datatypes of the columns) of |
| 6077 |
** the virtual tables they implement. |
| 6078 |
*/ |
| 6079 |
SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL); |
| 6080 |
|
| 6081 |
/* |
| 6082 |
** CAPI3REF: Overload A Function For A Virtual Table |
| 6083 |
** METHOD: sqlite3 |
| 6084 |
** |
| 6085 |
** ^(Virtual tables can provide alternative implementations of functions |
| 6086 |
** using the [xFindFunction] method of the [virtual table module]. |
| 6087 |
** But global versions of those functions |
| 6088 |
** must exist in order to be overloaded.)^ |
| 6089 |
** |
| 6090 |
** ^(This API makes sure a global version of a function with a particular |
| 6091 |
** name and number of parameters exists. If no such function exists |
| 6092 |
** before this API is called, a new function is created.)^ ^The implementation |
| 6093 |
** of the new function always causes an exception to be thrown. So |
| 6094 |
** the new function is not good for anything by itself. Its only |
| 6095 |
** purpose is to be a placeholder function that can be overloaded |
| 6096 |
** by a [virtual table]. |
| 6097 |
*/ |
| 6098 |
SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); |
| 6099 |
|
| 6100 |
/* |
| 6101 |
** The interface to the virtual-table mechanism defined above (back up |
| 6102 |
** to a comment remarkably similar to this one) is currently considered |
| 6103 |
** to be experimental. The interface might change in incompatible ways. |
| 6104 |
** If this is a problem for you, do not use the interface at this time. |
| 6105 |
** |
| 6106 |
** When the virtual-table mechanism stabilizes, we will declare the |
| 6107 |
** interface fixed, support it indefinitely, and remove this comment. |
| 6108 |
*/ |
| 6109 |
|
| 6110 |
/* |
| 6111 |
** CAPI3REF: A Handle To An Open BLOB |
| 6112 |
** KEYWORDS: {BLOB handle} {BLOB handles} |
| 6113 |
** |
| 6114 |
** An instance of this object represents an open BLOB on which |
| 6115 |
** [sqlite3_blob_open | incremental BLOB I/O] can be performed. |
| 6116 |
** ^Objects of this type are created by [sqlite3_blob_open()] |
| 6117 |
** and destroyed by [sqlite3_blob_close()]. |
| 6118 |
** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces |
| 6119 |
** can be used to read or write small subsections of the BLOB. |
| 6120 |
** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. |
| 6121 |
*/ |
| 6122 |
typedef struct sqlite3_blob sqlite3_blob; |
| 6123 |
|
| 6124 |
/* |
| 6125 |
** CAPI3REF: Open A BLOB For Incremental I/O |
| 6126 |
** METHOD: sqlite3 |
| 6127 |
** CONSTRUCTOR: sqlite3_blob |
| 6128 |
** |
| 6129 |
** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located |
| 6130 |
** in row iRow, column zColumn, table zTable in database zDb; |
| 6131 |
** in other words, the same BLOB that would be selected by: |
| 6132 |
** |
| 6133 |
** <pre> |
| 6134 |
** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; |
| 6135 |
** </pre>)^ |
| 6136 |
** |
| 6137 |
** ^(Parameter zDb is not the filename that contains the database, but |
| 6138 |
** rather the symbolic name of the database. For attached databases, this is |
| 6139 |
** the name that appears after the AS keyword in the [ATTACH] statement. |
| 6140 |
** For the main database file, the database name is "main". For TEMP |
| 6141 |
** tables, the database name is "temp".)^ |
| 6142 |
** |
| 6143 |
** ^If the flags parameter is non-zero, then the BLOB is opened for read |
| 6144 |
** and write access. ^If the flags parameter is zero, the BLOB is opened for |
| 6145 |
** read-only access. |
| 6146 |
** |
| 6147 |
** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored |
| 6148 |
** in *ppBlob. Otherwise an [error code] is returned and, unless the error |
| 6149 |
** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided |
| 6150 |
** the API is not misused, it is always safe to call [sqlite3_blob_close()] |
| 6151 |
** on *ppBlob after this function it returns. |
| 6152 |
** |
| 6153 |
** This function fails with SQLITE_ERROR if any of the following are true: |
| 6154 |
** <ul> |
| 6155 |
** <li> ^(Database zDb does not exist)^, |
| 6156 |
** <li> ^(Table zTable does not exist within database zDb)^, |
| 6157 |
** <li> ^(Table zTable is a WITHOUT ROWID table)^, |
| 6158 |
** <li> ^(Column zColumn does not exist)^, |
| 6159 |
** <li> ^(Row iRow is not present in the table)^, |
| 6160 |
** <li> ^(The specified column of row iRow contains a value that is not |
| 6161 |
** a TEXT or BLOB value)^, |
| 6162 |
** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE |
| 6163 |
** constraint and the blob is being opened for read/write access)^, |
| 6164 |
** <li> ^([foreign key constraints | Foreign key constraints] are enabled, |
| 6165 |
** column zColumn is part of a [child key] definition and the blob is |
| 6166 |
** being opened for read/write access)^. |
| 6167 |
** </ul> |
| 6168 |
** |
| 6169 |
** ^Unless it returns SQLITE_MISUSE, this function sets the |
| 6170 |
** [database connection] error code and message accessible via |
| 6171 |
** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. |
| 6172 |
** |
| 6173 |
** |
| 6174 |
** ^(If the row that a BLOB handle points to is modified by an |
| 6175 |
** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects |
| 6176 |
** then the BLOB handle is marked as "expired". |
| 6177 |
** This is true if any column of the row is changed, even a column |
| 6178 |
** other than the one the BLOB handle is open on.)^ |
| 6179 |
** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for |
| 6180 |
** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. |
| 6181 |
** ^(Changes written into a BLOB prior to the BLOB expiring are not |
| 6182 |
** rolled back by the expiration of the BLOB. Such changes will eventually |
| 6183 |
** commit if the transaction continues to completion.)^ |
| 6184 |
** |
| 6185 |
** ^Use the [sqlite3_blob_bytes()] interface to determine the size of |
| 6186 |
** the opened blob. ^The size of a blob may not be changed by this |
| 6187 |
** interface. Use the [UPDATE] SQL command to change the size of a |
| 6188 |
** blob. |
| 6189 |
** |
| 6190 |
** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces |
| 6191 |
** and the built-in [zeroblob] SQL function may be used to create a |
| 6192 |
** zero-filled blob to read or write using the incremental-blob interface. |
| 6193 |
** |
| 6194 |
** To avoid a resource leak, every open [BLOB handle] should eventually |
| 6195 |
** be released by a call to [sqlite3_blob_close()]. |
| 6196 |
*/ |
| 6197 |
SQLITE_API int sqlite3_blob_open( |
| 6198 |
sqlite3*, |
| 6199 |
const char *zDb, |
| 6200 |
const char *zTable, |
| 6201 |
const char *zColumn, |
| 6202 |
sqlite3_int64 iRow, |
| 6203 |
int flags, |
| 6204 |
sqlite3_blob **ppBlob |
| 6205 |
); |
| 6206 |
|
| 6207 |
/* |
| 6208 |
** CAPI3REF: Move a BLOB Handle to a New Row |
| 6209 |
** METHOD: sqlite3_blob |
| 6210 |
** |
| 6211 |
** ^This function is used to move an existing blob handle so that it points |
| 6212 |
** to a different row of the same database table. ^The new row is identified |
| 6213 |
** by the rowid value passed as the second argument. Only the row can be |
| 6214 |
** changed. ^The database, table and column on which the blob handle is open |
| 6215 |
** remain the same. Moving an existing blob handle to a new row can be |
| 6216 |
** faster than closing the existing handle and opening a new one. |
| 6217 |
** |
| 6218 |
** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - |
| 6219 |
** it must exist and there must be either a blob or text value stored in |
| 6220 |
** the nominated column.)^ ^If the new row is not present in the table, or if |
| 6221 |
** it does not contain a blob or text value, or if another error occurs, an |
| 6222 |
** SQLite error code is returned and the blob handle is considered aborted. |
| 6223 |
** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or |
| 6224 |
** [sqlite3_blob_reopen()] on an aborted blob handle immediately return |
| 6225 |
** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle |
| 6226 |
** always returns zero. |
| 6227 |
** |
| 6228 |
** ^This function sets the database handle error code and message. |
| 6229 |
*/ |
| 6230 |
SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); |
| 6231 |
|
| 6232 |
/* |
| 6233 |
** CAPI3REF: Close A BLOB Handle |
| 6234 |
** DESTRUCTOR: sqlite3_blob |
| 6235 |
** |
| 6236 |
** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed |
| 6237 |
** unconditionally. Even if this routine returns an error code, the |
| 6238 |
** handle is still closed.)^ |
| 6239 |
** |
| 6240 |
** ^If the blob handle being closed was opened for read-write access, and if |
| 6241 |
** the database is in auto-commit mode and there are no other open read-write |
| 6242 |
** blob handles or active write statements, the current transaction is |
| 6243 |
** committed. ^If an error occurs while committing the transaction, an error |
| 6244 |
** code is returned and the transaction rolled back. |
| 6245 |
** |
| 6246 |
** Calling this function with an argument that is not a NULL pointer or an |
| 6247 |
** open blob handle results in undefined behaviour. ^Calling this routine |
| 6248 |
** with a null pointer (such as would be returned by a failed call to |
| 6249 |
** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function |
| 6250 |
** is passed a valid open blob handle, the values returned by the |
| 6251 |
** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning. |
| 6252 |
*/ |
| 6253 |
SQLITE_API int sqlite3_blob_close(sqlite3_blob *); |
| 6254 |
|
| 6255 |
/* |
| 6256 |
** CAPI3REF: Return The Size Of An Open BLOB |
| 6257 |
** METHOD: sqlite3_blob |
| 6258 |
** |
| 6259 |
** ^Returns the size in bytes of the BLOB accessible via the |
| 6260 |
** successfully opened [BLOB handle] in its only argument. ^The |
| 6261 |
** incremental blob I/O routines can only read or overwriting existing |
| 6262 |
** blob content; they cannot change the size of a blob. |
| 6263 |
** |
| 6264 |
** This routine only works on a [BLOB handle] which has been created |
| 6265 |
** by a prior successful call to [sqlite3_blob_open()] and which has not |
| 6266 |
** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
| 6267 |
** to this routine results in undefined and probably undesirable behavior. |
| 6268 |
*/ |
| 6269 |
SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); |
| 6270 |
|
| 6271 |
/* |
| 6272 |
** CAPI3REF: Read Data From A BLOB Incrementally |
| 6273 |
** METHOD: sqlite3_blob |
| 6274 |
** |
| 6275 |
** ^(This function is used to read data from an open [BLOB handle] into a |
| 6276 |
** caller-supplied buffer. N bytes of data are copied into buffer Z |
| 6277 |
** from the open BLOB, starting at offset iOffset.)^ |
| 6278 |
** |
| 6279 |
** ^If offset iOffset is less than N bytes from the end of the BLOB, |
| 6280 |
** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is |
| 6281 |
** less than zero, [SQLITE_ERROR] is returned and no data is read. |
| 6282 |
** ^The size of the blob (and hence the maximum value of N+iOffset) |
| 6283 |
** can be determined using the [sqlite3_blob_bytes()] interface. |
| 6284 |
** |
| 6285 |
** ^An attempt to read from an expired [BLOB handle] fails with an |
| 6286 |
** error code of [SQLITE_ABORT]. |
| 6287 |
** |
| 6288 |
** ^(On success, sqlite3_blob_read() returns SQLITE_OK. |
| 6289 |
** Otherwise, an [error code] or an [extended error code] is returned.)^ |
| 6290 |
** |
| 6291 |
** This routine only works on a [BLOB handle] which has been created |
| 6292 |
** by a prior successful call to [sqlite3_blob_open()] and which has not |
| 6293 |
** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
| 6294 |
** to this routine results in undefined and probably undesirable behavior. |
| 6295 |
** |
| 6296 |
** See also: [sqlite3_blob_write()]. |
| 6297 |
*/ |
| 6298 |
SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); |
| 6299 |
|
| 6300 |
/* |
| 6301 |
** CAPI3REF: Write Data Into A BLOB Incrementally |
| 6302 |
** METHOD: sqlite3_blob |
| 6303 |
** |
| 6304 |
** ^(This function is used to write data into an open [BLOB handle] from a |
| 6305 |
** caller-supplied buffer. N bytes of data are copied from the buffer Z |
| 6306 |
** into the open BLOB, starting at offset iOffset.)^ |
| 6307 |
** |
| 6308 |
** ^(On success, sqlite3_blob_write() returns SQLITE_OK. |
| 6309 |
** Otherwise, an [error code] or an [extended error code] is returned.)^ |
| 6310 |
** ^Unless SQLITE_MISUSE is returned, this function sets the |
| 6311 |
** [database connection] error code and message accessible via |
| 6312 |
** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. |
| 6313 |
** |
| 6314 |
** ^If the [BLOB handle] passed as the first argument was not opened for |
| 6315 |
** writing (the flags parameter to [sqlite3_blob_open()] was zero), |
| 6316 |
** this function returns [SQLITE_READONLY]. |
| 6317 |
** |
| 6318 |
** This function may only modify the contents of the BLOB; it is |
| 6319 |
** not possible to increase the size of a BLOB using this API. |
| 6320 |
** ^If offset iOffset is less than N bytes from the end of the BLOB, |
| 6321 |
** [SQLITE_ERROR] is returned and no data is written. The size of the |
| 6322 |
** BLOB (and hence the maximum value of N+iOffset) can be determined |
| 6323 |
** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less |
| 6324 |
** than zero [SQLITE_ERROR] is returned and no data is written. |
| 6325 |
** |
| 6326 |
** ^An attempt to write to an expired [BLOB handle] fails with an |
| 6327 |
** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred |
| 6328 |
** before the [BLOB handle] expired are not rolled back by the |
| 6329 |
** expiration of the handle, though of course those changes might |
| 6330 |
** have been overwritten by the statement that expired the BLOB handle |
| 6331 |
** or by other independent statements. |
| 6332 |
** |
| 6333 |
** This routine only works on a [BLOB handle] which has been created |
| 6334 |
** by a prior successful call to [sqlite3_blob_open()] and which has not |
| 6335 |
** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
| 6336 |
** to this routine results in undefined and probably undesirable behavior. |
| 6337 |
** |
| 6338 |
** See also: [sqlite3_blob_read()]. |
| 6339 |
*/ |
| 6340 |
SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); |
| 6341 |
|
| 6342 |
/* |
| 6343 |
** CAPI3REF: Virtual File System Objects |
| 6344 |
** |
| 6345 |
** A virtual filesystem (VFS) is an [sqlite3_vfs] object |
| 6346 |
** that SQLite uses to interact |
| 6347 |
** with the underlying operating system. Most SQLite builds come with a |
| 6348 |
** single default VFS that is appropriate for the host computer. |
| 6349 |
** New VFSes can be registered and existing VFSes can be unregistered. |
| 6350 |
** The following interfaces are provided. |
| 6351 |
** |
| 6352 |
** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. |
| 6353 |
** ^Names are case sensitive. |
| 6354 |
** ^Names are zero-terminated UTF-8 strings. |
| 6355 |
** ^If there is no match, a NULL pointer is returned. |
| 6356 |
** ^If zVfsName is NULL then the default VFS is returned. |
| 6357 |
** |
| 6358 |
** ^New VFSes are registered with sqlite3_vfs_register(). |
| 6359 |
** ^Each new VFS becomes the default VFS if the makeDflt flag is set. |
| 6360 |
** ^The same VFS can be registered multiple times without injury. |
| 6361 |
** ^To make an existing VFS into the default VFS, register it again |
| 6362 |
** with the makeDflt flag set. If two different VFSes with the |
| 6363 |
** same name are registered, the behavior is undefined. If a |
| 6364 |
** VFS is registered with a name that is NULL or an empty string, |
| 6365 |
** then the behavior is undefined. |
| 6366 |
** |
| 6367 |
** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. |
| 6368 |
** ^(If the default VFS is unregistered, another VFS is chosen as |
| 6369 |
** the default. The choice for the new VFS is arbitrary.)^ |
| 6370 |
*/ |
| 6371 |
SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); |
| 6372 |
SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); |
| 6373 |
SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); |
| 6374 |
|
| 6375 |
/* |
| 6376 |
** CAPI3REF: Mutexes |
| 6377 |
** |
| 6378 |
** The SQLite core uses these routines for thread |
| 6379 |
** synchronization. Though they are intended for internal |
| 6380 |
** use by SQLite, code that links against SQLite is |
| 6381 |
** permitted to use any of these routines. |
| 6382 |
** |
| 6383 |
** The SQLite source code contains multiple implementations |
| 6384 |
** of these mutex routines. An appropriate implementation |
| 6385 |
** is selected automatically at compile-time. The following |
| 6386 |
** implementations are available in the SQLite core: |
| 6387 |
** |
| 6388 |
** <ul> |
| 6389 |
** <li> SQLITE_MUTEX_PTHREADS |
| 6390 |
** <li> SQLITE_MUTEX_W32 |
| 6391 |
** <li> SQLITE_MUTEX_NOOP |
| 6392 |
** </ul> |
| 6393 |
** |
| 6394 |
** The SQLITE_MUTEX_NOOP implementation is a set of routines |
| 6395 |
** that does no real locking and is appropriate for use in |
| 6396 |
** a single-threaded application. The SQLITE_MUTEX_PTHREADS and |
| 6397 |
** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix |
| 6398 |
** and Windows. |
| 6399 |
** |
| 6400 |
** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor |
| 6401 |
** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex |
| 6402 |
** implementation is included with the library. In this case the |
| 6403 |
** application must supply a custom mutex implementation using the |
| 6404 |
** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function |
| 6405 |
** before calling sqlite3_initialize() or any other public sqlite3_ |
| 6406 |
** function that calls sqlite3_initialize(). |
| 6407 |
** |
| 6408 |
** ^The sqlite3_mutex_alloc() routine allocates a new |
| 6409 |
** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc() |
| 6410 |
** routine returns NULL if it is unable to allocate the requested |
| 6411 |
** mutex. The argument to sqlite3_mutex_alloc() must one of these |
| 6412 |
** integer constants: |
| 6413 |
** |
| 6414 |
** <ul> |
| 6415 |
** <li> SQLITE_MUTEX_FAST |
| 6416 |
** <li> SQLITE_MUTEX_RECURSIVE |
| 6417 |
** <li> SQLITE_MUTEX_STATIC_MASTER |
| 6418 |
** <li> SQLITE_MUTEX_STATIC_MEM |
| 6419 |
** <li> SQLITE_MUTEX_STATIC_OPEN |
| 6420 |
** <li> SQLITE_MUTEX_STATIC_PRNG |
| 6421 |
** <li> SQLITE_MUTEX_STATIC_LRU |
| 6422 |
** <li> SQLITE_MUTEX_STATIC_PMEM |
| 6423 |
** <li> SQLITE_MUTEX_STATIC_APP1 |
| 6424 |
** <li> SQLITE_MUTEX_STATIC_APP2 |
| 6425 |
** <li> SQLITE_MUTEX_STATIC_APP3 |
| 6426 |
** <li> SQLITE_MUTEX_STATIC_VFS1 |
| 6427 |
** <li> SQLITE_MUTEX_STATIC_VFS2 |
| 6428 |
** <li> SQLITE_MUTEX_STATIC_VFS3 |
| 6429 |
** </ul> |
| 6430 |
** |
| 6431 |
** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) |
| 6432 |
** cause sqlite3_mutex_alloc() to create |
| 6433 |
** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE |
| 6434 |
** is used but not necessarily so when SQLITE_MUTEX_FAST is used. |
| 6435 |
** The mutex implementation does not need to make a distinction |
| 6436 |
** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does |
| 6437 |
** not want to. SQLite will only request a recursive mutex in |
| 6438 |
** cases where it really needs one. If a faster non-recursive mutex |
| 6439 |
** implementation is available on the host platform, the mutex subsystem |
| 6440 |
** might return such a mutex in response to SQLITE_MUTEX_FAST. |
| 6441 |
** |
| 6442 |
** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other |
| 6443 |
** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return |
| 6444 |
** a pointer to a static preexisting mutex. ^Nine static mutexes are |
| 6445 |
** used by the current version of SQLite. Future versions of SQLite |
| 6446 |
** may add additional static mutexes. Static mutexes are for internal |
| 6447 |
** use by SQLite only. Applications that use SQLite mutexes should |
| 6448 |
** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or |
| 6449 |
** SQLITE_MUTEX_RECURSIVE. |
| 6450 |
** |
| 6451 |
** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST |
| 6452 |
** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() |
| 6453 |
** returns a different mutex on every call. ^For the static |
| 6454 |
** mutex types, the same mutex is returned on every call that has |
| 6455 |
** the same type number. |
| 6456 |
** |
| 6457 |
** ^The sqlite3_mutex_free() routine deallocates a previously |
| 6458 |
** allocated dynamic mutex. Attempting to deallocate a static |
| 6459 |
** mutex results in undefined behavior. |
| 6460 |
** |
| 6461 |
** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt |
| 6462 |
** to enter a mutex. ^If another thread is already within the mutex, |
| 6463 |
** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return |
| 6464 |
** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] |
| 6465 |
** upon successful entry. ^(Mutexes created using |
| 6466 |
** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. |
| 6467 |
** In such cases, the |
| 6468 |
** mutex must be exited an equal number of times before another thread |
| 6469 |
** can enter.)^ If the same thread tries to enter any mutex other |
| 6470 |
** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined. |
| 6471 |
** |
| 6472 |
** ^(Some systems (for example, Windows 95) do not support the operation |
| 6473 |
** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() |
| 6474 |
** will always return SQLITE_BUSY. The SQLite core only ever uses |
| 6475 |
** sqlite3_mutex_try() as an optimization so this is acceptable |
| 6476 |
** behavior.)^ |
| 6477 |
** |
| 6478 |
** ^The sqlite3_mutex_leave() routine exits a mutex that was |
| 6479 |
** previously entered by the same thread. The behavior |
| 6480 |
** is undefined if the mutex is not currently entered by the |
| 6481 |
** calling thread or is not currently allocated. |
| 6482 |
** |
| 6483 |
** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or |
| 6484 |
** sqlite3_mutex_leave() is a NULL pointer, then all three routines |
| 6485 |
** behave as no-ops. |
| 6486 |
** |
| 6487 |
** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. |
| 6488 |
*/ |
| 6489 |
SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); |
| 6490 |
SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); |
| 6491 |
SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); |
| 6492 |
SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); |
| 6493 |
SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); |
| 6494 |
|
| 6495 |
/* |
| 6496 |
** CAPI3REF: Mutex Methods Object |
| 6497 |
** |
| 6498 |
** An instance of this structure defines the low-level routines |
| 6499 |
** used to allocate and use mutexes. |
| 6500 |
** |
| 6501 |
** Usually, the default mutex implementations provided by SQLite are |
| 6502 |
** sufficient, however the application has the option of substituting a custom |
| 6503 |
** implementation for specialized deployments or systems for which SQLite |
| 6504 |
** does not provide a suitable implementation. In this case, the application |
| 6505 |
** creates and populates an instance of this structure to pass |
| 6506 |
** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. |
| 6507 |
** Additionally, an instance of this structure can be used as an |
| 6508 |
** output variable when querying the system for the current mutex |
| 6509 |
** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. |
| 6510 |
** |
| 6511 |
** ^The xMutexInit method defined by this structure is invoked as |
| 6512 |
** part of system initialization by the sqlite3_initialize() function. |
| 6513 |
** ^The xMutexInit routine is called by SQLite exactly once for each |
| 6514 |
** effective call to [sqlite3_initialize()]. |
| 6515 |
** |
| 6516 |
** ^The xMutexEnd method defined by this structure is invoked as |
| 6517 |
** part of system shutdown by the sqlite3_shutdown() function. The |
| 6518 |
** implementation of this method is expected to release all outstanding |
| 6519 |
** resources obtained by the mutex methods implementation, especially |
| 6520 |
** those obtained by the xMutexInit method. ^The xMutexEnd() |
| 6521 |
** interface is invoked exactly once for each call to [sqlite3_shutdown()]. |
| 6522 |
** |
| 6523 |
** ^(The remaining seven methods defined by this structure (xMutexAlloc, |
| 6524 |
** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and |
| 6525 |
** xMutexNotheld) implement the following interfaces (respectively): |
| 6526 |
** |
| 6527 |
** <ul> |
| 6528 |
** <li> [sqlite3_mutex_alloc()] </li> |
| 6529 |
** <li> [sqlite3_mutex_free()] </li> |
| 6530 |
** <li> [sqlite3_mutex_enter()] </li> |
| 6531 |
** <li> [sqlite3_mutex_try()] </li> |
| 6532 |
** <li> [sqlite3_mutex_leave()] </li> |
| 6533 |
** <li> [sqlite3_mutex_held()] </li> |
| 6534 |
** <li> [sqlite3_mutex_notheld()] </li> |
| 6535 |
** </ul>)^ |
| 6536 |
** |
| 6537 |
** The only difference is that the public sqlite3_XXX functions enumerated |
| 6538 |
** above silently ignore any invocations that pass a NULL pointer instead |
| 6539 |
** of a valid mutex handle. The implementations of the methods defined |
| 6540 |
** by this structure are not required to handle this case, the results |
| 6541 |
** of passing a NULL pointer instead of a valid mutex handle are undefined |
| 6542 |
** (i.e. it is acceptable to provide an implementation that segfaults if |
| 6543 |
** it is passed a NULL pointer). |
| 6544 |
** |
| 6545 |
** The xMutexInit() method must be threadsafe. It must be harmless to |
| 6546 |
** invoke xMutexInit() multiple times within the same process and without |
| 6547 |
** intervening calls to xMutexEnd(). Second and subsequent calls to |
| 6548 |
** xMutexInit() must be no-ops. |
| 6549 |
** |
| 6550 |
** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] |
| 6551 |
** and its associates). Similarly, xMutexAlloc() must not use SQLite memory |
| 6552 |
** allocation for a static mutex. ^However xMutexAlloc() may use SQLite |
| 6553 |
** memory allocation for a fast or recursive mutex. |
| 6554 |
** |
| 6555 |
** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is |
| 6556 |
** called, but only if the prior call to xMutexInit returned SQLITE_OK. |
| 6557 |
** If xMutexInit fails in any way, it is expected to clean up after itself |
| 6558 |
** prior to returning. |
| 6559 |
*/ |
| 6560 |
typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; |
| 6561 |
struct sqlite3_mutex_methods { |
| 6562 |
int (*xMutexInit)(void); |
| 6563 |
int (*xMutexEnd)(void); |
| 6564 |
sqlite3_mutex *(*xMutexAlloc)(int); |
| 6565 |
void (*xMutexFree)(sqlite3_mutex *); |
| 6566 |
void (*xMutexEnter)(sqlite3_mutex *); |
| 6567 |
int (*xMutexTry)(sqlite3_mutex *); |
| 6568 |
void (*xMutexLeave)(sqlite3_mutex *); |
| 6569 |
int (*xMutexHeld)(sqlite3_mutex *); |
| 6570 |
int (*xMutexNotheld)(sqlite3_mutex *); |
| 6571 |
}; |
| 6572 |
|
| 6573 |
/* |
| 6574 |
** CAPI3REF: Mutex Verification Routines |
| 6575 |
** |
| 6576 |
** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines |
| 6577 |
** are intended for use inside assert() statements. The SQLite core |
| 6578 |
** never uses these routines except inside an assert() and applications |
| 6579 |
** are advised to follow the lead of the core. The SQLite core only |
| 6580 |
** provides implementations for these routines when it is compiled |
| 6581 |
** with the SQLITE_DEBUG flag. External mutex implementations |
| 6582 |
** are only required to provide these routines if SQLITE_DEBUG is |
| 6583 |
** defined and if NDEBUG is not defined. |
| 6584 |
** |
| 6585 |
** These routines should return true if the mutex in their argument |
| 6586 |
** is held or not held, respectively, by the calling thread. |
| 6587 |
** |
| 6588 |
** The implementation is not required to provide versions of these |
| 6589 |
** routines that actually work. If the implementation does not provide working |
| 6590 |
** versions of these routines, it should at least provide stubs that always |
| 6591 |
** return true so that one does not get spurious assertion failures. |
| 6592 |
** |
| 6593 |
** If the argument to sqlite3_mutex_held() is a NULL pointer then |
| 6594 |
** the routine should return 1. This seems counter-intuitive since |
| 6595 |
** clearly the mutex cannot be held if it does not exist. But |
| 6596 |
** the reason the mutex does not exist is because the build is not |
| 6597 |
** using mutexes. And we do not want the assert() containing the |
| 6598 |
** call to sqlite3_mutex_held() to fail, so a non-zero return is |
| 6599 |
** the appropriate thing to do. The sqlite3_mutex_notheld() |
| 6600 |
** interface should also return 1 when given a NULL pointer. |
| 6601 |
*/ |
| 6602 |
#ifndef NDEBUG |
| 6603 |
SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); |
| 6604 |
SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); |
| 6605 |
#endif |
| 6606 |
|
| 6607 |
/* |
| 6608 |
** CAPI3REF: Mutex Types |
| 6609 |
** |
| 6610 |
** The [sqlite3_mutex_alloc()] interface takes a single argument |
| 6611 |
** which is one of these integer constants. |
| 6612 |
** |
| 6613 |
** The set of static mutexes may change from one SQLite release to the |
| 6614 |
** next. Applications that override the built-in mutex logic must be |
| 6615 |
** prepared to accommodate additional static mutexes. |
| 6616 |
*/ |
| 6617 |
#define SQLITE_MUTEX_FAST 0 |
| 6618 |
#define SQLITE_MUTEX_RECURSIVE 1 |
| 6619 |
#define SQLITE_MUTEX_STATIC_MASTER 2 |
| 6620 |
#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ |
| 6621 |
#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ |
| 6622 |
#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ |
| 6623 |
#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */ |
| 6624 |
#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ |
| 6625 |
#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ |
| 6626 |
#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ |
| 6627 |
#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */ |
| 6628 |
#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */ |
| 6629 |
#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */ |
| 6630 |
#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */ |
| 6631 |
#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */ |
| 6632 |
#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */ |
| 6633 |
|
| 6634 |
/* |
| 6635 |
** CAPI3REF: Retrieve the mutex for a database connection |
| 6636 |
** METHOD: sqlite3 |
| 6637 |
** |
| 6638 |
** ^This interface returns a pointer the [sqlite3_mutex] object that |
| 6639 |
** serializes access to the [database connection] given in the argument |
| 6640 |
** when the [threading mode] is Serialized. |
| 6641 |
** ^If the [threading mode] is Single-thread or Multi-thread then this |
| 6642 |
** routine returns a NULL pointer. |
| 6643 |
*/ |
| 6644 |
SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); |
| 6645 |
|
| 6646 |
/* |
| 6647 |
** CAPI3REF: Low-Level Control Of Database Files |
| 6648 |
** METHOD: sqlite3 |
| 6649 |
** |
| 6650 |
** ^The [sqlite3_file_control()] interface makes a direct call to the |
| 6651 |
** xFileControl method for the [sqlite3_io_methods] object associated |
| 6652 |
** with a particular database identified by the second argument. ^The |
| 6653 |
** name of the database is "main" for the main database or "temp" for the |
| 6654 |
** TEMP database, or the name that appears after the AS keyword for |
| 6655 |
** databases that are added using the [ATTACH] SQL command. |
| 6656 |
** ^A NULL pointer can be used in place of "main" to refer to the |
| 6657 |
** main database file. |
| 6658 |
** ^The third and fourth parameters to this routine |
| 6659 |
** are passed directly through to the second and third parameters of |
| 6660 |
** the xFileControl method. ^The return value of the xFileControl |
| 6661 |
** method becomes the return value of this routine. |
| 6662 |
** |
| 6663 |
** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes |
| 6664 |
** a pointer to the underlying [sqlite3_file] object to be written into |
| 6665 |
** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER |
| 6666 |
** case is a short-circuit path which does not actually invoke the |
| 6667 |
** underlying sqlite3_io_methods.xFileControl method. |
| 6668 |
** |
| 6669 |
** ^If the second parameter (zDbName) does not match the name of any |
| 6670 |
** open database file, then SQLITE_ERROR is returned. ^This error |
| 6671 |
** code is not remembered and will not be recalled by [sqlite3_errcode()] |
| 6672 |
** or [sqlite3_errmsg()]. The underlying xFileControl method might |
| 6673 |
** also return SQLITE_ERROR. There is no way to distinguish between |
| 6674 |
** an incorrect zDbName and an SQLITE_ERROR return from the underlying |
| 6675 |
** xFileControl method. |
| 6676 |
** |
| 6677 |
** See also: [SQLITE_FCNTL_LOCKSTATE] |
| 6678 |
*/ |
| 6679 |
SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); |
| 6680 |
|
| 6681 |
/* |
| 6682 |
** CAPI3REF: Testing Interface |
| 6683 |
** |
| 6684 |
** ^The sqlite3_test_control() interface is used to read out internal |
| 6685 |
** state of SQLite and to inject faults into SQLite for testing |
| 6686 |
** purposes. ^The first parameter is an operation code that determines |
| 6687 |
** the number, meaning, and operation of all subsequent parameters. |
| 6688 |
** |
| 6689 |
** This interface is not for use by applications. It exists solely |
| 6690 |
** for verifying the correct operation of the SQLite library. Depending |
| 6691 |
** on how the SQLite library is compiled, this interface might not exist. |
| 6692 |
** |
| 6693 |
** The details of the operation codes, their meanings, the parameters |
| 6694 |
** they take, and what they do are all subject to change without notice. |
| 6695 |
** Unlike most of the SQLite API, this function is not guaranteed to |
| 6696 |
** operate consistently from one release to the next. |
| 6697 |
*/ |
| 6698 |
SQLITE_API int sqlite3_test_control(int op, ...); |
| 6699 |
|
| 6700 |
/* |
| 6701 |
** CAPI3REF: Testing Interface Operation Codes |
| 6702 |
** |
| 6703 |
** These constants are the valid operation code parameters used |
| 6704 |
** as the first argument to [sqlite3_test_control()]. |
| 6705 |
** |
| 6706 |
** These parameters and their meanings are subject to change |
| 6707 |
** without notice. These values are for testing purposes only. |
| 6708 |
** Applications should not use any of these parameters or the |
| 6709 |
** [sqlite3_test_control()] interface. |
| 6710 |
*/ |
| 6711 |
#define SQLITE_TESTCTRL_FIRST 5 |
| 6712 |
#define SQLITE_TESTCTRL_PRNG_SAVE 5 |
| 6713 |
#define SQLITE_TESTCTRL_PRNG_RESTORE 6 |
| 6714 |
#define SQLITE_TESTCTRL_PRNG_RESET 7 |
| 6715 |
#define SQLITE_TESTCTRL_BITVEC_TEST 8 |
| 6716 |
#define SQLITE_TESTCTRL_FAULT_INSTALL 9 |
| 6717 |
#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 |
| 6718 |
#define SQLITE_TESTCTRL_PENDING_BYTE 11 |
| 6719 |
#define SQLITE_TESTCTRL_ASSERT 12 |
| 6720 |
#define SQLITE_TESTCTRL_ALWAYS 13 |
| 6721 |
#define SQLITE_TESTCTRL_RESERVE 14 |
| 6722 |
#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 |
| 6723 |
#define SQLITE_TESTCTRL_ISKEYWORD 16 |
| 6724 |
#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 |
| 6725 |
#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 |
| 6726 |
#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */ |
| 6727 |
#define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19 |
| 6728 |
#define SQLITE_TESTCTRL_NEVER_CORRUPT 20 |
| 6729 |
#define SQLITE_TESTCTRL_VDBE_COVERAGE 21 |
| 6730 |
#define SQLITE_TESTCTRL_BYTEORDER 22 |
| 6731 |
#define SQLITE_TESTCTRL_ISINIT 23 |
| 6732 |
#define SQLITE_TESTCTRL_SORTER_MMAP 24 |
| 6733 |
#define SQLITE_TESTCTRL_IMPOSTER 25 |
| 6734 |
#define SQLITE_TESTCTRL_LAST 25 |
| 6735 |
|
| 6736 |
/* |
| 6737 |
** CAPI3REF: SQLite Runtime Status |
| 6738 |
** |
| 6739 |
** ^These interfaces are used to retrieve runtime status information |
| 6740 |
** about the performance of SQLite, and optionally to reset various |
| 6741 |
** highwater marks. ^The first argument is an integer code for |
| 6742 |
** the specific parameter to measure. ^(Recognized integer codes |
| 6743 |
** are of the form [status parameters | SQLITE_STATUS_...].)^ |
| 6744 |
** ^The current value of the parameter is returned into *pCurrent. |
| 6745 |
** ^The highest recorded value is returned in *pHighwater. ^If the |
| 6746 |
** resetFlag is true, then the highest record value is reset after |
| 6747 |
** *pHighwater is written. ^(Some parameters do not record the highest |
| 6748 |
** value. For those parameters |
| 6749 |
** nothing is written into *pHighwater and the resetFlag is ignored.)^ |
| 6750 |
** ^(Other parameters record only the highwater mark and not the current |
| 6751 |
** value. For these latter parameters nothing is written into *pCurrent.)^ |
| 6752 |
** |
| 6753 |
** ^The sqlite3_status() and sqlite3_status64() routines return |
| 6754 |
** SQLITE_OK on success and a non-zero [error code] on failure. |
| 6755 |
** |
| 6756 |
** If either the current value or the highwater mark is too large to |
| 6757 |
** be represented by a 32-bit integer, then the values returned by |
| 6758 |
** sqlite3_status() are undefined. |
| 6759 |
** |
| 6760 |
** See also: [sqlite3_db_status()] |
| 6761 |
*/ |
| 6762 |
SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); |
| 6763 |
SQLITE_API int sqlite3_status64( |
| 6764 |
int op, |
| 6765 |
sqlite3_int64 *pCurrent, |
| 6766 |
sqlite3_int64 *pHighwater, |
| 6767 |
int resetFlag |
| 6768 |
); |
| 6769 |
|
| 6770 |
|
| 6771 |
/* |
| 6772 |
** CAPI3REF: Status Parameters |
| 6773 |
** KEYWORDS: {status parameters} |
| 6774 |
** |
| 6775 |
** These integer constants designate various run-time status parameters |
| 6776 |
** that can be returned by [sqlite3_status()]. |
| 6777 |
** |
| 6778 |
** <dl> |
| 6779 |
** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> |
| 6780 |
** <dd>This parameter is the current amount of memory checked out |
| 6781 |
** using [sqlite3_malloc()], either directly or indirectly. The |
| 6782 |
** figure includes calls made to [sqlite3_malloc()] by the application |
| 6783 |
** and internal memory usage by the SQLite library. Scratch memory |
| 6784 |
** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache |
| 6785 |
** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in |
| 6786 |
** this parameter. The amount returned is the sum of the allocation |
| 6787 |
** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ |
| 6788 |
** |
| 6789 |
** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> |
| 6790 |
** <dd>This parameter records the largest memory allocation request |
| 6791 |
** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their |
| 6792 |
** internal equivalents). Only the value returned in the |
| 6793 |
** *pHighwater parameter to [sqlite3_status()] is of interest. |
| 6794 |
** The value written into the *pCurrent parameter is undefined.</dd>)^ |
| 6795 |
** |
| 6796 |
** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> |
| 6797 |
** <dd>This parameter records the number of separate memory allocations |
| 6798 |
** currently checked out.</dd>)^ |
| 6799 |
** |
| 6800 |
** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> |
| 6801 |
** <dd>This parameter returns the number of pages used out of the |
| 6802 |
** [pagecache memory allocator] that was configured using |
| 6803 |
** [SQLITE_CONFIG_PAGECACHE]. The |
| 6804 |
** value returned is in pages, not in bytes.</dd>)^ |
| 6805 |
** |
| 6806 |
** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] |
| 6807 |
** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> |
| 6808 |
** <dd>This parameter returns the number of bytes of page cache |
| 6809 |
** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] |
| 6810 |
** buffer and where forced to overflow to [sqlite3_malloc()]. The |
| 6811 |
** returned value includes allocations that overflowed because they |
| 6812 |
** where too large (they were larger than the "sz" parameter to |
| 6813 |
** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because |
| 6814 |
** no space was left in the page cache.</dd>)^ |
| 6815 |
** |
| 6816 |
** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> |
| 6817 |
** <dd>This parameter records the largest memory allocation request |
| 6818 |
** handed to [pagecache memory allocator]. Only the value returned in the |
| 6819 |
** *pHighwater parameter to [sqlite3_status()] is of interest. |
| 6820 |
** The value written into the *pCurrent parameter is undefined.</dd>)^ |
| 6821 |
** |
| 6822 |
** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> |
| 6823 |
** <dd>This parameter returns the number of allocations used out of the |
| 6824 |
** [scratch memory allocator] configured using |
| 6825 |
** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not |
| 6826 |
** in bytes. Since a single thread may only have one scratch allocation |
| 6827 |
** outstanding at time, this parameter also reports the number of threads |
| 6828 |
** using scratch memory at the same time.</dd>)^ |
| 6829 |
** |
| 6830 |
** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> |
| 6831 |
** <dd>This parameter returns the number of bytes of scratch memory |
| 6832 |
** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] |
| 6833 |
** buffer and where forced to overflow to [sqlite3_malloc()]. The values |
| 6834 |
** returned include overflows because the requested allocation was too |
| 6835 |
** larger (that is, because the requested allocation was larger than the |
| 6836 |
** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer |
| 6837 |
** slots were available. |
| 6838 |
** </dd>)^ |
| 6839 |
** |
| 6840 |
** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> |
| 6841 |
** <dd>This parameter records the largest memory allocation request |
| 6842 |
** handed to [scratch memory allocator]. Only the value returned in the |
| 6843 |
** *pHighwater parameter to [sqlite3_status()] is of interest. |
| 6844 |
** The value written into the *pCurrent parameter is undefined.</dd>)^ |
| 6845 |
** |
| 6846 |
** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> |
| 6847 |
** <dd>The *pHighwater parameter records the deepest parser stack. |
| 6848 |
** The *pCurrent value is undefined. The *pHighwater value is only |
| 6849 |
** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ |
| 6850 |
** </dl> |
| 6851 |
** |
| 6852 |
** New status parameters may be added from time to time. |
| 6853 |
*/ |
| 6854 |
#define SQLITE_STATUS_MEMORY_USED 0 |
| 6855 |
#define SQLITE_STATUS_PAGECACHE_USED 1 |
| 6856 |
#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 |
| 6857 |
#define SQLITE_STATUS_SCRATCH_USED 3 |
| 6858 |
#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 |
| 6859 |
#define SQLITE_STATUS_MALLOC_SIZE 5 |
| 6860 |
#define SQLITE_STATUS_PARSER_STACK 6 |
| 6861 |
#define SQLITE_STATUS_PAGECACHE_SIZE 7 |
| 6862 |
#define SQLITE_STATUS_SCRATCH_SIZE 8 |
| 6863 |
#define SQLITE_STATUS_MALLOC_COUNT 9 |
| 6864 |
|
| 6865 |
/* |
| 6866 |
** CAPI3REF: Database Connection Status |
| 6867 |
** METHOD: sqlite3 |
| 6868 |
** |
| 6869 |
** ^This interface is used to retrieve runtime status information |
| 6870 |
** about a single [database connection]. ^The first argument is the |
| 6871 |
** database connection object to be interrogated. ^The second argument |
| 6872 |
** is an integer constant, taken from the set of |
| 6873 |
** [SQLITE_DBSTATUS options], that |
| 6874 |
** determines the parameter to interrogate. The set of |
| 6875 |
** [SQLITE_DBSTATUS options] is likely |
| 6876 |
** to grow in future releases of SQLite. |
| 6877 |
** |
| 6878 |
** ^The current value of the requested parameter is written into *pCur |
| 6879 |
** and the highest instantaneous value is written into *pHiwtr. ^If |
| 6880 |
** the resetFlg is true, then the highest instantaneous value is |
| 6881 |
** reset back down to the current value. |
| 6882 |
** |
| 6883 |
** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a |
| 6884 |
** non-zero [error code] on failure. |
| 6885 |
** |
| 6886 |
** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. |
| 6887 |
*/ |
| 6888 |
SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); |
| 6889 |
|
| 6890 |
/* |
| 6891 |
** CAPI3REF: Status Parameters for database connections |
| 6892 |
** KEYWORDS: {SQLITE_DBSTATUS options} |
| 6893 |
** |
| 6894 |
** These constants are the available integer "verbs" that can be passed as |
| 6895 |
** the second argument to the [sqlite3_db_status()] interface. |
| 6896 |
** |
| 6897 |
** New verbs may be added in future releases of SQLite. Existing verbs |
| 6898 |
** might be discontinued. Applications should check the return code from |
| 6899 |
** [sqlite3_db_status()] to make sure that the call worked. |
| 6900 |
** The [sqlite3_db_status()] interface will return a non-zero error code |
| 6901 |
** if a discontinued or unsupported verb is invoked. |
| 6902 |
** |
| 6903 |
** <dl> |
| 6904 |
** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> |
| 6905 |
** <dd>This parameter returns the number of lookaside memory slots currently |
| 6906 |
** checked out.</dd>)^ |
| 6907 |
** |
| 6908 |
** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> |
| 6909 |
** <dd>This parameter returns the number malloc attempts that were |
| 6910 |
** satisfied using lookaside memory. Only the high-water value is meaningful; |
| 6911 |
** the current value is always zero.)^ |
| 6912 |
** |
| 6913 |
** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] |
| 6914 |
** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> |
| 6915 |
** <dd>This parameter returns the number malloc attempts that might have |
| 6916 |
** been satisfied using lookaside memory but failed due to the amount of |
| 6917 |
** memory requested being larger than the lookaside slot size. |
| 6918 |
** Only the high-water value is meaningful; |
| 6919 |
** the current value is always zero.)^ |
| 6920 |
** |
| 6921 |
** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] |
| 6922 |
** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> |
| 6923 |
** <dd>This parameter returns the number malloc attempts that might have |
| 6924 |
** been satisfied using lookaside memory but failed due to all lookaside |
| 6925 |
** memory already being in use. |
| 6926 |
** Only the high-water value is meaningful; |
| 6927 |
** the current value is always zero.)^ |
| 6928 |
** |
| 6929 |
** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> |
| 6930 |
** <dd>This parameter returns the approximate number of bytes of heap |
| 6931 |
** memory used by all pager caches associated with the database connection.)^ |
| 6932 |
** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. |
| 6933 |
** |
| 6934 |
** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]] |
| 6935 |
** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt> |
| 6936 |
** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a |
| 6937 |
** pager cache is shared between two or more connections the bytes of heap |
| 6938 |
** memory used by that pager cache is divided evenly between the attached |
| 6939 |
** connections.)^ In other words, if none of the pager caches associated |
| 6940 |
** with the database connection are shared, this request returns the same |
| 6941 |
** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are |
| 6942 |
** shared, the value returned by this call will be smaller than that returned |
| 6943 |
** by DBSTATUS_CACHE_USED. ^The highwater mark associated with |
| 6944 |
** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. |
| 6945 |
** |
| 6946 |
** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> |
| 6947 |
** <dd>This parameter returns the approximate number of bytes of heap |
| 6948 |
** memory used to store the schema for all databases associated |
| 6949 |
** with the connection - main, temp, and any [ATTACH]-ed databases.)^ |
| 6950 |
** ^The full amount of memory used by the schemas is reported, even if the |
| 6951 |
** schema memory is shared with other database connections due to |
| 6952 |
** [shared cache mode] being enabled. |
| 6953 |
** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. |
| 6954 |
** |
| 6955 |
** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> |
| 6956 |
** <dd>This parameter returns the approximate number of bytes of heap |
| 6957 |
** and lookaside memory used by all prepared statements associated with |
| 6958 |
** the database connection.)^ |
| 6959 |
** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. |
| 6960 |
** </dd> |
| 6961 |
** |
| 6962 |
** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> |
| 6963 |
** <dd>This parameter returns the number of pager cache hits that have |
| 6964 |
** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT |
| 6965 |
** is always 0. |
| 6966 |
** </dd> |
| 6967 |
** |
| 6968 |
** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> |
| 6969 |
** <dd>This parameter returns the number of pager cache misses that have |
| 6970 |
** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS |
| 6971 |
** is always 0. |
| 6972 |
** </dd> |
| 6973 |
** |
| 6974 |
** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt> |
| 6975 |
** <dd>This parameter returns the number of dirty cache entries that have |
| 6976 |
** been written to disk. Specifically, the number of pages written to the |
| 6977 |
** wal file in wal mode databases, or the number of pages written to the |
| 6978 |
** database file in rollback mode databases. Any pages written as part of |
| 6979 |
** transaction rollback or database recovery operations are not included. |
| 6980 |
** If an IO or other error occurs while writing a page to disk, the effect |
| 6981 |
** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The |
| 6982 |
** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. |
| 6983 |
** </dd> |
| 6984 |
** |
| 6985 |
** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt> |
| 6986 |
** <dd>This parameter returns zero for the current value if and only if |
| 6987 |
** all foreign key constraints (deferred or immediate) have been |
| 6988 |
** resolved.)^ ^The highwater mark is always 0. |
| 6989 |
** </dd> |
| 6990 |
** </dl> |
| 6991 |
*/ |
| 6992 |
#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 |
| 6993 |
#define SQLITE_DBSTATUS_CACHE_USED 1 |
| 6994 |
#define SQLITE_DBSTATUS_SCHEMA_USED 2 |
| 6995 |
#define SQLITE_DBSTATUS_STMT_USED 3 |
| 6996 |
#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 |
| 6997 |
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 |
| 6998 |
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 |
| 6999 |
#define SQLITE_DBSTATUS_CACHE_HIT 7 |
| 7000 |
#define SQLITE_DBSTATUS_CACHE_MISS 8 |
| 7001 |
#define SQLITE_DBSTATUS_CACHE_WRITE 9 |
| 7002 |
#define SQLITE_DBSTATUS_DEFERRED_FKS 10 |
| 7003 |
#define SQLITE_DBSTATUS_CACHE_USED_SHARED 11 |
| 7004 |
#define SQLITE_DBSTATUS_MAX 11 /* Largest defined DBSTATUS */ |
| 7005 |
|
| 7006 |
|
| 7007 |
/* |
| 7008 |
** CAPI3REF: Prepared Statement Status |
| 7009 |
** METHOD: sqlite3_stmt |
| 7010 |
** |
| 7011 |
** ^(Each prepared statement maintains various |
| 7012 |
** [SQLITE_STMTSTATUS counters] that measure the number |
| 7013 |
** of times it has performed specific operations.)^ These counters can |
| 7014 |
** be used to monitor the performance characteristics of the prepared |
| 7015 |
** statements. For example, if the number of table steps greatly exceeds |
| 7016 |
** the number of table searches or result rows, that would tend to indicate |
| 7017 |
** that the prepared statement is using a full table scan rather than |
| 7018 |
** an index. |
| 7019 |
** |
| 7020 |
** ^(This interface is used to retrieve and reset counter values from |
| 7021 |
** a [prepared statement]. The first argument is the prepared statement |
| 7022 |
** object to be interrogated. The second argument |
| 7023 |
** is an integer code for a specific [SQLITE_STMTSTATUS counter] |
| 7024 |
** to be interrogated.)^ |
| 7025 |
** ^The current value of the requested counter is returned. |
| 7026 |
** ^If the resetFlg is true, then the counter is reset to zero after this |
| 7027 |
** interface call returns. |
| 7028 |
** |
| 7029 |
** See also: [sqlite3_status()] and [sqlite3_db_status()]. |
| 7030 |
*/ |
| 7031 |
SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); |
| 7032 |
|
| 7033 |
/* |
| 7034 |
** CAPI3REF: Status Parameters for prepared statements |
| 7035 |
** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} |
| 7036 |
** |
| 7037 |
** These preprocessor macros define integer codes that name counter |
| 7038 |
** values associated with the [sqlite3_stmt_status()] interface. |
| 7039 |
** The meanings of the various counters are as follows: |
| 7040 |
** |
| 7041 |
** <dl> |
| 7042 |
** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> |
| 7043 |
** <dd>^This is the number of times that SQLite has stepped forward in |
| 7044 |
** a table as part of a full table scan. Large numbers for this counter |
| 7045 |
** may indicate opportunities for performance improvement through |
| 7046 |
** careful use of indices.</dd> |
| 7047 |
** |
| 7048 |
** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> |
| 7049 |
** <dd>^This is the number of sort operations that have occurred. |
| 7050 |
** A non-zero value in this counter may indicate an opportunity to |
| 7051 |
** improvement performance through careful use of indices.</dd> |
| 7052 |
** |
| 7053 |
** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> |
| 7054 |
** <dd>^This is the number of rows inserted into transient indices that |
| 7055 |
** were created automatically in order to help joins run faster. |
| 7056 |
** A non-zero value in this counter may indicate an opportunity to |
| 7057 |
** improvement performance by adding permanent indices that do not |
| 7058 |
** need to be reinitialized each time the statement is run.</dd> |
| 7059 |
** |
| 7060 |
** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt> |
| 7061 |
** <dd>^This is the number of virtual machine operations executed |
| 7062 |
** by the prepared statement if that number is less than or equal |
| 7063 |
** to 2147483647. The number of virtual machine operations can be |
| 7064 |
** used as a proxy for the total work done by the prepared statement. |
| 7065 |
** If the number of virtual machine operations exceeds 2147483647 |
| 7066 |
** then the value returned by this statement status code is undefined. |
| 7067 |
** </dd> |
| 7068 |
** </dl> |
| 7069 |
*/ |
| 7070 |
#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 |
| 7071 |
#define SQLITE_STMTSTATUS_SORT 2 |
| 7072 |
#define SQLITE_STMTSTATUS_AUTOINDEX 3 |
| 7073 |
#define SQLITE_STMTSTATUS_VM_STEP 4 |
| 7074 |
|
| 7075 |
/* |
| 7076 |
** CAPI3REF: Custom Page Cache Object |
| 7077 |
** |
| 7078 |
** The sqlite3_pcache type is opaque. It is implemented by |
| 7079 |
** the pluggable module. The SQLite core has no knowledge of |
| 7080 |
** its size or internal structure and never deals with the |
| 7081 |
** sqlite3_pcache object except by holding and passing pointers |
| 7082 |
** to the object. |
| 7083 |
** |
| 7084 |
** See [sqlite3_pcache_methods2] for additional information. |
| 7085 |
*/ |
| 7086 |
typedef struct sqlite3_pcache sqlite3_pcache; |
| 7087 |
|
| 7088 |
/* |
| 7089 |
** CAPI3REF: Custom Page Cache Object |
| 7090 |
** |
| 7091 |
** The sqlite3_pcache_page object represents a single page in the |
| 7092 |
** page cache. The page cache will allocate instances of this |
| 7093 |
** object. Various methods of the page cache use pointers to instances |
| 7094 |
** of this object as parameters or as their return value. |
| 7095 |
** |
| 7096 |
** See [sqlite3_pcache_methods2] for additional information. |
| 7097 |
*/ |
| 7098 |
typedef struct sqlite3_pcache_page sqlite3_pcache_page; |
| 7099 |
struct sqlite3_pcache_page { |
| 7100 |
void *pBuf; /* The content of the page */ |
| 7101 |
void *pExtra; /* Extra information associated with the page */ |
| 7102 |
}; |
| 7103 |
|
| 7104 |
/* |
| 7105 |
** CAPI3REF: Application Defined Page Cache. |
| 7106 |
** KEYWORDS: {page cache} |
| 7107 |
** |
| 7108 |
** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can |
| 7109 |
** register an alternative page cache implementation by passing in an |
| 7110 |
** instance of the sqlite3_pcache_methods2 structure.)^ |
| 7111 |
** In many applications, most of the heap memory allocated by |
| 7112 |
** SQLite is used for the page cache. |
| 7113 |
** By implementing a |
| 7114 |
** custom page cache using this API, an application can better control |
| 7115 |
** the amount of memory consumed by SQLite, the way in which |
| 7116 |
** that memory is allocated and released, and the policies used to |
| 7117 |
** determine exactly which parts of a database file are cached and for |
| 7118 |
** how long. |
| 7119 |
** |
| 7120 |
** The alternative page cache mechanism is an |
| 7121 |
** extreme measure that is only needed by the most demanding applications. |
| 7122 |
** The built-in page cache is recommended for most uses. |
| 7123 |
** |
| 7124 |
** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an |
| 7125 |
** internal buffer by SQLite within the call to [sqlite3_config]. Hence |
| 7126 |
** the application may discard the parameter after the call to |
| 7127 |
** [sqlite3_config()] returns.)^ |
| 7128 |
** |
| 7129 |
** [[the xInit() page cache method]] |
| 7130 |
** ^(The xInit() method is called once for each effective |
| 7131 |
** call to [sqlite3_initialize()])^ |
| 7132 |
** (usually only once during the lifetime of the process). ^(The xInit() |
| 7133 |
** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ |
| 7134 |
** The intent of the xInit() method is to set up global data structures |
| 7135 |
** required by the custom page cache implementation. |
| 7136 |
** ^(If the xInit() method is NULL, then the |
| 7137 |
** built-in default page cache is used instead of the application defined |
| 7138 |
** page cache.)^ |
| 7139 |
** |
| 7140 |
** [[the xShutdown() page cache method]] |
| 7141 |
** ^The xShutdown() method is called by [sqlite3_shutdown()]. |
| 7142 |
** It can be used to clean up |
| 7143 |
** any outstanding resources before process shutdown, if required. |
| 7144 |
** ^The xShutdown() method may be NULL. |
| 7145 |
** |
| 7146 |
** ^SQLite automatically serializes calls to the xInit method, |
| 7147 |
** so the xInit method need not be threadsafe. ^The |
| 7148 |
** xShutdown method is only called from [sqlite3_shutdown()] so it does |
| 7149 |
** not need to be threadsafe either. All other methods must be threadsafe |
| 7150 |
** in multithreaded applications. |
| 7151 |
** |
| 7152 |
** ^SQLite will never invoke xInit() more than once without an intervening |
| 7153 |
** call to xShutdown(). |
| 7154 |
** |
| 7155 |
** [[the xCreate() page cache methods]] |
| 7156 |
** ^SQLite invokes the xCreate() method to construct a new cache instance. |
| 7157 |
** SQLite will typically create one cache instance for each open database file, |
| 7158 |
** though this is not guaranteed. ^The |
| 7159 |
** first parameter, szPage, is the size in bytes of the pages that must |
| 7160 |
** be allocated by the cache. ^szPage will always a power of two. ^The |
| 7161 |
** second parameter szExtra is a number of bytes of extra storage |
| 7162 |
** associated with each page cache entry. ^The szExtra parameter will |
| 7163 |
** a number less than 250. SQLite will use the |
| 7164 |
** extra szExtra bytes on each page to store metadata about the underlying |
| 7165 |
** database page on disk. The value passed into szExtra depends |
| 7166 |
** on the SQLite version, the target platform, and how SQLite was compiled. |
| 7167 |
** ^The third argument to xCreate(), bPurgeable, is true if the cache being |
| 7168 |
** created will be used to cache database pages of a file stored on disk, or |
| 7169 |
** false if it is used for an in-memory database. The cache implementation |
| 7170 |
** does not have to do anything special based with the value of bPurgeable; |
| 7171 |
** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will |
| 7172 |
** never invoke xUnpin() except to deliberately delete a page. |
| 7173 |
** ^In other words, calls to xUnpin() on a cache with bPurgeable set to |
| 7174 |
** false will always have the "discard" flag set to true. |
| 7175 |
** ^Hence, a cache created with bPurgeable false will |
| 7176 |
** never contain any unpinned pages. |
| 7177 |
** |
| 7178 |
** [[the xCachesize() page cache method]] |
| 7179 |
** ^(The xCachesize() method may be called at any time by SQLite to set the |
| 7180 |
** suggested maximum cache-size (number of pages stored by) the cache |
| 7181 |
** instance passed as the first argument. This is the value configured using |
| 7182 |
** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable |
| 7183 |
** parameter, the implementation is not required to do anything with this |
| 7184 |
** value; it is advisory only. |
| 7185 |
** |
| 7186 |
** [[the xPagecount() page cache methods]] |
| 7187 |
** The xPagecount() method must return the number of pages currently |
| 7188 |
** stored in the cache, both pinned and unpinned. |
| 7189 |
** |
| 7190 |
** [[the xFetch() page cache methods]] |
| 7191 |
** The xFetch() method locates a page in the cache and returns a pointer to |
| 7192 |
** an sqlite3_pcache_page object associated with that page, or a NULL pointer. |
| 7193 |
** The pBuf element of the returned sqlite3_pcache_page object will be a |
| 7194 |
** pointer to a buffer of szPage bytes used to store the content of a |
| 7195 |
** single database page. The pExtra element of sqlite3_pcache_page will be |
| 7196 |
** a pointer to the szExtra bytes of extra storage that SQLite has requested |
| 7197 |
** for each entry in the page cache. |
| 7198 |
** |
| 7199 |
** The page to be fetched is determined by the key. ^The minimum key value |
| 7200 |
** is 1. After it has been retrieved using xFetch, the page is considered |
| 7201 |
** to be "pinned". |
| 7202 |
** |
| 7203 |
** If the requested page is already in the page cache, then the page cache |
| 7204 |
** implementation must return a pointer to the page buffer with its content |
| 7205 |
** intact. If the requested page is not already in the cache, then the |
| 7206 |
** cache implementation should use the value of the createFlag |
| 7207 |
** parameter to help it determined what action to take: |
| 7208 |
** |
| 7209 |
** <table border=1 width=85% align=center> |
| 7210 |
** <tr><th> createFlag <th> Behavior when page is not already in cache |
| 7211 |
** <tr><td> 0 <td> Do not allocate a new page. Return NULL. |
| 7212 |
** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. |
| 7213 |
** Otherwise return NULL. |
| 7214 |
** <tr><td> 2 <td> Make every effort to allocate a new page. Only return |
| 7215 |
** NULL if allocating a new page is effectively impossible. |
| 7216 |
** </table> |
| 7217 |
** |
| 7218 |
** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite |
| 7219 |
** will only use a createFlag of 2 after a prior call with a createFlag of 1 |
| 7220 |
** failed.)^ In between the to xFetch() calls, SQLite may |
| 7221 |
** attempt to unpin one or more cache pages by spilling the content of |
| 7222 |
** pinned pages to disk and synching the operating system disk cache. |
| 7223 |
** |
| 7224 |
** [[the xUnpin() page cache method]] |
| 7225 |
** ^xUnpin() is called by SQLite with a pointer to a currently pinned page |
| 7226 |
** as its second argument. If the third parameter, discard, is non-zero, |
| 7227 |
** then the page must be evicted from the cache. |
| 7228 |
** ^If the discard parameter is |
| 7229 |
** zero, then the page may be discarded or retained at the discretion of |
| 7230 |
** page cache implementation. ^The page cache implementation |
| 7231 |
** may choose to evict unpinned pages at any time. |
| 7232 |
** |
| 7233 |
** The cache must not perform any reference counting. A single |
| 7234 |
** call to xUnpin() unpins the page regardless of the number of prior calls |
| 7235 |
** to xFetch(). |
| 7236 |
** |
| 7237 |
** [[the xRekey() page cache methods]] |
| 7238 |
** The xRekey() method is used to change the key value associated with the |
| 7239 |
** page passed as the second argument. If the cache |
| 7240 |
** previously contains an entry associated with newKey, it must be |
| 7241 |
** discarded. ^Any prior cache entry associated with newKey is guaranteed not |
| 7242 |
** to be pinned. |
| 7243 |
** |
| 7244 |
** When SQLite calls the xTruncate() method, the cache must discard all |
| 7245 |
** existing cache entries with page numbers (keys) greater than or equal |
| 7246 |
** to the value of the iLimit parameter passed to xTruncate(). If any |
| 7247 |
** of these pages are pinned, they are implicitly unpinned, meaning that |
| 7248 |
** they can be safely discarded. |
| 7249 |
** |
| 7250 |
** [[the xDestroy() page cache method]] |
| 7251 |
** ^The xDestroy() method is used to delete a cache allocated by xCreate(). |
| 7252 |
** All resources associated with the specified cache should be freed. ^After |
| 7253 |
** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] |
| 7254 |
** handle invalid, and will not use it with any other sqlite3_pcache_methods2 |
| 7255 |
** functions. |
| 7256 |
** |
| 7257 |
** [[the xShrink() page cache method]] |
| 7258 |
** ^SQLite invokes the xShrink() method when it wants the page cache to |
| 7259 |
** free up as much of heap memory as possible. The page cache implementation |
| 7260 |
** is not obligated to free any memory, but well-behaved implementations should |
| 7261 |
** do their best. |
| 7262 |
*/ |
| 7263 |
typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2; |
| 7264 |
struct sqlite3_pcache_methods2 { |
| 7265 |
int iVersion; |
| 7266 |
void *pArg; |
| 7267 |
int (*xInit)(void*); |
| 7268 |
void (*xShutdown)(void*); |
| 7269 |
sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); |
| 7270 |
void (*xCachesize)(sqlite3_pcache*, int nCachesize); |
| 7271 |
int (*xPagecount)(sqlite3_pcache*); |
| 7272 |
sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); |
| 7273 |
void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); |
| 7274 |
void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, |
| 7275 |
unsigned oldKey, unsigned newKey); |
| 7276 |
void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); |
| 7277 |
void (*xDestroy)(sqlite3_pcache*); |
| 7278 |
void (*xShrink)(sqlite3_pcache*); |
| 7279 |
}; |
| 7280 |
|
| 7281 |
/* |
| 7282 |
** This is the obsolete pcache_methods object that has now been replaced |
| 7283 |
** by sqlite3_pcache_methods2. This object is not used by SQLite. It is |
| 7284 |
** retained in the header file for backwards compatibility only. |
| 7285 |
*/ |
| 7286 |
typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; |
| 7287 |
struct sqlite3_pcache_methods { |
| 7288 |
void *pArg; |
| 7289 |
int (*xInit)(void*); |
| 7290 |
void (*xShutdown)(void*); |
| 7291 |
sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); |
| 7292 |
void (*xCachesize)(sqlite3_pcache*, int nCachesize); |
| 7293 |
int (*xPagecount)(sqlite3_pcache*); |
| 7294 |
void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); |
| 7295 |
void (*xUnpin)(sqlite3_pcache*, void*, int discard); |
| 7296 |
void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); |
| 7297 |
void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); |
| 7298 |
void (*xDestroy)(sqlite3_pcache*); |
| 7299 |
}; |
| 7300 |
|
| 7301 |
|
| 7302 |
/* |
| 7303 |
** CAPI3REF: Online Backup Object |
| 7304 |
** |
| 7305 |
** The sqlite3_backup object records state information about an ongoing |
| 7306 |
** online backup operation. ^The sqlite3_backup object is created by |
| 7307 |
** a call to [sqlite3_backup_init()] and is destroyed by a call to |
| 7308 |
** [sqlite3_backup_finish()]. |
| 7309 |
** |
| 7310 |
** See Also: [Using the SQLite Online Backup API] |
| 7311 |
*/ |
| 7312 |
typedef struct sqlite3_backup sqlite3_backup; |
| 7313 |
|
| 7314 |
/* |
| 7315 |
** CAPI3REF: Online Backup API. |
| 7316 |
** |
| 7317 |
** The backup API copies the content of one database into another. |
| 7318 |
** It is useful either for creating backups of databases or |
| 7319 |
** for copying in-memory databases to or from persistent files. |
| 7320 |
** |
| 7321 |
** See Also: [Using the SQLite Online Backup API] |
| 7322 |
** |
| 7323 |
** ^SQLite holds a write transaction open on the destination database file |
| 7324 |
** for the duration of the backup operation. |
| 7325 |
** ^The source database is read-locked only while it is being read; |
| 7326 |
** it is not locked continuously for the entire backup operation. |
| 7327 |
** ^Thus, the backup may be performed on a live source database without |
| 7328 |
** preventing other database connections from |
| 7329 |
** reading or writing to the source database while the backup is underway. |
| 7330 |
** |
| 7331 |
** ^(To perform a backup operation: |
| 7332 |
** <ol> |
| 7333 |
** <li><b>sqlite3_backup_init()</b> is called once to initialize the |
| 7334 |
** backup, |
| 7335 |
** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer |
| 7336 |
** the data between the two databases, and finally |
| 7337 |
** <li><b>sqlite3_backup_finish()</b> is called to release all resources |
| 7338 |
** associated with the backup operation. |
| 7339 |
** </ol>)^ |
| 7340 |
** There should be exactly one call to sqlite3_backup_finish() for each |
| 7341 |
** successful call to sqlite3_backup_init(). |
| 7342 |
** |
| 7343 |
** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> |
| 7344 |
** |
| 7345 |
** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the |
| 7346 |
** [database connection] associated with the destination database |
| 7347 |
** and the database name, respectively. |
| 7348 |
** ^The database name is "main" for the main database, "temp" for the |
| 7349 |
** temporary database, or the name specified after the AS keyword in |
| 7350 |
** an [ATTACH] statement for an attached database. |
| 7351 |
** ^The S and M arguments passed to |
| 7352 |
** sqlite3_backup_init(D,N,S,M) identify the [database connection] |
| 7353 |
** and database name of the source database, respectively. |
| 7354 |
** ^The source and destination [database connections] (parameters S and D) |
| 7355 |
** must be different or else sqlite3_backup_init(D,N,S,M) will fail with |
| 7356 |
** an error. |
| 7357 |
** |
| 7358 |
** ^A call to sqlite3_backup_init() will fail, returning NULL, if |
| 7359 |
** there is already a read or read-write transaction open on the |
| 7360 |
** destination database. |
| 7361 |
** |
| 7362 |
** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is |
| 7363 |
** returned and an error code and error message are stored in the |
| 7364 |
** destination [database connection] D. |
| 7365 |
** ^The error code and message for the failed call to sqlite3_backup_init() |
| 7366 |
** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or |
| 7367 |
** [sqlite3_errmsg16()] functions. |
| 7368 |
** ^A successful call to sqlite3_backup_init() returns a pointer to an |
| 7369 |
** [sqlite3_backup] object. |
| 7370 |
** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and |
| 7371 |
** sqlite3_backup_finish() functions to perform the specified backup |
| 7372 |
** operation. |
| 7373 |
** |
| 7374 |
** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> |
| 7375 |
** |
| 7376 |
** ^Function sqlite3_backup_step(B,N) will copy up to N pages between |
| 7377 |
** the source and destination databases specified by [sqlite3_backup] object B. |
| 7378 |
** ^If N is negative, all remaining source pages are copied. |
| 7379 |
** ^If sqlite3_backup_step(B,N) successfully copies N pages and there |
| 7380 |
** are still more pages to be copied, then the function returns [SQLITE_OK]. |
| 7381 |
** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages |
| 7382 |
** from source to destination, then it returns [SQLITE_DONE]. |
| 7383 |
** ^If an error occurs while running sqlite3_backup_step(B,N), |
| 7384 |
** then an [error code] is returned. ^As well as [SQLITE_OK] and |
| 7385 |
** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], |
| 7386 |
** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an |
| 7387 |
** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. |
| 7388 |
** |
| 7389 |
** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if |
| 7390 |
** <ol> |
| 7391 |
** <li> the destination database was opened read-only, or |
| 7392 |
** <li> the destination database is using write-ahead-log journaling |
| 7393 |
** and the destination and source page sizes differ, or |
| 7394 |
** <li> the destination database is an in-memory database and the |
| 7395 |
** destination and source page sizes differ. |
| 7396 |
** </ol>)^ |
| 7397 |
** |
| 7398 |
** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then |
| 7399 |
** the [sqlite3_busy_handler | busy-handler function] |
| 7400 |
** is invoked (if one is specified). ^If the |
| 7401 |
** busy-handler returns non-zero before the lock is available, then |
| 7402 |
** [SQLITE_BUSY] is returned to the caller. ^In this case the call to |
| 7403 |
** sqlite3_backup_step() can be retried later. ^If the source |
| 7404 |
** [database connection] |
| 7405 |
** is being used to write to the source database when sqlite3_backup_step() |
| 7406 |
** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this |
| 7407 |
** case the call to sqlite3_backup_step() can be retried later on. ^(If |
| 7408 |
** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or |
| 7409 |
** [SQLITE_READONLY] is returned, then |
| 7410 |
** there is no point in retrying the call to sqlite3_backup_step(). These |
| 7411 |
** errors are considered fatal.)^ The application must accept |
| 7412 |
** that the backup operation has failed and pass the backup operation handle |
| 7413 |
** to the sqlite3_backup_finish() to release associated resources. |
| 7414 |
** |
| 7415 |
** ^The first call to sqlite3_backup_step() obtains an exclusive lock |
| 7416 |
** on the destination file. ^The exclusive lock is not released until either |
| 7417 |
** sqlite3_backup_finish() is called or the backup operation is complete |
| 7418 |
** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to |
| 7419 |
** sqlite3_backup_step() obtains a [shared lock] on the source database that |
| 7420 |
** lasts for the duration of the sqlite3_backup_step() call. |
| 7421 |
** ^Because the source database is not locked between calls to |
| 7422 |
** sqlite3_backup_step(), the source database may be modified mid-way |
| 7423 |
** through the backup process. ^If the source database is modified by an |
| 7424 |
** external process or via a database connection other than the one being |
| 7425 |
** used by the backup operation, then the backup will be automatically |
| 7426 |
** restarted by the next call to sqlite3_backup_step(). ^If the source |
| 7427 |
** database is modified by the using the same database connection as is used |
| 7428 |
** by the backup operation, then the backup database is automatically |
| 7429 |
** updated at the same time. |
| 7430 |
** |
| 7431 |
** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> |
| 7432 |
** |
| 7433 |
** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the |
| 7434 |
** application wishes to abandon the backup operation, the application |
| 7435 |
** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). |
| 7436 |
** ^The sqlite3_backup_finish() interfaces releases all |
| 7437 |
** resources associated with the [sqlite3_backup] object. |
| 7438 |
** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any |
| 7439 |
** active write-transaction on the destination database is rolled back. |
| 7440 |
** The [sqlite3_backup] object is invalid |
| 7441 |
** and may not be used following a call to sqlite3_backup_finish(). |
| 7442 |
** |
| 7443 |
** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no |
| 7444 |
** sqlite3_backup_step() errors occurred, regardless or whether or not |
| 7445 |
** sqlite3_backup_step() completed. |
| 7446 |
** ^If an out-of-memory condition or IO error occurred during any prior |
| 7447 |
** sqlite3_backup_step() call on the same [sqlite3_backup] object, then |
| 7448 |
** sqlite3_backup_finish() returns the corresponding [error code]. |
| 7449 |
** |
| 7450 |
** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() |
| 7451 |
** is not a permanent error and does not affect the return value of |
| 7452 |
** sqlite3_backup_finish(). |
| 7453 |
** |
| 7454 |
** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]] |
| 7455 |
** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> |
| 7456 |
** |
| 7457 |
** ^The sqlite3_backup_remaining() routine returns the number of pages still |
| 7458 |
** to be backed up at the conclusion of the most recent sqlite3_backup_step(). |
| 7459 |
** ^The sqlite3_backup_pagecount() routine returns the total number of pages |
| 7460 |
** in the source database at the conclusion of the most recent |
| 7461 |
** sqlite3_backup_step(). |
| 7462 |
** ^(The values returned by these functions are only updated by |
| 7463 |
** sqlite3_backup_step(). If the source database is modified in a way that |
| 7464 |
** changes the size of the source database or the number of pages remaining, |
| 7465 |
** those changes are not reflected in the output of sqlite3_backup_pagecount() |
| 7466 |
** and sqlite3_backup_remaining() until after the next |
| 7467 |
** sqlite3_backup_step().)^ |
| 7468 |
** |
| 7469 |
** <b>Concurrent Usage of Database Handles</b> |
| 7470 |
** |
| 7471 |
** ^The source [database connection] may be used by the application for other |
| 7472 |
** purposes while a backup operation is underway or being initialized. |
| 7473 |
** ^If SQLite is compiled and configured to support threadsafe database |
| 7474 |
** connections, then the source database connection may be used concurrently |
| 7475 |
** from within other threads. |
| 7476 |
** |
| 7477 |
** However, the application must guarantee that the destination |
| 7478 |
** [database connection] is not passed to any other API (by any thread) after |
| 7479 |
** sqlite3_backup_init() is called and before the corresponding call to |
| 7480 |
** sqlite3_backup_finish(). SQLite does not currently check to see |
| 7481 |
** if the application incorrectly accesses the destination [database connection] |
| 7482 |
** and so no error code is reported, but the operations may malfunction |
| 7483 |
** nevertheless. Use of the destination database connection while a |
| 7484 |
** backup is in progress might also also cause a mutex deadlock. |
| 7485 |
** |
| 7486 |
** If running in [shared cache mode], the application must |
| 7487 |
** guarantee that the shared cache used by the destination database |
| 7488 |
** is not accessed while the backup is running. In practice this means |
| 7489 |
** that the application must guarantee that the disk file being |
| 7490 |
** backed up to is not accessed by any connection within the process, |
| 7491 |
** not just the specific connection that was passed to sqlite3_backup_init(). |
| 7492 |
** |
| 7493 |
** The [sqlite3_backup] object itself is partially threadsafe. Multiple |
| 7494 |
** threads may safely make multiple concurrent calls to sqlite3_backup_step(). |
| 7495 |
** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() |
| 7496 |
** APIs are not strictly speaking threadsafe. If they are invoked at the |
| 7497 |
** same time as another thread is invoking sqlite3_backup_step() it is |
| 7498 |
** possible that they return invalid values. |
| 7499 |
*/ |
| 7500 |
SQLITE_API sqlite3_backup *sqlite3_backup_init( |
| 7501 |
sqlite3 *pDest, /* Destination database handle */ |
| 7502 |
const char *zDestName, /* Destination database name */ |
| 7503 |
sqlite3 *pSource, /* Source database handle */ |
| 7504 |
const char *zSourceName /* Source database name */ |
| 7505 |
); |
| 7506 |
SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); |
| 7507 |
SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); |
| 7508 |
SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); |
| 7509 |
SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); |
| 7510 |
|
| 7511 |
/* |
| 7512 |
** CAPI3REF: Unlock Notification |
| 7513 |
** METHOD: sqlite3 |
| 7514 |
** |
| 7515 |
** ^When running in shared-cache mode, a database operation may fail with |
| 7516 |
** an [SQLITE_LOCKED] error if the required locks on the shared-cache or |
| 7517 |
** individual tables within the shared-cache cannot be obtained. See |
| 7518 |
** [SQLite Shared-Cache Mode] for a description of shared-cache locking. |
| 7519 |
** ^This API may be used to register a callback that SQLite will invoke |
| 7520 |
** when the connection currently holding the required lock relinquishes it. |
| 7521 |
** ^This API is only available if the library was compiled with the |
| 7522 |
** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. |
| 7523 |
** |
| 7524 |
** See Also: [Using the SQLite Unlock Notification Feature]. |
| 7525 |
** |
| 7526 |
** ^Shared-cache locks are released when a database connection concludes |
| 7527 |
** its current transaction, either by committing it or rolling it back. |
| 7528 |
** |
| 7529 |
** ^When a connection (known as the blocked connection) fails to obtain a |
| 7530 |
** shared-cache lock and SQLITE_LOCKED is returned to the caller, the |
| 7531 |
** identity of the database connection (the blocking connection) that |
| 7532 |
** has locked the required resource is stored internally. ^After an |
| 7533 |
** application receives an SQLITE_LOCKED error, it may call the |
| 7534 |
** sqlite3_unlock_notify() method with the blocked connection handle as |
| 7535 |
** the first argument to register for a callback that will be invoked |
| 7536 |
** when the blocking connections current transaction is concluded. ^The |
| 7537 |
** callback is invoked from within the [sqlite3_step] or [sqlite3_close] |
| 7538 |
** call that concludes the blocking connections transaction. |
| 7539 |
** |
| 7540 |
** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, |
| 7541 |
** there is a chance that the blocking connection will have already |
| 7542 |
** concluded its transaction by the time sqlite3_unlock_notify() is invoked. |
| 7543 |
** If this happens, then the specified callback is invoked immediately, |
| 7544 |
** from within the call to sqlite3_unlock_notify().)^ |
| 7545 |
** |
| 7546 |
** ^If the blocked connection is attempting to obtain a write-lock on a |
| 7547 |
** shared-cache table, and more than one other connection currently holds |
| 7548 |
** a read-lock on the same table, then SQLite arbitrarily selects one of |
| 7549 |
** the other connections to use as the blocking connection. |
| 7550 |
** |
| 7551 |
** ^(There may be at most one unlock-notify callback registered by a |
| 7552 |
** blocked connection. If sqlite3_unlock_notify() is called when the |
| 7553 |
** blocked connection already has a registered unlock-notify callback, |
| 7554 |
** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is |
| 7555 |
** called with a NULL pointer as its second argument, then any existing |
| 7556 |
** unlock-notify callback is canceled. ^The blocked connections |
| 7557 |
** unlock-notify callback may also be canceled by closing the blocked |
| 7558 |
** connection using [sqlite3_close()]. |
| 7559 |
** |
| 7560 |
** The unlock-notify callback is not reentrant. If an application invokes |
| 7561 |
** any sqlite3_xxx API functions from within an unlock-notify callback, a |
| 7562 |
** crash or deadlock may be the result. |
| 7563 |
** |
| 7564 |
** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always |
| 7565 |
** returns SQLITE_OK. |
| 7566 |
** |
| 7567 |
** <b>Callback Invocation Details</b> |
| 7568 |
** |
| 7569 |
** When an unlock-notify callback is registered, the application provides a |
| 7570 |
** single void* pointer that is passed to the callback when it is invoked. |
| 7571 |
** However, the signature of the callback function allows SQLite to pass |
| 7572 |
** it an array of void* context pointers. The first argument passed to |
| 7573 |
** an unlock-notify callback is a pointer to an array of void* pointers, |
| 7574 |
** and the second is the number of entries in the array. |
| 7575 |
** |
| 7576 |
** When a blocking connections transaction is concluded, there may be |
| 7577 |
** more than one blocked connection that has registered for an unlock-notify |
| 7578 |
** callback. ^If two or more such blocked connections have specified the |
| 7579 |
** same callback function, then instead of invoking the callback function |
| 7580 |
** multiple times, it is invoked once with the set of void* context pointers |
| 7581 |
** specified by the blocked connections bundled together into an array. |
| 7582 |
** This gives the application an opportunity to prioritize any actions |
| 7583 |
** related to the set of unblocked database connections. |
| 7584 |
** |
| 7585 |
** <b>Deadlock Detection</b> |
| 7586 |
** |
| 7587 |
** Assuming that after registering for an unlock-notify callback a |
| 7588 |
** database waits for the callback to be issued before taking any further |
| 7589 |
** action (a reasonable assumption), then using this API may cause the |
| 7590 |
** application to deadlock. For example, if connection X is waiting for |
| 7591 |
** connection Y's transaction to be concluded, and similarly connection |
| 7592 |
** Y is waiting on connection X's transaction, then neither connection |
| 7593 |
** will proceed and the system may remain deadlocked indefinitely. |
| 7594 |
** |
| 7595 |
** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock |
| 7596 |
** detection. ^If a given call to sqlite3_unlock_notify() would put the |
| 7597 |
** system in a deadlocked state, then SQLITE_LOCKED is returned and no |
| 7598 |
** unlock-notify callback is registered. The system is said to be in |
| 7599 |
** a deadlocked state if connection A has registered for an unlock-notify |
| 7600 |
** callback on the conclusion of connection B's transaction, and connection |
| 7601 |
** B has itself registered for an unlock-notify callback when connection |
| 7602 |
** A's transaction is concluded. ^Indirect deadlock is also detected, so |
| 7603 |
** the system is also considered to be deadlocked if connection B has |
| 7604 |
** registered for an unlock-notify callback on the conclusion of connection |
| 7605 |
** C's transaction, where connection C is waiting on connection A. ^Any |
| 7606 |
** number of levels of indirection are allowed. |
| 7607 |
** |
| 7608 |
** <b>The "DROP TABLE" Exception</b> |
| 7609 |
** |
| 7610 |
** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost |
| 7611 |
** always appropriate to call sqlite3_unlock_notify(). There is however, |
| 7612 |
** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, |
| 7613 |
** SQLite checks if there are any currently executing SELECT statements |
| 7614 |
** that belong to the same connection. If there are, SQLITE_LOCKED is |
| 7615 |
** returned. In this case there is no "blocking connection", so invoking |
| 7616 |
** sqlite3_unlock_notify() results in the unlock-notify callback being |
| 7617 |
** invoked immediately. If the application then re-attempts the "DROP TABLE" |
| 7618 |
** or "DROP INDEX" query, an infinite loop might be the result. |
| 7619 |
** |
| 7620 |
** One way around this problem is to check the extended error code returned |
| 7621 |
** by an sqlite3_step() call. ^(If there is a blocking connection, then the |
| 7622 |
** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in |
| 7623 |
** the special "DROP TABLE/INDEX" case, the extended error code is just |
| 7624 |
** SQLITE_LOCKED.)^ |
| 7625 |
*/ |
| 7626 |
SQLITE_API int sqlite3_unlock_notify( |
| 7627 |
sqlite3 *pBlocked, /* Waiting connection */ |
| 7628 |
void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ |
| 7629 |
void *pNotifyArg /* Argument to pass to xNotify */ |
| 7630 |
); |
| 7631 |
|
| 7632 |
|
| 7633 |
/* |
| 7634 |
** CAPI3REF: String Comparison |
| 7635 |
** |
| 7636 |
** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications |
| 7637 |
** and extensions to compare the contents of two buffers containing UTF-8 |
| 7638 |
** strings in a case-independent fashion, using the same definition of "case |
| 7639 |
** independence" that SQLite uses internally when comparing identifiers. |
| 7640 |
*/ |
| 7641 |
SQLITE_API int sqlite3_stricmp(const char *, const char *); |
| 7642 |
SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); |
| 7643 |
|
| 7644 |
/* |
| 7645 |
** CAPI3REF: String Globbing |
| 7646 |
* |
| 7647 |
** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if |
| 7648 |
** string X matches the [GLOB] pattern P. |
| 7649 |
** ^The definition of [GLOB] pattern matching used in |
| 7650 |
** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the |
| 7651 |
** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function |
| 7652 |
** is case sensitive. |
| 7653 |
** |
| 7654 |
** Note that this routine returns zero on a match and non-zero if the strings |
| 7655 |
** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. |
| 7656 |
** |
| 7657 |
** See also: [sqlite3_strlike()]. |
| 7658 |
*/ |
| 7659 |
SQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr); |
| 7660 |
|
| 7661 |
/* |
| 7662 |
** CAPI3REF: String LIKE Matching |
| 7663 |
* |
| 7664 |
** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if |
| 7665 |
** string X matches the [LIKE] pattern P with escape character E. |
| 7666 |
** ^The definition of [LIKE] pattern matching used in |
| 7667 |
** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E" |
| 7668 |
** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without |
| 7669 |
** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0. |
| 7670 |
** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case |
| 7671 |
** insensitive - equivalent upper and lower case ASCII characters match |
| 7672 |
** one another. |
| 7673 |
** |
| 7674 |
** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though |
| 7675 |
** only ASCII characters are case folded. |
| 7676 |
** |
| 7677 |
** Note that this routine returns zero on a match and non-zero if the strings |
| 7678 |
** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. |
| 7679 |
** |
| 7680 |
** See also: [sqlite3_strglob()]. |
| 7681 |
*/ |
| 7682 |
SQLITE_API int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc); |
| 7683 |
|
| 7684 |
/* |
| 7685 |
** CAPI3REF: Error Logging Interface |
| 7686 |
** |
| 7687 |
** ^The [sqlite3_log()] interface writes a message into the [error log] |
| 7688 |
** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. |
| 7689 |
** ^If logging is enabled, the zFormat string and subsequent arguments are |
| 7690 |
** used with [sqlite3_snprintf()] to generate the final output string. |
| 7691 |
** |
| 7692 |
** The sqlite3_log() interface is intended for use by extensions such as |
| 7693 |
** virtual tables, collating functions, and SQL functions. While there is |
| 7694 |
** nothing to prevent an application from calling sqlite3_log(), doing so |
| 7695 |
** is considered bad form. |
| 7696 |
** |
| 7697 |
** The zFormat string must not be NULL. |
| 7698 |
** |
| 7699 |
** To avoid deadlocks and other threading problems, the sqlite3_log() routine |
| 7700 |
** will not use dynamically allocated memory. The log message is stored in |
| 7701 |
** a fixed-length buffer on the stack. If the log message is longer than |
| 7702 |
** a few hundred characters, it will be truncated to the length of the |
| 7703 |
** buffer. |
| 7704 |
*/ |
| 7705 |
SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...); |
| 7706 |
|
| 7707 |
/* |
| 7708 |
** CAPI3REF: Write-Ahead Log Commit Hook |
| 7709 |
** METHOD: sqlite3 |
| 7710 |
** |
| 7711 |
** ^The [sqlite3_wal_hook()] function is used to register a callback that |
| 7712 |
** is invoked each time data is committed to a database in wal mode. |
| 7713 |
** |
| 7714 |
** ^(The callback is invoked by SQLite after the commit has taken place and |
| 7715 |
** the associated write-lock on the database released)^, so the implementation |
| 7716 |
** may read, write or [checkpoint] the database as required. |
| 7717 |
** |
| 7718 |
** ^The first parameter passed to the callback function when it is invoked |
| 7719 |
** is a copy of the third parameter passed to sqlite3_wal_hook() when |
| 7720 |
** registering the callback. ^The second is a copy of the database handle. |
| 7721 |
** ^The third parameter is the name of the database that was written to - |
| 7722 |
** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter |
| 7723 |
** is the number of pages currently in the write-ahead log file, |
| 7724 |
** including those that were just committed. |
| 7725 |
** |
| 7726 |
** The callback function should normally return [SQLITE_OK]. ^If an error |
| 7727 |
** code is returned, that error will propagate back up through the |
| 7728 |
** SQLite code base to cause the statement that provoked the callback |
| 7729 |
** to report an error, though the commit will have still occurred. If the |
| 7730 |
** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value |
| 7731 |
** that does not correspond to any valid SQLite error code, the results |
| 7732 |
** are undefined. |
| 7733 |
** |
| 7734 |
** A single database handle may have at most a single write-ahead log callback |
| 7735 |
** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any |
| 7736 |
** previously registered write-ahead log callback. ^Note that the |
| 7737 |
** [sqlite3_wal_autocheckpoint()] interface and the |
| 7738 |
** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will |
| 7739 |
** overwrite any prior [sqlite3_wal_hook()] settings. |
| 7740 |
*/ |
| 7741 |
SQLITE_API void *sqlite3_wal_hook( |
| 7742 |
sqlite3*, |
| 7743 |
int(*)(void *,sqlite3*,const char*,int), |
| 7744 |
void* |
| 7745 |
); |
| 7746 |
|
| 7747 |
/* |
| 7748 |
** CAPI3REF: Configure an auto-checkpoint |
| 7749 |
** METHOD: sqlite3 |
| 7750 |
** |
| 7751 |
** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around |
| 7752 |
** [sqlite3_wal_hook()] that causes any database on [database connection] D |
| 7753 |
** to automatically [checkpoint] |
| 7754 |
** after committing a transaction if there are N or |
| 7755 |
** more frames in the [write-ahead log] file. ^Passing zero or |
| 7756 |
** a negative value as the nFrame parameter disables automatic |
| 7757 |
** checkpoints entirely. |
| 7758 |
** |
| 7759 |
** ^The callback registered by this function replaces any existing callback |
| 7760 |
** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback |
| 7761 |
** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism |
| 7762 |
** configured by this function. |
| 7763 |
** |
| 7764 |
** ^The [wal_autocheckpoint pragma] can be used to invoke this interface |
| 7765 |
** from SQL. |
| 7766 |
** |
| 7767 |
** ^Checkpoints initiated by this mechanism are |
| 7768 |
** [sqlite3_wal_checkpoint_v2|PASSIVE]. |
| 7769 |
** |
| 7770 |
** ^Every new [database connection] defaults to having the auto-checkpoint |
| 7771 |
** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] |
| 7772 |
** pages. The use of this interface |
| 7773 |
** is only necessary if the default setting is found to be suboptimal |
| 7774 |
** for a particular application. |
| 7775 |
*/ |
| 7776 |
SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); |
| 7777 |
|
| 7778 |
/* |
| 7779 |
** CAPI3REF: Checkpoint a database |
| 7780 |
** METHOD: sqlite3 |
| 7781 |
** |
| 7782 |
** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to |
| 7783 |
** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^ |
| 7784 |
** |
| 7785 |
** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the |
| 7786 |
** [write-ahead log] for database X on [database connection] D to be |
| 7787 |
** transferred into the database file and for the write-ahead log to |
| 7788 |
** be reset. See the [checkpointing] documentation for addition |
| 7789 |
** information. |
| 7790 |
** |
| 7791 |
** This interface used to be the only way to cause a checkpoint to |
| 7792 |
** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()] |
| 7793 |
** interface was added. This interface is retained for backwards |
| 7794 |
** compatibility and as a convenience for applications that need to manually |
| 7795 |
** start a callback but which do not need the full power (and corresponding |
| 7796 |
** complication) of [sqlite3_wal_checkpoint_v2()]. |
| 7797 |
*/ |
| 7798 |
SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); |
| 7799 |
|
| 7800 |
/* |
| 7801 |
** CAPI3REF: Checkpoint a database |
| 7802 |
** METHOD: sqlite3 |
| 7803 |
** |
| 7804 |
** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint |
| 7805 |
** operation on database X of [database connection] D in mode M. Status |
| 7806 |
** information is written back into integers pointed to by L and C.)^ |
| 7807 |
** ^(The M parameter must be a valid [checkpoint mode]:)^ |
| 7808 |
** |
| 7809 |
** <dl> |
| 7810 |
** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> |
| 7811 |
** ^Checkpoint as many frames as possible without waiting for any database |
| 7812 |
** readers or writers to finish, then sync the database file if all frames |
| 7813 |
** in the log were checkpointed. ^The [busy-handler callback] |
| 7814 |
** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode. |
| 7815 |
** ^On the other hand, passive mode might leave the checkpoint unfinished |
| 7816 |
** if there are concurrent readers or writers. |
| 7817 |
** |
| 7818 |
** <dt>SQLITE_CHECKPOINT_FULL<dd> |
| 7819 |
** ^This mode blocks (it invokes the |
| 7820 |
** [sqlite3_busy_handler|busy-handler callback]) until there is no |
| 7821 |
** database writer and all readers are reading from the most recent database |
| 7822 |
** snapshot. ^It then checkpoints all frames in the log file and syncs the |
| 7823 |
** database file. ^This mode blocks new database writers while it is pending, |
| 7824 |
** but new database readers are allowed to continue unimpeded. |
| 7825 |
** |
| 7826 |
** <dt>SQLITE_CHECKPOINT_RESTART<dd> |
| 7827 |
** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition |
| 7828 |
** that after checkpointing the log file it blocks (calls the |
| 7829 |
** [busy-handler callback]) |
| 7830 |
** until all readers are reading from the database file only. ^This ensures |
| 7831 |
** that the next writer will restart the log file from the beginning. |
| 7832 |
** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new |
| 7833 |
** database writer attempts while it is pending, but does not impede readers. |
| 7834 |
** |
| 7835 |
** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd> |
| 7836 |
** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the |
| 7837 |
** addition that it also truncates the log file to zero bytes just prior |
| 7838 |
** to a successful return. |
| 7839 |
** </dl> |
| 7840 |
** |
| 7841 |
** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in |
| 7842 |
** the log file or to -1 if the checkpoint could not run because |
| 7843 |
** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not |
| 7844 |
** NULL,then *pnCkpt is set to the total number of checkpointed frames in the |
| 7845 |
** log file (including any that were already checkpointed before the function |
| 7846 |
** was called) or to -1 if the checkpoint could not run due to an error or |
| 7847 |
** because the database is not in WAL mode. ^Note that upon successful |
| 7848 |
** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been |
| 7849 |
** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero. |
| 7850 |
** |
| 7851 |
** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If |
| 7852 |
** any other process is running a checkpoint operation at the same time, the |
| 7853 |
** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a |
| 7854 |
** busy-handler configured, it will not be invoked in this case. |
| 7855 |
** |
| 7856 |
** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the |
| 7857 |
** exclusive "writer" lock on the database file. ^If the writer lock cannot be |
| 7858 |
** obtained immediately, and a busy-handler is configured, it is invoked and |
| 7859 |
** the writer lock retried until either the busy-handler returns 0 or the lock |
| 7860 |
** is successfully obtained. ^The busy-handler is also invoked while waiting for |
| 7861 |
** database readers as described above. ^If the busy-handler returns 0 before |
| 7862 |
** the writer lock is obtained or while waiting for database readers, the |
| 7863 |
** checkpoint operation proceeds from that point in the same way as |
| 7864 |
** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible |
| 7865 |
** without blocking any further. ^SQLITE_BUSY is returned in this case. |
| 7866 |
** |
| 7867 |
** ^If parameter zDb is NULL or points to a zero length string, then the |
| 7868 |
** specified operation is attempted on all WAL databases [attached] to |
| 7869 |
** [database connection] db. In this case the |
| 7870 |
** values written to output parameters *pnLog and *pnCkpt are undefined. ^If |
| 7871 |
** an SQLITE_BUSY error is encountered when processing one or more of the |
| 7872 |
** attached WAL databases, the operation is still attempted on any remaining |
| 7873 |
** attached databases and SQLITE_BUSY is returned at the end. ^If any other |
| 7874 |
** error occurs while processing an attached database, processing is abandoned |
| 7875 |
** and the error code is returned to the caller immediately. ^If no error |
| 7876 |
** (SQLITE_BUSY or otherwise) is encountered while processing the attached |
| 7877 |
** databases, SQLITE_OK is returned. |
| 7878 |
** |
| 7879 |
** ^If database zDb is the name of an attached database that is not in WAL |
| 7880 |
** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If |
| 7881 |
** zDb is not NULL (or a zero length string) and is not the name of any |
| 7882 |
** attached database, SQLITE_ERROR is returned to the caller. |
| 7883 |
** |
| 7884 |
** ^Unless it returns SQLITE_MISUSE, |
| 7885 |
** the sqlite3_wal_checkpoint_v2() interface |
| 7886 |
** sets the error information that is queried by |
| 7887 |
** [sqlite3_errcode()] and [sqlite3_errmsg()]. |
| 7888 |
** |
| 7889 |
** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface |
| 7890 |
** from SQL. |
| 7891 |
*/ |
| 7892 |
SQLITE_API int sqlite3_wal_checkpoint_v2( |
| 7893 |
sqlite3 *db, /* Database handle */ |
| 7894 |
const char *zDb, /* Name of attached database (or NULL) */ |
| 7895 |
int eMode, /* SQLITE_CHECKPOINT_* value */ |
| 7896 |
int *pnLog, /* OUT: Size of WAL log in frames */ |
| 7897 |
int *pnCkpt /* OUT: Total number of frames checkpointed */ |
| 7898 |
); |
| 7899 |
|
| 7900 |
/* |
| 7901 |
** CAPI3REF: Checkpoint Mode Values |
| 7902 |
** KEYWORDS: {checkpoint mode} |
| 7903 |
** |
| 7904 |
** These constants define all valid values for the "checkpoint mode" passed |
| 7905 |
** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface. |
| 7906 |
** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the |
| 7907 |
** meaning of each of these checkpoint modes. |
| 7908 |
*/ |
| 7909 |
#define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */ |
| 7910 |
#define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */ |
| 7911 |
#define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */ |
| 7912 |
#define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */ |
| 7913 |
|
| 7914 |
/* |
| 7915 |
** CAPI3REF: Virtual Table Interface Configuration |
| 7916 |
** |
| 7917 |
** This function may be called by either the [xConnect] or [xCreate] method |
| 7918 |
** of a [virtual table] implementation to configure |
| 7919 |
** various facets of the virtual table interface. |
| 7920 |
** |
| 7921 |
** If this interface is invoked outside the context of an xConnect or |
| 7922 |
** xCreate virtual table method then the behavior is undefined. |
| 7923 |
** |
| 7924 |
** At present, there is only one option that may be configured using |
| 7925 |
** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options |
| 7926 |
** may be added in the future. |
| 7927 |
*/ |
| 7928 |
SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...); |
| 7929 |
|
| 7930 |
/* |
| 7931 |
** CAPI3REF: Virtual Table Configuration Options |
| 7932 |
** |
| 7933 |
** These macros define the various options to the |
| 7934 |
** [sqlite3_vtab_config()] interface that [virtual table] implementations |
| 7935 |
** can use to customize and optimize their behavior. |
| 7936 |
** |
| 7937 |
** <dl> |
| 7938 |
** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT |
| 7939 |
** <dd>Calls of the form |
| 7940 |
** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, |
| 7941 |
** where X is an integer. If X is zero, then the [virtual table] whose |
| 7942 |
** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not |
| 7943 |
** support constraints. In this configuration (which is the default) if |
| 7944 |
** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire |
| 7945 |
** statement is rolled back as if [ON CONFLICT | OR ABORT] had been |
| 7946 |
** specified as part of the users SQL statement, regardless of the actual |
| 7947 |
** ON CONFLICT mode specified. |
| 7948 |
** |
| 7949 |
** If X is non-zero, then the virtual table implementation guarantees |
| 7950 |
** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before |
| 7951 |
** any modifications to internal or persistent data structures have been made. |
| 7952 |
** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite |
| 7953 |
** is able to roll back a statement or database transaction, and abandon |
| 7954 |
** or continue processing the current SQL statement as appropriate. |
| 7955 |
** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns |
| 7956 |
** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode |
| 7957 |
** had been ABORT. |
| 7958 |
** |
| 7959 |
** Virtual table implementations that are required to handle OR REPLACE |
| 7960 |
** must do so within the [xUpdate] method. If a call to the |
| 7961 |
** [sqlite3_vtab_on_conflict()] function indicates that the current ON |
| 7962 |
** CONFLICT policy is REPLACE, the virtual table implementation should |
| 7963 |
** silently replace the appropriate rows within the xUpdate callback and |
| 7964 |
** return SQLITE_OK. Or, if this is not possible, it may return |
| 7965 |
** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT |
| 7966 |
** constraint handling. |
| 7967 |
** </dl> |
| 7968 |
*/ |
| 7969 |
#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 |
| 7970 |
|
| 7971 |
/* |
| 7972 |
** CAPI3REF: Determine The Virtual Table Conflict Policy |
| 7973 |
** |
| 7974 |
** This function may only be called from within a call to the [xUpdate] method |
| 7975 |
** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The |
| 7976 |
** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], |
| 7977 |
** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode |
| 7978 |
** of the SQL statement that triggered the call to the [xUpdate] method of the |
| 7979 |
** [virtual table]. |
| 7980 |
*/ |
| 7981 |
SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *); |
| 7982 |
|
| 7983 |
/* |
| 7984 |
** CAPI3REF: Conflict resolution modes |
| 7985 |
** KEYWORDS: {conflict resolution mode} |
| 7986 |
** |
| 7987 |
** These constants are returned by [sqlite3_vtab_on_conflict()] to |
| 7988 |
** inform a [virtual table] implementation what the [ON CONFLICT] mode |
| 7989 |
** is for the SQL statement being evaluated. |
| 7990 |
** |
| 7991 |
** Note that the [SQLITE_IGNORE] constant is also used as a potential |
| 7992 |
** return value from the [sqlite3_set_authorizer()] callback and that |
| 7993 |
** [SQLITE_ABORT] is also a [result code]. |
| 7994 |
*/ |
| 7995 |
#define SQLITE_ROLLBACK 1 |
| 7996 |
/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ |
| 7997 |
#define SQLITE_FAIL 3 |
| 7998 |
/* #define SQLITE_ABORT 4 // Also an error code */ |
| 7999 |
#define SQLITE_REPLACE 5 |
| 8000 |
|
| 8001 |
/* |
| 8002 |
** CAPI3REF: Prepared Statement Scan Status Opcodes |
| 8003 |
** KEYWORDS: {scanstatus options} |
| 8004 |
** |
| 8005 |
** The following constants can be used for the T parameter to the |
| 8006 |
** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a |
| 8007 |
** different metric for sqlite3_stmt_scanstatus() to return. |
| 8008 |
** |
| 8009 |
** When the value returned to V is a string, space to hold that string is |
| 8010 |
** managed by the prepared statement S and will be automatically freed when |
| 8011 |
** S is finalized. |
| 8012 |
** |
| 8013 |
** <dl> |
| 8014 |
** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt> |
| 8015 |
** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be |
| 8016 |
** set to the total number of times that the X-th loop has run.</dd> |
| 8017 |
** |
| 8018 |
** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt> |
| 8019 |
** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set |
| 8020 |
** to the total number of rows examined by all iterations of the X-th loop.</dd> |
| 8021 |
** |
| 8022 |
** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt> |
| 8023 |
** <dd>^The "double" variable pointed to by the T parameter will be set to the |
| 8024 |
** query planner's estimate for the average number of rows output from each |
| 8025 |
** iteration of the X-th loop. If the query planner's estimates was accurate, |
| 8026 |
** then this value will approximate the quotient NVISIT/NLOOP and the |
| 8027 |
** product of this value for all prior loops with the same SELECTID will |
| 8028 |
** be the NLOOP value for the current loop. |
| 8029 |
** |
| 8030 |
** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt> |
| 8031 |
** <dd>^The "const char *" variable pointed to by the T parameter will be set |
| 8032 |
** to a zero-terminated UTF-8 string containing the name of the index or table |
| 8033 |
** used for the X-th loop. |
| 8034 |
** |
| 8035 |
** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt> |
| 8036 |
** <dd>^The "const char *" variable pointed to by the T parameter will be set |
| 8037 |
** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] |
| 8038 |
** description for the X-th loop. |
| 8039 |
** |
| 8040 |
** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt> |
| 8041 |
** <dd>^The "int" variable pointed to by the T parameter will be set to the |
| 8042 |
** "select-id" for the X-th loop. The select-id identifies which query or |
| 8043 |
** subquery the loop is part of. The main query has a select-id of zero. |
| 8044 |
** The select-id is the same value as is output in the first column |
| 8045 |
** of an [EXPLAIN QUERY PLAN] query. |
| 8046 |
** </dl> |
| 8047 |
*/ |
| 8048 |
#define SQLITE_SCANSTAT_NLOOP 0 |
| 8049 |
#define SQLITE_SCANSTAT_NVISIT 1 |
| 8050 |
#define SQLITE_SCANSTAT_EST 2 |
| 8051 |
#define SQLITE_SCANSTAT_NAME 3 |
| 8052 |
#define SQLITE_SCANSTAT_EXPLAIN 4 |
| 8053 |
#define SQLITE_SCANSTAT_SELECTID 5 |
| 8054 |
|
| 8055 |
/* |
| 8056 |
** CAPI3REF: Prepared Statement Scan Status |
| 8057 |
** METHOD: sqlite3_stmt |
| 8058 |
** |
| 8059 |
** This interface returns information about the predicted and measured |
| 8060 |
** performance for pStmt. Advanced applications can use this |
| 8061 |
** interface to compare the predicted and the measured performance and |
| 8062 |
** issue warnings and/or rerun [ANALYZE] if discrepancies are found. |
| 8063 |
** |
| 8064 |
** Since this interface is expected to be rarely used, it is only |
| 8065 |
** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS] |
| 8066 |
** compile-time option. |
| 8067 |
** |
| 8068 |
** The "iScanStatusOp" parameter determines which status information to return. |
| 8069 |
** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior |
| 8070 |
** of this interface is undefined. |
| 8071 |
** ^The requested measurement is written into a variable pointed to by |
| 8072 |
** the "pOut" parameter. |
| 8073 |
** Parameter "idx" identifies the specific loop to retrieve statistics for. |
| 8074 |
** Loops are numbered starting from zero. ^If idx is out of range - less than |
| 8075 |
** zero or greater than or equal to the total number of loops used to implement |
| 8076 |
** the statement - a non-zero value is returned and the variable that pOut |
| 8077 |
** points to is unchanged. |
| 8078 |
** |
| 8079 |
** ^Statistics might not be available for all loops in all statements. ^In cases |
| 8080 |
** where there exist loops with no available statistics, this function behaves |
| 8081 |
** as if the loop did not exist - it returns non-zero and leave the variable |
| 8082 |
** that pOut points to unchanged. |
| 8083 |
** |
| 8084 |
** See also: [sqlite3_stmt_scanstatus_reset()] |
| 8085 |
*/ |
| 8086 |
SQLITE_API int sqlite3_stmt_scanstatus( |
| 8087 |
sqlite3_stmt *pStmt, /* Prepared statement for which info desired */ |
| 8088 |
int idx, /* Index of loop to report on */ |
| 8089 |
int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */ |
| 8090 |
void *pOut /* Result written here */ |
| 8091 |
); |
| 8092 |
|
| 8093 |
/* |
| 8094 |
** CAPI3REF: Zero Scan-Status Counters |
| 8095 |
** METHOD: sqlite3_stmt |
| 8096 |
** |
| 8097 |
** ^Zero all [sqlite3_stmt_scanstatus()] related event counters. |
| 8098 |
** |
| 8099 |
** This API is only available if the library is built with pre-processor |
| 8100 |
** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined. |
| 8101 |
*/ |
| 8102 |
SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*); |
| 8103 |
|
| 8104 |
/* |
| 8105 |
** CAPI3REF: Flush caches to disk mid-transaction |
| 8106 |
** |
| 8107 |
** ^If a write-transaction is open on [database connection] D when the |
| 8108 |
** [sqlite3_db_cacheflush(D)] interface invoked, any dirty |
| 8109 |
** pages in the pager-cache that are not currently in use are written out |
| 8110 |
** to disk. A dirty page may be in use if a database cursor created by an |
| 8111 |
** active SQL statement is reading from it, or if it is page 1 of a database |
| 8112 |
** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)] |
| 8113 |
** interface flushes caches for all schemas - "main", "temp", and |
| 8114 |
** any [attached] databases. |
| 8115 |
** |
| 8116 |
** ^If this function needs to obtain extra database locks before dirty pages |
| 8117 |
** can be flushed to disk, it does so. ^If those locks cannot be obtained |
| 8118 |
** immediately and there is a busy-handler callback configured, it is invoked |
| 8119 |
** in the usual manner. ^If the required lock still cannot be obtained, then |
| 8120 |
** the database is skipped and an attempt made to flush any dirty pages |
| 8121 |
** belonging to the next (if any) database. ^If any databases are skipped |
| 8122 |
** because locks cannot be obtained, but no other error occurs, this |
| 8123 |
** function returns SQLITE_BUSY. |
| 8124 |
** |
| 8125 |
** ^If any other error occurs while flushing dirty pages to disk (for |
| 8126 |
** example an IO error or out-of-memory condition), then processing is |
| 8127 |
** abandoned and an SQLite [error code] is returned to the caller immediately. |
| 8128 |
** |
| 8129 |
** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK. |
| 8130 |
** |
| 8131 |
** ^This function does not set the database handle error code or message |
| 8132 |
** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions. |
| 8133 |
*/ |
| 8134 |
SQLITE_API int sqlite3_db_cacheflush(sqlite3*); |
| 8135 |
|
| 8136 |
/* |
| 8137 |
** CAPI3REF: The pre-update hook. |
| 8138 |
** |
| 8139 |
** ^These interfaces are only available if SQLite is compiled using the |
| 8140 |
** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option. |
| 8141 |
** |
| 8142 |
** ^The [sqlite3_preupdate_hook()] interface registers a callback function |
| 8143 |
** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation |
| 8144 |
** on a [rowid table]. |
| 8145 |
** ^At most one preupdate hook may be registered at a time on a single |
| 8146 |
** [database connection]; each call to [sqlite3_preupdate_hook()] overrides |
| 8147 |
** the previous setting. |
| 8148 |
** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()] |
| 8149 |
** with a NULL pointer as the second parameter. |
| 8150 |
** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as |
| 8151 |
** the first parameter to callbacks. |
| 8152 |
** |
| 8153 |
** ^The preupdate hook only fires for changes to [rowid tables]; the preupdate |
| 8154 |
** hook is not invoked for changes to [virtual tables] or [WITHOUT ROWID] |
| 8155 |
** tables. |
| 8156 |
** |
| 8157 |
** ^The second parameter to the preupdate callback is a pointer to |
| 8158 |
** the [database connection] that registered the preupdate hook. |
| 8159 |
** ^The third parameter to the preupdate callback is one of the constants |
| 8160 |
** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the |
| 8161 |
** kind of update operation that is about to occur. |
| 8162 |
** ^(The fourth parameter to the preupdate callback is the name of the |
| 8163 |
** database within the database connection that is being modified. This |
| 8164 |
** will be "main" for the main database or "temp" for TEMP tables or |
| 8165 |
** the name given after the AS keyword in the [ATTACH] statement for attached |
| 8166 |
** databases.)^ |
| 8167 |
** ^The fifth parameter to the preupdate callback is the name of the |
| 8168 |
** table that is being modified. |
| 8169 |
** ^The sixth parameter to the preupdate callback is the initial [rowid] of the |
| 8170 |
** row being changes for SQLITE_UPDATE and SQLITE_DELETE changes and is |
| 8171 |
** undefined for SQLITE_INSERT changes. |
| 8172 |
** ^The seventh parameter to the preupdate callback is the final [rowid] of |
| 8173 |
** the row being changed for SQLITE_UPDATE and SQLITE_INSERT changes and is |
| 8174 |
** undefined for SQLITE_DELETE changes. |
| 8175 |
** |
| 8176 |
** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()], |
| 8177 |
** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces |
| 8178 |
** provide additional information about a preupdate event. These routines |
| 8179 |
** may only be called from within a preupdate callback. Invoking any of |
| 8180 |
** these routines from outside of a preupdate callback or with a |
| 8181 |
** [database connection] pointer that is different from the one supplied |
| 8182 |
** to the preupdate callback results in undefined and probably undesirable |
| 8183 |
** behavior. |
| 8184 |
** |
| 8185 |
** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns |
| 8186 |
** in the row that is being inserted, updated, or deleted. |
| 8187 |
** |
| 8188 |
** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to |
| 8189 |
** a [protected sqlite3_value] that contains the value of the Nth column of |
| 8190 |
** the table row before it is updated. The N parameter must be between 0 |
| 8191 |
** and one less than the number of columns or the behavior will be |
| 8192 |
** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE |
| 8193 |
** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the |
| 8194 |
** behavior is undefined. The [sqlite3_value] that P points to |
| 8195 |
** will be destroyed when the preupdate callback returns. |
| 8196 |
** |
| 8197 |
** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to |
| 8198 |
** a [protected sqlite3_value] that contains the value of the Nth column of |
| 8199 |
** the table row after it is updated. The N parameter must be between 0 |
| 8200 |
** and one less than the number of columns or the behavior will be |
| 8201 |
** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE |
| 8202 |
** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the |
| 8203 |
** behavior is undefined. The [sqlite3_value] that P points to |
| 8204 |
** will be destroyed when the preupdate callback returns. |
| 8205 |
** |
| 8206 |
** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate |
| 8207 |
** callback was invoked as a result of a direct insert, update, or delete |
| 8208 |
** operation; or 1 for inserts, updates, or deletes invoked by top-level |
| 8209 |
** triggers; or 2 for changes resulting from triggers called by top-level |
| 8210 |
** triggers; and so forth. |
| 8211 |
** |
| 8212 |
** See also: [sqlite3_update_hook()] |
| 8213 |
*/ |
| 8214 |
SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_preupdate_hook( |
| 8215 |
sqlite3 *db, |
| 8216 |
void(*xPreUpdate)( |
| 8217 |
void *pCtx, /* Copy of third arg to preupdate_hook() */ |
| 8218 |
sqlite3 *db, /* Database handle */ |
| 8219 |
int op, /* SQLITE_UPDATE, DELETE or INSERT */ |
| 8220 |
char const *zDb, /* Database name */ |
| 8221 |
char const *zName, /* Table name */ |
| 8222 |
sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */ |
| 8223 |
sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */ |
| 8224 |
), |
| 8225 |
void* |
| 8226 |
); |
| 8227 |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **); |
| 8228 |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_count(sqlite3 *); |
| 8229 |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_depth(sqlite3 *); |
| 8230 |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **); |
| 8231 |
|
| 8232 |
/* |
| 8233 |
** CAPI3REF: Low-level system error code |
| 8234 |
** |
| 8235 |
** ^Attempt to return the underlying operating system error code or error |
| 8236 |
** number that caused the most recent I/O error or failure to open a file. |
| 8237 |
** The return value is OS-dependent. For example, on unix systems, after |
| 8238 |
** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be |
| 8239 |
** called to get back the underlying "errno" that caused the problem, such |
| 8240 |
** as ENOSPC, EAUTH, EISDIR, and so forth. |
| 8241 |
*/ |
| 8242 |
SQLITE_API int sqlite3_system_errno(sqlite3*); |
| 8243 |
|
| 8244 |
/* |
| 8245 |
** CAPI3REF: Database Snapshot |
| 8246 |
** KEYWORDS: {snapshot} |
| 8247 |
** EXPERIMENTAL |
| 8248 |
** |
| 8249 |
** An instance of the snapshot object records the state of a [WAL mode] |
| 8250 |
** database for some specific point in history. |
| 8251 |
** |
| 8252 |
** In [WAL mode], multiple [database connections] that are open on the |
| 8253 |
** same database file can each be reading a different historical version |
| 8254 |
** of the database file. When a [database connection] begins a read |
| 8255 |
** transaction, that connection sees an unchanging copy of the database |
| 8256 |
** as it existed for the point in time when the transaction first started. |
| 8257 |
** Subsequent changes to the database from other connections are not seen |
| 8258 |
** by the reader until a new read transaction is started. |
| 8259 |
** |
| 8260 |
** The sqlite3_snapshot object records state information about an historical |
| 8261 |
** version of the database file so that it is possible to later open a new read |
| 8262 |
** transaction that sees that historical version of the database rather than |
| 8263 |
** the most recent version. |
| 8264 |
** |
| 8265 |
** The constructor for this object is [sqlite3_snapshot_get()]. The |
| 8266 |
** [sqlite3_snapshot_open()] method causes a fresh read transaction to refer |
| 8267 |
** to an historical snapshot (if possible). The destructor for |
| 8268 |
** sqlite3_snapshot objects is [sqlite3_snapshot_free()]. |
| 8269 |
*/ |
| 8270 |
typedef struct sqlite3_snapshot sqlite3_snapshot; |
| 8271 |
|
| 8272 |
/* |
| 8273 |
** CAPI3REF: Record A Database Snapshot |
| 8274 |
** EXPERIMENTAL |
| 8275 |
** |
| 8276 |
** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a |
| 8277 |
** new [sqlite3_snapshot] object that records the current state of |
| 8278 |
** schema S in database connection D. ^On success, the |
| 8279 |
** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly |
| 8280 |
** created [sqlite3_snapshot] object into *P and returns SQLITE_OK. |
| 8281 |
** ^If schema S of [database connection] D is not a [WAL mode] database |
| 8282 |
** that is in a read transaction, then [sqlite3_snapshot_get(D,S,P)] |
| 8283 |
** leaves the *P value unchanged and returns an appropriate [error code]. |
| 8284 |
** |
| 8285 |
** The [sqlite3_snapshot] object returned from a successful call to |
| 8286 |
** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()] |
| 8287 |
** to avoid a memory leak. |
| 8288 |
** |
| 8289 |
** The [sqlite3_snapshot_get()] interface is only available when the |
| 8290 |
** SQLITE_ENABLE_SNAPSHOT compile-time option is used. |
| 8291 |
*/ |
| 8292 |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get( |
| 8293 |
sqlite3 *db, |
| 8294 |
const char *zSchema, |
| 8295 |
sqlite3_snapshot **ppSnapshot |
| 8296 |
); |
| 8297 |
|
| 8298 |
/* |
| 8299 |
** CAPI3REF: Start a read transaction on an historical snapshot |
| 8300 |
** EXPERIMENTAL |
| 8301 |
** |
| 8302 |
** ^The [sqlite3_snapshot_open(D,S,P)] interface starts a |
| 8303 |
** read transaction for schema S of |
| 8304 |
** [database connection] D such that the read transaction |
| 8305 |
** refers to historical [snapshot] P, rather than the most |
| 8306 |
** recent change to the database. |
| 8307 |
** ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK on success |
| 8308 |
** or an appropriate [error code] if it fails. |
| 8309 |
** |
| 8310 |
** ^In order to succeed, a call to [sqlite3_snapshot_open(D,S,P)] must be |
| 8311 |
** the first operation following the [BEGIN] that takes the schema S |
| 8312 |
** out of [autocommit mode]. |
| 8313 |
** ^In other words, schema S must not currently be in |
| 8314 |
** a transaction for [sqlite3_snapshot_open(D,S,P)] to work, but the |
| 8315 |
** database connection D must be out of [autocommit mode]. |
| 8316 |
** ^A [snapshot] will fail to open if it has been overwritten by a |
| 8317 |
** [checkpoint]. |
| 8318 |
** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the |
| 8319 |
** database connection D does not know that the database file for |
| 8320 |
** schema S is in [WAL mode]. A database connection might not know |
| 8321 |
** that the database file is in [WAL mode] if there has been no prior |
| 8322 |
** I/O on that database connection, or if the database entered [WAL mode] |
| 8323 |
** after the most recent I/O on the database connection.)^ |
| 8324 |
** (Hint: Run "[PRAGMA application_id]" against a newly opened |
| 8325 |
** database connection in order to make it ready to use snapshots.) |
| 8326 |
** |
| 8327 |
** The [sqlite3_snapshot_open()] interface is only available when the |
| 8328 |
** SQLITE_ENABLE_SNAPSHOT compile-time option is used. |
| 8329 |
*/ |
| 8330 |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open( |
| 8331 |
sqlite3 *db, |
| 8332 |
const char *zSchema, |
| 8333 |
sqlite3_snapshot *pSnapshot |
| 8334 |
); |
| 8335 |
|
| 8336 |
/* |
| 8337 |
** CAPI3REF: Destroy a snapshot |
| 8338 |
** EXPERIMENTAL |
| 8339 |
** |
| 8340 |
** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P. |
| 8341 |
** The application must eventually free every [sqlite3_snapshot] object |
| 8342 |
** using this routine to avoid a memory leak. |
| 8343 |
** |
| 8344 |
** The [sqlite3_snapshot_free()] interface is only available when the |
| 8345 |
** SQLITE_ENABLE_SNAPSHOT compile-time option is used. |
| 8346 |
*/ |
| 8347 |
SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*); |
| 8348 |
|
| 8349 |
/* |
| 8350 |
** CAPI3REF: Compare the ages of two snapshot handles. |
| 8351 |
** EXPERIMENTAL |
| 8352 |
** |
| 8353 |
** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages |
| 8354 |
** of two valid snapshot handles. |
| 8355 |
** |
| 8356 |
** If the two snapshot handles are not associated with the same database |
| 8357 |
** file, the result of the comparison is undefined. |
| 8358 |
** |
| 8359 |
** Additionally, the result of the comparison is only valid if both of the |
| 8360 |
** snapshot handles were obtained by calling sqlite3_snapshot_get() since the |
| 8361 |
** last time the wal file was deleted. The wal file is deleted when the |
| 8362 |
** database is changed back to rollback mode or when the number of database |
| 8363 |
** clients drops to zero. If either snapshot handle was obtained before the |
| 8364 |
** wal file was last deleted, the value returned by this function |
| 8365 |
** is undefined. |
| 8366 |
** |
| 8367 |
** Otherwise, this API returns a negative value if P1 refers to an older |
| 8368 |
** snapshot than P2, zero if the two handles refer to the same database |
| 8369 |
** snapshot, and a positive value if P1 is a newer snapshot than P2. |
| 8370 |
*/ |
| 8371 |
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp( |
| 8372 |
sqlite3_snapshot *p1, |
| 8373 |
sqlite3_snapshot *p2 |
| 8374 |
); |
| 8375 |
|
| 8376 |
/* |
| 8377 |
** Undo the hack that converts floating point types to integer for |
| 8378 |
** builds on processors without floating point support. |
| 8379 |
*/ |
| 8380 |
#ifdef SQLITE_OMIT_FLOATING_POINT |
| 8381 |
# undef double |
| 8382 |
#endif |
| 8383 |
|
| 8384 |
#ifdef __cplusplus |
| 8385 |
} /* End of the 'extern "C"' block */ |
| 8386 |
#endif |
| 8387 |
#endif /* SQLITE3_H */ |
| 8388 |
|
| 8389 |
/******** Begin file sqlite3rtree.h *********/ |
| 8390 |
/* |
| 8391 |
** 2010 August 30 |
| 8392 |
** |
| 8393 |
** The author disclaims copyright to this source code. In place of |
| 8394 |
** a legal notice, here is a blessing: |
| 8395 |
** |
| 8396 |
** May you do good and not evil. |
| 8397 |
** May you find forgiveness for yourself and forgive others. |
| 8398 |
** May you share freely, never taking more than you give. |
| 8399 |
** |
| 8400 |
************************************************************************* |
| 8401 |
*/ |
| 8402 |
|
| 8403 |
#ifndef _SQLITE3RTREE_H_ |
| 8404 |
#define _SQLITE3RTREE_H_ |
| 8405 |
|
| 8406 |
|
| 8407 |
#ifdef __cplusplus |
| 8408 |
extern "C" { |
| 8409 |
#endif |
| 8410 |
|
| 8411 |
typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; |
| 8412 |
typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info; |
| 8413 |
|
| 8414 |
/* The double-precision datatype used by RTree depends on the |
| 8415 |
** SQLITE_RTREE_INT_ONLY compile-time option. |
| 8416 |
*/ |
| 8417 |
#ifdef SQLITE_RTREE_INT_ONLY |
| 8418 |
typedef sqlite3_int64 sqlite3_rtree_dbl; |
| 8419 |
#else |
| 8420 |
typedef double sqlite3_rtree_dbl; |
| 8421 |
#endif |
| 8422 |
|
| 8423 |
/* |
| 8424 |
** Register a geometry callback named zGeom that can be used as part of an |
| 8425 |
** R-Tree geometry query as follows: |
| 8426 |
** |
| 8427 |
** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...) |
| 8428 |
*/ |
| 8429 |
SQLITE_API int sqlite3_rtree_geometry_callback( |
| 8430 |
sqlite3 *db, |
| 8431 |
const char *zGeom, |
| 8432 |
int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*), |
| 8433 |
void *pContext |
| 8434 |
); |
| 8435 |
|
| 8436 |
|
| 8437 |
/* |
| 8438 |
** A pointer to a structure of the following type is passed as the first |
| 8439 |
** argument to callbacks registered using rtree_geometry_callback(). |
| 8440 |
*/ |
| 8441 |
struct sqlite3_rtree_geometry { |
| 8442 |
void *pContext; /* Copy of pContext passed to s_r_g_c() */ |
| 8443 |
int nParam; /* Size of array aParam[] */ |
| 8444 |
sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */ |
| 8445 |
void *pUser; /* Callback implementation user data */ |
| 8446 |
void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ |
| 8447 |
}; |
| 8448 |
|
| 8449 |
/* |
| 8450 |
** Register a 2nd-generation geometry callback named zScore that can be |
| 8451 |
** used as part of an R-Tree geometry query as follows: |
| 8452 |
** |
| 8453 |
** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...) |
| 8454 |
*/ |
| 8455 |
SQLITE_API int sqlite3_rtree_query_callback( |
| 8456 |
sqlite3 *db, |
| 8457 |
const char *zQueryFunc, |
| 8458 |
int (*xQueryFunc)(sqlite3_rtree_query_info*), |
| 8459 |
void *pContext, |
| 8460 |
void (*xDestructor)(void*) |
| 8461 |
); |
| 8462 |
|
| 8463 |
|
| 8464 |
/* |
| 8465 |
** A pointer to a structure of the following type is passed as the |
| 8466 |
** argument to scored geometry callback registered using |
| 8467 |
** sqlite3_rtree_query_callback(). |
| 8468 |
** |
| 8469 |
** Note that the first 5 fields of this structure are identical to |
| 8470 |
** sqlite3_rtree_geometry. This structure is a subclass of |
| 8471 |
** sqlite3_rtree_geometry. |
| 8472 |
*/ |
| 8473 |
struct sqlite3_rtree_query_info { |
| 8474 |
void *pContext; /* pContext from when function registered */ |
| 8475 |
int nParam; /* Number of function parameters */ |
| 8476 |
sqlite3_rtree_dbl *aParam; /* value of function parameters */ |
| 8477 |
void *pUser; /* callback can use this, if desired */ |
| 8478 |
void (*xDelUser)(void*); /* function to free pUser */ |
| 8479 |
sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */ |
| 8480 |
unsigned int *anQueue; /* Number of pending entries in the queue */ |
| 8481 |
int nCoord; /* Number of coordinates */ |
| 8482 |
int iLevel; /* Level of current node or entry */ |
| 8483 |
int mxLevel; /* The largest iLevel value in the tree */ |
| 8484 |
sqlite3_int64 iRowid; /* Rowid for current entry */ |
| 8485 |
sqlite3_rtree_dbl rParentScore; /* Score of parent node */ |
| 8486 |
int eParentWithin; /* Visibility of parent node */ |
| 8487 |
int eWithin; /* OUT: Visiblity */ |
| 8488 |
sqlite3_rtree_dbl rScore; /* OUT: Write the score here */ |
| 8489 |
/* The following fields are only available in 3.8.11 and later */ |
| 8490 |
sqlite3_value **apSqlParam; /* Original SQL values of parameters */ |
| 8491 |
}; |
| 8492 |
|
| 8493 |
/* |
| 8494 |
** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin. |
| 8495 |
*/ |
| 8496 |
#define NOT_WITHIN 0 /* Object completely outside of query region */ |
| 8497 |
#define PARTLY_WITHIN 1 /* Object partially overlaps query region */ |
| 8498 |
#define FULLY_WITHIN 2 /* Object fully contained within query region */ |
| 8499 |
|
| 8500 |
|
| 8501 |
#ifdef __cplusplus |
| 8502 |
} /* end of the 'extern "C"' block */ |
| 8503 |
#endif |
| 8504 |
|
| 8505 |
#endif /* ifndef _SQLITE3RTREE_H_ */ |
| 8506 |
|
| 8507 |
/******** End of sqlite3rtree.h *********/ |
| 8508 |
/******** Begin file sqlite3session.h *********/ |
| 8509 |
|
| 8510 |
#if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) |
| 8511 |
#define __SQLITESESSION_H_ 1 |
| 8512 |
|
| 8513 |
/* |
| 8514 |
** Make sure we can call this stuff from C++. |
| 8515 |
*/ |
| 8516 |
#ifdef __cplusplus |
| 8517 |
extern "C" { |
| 8518 |
#endif |
| 8519 |
|
| 8520 |
|
| 8521 |
/* |
| 8522 |
** CAPI3REF: Session Object Handle |
| 8523 |
*/ |
| 8524 |
typedef struct sqlite3_session sqlite3_session; |
| 8525 |
|
| 8526 |
/* |
| 8527 |
** CAPI3REF: Changeset Iterator Handle |
| 8528 |
*/ |
| 8529 |
typedef struct sqlite3_changeset_iter sqlite3_changeset_iter; |
| 8530 |
|
| 8531 |
/* |
| 8532 |
** CAPI3REF: Create A New Session Object |
| 8533 |
** |
| 8534 |
** Create a new session object attached to database handle db. If successful, |
| 8535 |
** a pointer to the new object is written to *ppSession and SQLITE_OK is |
| 8536 |
** returned. If an error occurs, *ppSession is set to NULL and an SQLite |
| 8537 |
** error code (e.g. SQLITE_NOMEM) is returned. |
| 8538 |
** |
| 8539 |
** It is possible to create multiple session objects attached to a single |
| 8540 |
** database handle. |
| 8541 |
** |
| 8542 |
** Session objects created using this function should be deleted using the |
| 8543 |
** [sqlite3session_delete()] function before the database handle that they |
| 8544 |
** are attached to is itself closed. If the database handle is closed before |
| 8545 |
** the session object is deleted, then the results of calling any session |
| 8546 |
** module function, including [sqlite3session_delete()] on the session object |
| 8547 |
** are undefined. |
| 8548 |
** |
| 8549 |
** Because the session module uses the [sqlite3_preupdate_hook()] API, it |
| 8550 |
** is not possible for an application to register a pre-update hook on a |
| 8551 |
** database handle that has one or more session objects attached. Nor is |
| 8552 |
** it possible to create a session object attached to a database handle for |
| 8553 |
** which a pre-update hook is already defined. The results of attempting |
| 8554 |
** either of these things are undefined. |
| 8555 |
** |
| 8556 |
** The session object will be used to create changesets for tables in |
| 8557 |
** database zDb, where zDb is either "main", or "temp", or the name of an |
| 8558 |
** attached database. It is not an error if database zDb is not attached |
| 8559 |
** to the database when the session object is created. |
| 8560 |
*/ |
| 8561 |
int sqlite3session_create( |
| 8562 |
sqlite3 *db, /* Database handle */ |
| 8563 |
const char *zDb, /* Name of db (e.g. "main") */ |
| 8564 |
sqlite3_session **ppSession /* OUT: New session object */ |
| 8565 |
); |
| 8566 |
|
| 8567 |
/* |
| 8568 |
** CAPI3REF: Delete A Session Object |
| 8569 |
** |
| 8570 |
** Delete a session object previously allocated using |
| 8571 |
** [sqlite3session_create()]. Once a session object has been deleted, the |
| 8572 |
** results of attempting to use pSession with any other session module |
| 8573 |
** function are undefined. |
| 8574 |
** |
| 8575 |
** Session objects must be deleted before the database handle to which they |
| 8576 |
** are attached is closed. Refer to the documentation for |
| 8577 |
** [sqlite3session_create()] for details. |
| 8578 |
*/ |
| 8579 |
void sqlite3session_delete(sqlite3_session *pSession); |
| 8580 |
|
| 8581 |
|
| 8582 |
/* |
| 8583 |
** CAPI3REF: Enable Or Disable A Session Object |
| 8584 |
** |
| 8585 |
** Enable or disable the recording of changes by a session object. When |
| 8586 |
** enabled, a session object records changes made to the database. When |
| 8587 |
** disabled - it does not. A newly created session object is enabled. |
| 8588 |
** Refer to the documentation for [sqlite3session_changeset()] for further |
| 8589 |
** details regarding how enabling and disabling a session object affects |
| 8590 |
** the eventual changesets. |
| 8591 |
** |
| 8592 |
** Passing zero to this function disables the session. Passing a value |
| 8593 |
** greater than zero enables it. Passing a value less than zero is a |
| 8594 |
** no-op, and may be used to query the current state of the session. |
| 8595 |
** |
| 8596 |
** The return value indicates the final state of the session object: 0 if |
| 8597 |
** the session is disabled, or 1 if it is enabled. |
| 8598 |
*/ |
| 8599 |
int sqlite3session_enable(sqlite3_session *pSession, int bEnable); |
| 8600 |
|
| 8601 |
/* |
| 8602 |
** CAPI3REF: Set Or Clear the Indirect Change Flag |
| 8603 |
** |
| 8604 |
** Each change recorded by a session object is marked as either direct or |
| 8605 |
** indirect. A change is marked as indirect if either: |
| 8606 |
** |
| 8607 |
** <ul> |
| 8608 |
** <li> The session object "indirect" flag is set when the change is |
| 8609 |
** made, or |
| 8610 |
** <li> The change is made by an SQL trigger or foreign key action |
| 8611 |
** instead of directly as a result of a users SQL statement. |
| 8612 |
** </ul> |
| 8613 |
** |
| 8614 |
** If a single row is affected by more than one operation within a session, |
| 8615 |
** then the change is considered indirect if all operations meet the criteria |
| 8616 |
** for an indirect change above, or direct otherwise. |
| 8617 |
** |
| 8618 |
** This function is used to set, clear or query the session object indirect |
| 8619 |
** flag. If the second argument passed to this function is zero, then the |
| 8620 |
** indirect flag is cleared. If it is greater than zero, the indirect flag |
| 8621 |
** is set. Passing a value less than zero does not modify the current value |
| 8622 |
** of the indirect flag, and may be used to query the current state of the |
| 8623 |
** indirect flag for the specified session object. |
| 8624 |
** |
| 8625 |
** The return value indicates the final state of the indirect flag: 0 if |
| 8626 |
** it is clear, or 1 if it is set. |
| 8627 |
*/ |
| 8628 |
int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect); |
| 8629 |
|
| 8630 |
/* |
| 8631 |
** CAPI3REF: Attach A Table To A Session Object |
| 8632 |
** |
| 8633 |
** If argument zTab is not NULL, then it is the name of a table to attach |
| 8634 |
** to the session object passed as the first argument. All subsequent changes |
| 8635 |
** made to the table while the session object is enabled will be recorded. See |
| 8636 |
** documentation for [sqlite3session_changeset()] for further details. |
| 8637 |
** |
| 8638 |
** Or, if argument zTab is NULL, then changes are recorded for all tables |
| 8639 |
** in the database. If additional tables are added to the database (by |
| 8640 |
** executing "CREATE TABLE" statements) after this call is made, changes for |
| 8641 |
** the new tables are also recorded. |
| 8642 |
** |
| 8643 |
** Changes can only be recorded for tables that have a PRIMARY KEY explicitly |
| 8644 |
** defined as part of their CREATE TABLE statement. It does not matter if the |
| 8645 |
** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY |
| 8646 |
** KEY may consist of a single column, or may be a composite key. |
| 8647 |
** |
| 8648 |
** It is not an error if the named table does not exist in the database. Nor |
| 8649 |
** is it an error if the named table does not have a PRIMARY KEY. However, |
| 8650 |
** no changes will be recorded in either of these scenarios. |
| 8651 |
** |
| 8652 |
** Changes are not recorded for individual rows that have NULL values stored |
| 8653 |
** in one or more of their PRIMARY KEY columns. |
| 8654 |
** |
| 8655 |
** SQLITE_OK is returned if the call completes without error. Or, if an error |
| 8656 |
** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned. |
| 8657 |
*/ |
| 8658 |
int sqlite3session_attach( |
| 8659 |
sqlite3_session *pSession, /* Session object */ |
| 8660 |
const char *zTab /* Table name */ |
| 8661 |
); |
| 8662 |
|
| 8663 |
/* |
| 8664 |
** CAPI3REF: Set a table filter on a Session Object. |
| 8665 |
** |
| 8666 |
** The second argument (xFilter) is the "filter callback". For changes to rows |
| 8667 |
** in tables that are not attached to the Session object, the filter is called |
| 8668 |
** to determine whether changes to the table's rows should be tracked or not. |
| 8669 |
** If xFilter returns 0, changes is not tracked. Note that once a table is |
| 8670 |
** attached, xFilter will not be called again. |
| 8671 |
*/ |
| 8672 |
void sqlite3session_table_filter( |
| 8673 |
sqlite3_session *pSession, /* Session object */ |
| 8674 |
int(*xFilter)( |
| 8675 |
void *pCtx, /* Copy of third arg to _filter_table() */ |
| 8676 |
const char *zTab /* Table name */ |
| 8677 |
), |
| 8678 |
void *pCtx /* First argument passed to xFilter */ |
| 8679 |
); |
| 8680 |
|
| 8681 |
/* |
| 8682 |
** CAPI3REF: Generate A Changeset From A Session Object |
| 8683 |
** |
| 8684 |
** Obtain a changeset containing changes to the tables attached to the |
| 8685 |
** session object passed as the first argument. If successful, |
| 8686 |
** set *ppChangeset to point to a buffer containing the changeset |
| 8687 |
** and *pnChangeset to the size of the changeset in bytes before returning |
| 8688 |
** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to |
| 8689 |
** zero and return an SQLite error code. |
| 8690 |
** |
| 8691 |
** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes, |
| 8692 |
** each representing a change to a single row of an attached table. An INSERT |
| 8693 |
** change contains the values of each field of a new database row. A DELETE |
| 8694 |
** contains the original values of each field of a deleted database row. An |
| 8695 |
** UPDATE change contains the original values of each field of an updated |
| 8696 |
** database row along with the updated values for each updated non-primary-key |
| 8697 |
** column. It is not possible for an UPDATE change to represent a change that |
| 8698 |
** modifies the values of primary key columns. If such a change is made, it |
| 8699 |
** is represented in a changeset as a DELETE followed by an INSERT. |
| 8700 |
** |
| 8701 |
** Changes are not recorded for rows that have NULL values stored in one or |
| 8702 |
** more of their PRIMARY KEY columns. If such a row is inserted or deleted, |
| 8703 |
** no corresponding change is present in the changesets returned by this |
| 8704 |
** function. If an existing row with one or more NULL values stored in |
| 8705 |
** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL, |
| 8706 |
** only an INSERT is appears in the changeset. Similarly, if an existing row |
| 8707 |
** with non-NULL PRIMARY KEY values is updated so that one or more of its |
| 8708 |
** PRIMARY KEY columns are set to NULL, the resulting changeset contains a |
| 8709 |
** DELETE change only. |
| 8710 |
** |
| 8711 |
** The contents of a changeset may be traversed using an iterator created |
| 8712 |
** using the [sqlite3changeset_start()] API. A changeset may be applied to |
| 8713 |
** a database with a compatible schema using the [sqlite3changeset_apply()] |
| 8714 |
** API. |
| 8715 |
** |
| 8716 |
** Within a changeset generated by this function, all changes related to a |
| 8717 |
** single table are grouped together. In other words, when iterating through |
| 8718 |
** a changeset or when applying a changeset to a database, all changes related |
| 8719 |
** to a single table are processed before moving on to the next table. Tables |
| 8720 |
** are sorted in the same order in which they were attached (or auto-attached) |
| 8721 |
** to the sqlite3_session object. The order in which the changes related to |
| 8722 |
** a single table are stored is undefined. |
| 8723 |
** |
| 8724 |
** Following a successful call to this function, it is the responsibility of |
| 8725 |
** the caller to eventually free the buffer that *ppChangeset points to using |
| 8726 |
** [sqlite3_free()]. |
| 8727 |
** |
| 8728 |
** <h3>Changeset Generation</h3> |
| 8729 |
** |
| 8730 |
** Once a table has been attached to a session object, the session object |
| 8731 |
** records the primary key values of all new rows inserted into the table. |
| 8732 |
** It also records the original primary key and other column values of any |
| 8733 |
** deleted or updated rows. For each unique primary key value, data is only |
| 8734 |
** recorded once - the first time a row with said primary key is inserted, |
| 8735 |
** updated or deleted in the lifetime of the session. |
| 8736 |
** |
| 8737 |
** There is one exception to the previous paragraph: when a row is inserted, |
| 8738 |
** updated or deleted, if one or more of its primary key columns contain a |
| 8739 |
** NULL value, no record of the change is made. |
| 8740 |
** |
| 8741 |
** The session object therefore accumulates two types of records - those |
| 8742 |
** that consist of primary key values only (created when the user inserts |
| 8743 |
** a new record) and those that consist of the primary key values and the |
| 8744 |
** original values of other table columns (created when the users deletes |
| 8745 |
** or updates a record). |
| 8746 |
** |
| 8747 |
** When this function is called, the requested changeset is created using |
| 8748 |
** both the accumulated records and the current contents of the database |
| 8749 |
** file. Specifically: |
| 8750 |
** |
| 8751 |
** <ul> |
| 8752 |
** <li> For each record generated by an insert, the database is queried |
| 8753 |
** for a row with a matching primary key. If one is found, an INSERT |
| 8754 |
** change is added to the changeset. If no such row is found, no change |
| 8755 |
** is added to the changeset. |
| 8756 |
** |
| 8757 |
** <li> For each record generated by an update or delete, the database is |
| 8758 |
** queried for a row with a matching primary key. If such a row is |
| 8759 |
** found and one or more of the non-primary key fields have been |
| 8760 |
** modified from their original values, an UPDATE change is added to |
| 8761 |
** the changeset. Or, if no such row is found in the table, a DELETE |
| 8762 |
** change is added to the changeset. If there is a row with a matching |
| 8763 |
** primary key in the database, but all fields contain their original |
| 8764 |
** values, no change is added to the changeset. |
| 8765 |
** </ul> |
| 8766 |
** |
| 8767 |
** This means, amongst other things, that if a row is inserted and then later |
| 8768 |
** deleted while a session object is active, neither the insert nor the delete |
| 8769 |
** will be present in the changeset. Or if a row is deleted and then later a |
| 8770 |
** row with the same primary key values inserted while a session object is |
| 8771 |
** active, the resulting changeset will contain an UPDATE change instead of |
| 8772 |
** a DELETE and an INSERT. |
| 8773 |
** |
| 8774 |
** When a session object is disabled (see the [sqlite3session_enable()] API), |
| 8775 |
** it does not accumulate records when rows are inserted, updated or deleted. |
| 8776 |
** This may appear to have some counter-intuitive effects if a single row |
| 8777 |
** is written to more than once during a session. For example, if a row |
| 8778 |
** is inserted while a session object is enabled, then later deleted while |
| 8779 |
** the same session object is disabled, no INSERT record will appear in the |
| 8780 |
** changeset, even though the delete took place while the session was disabled. |
| 8781 |
** Or, if one field of a row is updated while a session is disabled, and |
| 8782 |
** another field of the same row is updated while the session is enabled, the |
| 8783 |
** resulting changeset will contain an UPDATE change that updates both fields. |
| 8784 |
*/ |
| 8785 |
int sqlite3session_changeset( |
| 8786 |
sqlite3_session *pSession, /* Session object */ |
| 8787 |
int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */ |
| 8788 |
void **ppChangeset /* OUT: Buffer containing changeset */ |
| 8789 |
); |
| 8790 |
|
| 8791 |
/* |
| 8792 |
** CAPI3REF: Load The Difference Between Tables Into A Session |
| 8793 |
** |
| 8794 |
** If it is not already attached to the session object passed as the first |
| 8795 |
** argument, this function attaches table zTbl in the same manner as the |
| 8796 |
** [sqlite3session_attach()] function. If zTbl does not exist, or if it |
| 8797 |
** does not have a primary key, this function is a no-op (but does not return |
| 8798 |
** an error). |
| 8799 |
** |
| 8800 |
** Argument zFromDb must be the name of a database ("main", "temp" etc.) |
| 8801 |
** attached to the same database handle as the session object that contains |
| 8802 |
** a table compatible with the table attached to the session by this function. |
| 8803 |
** A table is considered compatible if it: |
| 8804 |
** |
| 8805 |
** <ul> |
| 8806 |
** <li> Has the same name, |
| 8807 |
** <li> Has the same set of columns declared in the same order, and |
| 8808 |
** <li> Has the same PRIMARY KEY definition. |
| 8809 |
** </ul> |
| 8810 |
** |
| 8811 |
** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables |
| 8812 |
** are compatible but do not have any PRIMARY KEY columns, it is not an error |
| 8813 |
** but no changes are added to the session object. As with other session |
| 8814 |
** APIs, tables without PRIMARY KEYs are simply ignored. |
| 8815 |
** |
| 8816 |
** This function adds a set of changes to the session object that could be |
| 8817 |
** used to update the table in database zFrom (call this the "from-table") |
| 8818 |
** so that its content is the same as the table attached to the session |
| 8819 |
** object (call this the "to-table"). Specifically: |
| 8820 |
** |
| 8821 |
** <ul> |
| 8822 |
** <li> For each row (primary key) that exists in the to-table but not in |
| 8823 |
** the from-table, an INSERT record is added to the session object. |
| 8824 |
** |
| 8825 |
** <li> For each row (primary key) that exists in the to-table but not in |
| 8826 |
** the from-table, a DELETE record is added to the session object. |
| 8827 |
** |
| 8828 |
** <li> For each row (primary key) that exists in both tables, but features |
| 8829 |
** different in each, an UPDATE record is added to the session. |
| 8830 |
** </ul> |
| 8831 |
** |
| 8832 |
** To clarify, if this function is called and then a changeset constructed |
| 8833 |
** using [sqlite3session_changeset()], then after applying that changeset to |
| 8834 |
** database zFrom the contents of the two compatible tables would be |
| 8835 |
** identical. |
| 8836 |
** |
| 8837 |
** It an error if database zFrom does not exist or does not contain the |
| 8838 |
** required compatible table. |
| 8839 |
** |
| 8840 |
** If the operation successful, SQLITE_OK is returned. Otherwise, an SQLite |
| 8841 |
** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg |
| 8842 |
** may be set to point to a buffer containing an English language error |
| 8843 |
** message. It is the responsibility of the caller to free this buffer using |
| 8844 |
** sqlite3_free(). |
| 8845 |
*/ |
| 8846 |
int sqlite3session_diff( |
| 8847 |
sqlite3_session *pSession, |
| 8848 |
const char *zFromDb, |
| 8849 |
const char *zTbl, |
| 8850 |
char **pzErrMsg |
| 8851 |
); |
| 8852 |
|
| 8853 |
|
| 8854 |
/* |
| 8855 |
** CAPI3REF: Generate A Patchset From A Session Object |
| 8856 |
** |
| 8857 |
** The differences between a patchset and a changeset are that: |
| 8858 |
** |
| 8859 |
** <ul> |
| 8860 |
** <li> DELETE records consist of the primary key fields only. The |
| 8861 |
** original values of other fields are omitted. |
| 8862 |
** <li> The original values of any modified fields are omitted from |
| 8863 |
** UPDATE records. |
| 8864 |
** </ul> |
| 8865 |
** |
| 8866 |
** A patchset blob may be used with up to date versions of all |
| 8867 |
** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(), |
| 8868 |
** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly, |
| 8869 |
** attempting to use a patchset blob with old versions of the |
| 8870 |
** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error. |
| 8871 |
** |
| 8872 |
** Because the non-primary key "old.*" fields are omitted, no |
| 8873 |
** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset |
| 8874 |
** is passed to the sqlite3changeset_apply() API. Other conflict types work |
| 8875 |
** in the same way as for changesets. |
| 8876 |
** |
| 8877 |
** Changes within a patchset are ordered in the same way as for changesets |
| 8878 |
** generated by the sqlite3session_changeset() function (i.e. all changes for |
| 8879 |
** a single table are grouped together, tables appear in the order in which |
| 8880 |
** they were attached to the session object). |
| 8881 |
*/ |
| 8882 |
int sqlite3session_patchset( |
| 8883 |
sqlite3_session *pSession, /* Session object */ |
| 8884 |
int *pnPatchset, /* OUT: Size of buffer at *ppChangeset */ |
| 8885 |
void **ppPatchset /* OUT: Buffer containing changeset */ |
| 8886 |
); |
| 8887 |
|
| 8888 |
/* |
| 8889 |
** CAPI3REF: Test if a changeset has recorded any changes. |
| 8890 |
** |
| 8891 |
** Return non-zero if no changes to attached tables have been recorded by |
| 8892 |
** the session object passed as the first argument. Otherwise, if one or |
| 8893 |
** more changes have been recorded, return zero. |
| 8894 |
** |
| 8895 |
** Even if this function returns zero, it is possible that calling |
| 8896 |
** [sqlite3session_changeset()] on the session handle may still return a |
| 8897 |
** changeset that contains no changes. This can happen when a row in |
| 8898 |
** an attached table is modified and then later on the original values |
| 8899 |
** are restored. However, if this function returns non-zero, then it is |
| 8900 |
** guaranteed that a call to sqlite3session_changeset() will return a |
| 8901 |
** changeset containing zero changes. |
| 8902 |
*/ |
| 8903 |
int sqlite3session_isempty(sqlite3_session *pSession); |
| 8904 |
|
| 8905 |
/* |
| 8906 |
** CAPI3REF: Create An Iterator To Traverse A Changeset |
| 8907 |
** |
| 8908 |
** Create an iterator used to iterate through the contents of a changeset. |
| 8909 |
** If successful, *pp is set to point to the iterator handle and SQLITE_OK |
| 8910 |
** is returned. Otherwise, if an error occurs, *pp is set to zero and an |
| 8911 |
** SQLite error code is returned. |
| 8912 |
** |
| 8913 |
** The following functions can be used to advance and query a changeset |
| 8914 |
** iterator created by this function: |
| 8915 |
** |
| 8916 |
** <ul> |
| 8917 |
** <li> [sqlite3changeset_next()] |
| 8918 |
** <li> [sqlite3changeset_op()] |
| 8919 |
** <li> [sqlite3changeset_new()] |
| 8920 |
** <li> [sqlite3changeset_old()] |
| 8921 |
** </ul> |
| 8922 |
** |
| 8923 |
** It is the responsibility of the caller to eventually destroy the iterator |
| 8924 |
** by passing it to [sqlite3changeset_finalize()]. The buffer containing the |
| 8925 |
** changeset (pChangeset) must remain valid until after the iterator is |
| 8926 |
** destroyed. |
| 8927 |
** |
| 8928 |
** Assuming the changeset blob was created by one of the |
| 8929 |
** [sqlite3session_changeset()], [sqlite3changeset_concat()] or |
| 8930 |
** [sqlite3changeset_invert()] functions, all changes within the changeset |
| 8931 |
** that apply to a single table are grouped together. This means that when |
| 8932 |
** an application iterates through a changeset using an iterator created by |
| 8933 |
** this function, all changes that relate to a single table are visited |
| 8934 |
** consecutively. There is no chance that the iterator will visit a change |
| 8935 |
** the applies to table X, then one for table Y, and then later on visit |
| 8936 |
** another change for table X. |
| 8937 |
*/ |
| 8938 |
int sqlite3changeset_start( |
| 8939 |
sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */ |
| 8940 |
int nChangeset, /* Size of changeset blob in bytes */ |
| 8941 |
void *pChangeset /* Pointer to blob containing changeset */ |
| 8942 |
); |
| 8943 |
|
| 8944 |
|
| 8945 |
/* |
| 8946 |
** CAPI3REF: Advance A Changeset Iterator |
| 8947 |
** |
| 8948 |
** This function may only be used with iterators created by function |
| 8949 |
** [sqlite3changeset_start()]. If it is called on an iterator passed to |
| 8950 |
** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE |
| 8951 |
** is returned and the call has no effect. |
| 8952 |
** |
| 8953 |
** Immediately after an iterator is created by sqlite3changeset_start(), it |
| 8954 |
** does not point to any change in the changeset. Assuming the changeset |
| 8955 |
** is not empty, the first call to this function advances the iterator to |
| 8956 |
** point to the first change in the changeset. Each subsequent call advances |
| 8957 |
** the iterator to point to the next change in the changeset (if any). If |
| 8958 |
** no error occurs and the iterator points to a valid change after a call |
| 8959 |
** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned. |
| 8960 |
** Otherwise, if all changes in the changeset have already been visited, |
| 8961 |
** SQLITE_DONE is returned. |
| 8962 |
** |
| 8963 |
** If an error occurs, an SQLite error code is returned. Possible error |
| 8964 |
** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or |
| 8965 |
** SQLITE_NOMEM. |
| 8966 |
*/ |
| 8967 |
int sqlite3changeset_next(sqlite3_changeset_iter *pIter); |
| 8968 |
|
| 8969 |
/* |
| 8970 |
** CAPI3REF: Obtain The Current Operation From A Changeset Iterator |
| 8971 |
** |
| 8972 |
** The pIter argument passed to this function may either be an iterator |
| 8973 |
** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator |
| 8974 |
** created by [sqlite3changeset_start()]. In the latter case, the most recent |
| 8975 |
** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this |
| 8976 |
** is not the case, this function returns [SQLITE_MISUSE]. |
| 8977 |
** |
| 8978 |
** If argument pzTab is not NULL, then *pzTab is set to point to a |
| 8979 |
** nul-terminated utf-8 encoded string containing the name of the table |
| 8980 |
** affected by the current change. The buffer remains valid until either |
| 8981 |
** sqlite3changeset_next() is called on the iterator or until the |
| 8982 |
** conflict-handler function returns. If pnCol is not NULL, then *pnCol is |
| 8983 |
** set to the number of columns in the table affected by the change. If |
| 8984 |
** pbIncorrect is not NULL, then *pbIndirect is set to true (1) if the change |
| 8985 |
** is an indirect change, or false (0) otherwise. See the documentation for |
| 8986 |
** [sqlite3session_indirect()] for a description of direct and indirect |
| 8987 |
** changes. Finally, if pOp is not NULL, then *pOp is set to one of |
| 8988 |
** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the |
| 8989 |
** type of change that the iterator currently points to. |
| 8990 |
** |
| 8991 |
** If no error occurs, SQLITE_OK is returned. If an error does occur, an |
| 8992 |
** SQLite error code is returned. The values of the output variables may not |
| 8993 |
** be trusted in this case. |
| 8994 |
*/ |
| 8995 |
int sqlite3changeset_op( |
| 8996 |
sqlite3_changeset_iter *pIter, /* Iterator object */ |
| 8997 |
const char **pzTab, /* OUT: Pointer to table name */ |
| 8998 |
int *pnCol, /* OUT: Number of columns in table */ |
| 8999 |
int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */ |
| 9000 |
int *pbIndirect /* OUT: True for an 'indirect' change */ |
| 9001 |
); |
| 9002 |
|
| 9003 |
/* |
| 9004 |
** CAPI3REF: Obtain The Primary Key Definition Of A Table |
| 9005 |
** |
| 9006 |
** For each modified table, a changeset includes the following: |
| 9007 |
** |
| 9008 |
** <ul> |
| 9009 |
** <li> The number of columns in the table, and |
| 9010 |
** <li> Which of those columns make up the tables PRIMARY KEY. |
| 9011 |
** </ul> |
| 9012 |
** |
| 9013 |
** This function is used to find which columns comprise the PRIMARY KEY of |
| 9014 |
** the table modified by the change that iterator pIter currently points to. |
| 9015 |
** If successful, *pabPK is set to point to an array of nCol entries, where |
| 9016 |
** nCol is the number of columns in the table. Elements of *pabPK are set to |
| 9017 |
** 0x01 if the corresponding column is part of the tables primary key, or |
| 9018 |
** 0x00 if it is not. |
| 9019 |
** |
| 9020 |
** If argument pnCol is not NULL, then *pnCol is set to the number of columns |
| 9021 |
** in the table. |
| 9022 |
** |
| 9023 |
** If this function is called when the iterator does not point to a valid |
| 9024 |
** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise, |
| 9025 |
** SQLITE_OK is returned and the output variables populated as described |
| 9026 |
** above. |
| 9027 |
*/ |
| 9028 |
int sqlite3changeset_pk( |
| 9029 |
sqlite3_changeset_iter *pIter, /* Iterator object */ |
| 9030 |
unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */ |
| 9031 |
int *pnCol /* OUT: Number of entries in output array */ |
| 9032 |
); |
| 9033 |
|
| 9034 |
/* |
| 9035 |
** CAPI3REF: Obtain old.* Values From A Changeset Iterator |
| 9036 |
** |
| 9037 |
** The pIter argument passed to this function may either be an iterator |
| 9038 |
** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator |
| 9039 |
** created by [sqlite3changeset_start()]. In the latter case, the most recent |
| 9040 |
** call to [sqlite3changeset_next()] must have returned SQLITE_ROW. |
| 9041 |
** Furthermore, it may only be called if the type of change that the iterator |
| 9042 |
** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise, |
| 9043 |
** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. |
| 9044 |
** |
| 9045 |
** Argument iVal must be greater than or equal to 0, and less than the number |
| 9046 |
** of columns in the table affected by the current change. Otherwise, |
| 9047 |
** [SQLITE_RANGE] is returned and *ppValue is set to NULL. |
| 9048 |
** |
| 9049 |
** If successful, this function sets *ppValue to point to a protected |
| 9050 |
** sqlite3_value object containing the iVal'th value from the vector of |
| 9051 |
** original row values stored as part of the UPDATE or DELETE change and |
| 9052 |
** returns SQLITE_OK. The name of the function comes from the fact that this |
| 9053 |
** is similar to the "old.*" columns available to update or delete triggers. |
| 9054 |
** |
| 9055 |
** If some other error occurs (e.g. an OOM condition), an SQLite error code |
| 9056 |
** is returned and *ppValue is set to NULL. |
| 9057 |
*/ |
| 9058 |
int sqlite3changeset_old( |
| 9059 |
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
| 9060 |
int iVal, /* Column number */ |
| 9061 |
sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */ |
| 9062 |
); |
| 9063 |
|
| 9064 |
/* |
| 9065 |
** CAPI3REF: Obtain new.* Values From A Changeset Iterator |
| 9066 |
** |
| 9067 |
** The pIter argument passed to this function may either be an iterator |
| 9068 |
** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator |
| 9069 |
** created by [sqlite3changeset_start()]. In the latter case, the most recent |
| 9070 |
** call to [sqlite3changeset_next()] must have returned SQLITE_ROW. |
| 9071 |
** Furthermore, it may only be called if the type of change that the iterator |
| 9072 |
** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise, |
| 9073 |
** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. |
| 9074 |
** |
| 9075 |
** Argument iVal must be greater than or equal to 0, and less than the number |
| 9076 |
** of columns in the table affected by the current change. Otherwise, |
| 9077 |
** [SQLITE_RANGE] is returned and *ppValue is set to NULL. |
| 9078 |
** |
| 9079 |
** If successful, this function sets *ppValue to point to a protected |
| 9080 |
** sqlite3_value object containing the iVal'th value from the vector of |
| 9081 |
** new row values stored as part of the UPDATE or INSERT change and |
| 9082 |
** returns SQLITE_OK. If the change is an UPDATE and does not include |
| 9083 |
** a new value for the requested column, *ppValue is set to NULL and |
| 9084 |
** SQLITE_OK returned. The name of the function comes from the fact that |
| 9085 |
** this is similar to the "new.*" columns available to update or delete |
| 9086 |
** triggers. |
| 9087 |
** |
| 9088 |
** If some other error occurs (e.g. an OOM condition), an SQLite error code |
| 9089 |
** is returned and *ppValue is set to NULL. |
| 9090 |
*/ |
| 9091 |
int sqlite3changeset_new( |
| 9092 |
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
| 9093 |
int iVal, /* Column number */ |
| 9094 |
sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */ |
| 9095 |
); |
| 9096 |
|
| 9097 |
/* |
| 9098 |
** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator |
| 9099 |
** |
| 9100 |
** This function should only be used with iterator objects passed to a |
| 9101 |
** conflict-handler callback by [sqlite3changeset_apply()] with either |
| 9102 |
** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function |
| 9103 |
** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue |
| 9104 |
** is set to NULL. |
| 9105 |
** |
| 9106 |
** Argument iVal must be greater than or equal to 0, and less than the number |
| 9107 |
** of columns in the table affected by the current change. Otherwise, |
| 9108 |
** [SQLITE_RANGE] is returned and *ppValue is set to NULL. |
| 9109 |
** |
| 9110 |
** If successful, this function sets *ppValue to point to a protected |
| 9111 |
** sqlite3_value object containing the iVal'th value from the |
| 9112 |
** "conflicting row" associated with the current conflict-handler callback |
| 9113 |
** and returns SQLITE_OK. |
| 9114 |
** |
| 9115 |
** If some other error occurs (e.g. an OOM condition), an SQLite error code |
| 9116 |
** is returned and *ppValue is set to NULL. |
| 9117 |
*/ |
| 9118 |
int sqlite3changeset_conflict( |
| 9119 |
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
| 9120 |
int iVal, /* Column number */ |
| 9121 |
sqlite3_value **ppValue /* OUT: Value from conflicting row */ |
| 9122 |
); |
| 9123 |
|
| 9124 |
/* |
| 9125 |
** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations |
| 9126 |
** |
| 9127 |
** This function may only be called with an iterator passed to an |
| 9128 |
** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case |
| 9129 |
** it sets the output variable to the total number of known foreign key |
| 9130 |
** violations in the destination database and returns SQLITE_OK. |
| 9131 |
** |
| 9132 |
** In all other cases this function returns SQLITE_MISUSE. |
| 9133 |
*/ |
| 9134 |
int sqlite3changeset_fk_conflicts( |
| 9135 |
sqlite3_changeset_iter *pIter, /* Changeset iterator */ |
| 9136 |
int *pnOut /* OUT: Number of FK violations */ |
| 9137 |
); |
| 9138 |
|
| 9139 |
|
| 9140 |
/* |
| 9141 |
** CAPI3REF: Finalize A Changeset Iterator |
| 9142 |
** |
| 9143 |
** This function is used to finalize an iterator allocated with |
| 9144 |
** [sqlite3changeset_start()]. |
| 9145 |
** |
| 9146 |
** This function should only be called on iterators created using the |
| 9147 |
** [sqlite3changeset_start()] function. If an application calls this |
| 9148 |
** function with an iterator passed to a conflict-handler by |
| 9149 |
** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the |
| 9150 |
** call has no effect. |
| 9151 |
** |
| 9152 |
** If an error was encountered within a call to an sqlite3changeset_xxx() |
| 9153 |
** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an |
| 9154 |
** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding |
| 9155 |
** to that error is returned by this function. Otherwise, SQLITE_OK is |
| 9156 |
** returned. This is to allow the following pattern (pseudo-code): |
| 9157 |
** |
| 9158 |
** sqlite3changeset_start(); |
| 9159 |
** while( SQLITE_ROW==sqlite3changeset_next() ){ |
| 9160 |
** // Do something with change. |
| 9161 |
** } |
| 9162 |
** rc = sqlite3changeset_finalize(); |
| 9163 |
** if( rc!=SQLITE_OK ){ |
| 9164 |
** // An error has occurred |
| 9165 |
** } |
| 9166 |
*/ |
| 9167 |
int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter); |
| 9168 |
|
| 9169 |
/* |
| 9170 |
** CAPI3REF: Invert A Changeset |
| 9171 |
** |
| 9172 |
** This function is used to "invert" a changeset object. Applying an inverted |
| 9173 |
** changeset to a database reverses the effects of applying the uninverted |
| 9174 |
** changeset. Specifically: |
| 9175 |
** |
| 9176 |
** <ul> |
| 9177 |
** <li> Each DELETE change is changed to an INSERT, and |
| 9178 |
** <li> Each INSERT change is changed to a DELETE, and |
| 9179 |
** <li> For each UPDATE change, the old.* and new.* values are exchanged. |
| 9180 |
** </ul> |
| 9181 |
** |
| 9182 |
** This function does not change the order in which changes appear within |
| 9183 |
** the changeset. It merely reverses the sense of each individual change. |
| 9184 |
** |
| 9185 |
** If successful, a pointer to a buffer containing the inverted changeset |
| 9186 |
** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and |
| 9187 |
** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are |
| 9188 |
** zeroed and an SQLite error code returned. |
| 9189 |
** |
| 9190 |
** It is the responsibility of the caller to eventually call sqlite3_free() |
| 9191 |
** on the *ppOut pointer to free the buffer allocation following a successful |
| 9192 |
** call to this function. |
| 9193 |
** |
| 9194 |
** WARNING/TODO: This function currently assumes that the input is a valid |
| 9195 |
** changeset. If it is not, the results are undefined. |
| 9196 |
*/ |
| 9197 |
int sqlite3changeset_invert( |
| 9198 |
int nIn, const void *pIn, /* Input changeset */ |
| 9199 |
int *pnOut, void **ppOut /* OUT: Inverse of input */ |
| 9200 |
); |
| 9201 |
|
| 9202 |
/* |
| 9203 |
** CAPI3REF: Concatenate Two Changeset Objects |
| 9204 |
** |
| 9205 |
** This function is used to concatenate two changesets, A and B, into a |
| 9206 |
** single changeset. The result is a changeset equivalent to applying |
| 9207 |
** changeset A followed by changeset B. |
| 9208 |
** |
| 9209 |
** This function combines the two input changesets using an |
| 9210 |
** sqlite3_changegroup object. Calling it produces similar results as the |
| 9211 |
** following code fragment: |
| 9212 |
** |
| 9213 |
** sqlite3_changegroup *pGrp; |
| 9214 |
** rc = sqlite3_changegroup_new(&pGrp); |
| 9215 |
** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA); |
| 9216 |
** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB); |
| 9217 |
** if( rc==SQLITE_OK ){ |
| 9218 |
** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut); |
| 9219 |
** }else{ |
| 9220 |
** *ppOut = 0; |
| 9221 |
** *pnOut = 0; |
| 9222 |
** } |
| 9223 |
** |
| 9224 |
** Refer to the sqlite3_changegroup documentation below for details. |
| 9225 |
*/ |
| 9226 |
int sqlite3changeset_concat( |
| 9227 |
int nA, /* Number of bytes in buffer pA */ |
| 9228 |
void *pA, /* Pointer to buffer containing changeset A */ |
| 9229 |
int nB, /* Number of bytes in buffer pB */ |
| 9230 |
void *pB, /* Pointer to buffer containing changeset B */ |
| 9231 |
int *pnOut, /* OUT: Number of bytes in output changeset */ |
| 9232 |
void **ppOut /* OUT: Buffer containing output changeset */ |
| 9233 |
); |
| 9234 |
|
| 9235 |
|
| 9236 |
/* |
| 9237 |
** CAPI3REF: Changegroup Handle |
| 9238 |
*/ |
| 9239 |
typedef struct sqlite3_changegroup sqlite3_changegroup; |
| 9240 |
|
| 9241 |
/* |
| 9242 |
** CAPI3REF: Create A New Changegroup Object |
| 9243 |
** |
| 9244 |
** An sqlite3_changegroup object is used to combine two or more changesets |
| 9245 |
** (or patchsets) into a single changeset (or patchset). A single changegroup |
| 9246 |
** object may combine changesets or patchsets, but not both. The output is |
| 9247 |
** always in the same format as the input. |
| 9248 |
** |
| 9249 |
** If successful, this function returns SQLITE_OK and populates (*pp) with |
| 9250 |
** a pointer to a new sqlite3_changegroup object before returning. The caller |
| 9251 |
** should eventually free the returned object using a call to |
| 9252 |
** sqlite3changegroup_delete(). If an error occurs, an SQLite error code |
| 9253 |
** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL. |
| 9254 |
** |
| 9255 |
** The usual usage pattern for an sqlite3_changegroup object is as follows: |
| 9256 |
** |
| 9257 |
** <ul> |
| 9258 |
** <li> It is created using a call to sqlite3changegroup_new(). |
| 9259 |
** |
| 9260 |
** <li> Zero or more changesets (or patchsets) are added to the object |
| 9261 |
** by calling sqlite3changegroup_add(). |
| 9262 |
** |
| 9263 |
** <li> The result of combining all input changesets together is obtained |
| 9264 |
** by the application via a call to sqlite3changegroup_output(). |
| 9265 |
** |
| 9266 |
** <li> The object is deleted using a call to sqlite3changegroup_delete(). |
| 9267 |
** </ul> |
| 9268 |
** |
| 9269 |
** Any number of calls to add() and output() may be made between the calls to |
| 9270 |
** new() and delete(), and in any order. |
| 9271 |
** |
| 9272 |
** As well as the regular sqlite3changegroup_add() and |
| 9273 |
** sqlite3changegroup_output() functions, also available are the streaming |
| 9274 |
** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm(). |
| 9275 |
*/ |
| 9276 |
int sqlite3changegroup_new(sqlite3_changegroup **pp); |
| 9277 |
|
| 9278 |
/* |
| 9279 |
** CAPI3REF: Add A Changeset To A Changegroup |
| 9280 |
** |
| 9281 |
** Add all changes within the changeset (or patchset) in buffer pData (size |
| 9282 |
** nData bytes) to the changegroup. |
| 9283 |
** |
| 9284 |
** If the buffer contains a patchset, then all prior calls to this function |
| 9285 |
** on the same changegroup object must also have specified patchsets. Or, if |
| 9286 |
** the buffer contains a changeset, so must have the earlier calls to this |
| 9287 |
** function. Otherwise, SQLITE_ERROR is returned and no changes are added |
| 9288 |
** to the changegroup. |
| 9289 |
** |
| 9290 |
** Rows within the changeset and changegroup are identified by the values in |
| 9291 |
** their PRIMARY KEY columns. A change in the changeset is considered to |
| 9292 |
** apply to the same row as a change already present in the changegroup if |
| 9293 |
** the two rows have the same primary key. |
| 9294 |
** |
| 9295 |
** Changes to rows that do not already appear in the changegroup are |
| 9296 |
** simply copied into it. Or, if both the new changeset and the changegroup |
| 9297 |
** contain changes that apply to a single row, the final contents of the |
| 9298 |
** changegroup depends on the type of each change, as follows: |
| 9299 |
** |
| 9300 |
** <table border=1 style="margin-left:8ex;margin-right:8ex"> |
| 9301 |
** <tr><th style="white-space:pre">Existing Change </th> |
| 9302 |
** <th style="white-space:pre">New Change </th> |
| 9303 |
** <th>Output Change |
| 9304 |
** <tr><td>INSERT <td>INSERT <td> |
| 9305 |
** The new change is ignored. This case does not occur if the new |
| 9306 |
** changeset was recorded immediately after the changesets already |
| 9307 |
** added to the changegroup. |
| 9308 |
** <tr><td>INSERT <td>UPDATE <td> |
| 9309 |
** The INSERT change remains in the changegroup. The values in the |
| 9310 |
** INSERT change are modified as if the row was inserted by the |
| 9311 |
** existing change and then updated according to the new change. |
| 9312 |
** <tr><td>INSERT <td>DELETE <td> |
| 9313 |
** The existing INSERT is removed from the changegroup. The DELETE is |
| 9314 |
** not added. |
| 9315 |
** <tr><td>UPDATE <td>INSERT <td> |
| 9316 |
** The new change is ignored. This case does not occur if the new |
| 9317 |
** changeset was recorded immediately after the changesets already |
| 9318 |
** added to the changegroup. |
| 9319 |
** <tr><td>UPDATE <td>UPDATE <td> |
| 9320 |
** The existing UPDATE remains within the changegroup. It is amended |
| 9321 |
** so that the accompanying values are as if the row was updated once |
| 9322 |
** by the existing change and then again by the new change. |
| 9323 |
** <tr><td>UPDATE <td>DELETE <td> |
| 9324 |
** The existing UPDATE is replaced by the new DELETE within the |
| 9325 |
** changegroup. |
| 9326 |
** <tr><td>DELETE <td>INSERT <td> |
| 9327 |
** If one or more of the column values in the row inserted by the |
| 9328 |
** new change differ from those in the row deleted by the existing |
| 9329 |
** change, the existing DELETE is replaced by an UPDATE within the |
| 9330 |
** changegroup. Otherwise, if the inserted row is exactly the same |
| 9331 |
** as the deleted row, the existing DELETE is simply discarded. |
| 9332 |
** <tr><td>DELETE <td>UPDATE <td> |
| 9333 |
** The new change is ignored. This case does not occur if the new |
| 9334 |
** changeset was recorded immediately after the changesets already |
| 9335 |
** added to the changegroup. |
| 9336 |
** <tr><td>DELETE <td>DELETE <td> |
| 9337 |
** The new change is ignored. This case does not occur if the new |
| 9338 |
** changeset was recorded immediately after the changesets already |
| 9339 |
** added to the changegroup. |
| 9340 |
** </table> |
| 9341 |
** |
| 9342 |
** If the new changeset contains changes to a table that is already present |
| 9343 |
** in the changegroup, then the number of columns and the position of the |
| 9344 |
** primary key columns for the table must be consistent. If this is not the |
| 9345 |
** case, this function fails with SQLITE_SCHEMA. If the input changeset |
| 9346 |
** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is |
| 9347 |
** returned. Or, if an out-of-memory condition occurs during processing, this |
| 9348 |
** function returns SQLITE_NOMEM. In all cases, if an error occurs the |
| 9349 |
** final contents of the changegroup is undefined. |
| 9350 |
** |
| 9351 |
** If no error occurs, SQLITE_OK is returned. |
| 9352 |
*/ |
| 9353 |
int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData); |
| 9354 |
|
| 9355 |
/* |
| 9356 |
** CAPI3REF: Obtain A Composite Changeset From A Changegroup |
| 9357 |
** |
| 9358 |
** Obtain a buffer containing a changeset (or patchset) representing the |
| 9359 |
** current contents of the changegroup. If the inputs to the changegroup |
| 9360 |
** were themselves changesets, the output is a changeset. Or, if the |
| 9361 |
** inputs were patchsets, the output is also a patchset. |
| 9362 |
** |
| 9363 |
** As with the output of the sqlite3session_changeset() and |
| 9364 |
** sqlite3session_patchset() functions, all changes related to a single |
| 9365 |
** table are grouped together in the output of this function. Tables appear |
| 9366 |
** in the same order as for the very first changeset added to the changegroup. |
| 9367 |
** If the second or subsequent changesets added to the changegroup contain |
| 9368 |
** changes for tables that do not appear in the first changeset, they are |
| 9369 |
** appended onto the end of the output changeset, again in the order in |
| 9370 |
** which they are first encountered. |
| 9371 |
** |
| 9372 |
** If an error occurs, an SQLite error code is returned and the output |
| 9373 |
** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK |
| 9374 |
** is returned and the output variables are set to the size of and a |
| 9375 |
** pointer to the output buffer, respectively. In this case it is the |
| 9376 |
** responsibility of the caller to eventually free the buffer using a |
| 9377 |
** call to sqlite3_free(). |
| 9378 |
*/ |
| 9379 |
int sqlite3changegroup_output( |
| 9380 |
sqlite3_changegroup*, |
| 9381 |
int *pnData, /* OUT: Size of output buffer in bytes */ |
| 9382 |
void **ppData /* OUT: Pointer to output buffer */ |
| 9383 |
); |
| 9384 |
|
| 9385 |
/* |
| 9386 |
** CAPI3REF: Delete A Changegroup Object |
| 9387 |
*/ |
| 9388 |
void sqlite3changegroup_delete(sqlite3_changegroup*); |
| 9389 |
|
| 9390 |
/* |
| 9391 |
** CAPI3REF: Apply A Changeset To A Database |
| 9392 |
** |
| 9393 |
** Apply a changeset to a database. This function attempts to update the |
| 9394 |
** "main" database attached to handle db with the changes found in the |
| 9395 |
** changeset passed via the second and third arguments. |
| 9396 |
** |
| 9397 |
** The fourth argument (xFilter) passed to this function is the "filter |
| 9398 |
** callback". If it is not NULL, then for each table affected by at least one |
| 9399 |
** change in the changeset, the filter callback is invoked with |
| 9400 |
** the table name as the second argument, and a copy of the context pointer |
| 9401 |
** passed as the sixth argument to this function as the first. If the "filter |
| 9402 |
** callback" returns zero, then no attempt is made to apply any changes to |
| 9403 |
** the table. Otherwise, if the return value is non-zero or the xFilter |
| 9404 |
** argument to this function is NULL, all changes related to the table are |
| 9405 |
** attempted. |
| 9406 |
** |
| 9407 |
** For each table that is not excluded by the filter callback, this function |
| 9408 |
** tests that the target database contains a compatible table. A table is |
| 9409 |
** considered compatible if all of the following are true: |
| 9410 |
** |
| 9411 |
** <ul> |
| 9412 |
** <li> The table has the same name as the name recorded in the |
| 9413 |
** changeset, and |
| 9414 |
** <li> The table has the same number of columns as recorded in the |
| 9415 |
** changeset, and |
| 9416 |
** <li> The table has primary key columns in the same position as |
| 9417 |
** recorded in the changeset. |
| 9418 |
** </ul> |
| 9419 |
** |
| 9420 |
** If there is no compatible table, it is not an error, but none of the |
| 9421 |
** changes associated with the table are applied. A warning message is issued |
| 9422 |
** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most |
| 9423 |
** one such warning is issued for each table in the changeset. |
| 9424 |
** |
| 9425 |
** For each change for which there is a compatible table, an attempt is made |
| 9426 |
** to modify the table contents according to the UPDATE, INSERT or DELETE |
| 9427 |
** change. If a change cannot be applied cleanly, the conflict handler |
| 9428 |
** function passed as the fifth argument to sqlite3changeset_apply() may be |
| 9429 |
** invoked. A description of exactly when the conflict handler is invoked for |
| 9430 |
** each type of change is below. |
| 9431 |
** |
| 9432 |
** Unlike the xFilter argument, xConflict may not be passed NULL. The results |
| 9433 |
** of passing anything other than a valid function pointer as the xConflict |
| 9434 |
** argument are undefined. |
| 9435 |
** |
| 9436 |
** Each time the conflict handler function is invoked, it must return one |
| 9437 |
** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or |
| 9438 |
** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned |
| 9439 |
** if the second argument passed to the conflict handler is either |
| 9440 |
** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler |
| 9441 |
** returns an illegal value, any changes already made are rolled back and |
| 9442 |
** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different |
| 9443 |
** actions are taken by sqlite3changeset_apply() depending on the value |
| 9444 |
** returned by each invocation of the conflict-handler function. Refer to |
| 9445 |
** the documentation for the three |
| 9446 |
** [SQLITE_CHANGESET_OMIT|available return values] for details. |
| 9447 |
** |
| 9448 |
** <dl> |
| 9449 |
** <dt>DELETE Changes<dd> |
| 9450 |
** For each DELETE change, this function checks if the target database |
| 9451 |
** contains a row with the same primary key value (or values) as the |
| 9452 |
** original row values stored in the changeset. If it does, and the values |
| 9453 |
** stored in all non-primary key columns also match the values stored in |
| 9454 |
** the changeset the row is deleted from the target database. |
| 9455 |
** |
| 9456 |
** If a row with matching primary key values is found, but one or more of |
| 9457 |
** the non-primary key fields contains a value different from the original |
| 9458 |
** row value stored in the changeset, the conflict-handler function is |
| 9459 |
** invoked with [SQLITE_CHANGESET_DATA] as the second argument. |
| 9460 |
** |
| 9461 |
** If no row with matching primary key values is found in the database, |
| 9462 |
** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] |
| 9463 |
** passed as the second argument. |
| 9464 |
** |
| 9465 |
** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT |
| 9466 |
** (which can only happen if a foreign key constraint is violated), the |
| 9467 |
** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT] |
| 9468 |
** passed as the second argument. This includes the case where the DELETE |
| 9469 |
** operation is attempted because an earlier call to the conflict handler |
| 9470 |
** function returned [SQLITE_CHANGESET_REPLACE]. |
| 9471 |
** |
| 9472 |
** <dt>INSERT Changes<dd> |
| 9473 |
** For each INSERT change, an attempt is made to insert the new row into |
| 9474 |
** the database. |
| 9475 |
** |
| 9476 |
** If the attempt to insert the row fails because the database already |
| 9477 |
** contains a row with the same primary key values, the conflict handler |
| 9478 |
** function is invoked with the second argument set to |
| 9479 |
** [SQLITE_CHANGESET_CONFLICT]. |
| 9480 |
** |
| 9481 |
** If the attempt to insert the row fails because of some other constraint |
| 9482 |
** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is |
| 9483 |
** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT]. |
| 9484 |
** This includes the case where the INSERT operation is re-attempted because |
| 9485 |
** an earlier call to the conflict handler function returned |
| 9486 |
** [SQLITE_CHANGESET_REPLACE]. |
| 9487 |
** |
| 9488 |
** <dt>UPDATE Changes<dd> |
| 9489 |
** For each UPDATE change, this function checks if the target database |
| 9490 |
** contains a row with the same primary key value (or values) as the |
| 9491 |
** original row values stored in the changeset. If it does, and the values |
| 9492 |
** stored in all non-primary key columns also match the values stored in |
| 9493 |
** the changeset the row is updated within the target database. |
| 9494 |
** |
| 9495 |
** If a row with matching primary key values is found, but one or more of |
| 9496 |
** the non-primary key fields contains a value different from an original |
| 9497 |
** row value stored in the changeset, the conflict-handler function is |
| 9498 |
** invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since |
| 9499 |
** UPDATE changes only contain values for non-primary key fields that are |
| 9500 |
** to be modified, only those fields need to match the original values to |
| 9501 |
** avoid the SQLITE_CHANGESET_DATA conflict-handler callback. |
| 9502 |
** |
| 9503 |
** If no row with matching primary key values is found in the database, |
| 9504 |
** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] |
| 9505 |
** passed as the second argument. |
| 9506 |
** |
| 9507 |
** If the UPDATE operation is attempted, but SQLite returns |
| 9508 |
** SQLITE_CONSTRAINT, the conflict-handler function is invoked with |
| 9509 |
** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument. |
| 9510 |
** This includes the case where the UPDATE operation is attempted after |
| 9511 |
** an earlier call to the conflict handler function returned |
| 9512 |
** [SQLITE_CHANGESET_REPLACE]. |
| 9513 |
** </dl> |
| 9514 |
** |
| 9515 |
** It is safe to execute SQL statements, including those that write to the |
| 9516 |
** table that the callback related to, from within the xConflict callback. |
| 9517 |
** This can be used to further customize the applications conflict |
| 9518 |
** resolution strategy. |
| 9519 |
** |
| 9520 |
** All changes made by this function are enclosed in a savepoint transaction. |
| 9521 |
** If any other error (aside from a constraint failure when attempting to |
| 9522 |
** write to the target database) occurs, then the savepoint transaction is |
| 9523 |
** rolled back, restoring the target database to its original state, and an |
| 9524 |
** SQLite error code returned. |
| 9525 |
*/ |
| 9526 |
int sqlite3changeset_apply( |
| 9527 |
sqlite3 *db, /* Apply change to "main" db of this handle */ |
| 9528 |
int nChangeset, /* Size of changeset in bytes */ |
| 9529 |
void *pChangeset, /* Changeset blob */ |
| 9530 |
int(*xFilter)( |
| 9531 |
void *pCtx, /* Copy of sixth arg to _apply() */ |
| 9532 |
const char *zTab /* Table name */ |
| 9533 |
), |
| 9534 |
int(*xConflict)( |
| 9535 |
void *pCtx, /* Copy of sixth arg to _apply() */ |
| 9536 |
int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ |
| 9537 |
sqlite3_changeset_iter *p /* Handle describing change and conflict */ |
| 9538 |
), |
| 9539 |
void *pCtx /* First argument passed to xConflict */ |
| 9540 |
); |
| 9541 |
|
| 9542 |
/* |
| 9543 |
** CAPI3REF: Constants Passed To The Conflict Handler |
| 9544 |
** |
| 9545 |
** Values that may be passed as the second argument to a conflict-handler. |
| 9546 |
** |
| 9547 |
** <dl> |
| 9548 |
** <dt>SQLITE_CHANGESET_DATA<dd> |
| 9549 |
** The conflict handler is invoked with CHANGESET_DATA as the second argument |
| 9550 |
** when processing a DELETE or UPDATE change if a row with the required |
| 9551 |
** PRIMARY KEY fields is present in the database, but one or more other |
| 9552 |
** (non primary-key) fields modified by the update do not contain the |
| 9553 |
** expected "before" values. |
| 9554 |
** |
| 9555 |
** The conflicting row, in this case, is the database row with the matching |
| 9556 |
** primary key. |
| 9557 |
** |
| 9558 |
** <dt>SQLITE_CHANGESET_NOTFOUND<dd> |
| 9559 |
** The conflict handler is invoked with CHANGESET_NOTFOUND as the second |
| 9560 |
** argument when processing a DELETE or UPDATE change if a row with the |
| 9561 |
** required PRIMARY KEY fields is not present in the database. |
| 9562 |
** |
| 9563 |
** There is no conflicting row in this case. The results of invoking the |
| 9564 |
** sqlite3changeset_conflict() API are undefined. |
| 9565 |
** |
| 9566 |
** <dt>SQLITE_CHANGESET_CONFLICT<dd> |
| 9567 |
** CHANGESET_CONFLICT is passed as the second argument to the conflict |
| 9568 |
** handler while processing an INSERT change if the operation would result |
| 9569 |
** in duplicate primary key values. |
| 9570 |
** |
| 9571 |
** The conflicting row in this case is the database row with the matching |
| 9572 |
** primary key. |
| 9573 |
** |
| 9574 |
** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd> |
| 9575 |
** If foreign key handling is enabled, and applying a changeset leaves the |
| 9576 |
** database in a state containing foreign key violations, the conflict |
| 9577 |
** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument |
| 9578 |
** exactly once before the changeset is committed. If the conflict handler |
| 9579 |
** returns CHANGESET_OMIT, the changes, including those that caused the |
| 9580 |
** foreign key constraint violation, are committed. Or, if it returns |
| 9581 |
** CHANGESET_ABORT, the changeset is rolled back. |
| 9582 |
** |
| 9583 |
** No current or conflicting row information is provided. The only function |
| 9584 |
** it is possible to call on the supplied sqlite3_changeset_iter handle |
| 9585 |
** is sqlite3changeset_fk_conflicts(). |
| 9586 |
** |
| 9587 |
** <dt>SQLITE_CHANGESET_CONSTRAINT<dd> |
| 9588 |
** If any other constraint violation occurs while applying a change (i.e. |
| 9589 |
** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is |
| 9590 |
** invoked with CHANGESET_CONSTRAINT as the second argument. |
| 9591 |
** |
| 9592 |
** There is no conflicting row in this case. The results of invoking the |
| 9593 |
** sqlite3changeset_conflict() API are undefined. |
| 9594 |
** |
| 9595 |
** </dl> |
| 9596 |
*/ |
| 9597 |
#define SQLITE_CHANGESET_DATA 1 |
| 9598 |
#define SQLITE_CHANGESET_NOTFOUND 2 |
| 9599 |
#define SQLITE_CHANGESET_CONFLICT 3 |
| 9600 |
#define SQLITE_CHANGESET_CONSTRAINT 4 |
| 9601 |
#define SQLITE_CHANGESET_FOREIGN_KEY 5 |
| 9602 |
|
| 9603 |
/* |
| 9604 |
** CAPI3REF: Constants Returned By The Conflict Handler |
| 9605 |
** |
| 9606 |
** A conflict handler callback must return one of the following three values. |
| 9607 |
** |
| 9608 |
** <dl> |
| 9609 |
** <dt>SQLITE_CHANGESET_OMIT<dd> |
| 9610 |
** If a conflict handler returns this value no special action is taken. The |
| 9611 |
** change that caused the conflict is not applied. The session module |
| 9612 |
** continues to the next change in the changeset. |
| 9613 |
** |
| 9614 |
** <dt>SQLITE_CHANGESET_REPLACE<dd> |
| 9615 |
** This value may only be returned if the second argument to the conflict |
| 9616 |
** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this |
| 9617 |
** is not the case, any changes applied so far are rolled back and the |
| 9618 |
** call to sqlite3changeset_apply() returns SQLITE_MISUSE. |
| 9619 |
** |
| 9620 |
** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict |
| 9621 |
** handler, then the conflicting row is either updated or deleted, depending |
| 9622 |
** on the type of change. |
| 9623 |
** |
| 9624 |
** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict |
| 9625 |
** handler, then the conflicting row is removed from the database and a |
| 9626 |
** second attempt to apply the change is made. If this second attempt fails, |
| 9627 |
** the original row is restored to the database before continuing. |
| 9628 |
** |
| 9629 |
** <dt>SQLITE_CHANGESET_ABORT<dd> |
| 9630 |
** If this value is returned, any changes applied so far are rolled back |
| 9631 |
** and the call to sqlite3changeset_apply() returns SQLITE_ABORT. |
| 9632 |
** </dl> |
| 9633 |
*/ |
| 9634 |
#define SQLITE_CHANGESET_OMIT 0 |
| 9635 |
#define SQLITE_CHANGESET_REPLACE 1 |
| 9636 |
#define SQLITE_CHANGESET_ABORT 2 |
| 9637 |
|
| 9638 |
/* |
| 9639 |
** CAPI3REF: Streaming Versions of API functions. |
| 9640 |
** |
| 9641 |
** The six streaming API xxx_strm() functions serve similar purposes to the |
| 9642 |
** corresponding non-streaming API functions: |
| 9643 |
** |
| 9644 |
** <table border=1 style="margin-left:8ex;margin-right:8ex"> |
| 9645 |
** <tr><th>Streaming function<th>Non-streaming equivalent</th> |
| 9646 |
** <tr><td>sqlite3changeset_apply_str<td>[sqlite3changeset_apply] |
| 9647 |
** <tr><td>sqlite3changeset_concat_str<td>[sqlite3changeset_concat] |
| 9648 |
** <tr><td>sqlite3changeset_invert_str<td>[sqlite3changeset_invert] |
| 9649 |
** <tr><td>sqlite3changeset_start_str<td>[sqlite3changeset_start] |
| 9650 |
** <tr><td>sqlite3session_changeset_str<td>[sqlite3session_changeset] |
| 9651 |
** <tr><td>sqlite3session_patchset_str<td>[sqlite3session_patchset] |
| 9652 |
** </table> |
| 9653 |
** |
| 9654 |
** Non-streaming functions that accept changesets (or patchsets) as input |
| 9655 |
** require that the entire changeset be stored in a single buffer in memory. |
| 9656 |
** Similarly, those that return a changeset or patchset do so by returning |
| 9657 |
** a pointer to a single large buffer allocated using sqlite3_malloc(). |
| 9658 |
** Normally this is convenient. However, if an application running in a |
| 9659 |
** low-memory environment is required to handle very large changesets, the |
| 9660 |
** large contiguous memory allocations required can become onerous. |
| 9661 |
** |
| 9662 |
** In order to avoid this problem, instead of a single large buffer, input |
| 9663 |
** is passed to a streaming API functions by way of a callback function that |
| 9664 |
** the sessions module invokes to incrementally request input data as it is |
| 9665 |
** required. In all cases, a pair of API function parameters such as |
| 9666 |
** |
| 9667 |
** <pre> |
| 9668 |
** int nChangeset, |
| 9669 |
** void *pChangeset, |
| 9670 |
** </pre> |
| 9671 |
** |
| 9672 |
** Is replaced by: |
| 9673 |
** |
| 9674 |
** <pre> |
| 9675 |
** int (*xInput)(void *pIn, void *pData, int *pnData), |
| 9676 |
** void *pIn, |
| 9677 |
** </pre> |
| 9678 |
** |
| 9679 |
** Each time the xInput callback is invoked by the sessions module, the first |
| 9680 |
** argument passed is a copy of the supplied pIn context pointer. The second |
| 9681 |
** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no |
| 9682 |
** error occurs the xInput method should copy up to (*pnData) bytes of data |
| 9683 |
** into the buffer and set (*pnData) to the actual number of bytes copied |
| 9684 |
** before returning SQLITE_OK. If the input is completely exhausted, (*pnData) |
| 9685 |
** should be set to zero to indicate this. Or, if an error occurs, an SQLite |
| 9686 |
** error code should be returned. In all cases, if an xInput callback returns |
| 9687 |
** an error, all processing is abandoned and the streaming API function |
| 9688 |
** returns a copy of the error code to the caller. |
| 9689 |
** |
| 9690 |
** In the case of sqlite3changeset_start_strm(), the xInput callback may be |
| 9691 |
** invoked by the sessions module at any point during the lifetime of the |
| 9692 |
** iterator. If such an xInput callback returns an error, the iterator enters |
| 9693 |
** an error state, whereby all subsequent calls to iterator functions |
| 9694 |
** immediately fail with the same error code as returned by xInput. |
| 9695 |
** |
| 9696 |
** Similarly, streaming API functions that return changesets (or patchsets) |
| 9697 |
** return them in chunks by way of a callback function instead of via a |
| 9698 |
** pointer to a single large buffer. In this case, a pair of parameters such |
| 9699 |
** as: |
| 9700 |
** |
| 9701 |
** <pre> |
| 9702 |
** int *pnChangeset, |
| 9703 |
** void **ppChangeset, |
| 9704 |
** </pre> |
| 9705 |
** |
| 9706 |
** Is replaced by: |
| 9707 |
** |
| 9708 |
** <pre> |
| 9709 |
** int (*xOutput)(void *pOut, const void *pData, int nData), |
| 9710 |
** void *pOut |
| 9711 |
** </pre> |
| 9712 |
** |
| 9713 |
** The xOutput callback is invoked zero or more times to return data to |
| 9714 |
** the application. The first parameter passed to each call is a copy of the |
| 9715 |
** pOut pointer supplied by the application. The second parameter, pData, |
| 9716 |
** points to a buffer nData bytes in size containing the chunk of output |
| 9717 |
** data being returned. If the xOutput callback successfully processes the |
| 9718 |
** supplied data, it should return SQLITE_OK to indicate success. Otherwise, |
| 9719 |
** it should return some other SQLite error code. In this case processing |
| 9720 |
** is immediately abandoned and the streaming API function returns a copy |
| 9721 |
** of the xOutput error code to the application. |
| 9722 |
** |
| 9723 |
** The sessions module never invokes an xOutput callback with the third |
| 9724 |
** parameter set to a value less than or equal to zero. Other than this, |
| 9725 |
** no guarantees are made as to the size of the chunks of data returned. |
| 9726 |
*/ |
| 9727 |
int sqlite3changeset_apply_strm( |
| 9728 |
sqlite3 *db, /* Apply change to "main" db of this handle */ |
| 9729 |
int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */ |
| 9730 |
void *pIn, /* First arg for xInput */ |
| 9731 |
int(*xFilter)( |
| 9732 |
void *pCtx, /* Copy of sixth arg to _apply() */ |
| 9733 |
const char *zTab /* Table name */ |
| 9734 |
), |
| 9735 |
int(*xConflict)( |
| 9736 |
void *pCtx, /* Copy of sixth arg to _apply() */ |
| 9737 |
int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ |
| 9738 |
sqlite3_changeset_iter *p /* Handle describing change and conflict */ |
| 9739 |
), |
| 9740 |
void *pCtx /* First argument passed to xConflict */ |
| 9741 |
); |
| 9742 |
int sqlite3changeset_concat_strm( |
| 9743 |
int (*xInputA)(void *pIn, void *pData, int *pnData), |
| 9744 |
void *pInA, |
| 9745 |
int (*xInputB)(void *pIn, void *pData, int *pnData), |
| 9746 |
void *pInB, |
| 9747 |
int (*xOutput)(void *pOut, const void *pData, int nData), |
| 9748 |
void *pOut |
| 9749 |
); |
| 9750 |
int sqlite3changeset_invert_strm( |
| 9751 |
int (*xInput)(void *pIn, void *pData, int *pnData), |
| 9752 |
void *pIn, |
| 9753 |
int (*xOutput)(void *pOut, const void *pData, int nData), |
| 9754 |
void *pOut |
| 9755 |
); |
| 9756 |
int sqlite3changeset_start_strm( |
| 9757 |
sqlite3_changeset_iter **pp, |
| 9758 |
int (*xInput)(void *pIn, void *pData, int *pnData), |
| 9759 |
void *pIn |
| 9760 |
); |
| 9761 |
int sqlite3session_changeset_strm( |
| 9762 |
sqlite3_session *pSession, |
| 9763 |
int (*xOutput)(void *pOut, const void *pData, int nData), |
| 9764 |
void *pOut |
| 9765 |
); |
| 9766 |
int sqlite3session_patchset_strm( |
| 9767 |
sqlite3_session *pSession, |
| 9768 |
int (*xOutput)(void *pOut, const void *pData, int nData), |
| 9769 |
void *pOut |
| 9770 |
); |
| 9771 |
int sqlite3changegroup_add_strm(sqlite3_changegroup*, |
| 9772 |
int (*xInput)(void *pIn, void *pData, int *pnData), |
| 9773 |
void *pIn |
| 9774 |
); |
| 9775 |
int sqlite3changegroup_output_strm(sqlite3_changegroup*, |
| 9776 |
int (*xOutput)(void *pOut, const void *pData, int nData), |
| 9777 |
void *pOut |
| 9778 |
); |
| 9779 |
|
| 9780 |
|
| 9781 |
/* |
| 9782 |
** Make sure we can call this stuff from C++. |
| 9783 |
*/ |
| 9784 |
#ifdef __cplusplus |
| 9785 |
} |
| 9786 |
#endif |
| 9787 |
|
| 9788 |
#endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */ |
| 9789 |
|
| 9790 |
/******** End of sqlite3session.h *********/ |
| 9791 |
/******** Begin file fts5.h *********/ |
| 9792 |
/* |
| 9793 |
** 2014 May 31 |
| 9794 |
** |
| 9795 |
** The author disclaims copyright to this source code. In place of |
| 9796 |
** a legal notice, here is a blessing: |
| 9797 |
** |
| 9798 |
** May you do good and not evil. |
| 9799 |
** May you find forgiveness for yourself and forgive others. |
| 9800 |
** May you share freely, never taking more than you give. |
| 9801 |
** |
| 9802 |
****************************************************************************** |
| 9803 |
** |
| 9804 |
** Interfaces to extend FTS5. Using the interfaces defined in this file, |
| 9805 |
** FTS5 may be extended with: |
| 9806 |
** |
| 9807 |
** * custom tokenizers, and |
| 9808 |
** * custom auxiliary functions. |
| 9809 |
*/ |
| 9810 |
|
| 9811 |
|
| 9812 |
#ifndef _FTS5_H |
| 9813 |
#define _FTS5_H |
| 9814 |
|
| 9815 |
|
| 9816 |
#ifdef __cplusplus |
| 9817 |
extern "C" { |
| 9818 |
#endif |
| 9819 |
|
| 9820 |
/************************************************************************* |
| 9821 |
** CUSTOM AUXILIARY FUNCTIONS |
| 9822 |
** |
| 9823 |
** Virtual table implementations may overload SQL functions by implementing |
| 9824 |
** the sqlite3_module.xFindFunction() method. |
| 9825 |
*/ |
| 9826 |
|
| 9827 |
typedef struct Fts5ExtensionApi Fts5ExtensionApi; |
| 9828 |
typedef struct Fts5Context Fts5Context; |
| 9829 |
typedef struct Fts5PhraseIter Fts5PhraseIter; |
| 9830 |
|
| 9831 |
typedef void (*fts5_extension_function)( |
| 9832 |
const Fts5ExtensionApi *pApi, /* API offered by current FTS version */ |
| 9833 |
Fts5Context *pFts, /* First arg to pass to pApi functions */ |
| 9834 |
sqlite3_context *pCtx, /* Context for returning result/error */ |
| 9835 |
int nVal, /* Number of values in apVal[] array */ |
| 9836 |
sqlite3_value **apVal /* Array of trailing arguments */ |
| 9837 |
); |
| 9838 |
|
| 9839 |
struct Fts5PhraseIter { |
| 9840 |
const unsigned char *a; |
| 9841 |
const unsigned char *b; |
| 9842 |
}; |
| 9843 |
|
| 9844 |
/* |
| 9845 |
** EXTENSION API FUNCTIONS |
| 9846 |
** |
| 9847 |
** xUserData(pFts): |
| 9848 |
** Return a copy of the context pointer the extension function was |
| 9849 |
** registered with. |
| 9850 |
** |
| 9851 |
** xColumnTotalSize(pFts, iCol, pnToken): |
| 9852 |
** If parameter iCol is less than zero, set output variable *pnToken |
| 9853 |
** to the total number of tokens in the FTS5 table. Or, if iCol is |
| 9854 |
** non-negative but less than the number of columns in the table, return |
| 9855 |
** the total number of tokens in column iCol, considering all rows in |
| 9856 |
** the FTS5 table. |
| 9857 |
** |
| 9858 |
** If parameter iCol is greater than or equal to the number of columns |
| 9859 |
** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g. |
| 9860 |
** an OOM condition or IO error), an appropriate SQLite error code is |
| 9861 |
** returned. |
| 9862 |
** |
| 9863 |
** xColumnCount(pFts): |
| 9864 |
** Return the number of columns in the table. |
| 9865 |
** |
| 9866 |
** xColumnSize(pFts, iCol, pnToken): |
| 9867 |
** If parameter iCol is less than zero, set output variable *pnToken |
| 9868 |
** to the total number of tokens in the current row. Or, if iCol is |
| 9869 |
** non-negative but less than the number of columns in the table, set |
| 9870 |
** *pnToken to the number of tokens in column iCol of the current row. |
| 9871 |
** |
| 9872 |
** If parameter iCol is greater than or equal to the number of columns |
| 9873 |
** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g. |
| 9874 |
** an OOM condition or IO error), an appropriate SQLite error code is |
| 9875 |
** returned. |
| 9876 |
** |
| 9877 |
** This function may be quite inefficient if used with an FTS5 table |
| 9878 |
** created with the "columnsize=0" option. |
| 9879 |
** |
| 9880 |
** xColumnText: |
| 9881 |
** This function attempts to retrieve the text of column iCol of the |
| 9882 |
** current document. If successful, (*pz) is set to point to a buffer |
| 9883 |
** containing the text in utf-8 encoding, (*pn) is set to the size in bytes |
| 9884 |
** (not characters) of the buffer and SQLITE_OK is returned. Otherwise, |
| 9885 |
** if an error occurs, an SQLite error code is returned and the final values |
| 9886 |
** of (*pz) and (*pn) are undefined. |
| 9887 |
** |
| 9888 |
** xPhraseCount: |
| 9889 |
** Returns the number of phrases in the current query expression. |
| 9890 |
** |
| 9891 |
** xPhraseSize: |
| 9892 |
** Returns the number of tokens in phrase iPhrase of the query. Phrases |
| 9893 |
** are numbered starting from zero. |
| 9894 |
** |
| 9895 |
** xInstCount: |
| 9896 |
** Set *pnInst to the total number of occurrences of all phrases within |
| 9897 |
** the query within the current row. Return SQLITE_OK if successful, or |
| 9898 |
** an error code (i.e. SQLITE_NOMEM) if an error occurs. |
| 9899 |
** |
| 9900 |
** This API can be quite slow if used with an FTS5 table created with the |
| 9901 |
** "detail=none" or "detail=column" option. If the FTS5 table is created |
| 9902 |
** with either "detail=none" or "detail=column" and "content=" option |
| 9903 |
** (i.e. if it is a contentless table), then this API always returns 0. |
| 9904 |
** |
| 9905 |
** xInst: |
| 9906 |
** Query for the details of phrase match iIdx within the current row. |
| 9907 |
** Phrase matches are numbered starting from zero, so the iIdx argument |
| 9908 |
** should be greater than or equal to zero and smaller than the value |
| 9909 |
** output by xInstCount(). |
| 9910 |
** |
| 9911 |
** Usually, output parameter *piPhrase is set to the phrase number, *piCol |
| 9912 |
** to the column in which it occurs and *piOff the token offset of the |
| 9913 |
** first token of the phrase. The exception is if the table was created |
| 9914 |
** with the offsets=0 option specified. In this case *piOff is always |
| 9915 |
** set to -1. |
| 9916 |
** |
| 9917 |
** Returns SQLITE_OK if successful, or an error code (i.e. SQLITE_NOMEM) |
| 9918 |
** if an error occurs. |
| 9919 |
** |
| 9920 |
** This API can be quite slow if used with an FTS5 table created with the |
| 9921 |
** "detail=none" or "detail=column" option. |
| 9922 |
** |
| 9923 |
** xRowid: |
| 9924 |
** Returns the rowid of the current row. |
| 9925 |
** |
| 9926 |
** xTokenize: |
| 9927 |
** Tokenize text using the tokenizer belonging to the FTS5 table. |
| 9928 |
** |
| 9929 |
** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback): |
| 9930 |
** This API function is used to query the FTS table for phrase iPhrase |
| 9931 |
** of the current query. Specifically, a query equivalent to: |
| 9932 |
** |
| 9933 |
** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid |
| 9934 |
** |
| 9935 |
** with $p set to a phrase equivalent to the phrase iPhrase of the |
| 9936 |
** current query is executed. Any column filter that applies to |
| 9937 |
** phrase iPhrase of the current query is included in $p. For each |
| 9938 |
** row visited, the callback function passed as the fourth argument |
| 9939 |
** is invoked. The context and API objects passed to the callback |
| 9940 |
** function may be used to access the properties of each matched row. |
| 9941 |
** Invoking Api.xUserData() returns a copy of the pointer passed as |
| 9942 |
** the third argument to pUserData. |
| 9943 |
** |
| 9944 |
** If the callback function returns any value other than SQLITE_OK, the |
| 9945 |
** query is abandoned and the xQueryPhrase function returns immediately. |
| 9946 |
** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK. |
| 9947 |
** Otherwise, the error code is propagated upwards. |
| 9948 |
** |
| 9949 |
** If the query runs to completion without incident, SQLITE_OK is returned. |
| 9950 |
** Or, if some error occurs before the query completes or is aborted by |
| 9951 |
** the callback, an SQLite error code is returned. |
| 9952 |
** |
| 9953 |
** |
| 9954 |
** xSetAuxdata(pFts5, pAux, xDelete) |
| 9955 |
** |
| 9956 |
** Save the pointer passed as the second argument as the extension functions |
| 9957 |
** "auxiliary data". The pointer may then be retrieved by the current or any |
| 9958 |
** future invocation of the same fts5 extension function made as part of |
| 9959 |
** of the same MATCH query using the xGetAuxdata() API. |
| 9960 |
** |
| 9961 |
** Each extension function is allocated a single auxiliary data slot for |
| 9962 |
** each FTS query (MATCH expression). If the extension function is invoked |
| 9963 |
** more than once for a single FTS query, then all invocations share a |
| 9964 |
** single auxiliary data context. |
| 9965 |
** |
| 9966 |
** If there is already an auxiliary data pointer when this function is |
| 9967 |
** invoked, then it is replaced by the new pointer. If an xDelete callback |
| 9968 |
** was specified along with the original pointer, it is invoked at this |
| 9969 |
** point. |
| 9970 |
** |
| 9971 |
** The xDelete callback, if one is specified, is also invoked on the |
| 9972 |
** auxiliary data pointer after the FTS5 query has finished. |
| 9973 |
** |
| 9974 |
** If an error (e.g. an OOM condition) occurs within this function, an |
| 9975 |
** the auxiliary data is set to NULL and an error code returned. If the |
| 9976 |
** xDelete parameter was not NULL, it is invoked on the auxiliary data |
| 9977 |
** pointer before returning. |
| 9978 |
** |
| 9979 |
** |
| 9980 |
** xGetAuxdata(pFts5, bClear) |
| 9981 |
** |
| 9982 |
** Returns the current auxiliary data pointer for the fts5 extension |
| 9983 |
** function. See the xSetAuxdata() method for details. |
| 9984 |
** |
| 9985 |
** If the bClear argument is non-zero, then the auxiliary data is cleared |
| 9986 |
** (set to NULL) before this function returns. In this case the xDelete, |
| 9987 |
** if any, is not invoked. |
| 9988 |
** |
| 9989 |
** |
| 9990 |
** xRowCount(pFts5, pnRow) |
| 9991 |
** |
| 9992 |
** This function is used to retrieve the total number of rows in the table. |
| 9993 |
** In other words, the same value that would be returned by: |
| 9994 |
** |
| 9995 |
** SELECT count(*) FROM ftstable; |
| 9996 |
** |
| 9997 |
** xPhraseFirst() |
| 9998 |
** This function is used, along with type Fts5PhraseIter and the xPhraseNext |
| 9999 |
** method, to iterate through all instances of a single query phrase within |
| 10000 |
** the current row. This is the same information as is accessible via the |
| 10001 |
** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient |
| 10002 |
** to use, this API may be faster under some circumstances. To iterate |
| 10003 |
** through instances of phrase iPhrase, use the following code: |
| 10004 |
** |
| 10005 |
** Fts5PhraseIter iter; |
| 10006 |
** int iCol, iOff; |
| 10007 |
** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff); |
| 10008 |
** iCol>=0; |
| 10009 |
** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff) |
| 10010 |
** ){ |
| 10011 |
** // An instance of phrase iPhrase at offset iOff of column iCol |
| 10012 |
** } |
| 10013 |
** |
| 10014 |
** The Fts5PhraseIter structure is defined above. Applications should not |
| 10015 |
** modify this structure directly - it should only be used as shown above |
| 10016 |
** with the xPhraseFirst() and xPhraseNext() API methods (and by |
| 10017 |
** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below). |
| 10018 |
** |
| 10019 |
** This API can be quite slow if used with an FTS5 table created with the |
| 10020 |
** "detail=none" or "detail=column" option. If the FTS5 table is created |
| 10021 |
** with either "detail=none" or "detail=column" and "content=" option |
| 10022 |
** (i.e. if it is a contentless table), then this API always iterates |
| 10023 |
** through an empty set (all calls to xPhraseFirst() set iCol to -1). |
| 10024 |
** |
| 10025 |
** xPhraseNext() |
| 10026 |
** See xPhraseFirst above. |
| 10027 |
** |
| 10028 |
** xPhraseFirstColumn() |
| 10029 |
** This function and xPhraseNextColumn() are similar to the xPhraseFirst() |
| 10030 |
** and xPhraseNext() APIs described above. The difference is that instead |
| 10031 |
** of iterating through all instances of a phrase in the current row, these |
| 10032 |
** APIs are used to iterate through the set of columns in the current row |
| 10033 |
** that contain one or more instances of a specified phrase. For example: |
| 10034 |
** |
| 10035 |
** Fts5PhraseIter iter; |
| 10036 |
** int iCol; |
| 10037 |
** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol); |
| 10038 |
** iCol>=0; |
| 10039 |
** pApi->xPhraseNextColumn(pFts, &iter, &iCol) |
| 10040 |
** ){ |
| 10041 |
** // Column iCol contains at least one instance of phrase iPhrase |
| 10042 |
** } |
| 10043 |
** |
| 10044 |
** This API can be quite slow if used with an FTS5 table created with the |
| 10045 |
** "detail=none" option. If the FTS5 table is created with either |
| 10046 |
** "detail=none" "content=" option (i.e. if it is a contentless table), |
| 10047 |
** then this API always iterates through an empty set (all calls to |
| 10048 |
** xPhraseFirstColumn() set iCol to -1). |
| 10049 |
** |
| 10050 |
** The information accessed using this API and its companion |
| 10051 |
** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext |
| 10052 |
** (or xInst/xInstCount). The chief advantage of this API is that it is |
| 10053 |
** significantly more efficient than those alternatives when used with |
| 10054 |
** "detail=column" tables. |
| 10055 |
** |
| 10056 |
** xPhraseNextColumn() |
| 10057 |
** See xPhraseFirstColumn above. |
| 10058 |
*/ |
| 10059 |
struct Fts5ExtensionApi { |
| 10060 |
int iVersion; /* Currently always set to 3 */ |
| 10061 |
|
| 10062 |
void *(*xUserData)(Fts5Context*); |
| 10063 |
|
| 10064 |
int (*xColumnCount)(Fts5Context*); |
| 10065 |
int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow); |
| 10066 |
int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken); |
| 10067 |
|
| 10068 |
int (*xTokenize)(Fts5Context*, |
| 10069 |
const char *pText, int nText, /* Text to tokenize */ |
| 10070 |
void *pCtx, /* Context passed to xToken() */ |
| 10071 |
int (*xToken)(void*, int, const char*, int, int, int) /* Callback */ |
| 10072 |
); |
| 10073 |
|
| 10074 |
int (*xPhraseCount)(Fts5Context*); |
| 10075 |
int (*xPhraseSize)(Fts5Context*, int iPhrase); |
| 10076 |
|
| 10077 |
int (*xInstCount)(Fts5Context*, int *pnInst); |
| 10078 |
int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff); |
| 10079 |
|
| 10080 |
sqlite3_int64 (*xRowid)(Fts5Context*); |
| 10081 |
int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn); |
| 10082 |
int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken); |
| 10083 |
|
| 10084 |
int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData, |
| 10085 |
int(*)(const Fts5ExtensionApi*,Fts5Context*,void*) |
| 10086 |
); |
| 10087 |
int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*)); |
| 10088 |
void *(*xGetAuxdata)(Fts5Context*, int bClear); |
| 10089 |
|
| 10090 |
int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*); |
| 10091 |
void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff); |
| 10092 |
|
| 10093 |
int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*); |
| 10094 |
void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol); |
| 10095 |
}; |
| 10096 |
|
| 10097 |
/* |
| 10098 |
** CUSTOM AUXILIARY FUNCTIONS |
| 10099 |
*************************************************************************/ |
| 10100 |
|
| 10101 |
/************************************************************************* |
| 10102 |
** CUSTOM TOKENIZERS |
| 10103 |
** |
| 10104 |
** Applications may also register custom tokenizer types. A tokenizer |
| 10105 |
** is registered by providing fts5 with a populated instance of the |
| 10106 |
** following structure. All structure methods must be defined, setting |
| 10107 |
** any member of the fts5_tokenizer struct to NULL leads to undefined |
| 10108 |
** behaviour. The structure methods are expected to function as follows: |
| 10109 |
** |
| 10110 |
** xCreate: |
| 10111 |
** This function is used to allocate and initialize a tokenizer instance. |
| 10112 |
** A tokenizer instance is required to actually tokenize text. |
| 10113 |
** |
| 10114 |
** The first argument passed to this function is a copy of the (void*) |
| 10115 |
** pointer provided by the application when the fts5_tokenizer object |
| 10116 |
** was registered with FTS5 (the third argument to xCreateTokenizer()). |
| 10117 |
** The second and third arguments are an array of nul-terminated strings |
| 10118 |
** containing the tokenizer arguments, if any, specified following the |
| 10119 |
** tokenizer name as part of the CREATE VIRTUAL TABLE statement used |
| 10120 |
** to create the FTS5 table. |
| 10121 |
** |
| 10122 |
** The final argument is an output variable. If successful, (*ppOut) |
| 10123 |
** should be set to point to the new tokenizer handle and SQLITE_OK |
| 10124 |
** returned. If an error occurs, some value other than SQLITE_OK should |
| 10125 |
** be returned. In this case, fts5 assumes that the final value of *ppOut |
| 10126 |
** is undefined. |
| 10127 |
** |
| 10128 |
** xDelete: |
| 10129 |
** This function is invoked to delete a tokenizer handle previously |
| 10130 |
** allocated using xCreate(). Fts5 guarantees that this function will |
| 10131 |
** be invoked exactly once for each successful call to xCreate(). |
| 10132 |
** |
| 10133 |
** xTokenize: |
| 10134 |
** This function is expected to tokenize the nText byte string indicated |
| 10135 |
** by argument pText. pText may or may not be nul-terminated. The first |
| 10136 |
** argument passed to this function is a pointer to an Fts5Tokenizer object |
| 10137 |
** returned by an earlier call to xCreate(). |
| 10138 |
** |
| 10139 |
** The second argument indicates the reason that FTS5 is requesting |
| 10140 |
** tokenization of the supplied text. This is always one of the following |
| 10141 |
** four values: |
| 10142 |
** |
| 10143 |
** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into |
| 10144 |
** or removed from the FTS table. The tokenizer is being invoked to |
| 10145 |
** determine the set of tokens to add to (or delete from) the |
| 10146 |
** FTS index. |
| 10147 |
** |
| 10148 |
** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed |
| 10149 |
** against the FTS index. The tokenizer is being called to tokenize |
| 10150 |
** a bareword or quoted string specified as part of the query. |
| 10151 |
** |
| 10152 |
** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as |
| 10153 |
** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is |
| 10154 |
** followed by a "*" character, indicating that the last token |
| 10155 |
** returned by the tokenizer will be treated as a token prefix. |
| 10156 |
** |
| 10157 |
** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to |
| 10158 |
** satisfy an fts5_api.xTokenize() request made by an auxiliary |
| 10159 |
** function. Or an fts5_api.xColumnSize() request made by the same |
| 10160 |
** on a columnsize=0 database. |
| 10161 |
** </ul> |
| 10162 |
** |
| 10163 |
** For each token in the input string, the supplied callback xToken() must |
| 10164 |
** be invoked. The first argument to it should be a copy of the pointer |
| 10165 |
** passed as the second argument to xTokenize(). The third and fourth |
| 10166 |
** arguments are a pointer to a buffer containing the token text, and the |
| 10167 |
** size of the token in bytes. The 4th and 5th arguments are the byte offsets |
| 10168 |
** of the first byte of and first byte immediately following the text from |
| 10169 |
** which the token is derived within the input. |
| 10170 |
** |
| 10171 |
** The second argument passed to the xToken() callback ("tflags") should |
| 10172 |
** normally be set to 0. The exception is if the tokenizer supports |
| 10173 |
** synonyms. In this case see the discussion below for details. |
| 10174 |
** |
| 10175 |
** FTS5 assumes the xToken() callback is invoked for each token in the |
| 10176 |
** order that they occur within the input text. |
| 10177 |
** |
| 10178 |
** If an xToken() callback returns any value other than SQLITE_OK, then |
| 10179 |
** the tokenization should be abandoned and the xTokenize() method should |
| 10180 |
** immediately return a copy of the xToken() return value. Or, if the |
| 10181 |
** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally, |
| 10182 |
** if an error occurs with the xTokenize() implementation itself, it |
| 10183 |
** may abandon the tokenization and return any error code other than |
| 10184 |
** SQLITE_OK or SQLITE_DONE. |
| 10185 |
** |
| 10186 |
** SYNONYM SUPPORT |
| 10187 |
** |
| 10188 |
** Custom tokenizers may also support synonyms. Consider a case in which a |
| 10189 |
** user wishes to query for a phrase such as "first place". Using the |
| 10190 |
** built-in tokenizers, the FTS5 query 'first + place' will match instances |
| 10191 |
** of "first place" within the document set, but not alternative forms |
| 10192 |
** such as "1st place". In some applications, it would be better to match |
| 10193 |
** all instances of "first place" or "1st place" regardless of which form |
| 10194 |
** the user specified in the MATCH query text. |
| 10195 |
** |
| 10196 |
** There are several ways to approach this in FTS5: |
| 10197 |
** |
| 10198 |
** <ol><li> By mapping all synonyms to a single token. In this case, the |
| 10199 |
** In the above example, this means that the tokenizer returns the |
| 10200 |
** same token for inputs "first" and "1st". Say that token is in |
| 10201 |
** fact "first", so that when the user inserts the document "I won |
| 10202 |
** 1st place" entries are added to the index for tokens "i", "won", |
| 10203 |
** "first" and "place". If the user then queries for '1st + place', |
| 10204 |
** the tokenizer substitutes "first" for "1st" and the query works |
| 10205 |
** as expected. |
| 10206 |
** |
| 10207 |
** <li> By adding multiple synonyms for a single term to the FTS index. |
| 10208 |
** In this case, when tokenizing query text, the tokenizer may |
| 10209 |
** provide multiple synonyms for a single term within the document. |
| 10210 |
** FTS5 then queries the index for each synonym individually. For |
| 10211 |
** example, faced with the query: |
| 10212 |
** |
| 10213 |
** <codeblock> |
| 10214 |
** ... MATCH 'first place'</codeblock> |
| 10215 |
** |
| 10216 |
** the tokenizer offers both "1st" and "first" as synonyms for the |
| 10217 |
** first token in the MATCH query and FTS5 effectively runs a query |
| 10218 |
** similar to: |
| 10219 |
** |
| 10220 |
** <codeblock> |
| 10221 |
** ... MATCH '(first OR 1st) place'</codeblock> |
| 10222 |
** |
| 10223 |
** except that, for the purposes of auxiliary functions, the query |
| 10224 |
** still appears to contain just two phrases - "(first OR 1st)" |
| 10225 |
** being treated as a single phrase. |
| 10226 |
** |
| 10227 |
** <li> By adding multiple synonyms for a single term to the FTS index. |
| 10228 |
** Using this method, when tokenizing document text, the tokenizer |
| 10229 |
** provides multiple synonyms for each token. So that when a |
| 10230 |
** document such as "I won first place" is tokenized, entries are |
| 10231 |
** added to the FTS index for "i", "won", "first", "1st" and |
| 10232 |
** "place". |
| 10233 |
** |
| 10234 |
** This way, even if the tokenizer does not provide synonyms |
| 10235 |
** when tokenizing query text (it should not - to do would be |
| 10236 |
** inefficient), it doesn't matter if the user queries for |
| 10237 |
** 'first + place' or '1st + place', as there are entires in the |
| 10238 |
** FTS index corresponding to both forms of the first token. |
| 10239 |
** </ol> |
| 10240 |
** |
| 10241 |
** Whether it is parsing document or query text, any call to xToken that |
| 10242 |
** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit |
| 10243 |
** is considered to supply a synonym for the previous token. For example, |
| 10244 |
** when parsing the document "I won first place", a tokenizer that supports |
| 10245 |
** synonyms would call xToken() 5 times, as follows: |
| 10246 |
** |
| 10247 |
** <codeblock> |
| 10248 |
** xToken(pCtx, 0, "i", 1, 0, 1); |
| 10249 |
** xToken(pCtx, 0, "won", 3, 2, 5); |
| 10250 |
** xToken(pCtx, 0, "first", 5, 6, 11); |
| 10251 |
** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11); |
| 10252 |
** xToken(pCtx, 0, "place", 5, 12, 17); |
| 10253 |
**</codeblock> |
| 10254 |
** |
| 10255 |
** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time |
| 10256 |
** xToken() is called. Multiple synonyms may be specified for a single token |
| 10257 |
** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence. |
| 10258 |
** There is no limit to the number of synonyms that may be provided for a |
| 10259 |
** single token. |
| 10260 |
** |
| 10261 |
** In many cases, method (1) above is the best approach. It does not add |
| 10262 |
** extra data to the FTS index or require FTS5 to query for multiple terms, |
| 10263 |
** so it is efficient in terms of disk space and query speed. However, it |
| 10264 |
** does not support prefix queries very well. If, as suggested above, the |
| 10265 |
** token "first" is subsituted for "1st" by the tokenizer, then the query: |
| 10266 |
** |
| 10267 |
** <codeblock> |
| 10268 |
** ... MATCH '1s*'</codeblock> |
| 10269 |
** |
| 10270 |
** will not match documents that contain the token "1st" (as the tokenizer |
| 10271 |
** will probably not map "1s" to any prefix of "first"). |
| 10272 |
** |
| 10273 |
** For full prefix support, method (3) may be preferred. In this case, |
| 10274 |
** because the index contains entries for both "first" and "1st", prefix |
| 10275 |
** queries such as 'fi*' or '1s*' will match correctly. However, because |
| 10276 |
** extra entries are added to the FTS index, this method uses more space |
| 10277 |
** within the database. |
| 10278 |
** |
| 10279 |
** Method (2) offers a midpoint between (1) and (3). Using this method, |
| 10280 |
** a query such as '1s*' will match documents that contain the literal |
| 10281 |
** token "1st", but not "first" (assuming the tokenizer is not able to |
| 10282 |
** provide synonyms for prefixes). However, a non-prefix query like '1st' |
| 10283 |
** will match against "1st" and "first". This method does not require |
| 10284 |
** extra disk space, as no extra entries are added to the FTS index. |
| 10285 |
** On the other hand, it may require more CPU cycles to run MATCH queries, |
| 10286 |
** as separate queries of the FTS index are required for each synonym. |
| 10287 |
** |
| 10288 |
** When using methods (2) or (3), it is important that the tokenizer only |
| 10289 |
** provide synonyms when tokenizing document text (method (2)) or query |
| 10290 |
** text (method (3)), not both. Doing so will not cause any errors, but is |
| 10291 |
** inefficient. |
| 10292 |
*/ |
| 10293 |
typedef struct Fts5Tokenizer Fts5Tokenizer; |
| 10294 |
typedef struct fts5_tokenizer fts5_tokenizer; |
| 10295 |
struct fts5_tokenizer { |
| 10296 |
int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut); |
| 10297 |
void (*xDelete)(Fts5Tokenizer*); |
| 10298 |
int (*xTokenize)(Fts5Tokenizer*, |
| 10299 |
void *pCtx, |
| 10300 |
int flags, /* Mask of FTS5_TOKENIZE_* flags */ |
| 10301 |
const char *pText, int nText, |
| 10302 |
int (*xToken)( |
| 10303 |
void *pCtx, /* Copy of 2nd argument to xTokenize() */ |
| 10304 |
int tflags, /* Mask of FTS5_TOKEN_* flags */ |
| 10305 |
const char *pToken, /* Pointer to buffer containing token */ |
| 10306 |
int nToken, /* Size of token in bytes */ |
| 10307 |
int iStart, /* Byte offset of token within input text */ |
| 10308 |
int iEnd /* Byte offset of end of token within input text */ |
| 10309 |
) |
| 10310 |
); |
| 10311 |
}; |
| 10312 |
|
| 10313 |
/* Flags that may be passed as the third argument to xTokenize() */ |
| 10314 |
#define FTS5_TOKENIZE_QUERY 0x0001 |
| 10315 |
#define FTS5_TOKENIZE_PREFIX 0x0002 |
| 10316 |
#define FTS5_TOKENIZE_DOCUMENT 0x0004 |
| 10317 |
#define FTS5_TOKENIZE_AUX 0x0008 |
| 10318 |
|
| 10319 |
/* Flags that may be passed by the tokenizer implementation back to FTS5 |
| 10320 |
** as the third argument to the supplied xToken callback. */ |
| 10321 |
#define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */ |
| 10322 |
|
| 10323 |
/* |
| 10324 |
** END OF CUSTOM TOKENIZERS |
| 10325 |
*************************************************************************/ |
| 10326 |
|
| 10327 |
/************************************************************************* |
| 10328 |
** FTS5 EXTENSION REGISTRATION API |
| 10329 |
*/ |
| 10330 |
typedef struct fts5_api fts5_api; |
| 10331 |
struct fts5_api { |
| 10332 |
int iVersion; /* Currently always set to 2 */ |
| 10333 |
|
| 10334 |
/* Create a new tokenizer */ |
| 10335 |
int (*xCreateTokenizer)( |
| 10336 |
fts5_api *pApi, |
| 10337 |
const char *zName, |
| 10338 |
void *pContext, |
| 10339 |
fts5_tokenizer *pTokenizer, |
| 10340 |
void (*xDestroy)(void*) |
| 10341 |
); |
| 10342 |
|
| 10343 |
/* Find an existing tokenizer */ |
| 10344 |
int (*xFindTokenizer)( |
| 10345 |
fts5_api *pApi, |
| 10346 |
const char *zName, |
| 10347 |
void **ppContext, |
| 10348 |
fts5_tokenizer *pTokenizer |
| 10349 |
); |
| 10350 |
|
| 10351 |
/* Create a new auxiliary function */ |
| 10352 |
int (*xCreateFunction)( |
| 10353 |
fts5_api *pApi, |
| 10354 |
const char *zName, |
| 10355 |
void *pContext, |
| 10356 |
fts5_extension_function xFunction, |
| 10357 |
void (*xDestroy)(void*) |
| 10358 |
); |
| 10359 |
}; |
| 10360 |
|
| 10361 |
/* |
| 10362 |
** END OF REGISTRATION API |
| 10363 |
*************************************************************************/ |
| 10364 |
|
| 10365 |
#ifdef __cplusplus |
| 10366 |
} /* end of the 'extern "C"' block */ |
| 10367 |
#endif |
| 10368 |
|
| 10369 |
#endif /* _FTS5_H */ |
| 10370 |
|
| 10371 |
/******** End of fts5.h *********/ |