Annotation of win32/sql/sqlite/include/sqlite3.h, revision 1.5
1.1 misha 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
1.2 misha 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
1.5 ! misha 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.
1.2 misha 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 suppose 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.
1.1 misha 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:
1.2 misha 44:
45: /*
46: ** Add the ability to override 'extern'
47: */
48: #ifndef SQLITE_EXTERN
49: # define SQLITE_EXTERN extern
50: #endif
51:
1.5 ! misha 52: #ifndef SQLITE_API
! 53: # define SQLITE_API
! 54: #endif
! 55:
! 56:
1.1 misha 57: /*
1.5 ! misha 58: ** These no-op macros are used in front of interfaces to mark those
! 59: ** interfaces as either deprecated or experimental. New applications
! 60: ** should not use deprecated interfaces - they are support for backwards
! 61: ** compatibility only. Application writers should be aware that
! 62: ** experimental interfaces are subject to change in point releases.
! 63: **
! 64: ** These macros used to resolve to various kinds of compiler magic that
! 65: ** would generate warning messages when they were used. But that
! 66: ** compiler magic ended up generating such a flurry of bug reports
! 67: ** that we have taken it all out and gone back to using simple
! 68: ** noop macros.
! 69: */
! 70: #define SQLITE_DEPRECATED
! 71: #define SQLITE_EXPERIMENTAL
! 72:
! 73: /*
! 74: ** Ensure these symbols were not defined by some previous header file.
1.1 misha 75: */
76: #ifdef SQLITE_VERSION
77: # undef SQLITE_VERSION
1.2 misha 78: #endif
79: #ifdef SQLITE_VERSION_NUMBER
80: # undef SQLITE_VERSION_NUMBER
1.1 misha 81: #endif
82:
83: /*
1.5 ! misha 84: ** CAPI3REF: Compile-Time Library Version Numbers
1.2 misha 85: **
1.5 ! misha 86: ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
! 87: ** evaluates to a string literal that is the SQLite version in the
! 88: ** format "X.Y.Z" where X is the major version number (always 3 for
! 89: ** SQLite3) and Y is the minor version number and Z is the release number.)^
! 90: ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
! 91: ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
! 92: ** numbers used in [SQLITE_VERSION].)^
! 93: ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
! 94: ** be larger than the release from which it is derived. Either Y will
! 95: ** be held constant and Z will be incremented or else Y will be incremented
! 96: ** and Z will be reset to zero.
! 97: **
! 98: ** Since version 3.6.18, SQLite source code has been stored in the
! 99: ** <a href="http://www.fossil-scm.org/">Fossil configuration management
! 100: ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
! 101: ** a string which identifies a particular check-in of SQLite
! 102: ** within its configuration management system. ^The SQLITE_SOURCE_ID
! 103: ** string contains the date and time of the check-in (UTC) and an SHA1
! 104: ** hash of the entire source tree.
! 105: **
! 106: ** See also: [sqlite3_libversion()],
! 107: ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
! 108: ** [sqlite_version()] and [sqlite_source_id()].
! 109: */
! 110: #define SQLITE_VERSION "3.8.1"
! 111: #define SQLITE_VERSION_NUMBER 3008001
! 112: #define SQLITE_SOURCE_ID "2013-10-17 12:57:35 c78be6d786c19073b3a6730dfe3fb1be54f5657a"
! 113:
! 114: /*
! 115: ** CAPI3REF: Run-Time Library Version Numbers
! 116: ** KEYWORDS: sqlite3_version, sqlite3_sourceid
! 117: **
! 118: ** These interfaces provide the same information as the [SQLITE_VERSION],
! 119: ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
! 120: ** but are associated with the library instead of the header file. ^(Cautious
! 121: ** programmers might include assert() statements in their application to
! 122: ** verify that values returned by these interfaces match the macros in
! 123: ** the header, and thus insure that the application is
! 124: ** compiled with matching library and header files.
1.4 misha 125: **
1.5 ! misha 126: ** <blockquote><pre>
! 127: ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
! 128: ** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
! 129: ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
! 130: ** </pre></blockquote>)^
! 131: **
! 132: ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
! 133: ** macro. ^The sqlite3_libversion() function returns a pointer to the
! 134: ** to the sqlite3_version[] string constant. The sqlite3_libversion()
! 135: ** function is provided for use in DLLs since DLL users usually do not have
! 136: ** direct access to string constants within the DLL. ^The
! 137: ** sqlite3_libversion_number() function returns an integer equal to
! 138: ** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns
! 139: ** a pointer to a string constant whose value is the same as the
! 140: ** [SQLITE_SOURCE_ID] C preprocessor macro.
! 141: **
! 142: ** See also: [sqlite_version()] and [sqlite_source_id()].
! 143: */
! 144: SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
! 145: SQLITE_API const char *sqlite3_libversion(void);
! 146: SQLITE_API const char *sqlite3_sourceid(void);
! 147: SQLITE_API int sqlite3_libversion_number(void);
! 148:
! 149: /*
! 150: ** CAPI3REF: Run-Time Library Compilation Options Diagnostics
! 151: **
! 152: ** ^The sqlite3_compileoption_used() function returns 0 or 1
! 153: ** indicating whether the specified option was defined at
! 154: ** compile time. ^The SQLITE_ prefix may be omitted from the
! 155: ** option name passed to sqlite3_compileoption_used().
! 156: **
! 157: ** ^The sqlite3_compileoption_get() function allows iterating
! 158: ** over the list of options that were defined at compile time by
! 159: ** returning the N-th compile time option string. ^If N is out of range,
! 160: ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
! 161: ** prefix is omitted from any strings returned by
! 162: ** sqlite3_compileoption_get().
! 163: **
! 164: ** ^Support for the diagnostic functions sqlite3_compileoption_used()
! 165: ** and sqlite3_compileoption_get() may be omitted by specifying the
! 166: ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
! 167: **
! 168: ** See also: SQL functions [sqlite_compileoption_used()] and
! 169: ** [sqlite_compileoption_get()] and the [compile_options pragma].
! 170: */
! 171: #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
! 172: SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
! 173: SQLITE_API const char *sqlite3_compileoption_get(int N);
! 174: #endif
1.2 misha 175:
176: /*
1.5 ! misha 177: ** CAPI3REF: Test To See If The Library Is Threadsafe
1.4 misha 178: **
1.5 ! misha 179: ** ^The sqlite3_threadsafe() function returns zero if and only if
! 180: ** SQLite was compiled with mutexing code omitted due to the
! 181: ** [SQLITE_THREADSAFE] compile-time option being set to 0.
1.2 misha 182: **
1.4 misha 183: ** SQLite can be compiled with or without mutexes. When
1.5 ! misha 184: ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
! 185: ** are enabled and SQLite is threadsafe. When the
! 186: ** [SQLITE_THREADSAFE] macro is 0,
1.4 misha 187: ** the mutexes are omitted. Without the mutexes, it is not safe
1.5 ! misha 188: ** to use SQLite concurrently from more than one thread.
1.4 misha 189: **
1.5 ! misha 190: ** Enabling mutexes incurs a measurable performance penalty.
1.4 misha 191: ** So if speed is of utmost importance, it makes sense to disable
192: ** the mutexes. But for maximum safety, mutexes should be enabled.
1.5 ! misha 193: ** ^The default behavior is for mutexes to be enabled.
1.4 misha 194: **
1.5 ! misha 195: ** This interface can be used by an application to make sure that the
1.4 misha 196: ** version of SQLite that it is linking against was compiled with
1.5 ! misha 197: ** the desired setting of the [SQLITE_THREADSAFE] macro.
1.4 misha 198: **
1.5 ! misha 199: ** This interface only reports on the compile-time mutex setting
! 200: ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
! 201: ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
! 202: ** can be fully or partially disabled using a call to [sqlite3_config()]
! 203: ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
! 204: ** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the
! 205: ** sqlite3_threadsafe() function shows only the compile-time setting of
! 206: ** thread safety, not any run-time changes to that setting made by
! 207: ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
! 208: ** is unchanged by calls to sqlite3_config().)^
1.4 misha 209: **
1.5 ! misha 210: ** See the [threading mode] documentation for additional information.
1.2 misha 211: */
1.5 ! misha 212: SQLITE_API int sqlite3_threadsafe(void);
1.2 misha 213:
214: /*
1.5 ! misha 215: ** CAPI3REF: Database Connection Handle
! 216: ** KEYWORDS: {database connection} {database connections}
1.2 misha 217: **
1.5 ! misha 218: ** Each open SQLite database is represented by a pointer to an instance of
! 219: ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
1.2 misha 220: ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
1.5 ! misha 221: ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
! 222: ** and [sqlite3_close_v2()] are its destructors. There are many other
! 223: ** interfaces (such as
! 224: ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
! 225: ** [sqlite3_busy_timeout()] to name but three) that are methods on an
! 226: ** sqlite3 object.
1.1 misha 227: */
228: typedef struct sqlite3 sqlite3;
229:
230: /*
1.5 ! misha 231: ** CAPI3REF: 64-Bit Integer Types
1.4 misha 232: ** KEYWORDS: sqlite_int64 sqlite_uint64
233: **
234: ** Because there is no cross-platform way to specify 64-bit integer types
235: ** SQLite includes typedefs for 64-bit signed and unsigned integers.
236: **
1.5 ! misha 237: ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
! 238: ** The sqlite_int64 and sqlite_uint64 types are supported for backwards
! 239: ** compatibility only.
! 240: **
! 241: ** ^The sqlite3_int64 and sqlite_int64 types can store integer values
! 242: ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
! 243: ** sqlite3_uint64 and sqlite_uint64 types can store integer values
! 244: ** between 0 and +18446744073709551615 inclusive.
1.1 misha 245: */
1.2 misha 246: #ifdef SQLITE_INT64_TYPE
247: typedef SQLITE_INT64_TYPE sqlite_int64;
248: typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
249: #elif defined(_MSC_VER) || defined(__BORLANDC__)
1.1 misha 250: typedef __int64 sqlite_int64;
251: typedef unsigned __int64 sqlite_uint64;
252: #else
253: typedef long long int sqlite_int64;
254: typedef unsigned long long int sqlite_uint64;
255: #endif
1.2 misha 256: typedef sqlite_int64 sqlite3_int64;
257: typedef sqlite_uint64 sqlite3_uint64;
1.1 misha 258:
1.2 misha 259: /*
260: ** If compiling for a processor that lacks floating point support,
1.5 ! misha 261: ** substitute integer for floating-point.
1.2 misha 262: */
263: #ifdef SQLITE_OMIT_FLOATING_POINT
264: # define double sqlite3_int64
265: #endif
1.1 misha 266:
267: /*
1.5 ! misha 268: ** CAPI3REF: Closing A Database Connection
1.4 misha 269: **
1.5 ! misha 270: ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
! 271: ** for the [sqlite3] object.
! 272: ** ^Calls to sqlite3_close() and sqlite3_close_v2() return SQLITE_OK if
! 273: ** the [sqlite3] object is successfully destroyed and all associated
! 274: ** resources are deallocated.
! 275: **
! 276: ** ^If the database connection is associated with unfinalized prepared
! 277: ** statements or unfinished sqlite3_backup objects then sqlite3_close()
! 278: ** will leave the database connection open and return [SQLITE_BUSY].
! 279: ** ^If sqlite3_close_v2() is called with unfinalized prepared statements
! 280: ** and unfinished sqlite3_backups, then the database connection becomes
! 281: ** an unusable "zombie" which will automatically be deallocated when the
! 282: ** last prepared statement is finalized or the last sqlite3_backup is
! 283: ** finished. The sqlite3_close_v2() interface is intended for use with
! 284: ** host languages that are garbage collected, and where the order in which
! 285: ** destructors are called is arbitrary.
! 286: **
! 287: ** Applications should [sqlite3_finalize | finalize] all [prepared statements],
! 288: ** [sqlite3_blob_close | close] all [BLOB handles], and
! 289: ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
! 290: ** with the [sqlite3] object prior to attempting to close the object. ^If
! 291: ** sqlite3_close_v2() is called on a [database connection] that still has
! 292: ** outstanding [prepared statements], [BLOB handles], and/or
! 293: ** [sqlite3_backup] objects then it returns SQLITE_OK but the deallocation
! 294: ** of resources is deferred until all [prepared statements], [BLOB handles],
! 295: ** and [sqlite3_backup] objects are also destroyed.
! 296: **
! 297: ** ^If an [sqlite3] object is destroyed while a transaction is open,
! 298: ** the transaction is automatically rolled back.
! 299: **
! 300: ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
! 301: ** must be either a NULL
! 302: ** pointer or an [sqlite3] object pointer obtained
! 303: ** from [sqlite3_open()], [sqlite3_open16()], or
! 304: ** [sqlite3_open_v2()], and not previously closed.
! 305: ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
! 306: ** argument is a harmless no-op.
1.1 misha 307: */
1.5 ! misha 308: SQLITE_API int sqlite3_close(sqlite3*);
! 309: SQLITE_API int sqlite3_close_v2(sqlite3*);
1.1 misha 310:
311: /*
312: ** The type for a callback function.
1.2 misha 313: ** This is legacy and deprecated. It is included for historical
314: ** compatibility and is not documented.
1.1 misha 315: */
316: typedef int (*sqlite3_callback)(void*,int,char**, char**);
317:
318: /*
1.5 ! misha 319: ** CAPI3REF: One-Step Query Execution Interface
1.4 misha 320: **
1.5 ! misha 321: ** The sqlite3_exec() interface is a convenience wrapper around
! 322: ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
! 323: ** that allows an application to run multiple statements of SQL
! 324: ** without having to use a lot of C code.
! 325: **
! 326: ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
! 327: ** semicolon-separate SQL statements passed into its 2nd argument,
! 328: ** in the context of the [database connection] passed in as its 1st
! 329: ** argument. ^If the callback function of the 3rd argument to
! 330: ** sqlite3_exec() is not NULL, then it is invoked for each result row
! 331: ** coming out of the evaluated SQL statements. ^The 4th argument to
! 332: ** sqlite3_exec() is relayed through to the 1st argument of each
! 333: ** callback invocation. ^If the callback pointer to sqlite3_exec()
! 334: ** is NULL, then no callback is ever invoked and result rows are
! 335: ** ignored.
! 336: **
! 337: ** ^If an error occurs while evaluating the SQL statements passed into
! 338: ** sqlite3_exec(), then execution of the current statement stops and
! 339: ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
! 340: ** is not NULL then any error message is written into memory obtained
! 341: ** from [sqlite3_malloc()] and passed back through the 5th parameter.
! 342: ** To avoid memory leaks, the application should invoke [sqlite3_free()]
! 343: ** on error message strings returned through the 5th parameter of
! 344: ** of sqlite3_exec() after the error message string is no longer needed.
! 345: ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
! 346: ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
! 347: ** NULL before returning.
! 348: **
! 349: ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
! 350: ** routine returns SQLITE_ABORT without invoking the callback again and
! 351: ** without running any subsequent SQL statements.
! 352: **
! 353: ** ^The 2nd argument to the sqlite3_exec() callback function is the
! 354: ** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
! 355: ** callback is an array of pointers to strings obtained as if from
! 356: ** [sqlite3_column_text()], one for each column. ^If an element of a
! 357: ** result row is NULL then the corresponding string pointer for the
! 358: ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
! 359: ** sqlite3_exec() callback is an array of pointers to strings where each
! 360: ** entry represents the name of corresponding result column as obtained
! 361: ** from [sqlite3_column_name()].
! 362: **
! 363: ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
! 364: ** to an empty string, or a pointer that contains only whitespace and/or
! 365: ** SQL comments, then no SQL statements are evaluated and the database
! 366: ** is not changed.
1.4 misha 367: **
1.5 ! misha 368: ** Restrictions:
1.2 misha 369: **
1.5 ! misha 370: ** <ul>
! 371: ** <li> The application must insure that the 1st parameter to sqlite3_exec()
! 372: ** is a valid and open [database connection].
! 373: ** <li> The application must not close [database connection] specified by
! 374: ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
! 375: ** <li> The application must not modify the SQL statement text passed into
! 376: ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
! 377: ** </ul>
1.1 misha 378: */
1.5 ! misha 379: SQLITE_API int sqlite3_exec(
1.2 misha 380: sqlite3*, /* An open database */
1.5 ! misha 381: const char *sql, /* SQL to be evaluated */
1.2 misha 382: int (*callback)(void*,int,char**,char**), /* Callback function */
383: void *, /* 1st argument to callback */
384: char **errmsg /* Error msg written here */
1.1 misha 385: );
386:
387: /*
1.5 ! misha 388: ** CAPI3REF: Result Codes
1.4 misha 389: ** KEYWORDS: SQLITE_OK {error code} {error codes}
1.5 ! misha 390: ** KEYWORDS: {result code} {result codes}
1.2 misha 391: **
392: ** Many SQLite functions return an integer result code from the set shown
1.5 ! misha 393: ** here in order to indicate success or failure.
! 394: **
! 395: ** New error codes may be added in future versions of SQLite.
1.2 misha 396: **
1.5 ! misha 397: ** See also: [SQLITE_IOERR_READ | extended result codes],
! 398: ** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes].
1.1 misha 399: */
400: #define SQLITE_OK 0 /* Successful result */
1.2 misha 401: /* beginning-of-error-codes */
1.1 misha 402: #define SQLITE_ERROR 1 /* SQL error or missing database */
1.4 misha 403: #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
1.1 misha 404: #define SQLITE_PERM 3 /* Access permission denied */
405: #define SQLITE_ABORT 4 /* Callback routine requested an abort */
406: #define SQLITE_BUSY 5 /* The database file is locked */
407: #define SQLITE_LOCKED 6 /* A table in the database is locked */
408: #define SQLITE_NOMEM 7 /* A malloc() failed */
409: #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
410: #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
411: #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
412: #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
1.5 ! misha 413: #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
1.1 misha 414: #define SQLITE_FULL 13 /* Insertion failed because database is full */
415: #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
1.5 ! misha 416: #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
1.1 misha 417: #define SQLITE_EMPTY 16 /* Database is empty */
418: #define SQLITE_SCHEMA 17 /* The database schema changed */
1.2 misha 419: #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
420: #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
1.1 misha 421: #define SQLITE_MISMATCH 20 /* Data type mismatch */
422: #define SQLITE_MISUSE 21 /* Library used incorrectly */
423: #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
424: #define SQLITE_AUTH 23 /* Authorization denied */
425: #define SQLITE_FORMAT 24 /* Auxiliary database format error */
426: #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
427: #define SQLITE_NOTADB 26 /* File opened that is not a database file */
1.5 ! misha 428: #define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
! 429: #define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
1.1 misha 430: #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
431: #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
1.2 misha 432: /* end-of-error-codes */
1.1 misha 433:
434: /*
1.5 ! misha 435: ** CAPI3REF: Extended Result Codes
1.4 misha 436: ** KEYWORDS: {extended error code} {extended error codes}
1.5 ! misha 437: ** KEYWORDS: {extended result code} {extended result codes}
1.1 misha 438: **
1.2 misha 439: ** In its default configuration, SQLite API routines return one of 26 integer
1.5 ! misha 440: ** [SQLITE_OK | result codes]. However, experience has shown that many of
! 441: ** these result codes are too coarse-grained. They do not provide as
1.4 misha 442: ** much information about problems as programmers might like. In an effort to
1.2 misha 443: ** address this, newer versions of SQLite (version 3.3.8 and later) include
444: ** support for additional result codes that provide more detailed information
1.4 misha 445: ** about errors. The extended result codes are enabled or disabled
1.5 ! misha 446: ** on a per database connection basis using the
! 447: ** [sqlite3_extended_result_codes()] API.
! 448: **
1.4 misha 449: ** Some of the available extended result codes are listed here.
450: ** One may expect the number of extended result codes will be expand
1.2 misha 451: ** over time. Software that uses extended result codes should expect
452: ** to see new result codes in future releases of SQLite.
453: **
454: ** The SQLITE_OK result code will never be extended. It will always
455: ** be exactly zero.
1.5 ! misha 456: */
! 457: #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
! 458: #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
! 459: #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
! 460: #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
! 461: #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
! 462: #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
! 463: #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
! 464: #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
! 465: #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
! 466: #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
! 467: #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
! 468: #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
! 469: #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
! 470: #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
! 471: #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
! 472: #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
! 473: #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
! 474: #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
! 475: #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
! 476: #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
! 477: #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
! 478: #define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
! 479: #define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8))
! 480: #define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
! 481: #define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8))
! 482: #define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8))
! 483: #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
! 484: #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
! 485: #define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8))
! 486: #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
! 487: #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8))
! 488: #define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8))
! 489: #define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8))
! 490: #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8))
! 491: #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8))
! 492: #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8))
! 493: #define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8))
! 494: #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8))
! 495: #define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8))
! 496: #define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8))
! 497: #define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8))
! 498: #define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8))
! 499: #define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8))
! 500: #define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8))
! 501: #define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8))
! 502: #define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8))
! 503: #define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8))
! 504: #define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8))
! 505: #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
! 506: #define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8))
1.2 misha 507:
508: /*
1.5 ! misha 509: ** CAPI3REF: Flags For File Open Operations
1.2 misha 510: **
1.4 misha 511: ** These bit values are intended for use in the
512: ** 3rd parameter to the [sqlite3_open_v2()] interface and
1.5 ! misha 513: ** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
1.2 misha 514: */
1.5 ! misha 515: #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
! 516: #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
! 517: #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
! 518: #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
! 519: #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
! 520: #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
! 521: #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
! 522: #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
! 523: #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
! 524: #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
! 525: #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
! 526: #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
! 527: #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
! 528: #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
! 529: #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
! 530: #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
! 531: #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
! 532: #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
! 533: #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
! 534: #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
! 535:
! 536: /* Reserved: 0x00F00000 */
1.2 misha 537:
538: /*
1.5 ! misha 539: ** CAPI3REF: Device Characteristics
1.2 misha 540: **
1.5 ! misha 541: ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
! 542: ** object returns an integer which is a vector of these
1.2 misha 543: ** bit values expressing I/O characteristics of the mass storage
544: ** device that holds the file that the [sqlite3_io_methods]
545: ** refers to.
546: **
547: ** The SQLITE_IOCAP_ATOMIC property means that all writes of
548: ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
549: ** mean that writes of blocks that are nnn bytes in size and
550: ** are aligned to an address which is an integer multiple of
551: ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
552: ** that when data is appended to a file, the data is appended
553: ** first then the size of the file is extended, never the other
554: ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
555: ** information is written to disk in the same order as calls
1.5 ! misha 556: ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
! 557: ** after reboot following a crash or power loss, the only bytes in a
! 558: ** file that were written at the application level might have changed
! 559: ** and that adjacent bytes, even bytes within the same sector are
! 560: ** guaranteed to be unchanged.
! 561: */
! 562: #define SQLITE_IOCAP_ATOMIC 0x00000001
! 563: #define SQLITE_IOCAP_ATOMIC512 0x00000002
! 564: #define SQLITE_IOCAP_ATOMIC1K 0x00000004
! 565: #define SQLITE_IOCAP_ATOMIC2K 0x00000008
! 566: #define SQLITE_IOCAP_ATOMIC4K 0x00000010
! 567: #define SQLITE_IOCAP_ATOMIC8K 0x00000020
! 568: #define SQLITE_IOCAP_ATOMIC16K 0x00000040
! 569: #define SQLITE_IOCAP_ATOMIC32K 0x00000080
! 570: #define SQLITE_IOCAP_ATOMIC64K 0x00000100
! 571: #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
! 572: #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
! 573: #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
! 574: #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
1.2 misha 575:
576: /*
1.5 ! misha 577: ** CAPI3REF: File Locking Levels
1.2 misha 578: **
1.4 misha 579: ** SQLite uses one of these integer values as the second
1.2 misha 580: ** argument to calls it makes to the xLock() and xUnlock() methods
581: ** of an [sqlite3_io_methods] object.
582: */
583: #define SQLITE_LOCK_NONE 0
584: #define SQLITE_LOCK_SHARED 1
585: #define SQLITE_LOCK_RESERVED 2
586: #define SQLITE_LOCK_PENDING 3
587: #define SQLITE_LOCK_EXCLUSIVE 4
588:
589: /*
1.5 ! misha 590: ** CAPI3REF: Synchronization Type Flags
1.2 misha 591: **
1.4 misha 592: ** When SQLite invokes the xSync() method of an
593: ** [sqlite3_io_methods] object it uses a combination of
594: ** these integer values as the second argument.
1.2 misha 595: **
596: ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
597: ** sync operation only needs to flush data to mass storage. Inode
1.5 ! misha 598: ** information need not be flushed. If the lower four bits of the flag
! 599: ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
! 600: ** If the lower four bits equal SQLITE_SYNC_FULL, that means
! 601: ** to use Mac OS X style fullsync instead of fsync().
! 602: **
! 603: ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
! 604: ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
! 605: ** settings. The [synchronous pragma] determines when calls to the
! 606: ** xSync VFS method occur and applies uniformly across all platforms.
! 607: ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
! 608: ** energetic or rigorous or forceful the sync operations are and
! 609: ** only make a difference on Mac OSX for the default SQLite code.
! 610: ** (Third-party VFS implementations might also make the distinction
! 611: ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
! 612: ** operating systems natively supported by SQLite, only Mac OSX
! 613: ** cares about the difference.)
1.2 misha 614: */
615: #define SQLITE_SYNC_NORMAL 0x00002
616: #define SQLITE_SYNC_FULL 0x00003
617: #define SQLITE_SYNC_DATAONLY 0x00010
618:
619: /*
1.5 ! misha 620: ** CAPI3REF: OS Interface Open File Handle
1.2 misha 621: **
1.5 ! misha 622: ** An [sqlite3_file] object represents an open file in the
! 623: ** [sqlite3_vfs | OS interface layer]. Individual OS interface
! 624: ** implementations will
1.2 misha 625: ** want to subclass this object by appending additional fields
626: ** for their own use. The pMethods entry is a pointer to an
627: ** [sqlite3_io_methods] object that defines methods for performing
628: ** I/O operations on the open file.
629: */
630: typedef struct sqlite3_file sqlite3_file;
631: struct sqlite3_file {
632: const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
633: };
634:
635: /*
1.5 ! misha 636: ** CAPI3REF: OS Interface File Virtual Methods Object
1.2 misha 637: **
1.5 ! misha 638: ** Every file opened by the [sqlite3_vfs.xOpen] method populates an
! 639: ** [sqlite3_file] object (or, more commonly, a subclass of the
! 640: ** [sqlite3_file] object) with a pointer to an instance of this object.
! 641: ** This object defines the methods used to perform various operations
! 642: ** against the open file represented by the [sqlite3_file] object.
! 643: **
! 644: ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
! 645: ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
! 646: ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
! 647: ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
! 648: ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
! 649: ** to NULL.
1.2 misha 650: **
651: ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
652: ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
1.5 ! misha 653: ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
! 654: ** flag may be ORed in to indicate that only the data of the file
! 655: ** and not its inode needs to be synced.
! 656: **
1.2 misha 657: ** The integer values to xLock() and xUnlock() are one of
658: ** <ul>
659: ** <li> [SQLITE_LOCK_NONE],
660: ** <li> [SQLITE_LOCK_SHARED],
661: ** <li> [SQLITE_LOCK_RESERVED],
662: ** <li> [SQLITE_LOCK_PENDING], or
663: ** <li> [SQLITE_LOCK_EXCLUSIVE].
664: ** </ul>
1.5 ! misha 665: ** xLock() increases the lock. xUnlock() decreases the lock.
! 666: ** The xCheckReservedLock() method checks whether any database connection,
! 667: ** either in this process or in some other process, is holding a RESERVED,
1.2 misha 668: ** PENDING, or EXCLUSIVE lock on the file. It returns true
1.5 ! misha 669: ** if such a lock exists and false otherwise.
! 670: **
1.2 misha 671: ** The xFileControl() method is a generic interface that allows custom
672: ** VFS implementations to directly control an open file using the
1.5 ! misha 673: ** [sqlite3_file_control()] interface. The second "op" argument is an
! 674: ** integer opcode. The third argument is a generic pointer intended to
! 675: ** point to a structure that may contain arguments or space in which to
1.2 misha 676: ** write return values. Potential uses for xFileControl() might be
677: ** functions to enable blocking locks with timeouts, to change the
678: ** locking strategy (for example to use dot-file locks), to inquire
679: ** about the status of a lock, or to break stale locks. The SQLite
1.5 ! misha 680: ** core reserves all opcodes less than 100 for its own use.
1.2 misha 681: ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
1.5 ! misha 682: ** Applications that define a custom xFileControl method should use opcodes
! 683: ** greater than 100 to avoid conflicts. VFS implementations should
! 684: ** return [SQLITE_NOTFOUND] for file control opcodes that they do not
! 685: ** recognize.
1.2 misha 686: **
687: ** The xSectorSize() method returns the sector size of the
688: ** device that underlies the file. The sector size is the
689: ** minimum write that can be performed without disturbing
690: ** other bytes in the file. The xDeviceCharacteristics()
691: ** method returns a bit vector describing behaviors of the
692: ** underlying device:
693: **
694: ** <ul>
695: ** <li> [SQLITE_IOCAP_ATOMIC]
696: ** <li> [SQLITE_IOCAP_ATOMIC512]
697: ** <li> [SQLITE_IOCAP_ATOMIC1K]
698: ** <li> [SQLITE_IOCAP_ATOMIC2K]
699: ** <li> [SQLITE_IOCAP_ATOMIC4K]
700: ** <li> [SQLITE_IOCAP_ATOMIC8K]
701: ** <li> [SQLITE_IOCAP_ATOMIC16K]
702: ** <li> [SQLITE_IOCAP_ATOMIC32K]
703: ** <li> [SQLITE_IOCAP_ATOMIC64K]
704: ** <li> [SQLITE_IOCAP_SAFE_APPEND]
705: ** <li> [SQLITE_IOCAP_SEQUENTIAL]
706: ** </ul>
707: **
708: ** The SQLITE_IOCAP_ATOMIC property means that all writes of
709: ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
710: ** mean that writes of blocks that are nnn bytes in size and
711: ** are aligned to an address which is an integer multiple of
712: ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
713: ** that when data is appended to a file, the data is appended
714: ** first then the size of the file is extended, never the other
715: ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
716: ** information is written to disk in the same order as calls
717: ** to xWrite().
1.5 ! misha 718: **
! 719: ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
! 720: ** in the unread portions of the buffer with zeros. A VFS that
! 721: ** fails to zero-fill short reads might seem to work. However,
! 722: ** failure to zero-fill short reads will eventually lead to
! 723: ** database corruption.
1.2 misha 724: */
725: typedef struct sqlite3_io_methods sqlite3_io_methods;
726: struct sqlite3_io_methods {
727: int iVersion;
728: int (*xClose)(sqlite3_file*);
729: int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
730: int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
731: int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
732: int (*xSync)(sqlite3_file*, int flags);
733: int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
734: int (*xLock)(sqlite3_file*, int);
735: int (*xUnlock)(sqlite3_file*, int);
1.5 ! misha 736: int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
1.2 misha 737: int (*xFileControl)(sqlite3_file*, int op, void *pArg);
738: int (*xSectorSize)(sqlite3_file*);
739: int (*xDeviceCharacteristics)(sqlite3_file*);
1.5 ! misha 740: /* Methods above are valid for version 1 */
! 741: int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
! 742: int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
! 743: void (*xShmBarrier)(sqlite3_file*);
! 744: int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
! 745: /* Methods above are valid for version 2 */
! 746: int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
! 747: int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
! 748: /* Methods above are valid for version 3 */
1.2 misha 749: /* Additional methods may be added in future releases */
750: };
751:
752: /*
1.5 ! misha 753: ** CAPI3REF: Standard File Control Opcodes
1.2 misha 754: **
755: ** These integer constants are opcodes for the xFileControl method
1.5 ! misha 756: ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
1.2 misha 757: ** interface.
758: **
759: ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
1.4 misha 760: ** opcode causes the xFileControl method to write the current state of
1.2 misha 761: ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
762: ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
1.4 misha 763: ** into an integer that the pArg argument points to. This capability
1.2 misha 764: ** is used during testing and only needs to be supported when SQLITE_TEST
765: ** is defined.
1.5 ! misha 766: ** <ul>
! 767: ** <li>[[SQLITE_FCNTL_SIZE_HINT]]
! 768: ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
! 769: ** layer a hint of how large the database file will grow to be during the
! 770: ** current transaction. This hint is not guaranteed to be accurate but it
! 771: ** is often close. The underlying VFS might choose to preallocate database
! 772: ** file space based on this hint in order to help writes to the database
! 773: ** file run faster.
! 774: **
! 775: ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
! 776: ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
! 777: ** extends and truncates the database file in chunks of a size specified
! 778: ** by the user. The fourth argument to [sqlite3_file_control()] should
! 779: ** point to an integer (type int) containing the new chunk-size to use
! 780: ** for the nominated database. Allocating database file space in large
! 781: ** chunks (say 1MB at a time), may reduce file-system fragmentation and
! 782: ** improve performance on some systems.
! 783: **
! 784: ** <li>[[SQLITE_FCNTL_FILE_POINTER]]
! 785: ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
! 786: ** to the [sqlite3_file] object associated with a particular database
! 787: ** connection. See the [sqlite3_file_control()] documentation for
! 788: ** additional information.
! 789: **
! 790: ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
! 791: ** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by
! 792: ** SQLite and sent to all VFSes in place of a call to the xSync method
! 793: ** when the database connection has [PRAGMA synchronous] set to OFF.)^
! 794: ** Some specialized VFSes need this signal in order to operate correctly
! 795: ** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most
! 796: ** VFSes do not need this signal and should silently ignore this opcode.
! 797: ** Applications should not call [sqlite3_file_control()] with this
! 798: ** opcode as doing so may disrupt the operation of the specialized VFSes
! 799: ** that do require it.
! 800: **
! 801: ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
! 802: ** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
! 803: ** retry counts and intervals for certain disk I/O operations for the
! 804: ** windows [VFS] in order to provide robustness in the presence of
! 805: ** anti-virus programs. By default, the windows VFS will retry file read,
! 806: ** file write, and file delete operations up to 10 times, with a delay
! 807: ** of 25 milliseconds before the first retry and with the delay increasing
! 808: ** by an additional 25 milliseconds with each subsequent retry. This
! 809: ** opcode allows these two values (10 retries and 25 milliseconds of delay)
! 810: ** to be adjusted. The values are changed for all database connections
! 811: ** within the same process. The argument is a pointer to an array of two
! 812: ** integers where the first integer i the new retry count and the second
! 813: ** integer is the delay. If either integer is negative, then the setting
! 814: ** is not changed but instead the prior value of that setting is written
! 815: ** into the array entry, allowing the current retry settings to be
! 816: ** interrogated. The zDbName parameter is ignored.
! 817: **
! 818: ** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
! 819: ** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
! 820: ** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
! 821: ** write ahead log and shared memory files used for transaction control
! 822: ** are automatically deleted when the latest connection to the database
! 823: ** closes. Setting persistent WAL mode causes those files to persist after
! 824: ** close. Persisting the files is useful when other processes that do not
! 825: ** have write permission on the directory containing the database file want
! 826: ** to read the database file, as the WAL and shared memory files must exist
! 827: ** in order for the database to be readable. The fourth parameter to
! 828: ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
! 829: ** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
! 830: ** WAL mode. If the integer is -1, then it is overwritten with the current
! 831: ** WAL persistence setting.
! 832: **
! 833: ** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
! 834: ** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
! 835: ** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
! 836: ** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
! 837: ** xDeviceCharacteristics methods. The fourth parameter to
! 838: ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
! 839: ** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
! 840: ** mode. If the integer is -1, then it is overwritten with the current
! 841: ** zero-damage mode setting.
! 842: **
! 843: ** <li>[[SQLITE_FCNTL_OVERWRITE]]
! 844: ** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
! 845: ** a write transaction to indicate that, unless it is rolled back for some
! 846: ** reason, the entire database file will be overwritten by the current
! 847: ** transaction. This is used by VACUUM operations.
! 848: **
! 849: ** <li>[[SQLITE_FCNTL_VFSNAME]]
! 850: ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
! 851: ** all [VFSes] in the VFS stack. The names are of all VFS shims and the
! 852: ** final bottom-level VFS are written into memory obtained from
! 853: ** [sqlite3_malloc()] and the result is stored in the char* variable
! 854: ** that the fourth parameter of [sqlite3_file_control()] points to.
! 855: ** The caller is responsible for freeing the memory when done. As with
! 856: ** all file-control actions, there is no guarantee that this will actually
! 857: ** do anything. Callers should initialize the char* variable to a NULL
! 858: ** pointer in case this file-control is not implemented. This file-control
! 859: ** is intended for diagnostic use only.
! 860: **
! 861: ** <li>[[SQLITE_FCNTL_PRAGMA]]
! 862: ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
! 863: ** file control is sent to the open [sqlite3_file] object corresponding
! 864: ** to the database file to which the pragma statement refers. ^The argument
! 865: ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
! 866: ** pointers to strings (char**) in which the second element of the array
! 867: ** is the name of the pragma and the third element is the argument to the
! 868: ** pragma or NULL if the pragma has no argument. ^The handler for an
! 869: ** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
! 870: ** of the char** argument point to a string obtained from [sqlite3_mprintf()]
! 871: ** or the equivalent and that string will become the result of the pragma or
! 872: ** the error message if the pragma fails. ^If the
! 873: ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
! 874: ** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
! 875: ** file control returns [SQLITE_OK], then the parser assumes that the
! 876: ** VFS has handled the PRAGMA itself and the parser generates a no-op
! 877: ** prepared statement. ^If the [SQLITE_FCNTL_PRAGMA] file control returns
! 878: ** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
! 879: ** that the VFS encountered an error while handling the [PRAGMA] and the
! 880: ** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
! 881: ** file control occurs at the beginning of pragma statement analysis and so
! 882: ** it is able to override built-in [PRAGMA] statements.
! 883: **
! 884: ** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
! 885: ** ^The [SQLITE_FCNTL_BUSYHANDLER]
! 886: ** file-control may be invoked by SQLite on the database file handle
! 887: ** shortly after it is opened in order to provide a custom VFS with access
! 888: ** to the connections busy-handler callback. The argument is of type (void **)
! 889: ** - an array of two (void *) values. The first (void *) actually points
! 890: ** to a function of type (int (*)(void *)). In order to invoke the connections
! 891: ** busy-handler, this function should be invoked with the second (void *) in
! 892: ** the array as the only argument. If it returns non-zero, then the operation
! 893: ** should be retried. If it returns zero, the custom VFS should abandon the
! 894: ** current operation.
! 895: **
! 896: ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
! 897: ** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
! 898: ** to have SQLite generate a
! 899: ** temporary filename using the same algorithm that is followed to generate
! 900: ** temporary filenames for TEMP tables and other internal uses. The
! 901: ** argument should be a char** which will be filled with the filename
! 902: ** written into memory obtained from [sqlite3_malloc()]. The caller should
! 903: ** invoke [sqlite3_free()] on the result to avoid a memory leak.
! 904: **
! 905: ** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
! 906: ** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
! 907: ** maximum number of bytes that will be used for memory-mapped I/O.
! 908: ** The argument is a pointer to a value of type sqlite3_int64 that
! 909: ** is an advisory maximum number of bytes in the file to memory map. The
! 910: ** pointer is overwritten with the old value. The limit is not changed if
! 911: ** the value originally pointed to is negative, and so the current limit
! 912: ** can be queried by passing in a pointer to a negative number. This
! 913: ** file-control is used internally to implement [PRAGMA mmap_size].
! 914: **
! 915: ** </ul>
1.2 misha 916: */
1.5 ! misha 917: #define SQLITE_FCNTL_LOCKSTATE 1
! 918: #define SQLITE_GET_LOCKPROXYFILE 2
! 919: #define SQLITE_SET_LOCKPROXYFILE 3
! 920: #define SQLITE_LAST_ERRNO 4
! 921: #define SQLITE_FCNTL_SIZE_HINT 5
! 922: #define SQLITE_FCNTL_CHUNK_SIZE 6
! 923: #define SQLITE_FCNTL_FILE_POINTER 7
! 924: #define SQLITE_FCNTL_SYNC_OMITTED 8
! 925: #define SQLITE_FCNTL_WIN32_AV_RETRY 9
! 926: #define SQLITE_FCNTL_PERSIST_WAL 10
! 927: #define SQLITE_FCNTL_OVERWRITE 11
! 928: #define SQLITE_FCNTL_VFSNAME 12
! 929: #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
! 930: #define SQLITE_FCNTL_PRAGMA 14
! 931: #define SQLITE_FCNTL_BUSYHANDLER 15
! 932: #define SQLITE_FCNTL_TEMPFILENAME 16
! 933: #define SQLITE_FCNTL_MMAP_SIZE 18
1.2 misha 934:
935: /*
1.5 ! misha 936: ** CAPI3REF: Mutex Handle
1.2 misha 937: **
938: ** The mutex module within SQLite defines [sqlite3_mutex] to be an
939: ** abstract type for a mutex object. The SQLite core never looks
940: ** at the internal representation of an [sqlite3_mutex]. It only
941: ** deals with pointers to the [sqlite3_mutex] object.
942: **
943: ** Mutexes are created using [sqlite3_mutex_alloc()].
944: */
945: typedef struct sqlite3_mutex sqlite3_mutex;
946:
947: /*
1.5 ! misha 948: ** CAPI3REF: OS Interface Object
1.2 misha 949: **
1.5 ! misha 950: ** An instance of the sqlite3_vfs object defines the interface between
! 951: ** the SQLite core and the underlying operating system. The "vfs"
! 952: ** in the name of the object stands for "virtual file system". See
! 953: ** the [VFS | VFS documentation] for further information.
! 954: **
! 955: ** The value of the iVersion field is initially 1 but may be larger in
! 956: ** future versions of SQLite. Additional fields may be appended to this
! 957: ** object when the iVersion value is increased. Note that the structure
! 958: ** of the sqlite3_vfs object changes in the transaction between
! 959: ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
! 960: ** modified.
1.2 misha 961: **
962: ** The szOsFile field is the size of the subclassed [sqlite3_file]
963: ** structure used by this VFS. mxPathname is the maximum length of
964: ** a pathname in this VFS.
965: **
1.4 misha 966: ** Registered sqlite3_vfs objects are kept on a linked list formed by
1.2 misha 967: ** the pNext pointer. The [sqlite3_vfs_register()]
968: ** and [sqlite3_vfs_unregister()] interfaces manage this list
969: ** in a thread-safe way. The [sqlite3_vfs_find()] interface
1.5 ! misha 970: ** searches the list. Neither the application code nor the VFS
! 971: ** implementation should use the pNext pointer.
1.2 misha 972: **
1.5 ! misha 973: ** The pNext field is the only field in the sqlite3_vfs
1.2 misha 974: ** structure that SQLite will ever modify. SQLite will only access
975: ** or modify this field while holding a particular static mutex.
976: ** The application should never modify anything within the sqlite3_vfs
977: ** object once the object has been registered.
978: **
979: ** The zName field holds the name of the VFS module. The name must
980: ** be unique across all VFS modules.
981: **
1.5 ! misha 982: ** [[sqlite3_vfs.xOpen]]
! 983: ** ^SQLite guarantees that the zFilename parameter to xOpen
! 984: ** is either a NULL pointer or string obtained
! 985: ** from xFullPathname() with an optional suffix added.
! 986: ** ^If a suffix is added to the zFilename parameter, it will
! 987: ** consist of a single "-" character followed by no more than
! 988: ** 11 alphanumeric and/or "-" characters.
! 989: ** ^SQLite further guarantees that
! 990: ** the string will be valid and unchanged until xClose() is
! 991: ** called. Because of the previous sentence,
! 992: ** the [sqlite3_file] can safely store a pointer to the
1.2 misha 993: ** filename if it needs to remember the filename for some reason.
1.5 ! misha 994: ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
! 995: ** must invent its own temporary name for the file. ^Whenever the
! 996: ** xFilename parameter is NULL it will also be the case that the
! 997: ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
1.2 misha 998: **
1.5 ! misha 999: ** The flags argument to xOpen() includes all bits set in
1.4 misha 1000: ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
1001: ** or [sqlite3_open16()] is used, then flags includes at least
1.5 ! misha 1002: ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
1.2 misha 1003: ** If xOpen() opens a file read-only then it sets *pOutFlags to
1.5 ! misha 1004: ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
! 1005: **
! 1006: ** ^(SQLite will also add one of the following flags to the xOpen()
1.2 misha 1007: ** call, depending on the object being opened:
1.5 ! misha 1008: **
1.2 misha 1009: ** <ul>
1010: ** <li> [SQLITE_OPEN_MAIN_DB]
1011: ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
1012: ** <li> [SQLITE_OPEN_TEMP_DB]
1013: ** <li> [SQLITE_OPEN_TEMP_JOURNAL]
1014: ** <li> [SQLITE_OPEN_TRANSIENT_DB]
1015: ** <li> [SQLITE_OPEN_SUBJOURNAL]
1016: ** <li> [SQLITE_OPEN_MASTER_JOURNAL]
1.5 ! misha 1017: ** <li> [SQLITE_OPEN_WAL]
! 1018: ** </ul>)^
1.2 misha 1019: **
1020: ** The file I/O implementation can use the object type flags to
1.5 ! misha 1021: ** change the way it deals with files. For example, an application
1.4 misha 1022: ** that does not care about crash recovery or rollback might make
1023: ** the open of a journal file a no-op. Writes to this journal would
1.5 ! misha 1024: ** also be no-ops, and any attempt to read the journal would return
! 1025: ** SQLITE_IOERR. Or the implementation might recognize that a database
! 1026: ** file will be doing page-aligned sector reads and writes in a random
1.4 misha 1027: ** order and set up its I/O subsystem accordingly.
1.5 ! misha 1028: **
! 1029: ** SQLite might also add one of the following flags to the xOpen method:
! 1030: **
1.2 misha 1031: ** <ul>
1032: ** <li> [SQLITE_OPEN_DELETEONCLOSE]
1033: ** <li> [SQLITE_OPEN_EXCLUSIVE]
1034: ** </ul>
1.5 ! misha 1035: **
! 1036: ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
! 1037: ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
! 1038: ** will be set for TEMP databases and their journals, transient
! 1039: ** databases, and subjournals.
! 1040: **
! 1041: ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
! 1042: ** with the [SQLITE_OPEN_CREATE] flag, which are both directly
! 1043: ** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
! 1044: ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
! 1045: ** SQLITE_OPEN_CREATE, is used to indicate that file should always
! 1046: ** be created, and that it is an error if it already exists.
! 1047: ** It is <i>not</i> used to indicate the file should be opened
! 1048: ** for exclusive access.
! 1049: **
! 1050: ** ^At least szOsFile bytes of memory are allocated by SQLite
! 1051: ** to hold the [sqlite3_file] structure passed as the third
! 1052: ** argument to xOpen. The xOpen method does not have to
! 1053: ** allocate the structure; it should just fill it in. Note that
! 1054: ** the xOpen method must set the sqlite3_file.pMethods to either
! 1055: ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
! 1056: ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
! 1057: ** element will be valid after xOpen returns regardless of the success
! 1058: ** or failure of the xOpen call.
! 1059: **
! 1060: ** [[sqlite3_vfs.xAccess]]
! 1061: ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
! 1062: ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
! 1063: ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
! 1064: ** to test whether a file is at least readable. The file can be a
1.2 misha 1065: ** directory.
1.5 ! misha 1066: **
! 1067: ** ^SQLite will always allocate at least mxPathname+1 bytes for the
! 1068: ** output buffer xFullPathname. The exact size of the output buffer
! 1069: ** is also passed as a parameter to both methods. If the output buffer
! 1070: ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
! 1071: ** handled as a fatal error by SQLite, vfs implementations should endeavor
! 1072: ** to prevent this by setting mxPathname to a sufficiently large value.
! 1073: **
! 1074: ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
! 1075: ** interfaces are not strictly a part of the filesystem, but they are
1.2 misha 1076: ** included in the VFS structure for completeness.
1077: ** The xRandomness() function attempts to return nBytes bytes
1078: ** of good-quality randomness into zOut. The return value is
1.5 ! misha 1079: ** the actual number of bytes of randomness obtained.
! 1080: ** The xSleep() method causes the calling thread to sleep for at
! 1081: ** least the number of microseconds given. ^The xCurrentTime()
! 1082: ** method returns a Julian Day Number for the current date and time as
! 1083: ** a floating point value.
! 1084: ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
! 1085: ** Day Number multiplied by 86400000 (the number of milliseconds in
! 1086: ** a 24-hour day).
! 1087: ** ^SQLite will use the xCurrentTimeInt64() method to get the current
! 1088: ** date and time if that method is available (if iVersion is 2 or
! 1089: ** greater and the function pointer is not NULL) and will fall back
! 1090: ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
! 1091: **
! 1092: ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
! 1093: ** are not used by the SQLite core. These optional interfaces are provided
! 1094: ** by some VFSes to facilitate testing of the VFS code. By overriding
! 1095: ** system calls with functions under its control, a test program can
! 1096: ** simulate faults and error conditions that would otherwise be difficult
! 1097: ** or impossible to induce. The set of system calls that can be overridden
! 1098: ** varies from one VFS to another, and from one version of the same VFS to the
! 1099: ** next. Applications that use these interfaces must be prepared for any
! 1100: ** or all of these interfaces to be NULL or for their behavior to change
! 1101: ** from one release to the next. Applications must not attempt to access
! 1102: ** any of these methods if the iVersion of the VFS is less than 3.
1.2 misha 1103: */
1104: typedef struct sqlite3_vfs sqlite3_vfs;
1.5 ! misha 1105: typedef void (*sqlite3_syscall_ptr)(void);
1.2 misha 1106: struct sqlite3_vfs {
1.5 ! misha 1107: int iVersion; /* Structure version number (currently 3) */
1.2 misha 1108: int szOsFile; /* Size of subclassed sqlite3_file */
1109: int mxPathname; /* Maximum file pathname length */
1110: sqlite3_vfs *pNext; /* Next registered VFS */
1111: const char *zName; /* Name of this virtual file system */
1112: void *pAppData; /* Pointer to application-specific data */
1113: int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
1114: int flags, int *pOutFlags);
1115: int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
1.5 ! misha 1116: int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
1.2 misha 1117: int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
1118: void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
1119: void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
1.5 ! misha 1120: void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
1.2 misha 1121: void (*xDlClose)(sqlite3_vfs*, void*);
1122: int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
1123: int (*xSleep)(sqlite3_vfs*, int microseconds);
1124: int (*xCurrentTime)(sqlite3_vfs*, double*);
1.5 ! misha 1125: int (*xGetLastError)(sqlite3_vfs*, int, char *);
! 1126: /*
! 1127: ** The methods above are in version 1 of the sqlite_vfs object
! 1128: ** definition. Those that follow are added in version 2 or later
! 1129: */
! 1130: int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
! 1131: /*
! 1132: ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
! 1133: ** Those below are for version 3 and greater.
! 1134: */
! 1135: int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
! 1136: sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
! 1137: const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
! 1138: /*
! 1139: ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
! 1140: ** New fields may be appended in figure versions. The iVersion
! 1141: ** value will increment whenever this happens.
! 1142: */
1.2 misha 1143: };
1144:
1145: /*
1.5 ! misha 1146: ** CAPI3REF: Flags for the xAccess VFS method
1.2 misha 1147: **
1.5 ! misha 1148: ** These integer constants can be used as the third parameter to
! 1149: ** the xAccess method of an [sqlite3_vfs] object. They determine
! 1150: ** what kind of permissions the xAccess method is looking for.
! 1151: ** With SQLITE_ACCESS_EXISTS, the xAccess method
! 1152: ** simply checks whether the file exists.
! 1153: ** With SQLITE_ACCESS_READWRITE, the xAccess method
! 1154: ** checks whether the named directory is both readable and writable
! 1155: ** (in other words, if files can be added, removed, and renamed within
! 1156: ** the directory).
! 1157: ** The SQLITE_ACCESS_READWRITE constant is currently used only by the
! 1158: ** [temp_store_directory pragma], though this could change in a future
! 1159: ** release of SQLite.
! 1160: ** With SQLITE_ACCESS_READ, the xAccess method
! 1161: ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
! 1162: ** currently unused, though it might be used in a future release of
! 1163: ** SQLite.
1.2 misha 1164: */
1165: #define SQLITE_ACCESS_EXISTS 0
1.5 ! misha 1166: #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
! 1167: #define SQLITE_ACCESS_READ 2 /* Unused */
1.2 misha 1168:
1169: /*
1.5 ! misha 1170: ** CAPI3REF: Flags for the xShmLock VFS method
! 1171: **
! 1172: ** These integer constants define the various locking operations
! 1173: ** allowed by the xShmLock method of [sqlite3_io_methods]. The
! 1174: ** following are the only legal combinations of flags to the
! 1175: ** xShmLock method:
! 1176: **
! 1177: ** <ul>
! 1178: ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
! 1179: ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
! 1180: ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
! 1181: ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
! 1182: ** </ul>
1.2 misha 1183: **
1.5 ! misha 1184: ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
! 1185: ** was given no the corresponding lock.
1.4 misha 1186: **
1.5 ! misha 1187: ** The xShmLock method can transition between unlocked and SHARED or
! 1188: ** between unlocked and EXCLUSIVE. It cannot transition between SHARED
! 1189: ** and EXCLUSIVE.
! 1190: */
! 1191: #define SQLITE_SHM_UNLOCK 1
! 1192: #define SQLITE_SHM_LOCK 2
! 1193: #define SQLITE_SHM_SHARED 4
! 1194: #define SQLITE_SHM_EXCLUSIVE 8
! 1195:
! 1196: /*
! 1197: ** CAPI3REF: Maximum xShmLock index
! 1198: **
! 1199: ** The xShmLock method on [sqlite3_io_methods] may use values
! 1200: ** between 0 and this upper bound as its "offset" argument.
! 1201: ** The SQLite core will never attempt to acquire or release a
! 1202: ** lock outside of this range
! 1203: */
! 1204: #define SQLITE_SHM_NLOCK 8
! 1205:
! 1206:
! 1207: /*
! 1208: ** CAPI3REF: Initialize The SQLite Library
! 1209: **
! 1210: ** ^The sqlite3_initialize() routine initializes the
! 1211: ** SQLite library. ^The sqlite3_shutdown() routine
! 1212: ** deallocates any resources that were allocated by sqlite3_initialize().
! 1213: ** These routines are designed to aid in process initialization and
! 1214: ** shutdown on embedded systems. Workstation applications using
! 1215: ** SQLite normally do not need to invoke either of these routines.
! 1216: **
! 1217: ** A call to sqlite3_initialize() is an "effective" call if it is
! 1218: ** the first time sqlite3_initialize() is invoked during the lifetime of
! 1219: ** the process, or if it is the first time sqlite3_initialize() is invoked
! 1220: ** following a call to sqlite3_shutdown(). ^(Only an effective call
! 1221: ** of sqlite3_initialize() does any initialization. All other calls
! 1222: ** are harmless no-ops.)^
! 1223: **
! 1224: ** A call to sqlite3_shutdown() is an "effective" call if it is the first
! 1225: ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
! 1226: ** an effective call to sqlite3_shutdown() does any deinitialization.
! 1227: ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
! 1228: **
! 1229: ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
! 1230: ** is not. The sqlite3_shutdown() interface must only be called from a
! 1231: ** single thread. All open [database connections] must be closed and all
! 1232: ** other SQLite resources must be deallocated prior to invoking
! 1233: ** sqlite3_shutdown().
! 1234: **
! 1235: ** Among other things, ^sqlite3_initialize() will invoke
! 1236: ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
! 1237: ** will invoke sqlite3_os_end().
! 1238: **
! 1239: ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
! 1240: ** ^If for some reason, sqlite3_initialize() is unable to initialize
! 1241: ** the library (perhaps it is unable to allocate a needed resource such
! 1242: ** as a mutex) it returns an [error code] other than [SQLITE_OK].
! 1243: **
! 1244: ** ^The sqlite3_initialize() routine is called internally by many other
! 1245: ** SQLite interfaces so that an application usually does not need to
! 1246: ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
! 1247: ** calls sqlite3_initialize() so the SQLite library will be automatically
! 1248: ** initialized when [sqlite3_open()] is called if it has not be initialized
! 1249: ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
! 1250: ** compile-time option, then the automatic calls to sqlite3_initialize()
! 1251: ** are omitted and the application must call sqlite3_initialize() directly
! 1252: ** prior to using any other SQLite interface. For maximum portability,
! 1253: ** it is recommended that applications always invoke sqlite3_initialize()
! 1254: ** directly prior to using any other SQLite interface. Future releases
! 1255: ** of SQLite may require this. In other words, the behavior exhibited
! 1256: ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
! 1257: ** default behavior in some future release of SQLite.
! 1258: **
! 1259: ** The sqlite3_os_init() routine does operating-system specific
! 1260: ** initialization of the SQLite library. The sqlite3_os_end()
! 1261: ** routine undoes the effect of sqlite3_os_init(). Typical tasks
! 1262: ** performed by these routines include allocation or deallocation
! 1263: ** of static resources, initialization of global variables,
! 1264: ** setting up a default [sqlite3_vfs] module, or setting up
! 1265: ** a default configuration using [sqlite3_config()].
! 1266: **
! 1267: ** The application should never invoke either sqlite3_os_init()
! 1268: ** or sqlite3_os_end() directly. The application should only invoke
! 1269: ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
! 1270: ** interface is called automatically by sqlite3_initialize() and
! 1271: ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
! 1272: ** implementations for sqlite3_os_init() and sqlite3_os_end()
! 1273: ** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
! 1274: ** When [custom builds | built for other platforms]
! 1275: ** (using the [SQLITE_OS_OTHER=1] compile-time
! 1276: ** option) the application must supply a suitable implementation for
! 1277: ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
! 1278: ** implementation of sqlite3_os_init() or sqlite3_os_end()
! 1279: ** must return [SQLITE_OK] on success and some other [error code] upon
! 1280: ** failure.
! 1281: */
! 1282: SQLITE_API int sqlite3_initialize(void);
! 1283: SQLITE_API int sqlite3_shutdown(void);
! 1284: SQLITE_API int sqlite3_os_init(void);
! 1285: SQLITE_API int sqlite3_os_end(void);
! 1286:
! 1287: /*
! 1288: ** CAPI3REF: Configuring The SQLite Library
! 1289: **
! 1290: ** The sqlite3_config() interface is used to make global configuration
! 1291: ** changes to SQLite in order to tune SQLite to the specific needs of
! 1292: ** the application. The default configuration is recommended for most
! 1293: ** applications and so this routine is usually not necessary. It is
! 1294: ** provided to support rare applications with unusual needs.
! 1295: **
! 1296: ** The sqlite3_config() interface is not threadsafe. The application
! 1297: ** must insure that no other SQLite interfaces are invoked by other
! 1298: ** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
! 1299: ** may only be invoked prior to library initialization using
! 1300: ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
! 1301: ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
! 1302: ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
! 1303: ** Note, however, that ^sqlite3_config() can be called as part of the
! 1304: ** implementation of an application-defined [sqlite3_os_init()].
! 1305: **
! 1306: ** The first argument to sqlite3_config() is an integer
! 1307: ** [configuration option] that determines
! 1308: ** what property of SQLite is to be configured. Subsequent arguments
! 1309: ** vary depending on the [configuration option]
! 1310: ** in the first argument.
! 1311: **
! 1312: ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
! 1313: ** ^If the option is unknown or SQLite is unable to set the option
! 1314: ** then this routine returns a non-zero [error code].
! 1315: */
! 1316: SQLITE_API int sqlite3_config(int, ...);
! 1317:
! 1318: /*
! 1319: ** CAPI3REF: Configure database connections
! 1320: **
! 1321: ** The sqlite3_db_config() interface is used to make configuration
! 1322: ** changes to a [database connection]. The interface is similar to
! 1323: ** [sqlite3_config()] except that the changes apply to a single
! 1324: ** [database connection] (specified in the first argument).
! 1325: **
! 1326: ** The second argument to sqlite3_db_config(D,V,...) is the
! 1327: ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
! 1328: ** that indicates what aspect of the [database connection] is being configured.
! 1329: ** Subsequent arguments vary depending on the configuration verb.
! 1330: **
! 1331: ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
! 1332: ** the call is considered successful.
! 1333: */
! 1334: SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
! 1335:
! 1336: /*
! 1337: ** CAPI3REF: Memory Allocation Routines
! 1338: **
! 1339: ** An instance of this object defines the interface between SQLite
! 1340: ** and low-level memory allocation routines.
! 1341: **
! 1342: ** This object is used in only one place in the SQLite interface.
! 1343: ** A pointer to an instance of this object is the argument to
! 1344: ** [sqlite3_config()] when the configuration option is
! 1345: ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
! 1346: ** By creating an instance of this object
! 1347: ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
! 1348: ** during configuration, an application can specify an alternative
! 1349: ** memory allocation subsystem for SQLite to use for all of its
! 1350: ** dynamic memory needs.
! 1351: **
! 1352: ** Note that SQLite comes with several [built-in memory allocators]
! 1353: ** that are perfectly adequate for the overwhelming majority of applications
! 1354: ** and that this object is only useful to a tiny minority of applications
! 1355: ** with specialized memory allocation requirements. This object is
! 1356: ** also used during testing of SQLite in order to specify an alternative
! 1357: ** memory allocator that simulates memory out-of-memory conditions in
! 1358: ** order to verify that SQLite recovers gracefully from such
! 1359: ** conditions.
! 1360: **
! 1361: ** The xMalloc, xRealloc, and xFree methods must work like the
! 1362: ** malloc(), realloc() and free() functions from the standard C library.
! 1363: ** ^SQLite guarantees that the second argument to
! 1364: ** xRealloc is always a value returned by a prior call to xRoundup.
! 1365: **
! 1366: ** xSize should return the allocated size of a memory allocation
! 1367: ** previously obtained from xMalloc or xRealloc. The allocated size
! 1368: ** is always at least as big as the requested size but may be larger.
! 1369: **
! 1370: ** The xRoundup method returns what would be the allocated size of
! 1371: ** a memory allocation given a particular requested size. Most memory
! 1372: ** allocators round up memory allocations at least to the next multiple
! 1373: ** of 8. Some allocators round up to a larger multiple or to a power of 2.
! 1374: ** Every memory allocation request coming in through [sqlite3_malloc()]
! 1375: ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
! 1376: ** that causes the corresponding memory allocation to fail.
! 1377: **
! 1378: ** The xInit method initializes the memory allocator. (For example,
! 1379: ** it might allocate any require mutexes or initialize internal data
! 1380: ** structures. The xShutdown method is invoked (indirectly) by
! 1381: ** [sqlite3_shutdown()] and should deallocate any resources acquired
! 1382: ** by xInit. The pAppData pointer is used as the only parameter to
! 1383: ** xInit and xShutdown.
! 1384: **
! 1385: ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
! 1386: ** the xInit method, so the xInit method need not be threadsafe. The
! 1387: ** xShutdown method is only called from [sqlite3_shutdown()] so it does
! 1388: ** not need to be threadsafe either. For all other methods, SQLite
! 1389: ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
! 1390: ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
! 1391: ** it is by default) and so the methods are automatically serialized.
! 1392: ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
! 1393: ** methods must be threadsafe or else make their own arrangements for
! 1394: ** serialization.
! 1395: **
! 1396: ** SQLite will never invoke xInit() more than once without an intervening
! 1397: ** call to xShutdown().
! 1398: */
! 1399: typedef struct sqlite3_mem_methods sqlite3_mem_methods;
! 1400: struct sqlite3_mem_methods {
! 1401: void *(*xMalloc)(int); /* Memory allocation function */
! 1402: void (*xFree)(void*); /* Free a prior allocation */
! 1403: void *(*xRealloc)(void*,int); /* Resize an allocation */
! 1404: int (*xSize)(void*); /* Return the size of an allocation */
! 1405: int (*xRoundup)(int); /* Round up request size to allocation size */
! 1406: int (*xInit)(void*); /* Initialize the memory allocator */
! 1407: void (*xShutdown)(void*); /* Deinitialize the memory allocator */
! 1408: void *pAppData; /* Argument to xInit() and xShutdown() */
! 1409: };
! 1410:
! 1411: /*
! 1412: ** CAPI3REF: Configuration Options
! 1413: ** KEYWORDS: {configuration option}
1.4 misha 1414: **
1.5 ! misha 1415: ** These constants are the available integer configuration options that
! 1416: ** can be passed as the first argument to the [sqlite3_config()] interface.
1.4 misha 1417: **
1.5 ! misha 1418: ** New configuration options may be added in future releases of SQLite.
! 1419: ** Existing configuration options might be discontinued. Applications
! 1420: ** should check the return code from [sqlite3_config()] to make sure that
! 1421: ** the call worked. The [sqlite3_config()] interface will return a
! 1422: ** non-zero [error code] if a discontinued or unsupported configuration option
! 1423: ** is invoked.
! 1424: **
! 1425: ** <dl>
! 1426: ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
! 1427: ** <dd>There are no arguments to this option. ^This option sets the
! 1428: ** [threading mode] to Single-thread. In other words, it disables
! 1429: ** all mutexing and puts SQLite into a mode where it can only be used
! 1430: ** by a single thread. ^If SQLite is compiled with
! 1431: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
! 1432: ** it is not possible to change the [threading mode] from its default
! 1433: ** value of Single-thread and so [sqlite3_config()] will return
! 1434: ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
! 1435: ** configuration option.</dd>
! 1436: **
! 1437: ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
! 1438: ** <dd>There are no arguments to this option. ^This option sets the
! 1439: ** [threading mode] to Multi-thread. In other words, it disables
! 1440: ** mutexing on [database connection] and [prepared statement] objects.
! 1441: ** The application is responsible for serializing access to
! 1442: ** [database connections] and [prepared statements]. But other mutexes
! 1443: ** are enabled so that SQLite will be safe to use in a multi-threaded
! 1444: ** environment as long as no two threads attempt to use the same
! 1445: ** [database connection] at the same time. ^If SQLite is compiled with
! 1446: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
! 1447: ** it is not possible to set the Multi-thread [threading mode] and
! 1448: ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
! 1449: ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
! 1450: **
! 1451: ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
! 1452: ** <dd>There are no arguments to this option. ^This option sets the
! 1453: ** [threading mode] to Serialized. In other words, this option enables
! 1454: ** all mutexes including the recursive
! 1455: ** mutexes on [database connection] and [prepared statement] objects.
! 1456: ** In this mode (which is the default when SQLite is compiled with
! 1457: ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
! 1458: ** to [database connections] and [prepared statements] so that the
! 1459: ** application is free to use the same [database connection] or the
! 1460: ** same [prepared statement] in different threads at the same time.
! 1461: ** ^If SQLite is compiled with
! 1462: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
! 1463: ** it is not possible to set the Serialized [threading mode] and
! 1464: ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
! 1465: ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
! 1466: **
! 1467: ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
! 1468: ** <dd> ^(This option takes a single argument which is a pointer to an
! 1469: ** instance of the [sqlite3_mem_methods] structure. The argument specifies
! 1470: ** alternative low-level memory allocation routines to be used in place of
! 1471: ** the memory allocation routines built into SQLite.)^ ^SQLite makes
! 1472: ** its own private copy of the content of the [sqlite3_mem_methods] structure
! 1473: ** before the [sqlite3_config()] call returns.</dd>
! 1474: **
! 1475: ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
! 1476: ** <dd> ^(This option takes a single argument which is a pointer to an
! 1477: ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
! 1478: ** structure is filled with the currently defined memory allocation routines.)^
! 1479: ** This option can be used to overload the default memory allocation
! 1480: ** routines with a wrapper that simulations memory allocation failure or
! 1481: ** tracks memory usage, for example. </dd>
! 1482: **
! 1483: ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
! 1484: ** <dd> ^This option takes single argument of type int, interpreted as a
! 1485: ** boolean, which enables or disables the collection of memory allocation
! 1486: ** statistics. ^(When memory allocation statistics are disabled, the
! 1487: ** following SQLite interfaces become non-operational:
! 1488: ** <ul>
! 1489: ** <li> [sqlite3_memory_used()]
! 1490: ** <li> [sqlite3_memory_highwater()]
! 1491: ** <li> [sqlite3_soft_heap_limit64()]
! 1492: ** <li> [sqlite3_status()]
! 1493: ** </ul>)^
! 1494: ** ^Memory allocation statistics are enabled by default unless SQLite is
! 1495: ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
! 1496: ** allocation statistics are disabled by default.
! 1497: ** </dd>
! 1498: **
! 1499: ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
! 1500: ** <dd> ^This option specifies a static memory buffer that SQLite can use for
! 1501: ** scratch memory. There are three arguments: A pointer an 8-byte
! 1502: ** aligned memory buffer from which the scratch allocations will be
! 1503: ** drawn, the size of each scratch allocation (sz),
! 1504: ** and the maximum number of scratch allocations (N). The sz
! 1505: ** argument must be a multiple of 16.
! 1506: ** The first argument must be a pointer to an 8-byte aligned buffer
! 1507: ** of at least sz*N bytes of memory.
! 1508: ** ^SQLite will use no more than two scratch buffers per thread. So
! 1509: ** N should be set to twice the expected maximum number of threads.
! 1510: ** ^SQLite will never require a scratch buffer that is more than 6
! 1511: ** times the database page size. ^If SQLite needs needs additional
! 1512: ** scratch memory beyond what is provided by this configuration option, then
! 1513: ** [sqlite3_malloc()] will be used to obtain the memory needed.</dd>
! 1514: **
! 1515: ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
! 1516: ** <dd> ^This option specifies a static memory buffer that SQLite can use for
! 1517: ** the database page cache with the default page cache implementation.
! 1518: ** This configuration should not be used if an application-define page
! 1519: ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option.
! 1520: ** There are three arguments to this option: A pointer to 8-byte aligned
! 1521: ** memory, the size of each page buffer (sz), and the number of pages (N).
! 1522: ** The sz argument should be the size of the largest database page
! 1523: ** (a power of two between 512 and 32768) plus a little extra for each
! 1524: ** page header. ^The page header size is 20 to 40 bytes depending on
! 1525: ** the host architecture. ^It is harmless, apart from the wasted memory,
! 1526: ** to make sz a little too large. The first
! 1527: ** argument should point to an allocation of at least sz*N bytes of memory.
! 1528: ** ^SQLite will use the memory provided by the first argument to satisfy its
! 1529: ** memory needs for the first N pages that it adds to cache. ^If additional
! 1530: ** page cache memory is needed beyond what is provided by this option, then
! 1531: ** SQLite goes to [sqlite3_malloc()] for the additional storage space.
! 1532: ** The pointer in the first argument must
! 1533: ** be aligned to an 8-byte boundary or subsequent behavior of SQLite
! 1534: ** will be undefined.</dd>
! 1535: **
! 1536: ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
! 1537: ** <dd> ^This option specifies a static memory buffer that SQLite will use
! 1538: ** for all of its dynamic memory allocation needs beyond those provided
! 1539: ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
! 1540: ** There are three arguments: An 8-byte aligned pointer to the memory,
! 1541: ** the number of bytes in the memory buffer, and the minimum allocation size.
! 1542: ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
! 1543: ** to using its default memory allocator (the system malloc() implementation),
! 1544: ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
! 1545: ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
! 1546: ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
! 1547: ** allocator is engaged to handle all of SQLites memory allocation needs.
! 1548: ** The first pointer (the memory pointer) must be aligned to an 8-byte
! 1549: ** boundary or subsequent behavior of SQLite will be undefined.
! 1550: ** The minimum allocation size is capped at 2**12. Reasonable values
! 1551: ** for the minimum allocation size are 2**5 through 2**8.</dd>
! 1552: **
! 1553: ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
! 1554: ** <dd> ^(This option takes a single argument which is a pointer to an
! 1555: ** instance of the [sqlite3_mutex_methods] structure. The argument specifies
! 1556: ** alternative low-level mutex routines to be used in place
! 1557: ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the
! 1558: ** content of the [sqlite3_mutex_methods] structure before the call to
! 1559: ** [sqlite3_config()] returns. ^If SQLite is compiled with
! 1560: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
! 1561: ** the entire mutexing subsystem is omitted from the build and hence calls to
! 1562: ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
! 1563: ** return [SQLITE_ERROR].</dd>
! 1564: **
! 1565: ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
! 1566: ** <dd> ^(This option takes a single argument which is a pointer to an
! 1567: ** instance of the [sqlite3_mutex_methods] structure. The
! 1568: ** [sqlite3_mutex_methods]
! 1569: ** structure is filled with the currently defined mutex routines.)^
! 1570: ** This option can be used to overload the default mutex allocation
! 1571: ** routines with a wrapper used to track mutex usage for performance
! 1572: ** profiling or testing, for example. ^If SQLite is compiled with
! 1573: ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
! 1574: ** the entire mutexing subsystem is omitted from the build and hence calls to
! 1575: ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
! 1576: ** return [SQLITE_ERROR].</dd>
! 1577: **
! 1578: ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
! 1579: ** <dd> ^(This option takes two arguments that determine the default
! 1580: ** memory allocation for the lookaside memory allocator on each
! 1581: ** [database connection]. The first argument is the
! 1582: ** size of each lookaside buffer slot and the second is the number of
! 1583: ** slots allocated to each database connection.)^ ^(This option sets the
! 1584: ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
! 1585: ** verb to [sqlite3_db_config()] can be used to change the lookaside
! 1586: ** configuration on individual connections.)^ </dd>
! 1587: **
! 1588: ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
! 1589: ** <dd> ^(This option takes a single argument which is a pointer to
! 1590: ** an [sqlite3_pcache_methods2] object. This object specifies the interface
! 1591: ** to a custom page cache implementation.)^ ^SQLite makes a copy of the
! 1592: ** object and uses it for page cache memory allocations.</dd>
! 1593: **
! 1594: ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
! 1595: ** <dd> ^(This option takes a single argument which is a pointer to an
! 1596: ** [sqlite3_pcache_methods2] object. SQLite copies of the current
! 1597: ** page cache implementation into that object.)^ </dd>
! 1598: **
! 1599: ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
! 1600: ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
! 1601: ** global [error log].
! 1602: ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
! 1603: ** function with a call signature of void(*)(void*,int,const char*),
! 1604: ** and a pointer to void. ^If the function pointer is not NULL, it is
! 1605: ** invoked by [sqlite3_log()] to process each logging event. ^If the
! 1606: ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
! 1607: ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
! 1608: ** passed through as the first parameter to the application-defined logger
! 1609: ** function whenever that function is invoked. ^The second parameter to
! 1610: ** the logger function is a copy of the first parameter to the corresponding
! 1611: ** [sqlite3_log()] call and is intended to be a [result code] or an
! 1612: ** [extended result code]. ^The third parameter passed to the logger is
! 1613: ** log message after formatting via [sqlite3_snprintf()].
! 1614: ** The SQLite logging interface is not reentrant; the logger function
! 1615: ** supplied by the application must not invoke any SQLite interface.
! 1616: ** In a multi-threaded application, the application-defined logger
! 1617: ** function must be threadsafe. </dd>
! 1618: **
! 1619: ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
! 1620: ** <dd>^(This option takes a single argument of type int. If non-zero, then
! 1621: ** URI handling is globally enabled. If the parameter is zero, then URI handling
! 1622: ** is globally disabled.)^ ^If URI handling is globally enabled, all filenames
! 1623: ** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or
! 1624: ** specified as part of [ATTACH] commands are interpreted as URIs, regardless
! 1625: ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
! 1626: ** connection is opened. ^If it is globally disabled, filenames are
! 1627: ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
! 1628: ** database connection is opened. ^(By default, URI handling is globally
! 1629: ** disabled. The default value may be changed by compiling with the
! 1630: ** [SQLITE_USE_URI] symbol defined.)^
! 1631: **
! 1632: ** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
! 1633: ** <dd>^This option takes a single integer argument which is interpreted as
! 1634: ** a boolean in order to enable or disable the use of covering indices for
! 1635: ** full table scans in the query optimizer. ^The default setting is determined
! 1636: ** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
! 1637: ** if that compile-time option is omitted.
! 1638: ** The ability to disable the use of covering indices for full table scans
! 1639: ** is because some incorrectly coded legacy applications might malfunction
! 1640: ** when the optimization is enabled. Providing the ability to
! 1641: ** disable the optimization allows the older, buggy application code to work
! 1642: ** without change even with newer versions of SQLite.
! 1643: **
! 1644: ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
! 1645: ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
! 1646: ** <dd> These options are obsolete and should not be used by new code.
! 1647: ** They are retained for backwards compatibility but are now no-ops.
! 1648: ** </dd>
! 1649: **
! 1650: ** [[SQLITE_CONFIG_SQLLOG]]
! 1651: ** <dt>SQLITE_CONFIG_SQLLOG
! 1652: ** <dd>This option is only available if sqlite is compiled with the
! 1653: ** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
! 1654: ** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
! 1655: ** The second should be of type (void*). The callback is invoked by the library
! 1656: ** in three separate circumstances, identified by the value passed as the
! 1657: ** fourth parameter. If the fourth parameter is 0, then the database connection
! 1658: ** passed as the second argument has just been opened. The third argument
! 1659: ** points to a buffer containing the name of the main database file. If the
! 1660: ** fourth parameter is 1, then the SQL statement that the third parameter
! 1661: ** points to has just been executed. Or, if the fourth parameter is 2, then
! 1662: ** the connection being passed as the second parameter is being closed. The
! 1663: ** third parameter is passed NULL In this case. An example of using this
! 1664: ** configuration option can be seen in the "test_sqllog.c" source file in
! 1665: ** the canonical SQLite source tree.</dd>
! 1666: **
! 1667: ** [[SQLITE_CONFIG_MMAP_SIZE]]
! 1668: ** <dt>SQLITE_CONFIG_MMAP_SIZE
! 1669: ** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
! 1670: ** that are the default mmap size limit (the default setting for
! 1671: ** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
! 1672: ** ^The default setting can be overridden by each database connection using
! 1673: ** either the [PRAGMA mmap_size] command, or by using the
! 1674: ** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
! 1675: ** cannot be changed at run-time. Nor may the maximum allowed mmap size
! 1676: ** exceed the compile-time maximum mmap size set by the
! 1677: ** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
! 1678: ** ^If either argument to this option is negative, then that argument is
! 1679: ** changed to its compile-time default.
! 1680: ** </dl>
! 1681: */
! 1682: #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
! 1683: #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
! 1684: #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
! 1685: #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
! 1686: #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
! 1687: #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
! 1688: #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
! 1689: #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
! 1690: #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
! 1691: #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
! 1692: #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
! 1693: /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
! 1694: #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
! 1695: #define SQLITE_CONFIG_PCACHE 14 /* no-op */
! 1696: #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
! 1697: #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
! 1698: #define SQLITE_CONFIG_URI 17 /* int */
! 1699: #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
! 1700: #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
! 1701: #define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
! 1702: #define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
! 1703: #define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
! 1704:
! 1705: /*
! 1706: ** CAPI3REF: Database Connection Configuration Options
! 1707: **
! 1708: ** These constants are the available integer configuration options that
! 1709: ** can be passed as the second argument to the [sqlite3_db_config()] interface.
! 1710: **
! 1711: ** New configuration options may be added in future releases of SQLite.
! 1712: ** Existing configuration options might be discontinued. Applications
! 1713: ** should check the return code from [sqlite3_db_config()] to make sure that
! 1714: ** the call worked. ^The [sqlite3_db_config()] interface will return a
! 1715: ** non-zero [error code] if a discontinued or unsupported configuration option
! 1716: ** is invoked.
! 1717: **
! 1718: ** <dl>
! 1719: ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
! 1720: ** <dd> ^This option takes three additional arguments that determine the
! 1721: ** [lookaside memory allocator] configuration for the [database connection].
! 1722: ** ^The first argument (the third parameter to [sqlite3_db_config()] is a
! 1723: ** pointer to a memory buffer to use for lookaside memory.
! 1724: ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
! 1725: ** may be NULL in which case SQLite will allocate the
! 1726: ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
! 1727: ** size of each lookaside buffer slot. ^The third argument is the number of
! 1728: ** slots. The size of the buffer in the first argument must be greater than
! 1729: ** or equal to the product of the second and third arguments. The buffer
! 1730: ** must be aligned to an 8-byte boundary. ^If the second argument to
! 1731: ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
! 1732: ** rounded down to the next smaller multiple of 8. ^(The lookaside memory
! 1733: ** configuration for a database connection can only be changed when that
! 1734: ** connection is not currently using lookaside memory, or in other words
! 1735: ** when the "current value" returned by
! 1736: ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
! 1737: ** Any attempt to change the lookaside memory configuration when lookaside
! 1738: ** memory is in use leaves the configuration unchanged and returns
! 1739: ** [SQLITE_BUSY].)^</dd>
! 1740: **
! 1741: ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
! 1742: ** <dd> ^This option is used to enable or disable the enforcement of
! 1743: ** [foreign key constraints]. There should be two additional arguments.
! 1744: ** The first argument is an integer which is 0 to disable FK enforcement,
! 1745: ** positive to enable FK enforcement or negative to leave FK enforcement
! 1746: ** unchanged. The second parameter is a pointer to an integer into which
! 1747: ** is written 0 or 1 to indicate whether FK enforcement is off or on
! 1748: ** following this call. The second parameter may be a NULL pointer, in
! 1749: ** which case the FK enforcement setting is not reported back. </dd>
! 1750: **
! 1751: ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
! 1752: ** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
! 1753: ** There should be two additional arguments.
! 1754: ** The first argument is an integer which is 0 to disable triggers,
! 1755: ** positive to enable triggers or negative to leave the setting unchanged.
! 1756: ** The second parameter is a pointer to an integer into which
! 1757: ** is written 0 or 1 to indicate whether triggers are disabled or enabled
! 1758: ** following this call. The second parameter may be a NULL pointer, in
! 1759: ** which case the trigger setting is not reported back. </dd>
! 1760: **
! 1761: ** </dl>
! 1762: */
! 1763: #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
! 1764: #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
! 1765: #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
! 1766:
! 1767:
! 1768: /*
! 1769: ** CAPI3REF: Enable Or Disable Extended Result Codes
! 1770: **
! 1771: ** ^The sqlite3_extended_result_codes() routine enables or disables the
! 1772: ** [extended result codes] feature of SQLite. ^The extended result
! 1773: ** codes are disabled by default for historical compatibility.
1.2 misha 1774: */
1.5 ! misha 1775: SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
1.2 misha 1776:
1777: /*
1.5 ! misha 1778: ** CAPI3REF: Last Insert Rowid
1.2 misha 1779: **
1.5 ! misha 1780: ** ^Each entry in an SQLite table has a unique 64-bit signed
! 1781: ** integer key called the [ROWID | "rowid"]. ^The rowid is always available
1.4 misha 1782: ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
1.5 ! misha 1783: ** names are not also used by explicitly declared columns. ^If
! 1784: ** the table has a column of type [INTEGER PRIMARY KEY] then that column
1.4 misha 1785: ** is another alias for the rowid.
1786: **
1.5 ! misha 1787: ** ^This routine returns the [rowid] of the most recent
! 1788: ** successful [INSERT] into the database from the [database connection]
! 1789: ** in the first argument. ^As of SQLite version 3.7.7, this routines
! 1790: ** records the last insert rowid of both ordinary tables and [virtual tables].
! 1791: ** ^If no successful [INSERT]s
! 1792: ** have ever occurred on that database connection, zero is returned.
! 1793: **
! 1794: ** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
! 1795: ** method, then this routine will return the [rowid] of the inserted
! 1796: ** row as long as the trigger or virtual table method is running.
! 1797: ** But once the trigger or virtual table method ends, the value returned
! 1798: ** by this routine reverts to what it was before the trigger or virtual
! 1799: ** table method began.)^
! 1800: **
! 1801: ** ^An [INSERT] that fails due to a constraint violation is not a
! 1802: ** successful [INSERT] and does not change the value returned by this
! 1803: ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
1.3 misha 1804: ** and INSERT OR ABORT make no changes to the return value of this
1.5 ! misha 1805: ** routine when their insertion fails. ^(When INSERT OR REPLACE
1.3 misha 1806: ** encounters a constraint violation, it does not fail. The
1807: ** INSERT continues to completion after deleting rows that caused
1808: ** the constraint problem so INSERT OR REPLACE will always change
1.5 ! misha 1809: ** the return value of this interface.)^
1.3 misha 1810: **
1.5 ! misha 1811: ** ^For the purposes of this routine, an [INSERT] is considered to
1.4 misha 1812: ** be successful even if it is subsequently rolled back.
1813: **
1.5 ! misha 1814: ** This function is accessible to SQL statements via the
! 1815: ** [last_insert_rowid() SQL function].
1.4 misha 1816: **
1.5 ! misha 1817: ** If a separate thread performs a new [INSERT] on the same
! 1818: ** database connection while the [sqlite3_last_insert_rowid()]
! 1819: ** function is running and thus changes the last insert [rowid],
! 1820: ** then the value returned by [sqlite3_last_insert_rowid()] is
! 1821: ** unpredictable and might not equal either the old or the new
! 1822: ** last insert [rowid].
1.1 misha 1823: */
1.5 ! misha 1824: SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
1.1 misha 1825:
1826: /*
1.5 ! misha 1827: ** CAPI3REF: Count The Number Of Rows Modified
1.2 misha 1828: **
1.5 ! misha 1829: ** ^This function returns the number of database rows that were changed
1.4 misha 1830: ** or inserted or deleted by the most recently completed SQL statement
1.5 ! misha 1831: ** on the [database connection] specified by the first parameter.
! 1832: ** ^(Only changes that are directly specified by the [INSERT], [UPDATE],
! 1833: ** or [DELETE] statement are counted. Auxiliary changes caused by
! 1834: ** triggers or [foreign key actions] are not counted.)^ Use the
! 1835: ** [sqlite3_total_changes()] function to find the total number of changes
! 1836: ** including changes caused by triggers and foreign key actions.
! 1837: **
! 1838: ** ^Changes to a view that are simulated by an [INSTEAD OF trigger]
! 1839: ** are not counted. Only real table changes are counted.
1.2 misha 1840: **
1.5 ! misha 1841: ** ^(A "row change" is a change to a single row of a single table
1.4 misha 1842: ** caused by an INSERT, DELETE, or UPDATE statement. Rows that
1.5 ! misha 1843: ** are changed as side effects of [REPLACE] constraint resolution,
! 1844: ** rollback, ABORT processing, [DROP TABLE], or by any other
! 1845: ** mechanisms do not count as direct row changes.)^
1.4 misha 1846: **
1847: ** A "trigger context" is a scope of execution that begins and
1.5 ! misha 1848: ** ends with the script of a [CREATE TRIGGER | trigger].
! 1849: ** Most SQL statements are
1.4 misha 1850: ** evaluated outside of any trigger. This is the "top level"
1851: ** trigger context. If a trigger fires from the top level, a
1852: ** new trigger context is entered for the duration of that one
1853: ** trigger. Subtriggers create subcontexts for their duration.
1854: **
1.5 ! misha 1855: ** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1.4 misha 1856: ** not create a new trigger context.
1857: **
1.5 ! misha 1858: ** ^This function returns the number of direct row changes in the
1.4 misha 1859: ** most recent INSERT, UPDATE, or DELETE statement within the same
1860: ** trigger context.
1861: **
1.5 ! misha 1862: ** ^Thus, when called from the top level, this function returns the
1.4 misha 1863: ** number of changes in the most recent INSERT, UPDATE, or DELETE
1.5 ! misha 1864: ** that also occurred at the top level. ^(Within the body of a trigger,
! 1865: ** the sqlite3_changes() interface can be called to find the number of
1.2 misha 1866: ** changes in the most recently completed INSERT, UPDATE, or DELETE
1.4 misha 1867: ** statement within the body of the same trigger.
1.5 ! misha 1868: ** However, the number returned does not include changes
! 1869: ** caused by subtriggers since those have their own context.)^
1.4 misha 1870: **
1.5 ! misha 1871: ** See also the [sqlite3_total_changes()] interface, the
! 1872: ** [count_changes pragma], and the [changes() SQL function].
1.2 misha 1873: **
1.5 ! misha 1874: ** If a separate thread makes changes on the same database connection
! 1875: ** while [sqlite3_changes()] is running then the value returned
! 1876: ** is unpredictable and not meaningful.
! 1877: */
! 1878: SQLITE_API int sqlite3_changes(sqlite3*);
! 1879:
! 1880: /*
! 1881: ** CAPI3REF: Total Number Of Rows Modified
1.4 misha 1882: **
1.5 ! misha 1883: ** ^This function returns the number of row changes caused by [INSERT],
! 1884: ** [UPDATE] or [DELETE] statements since the [database connection] was opened.
! 1885: ** ^(The count returned by sqlite3_total_changes() includes all changes
! 1886: ** from all [CREATE TRIGGER | trigger] contexts and changes made by
! 1887: ** [foreign key actions]. However,
! 1888: ** the count does not include changes used to implement [REPLACE] constraints,
! 1889: ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The
! 1890: ** count does not include rows of views that fire an [INSTEAD OF trigger],
! 1891: ** though if the INSTEAD OF trigger makes changes of its own, those changes
! 1892: ** are counted.)^
! 1893: ** ^The sqlite3_total_changes() function counts the changes as soon as
! 1894: ** the statement that makes them is completed (when the statement handle
! 1895: ** is passed to [sqlite3_reset()] or [sqlite3_finalize()]).
1.4 misha 1896: **
1.5 ! misha 1897: ** See also the [sqlite3_changes()] interface, the
! 1898: ** [count_changes pragma], and the [total_changes() SQL function].
1.4 misha 1899: **
1.5 ! misha 1900: ** If a separate thread makes changes on the same database connection
! 1901: ** while [sqlite3_total_changes()] is running then the value
! 1902: ** returned is unpredictable and not meaningful.
1.1 misha 1903: */
1.5 ! misha 1904: SQLITE_API int sqlite3_total_changes(sqlite3*);
1.1 misha 1905:
1.2 misha 1906: /*
1.5 ! misha 1907: ** CAPI3REF: Interrupt A Long-Running Query
1.2 misha 1908: **
1.5 ! misha 1909: ** ^This function causes any pending database operation to abort and
1.4 misha 1910: ** return at its earliest opportunity. This routine is typically
1.1 misha 1911: ** called in response to a user action such as pressing "Cancel"
1912: ** or Ctrl-C where the user wants a long query operation to halt
1913: ** immediately.
1.2 misha 1914: **
1.5 ! misha 1915: ** ^It is safe to call this routine from a thread different from the
1.2 misha 1916: ** thread that is currently running the database operation. But it
1.5 ! misha 1917: ** is not safe to call this routine with a [database connection] that
1.2 misha 1918: ** is closed or might close before sqlite3_interrupt() returns.
1919: **
1.5 ! misha 1920: ** ^If an SQL operation is very nearly finished at the time when
! 1921: ** sqlite3_interrupt() is called, then it might not have an opportunity
! 1922: ** to be interrupted and might continue to completion.
! 1923: **
! 1924: ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
! 1925: ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
! 1926: ** that is inside an explicit transaction, then the entire transaction
! 1927: ** will be rolled back automatically.
! 1928: **
! 1929: ** ^The sqlite3_interrupt(D) call is in effect until all currently running
! 1930: ** SQL statements on [database connection] D complete. ^Any new SQL statements
! 1931: ** that are started after the sqlite3_interrupt() call and before the
! 1932: ** running statements reaches zero are interrupted as if they had been
! 1933: ** running prior to the sqlite3_interrupt() call. ^New SQL statements
! 1934: ** that are started after the running statement count reaches zero are
! 1935: ** not effected by the sqlite3_interrupt().
! 1936: ** ^A call to sqlite3_interrupt(D) that occurs when there are no running
! 1937: ** SQL statements is a no-op and has no effect on SQL statements
! 1938: ** that are started after the sqlite3_interrupt() call returns.
! 1939: **
! 1940: ** If the database connection closes while [sqlite3_interrupt()]
! 1941: ** is running then bad things will likely happen.
1.1 misha 1942: */
1.5 ! misha 1943: SQLITE_API void sqlite3_interrupt(sqlite3*);
1.1 misha 1944:
1.2 misha 1945: /*
1.5 ! misha 1946: ** CAPI3REF: Determine If An SQL Statement Is Complete
1.4 misha 1947: **
1.5 ! misha 1948: ** These routines are useful during command-line input to determine if the
! 1949: ** currently entered text seems to form a complete SQL statement or
1.4 misha 1950: ** if additional input is needed before sending the text into
1.5 ! misha 1951: ** SQLite for parsing. ^These routines return 1 if the input string
! 1952: ** appears to be a complete SQL statement. ^A statement is judged to be
! 1953: ** complete if it ends with a semicolon token and is not a prefix of a
! 1954: ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
1.4 misha 1955: ** string literals or quoted identifier names or comments are not
1956: ** independent tokens (they are part of the token in which they are
1.5 ! misha 1957: ** embedded) and thus do not count as a statement terminator. ^Whitespace
! 1958: ** and comments that follow the final semicolon are ignored.
1.4 misha 1959: **
1.5 ! misha 1960: ** ^These routines return 0 if the statement is incomplete. ^If a
! 1961: ** memory allocation fails, then SQLITE_NOMEM is returned.
1.4 misha 1962: **
1.5 ! misha 1963: ** ^These routines do not parse the SQL statements thus
! 1964: ** will not detect syntactically incorrect SQL.
1.4 misha 1965: **
1.5 ! misha 1966: ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
! 1967: ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
! 1968: ** automatically by sqlite3_complete16(). If that initialization fails,
! 1969: ** then the return value from sqlite3_complete16() will be non-zero
! 1970: ** regardless of whether or not the input SQL is complete.)^
1.2 misha 1971: **
1.5 ! misha 1972: ** The input to [sqlite3_complete()] must be a zero-terminated
! 1973: ** UTF-8 string.
1.1 misha 1974: **
1.5 ! misha 1975: ** The input to [sqlite3_complete16()] must be a zero-terminated
! 1976: ** UTF-16 string in native byte order.
1.1 misha 1977: */
1.5 ! misha 1978: SQLITE_API int sqlite3_complete(const char *sql);
! 1979: SQLITE_API int sqlite3_complete16(const void *sql);
1.1 misha 1980:
1981: /*
1.5 ! misha 1982: ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
1.2 misha 1983: **
1.5 ! misha 1984: ** ^This routine sets a callback function that might be invoked whenever
! 1985: ** an attempt is made to open a database table that another thread
! 1986: ** or process has locked.
! 1987: **
! 1988: ** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]
! 1989: ** is returned immediately upon encountering the lock. ^If the busy callback
! 1990: ** is not NULL, then the callback might be invoked with two arguments.
! 1991: **
! 1992: ** ^The first argument to the busy handler is a copy of the void* pointer which
! 1993: ** is the third argument to sqlite3_busy_handler(). ^The second argument to
! 1994: ** the busy handler callback is the number of times that the busy handler has
! 1995: ** been invoked for this locking event. ^If the
1.2 misha 1996: ** busy callback returns 0, then no additional attempts are made to
1997: ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
1.5 ! misha 1998: ** ^If the callback returns non-zero, then another attempt
1.4 misha 1999: ** is made to open the database for reading and the cycle repeats.
1.2 misha 2000: **
1.5 ! misha 2001: ** The presence of a busy handler does not guarantee that it will be invoked
! 2002: ** when there is lock contention. ^If SQLite determines that invoking the busy
! 2003: ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
! 2004: ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler.
1.2 misha 2005: ** Consider a scenario where one process is holding a read lock that
2006: ** it is trying to promote to a reserved lock and
2007: ** a second process is holding a reserved lock that it is trying
2008: ** to promote to an exclusive lock. The first process cannot proceed
2009: ** because it is blocked by the second and the second process cannot
2010: ** proceed because it is blocked by the first. If both processes
2011: ** invoke the busy handlers, neither will make any progress. Therefore,
2012: ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
2013: ** will induce the first process to release its read lock and allow
2014: ** the second process to proceed.
1.1 misha 2015: **
1.5 ! misha 2016: ** ^The default busy callback is NULL.
1.1 misha 2017: **
1.5 ! misha 2018: ** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
1.4 misha 2019: ** when SQLite is in the middle of a large transaction where all the
1.2 misha 2020: ** changes will not fit into the in-memory cache. SQLite will
2021: ** already hold a RESERVED lock on the database file, but it needs
2022: ** to promote this lock to EXCLUSIVE so that it can spill cache
2023: ** pages into the database file without harm to concurrent
1.5 ! misha 2024: ** readers. ^If it is unable to promote the lock, then the in-memory
1.2 misha 2025: ** cache will be left in an inconsistent state and so the error
2026: ** code is promoted from the relatively benign [SQLITE_BUSY] to
1.5 ! misha 2027: ** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion
1.4 misha 2028: ** forces an automatic rollback of the changes. See the
1.5 ! misha 2029: ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
1.2 misha 2030: ** CorruptionFollowingBusyError</a> wiki page for a discussion of why
2031: ** this is important.
2032: **
1.5 ! misha 2033: ** ^(There can only be a single busy handler defined for each
! 2034: ** [database connection]. Setting a new busy handler clears any
! 2035: ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
! 2036: ** will also set or clear the busy handler.
! 2037: **
! 2038: ** The busy callback should not take any actions which modify the
! 2039: ** database connection that invoked the busy handler. Any such actions
! 2040: ** result in undefined behavior.
! 2041: **
! 2042: ** A busy handler must not close the database connection
! 2043: ** or [prepared statement] that invoked the busy handler.
1.1 misha 2044: */
1.5 ! misha 2045: SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
1.1 misha 2046:
2047: /*
1.5 ! misha 2048: ** CAPI3REF: Set A Busy Timeout
1.2 misha 2049: **
1.5 ! misha 2050: ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
! 2051: ** for a specified amount of time when a table is locked. ^The handler
! 2052: ** will sleep multiple times until at least "ms" milliseconds of sleeping
! 2053: ** have accumulated. ^After at least "ms" milliseconds of sleeping,
! 2054: ** the handler returns 0 which causes [sqlite3_step()] to return
! 2055: ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
1.1 misha 2056: **
1.5 ! misha 2057: ** ^Calling this routine with an argument less than or equal to zero
1.1 misha 2058: ** turns off all busy handlers.
1.2 misha 2059: **
1.5 ! misha 2060: ** ^(There can only be a single busy handler for a particular
! 2061: ** [database connection] any any given moment. If another busy handler
! 2062: ** was defined (using [sqlite3_busy_handler()]) prior to calling
! 2063: ** this routine, that other busy handler is cleared.)^
1.1 misha 2064: */
1.5 ! misha 2065: SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
1.1 misha 2066:
2067: /*
1.5 ! misha 2068: ** CAPI3REF: Convenience Routines For Running Queries
! 2069: **
! 2070: ** This is a legacy interface that is preserved for backwards compatibility.
! 2071: ** Use of this interface is not recommended.
1.2 misha 2072: **
1.4 misha 2073: ** Definition: A <b>result table</b> is memory data structure created by the
2074: ** [sqlite3_get_table()] interface. A result table records the
2075: ** complete query results from one or more queries.
2076: **
2077: ** The table conceptually has a number of rows and columns. But
2078: ** these numbers are not part of the result table itself. These
2079: ** numbers are obtained separately. Let N be the number of rows
2080: ** and M be the number of columns.
2081: **
1.5 ! misha 2082: ** A result table is an array of pointers to zero-terminated UTF-8 strings.
! 2083: ** There are (N+1)*M elements in the array. The first M pointers point
! 2084: ** to zero-terminated strings that contain the names of the columns.
! 2085: ** The remaining entries all point to query results. NULL values result
! 2086: ** in NULL pointers. All other values are in their UTF-8 zero-terminated
! 2087: ** string representation as returned by [sqlite3_column_text()].
1.4 misha 2088: **
1.5 ! misha 2089: ** A result table might consist of one or more memory allocations.
1.4 misha 2090: ** It is not safe to pass a result table directly to [sqlite3_free()].
2091: ** A result table should be deallocated using [sqlite3_free_table()].
1.1 misha 2092: **
1.5 ! misha 2093: ** ^(As an example of the result table format, suppose a query result
1.4 misha 2094: ** is as follows:
1.1 misha 2095: **
1.2 misha 2096: ** <blockquote><pre>
1.1 misha 2097: ** Name | Age
2098: ** -----------------------
2099: ** Alice | 43
2100: ** Bob | 28
2101: ** Cindy | 21
1.2 misha 2102: ** </pre></blockquote>
1.1 misha 2103: **
1.4 misha 2104: ** There are two column (M==2) and three rows (N==3). Thus the
2105: ** result table has 8 entries. Suppose the result table is stored
2106: ** in an array names azResult. Then azResult holds this content:
1.1 misha 2107: **
1.2 misha 2108: ** <blockquote><pre>
2109: ** azResult[0] = "Name";
2110: ** azResult[1] = "Age";
2111: ** azResult[2] = "Alice";
2112: ** azResult[3] = "43";
2113: ** azResult[4] = "Bob";
2114: ** azResult[5] = "28";
2115: ** azResult[6] = "Cindy";
2116: ** azResult[7] = "21";
1.5 ! misha 2117: ** </pre></blockquote>)^
1.1 misha 2118: **
1.5 ! misha 2119: ** ^The sqlite3_get_table() function evaluates one or more
1.4 misha 2120: ** semicolon-separated SQL statements in the zero-terminated UTF-8
1.5 ! misha 2121: ** string of its 2nd parameter and returns a result table to the
1.4 misha 2122: ** pointer given in its 3rd parameter.
1.1 misha 2123: **
1.5 ! misha 2124: ** After the application has finished with the result from sqlite3_get_table(),
! 2125: ** it must pass the result table pointer to sqlite3_free_table() in order to
! 2126: ** release the memory that was malloced. Because of the way the
1.4 misha 2127: ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
1.5 ! misha 2128: ** function must not try to call [sqlite3_free()] directly. Only
1.4 misha 2129: ** [sqlite3_free_table()] is able to release the memory properly and safely.
2130: **
2131: ** The sqlite3_get_table() interface is implemented as a wrapper around
2132: ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
2133: ** to any internal data structures of SQLite. It uses only the public
2134: ** interface defined here. As a consequence, errors that occur in the
2135: ** wrapper layer outside of the internal [sqlite3_exec()] call are not
2136: ** reflected in subsequent calls to [sqlite3_errcode()] or
2137: ** [sqlite3_errmsg()].
1.5 ! misha 2138: */
! 2139: SQLITE_API int sqlite3_get_table(
! 2140: sqlite3 *db, /* An open database */
! 2141: const char *zSql, /* SQL to be evaluated */
! 2142: char ***pazResult, /* Results of the query */
! 2143: int *pnRow, /* Number of result rows written here */
! 2144: int *pnColumn, /* Number of result columns written here */
! 2145: char **pzErrmsg /* Error msg written here */
1.1 misha 2146: );
1.5 ! misha 2147: SQLITE_API void sqlite3_free_table(char **result);
1.1 misha 2148:
2149: /*
1.5 ! misha 2150: ** CAPI3REF: Formatted String Printing Functions
1.2 misha 2151: **
1.5 ! misha 2152: ** These routines are work-alikes of the "printf()" family of functions
1.2 misha 2153: ** from the standard C library.
1.1 misha 2154: **
1.5 ! misha 2155: ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
1.2 misha 2156: ** results into memory obtained from [sqlite3_malloc()].
2157: ** The strings returned by these two routines should be
1.5 ! misha 2158: ** released by [sqlite3_free()]. ^Both routines return a
1.2 misha 2159: ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
2160: ** memory to hold the resulting string.
2161: **
1.5 ! misha 2162: ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
1.2 misha 2163: ** the standard C library. The result is written into the
2164: ** buffer supplied as the second parameter whose size is given by
1.4 misha 2165: ** the first parameter. Note that the order of the
1.5 ! misha 2166: ** first two parameters is reversed from snprintf().)^ This is an
1.2 misha 2167: ** historical accident that cannot be fixed without breaking
1.5 ! misha 2168: ** backwards compatibility. ^(Note also that sqlite3_snprintf()
1.2 misha 2169: ** returns a pointer to its buffer instead of the number of
1.5 ! misha 2170: ** characters actually written into the buffer.)^ We admit that
1.2 misha 2171: ** the number of characters written would be a more useful return
2172: ** value but we cannot change the implementation of sqlite3_snprintf()
2173: ** now without breaking compatibility.
2174: **
1.5 ! misha 2175: ** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
! 2176: ** guarantees that the buffer is always zero-terminated. ^The first
1.2 misha 2177: ** parameter "n" is the total size of the buffer, including space for
2178: ** the zero terminator. So the longest string that can be completely
2179: ** written will be n-1 characters.
1.1 misha 2180: **
1.5 ! misha 2181: ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
! 2182: **
1.2 misha 2183: ** These routines all implement some additional formatting
2184: ** options that are useful for constructing SQL statements.
1.5 ! misha 2185: ** All of the usual printf() formatting options apply. In addition, there
1.2 misha 2186: ** is are "%q", "%Q", and "%z" options.
2187: **
1.5 ! misha 2188: ** ^(The %q option works like %s in that it substitutes a nul-terminated
1.1 misha 2189: ** string from the argument list. But %q also doubles every '\'' character.
1.5 ! misha 2190: ** %q is designed for use inside a string literal.)^ By doubling each '\''
1.1 misha 2191: ** character it escapes that character and allows it to be inserted into
2192: ** the string.
2193: **
1.5 ! misha 2194: ** For example, assume the string variable zText contains text as follows:
1.1 misha 2195: **
1.2 misha 2196: ** <blockquote><pre>
2197: ** char *zText = "It's a happy day!";
2198: ** </pre></blockquote>
2199: **
2200: ** One can use this text in an SQL statement as follows:
2201: **
2202: ** <blockquote><pre>
2203: ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
2204: ** sqlite3_exec(db, zSQL, 0, 0, 0);
2205: ** sqlite3_free(zSQL);
2206: ** </pre></blockquote>
1.1 misha 2207: **
2208: ** Because the %q format string is used, the '\'' character in zText
2209: ** is escaped and the SQL generated is as follows:
2210: **
1.2 misha 2211: ** <blockquote><pre>
2212: ** INSERT INTO table1 VALUES('It''s a happy day!')
2213: ** </pre></blockquote>
1.1 misha 2214: **
2215: ** This is correct. Had we used %s instead of %q, the generated SQL
2216: ** would have looked like this:
2217: **
1.2 misha 2218: ** <blockquote><pre>
2219: ** INSERT INTO table1 VALUES('It's a happy day!');
2220: ** </pre></blockquote>
1.1 misha 2221: **
1.5 ! misha 2222: ** This second example is an SQL syntax error. As a general rule you should
! 2223: ** always use %q instead of %s when inserting text into a string literal.
! 2224: **
! 2225: ** ^(The %Q option works like %q except it also adds single quotes around
! 2226: ** the outside of the total string. Additionally, if the parameter in the
! 2227: ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
! 2228: ** single quotes).)^ So, for example, one could say:
1.2 misha 2229: **
2230: ** <blockquote><pre>
2231: ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
2232: ** sqlite3_exec(db, zSQL, 0, 0, 0);
2233: ** sqlite3_free(zSQL);
2234: ** </pre></blockquote>
2235: **
2236: ** The code above will render a correct SQL statement in the zSQL
2237: ** variable even if the zText variable is a NULL pointer.
2238: **
1.5 ! misha 2239: ** ^(The "%z" formatting option works like "%s" but with the
1.2 misha 2240: ** addition that after the string has been read and copied into
1.5 ! misha 2241: ** the result, [sqlite3_free()] is called on the input string.)^
1.1 misha 2242: */
1.5 ! misha 2243: SQLITE_API char *sqlite3_mprintf(const char*,...);
! 2244: SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
! 2245: SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
! 2246: SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
1.1 misha 2247:
2248: /*
1.5 ! misha 2249: ** CAPI3REF: Memory Allocation Subsystem
1.4 misha 2250: **
1.5 ! misha 2251: ** The SQLite core uses these three routines for all of its own
1.4 misha 2252: ** internal memory allocation needs. "Core" in the previous sentence
2253: ** does not include operating-system specific VFS implementation. The
1.5 ! misha 2254: ** Windows VFS uses native malloc() and free() for some operations.
1.4 misha 2255: **
1.5 ! misha 2256: ** ^The sqlite3_malloc() routine returns a pointer to a block
1.4 misha 2257: ** of memory at least N bytes in length, where N is the parameter.
1.5 ! misha 2258: ** ^If sqlite3_malloc() is unable to obtain sufficient free
! 2259: ** memory, it returns a NULL pointer. ^If the parameter N to
1.4 misha 2260: ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
2261: ** a NULL pointer.
2262: **
1.5 ! misha 2263: ** ^Calling sqlite3_free() with a pointer previously returned
1.4 misha 2264: ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
1.5 ! misha 2265: ** that it might be reused. ^The sqlite3_free() routine is
1.4 misha 2266: ** a no-op if is called with a NULL pointer. Passing a NULL pointer
2267: ** to sqlite3_free() is harmless. After being freed, memory
2268: ** should neither be read nor written. Even reading previously freed
2269: ** memory might result in a segmentation fault or other severe error.
2270: ** Memory corruption, a segmentation fault, or other severe error
2271: ** might result if sqlite3_free() is called with a non-NULL pointer that
1.5 ! misha 2272: ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
1.4 misha 2273: **
1.5 ! misha 2274: ** ^(The sqlite3_realloc() interface attempts to resize a
1.4 misha 2275: ** prior memory allocation to be at least N bytes, where N is the
2276: ** second parameter. The memory allocation to be resized is the first
1.5 ! misha 2277: ** parameter.)^ ^ If the first parameter to sqlite3_realloc()
1.4 misha 2278: ** is a NULL pointer then its behavior is identical to calling
2279: ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
1.5 ! misha 2280: ** ^If the second parameter to sqlite3_realloc() is zero or
1.4 misha 2281: ** negative then the behavior is exactly the same as calling
2282: ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
1.5 ! misha 2283: ** ^sqlite3_realloc() returns a pointer to a memory allocation
1.4 misha 2284: ** of at least N bytes in size or NULL if sufficient memory is unavailable.
1.5 ! misha 2285: ** ^If M is the size of the prior allocation, then min(N,M) bytes
1.4 misha 2286: ** of the prior allocation are copied into the beginning of buffer returned
2287: ** by sqlite3_realloc() and the prior allocation is freed.
1.5 ! misha 2288: ** ^If sqlite3_realloc() returns NULL, then the prior allocation
1.4 misha 2289: ** is not freed.
1.2 misha 2290: **
1.5 ! misha 2291: ** ^The memory returned by sqlite3_malloc() and sqlite3_realloc()
! 2292: ** is always aligned to at least an 8 byte boundary, or to a
! 2293: ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
! 2294: ** option is used.
1.3 misha 2295: **
2296: ** In SQLite version 3.5.0 and 3.5.1, it was possible to define
2297: ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
2298: ** implementation of these routines to be omitted. That capability
1.5 ! misha 2299: ** is no longer provided. Only built-in memory allocators can be used.
1.2 misha 2300: **
1.5 ! misha 2301: ** Prior to SQLite version 3.7.10, the Windows OS interface layer called
1.2 misha 2302: ** the system malloc() and free() directly when converting
2303: ** filenames between the UTF-8 encoding used by SQLite
1.5 ! misha 2304: ** and whatever filename encoding is used by the particular Windows
! 2305: ** installation. Memory allocation errors were detected, but
! 2306: ** they were reported back as [SQLITE_CANTOPEN] or
1.2 misha 2307: ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
1.4 misha 2308: **
1.5 ! misha 2309: ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
! 2310: ** must be either NULL or else pointers obtained from a prior
! 2311: ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
! 2312: ** not yet been released.
1.4 misha 2313: **
1.5 ! misha 2314: ** The application must not read or write any part of
! 2315: ** a block of memory after it has been released using
! 2316: ** [sqlite3_free()] or [sqlite3_realloc()].
! 2317: */
! 2318: SQLITE_API void *sqlite3_malloc(int);
! 2319: SQLITE_API void *sqlite3_realloc(void*, int);
! 2320: SQLITE_API void sqlite3_free(void*);
! 2321:
! 2322: /*
! 2323: ** CAPI3REF: Memory Allocator Statistics
1.4 misha 2324: **
1.5 ! misha 2325: ** SQLite provides these two interfaces for reporting on the status
! 2326: ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
! 2327: ** routines, which form the built-in memory allocation subsystem.
1.4 misha 2328: **
1.5 ! misha 2329: ** ^The [sqlite3_memory_used()] routine returns the number of bytes
! 2330: ** of memory currently outstanding (malloced but not freed).
! 2331: ** ^The [sqlite3_memory_highwater()] routine returns the maximum
! 2332: ** value of [sqlite3_memory_used()] since the high-water mark
! 2333: ** was last reset. ^The values returned by [sqlite3_memory_used()] and
! 2334: ** [sqlite3_memory_highwater()] include any overhead
! 2335: ** added by SQLite in its implementation of [sqlite3_malloc()],
! 2336: ** but not overhead added by the any underlying system library
! 2337: ** routines that [sqlite3_malloc()] may call.
1.4 misha 2338: **
1.5 ! misha 2339: ** ^The memory high-water mark is reset to the current value of
! 2340: ** [sqlite3_memory_used()] if and only if the parameter to
! 2341: ** [sqlite3_memory_highwater()] is true. ^The value returned
! 2342: ** by [sqlite3_memory_highwater(1)] is the high-water mark
! 2343: ** prior to the reset.
1.2 misha 2344: */
1.5 ! misha 2345: SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
! 2346: SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
1.2 misha 2347:
2348: /*
1.5 ! misha 2349: ** CAPI3REF: Pseudo-Random Number Generator
1.2 misha 2350: **
1.5 ! misha 2351: ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
! 2352: ** select random [ROWID | ROWIDs] when inserting new records into a table that
! 2353: ** already uses the largest possible [ROWID]. The PRNG is also used for
! 2354: ** the build-in random() and randomblob() SQL functions. This interface allows
! 2355: ** applications to access the same PRNG for other purposes.
1.4 misha 2356: **
1.5 ! misha 2357: ** ^A call to this routine stores N bytes of randomness into buffer P.
1.4 misha 2358: **
1.5 ! misha 2359: ** ^The first time this routine is invoked (either internally or by
! 2360: ** the application) the PRNG is seeded using randomness obtained
! 2361: ** from the xRandomness method of the default [sqlite3_vfs] object.
! 2362: ** ^On all subsequent invocations, the pseudo-randomness is generated
! 2363: ** internally and without recourse to the [sqlite3_vfs] xRandomness
! 2364: ** method.
1.2 misha 2365: */
1.5 ! misha 2366: SQLITE_API void sqlite3_randomness(int N, void *P);
1.2 misha 2367:
2368: /*
1.5 ! misha 2369: ** CAPI3REF: Compile-Time Authorization Callbacks
1.4 misha 2370: **
1.5 ! misha 2371: ** ^This routine registers an authorizer callback with a particular
! 2372: ** [database connection], supplied in the first argument.
! 2373: ** ^The authorizer callback is invoked as SQL statements are being compiled
1.2 misha 2374: ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
1.5 ! misha 2375: ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various
1.2 misha 2376: ** points during the compilation process, as logic is being created
2377: ** to perform various actions, the authorizer callback is invoked to
1.5 ! misha 2378: ** see if those actions are allowed. ^The authorizer callback should
! 2379: ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
1.2 misha 2380: ** specific action but allow the SQL statement to continue to be
2381: ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
1.5 ! misha 2382: ** rejected with an error. ^If the authorizer callback returns
1.4 misha 2383: ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
1.5 ! misha 2384: ** then the [sqlite3_prepare_v2()] or equivalent call that triggered
1.4 misha 2385: ** the authorizer will fail with an error message.
2386: **
2387: ** When the callback returns [SQLITE_OK], that means the operation
1.5 ! misha 2388: ** requested is ok. ^When the callback returns [SQLITE_DENY], the
1.4 misha 2389: ** [sqlite3_prepare_v2()] or equivalent call that triggered the
2390: ** authorizer will fail with an error message explaining that
1.5 ! misha 2391: ** access is denied.
! 2392: **
! 2393: ** ^The first parameter to the authorizer callback is a copy of the third
! 2394: ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
! 2395: ** to the callback is an integer [SQLITE_COPY | action code] that specifies
! 2396: ** the particular action to be authorized. ^The third through sixth parameters
! 2397: ** to the callback are zero-terminated strings that contain additional
! 2398: ** details about the action to be authorized.
! 2399: **
! 2400: ** ^If the action code is [SQLITE_READ]
! 2401: ** and the callback returns [SQLITE_IGNORE] then the
! 2402: ** [prepared statement] statement is constructed to substitute
! 2403: ** a NULL value in place of the table column that would have
1.4 misha 2404: ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
2405: ** return can be used to deny an untrusted user access to individual
2406: ** columns of a table.
1.5 ! misha 2407: ** ^If the action code is [SQLITE_DELETE] and the callback returns
! 2408: ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
! 2409: ** [truncate optimization] is disabled and all rows are deleted individually.
! 2410: **
! 2411: ** An authorizer is used when [sqlite3_prepare | preparing]
! 2412: ** SQL statements from an untrusted source, to ensure that the SQL statements
! 2413: ** do not try to access data they are not allowed to see, or that they do not
! 2414: ** try to execute malicious statements that damage the database. For
1.2 misha 2415: ** example, an application may allow a user to enter arbitrary
2416: ** SQL queries for evaluation by a database. But the application does
2417: ** not want the user to be able to make arbitrary changes to the
2418: ** database. An authorizer could then be put in place while the
1.5 ! misha 2419: ** user-entered SQL is being [sqlite3_prepare | prepared] that
! 2420: ** disallows everything except [SELECT] statements.
! 2421: **
! 2422: ** Applications that need to process SQL from untrusted sources
! 2423: ** might also consider lowering resource limits using [sqlite3_limit()]
! 2424: ** and limiting database size using the [max_page_count] [PRAGMA]
! 2425: ** in addition to using an authorizer.
1.2 misha 2426: **
1.5 ! misha 2427: ** ^(Only a single authorizer can be in place on a database connection
1.2 misha 2428: ** at a time. Each call to sqlite3_set_authorizer overrides the
1.5 ! misha 2429: ** previous call.)^ ^Disable the authorizer by installing a NULL callback.
1.4 misha 2430: ** The authorizer is disabled by default.
1.2 misha 2431: **
1.5 ! misha 2432: ** The authorizer callback must not do anything that will modify
! 2433: ** the database connection that invoked the authorizer callback.
! 2434: ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
! 2435: ** database connections for the meaning of "modify" in this paragraph.
! 2436: **
! 2437: ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
! 2438: ** statement might be re-prepared during [sqlite3_step()] due to a
! 2439: ** schema change. Hence, the application should ensure that the
! 2440: ** correct authorizer callback remains in place during the [sqlite3_step()].
! 2441: **
! 2442: ** ^Note that the authorizer callback is invoked only during
1.2 misha 2443: ** [sqlite3_prepare()] or its variants. Authorization is not
1.5 ! misha 2444: ** performed during statement evaluation in [sqlite3_step()], unless
! 2445: ** as stated in the previous paragraph, sqlite3_step() invokes
! 2446: ** sqlite3_prepare_v2() to reprepare a statement after a schema change.
1.1 misha 2447: */
1.5 ! misha 2448: SQLITE_API int sqlite3_set_authorizer(
1.1 misha 2449: sqlite3*,
2450: int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
2451: void *pUserData
2452: );
2453:
2454: /*
1.5 ! misha 2455: ** CAPI3REF: Authorizer Return Codes
1.2 misha 2456: **
2457: ** The [sqlite3_set_authorizer | authorizer callback function] must
2458: ** return either [SQLITE_OK] or one of these two constants in order
2459: ** to signal SQLite whether or not the action is permitted. See the
2460: ** [sqlite3_set_authorizer | authorizer documentation] for additional
2461: ** information.
1.5 ! misha 2462: **
! 2463: ** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code]
! 2464: ** from the [sqlite3_vtab_on_conflict()] interface.
1.2 misha 2465: */
2466: #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
2467: #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
2468:
2469: /*
1.5 ! misha 2470: ** CAPI3REF: Authorizer Action Codes
1.2 misha 2471: **
2472: ** The [sqlite3_set_authorizer()] interface registers a callback function
1.5 ! misha 2473: ** that is invoked to authorize certain SQL statement actions. The
1.2 misha 2474: ** second parameter to the callback is an integer code that specifies
2475: ** what action is being authorized. These are the integer action codes that
2476: ** the authorizer callback may be passed.
2477: **
1.5 ! misha 2478: ** These action code values signify what kind of operation is to be
1.4 misha 2479: ** authorized. The 3rd and 4th parameters to the authorization
2480: ** callback function will be parameters or NULL depending on which of these
1.5 ! misha 2481: ** codes is used as the second parameter. ^(The 5th parameter to the
! 2482: ** authorizer callback is the name of the database ("main", "temp",
! 2483: ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
1.1 misha 2484: ** is the name of the inner-most trigger or view that is responsible for
1.5 ! misha 2485: ** the access attempt or NULL if this access attempt is directly from
1.2 misha 2486: ** top-level SQL code.
1.1 misha 2487: */
1.2 misha 2488: /******************************************* 3rd ************ 4th ***********/
1.1 misha 2489: #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
2490: #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
2491: #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
2492: #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
2493: #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
2494: #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
2495: #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
2496: #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
2497: #define SQLITE_DELETE 9 /* Table Name NULL */
2498: #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
2499: #define SQLITE_DROP_TABLE 11 /* Table Name NULL */
2500: #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
2501: #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
2502: #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
2503: #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
2504: #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
2505: #define SQLITE_DROP_VIEW 17 /* View Name NULL */
2506: #define SQLITE_INSERT 18 /* Table Name NULL */
2507: #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
2508: #define SQLITE_READ 20 /* Table Name Column Name */
2509: #define SQLITE_SELECT 21 /* NULL NULL */
1.5 ! misha 2510: #define SQLITE_TRANSACTION 22 /* Operation NULL */
1.1 misha 2511: #define SQLITE_UPDATE 23 /* Table Name Column Name */
2512: #define SQLITE_ATTACH 24 /* Filename NULL */
2513: #define SQLITE_DETACH 25 /* Database Name NULL */
1.2 misha 2514: #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
2515: #define SQLITE_REINDEX 27 /* Index Name NULL */
2516: #define SQLITE_ANALYZE 28 /* Table Name NULL */
2517: #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
2518: #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
1.5 ! misha 2519: #define SQLITE_FUNCTION 31 /* NULL Function Name */
! 2520: #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
1.2 misha 2521: #define SQLITE_COPY 0 /* No longer used */
2522:
2523: /*
1.5 ! misha 2524: ** CAPI3REF: Tracing And Profiling Functions
1.2 misha 2525: **
2526: ** These routines register callback functions that can be used for
2527: ** tracing and profiling the execution of SQL statements.
1.4 misha 2528: **
1.5 ! misha 2529: ** ^The callback function registered by sqlite3_trace() is invoked at
1.4 misha 2530: ** various times when an SQL statement is being run by [sqlite3_step()].
1.5 ! misha 2531: ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
! 2532: ** SQL statement text as the statement first begins executing.
! 2533: ** ^(Additional sqlite3_trace() callbacks might occur
! 2534: ** as each triggered subprogram is entered. The callbacks for triggers
! 2535: ** contain a UTF-8 SQL comment that identifies the trigger.)^
1.2 misha 2536: **
1.5 ! misha 2537: ** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
! 2538: ** the length of [bound parameter] expansion in the output of sqlite3_trace().
1.4 misha 2539: **
1.5 ! misha 2540: ** ^The callback function registered by sqlite3_profile() is invoked
! 2541: ** as each SQL statement finishes. ^The profile callback contains
! 2542: ** the original statement text and an estimate of wall-clock time
! 2543: ** of how long that statement took to run. ^The profile callback
! 2544: ** time is in units of nanoseconds, however the current implementation
! 2545: ** is only capable of millisecond resolution so the six least significant
! 2546: ** digits in the time are meaningless. Future versions of SQLite
! 2547: ** might provide greater resolution on the profiler callback. The
! 2548: ** sqlite3_profile() function is considered experimental and is
! 2549: ** subject to change in future versions of SQLite.
1.1 misha 2550: */
1.5 ! misha 2551: SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
! 2552: SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
1.2 misha 2553: void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
1.1 misha 2554:
2555: /*
1.5 ! misha 2556: ** CAPI3REF: Query Progress Callbacks
1.2 misha 2557: **
1.5 ! misha 2558: ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
! 2559: ** function X to be invoked periodically during long running calls to
! 2560: ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
! 2561: ** database connection D. An example use for this
1.2 misha 2562: ** interface is to keep a GUI updated during a large query.
1.1 misha 2563: **
1.5 ! misha 2564: ** ^The parameter P is passed through as the only parameter to the
! 2565: ** callback function X. ^The parameter N is the approximate number of
! 2566: ** [virtual machine instructions] that are evaluated between successive
! 2567: ** invocations of the callback X. ^If N is less than one then the progress
! 2568: ** handler is disabled.
! 2569: **
! 2570: ** ^Only a single progress handler may be defined at one time per
! 2571: ** [database connection]; setting a new progress handler cancels the
! 2572: ** old one. ^Setting parameter X to NULL disables the progress handler.
! 2573: ** ^The progress handler is also disabled by setting N to a value less
! 2574: ** than 1.
! 2575: **
! 2576: ** ^If the progress callback returns non-zero, the operation is
1.4 misha 2577: ** interrupted. This feature can be used to implement a
1.5 ! misha 2578: ** "Cancel" button on a GUI progress dialog box.
1.4 misha 2579: **
1.5 ! misha 2580: ** The progress handler callback must not do anything that will modify
! 2581: ** the database connection that invoked the progress handler.
! 2582: ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
! 2583: ** database connections for the meaning of "modify" in this paragraph.
! 2584: **
! 2585: */
! 2586: SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
! 2587:
! 2588: /*
! 2589: ** CAPI3REF: Opening A New Database Connection
! 2590: **
! 2591: ** ^These routines open an SQLite database file as specified by the
! 2592: ** filename argument. ^The filename argument is interpreted as UTF-8 for
! 2593: ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
! 2594: ** order for sqlite3_open16(). ^(A [database connection] handle is usually
! 2595: ** returned in *ppDb, even if an error occurs. The only exception is that
! 2596: ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
! 2597: ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
! 2598: ** object.)^ ^(If the database is opened (and/or created) successfully, then
! 2599: ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
! 2600: ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
! 2601: ** an English language description of the error following a failure of any
! 2602: ** of the sqlite3_open() routines.
! 2603: **
! 2604: ** ^The default encoding for the database will be UTF-8 if
! 2605: ** sqlite3_open() or sqlite3_open_v2() is called and
! 2606: ** UTF-16 in the native byte order if sqlite3_open16() is used.
1.4 misha 2607: **
1.5 ! misha 2608: ** Whether or not an error occurs when it is opened, resources
! 2609: ** associated with the [database connection] handle should be released by
! 2610: ** passing it to [sqlite3_close()] when it is no longer required.
1.4 misha 2611: **
1.5 ! misha 2612: ** The sqlite3_open_v2() interface works like sqlite3_open()
! 2613: ** except that it accepts two additional parameters for additional control
! 2614: ** over the new database connection. ^(The flags parameter to
! 2615: ** sqlite3_open_v2() can take one of
! 2616: ** the following three values, optionally combined with the
! 2617: ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
! 2618: ** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^
! 2619: **
! 2620: ** <dl>
! 2621: ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
! 2622: ** <dd>The database is opened in read-only mode. If the database does not
! 2623: ** already exist, an error is returned.</dd>)^
! 2624: **
! 2625: ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
! 2626: ** <dd>The database is opened for reading and writing if possible, or reading
! 2627: ** only if the file is write protected by the operating system. In either
! 2628: ** case the database must already exist, otherwise an error is returned.</dd>)^
! 2629: **
! 2630: ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
! 2631: ** <dd>The database is opened for reading and writing, and is created if
! 2632: ** it does not already exist. This is the behavior that is always used for
! 2633: ** sqlite3_open() and sqlite3_open16().</dd>)^
! 2634: ** </dl>
! 2635: **
! 2636: ** If the 3rd parameter to sqlite3_open_v2() is not one of the
! 2637: ** combinations shown above optionally combined with other
! 2638: ** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
! 2639: ** then the behavior is undefined.
1.4 misha 2640: **
1.5 ! misha 2641: ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
! 2642: ** opens in the multi-thread [threading mode] as long as the single-thread
! 2643: ** mode has not been set at compile-time or start-time. ^If the
! 2644: ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
! 2645: ** in the serialized [threading mode] unless single-thread was
! 2646: ** previously selected at compile-time or start-time.
! 2647: ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
! 2648: ** eligible to use [shared cache mode], regardless of whether or not shared
! 2649: ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
! 2650: ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
! 2651: ** participate in [shared cache mode] even if it is enabled.
! 2652: **
! 2653: ** ^The fourth parameter to sqlite3_open_v2() is the name of the
! 2654: ** [sqlite3_vfs] object that defines the operating system interface that
! 2655: ** the new database connection should use. ^If the fourth parameter is
! 2656: ** a NULL pointer then the default [sqlite3_vfs] object is used.
! 2657: **
! 2658: ** ^If the filename is ":memory:", then a private, temporary in-memory database
! 2659: ** is created for the connection. ^This in-memory database will vanish when
! 2660: ** the database connection is closed. Future versions of SQLite might
! 2661: ** make use of additional special filenames that begin with the ":" character.
! 2662: ** It is recommended that when a database filename actually does begin with
! 2663: ** a ":" character you should prefix the filename with a pathname such as
! 2664: ** "./" to avoid ambiguity.
1.4 misha 2665: **
1.5 ! misha 2666: ** ^If the filename is an empty string, then a private, temporary
! 2667: ** on-disk database will be created. ^This private database will be
! 2668: ** automatically deleted as soon as the database connection is closed.
1.4 misha 2669: **
1.5 ! misha 2670: ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
1.4 misha 2671: **
1.5 ! misha 2672: ** ^If [URI filename] interpretation is enabled, and the filename argument
! 2673: ** begins with "file:", then the filename is interpreted as a URI. ^URI
! 2674: ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
! 2675: ** set in the fourth argument to sqlite3_open_v2(), or if it has
! 2676: ** been enabled globally using the [SQLITE_CONFIG_URI] option with the
! 2677: ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
! 2678: ** As of SQLite version 3.7.7, URI filename interpretation is turned off
! 2679: ** by default, but future releases of SQLite might enable URI filename
! 2680: ** interpretation by default. See "[URI filenames]" for additional
! 2681: ** information.
1.4 misha 2682: **
1.5 ! misha 2683: ** URI filenames are parsed according to RFC 3986. ^If the URI contains an
! 2684: ** authority, then it must be either an empty string or the string
! 2685: ** "localhost". ^If the authority is not an empty string or "localhost", an
! 2686: ** error is returned to the caller. ^The fragment component of a URI, if
! 2687: ** present, is ignored.
! 2688: **
! 2689: ** ^SQLite uses the path component of the URI as the name of the disk file
! 2690: ** which contains the database. ^If the path begins with a '/' character,
! 2691: ** then it is interpreted as an absolute path. ^If the path does not begin
! 2692: ** with a '/' (meaning that the authority section is omitted from the URI)
! 2693: ** then the path is interpreted as a relative path.
! 2694: ** ^On windows, the first component of an absolute path
! 2695: ** is a drive specification (e.g. "C:").
! 2696: **
! 2697: ** [[core URI query parameters]]
! 2698: ** The query component of a URI may contain parameters that are interpreted
! 2699: ** either by SQLite itself, or by a [VFS | custom VFS implementation].
! 2700: ** SQLite interprets the following three query parameters:
1.1 misha 2701: **
1.5 ! misha 2702: ** <ul>
! 2703: ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
! 2704: ** a VFS object that provides the operating system interface that should
! 2705: ** be used to access the database file on disk. ^If this option is set to
! 2706: ** an empty string the default VFS object is used. ^Specifying an unknown
! 2707: ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
! 2708: ** present, then the VFS specified by the option takes precedence over
! 2709: ** the value passed as the fourth parameter to sqlite3_open_v2().
! 2710: **
! 2711: ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
! 2712: ** "rwc", or "memory". Attempting to set it to any other value is
! 2713: ** an error)^.
! 2714: ** ^If "ro" is specified, then the database is opened for read-only
! 2715: ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
! 2716: ** third argument to sqlite3_open_v2(). ^If the mode option is set to
! 2717: ** "rw", then the database is opened for read-write (but not create)
! 2718: ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
! 2719: ** been set. ^Value "rwc" is equivalent to setting both
! 2720: ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
! 2721: ** set to "memory" then a pure [in-memory database] that never reads
! 2722: ** or writes from disk is used. ^It is an error to specify a value for
! 2723: ** the mode parameter that is less restrictive than that specified by
! 2724: ** the flags passed in the third parameter to sqlite3_open_v2().
! 2725: **
! 2726: ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
! 2727: ** "private". ^Setting it to "shared" is equivalent to setting the
! 2728: ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
! 2729: ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
! 2730: ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
! 2731: ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
! 2732: ** a URI filename, its value overrides any behavior requested by setting
! 2733: ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
! 2734: ** </ul>
1.4 misha 2735: **
1.5 ! misha 2736: ** ^Specifying an unknown parameter in the query component of a URI is not an
! 2737: ** error. Future versions of SQLite might understand additional query
! 2738: ** parameters. See "[query parameters with special meaning to SQLite]" for
! 2739: ** additional information.
1.2 misha 2740: **
1.5 ! misha 2741: ** [[URI filename examples]] <h3>URI filename examples</h3>
1.2 misha 2742: **
1.5 ! misha 2743: ** <table border="1" align=center cellpadding=5>
! 2744: ** <tr><th> URI filenames <th> Results
! 2745: ** <tr><td> file:data.db <td>
! 2746: ** Open the file "data.db" in the current directory.
! 2747: ** <tr><td> file:/home/fred/data.db<br>
! 2748: ** file:///home/fred/data.db <br>
! 2749: ** file://localhost/home/fred/data.db <br> <td>
! 2750: ** Open the database file "/home/fred/data.db".
! 2751: ** <tr><td> file://darkstar/home/fred/data.db <td>
! 2752: ** An error. "darkstar" is not a recognized authority.
! 2753: ** <tr><td style="white-space:nowrap">
! 2754: ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
! 2755: ** <td> Windows only: Open the file "data.db" on fred's desktop on drive
! 2756: ** C:. Note that the %20 escaping in this example is not strictly
! 2757: ** necessary - space characters can be used literally
! 2758: ** in URI filenames.
! 2759: ** <tr><td> file:data.db?mode=ro&cache=private <td>
! 2760: ** Open file "data.db" in the current directory for read-only access.
! 2761: ** Regardless of whether or not shared-cache mode is enabled by
! 2762: ** default, use a private cache.
! 2763: ** <tr><td> file:/home/fred/data.db?vfs=unix-nolock <td>
! 2764: ** Open file "/home/fred/data.db". Use the special VFS "unix-nolock".
! 2765: ** <tr><td> file:data.db?mode=readonly <td>
! 2766: ** An error. "readonly" is not a valid option for the "mode" parameter.
! 2767: ** </table>
1.2 misha 2768: **
1.5 ! misha 2769: ** ^URI hexadecimal escape sequences (%HH) are supported within the path and
! 2770: ** query components of a URI. A hexadecimal escape sequence consists of a
! 2771: ** percent sign - "%" - followed by exactly two hexadecimal digits
! 2772: ** specifying an octet value. ^Before the path or query components of a
! 2773: ** URI filename are interpreted, they are encoded using UTF-8 and all
! 2774: ** hexadecimal escape sequences replaced by a single byte containing the
! 2775: ** corresponding octet. If this process generates an invalid UTF-8 encoding,
! 2776: ** the results are undefined.
1.2 misha 2777: **
1.5 ! misha 2778: ** <b>Note to Windows users:</b> The encoding used for the filename argument
! 2779: ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
1.2 misha 2780: ** codepage is currently defined. Filenames containing international
2781: ** characters must be converted to UTF-8 prior to passing them into
1.5 ! misha 2782: ** sqlite3_open() or sqlite3_open_v2().
1.4 misha 2783: **
1.5 ! misha 2784: ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
! 2785: ** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
! 2786: ** features that require the use of temporary files may fail.
1.4 misha 2787: **
1.5 ! misha 2788: ** See also: [sqlite3_temp_directory]
1.1 misha 2789: */
1.5 ! misha 2790: SQLITE_API int sqlite3_open(
1.1 misha 2791: const char *filename, /* Database filename (UTF-8) */
2792: sqlite3 **ppDb /* OUT: SQLite db handle */
2793: );
1.5 ! misha 2794: SQLITE_API int sqlite3_open16(
1.1 misha 2795: const void *filename, /* Database filename (UTF-16) */
2796: sqlite3 **ppDb /* OUT: SQLite db handle */
2797: );
1.5 ! misha 2798: SQLITE_API int sqlite3_open_v2(
1.2 misha 2799: const char *filename, /* Database filename (UTF-8) */
2800: sqlite3 **ppDb, /* OUT: SQLite db handle */
2801: int flags, /* Flags */
2802: const char *zVfs /* Name of VFS module to use */
2803: );
1.1 misha 2804:
2805: /*
1.5 ! misha 2806: ** CAPI3REF: Obtain Values For URI Parameters
1.2 misha 2807: **
1.5 ! misha 2808: ** These are utility routines, useful to VFS implementations, that check
! 2809: ** to see if a database file was a URI that contained a specific query
! 2810: ** parameter, and if so obtains the value of that query parameter.
! 2811: **
! 2812: ** If F is the database filename pointer passed into the xOpen() method of
! 2813: ** a VFS implementation when the flags parameter to xOpen() has one or
! 2814: ** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
! 2815: ** P is the name of the query parameter, then
! 2816: ** sqlite3_uri_parameter(F,P) returns the value of the P
! 2817: ** parameter if it exists or a NULL pointer if P does not appear as a
! 2818: ** query parameter on F. If P is a query parameter of F
! 2819: ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
! 2820: ** a pointer to an empty string.
! 2821: **
! 2822: ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
! 2823: ** parameter and returns true (1) or false (0) according to the value
! 2824: ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
! 2825: ** value of query parameter P is one of "yes", "true", or "on" in any
! 2826: ** case or if the value begins with a non-zero number. The
! 2827: ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
! 2828: ** query parameter P is one of "no", "false", or "off" in any case or
! 2829: ** if the value begins with a numeric zero. If P is not a query
! 2830: ** parameter on F or if the value of P is does not match any of the
! 2831: ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
! 2832: **
! 2833: ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
! 2834: ** 64-bit signed integer and returns that integer, or D if P does not
! 2835: ** exist. If the value of P is something other than an integer, then
! 2836: ** zero is returned.
! 2837: **
! 2838: ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
! 2839: ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
! 2840: ** is not a database file pathname pointer that SQLite passed into the xOpen
! 2841: ** VFS method, then the behavior of this routine is undefined and probably
! 2842: ** undesirable.
! 2843: */
! 2844: SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
! 2845: SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
! 2846: SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
! 2847:
! 2848:
! 2849: /*
! 2850: ** CAPI3REF: Error Codes And Messages
! 2851: **
! 2852: ** ^The sqlite3_errcode() interface returns the numeric [result code] or
! 2853: ** [extended result code] for the most recent failed sqlite3_* API call
! 2854: ** associated with a [database connection]. If a prior API call failed
! 2855: ** but the most recent API call succeeded, the return value from
! 2856: ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode()
! 2857: ** interface is the same except that it always returns the
! 2858: ** [extended result code] even when extended result codes are
! 2859: ** disabled.
! 2860: **
! 2861: ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
! 2862: ** text that describes the error, as either UTF-8 or UTF-16 respectively.
! 2863: ** ^(Memory to hold the error message string is managed internally.
! 2864: ** The application does not need to worry about freeing the result.
1.4 misha 2865: ** However, the error string might be overwritten or deallocated by
1.5 ! misha 2866: ** subsequent calls to other SQLite interface functions.)^
1.4 misha 2867: **
1.5 ! misha 2868: ** ^The sqlite3_errstr() interface returns the English-language text
! 2869: ** that describes the [result code], as UTF-8.
! 2870: ** ^(Memory to hold the error message string is managed internally
! 2871: ** and must not be freed by the application)^.
! 2872: **
! 2873: ** When the serialized [threading mode] is in use, it might be the
! 2874: ** case that a second error occurs on a separate thread in between
! 2875: ** the time of the first error and the call to these interfaces.
! 2876: ** When that happens, the second error will be reported since these
! 2877: ** interfaces always report the most recent result. To avoid
! 2878: ** this, each thread can obtain exclusive use of the [database connection] D
! 2879: ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
! 2880: ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
! 2881: ** all calls to the interfaces listed here are completed.
! 2882: **
! 2883: ** If an interface fails with SQLITE_MISUSE, that means the interface
! 2884: ** was invoked incorrectly by the application. In that case, the
! 2885: ** error code and message may or may not be set.
! 2886: */
! 2887: SQLITE_API int sqlite3_errcode(sqlite3 *db);
! 2888: SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
! 2889: SQLITE_API const char *sqlite3_errmsg(sqlite3*);
! 2890: SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
! 2891: SQLITE_API const char *sqlite3_errstr(int);
1.1 misha 2892:
2893: /*
1.5 ! misha 2894: ** CAPI3REF: SQL Statement Object
1.4 misha 2895: ** KEYWORDS: {prepared statement} {prepared statements}
1.2 misha 2896: **
1.5 ! misha 2897: ** An instance of this object represents a single SQL statement.
! 2898: ** This object is variously known as a "prepared statement" or a
1.2 misha 2899: ** "compiled SQL statement" or simply as a "statement".
1.5 ! misha 2900: **
1.2 misha 2901: ** The life of a statement object goes something like this:
1.1 misha 2902: **
1.2 misha 2903: ** <ol>
2904: ** <li> Create the object using [sqlite3_prepare_v2()] or a related
2905: ** function.
1.5 ! misha 2906: ** <li> Bind values to [host parameters] using the sqlite3_bind_*()
! 2907: ** interfaces.
1.2 misha 2908: ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2909: ** <li> Reset the statement using [sqlite3_reset()] then go back
2910: ** to step 2. Do this zero or more times.
2911: ** <li> Destroy the object using [sqlite3_finalize()].
2912: ** </ol>
1.1 misha 2913: **
1.2 misha 2914: ** Refer to documentation on individual methods above for additional
2915: ** information.
1.1 misha 2916: */
2917: typedef struct sqlite3_stmt sqlite3_stmt;
2918:
2919: /*
1.5 ! misha 2920: ** CAPI3REF: Run-time Limits
! 2921: **
! 2922: ** ^(This interface allows the size of various constructs to be limited
! 2923: ** on a connection by connection basis. The first parameter is the
! 2924: ** [database connection] whose limit is to be set or queried. The
! 2925: ** second parameter is one of the [limit categories] that define a
! 2926: ** class of constructs to be size limited. The third parameter is the
! 2927: ** new limit for that construct.)^
! 2928: **
! 2929: ** ^If the new limit is a negative number, the limit is unchanged.
! 2930: ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
! 2931: ** [limits | hard upper bound]
! 2932: ** set at compile-time by a C preprocessor macro called
! 2933: ** [limits | SQLITE_MAX_<i>NAME</i>].
! 2934: ** (The "_LIMIT_" in the name is changed to "_MAX_".))^
! 2935: ** ^Attempts to increase a limit above its hard upper bound are
! 2936: ** silently truncated to the hard upper bound.
! 2937: **
! 2938: ** ^Regardless of whether or not the limit was changed, the
! 2939: ** [sqlite3_limit()] interface returns the prior value of the limit.
! 2940: ** ^Hence, to find the current value of a limit without changing it,
! 2941: ** simply invoke this interface with the third parameter set to -1.
! 2942: **
! 2943: ** Run-time limits are intended for use in applications that manage
! 2944: ** both their own internal database and also databases that are controlled
! 2945: ** by untrusted external sources. An example application might be a
! 2946: ** web browser that has its own databases for storing history and
! 2947: ** separate databases controlled by JavaScript applications downloaded
! 2948: ** off the Internet. The internal databases can be given the
! 2949: ** large, default limits. Databases managed by external sources can
! 2950: ** be given much smaller limits designed to prevent a denial of service
! 2951: ** attack. Developers might also want to use the [sqlite3_set_authorizer()]
! 2952: ** interface to further control untrusted SQL. The size of the database
! 2953: ** created by an untrusted script can be contained using the
! 2954: ** [max_page_count] [PRAGMA].
! 2955: **
! 2956: ** New run-time limit categories may be added in future releases.
! 2957: */
! 2958: SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
! 2959:
! 2960: /*
! 2961: ** CAPI3REF: Run-Time Limit Categories
! 2962: ** KEYWORDS: {limit category} {*limit categories}
! 2963: **
! 2964: ** These constants define various performance limits
! 2965: ** that can be lowered at run-time using [sqlite3_limit()].
! 2966: ** The synopsis of the meanings of the various limits is shown below.
! 2967: ** Additional information is available at [limits | Limits in SQLite].
! 2968: **
! 2969: ** <dl>
! 2970: ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
! 2971: ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
! 2972: **
! 2973: ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
! 2974: ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
! 2975: **
! 2976: ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
! 2977: ** <dd>The maximum number of columns in a table definition or in the
! 2978: ** result set of a [SELECT] or the maximum number of columns in an index
! 2979: ** or in an ORDER BY or GROUP BY clause.</dd>)^
! 2980: **
! 2981: ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
! 2982: ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
! 2983: **
! 2984: ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
! 2985: ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
! 2986: **
! 2987: ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
! 2988: ** <dd>The maximum number of instructions in a virtual machine program
! 2989: ** used to implement an SQL statement. This limit is not currently
! 2990: ** enforced, though that might be added in some future release of
! 2991: ** SQLite.</dd>)^
! 2992: **
! 2993: ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
! 2994: ** <dd>The maximum number of arguments on a function.</dd>)^
! 2995: **
! 2996: ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
! 2997: ** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
! 2998: **
! 2999: ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
! 3000: ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
! 3001: ** <dd>The maximum length of the pattern argument to the [LIKE] or
! 3002: ** [GLOB] operators.</dd>)^
! 3003: **
! 3004: ** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
! 3005: ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
! 3006: ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
! 3007: **
! 3008: ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
! 3009: ** <dd>The maximum depth of recursion for triggers.</dd>)^
! 3010: ** </dl>
! 3011: */
! 3012: #define SQLITE_LIMIT_LENGTH 0
! 3013: #define SQLITE_LIMIT_SQL_LENGTH 1
! 3014: #define SQLITE_LIMIT_COLUMN 2
! 3015: #define SQLITE_LIMIT_EXPR_DEPTH 3
! 3016: #define SQLITE_LIMIT_COMPOUND_SELECT 4
! 3017: #define SQLITE_LIMIT_VDBE_OP 5
! 3018: #define SQLITE_LIMIT_FUNCTION_ARG 6
! 3019: #define SQLITE_LIMIT_ATTACHED 7
! 3020: #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
! 3021: #define SQLITE_LIMIT_VARIABLE_NUMBER 9
! 3022: #define SQLITE_LIMIT_TRIGGER_DEPTH 10
! 3023:
! 3024: /*
! 3025: ** CAPI3REF: Compiling An SQL Statement
! 3026: ** KEYWORDS: {SQL statement compiler}
1.2 misha 3027: **
1.1 misha 3028: ** To execute an SQL query, it must first be compiled into a byte-code
1.5 ! misha 3029: ** program using one of these routines.
1.2 misha 3030: **
1.5 ! misha 3031: ** The first argument, "db", is a [database connection] obtained from a
! 3032: ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
! 3033: ** [sqlite3_open16()]. The database connection must not have been closed.
! 3034: **
! 3035: ** The second argument, "zSql", is the statement to be compiled, encoded
1.2 misha 3036: ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
1.5 ! misha 3037: ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
! 3038: ** use UTF-16.
1.2 misha 3039: **
1.5 ! misha 3040: ** ^If the nByte argument is less than zero, then zSql is read up to the
! 3041: ** first zero terminator. ^If nByte is non-negative, then it is the maximum
! 3042: ** number of bytes read from zSql. ^When nByte is non-negative, the
! 3043: ** zSql string ends at either the first '\000' or '\u0000' character or
! 3044: ** the nByte-th byte, whichever comes first. If the caller knows
! 3045: ** that the supplied string is nul-terminated, then there is a small
! 3046: ** performance advantage to be gained by passing an nByte parameter that
! 3047: ** is equal to the number of bytes in the input string <i>including</i>
! 3048: ** the nul-terminator bytes as this saves SQLite from having to
! 3049: ** make a copy of the input string.
! 3050: **
! 3051: ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
! 3052: ** past the end of the first SQL statement in zSql. These routines only
! 3053: ** compile the first statement in zSql, so *pzTail is left pointing to
! 3054: ** what remains uncompiled.
! 3055: **
! 3056: ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
! 3057: ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
! 3058: ** to NULL. ^If the input text contains no SQL (if the input is an empty
! 3059: ** string or a comment) then *ppStmt is set to NULL.
! 3060: ** The calling procedure is responsible for deleting the compiled
! 3061: ** SQL statement using [sqlite3_finalize()] after it has finished with it.
! 3062: ** ppStmt may not be NULL.
1.2 misha 3063: **
1.5 ! misha 3064: ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
! 3065: ** otherwise an [error code] is returned.
1.2 misha 3066: **
3067: ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
3068: ** recommended for all new programs. The two older interfaces are retained
3069: ** for backwards compatibility, but their use is discouraged.
1.5 ! misha 3070: ** ^In the "v2" interfaces, the prepared statement
! 3071: ** that is returned (the [sqlite3_stmt] object) contains a copy of the
! 3072: ** original SQL text. This causes the [sqlite3_step()] interface to
! 3073: ** behave differently in three ways:
1.2 misha 3074: **
3075: ** <ol>
3076: ** <li>
1.5 ! misha 3077: ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
1.2 misha 3078: ** always used to do, [sqlite3_step()] will automatically recompile the SQL
1.5 ! misha 3079: ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
! 3080: ** retries will occur before sqlite3_step() gives up and returns an error.
! 3081: ** </li>
! 3082: **
! 3083: ** <li>
! 3084: ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
! 3085: ** [error codes] or [extended error codes]. ^The legacy behavior was that
! 3086: ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
! 3087: ** and the application would have to make a second call to [sqlite3_reset()]
! 3088: ** in order to find the underlying cause of the problem. With the "v2" prepare
! 3089: ** interfaces, the underlying reason for the error is returned immediately.
1.2 misha 3090: ** </li>
3091: **
3092: ** <li>
1.5 ! misha 3093: ** ^If the specific value bound to [parameter | host parameter] in the
! 3094: ** WHERE clause might influence the choice of query plan for a statement,
! 3095: ** then the statement will be automatically recompiled, as if there had been
! 3096: ** a schema change, on the first [sqlite3_step()] call following any change
! 3097: ** to the [sqlite3_bind_text | bindings] of that [parameter].
! 3098: ** ^The specific value of WHERE-clause [parameter] might influence the
! 3099: ** choice of query plan if the parameter is the left-hand side of a [LIKE]
! 3100: ** or [GLOB] operator or if the parameter is compared to an indexed column
! 3101: ** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
! 3102: ** the
1.2 misha 3103: ** </li>
3104: ** </ol>
1.1 misha 3105: */
1.5 ! misha 3106: SQLITE_API int sqlite3_prepare(
1.1 misha 3107: sqlite3 *db, /* Database handle */
3108: const char *zSql, /* SQL statement, UTF-8 encoded */
1.2 misha 3109: int nByte, /* Maximum length of zSql in bytes. */
3110: sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3111: const char **pzTail /* OUT: Pointer to unused portion of zSql */
3112: );
1.5 ! misha 3113: SQLITE_API int sqlite3_prepare_v2(
1.2 misha 3114: sqlite3 *db, /* Database handle */
3115: const char *zSql, /* SQL statement, UTF-8 encoded */
3116: int nByte, /* Maximum length of zSql in bytes. */
1.1 misha 3117: sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3118: const char **pzTail /* OUT: Pointer to unused portion of zSql */
3119: );
1.5 ! misha 3120: SQLITE_API int sqlite3_prepare16(
1.1 misha 3121: sqlite3 *db, /* Database handle */
3122: const void *zSql, /* SQL statement, UTF-16 encoded */
1.2 misha 3123: int nByte, /* Maximum length of zSql in bytes. */
3124: sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3125: const void **pzTail /* OUT: Pointer to unused portion of zSql */
3126: );
1.5 ! misha 3127: SQLITE_API int sqlite3_prepare16_v2(
1.2 misha 3128: sqlite3 *db, /* Database handle */
3129: const void *zSql, /* SQL statement, UTF-16 encoded */
3130: int nByte, /* Maximum length of zSql in bytes. */
1.1 misha 3131: sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3132: const void **pzTail /* OUT: Pointer to unused portion of zSql */
3133: );
3134:
3135: /*
1.5 ! misha 3136: ** CAPI3REF: Retrieving Statement SQL
! 3137: **
! 3138: ** ^This interface can be used to retrieve a saved copy of the original
! 3139: ** SQL text used to create a [prepared statement] if that statement was
! 3140: ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
! 3141: */
! 3142: SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
! 3143:
! 3144: /*
! 3145: ** CAPI3REF: Determine If An SQL Statement Writes The Database
1.4 misha 3146: **
1.5 ! misha 3147: ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
! 3148: ** and only if the [prepared statement] X makes no direct changes to
! 3149: ** the content of the database file.
1.4 misha 3150: **
1.5 ! misha 3151: ** Note that [application-defined SQL functions] or
! 3152: ** [virtual tables] might change the database indirectly as a side effect.
! 3153: ** ^(For example, if an application defines a function "eval()" that
! 3154: ** calls [sqlite3_exec()], then the following SQL statement would
! 3155: ** change the database file through side-effects:
1.4 misha 3156: **
1.5 ! misha 3157: ** <blockquote><pre>
! 3158: ** SELECT eval('DELETE FROM t1') FROM t2;
! 3159: ** </pre></blockquote>
1.4 misha 3160: **
1.5 ! misha 3161: ** But because the [SELECT] statement does not change the database file
! 3162: ** directly, sqlite3_stmt_readonly() would still return true.)^
1.4 misha 3163: **
1.5 ! misha 3164: ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
! 3165: ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
! 3166: ** since the statements themselves do not actually modify the database but
! 3167: ** rather they control the timing of when other statements modify the
! 3168: ** database. ^The [ATTACH] and [DETACH] statements also cause
! 3169: ** sqlite3_stmt_readonly() to return true since, while those statements
! 3170: ** change the configuration of a database connection, they do not make
! 3171: ** changes to the content of the database files on disk.
! 3172: */
! 3173: SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
! 3174:
! 3175: /*
! 3176: ** CAPI3REF: Determine If A Prepared Statement Has Been Reset
! 3177: **
! 3178: ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
! 3179: ** [prepared statement] S has been stepped at least once using
! 3180: ** [sqlite3_step(S)] but has not run to completion and/or has not
! 3181: ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
! 3182: ** interface returns false if S is a NULL pointer. If S is not a
! 3183: ** NULL pointer and is not a pointer to a valid [prepared statement]
! 3184: ** object, then the behavior is undefined and probably undesirable.
! 3185: **
! 3186: ** This interface can be used in combination [sqlite3_next_stmt()]
! 3187: ** to locate all prepared statements associated with a database
! 3188: ** connection that are in need of being reset. This can be used,
! 3189: ** for example, in diagnostic routines to search for prepared
! 3190: ** statements that are holding a transaction open.
1.4 misha 3191: */
1.5 ! misha 3192: SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
1.4 misha 3193:
3194: /*
1.5 ! misha 3195: ** CAPI3REF: Dynamically Typed Value Object
! 3196: ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
1.2 misha 3197: **
1.4 misha 3198: ** SQLite uses the sqlite3_value object to represent all values
1.5 ! misha 3199: ** that can be stored in a database table. SQLite uses dynamic typing
! 3200: ** for the values it stores. ^Values stored in sqlite3_value objects
! 3201: ** can be integers, floating point values, strings, BLOBs, or NULL.
! 3202: **
! 3203: ** An sqlite3_value object may be either "protected" or "unprotected".
! 3204: ** Some interfaces require a protected sqlite3_value. Other interfaces
! 3205: ** will accept either a protected or an unprotected sqlite3_value.
! 3206: ** Every interface that accepts sqlite3_value arguments specifies
! 3207: ** whether or not it requires a protected sqlite3_value.
! 3208: **
! 3209: ** The terms "protected" and "unprotected" refer to whether or not
! 3210: ** a mutex is held. An internal mutex is held for a protected
! 3211: ** sqlite3_value object but no mutex is held for an unprotected
! 3212: ** sqlite3_value object. If SQLite is compiled to be single-threaded
! 3213: ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
! 3214: ** or if SQLite is run in one of reduced mutex modes
! 3215: ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
! 3216: ** then there is no distinction between protected and unprotected
! 3217: ** sqlite3_value objects and they can be used interchangeably. However,
! 3218: ** for maximum code portability it is recommended that applications
! 3219: ** still make the distinction between protected and unprotected
! 3220: ** sqlite3_value objects even when not strictly required.
! 3221: **
! 3222: ** ^The sqlite3_value objects that are passed as parameters into the
! 3223: ** implementation of [application-defined SQL functions] are protected.
! 3224: ** ^The sqlite3_value object returned by
! 3225: ** [sqlite3_column_value()] is unprotected.
! 3226: ** Unprotected sqlite3_value objects may only be used with
! 3227: ** [sqlite3_result_value()] and [sqlite3_bind_value()].
! 3228: ** The [sqlite3_value_blob | sqlite3_value_type()] family of
! 3229: ** interfaces require protected sqlite3_value objects.
1.2 misha 3230: */
3231: typedef struct Mem sqlite3_value;
3232:
3233: /*
1.5 ! misha 3234: ** CAPI3REF: SQL Function Context Object
1.2 misha 3235: **
3236: ** The context in which an SQL function executes is stored in an
1.5 ! misha 3237: ** sqlite3_context object. ^A pointer to an sqlite3_context object
! 3238: ** is always first parameter to [application-defined SQL functions].
! 3239: ** The application-defined SQL function implementation will pass this
! 3240: ** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
! 3241: ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
! 3242: ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
! 3243: ** and/or [sqlite3_set_auxdata()].
1.1 misha 3244: */
3245: typedef struct sqlite3_context sqlite3_context;
3246:
3247: /*
1.5 ! misha 3248: ** CAPI3REF: Binding Values To Prepared Statements
! 3249: ** KEYWORDS: {host parameter} {host parameters} {host parameter name}
! 3250: ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
! 3251: **
! 3252: ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
! 3253: ** literals may be replaced by a [parameter] that matches one of following
! 3254: ** templates:
1.2 misha 3255: **
3256: ** <ul>
3257: ** <li> ?
3258: ** <li> ?NNN
1.4 misha 3259: ** <li> :VVV
3260: ** <li> @VVV
1.2 misha 3261: ** <li> $VVV
3262: ** </ul>
3263: **
1.5 ! misha 3264: ** In the templates above, NNN represents an integer literal,
! 3265: ** and VVV represents an alphanumeric identifier.)^ ^The values of these
! 3266: ** parameters (also called "host parameter names" or "SQL parameters")
1.2 misha 3267: ** can be set using the sqlite3_bind_*() routines defined here.
3268: **
1.5 ! misha 3269: ** ^The first argument to the sqlite3_bind_*() routines is always
! 3270: ** a pointer to the [sqlite3_stmt] object returned from
! 3271: ** [sqlite3_prepare_v2()] or its variants.
! 3272: **
! 3273: ** ^The second argument is the index of the SQL parameter to be set.
! 3274: ** ^The leftmost SQL parameter has an index of 1. ^When the same named
! 3275: ** SQL parameter is used more than once, second and subsequent
! 3276: ** occurrences have the same index as the first occurrence.
! 3277: ** ^The index for named parameters can be looked up using the
! 3278: ** [sqlite3_bind_parameter_index()] API if desired. ^The index
1.4 misha 3279: ** for "?NNN" parameters is the value of NNN.
1.5 ! misha 3280: ** ^The NNN value must be between 1 and the [sqlite3_limit()]
! 3281: ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
1.2 misha 3282: **
1.5 ! misha 3283: ** ^The third argument is the value to bind to the parameter.
! 3284: ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
! 3285: ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
! 3286: ** is ignored and the end result is the same as sqlite3_bind_null().
! 3287: **
! 3288: ** ^(In those routines that have a fourth argument, its value is the
! 3289: ** number of bytes in the parameter. To be clear: the value is the
! 3290: ** number of <u>bytes</u> in the value, not the number of characters.)^
! 3291: ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
! 3292: ** is negative, then the length of the string is
! 3293: ** the number of bytes up to the first zero terminator.
! 3294: ** If the fourth parameter to sqlite3_bind_blob() is negative, then
! 3295: ** the behavior is undefined.
! 3296: ** If a non-negative fourth parameter is provided to sqlite3_bind_text()
! 3297: ** or sqlite3_bind_text16() then that parameter must be the byte offset
! 3298: ** where the NUL terminator would occur assuming the string were NUL
! 3299: ** terminated. If any NUL characters occur at byte offsets less than
! 3300: ** the value of the fourth parameter then the resulting string value will
! 3301: ** contain embedded NULs. The result of expressions involving strings
! 3302: ** with embedded NULs is undefined.
1.1 misha 3303: **
1.5 ! misha 3304: ** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
1.1 misha 3305: ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
1.5 ! misha 3306: ** string after SQLite has finished with it. ^The destructor is called
! 3307: ** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(),
! 3308: ** sqlite3_bind_text(), or sqlite3_bind_text16() fails.
! 3309: ** ^If the fifth argument is
1.4 misha 3310: ** the special value [SQLITE_STATIC], then SQLite assumes that the
3311: ** information is in static, unmanaged space and does not need to be freed.
1.5 ! misha 3312: ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
1.4 misha 3313: ** SQLite makes its own private copy of the data immediately, before
3314: ** the sqlite3_bind_*() routine returns.
1.2 misha 3315: **
1.5 ! misha 3316: ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
! 3317: ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
! 3318: ** (just an integer to hold its size) while it is being processed.
! 3319: ** Zeroblobs are intended to serve as placeholders for BLOBs whose
! 3320: ** content is later written using
! 3321: ** [sqlite3_blob_open | incremental BLOB I/O] routines.
! 3322: ** ^A negative value for the zeroblob results in a zero-length BLOB.
! 3323: **
! 3324: ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
! 3325: ** for the [prepared statement] or with a prepared statement for which
! 3326: ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
! 3327: ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
! 3328: ** routine is passed a [prepared statement] that has been finalized, the
! 3329: ** result is undefined and probably harmful.
! 3330: **
! 3331: ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
! 3332: ** ^Unbound parameters are interpreted as NULL.
! 3333: **
! 3334: ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
! 3335: ** [error code] if anything goes wrong.
! 3336: ** ^[SQLITE_RANGE] is returned if the parameter
! 3337: ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
1.4 misha 3338: **
3339: ** See also: [sqlite3_bind_parameter_count()],
1.5 ! misha 3340: ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
! 3341: */
! 3342: SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
! 3343: SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
! 3344: SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
! 3345: SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
! 3346: SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
! 3347: SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
! 3348: SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
! 3349: SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
! 3350: SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
1.1 misha 3351:
3352: /*
1.5 ! misha 3353: ** CAPI3REF: Number Of SQL Parameters
1.2 misha 3354: **
1.5 ! misha 3355: ** ^This routine can be used to find the number of [SQL parameters]
! 3356: ** in a [prepared statement]. SQL parameters are tokens of the
1.4 misha 3357: ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
1.5 ! misha 3358: ** placeholders for values that are [sqlite3_bind_blob | bound]
1.4 misha 3359: ** to the parameters at a later time.
3360: **
1.5 ! misha 3361: ** ^(This routine actually returns the index of the largest (rightmost)
! 3362: ** parameter. For all forms except ?NNN, this will correspond to the
! 3363: ** number of unique parameters. If parameters of the ?NNN form are used,
! 3364: ** there may be gaps in the list.)^
1.4 misha 3365: **
3366: ** See also: [sqlite3_bind_blob|sqlite3_bind()],
3367: ** [sqlite3_bind_parameter_name()], and
3368: ** [sqlite3_bind_parameter_index()].
1.1 misha 3369: */
1.5 ! misha 3370: SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
1.1 misha 3371:
3372: /*
1.5 ! misha 3373: ** CAPI3REF: Name Of A Host Parameter
1.2 misha 3374: **
1.5 ! misha 3375: ** ^The sqlite3_bind_parameter_name(P,N) interface returns
! 3376: ** the name of the N-th [SQL parameter] in the [prepared statement] P.
! 3377: ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
! 3378: ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
! 3379: ** respectively.
! 3380: ** In other words, the initial ":" or "$" or "@" or "?"
! 3381: ** is included as part of the name.)^
! 3382: ** ^Parameters of the form "?" without a following integer have no name
! 3383: ** and are referred to as "nameless" or "anonymous parameters".
! 3384: **
! 3385: ** ^The first host parameter has an index of 1, not 0.
! 3386: **
! 3387: ** ^If the value N is out of range or if the N-th parameter is
! 3388: ** nameless, then NULL is returned. ^The returned string is
! 3389: ** always in UTF-8 encoding even if the named parameter was
1.4 misha 3390: ** originally specified as UTF-16 in [sqlite3_prepare16()] or
3391: ** [sqlite3_prepare16_v2()].
3392: **
3393: ** See also: [sqlite3_bind_blob|sqlite3_bind()],
3394: ** [sqlite3_bind_parameter_count()], and
3395: ** [sqlite3_bind_parameter_index()].
1.1 misha 3396: */
1.5 ! misha 3397: SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
1.1 misha 3398:
3399: /*
1.5 ! misha 3400: ** CAPI3REF: Index Of A Parameter With A Given Name
1.2 misha 3401: **
1.5 ! misha 3402: ** ^Return the index of an SQL parameter given its name. ^The
1.4 misha 3403: ** index value returned is suitable for use as the second
1.5 ! misha 3404: ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
! 3405: ** is returned if no matching parameter is found. ^The parameter
1.4 misha 3406: ** name must be given in UTF-8 even if the original statement
3407: ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
3408: **
3409: ** See also: [sqlite3_bind_blob|sqlite3_bind()],
3410: ** [sqlite3_bind_parameter_count()], and
3411: ** [sqlite3_bind_parameter_index()].
1.1 misha 3412: */
1.5 ! misha 3413: SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
1.1 misha 3414:
3415: /*
1.5 ! misha 3416: ** CAPI3REF: Reset All Bindings On A Prepared Statement
1.4 misha 3417: **
1.5 ! misha 3418: ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
! 3419: ** the [sqlite3_bind_blob | bindings] on a [prepared statement].
! 3420: ** ^Use this routine to reset all host parameters to NULL.
1.1 misha 3421: */
1.5 ! misha 3422: SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
1.1 misha 3423:
3424: /*
1.5 ! misha 3425: ** CAPI3REF: Number Of Columns In A Result Set
1.4 misha 3426: **
1.5 ! misha 3427: ** ^Return the number of columns in the result set returned by the
! 3428: ** [prepared statement]. ^This routine returns 0 if pStmt is an SQL
! 3429: ** statement that does not return data (for example an [UPDATE]).
1.4 misha 3430: **
1.5 ! misha 3431: ** See also: [sqlite3_data_count()]
1.2 misha 3432: */
1.5 ! misha 3433: SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
1.1 misha 3434:
3435: /*
1.5 ! misha 3436: ** CAPI3REF: Column Names In A Result Set
1.2 misha 3437: **
1.5 ! misha 3438: ** ^These routines return the name assigned to a particular column
! 3439: ** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
! 3440: ** interface returns a pointer to a zero-terminated UTF-8 string
1.4 misha 3441: ** and sqlite3_column_name16() returns a pointer to a zero-terminated
1.5 ! misha 3442: ** UTF-16 string. ^The first parameter is the [prepared statement]
! 3443: ** that implements the [SELECT] statement. ^The second parameter is the
! 3444: ** column number. ^The leftmost column is number 0.
! 3445: **
! 3446: ** ^The returned string pointer is valid until either the [prepared statement]
! 3447: ** is destroyed by [sqlite3_finalize()] or until the statement is automatically
! 3448: ** reprepared by the first call to [sqlite3_step()] for a particular run
! 3449: ** or until the next call to
! 3450: ** sqlite3_column_name() or sqlite3_column_name16() on the same column.
1.2 misha 3451: **
1.5 ! misha 3452: ** ^If sqlite3_malloc() fails during the processing of either routine
1.2 misha 3453: ** (for example during a conversion from UTF-8 to UTF-16) then a
3454: ** NULL pointer is returned.
1.4 misha 3455: **
1.5 ! misha 3456: ** ^The name of a result column is the value of the "AS" clause for
1.4 misha 3457: ** that column, if there is an AS clause. If there is no AS clause
3458: ** then the name of the column is unspecified and may change from
3459: ** one release of SQLite to the next.
1.2 misha 3460: */
1.5 ! misha 3461: SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
! 3462: SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
1.2 misha 3463:
3464: /*
1.5 ! misha 3465: ** CAPI3REF: Source Of Data In A Query Result
1.2 misha 3466: **
1.5 ! misha 3467: ** ^These routines provide a means to determine the database, table, and
! 3468: ** table column that is the origin of a particular result column in
! 3469: ** [SELECT] statement.
! 3470: ** ^The name of the database or table or column can be returned as
! 3471: ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
1.2 misha 3472: ** the database name, the _table_ routines return the table name, and
3473: ** the origin_ routines return the column name.
1.5 ! misha 3474: ** ^The returned string is valid until the [prepared statement] is destroyed
! 3475: ** using [sqlite3_finalize()] or until the statement is automatically
! 3476: ** reprepared by the first call to [sqlite3_step()] for a particular run
! 3477: ** or until the same information is requested
1.2 misha 3478: ** again in a different encoding.
3479: **
1.5 ! misha 3480: ** ^The names returned are the original un-aliased names of the
1.2 misha 3481: ** database, table, and column.
3482: **
1.5 ! misha 3483: ** ^The first argument to these interfaces is a [prepared statement].
! 3484: ** ^These functions return information about the Nth result column returned by
1.2 misha 3485: ** the statement, where N is the second function argument.
1.5 ! misha 3486: ** ^The left-most column is column 0 for these routines.
1.2 misha 3487: **
1.5 ! misha 3488: ** ^If the Nth column returned by the statement is an expression or
! 3489: ** subquery and is not a column value, then all of these functions return
! 3490: ** NULL. ^These routine might also return NULL if a memory allocation error
! 3491: ** occurs. ^Otherwise, they return the name of the attached database, table,
! 3492: ** or column that query result column was extracted from.
1.2 misha 3493: **
1.5 ! misha 3494: ** ^As with all other SQLite APIs, those whose names end with "16" return
! 3495: ** UTF-16 encoded strings and the other functions return UTF-8.
1.2 misha 3496: **
1.5 ! misha 3497: ** ^These APIs are only available if the library was compiled with the
! 3498: ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
1.2 misha 3499: **
3500: ** If two or more threads call one or more of these routines against the same
3501: ** prepared statement and column at the same time then the results are
3502: ** undefined.
1.4 misha 3503: **
1.5 ! misha 3504: ** If two or more threads call one or more
! 3505: ** [sqlite3_column_database_name | column metadata interfaces]
! 3506: ** for the same [prepared statement] and result column
! 3507: ** at the same time then the results are undefined.
! 3508: */
! 3509: SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
! 3510: SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
! 3511: SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
! 3512: SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
! 3513: SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
! 3514: SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
! 3515:
! 3516: /*
! 3517: ** CAPI3REF: Declared Datatype Of A Query Result
! 3518: **
! 3519: ** ^(The first parameter is a [prepared statement].
! 3520: ** If this statement is a [SELECT] statement and the Nth column of the
! 3521: ** returned result set of that [SELECT] is a table column (not an
1.2 misha 3522: ** expression or subquery) then the declared type of the table
1.5 ! misha 3523: ** column is returned.)^ ^If the Nth column of the result set is an
1.2 misha 3524: ** expression or subquery, then a NULL pointer is returned.
1.5 ! misha 3525: ** ^The returned string is always UTF-8 encoded.
! 3526: **
! 3527: ** ^(For example, given the database schema:
1.1 misha 3528: **
3529: ** CREATE TABLE t1(c1 VARIANT);
3530: **
1.5 ! misha 3531: ** and the following statement to be compiled:
1.1 misha 3532: **
1.2 misha 3533: ** SELECT c1 + 1, c1 FROM t1;
1.1 misha 3534: **
1.5 ! misha 3535: ** this routine would return the string "VARIANT" for the second result
! 3536: ** column (i==1), and a NULL pointer for the first result column (i==0).)^
1.2 misha 3537: **
1.5 ! misha 3538: ** ^SQLite uses dynamic run-time typing. ^So just because a column
1.2 misha 3539: ** is declared to contain a particular type does not mean that the
3540: ** data stored in that column is of the declared type. SQLite is
1.5 ! misha 3541: ** strongly typed, but the typing is dynamic not static. ^Type
1.2 misha 3542: ** is associated with individual values, not with the containers
3543: ** used to hold those values.
1.5 ! misha 3544: */
! 3545: SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
! 3546: SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
! 3547:
! 3548: /*
! 3549: ** CAPI3REF: Evaluate An SQL Statement
1.4 misha 3550: **
1.5 ! misha 3551: ** After a [prepared statement] has been prepared using either
! 3552: ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
! 3553: ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
! 3554: ** must be called one or more times to evaluate the statement.
1.2 misha 3555: **
1.5 ! misha 3556: ** The details of the behavior of the sqlite3_step() interface depend
1.2 misha 3557: ** on whether the statement was prepared using the newer "v2" interface
3558: ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
3559: ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
3560: ** new "v2" interface is recommended for new applications but the legacy
3561: ** interface will continue to be supported.
3562: **
1.5 ! misha 3563: ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
1.2 misha 3564: ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
1.5 ! misha 3565: ** ^With the "v2" interface, any of the other [result codes] or
! 3566: ** [extended result codes] might be returned as well.
1.2 misha 3567: **
1.5 ! misha 3568: ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
! 3569: ** database locks it needs to do its job. ^If the statement is a [COMMIT]
1.2 misha 3570: ** or occurs outside of an explicit transaction, then you can retry the
1.5 ! misha 3571: ** statement. If the statement is not a [COMMIT] and occurs within an
1.2 misha 3572: ** explicit transaction then you should rollback the transaction before
3573: ** continuing.
1.1 misha 3574: **
1.5 ! misha 3575: ** ^[SQLITE_DONE] means that the statement has finished executing
1.1 misha 3576: ** successfully. sqlite3_step() should not be called again on this virtual
1.2 misha 3577: ** machine without first calling [sqlite3_reset()] to reset the virtual
3578: ** machine back to its initial state.
1.1 misha 3579: **
1.5 ! misha 3580: ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
! 3581: ** is returned each time a new row of data is ready for processing by the
! 3582: ** caller. The values may be accessed using the [column access functions].
1.2 misha 3583: ** sqlite3_step() is called again to retrieve the next row of data.
1.5 ! misha 3584: **
! 3585: ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
1.1 misha 3586: ** violation) has occurred. sqlite3_step() should not be called again on
1.2 misha 3587: ** the VM. More information may be found by calling [sqlite3_errmsg()].
1.5 ! misha 3588: ** ^With the legacy interface, a more specific error code (for example,
1.2 misha 3589: ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
3590: ** can be obtained by calling [sqlite3_reset()] on the
1.5 ! misha 3591: ** [prepared statement]. ^In the "v2" interface,
1.2 misha 3592: ** the more specific error code is returned directly by sqlite3_step().
3593: **
3594: ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
1.4 misha 3595: ** Perhaps it was called on a [prepared statement] that has
1.5 ! misha 3596: ** already been [sqlite3_finalize | finalized] or on one that had
1.2 misha 3597: ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
3598: ** be the case that the same database connection is being used by two or
3599: ** more threads at the same moment in time.
3600: **
1.5 ! misha 3601: ** For all versions of SQLite up to and including 3.6.23.1, a call to
! 3602: ** [sqlite3_reset()] was required after sqlite3_step() returned anything
! 3603: ** other than [SQLITE_ROW] before any subsequent invocation of
! 3604: ** sqlite3_step(). Failure to reset the prepared statement using
! 3605: ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
! 3606: ** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began
! 3607: ** calling [sqlite3_reset()] automatically in this circumstance rather
! 3608: ** than returning [SQLITE_MISUSE]. This is not considered a compatibility
! 3609: ** break because any application that ever receives an SQLITE_MISUSE error
! 3610: ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
! 3611: ** can be used to restore the legacy behavior.
! 3612: **
! 3613: ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
! 3614: ** API always returns a generic error code, [SQLITE_ERROR], following any
! 3615: ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
! 3616: ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
! 3617: ** specific [error codes] that better describes the error.
1.2 misha 3618: ** We admit that this is a goofy design. The problem has been fixed
3619: ** with the "v2" interface. If you prepare all of your SQL statements
3620: ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
1.5 ! misha 3621: ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
! 3622: ** then the more specific [error codes] are returned directly
1.2 misha 3623: ** by sqlite3_step(). The use of the "v2" interface is recommended.
1.1 misha 3624: */
1.5 ! misha 3625: SQLITE_API int sqlite3_step(sqlite3_stmt*);
1.1 misha 3626:
3627: /*
1.5 ! misha 3628: ** CAPI3REF: Number of columns in a result set
1.4 misha 3629: **
1.5 ! misha 3630: ** ^The sqlite3_data_count(P) interface returns the number of columns in the
! 3631: ** current row of the result set of [prepared statement] P.
! 3632: ** ^If prepared statement P does not have results ready to return
! 3633: ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
! 3634: ** interfaces) then sqlite3_data_count(P) returns 0.
! 3635: ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
! 3636: ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
! 3637: ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
! 3638: ** will return non-zero if previous call to [sqlite3_step](P) returned
! 3639: ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
! 3640: ** where it always returns zero since each step of that multi-step
! 3641: ** pragma returns 0 columns of data.
1.4 misha 3642: **
1.5 ! misha 3643: ** See also: [sqlite3_column_count()]
1.1 misha 3644: */
1.5 ! misha 3645: SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
1.1 misha 3646:
3647: /*
1.5 ! misha 3648: ** CAPI3REF: Fundamental Datatypes
1.4 misha 3649: ** KEYWORDS: SQLITE_TEXT
1.2 misha 3650: **
1.5 ! misha 3651: ** ^(Every value in SQLite has one of five fundamental datatypes:
1.2 misha 3652: **
3653: ** <ul>
3654: ** <li> 64-bit signed integer
3655: ** <li> 64-bit IEEE floating point number
3656: ** <li> string
3657: ** <li> BLOB
3658: ** <li> NULL
1.5 ! misha 3659: ** </ul>)^
1.2 misha 3660: **
3661: ** These constants are codes for each of those types.
3662: **
3663: ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
3664: ** for a completely different meaning. Software that links against both
1.5 ! misha 3665: ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
1.2 misha 3666: ** SQLITE_TEXT.
1.1 misha 3667: */
3668: #define SQLITE_INTEGER 1
3669: #define SQLITE_FLOAT 2
3670: #define SQLITE_BLOB 4
3671: #define SQLITE_NULL 5
3672: #ifdef SQLITE_TEXT
3673: # undef SQLITE_TEXT
3674: #else
3675: # define SQLITE_TEXT 3
3676: #endif
3677: #define SQLITE3_TEXT 3
3678:
3679: /*
1.5 ! misha 3680: ** CAPI3REF: Result Values From A Query
! 3681: ** KEYWORDS: {column access functions}
1.4 misha 3682: **
1.5 ! misha 3683: ** These routines form the "result set" interface.
1.2 misha 3684: **
1.5 ! misha 3685: ** ^These routines return information about a single column of the current
! 3686: ** result row of a query. ^In every case the first argument is a pointer
! 3687: ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
! 3688: ** that was returned from [sqlite3_prepare_v2()] or one of its variants)
! 3689: ** and the second argument is the index of the column for which information
! 3690: ** should be returned. ^The leftmost column of the result set has the index 0.
! 3691: ** ^The number of columns in the result can be determined using
! 3692: ** [sqlite3_column_count()].
1.1 misha 3693: **
1.5 ! misha 3694: ** If the SQL statement does not currently point to a valid row, or if the
! 3695: ** column index is out of range, the result is undefined.
1.2 misha 3696: ** These routines may only be called when the most recent call to
3697: ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
1.5 ! misha 3698: ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
1.2 misha 3699: ** If any of these routines are called after [sqlite3_reset()] or
3700: ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
3701: ** something other than [SQLITE_ROW], the results are undefined.
3702: ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
3703: ** are called from a different thread while any of these routines
1.5 ! misha 3704: ** are pending, then the results are undefined.
1.2 misha 3705: **
1.5 ! misha 3706: ** ^The sqlite3_column_type() routine returns the
1.2 misha 3707: ** [SQLITE_INTEGER | datatype code] for the initial data type
1.5 ! misha 3708: ** of the result column. ^The returned value is one of [SQLITE_INTEGER],
1.2 misha 3709: ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
3710: ** returned by sqlite3_column_type() is only meaningful if no type
3711: ** conversions have occurred as described below. After a type conversion,
3712: ** the value returned by sqlite3_column_type() is undefined. Future
3713: ** versions of SQLite may change the behavior of sqlite3_column_type()
3714: ** following a type conversion.
3715: **
1.5 ! misha 3716: ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
1.2 misha 3717: ** routine returns the number of bytes in that BLOB or string.
1.5 ! misha 3718: ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
1.2 misha 3719: ** the string to UTF-8 and then returns the number of bytes.
1.5 ! misha 3720: ** ^If the result is a numeric value then sqlite3_column_bytes() uses
1.2 misha 3721: ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
3722: ** the number of bytes in that string.
1.5 ! misha 3723: ** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
! 3724: **
! 3725: ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
! 3726: ** routine returns the number of bytes in that BLOB or string.
! 3727: ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
! 3728: ** the string to UTF-16 and then returns the number of bytes.
! 3729: ** ^If the result is a numeric value then sqlite3_column_bytes16() uses
! 3730: ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
! 3731: ** the number of bytes in that string.
! 3732: ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
! 3733: **
! 3734: ** ^The values returned by [sqlite3_column_bytes()] and
! 3735: ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
! 3736: ** of the string. ^For clarity: the values returned by
! 3737: ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
1.2 misha 3738: ** bytes in the string, not the number of characters.
3739: **
1.5 ! misha 3740: ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
! 3741: ** even empty strings, are always zero-terminated. ^The return
! 3742: ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
! 3743: **
! 3744: ** ^The object returned by [sqlite3_column_value()] is an
! 3745: ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
! 3746: ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
! 3747: ** If the [unprotected sqlite3_value] object returned by
! 3748: ** [sqlite3_column_value()] is used in any other way, including calls
! 3749: ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
! 3750: ** or [sqlite3_value_bytes()], then the behavior is undefined.
1.1 misha 3751: **
1.5 ! misha 3752: ** These routines attempt to convert the value where appropriate. ^For
1.1 misha 3753: ** example, if the internal representation is FLOAT and a text result
1.5 ! misha 3754: ** is requested, [sqlite3_snprintf()] is used internally to perform the
! 3755: ** conversion automatically. ^(The following table details the conversions
! 3756: ** that are applied:
1.1 misha 3757: **
1.2 misha 3758: ** <blockquote>
3759: ** <table border="1">
3760: ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
3761: **
3762: ** <tr><td> NULL <td> INTEGER <td> Result is 0
3763: ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
3764: ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer
3765: ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
3766: ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
3767: ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
1.5 ! misha 3768: ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
1.2 misha 3769: ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
3770: ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
3771: ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
3772: ** <tr><td> TEXT <td> INTEGER <td> Use atoi()
3773: ** <tr><td> TEXT <td> FLOAT <td> Use atof()
3774: ** <tr><td> TEXT <td> BLOB <td> No change
3775: ** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi()
3776: ** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
3777: ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
3778: ** </table>
1.5 ! misha 3779: ** </blockquote>)^
1.2 misha 3780: **
3781: ** The table above makes reference to standard C library functions atoi()
3782: ** and atof(). SQLite does not really use these functions. It has its
1.5 ! misha 3783: ** own equivalent internal routines. The atoi() and atof() names are
1.2 misha 3784: ** used in the table for brevity and because they are familiar to most
3785: ** C programmers.
3786: **
3787: ** Note that when type conversions occur, pointers returned by prior
3788: ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
1.5 ! misha 3789: ** sqlite3_column_text16() may be invalidated.
1.2 misha 3790: ** Type conversions and pointer invalidations might occur
3791: ** in the following cases:
3792: **
3793: ** <ul>
1.5 ! misha 3794: ** <li> The initial content is a BLOB and sqlite3_column_text() or
! 3795: ** sqlite3_column_text16() is called. A zero-terminator might
! 3796: ** need to be added to the string.</li>
! 3797: ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
! 3798: ** sqlite3_column_text16() is called. The content must be converted
! 3799: ** to UTF-16.</li>
! 3800: ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
! 3801: ** sqlite3_column_text() is called. The content must be converted
! 3802: ** to UTF-8.</li>
1.2 misha 3803: ** </ul>
3804: **
1.5 ! misha 3805: ** ^Conversions between UTF-16be and UTF-16le are always done in place and do
1.2 misha 3806: ** not invalidate a prior pointer, though of course the content of the buffer
1.5 ! misha 3807: ** that the prior pointer references will have been modified. Other kinds
! 3808: ** of conversion are done in place when it is possible, but sometimes they
! 3809: ** are not possible and in those cases prior pointers are invalidated.
1.2 misha 3810: **
3811: ** The safest and easiest to remember policy is to invoke these routines
3812: ** in one of the following ways:
3813: **
1.5 ! misha 3814: ** <ul>
1.2 misha 3815: ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
3816: ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
3817: ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
1.5 ! misha 3818: ** </ul>
1.2 misha 3819: **
1.5 ! misha 3820: ** In other words, you should call sqlite3_column_text(),
! 3821: ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
! 3822: ** into the desired format, then invoke sqlite3_column_bytes() or
! 3823: ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
! 3824: ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
! 3825: ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
! 3826: ** with calls to sqlite3_column_bytes().
1.2 misha 3827: **
1.5 ! misha 3828: ** ^The pointers returned are valid until a type conversion occurs as
1.2 misha 3829: ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
1.5 ! misha 3830: ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
! 3831: ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
! 3832: ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
1.2 misha 3833: ** [sqlite3_free()].
3834: **
1.5 ! misha 3835: ** ^(If a memory allocation error occurs during the evaluation of any
1.2 misha 3836: ** of these routines, a default value is returned. The default value
3837: ** is either the integer 0, the floating point number 0.0, or a NULL
3838: ** pointer. Subsequent calls to [sqlite3_errcode()] will return
1.5 ! misha 3839: ** [SQLITE_NOMEM].)^
! 3840: */
! 3841: SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
! 3842: SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
! 3843: SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
! 3844: SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
! 3845: SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
! 3846: SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
! 3847: SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
! 3848: SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
! 3849: SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
! 3850: SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
! 3851:
! 3852: /*
! 3853: ** CAPI3REF: Destroy A Prepared Statement Object
! 3854: **
! 3855: ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
! 3856: ** ^If the most recent evaluation of the statement encountered no errors
! 3857: ** or if the statement is never been evaluated, then sqlite3_finalize() returns
! 3858: ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
! 3859: ** sqlite3_finalize(S) returns the appropriate [error code] or
! 3860: ** [extended error code].
! 3861: **
! 3862: ** ^The sqlite3_finalize(S) routine can be called at any point during
! 3863: ** the life cycle of [prepared statement] S:
! 3864: ** before statement S is ever evaluated, after
! 3865: ** one or more calls to [sqlite3_reset()], or after any call
! 3866: ** to [sqlite3_step()] regardless of whether or not the statement has
! 3867: ** completed execution.
! 3868: **
! 3869: ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
! 3870: **
! 3871: ** The application must finalize every [prepared statement] in order to avoid
! 3872: ** resource leaks. It is a grievous error for the application to try to use
! 3873: ** a prepared statement after it has been finalized. Any use of a prepared
! 3874: ** statement after it has been finalized can result in undefined and
! 3875: ** undesirable behavior such as segfaults and heap corruption.
! 3876: */
! 3877: SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
! 3878:
! 3879: /*
! 3880: ** CAPI3REF: Reset A Prepared Statement Object
! 3881: **
! 3882: ** The sqlite3_reset() function is called to reset a [prepared statement]
! 3883: ** object back to its initial state, ready to be re-executed.
! 3884: ** ^Any SQL statement variables that had values bound to them using
1.2 misha 3885: ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3886: ** Use [sqlite3_clear_bindings()] to reset the bindings.
1.4 misha 3887: **
1.5 ! misha 3888: ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
! 3889: ** back to the beginning of its program.
1.4 misha 3890: **
1.5 ! misha 3891: ** ^If the most recent call to [sqlite3_step(S)] for the
! 3892: ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
! 3893: ** or if [sqlite3_step(S)] has never before been called on S,
! 3894: ** then [sqlite3_reset(S)] returns [SQLITE_OK].
! 3895: **
! 3896: ** ^If the most recent call to [sqlite3_step(S)] for the
! 3897: ** [prepared statement] S indicated an error, then
! 3898: ** [sqlite3_reset(S)] returns an appropriate [error code].
! 3899: **
! 3900: ** ^The [sqlite3_reset(S)] interface does not change the values
! 3901: ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
! 3902: */
! 3903: SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
! 3904:
! 3905: /*
! 3906: ** CAPI3REF: Create Or Redefine SQL Functions
! 3907: ** KEYWORDS: {function creation routines}
! 3908: ** KEYWORDS: {application-defined SQL function}
! 3909: ** KEYWORDS: {application-defined SQL functions}
! 3910: **
! 3911: ** ^These functions (collectively known as "function creation routines")
! 3912: ** are used to add SQL functions or aggregates or to redefine the behavior
! 3913: ** of existing SQL functions or aggregates. The only differences between
! 3914: ** these routines are the text encoding expected for
! 3915: ** the second parameter (the name of the function being created)
! 3916: ** and the presence or absence of a destructor callback for
! 3917: ** the application data pointer.
! 3918: **
! 3919: ** ^The first parameter is the [database connection] to which the SQL
! 3920: ** function is to be added. ^If an application uses more than one database
! 3921: ** connection then application-defined SQL functions must be added
! 3922: ** to each database connection separately.
! 3923: **
! 3924: ** ^The second parameter is the name of the SQL function to be created or
! 3925: ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
! 3926: ** representation, exclusive of the zero-terminator. ^Note that the name
! 3927: ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
! 3928: ** ^Any attempt to create a function with a longer name
! 3929: ** will result in [SQLITE_MISUSE] being returned.
! 3930: **
! 3931: ** ^The third parameter (nArg)
! 3932: ** is the number of arguments that the SQL function or
! 3933: ** aggregate takes. ^If this parameter is -1, then the SQL function or
! 3934: ** aggregate may take any number of arguments between 0 and the limit
! 3935: ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
! 3936: ** parameter is less than -1 or greater than 127 then the behavior is
! 3937: ** undefined.
1.1 misha 3938: **
1.5 ! misha 3939: ** ^The fourth parameter, eTextRep, specifies what
1.2 misha 3940: ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
1.5 ! misha 3941: ** its parameters. Every SQL function implementation must be able to work
! 3942: ** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
! 3943: ** more efficient with one encoding than another. ^An application may
1.2 misha 3944: ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
3945: ** times with the same function but with different values of eTextRep.
1.5 ! misha 3946: ** ^When multiple implementations of the same function are available, SQLite
1.2 misha 3947: ** will pick the one that involves the least amount of data conversion.
1.5 ! misha 3948: ** If there is only a single implementation which does not care what text
! 3949: ** encoding is used, then the fourth argument should be [SQLITE_ANY].
! 3950: **
! 3951: ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
! 3952: ** function can gain access to this pointer using [sqlite3_user_data()].)^
! 3953: **
! 3954: ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
! 3955: ** pointers to C-language functions that implement the SQL function or
! 3956: ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
! 3957: ** callback only; NULL pointers must be passed as the xStep and xFinal
! 3958: ** parameters. ^An aggregate SQL function requires an implementation of xStep
! 3959: ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
! 3960: ** SQL function or aggregate, pass NULL pointers for all three function
! 3961: ** callbacks.
! 3962: **
! 3963: ** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL,
! 3964: ** then it is destructor for the application data pointer.
! 3965: ** The destructor is invoked when the function is deleted, either by being
! 3966: ** overloaded or when the database connection closes.)^
! 3967: ** ^The destructor is also invoked if the call to
! 3968: ** sqlite3_create_function_v2() fails.
! 3969: ** ^When the destructor callback of the tenth parameter is invoked, it
! 3970: ** is passed a single argument which is a copy of the application data
! 3971: ** pointer which was the fifth parameter to sqlite3_create_function_v2().
1.2 misha 3972: **
1.5 ! misha 3973: ** ^It is permitted to register multiple implementations of the same
1.2 misha 3974: ** functions with the same name but with either differing numbers of
1.5 ! misha 3975: ** arguments or differing preferred text encodings. ^SQLite will use
! 3976: ** the implementation that most closely matches the way in which the
! 3977: ** SQL function is used. ^A function implementation with a non-negative
! 3978: ** nArg parameter is a better match than a function implementation with
! 3979: ** a negative nArg. ^A function where the preferred text encoding
! 3980: ** matches the database encoding is a better
! 3981: ** match than a function where the encoding is different.
! 3982: ** ^A function where the encoding difference is between UTF16le and UTF16be
! 3983: ** is a closer match than a function where the encoding difference is
! 3984: ** between UTF8 and UTF16.
! 3985: **
! 3986: ** ^Built-in functions may be overloaded by new application-defined functions.
! 3987: **
! 3988: ** ^An application-defined function is permitted to call other
! 3989: ** SQLite interfaces. However, such calls must not
! 3990: ** close the database connection nor finalize or reset the prepared
! 3991: ** statement in which the function is running.
1.1 misha 3992: */
1.5 ! misha 3993: SQLITE_API int sqlite3_create_function(
1.4 misha 3994: sqlite3 *db,
1.1 misha 3995: const char *zFunctionName,
3996: int nArg,
3997: int eTextRep,
1.4 misha 3998: void *pApp,
1.1 misha 3999: void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
4000: void (*xStep)(sqlite3_context*,int,sqlite3_value**),
4001: void (*xFinal)(sqlite3_context*)
4002: );
1.5 ! misha 4003: SQLITE_API int sqlite3_create_function16(
1.4 misha 4004: sqlite3 *db,
1.1 misha 4005: const void *zFunctionName,
4006: int nArg,
4007: int eTextRep,
1.4 misha 4008: void *pApp,
1.1 misha 4009: void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
4010: void (*xStep)(sqlite3_context*,int,sqlite3_value**),
4011: void (*xFinal)(sqlite3_context*)
4012: );
1.5 ! misha 4013: SQLITE_API int sqlite3_create_function_v2(
! 4014: sqlite3 *db,
! 4015: const char *zFunctionName,
! 4016: int nArg,
! 4017: int eTextRep,
! 4018: void *pApp,
! 4019: void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
! 4020: void (*xStep)(sqlite3_context*,int,sqlite3_value**),
! 4021: void (*xFinal)(sqlite3_context*),
! 4022: void(*xDestroy)(void*)
! 4023: );
1.1 misha 4024:
4025: /*
1.5 ! misha 4026: ** CAPI3REF: Text Encodings
1.2 misha 4027: **
4028: ** These constant define integer codes that represent the various
4029: ** text encodings supported by SQLite.
4030: */
4031: #define SQLITE_UTF8 1
4032: #define SQLITE_UTF16LE 2
4033: #define SQLITE_UTF16BE 3
4034: #define SQLITE_UTF16 4 /* Use native byte order */
4035: #define SQLITE_ANY 5 /* sqlite3_create_function only */
4036: #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
4037:
4038: /*
1.5 ! misha 4039: ** CAPI3REF: Deprecated Functions
! 4040: ** DEPRECATED
1.2 misha 4041: **
1.5 ! misha 4042: ** These functions are [deprecated]. In order to maintain
! 4043: ** backwards compatibility with older code, these functions continue
! 4044: ** to be supported. However, new applications should avoid
1.2 misha 4045: ** the use of these functions. To help encourage people to avoid
1.5 ! misha 4046: ** using these functions, we are not going to tell you what they do.
1.1 misha 4047: */
1.5 ! misha 4048: #ifndef SQLITE_OMIT_DEPRECATED
! 4049: SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
! 4050: SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
! 4051: SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
! 4052: SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
! 4053: SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
! 4054: SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
! 4055: void*,sqlite3_int64);
! 4056: #endif
1.2 misha 4057:
4058: /*
1.5 ! misha 4059: ** CAPI3REF: Obtaining SQL Function Parameter Values
1.2 misha 4060: **
4061: ** The C-language implementation of SQL functions and aggregates uses
4062: ** this set of interface routines to access the parameter values on
4063: ** the function or aggregate.
4064: **
4065: ** The xFunc (for scalar functions) or xStep (for aggregates) parameters
4066: ** to [sqlite3_create_function()] and [sqlite3_create_function16()]
4067: ** define callbacks that implement the SQL functions and aggregates.
1.5 ! misha 4068: ** The 3rd parameter to these callbacks is an array of pointers to
! 4069: ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
1.2 misha 4070: ** each parameter to the SQL function. These routines are used to
4071: ** extract values from the [sqlite3_value] objects.
4072: **
1.5 ! misha 4073: ** These routines work only with [protected sqlite3_value] objects.
! 4074: ** Any attempt to use these routines on an [unprotected sqlite3_value]
! 4075: ** object results in undefined behavior.
! 4076: **
! 4077: ** ^These routines work just like the corresponding [column access functions]
! 4078: ** except that these routines take a single [protected sqlite3_value] object
! 4079: ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
1.2 misha 4080: **
1.5 ! misha 4081: ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
! 4082: ** in the native byte-order of the host machine. ^The
1.2 misha 4083: ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
1.5 ! misha 4084: ** extract UTF-16 strings as big-endian and little-endian respectively.
1.2 misha 4085: **
1.5 ! misha 4086: ** ^(The sqlite3_value_numeric_type() interface attempts to apply
1.2 misha 4087: ** numeric affinity to the value. This means that an attempt is
4088: ** made to convert the value to an integer or floating point. If
1.4 misha 4089: ** such a conversion is possible without loss of information (in other
1.5 ! misha 4090: ** words, if the value is a string that looks like a number)
! 4091: ** then the conversion is performed. Otherwise no conversion occurs.
! 4092: ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
1.2 misha 4093: **
1.5 ! misha 4094: ** Please pay particular attention to the fact that the pointer returned
! 4095: ** from [sqlite3_value_blob()], [sqlite3_value_text()], or
1.2 misha 4096: ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
4097: ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
1.5 ! misha 4098: ** or [sqlite3_value_text16()].
1.2 misha 4099: **
4100: ** These routines must be called from the same thread as
1.5 ! misha 4101: ** the SQL function that supplied the [sqlite3_value*] parameters.
! 4102: */
! 4103: SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
! 4104: SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
! 4105: SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
! 4106: SQLITE_API double sqlite3_value_double(sqlite3_value*);
! 4107: SQLITE_API int sqlite3_value_int(sqlite3_value*);
! 4108: SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
! 4109: SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
! 4110: SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
! 4111: SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
! 4112: SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
! 4113: SQLITE_API int sqlite3_value_type(sqlite3_value*);
! 4114: SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
! 4115:
! 4116: /*
! 4117: ** CAPI3REF: Obtain Aggregate Function Context
! 4118: **
! 4119: ** Implementations of aggregate SQL functions use this
! 4120: ** routine to allocate memory for storing their state.
! 4121: **
! 4122: ** ^The first time the sqlite3_aggregate_context(C,N) routine is called
! 4123: ** for a particular aggregate function, SQLite
! 4124: ** allocates N of memory, zeroes out that memory, and returns a pointer
! 4125: ** to the new memory. ^On second and subsequent calls to
! 4126: ** sqlite3_aggregate_context() for the same aggregate function instance,
! 4127: ** the same buffer is returned. Sqlite3_aggregate_context() is normally
! 4128: ** called once for each invocation of the xStep callback and then one
! 4129: ** last time when the xFinal callback is invoked. ^(When no rows match
! 4130: ** an aggregate query, the xStep() callback of the aggregate function
! 4131: ** implementation is never called and xFinal() is called exactly once.
! 4132: ** In those cases, sqlite3_aggregate_context() might be called for the
! 4133: ** first time from within xFinal().)^
! 4134: **
! 4135: ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
! 4136: ** when first called if N is less than or equal to zero or if a memory
! 4137: ** allocate error occurs.
! 4138: **
! 4139: ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
! 4140: ** determined by the N parameter on first successful call. Changing the
! 4141: ** value of N in subsequent call to sqlite3_aggregate_context() within
! 4142: ** the same aggregate function instance will not resize the memory
! 4143: ** allocation.)^ Within the xFinal callback, it is customary to set
! 4144: ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
! 4145: ** pointless memory allocations occur.
! 4146: **
! 4147: ** ^SQLite automatically frees the memory allocated by
! 4148: ** sqlite3_aggregate_context() when the aggregate query concludes.
! 4149: **
! 4150: ** The first parameter must be a copy of the
! 4151: ** [sqlite3_context | SQL function context] that is the first parameter
! 4152: ** to the xStep or xFinal callback routine that implements the aggregate
1.2 misha 4153: ** function.
4154: **
4155: ** This routine must be called from the same thread in which
4156: ** the aggregate SQL function is running.
1.1 misha 4157: */
1.5 ! misha 4158: SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
1.1 misha 4159:
4160: /*
1.5 ! misha 4161: ** CAPI3REF: User Data For Functions
1.2 misha 4162: **
1.5 ! misha 4163: ** ^The sqlite3_user_data() interface returns a copy of
1.4 misha 4164: ** the pointer that was the pUserData parameter (the 5th parameter)
1.5 ! misha 4165: ** of the [sqlite3_create_function()]
1.4 misha 4166: ** and [sqlite3_create_function16()] routines that originally
1.5 ! misha 4167: ** registered the application defined function.
1.2 misha 4168: **
4169: ** This routine must be called from the same thread in which
1.4 misha 4170: ** the application-defined function is running.
1.5 ! misha 4171: */
! 4172: SQLITE_API void *sqlite3_user_data(sqlite3_context*);
! 4173:
! 4174: /*
! 4175: ** CAPI3REF: Database Connection For Functions
1.4 misha 4176: **
1.5 ! misha 4177: ** ^The sqlite3_context_db_handle() interface returns a copy of
! 4178: ** the pointer to the [database connection] (the 1st parameter)
! 4179: ** of the [sqlite3_create_function()]
! 4180: ** and [sqlite3_create_function16()] routines that originally
! 4181: ** registered the application defined function.
1.1 misha 4182: */
1.5 ! misha 4183: SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
1.1 misha 4184:
4185: /*
1.5 ! misha 4186: ** CAPI3REF: Function Auxiliary Data
1.2 misha 4187: **
1.5 ! misha 4188: ** These functions may be used by (non-aggregate) SQL functions to
! 4189: ** associate metadata with argument values. If the same value is passed to
1.2 misha 4190: ** multiple invocations of the same SQL function during query execution, under
1.5 ! misha 4191: ** some circumstances the associated metadata may be preserved. An example
! 4192: ** of where this might be useful is in a regular-expression matching
! 4193: ** function. The compiled version of the regular expression can be stored as
! 4194: ** metadata associated with the pattern string.
! 4195: ** Then as long as the pattern string remains the same,
! 4196: ** the compiled regular expression can be reused on multiple
! 4197: ** invocations of the same function.
1.1 misha 4198: **
1.5 ! misha 4199: ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
1.4 misha 4200: ** associated by the sqlite3_set_auxdata() function with the Nth argument
1.5 ! misha 4201: ** value to the application-defined function. ^If there is no metadata
! 4202: ** associated with the function argument, this sqlite3_get_auxdata() interface
1.4 misha 4203: ** returns a NULL pointer.
4204: **
1.5 ! misha 4205: ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
! 4206: ** argument of the application-defined function. ^Subsequent
! 4207: ** calls to sqlite3_get_auxdata(C,N) return P from the most recent
! 4208: ** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
! 4209: ** NULL if the metadata has been discarded.
! 4210: ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
! 4211: ** SQLite will invoke the destructor function X with parameter P exactly
! 4212: ** once, when the metadata is discarded.
! 4213: ** SQLite is free to discard the metadata at any time, including: <ul>
! 4214: ** <li> when the corresponding function parameter changes, or
! 4215: ** <li> when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
! 4216: ** SQL statement, or
! 4217: ** <li> when sqlite3_set_auxdata() is invoked again on the same parameter, or
! 4218: ** <li> during the original sqlite3_set_auxdata() call when a memory
! 4219: ** allocation error occurs. </ul>)^
! 4220: **
! 4221: ** Note the last bullet in particular. The destructor X in
! 4222: ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
! 4223: ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
! 4224: ** should be called near the end of the function implementation and the
! 4225: ** function implementation should not make any use of P after
! 4226: ** sqlite3_set_auxdata() has been called.
! 4227: **
! 4228: ** ^(In practice, metadata is preserved between function calls for
! 4229: ** function parameters that are compile-time constants, including literal
! 4230: ** values and [parameters] and expressions composed from the same.)^
1.2 misha 4231: **
4232: ** These routines must be called from the same thread in which
4233: ** the SQL function is running.
1.1 misha 4234: */
1.5 ! misha 4235: SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
! 4236: SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
1.1 misha 4237:
4238:
4239: /*
1.5 ! misha 4240: ** CAPI3REF: Constants Defining Special Destructor Behavior
1.2 misha 4241: **
1.5 ! misha 4242: ** These are special values for the destructor that is passed in as the
! 4243: ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
1.1 misha 4244: ** argument is SQLITE_STATIC, it means that the content pointer is constant
1.5 ! misha 4245: ** and will never change. It does not need to be destroyed. ^The
1.1 misha 4246: ** SQLITE_TRANSIENT value means that the content will likely change in
4247: ** the near future and that SQLite should make its own private copy of
4248: ** the content before returning.
1.2 misha 4249: **
4250: ** The typedef is necessary to work around problems in certain
1.5 ! misha 4251: ** C++ compilers.
1.1 misha 4252: */
1.2 misha 4253: typedef void (*sqlite3_destructor_type)(void*);
4254: #define SQLITE_STATIC ((sqlite3_destructor_type)0)
4255: #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
4256:
4257: /*
1.5 ! misha 4258: ** CAPI3REF: Setting The Result Of An SQL Function
1.2 misha 4259: **
4260: ** These routines are used by the xFunc or xFinal callbacks that
4261: ** implement SQL functions and aggregates. See
4262: ** [sqlite3_create_function()] and [sqlite3_create_function16()]
4263: ** for additional information.
4264: **
1.5 ! misha 4265: ** These functions work very much like the [parameter binding] family of
! 4266: ** functions used to bind values to host parameters in prepared statements.
! 4267: ** Refer to the [SQL parameter] documentation for additional information.
1.2 misha 4268: **
1.5 ! misha 4269: ** ^The sqlite3_result_blob() interface sets the result from
! 4270: ** an application-defined function to be the BLOB whose content is pointed
1.4 misha 4271: ** to by the second parameter and which is N bytes long where N is the
1.5 ! misha 4272: ** third parameter.
! 4273: **
! 4274: ** ^The sqlite3_result_zeroblob() interfaces set the result of
! 4275: ** the application-defined function to be a BLOB containing all zero
1.4 misha 4276: ** bytes and N bytes in size, where N is the value of the 2nd parameter.
4277: **
1.5 ! misha 4278: ** ^The sqlite3_result_double() interface sets the result from
! 4279: ** an application-defined function to be a floating point value specified
1.4 misha 4280: ** by its 2nd argument.
4281: **
1.5 ! misha 4282: ** ^The sqlite3_result_error() and sqlite3_result_error16() functions
1.4 misha 4283: ** cause the implemented SQL function to throw an exception.
1.5 ! misha 4284: ** ^SQLite uses the string pointed to by the
1.4 misha 4285: ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
1.5 ! misha 4286: ** as the text of an error message. ^SQLite interprets the error
! 4287: ** message string from sqlite3_result_error() as UTF-8. ^SQLite
! 4288: ** interprets the string from sqlite3_result_error16() as UTF-16 in native
! 4289: ** byte order. ^If the third parameter to sqlite3_result_error()
1.4 misha 4290: ** or sqlite3_result_error16() is negative then SQLite takes as the error
4291: ** message all text up through the first zero character.
1.5 ! misha 4292: ** ^If the third parameter to sqlite3_result_error() or
1.4 misha 4293: ** sqlite3_result_error16() is non-negative then SQLite takes that many
4294: ** bytes (not characters) from the 2nd parameter as the error message.
1.5 ! misha 4295: ** ^The sqlite3_result_error() and sqlite3_result_error16()
! 4296: ** routines make a private copy of the error message text before
1.4 misha 4297: ** they return. Hence, the calling function can deallocate or
4298: ** modify the text after they return without harm.
1.5 ! misha 4299: ** ^The sqlite3_result_error_code() function changes the error code
! 4300: ** returned by SQLite as a result of an error in a function. ^By default,
! 4301: ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
! 4302: ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
! 4303: **
! 4304: ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
! 4305: ** error indicating that a string or BLOB is too long to represent.
1.4 misha 4306: **
1.5 ! misha 4307: ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
! 4308: ** error indicating that a memory allocation failed.
! 4309: **
! 4310: ** ^The sqlite3_result_int() interface sets the return value
1.4 misha 4311: ** of the application-defined function to be the 32-bit signed integer
4312: ** value given in the 2nd argument.
1.5 ! misha 4313: ** ^The sqlite3_result_int64() interface sets the return value
1.4 misha 4314: ** of the application-defined function to be the 64-bit signed integer
4315: ** value given in the 2nd argument.
4316: **
1.5 ! misha 4317: ** ^The sqlite3_result_null() interface sets the return value
1.4 misha 4318: ** of the application-defined function to be NULL.
4319: **
1.5 ! misha 4320: ** ^The sqlite3_result_text(), sqlite3_result_text16(),
1.4 misha 4321: ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
4322: ** set the return value of the application-defined function to be
4323: ** a text string which is represented as UTF-8, UTF-16 native byte order,
4324: ** UTF-16 little endian, or UTF-16 big endian, respectively.
1.5 ! misha 4325: ** ^SQLite takes the text result from the application from
1.4 misha 4326: ** the 2nd parameter of the sqlite3_result_text* interfaces.
1.5 ! misha 4327: ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
! 4328: ** is negative, then SQLite takes result text from the 2nd parameter
1.4 misha 4329: ** through the first zero character.
1.5 ! misha 4330: ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
1.4 misha 4331: ** is non-negative, then as many bytes (not characters) of the text
4332: ** pointed to by the 2nd parameter are taken as the application-defined
1.5 ! misha 4333: ** function result. If the 3rd parameter is non-negative, then it
! 4334: ** must be the byte offset into the string where the NUL terminator would
! 4335: ** appear if the string where NUL terminated. If any NUL characters occur
! 4336: ** in the string at a byte offset that is less than the value of the 3rd
! 4337: ** parameter, then the resulting string will contain embedded NULs and the
! 4338: ** result of expressions operating on strings with embedded NULs is undefined.
! 4339: ** ^If the 4th parameter to the sqlite3_result_text* interfaces
1.4 misha 4340: ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
1.5 ! misha 4341: ** function as the destructor on the text or BLOB result when it has
1.4 misha 4342: ** finished using that result.
1.5 ! misha 4343: ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
! 4344: ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
! 4345: ** assumes that the text or BLOB result is in constant space and does not
! 4346: ** copy the content of the parameter nor call a destructor on the content
! 4347: ** when it has finished using that result.
! 4348: ** ^If the 4th parameter to the sqlite3_result_text* interfaces
1.4 misha 4349: ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
4350: ** then SQLite makes a copy of the result into space obtained from
4351: ** from [sqlite3_malloc()] before it returns.
4352: **
1.5 ! misha 4353: ** ^The sqlite3_result_value() interface sets the result of
! 4354: ** the application-defined function to be a copy the
! 4355: ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
1.4 misha 4356: ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
1.5 ! misha 4357: ** so that the [sqlite3_value] specified in the parameter may change or
1.4 misha 4358: ** be deallocated after sqlite3_result_value() returns without harm.
1.5 ! misha 4359: ** ^A [protected sqlite3_value] object may always be used where an
! 4360: ** [unprotected sqlite3_value] object is required, so either
! 4361: ** kind of [sqlite3_value] object can be used with this interface.
1.4 misha 4362: **
1.5 ! misha 4363: ** If these routines are called from within the different thread
! 4364: ** than the one containing the application-defined function that received
1.4 misha 4365: ** the [sqlite3_context] pointer, the results are undefined.
1.5 ! misha 4366: */
! 4367: SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
! 4368: SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
! 4369: SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
! 4370: SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
! 4371: SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
! 4372: SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
! 4373: SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
! 4374: SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
! 4375: SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
! 4376: SQLITE_API void sqlite3_result_null(sqlite3_context*);
! 4377: SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
! 4378: SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
! 4379: SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
! 4380: SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
! 4381: SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
! 4382: SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
! 4383:
! 4384: /*
! 4385: ** CAPI3REF: Define New Collating Sequences
1.4 misha 4386: **
1.5 ! misha 4387: ** ^These functions add, remove, or modify a [collation] associated
! 4388: ** with the [database connection] specified as the first argument.
1.4 misha 4389: **
1.5 ! misha 4390: ** ^The name of the collation is a UTF-8 string
! 4391: ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
! 4392: ** and a UTF-16 string in native byte order for sqlite3_create_collation16().
! 4393: ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
! 4394: ** considered to be the same name.
1.4 misha 4395: **
1.5 ! misha 4396: ** ^(The third argument (eTextRep) must be one of the constants:
! 4397: ** <ul>
! 4398: ** <li> [SQLITE_UTF8],
! 4399: ** <li> [SQLITE_UTF16LE],
! 4400: ** <li> [SQLITE_UTF16BE],
! 4401: ** <li> [SQLITE_UTF16], or
! 4402: ** <li> [SQLITE_UTF16_ALIGNED].
! 4403: ** </ul>)^
! 4404: ** ^The eTextRep argument determines the encoding of strings passed
! 4405: ** to the collating function callback, xCallback.
! 4406: ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
! 4407: ** force strings to be UTF16 with native byte order.
! 4408: ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
! 4409: ** on an even byte address.
! 4410: **
! 4411: ** ^The fourth argument, pArg, is an application data pointer that is passed
! 4412: ** through as the first argument to the collating function callback.
! 4413: **
! 4414: ** ^The fifth argument, xCallback, is a pointer to the collating function.
! 4415: ** ^Multiple collating functions can be registered using the same name but
! 4416: ** with different eTextRep parameters and SQLite will use whichever
! 4417: ** function requires the least amount of data transformation.
! 4418: ** ^If the xCallback argument is NULL then the collating function is
! 4419: ** deleted. ^When all collating functions having the same name are deleted,
! 4420: ** that collation is no longer usable.
! 4421: **
! 4422: ** ^The collating function callback is invoked with a copy of the pArg
! 4423: ** application data pointer and with two strings in the encoding specified
! 4424: ** by the eTextRep argument. The collating function must return an
! 4425: ** integer that is negative, zero, or positive
! 4426: ** if the first string is less than, equal to, or greater than the second,
! 4427: ** respectively. A collating function must always return the same answer
! 4428: ** given the same inputs. If two or more collating functions are registered
! 4429: ** to the same collation name (using different eTextRep values) then all
! 4430: ** must give an equivalent answer when invoked with equivalent strings.
! 4431: ** The collating function must obey the following properties for all
! 4432: ** strings A, B, and C:
! 4433: **
! 4434: ** <ol>
! 4435: ** <li> If A==B then B==A.
! 4436: ** <li> If A==B and B==C then A==C.
! 4437: ** <li> If A<B THEN B>A.
! 4438: ** <li> If A<B and B<C then A<C.
! 4439: ** </ol>
1.2 misha 4440: **
1.5 ! misha 4441: ** If a collating function fails any of the above constraints and that
! 4442: ** collating function is registered and used, then the behavior of SQLite
! 4443: ** is undefined.
1.1 misha 4444: **
1.5 ! misha 4445: ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
! 4446: ** with the addition that the xDestroy callback is invoked on pArg when
! 4447: ** the collating function is deleted.
! 4448: ** ^Collating functions are deleted when they are overridden by later
! 4449: ** calls to the collation creation functions or when the
! 4450: ** [database connection] is closed using [sqlite3_close()].
! 4451: **
! 4452: ** ^The xDestroy callback is <u>not</u> called if the
! 4453: ** sqlite3_create_collation_v2() function fails. Applications that invoke
! 4454: ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
! 4455: ** check the return code and dispose of the application data pointer
! 4456: ** themselves rather than expecting SQLite to deal with it for them.
! 4457: ** This is different from every other SQLite interface. The inconsistency
! 4458: ** is unfortunate but cannot be changed without breaking backwards
! 4459: ** compatibility.
1.1 misha 4460: **
1.5 ! misha 4461: ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
1.1 misha 4462: */
1.5 ! misha 4463: SQLITE_API int sqlite3_create_collation(
1.1 misha 4464: sqlite3*,
4465: const char *zName,
4466: int eTextRep,
1.5 ! misha 4467: void *pArg,
1.1 misha 4468: int(*xCompare)(void*,int,const void*,int,const void*)
4469: );
1.5 ! misha 4470: SQLITE_API int sqlite3_create_collation_v2(
1.2 misha 4471: sqlite3*,
4472: const char *zName,
4473: int eTextRep,
1.5 ! misha 4474: void *pArg,
1.2 misha 4475: int(*xCompare)(void*,int,const void*,int,const void*),
4476: void(*xDestroy)(void*)
4477: );
1.5 ! misha 4478: SQLITE_API int sqlite3_create_collation16(
1.1 misha 4479: sqlite3*,
1.5 ! misha 4480: const void *zName,
1.1 misha 4481: int eTextRep,
1.5 ! misha 4482: void *pArg,
1.1 misha 4483: int(*xCompare)(void*,int,const void*,int,const void*)
4484: );
4485:
4486: /*
1.5 ! misha 4487: ** CAPI3REF: Collation Needed Callbacks
1.2 misha 4488: **
1.5 ! misha 4489: ** ^To avoid having to register all collation sequences before a database
1.1 misha 4490: ** can be used, a single callback function may be registered with the
1.5 ! misha 4491: ** [database connection] to be invoked whenever an undefined collation
! 4492: ** sequence is required.
1.1 misha 4493: **
1.5 ! misha 4494: ** ^If the function is registered using the sqlite3_collation_needed() API,
1.1 misha 4495: ** then it is passed the names of undefined collation sequences as strings
1.5 ! misha 4496: ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
! 4497: ** the names are passed as UTF-16 in machine native byte order.
! 4498: ** ^A call to either function replaces the existing collation-needed callback.
1.1 misha 4499: **
1.5 ! misha 4500: ** ^(When the callback is invoked, the first argument passed is a copy
1.1 misha 4501: ** of the second argument to sqlite3_collation_needed() or
1.4 misha 4502: ** sqlite3_collation_needed16(). The second argument is the database
1.5 ! misha 4503: ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
! 4504: ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
! 4505: ** sequence function required. The fourth parameter is the name of the
! 4506: ** required collation sequence.)^
1.1 misha 4507: **
1.2 misha 4508: ** The callback function should register the desired collation using
4509: ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
4510: ** [sqlite3_create_collation_v2()].
1.1 misha 4511: */
1.5 ! misha 4512: SQLITE_API int sqlite3_collation_needed(
1.1 misha 4513: sqlite3*,
4514: void*,
4515: void(*)(void*,sqlite3*,int eTextRep,const char*)
4516: );
1.5 ! misha 4517: SQLITE_API int sqlite3_collation_needed16(
1.1 misha 4518: sqlite3*,
4519: void*,
4520: void(*)(void*,sqlite3*,int eTextRep,const void*)
4521: );
4522:
1.5 ! misha 4523: #ifdef SQLITE_HAS_CODEC
1.1 misha 4524: /*
4525: ** Specify the key for an encrypted database. This routine should be
4526: ** called right after sqlite3_open().
4527: **
4528: ** The code to implement this API is not available in the public release
4529: ** of SQLite.
4530: */
1.5 ! misha 4531: SQLITE_API int sqlite3_key(
1.1 misha 4532: sqlite3 *db, /* Database to be rekeyed */
4533: const void *pKey, int nKey /* The key */
4534: );
1.5 ! misha 4535: SQLITE_API int sqlite3_key_v2(
! 4536: sqlite3 *db, /* Database to be rekeyed */
! 4537: const char *zDbName, /* Name of the database */
! 4538: const void *pKey, int nKey /* The key */
! 4539: );
1.1 misha 4540:
4541: /*
4542: ** Change the key on an open database. If the current database is not
4543: ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
4544: ** database is decrypted.
4545: **
4546: ** The code to implement this API is not available in the public release
4547: ** of SQLite.
4548: */
1.5 ! misha 4549: SQLITE_API int sqlite3_rekey(
! 4550: sqlite3 *db, /* Database to be rekeyed */
! 4551: const void *pKey, int nKey /* The new key */
! 4552: );
! 4553: SQLITE_API int sqlite3_rekey_v2(
1.1 misha 4554: sqlite3 *db, /* Database to be rekeyed */
1.5 ! misha 4555: const char *zDbName, /* Name of the database */
1.1 misha 4556: const void *pKey, int nKey /* The new key */
4557: );
4558:
4559: /*
1.5 ! misha 4560: ** Specify the activation key for a SEE database. Unless
! 4561: ** activated, none of the SEE routines will work.
! 4562: */
! 4563: SQLITE_API void sqlite3_activate_see(
! 4564: const char *zPassPhrase /* Activation phrase */
! 4565: );
! 4566: #endif
! 4567:
! 4568: #ifdef SQLITE_ENABLE_CEROD
! 4569: /*
! 4570: ** Specify the activation key for a CEROD database. Unless
! 4571: ** activated, none of the CEROD routines will work.
! 4572: */
! 4573: SQLITE_API void sqlite3_activate_cerod(
! 4574: const char *zPassPhrase /* Activation phrase */
! 4575: );
! 4576: #endif
! 4577:
! 4578: /*
! 4579: ** CAPI3REF: Suspend Execution For A Short Time
1.2 misha 4580: **
1.5 ! misha 4581: ** The sqlite3_sleep() function causes the current thread to suspend execution
1.4 misha 4582: ** for at least a number of milliseconds specified in its parameter.
1.2 misha 4583: **
1.5 ! misha 4584: ** If the operating system does not support sleep requests with
! 4585: ** millisecond time resolution, then the time will be rounded up to
! 4586: ** the nearest second. The number of milliseconds of sleep actually
1.2 misha 4587: ** requested from the operating system is returned.
4588: **
1.5 ! misha 4589: ** ^SQLite implements this interface by calling the xSleep()
! 4590: ** method of the default [sqlite3_vfs] object. If the xSleep() method
! 4591: ** of the default VFS is not implemented correctly, or not implemented at
! 4592: ** all, then the behavior of sqlite3_sleep() may deviate from the description
! 4593: ** in the previous paragraphs.
! 4594: */
! 4595: SQLITE_API int sqlite3_sleep(int);
! 4596:
! 4597: /*
! 4598: ** CAPI3REF: Name Of The Folder Holding Temporary Files
! 4599: **
! 4600: ** ^(If this global variable is made to point to a string which is
! 4601: ** the name of a folder (a.k.a. directory), then all temporary files
! 4602: ** created by SQLite when using a built-in [sqlite3_vfs | VFS]
! 4603: ** will be placed in that directory.)^ ^If this variable
! 4604: ** is a NULL pointer, then SQLite performs a search for an appropriate
! 4605: ** temporary file directory.
! 4606: **
! 4607: ** It is not safe to read or modify this variable in more than one
! 4608: ** thread at a time. It is not safe to read or modify this variable
! 4609: ** if a [database connection] is being used at the same time in a separate
! 4610: ** thread.
! 4611: ** It is intended that this variable be set once
! 4612: ** as part of process initialization and before any SQLite interface
! 4613: ** routines have been called and that this variable remain unchanged
! 4614: ** thereafter.
1.4 misha 4615: **
1.5 ! misha 4616: ** ^The [temp_store_directory pragma] may modify this variable and cause
! 4617: ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
! 4618: ** the [temp_store_directory pragma] always assumes that any string
! 4619: ** that this variable points to is held in memory obtained from
! 4620: ** [sqlite3_malloc] and the pragma may attempt to free that memory
! 4621: ** using [sqlite3_free].
! 4622: ** Hence, if this variable is modified directly, either it should be
! 4623: ** made NULL or made to point to memory obtained from [sqlite3_malloc]
! 4624: ** or else the use of the [temp_store_directory pragma] should be avoided.
! 4625: **
! 4626: ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
! 4627: ** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
! 4628: ** features that require the use of temporary files may fail. Here is an
! 4629: ** example of how to do this using C++ with the Windows Runtime:
1.4 misha 4630: **
1.5 ! misha 4631: ** <blockquote><pre>
! 4632: ** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
! 4633: ** TemporaryFolder->Path->Data();
! 4634: ** char zPathBuf[MAX_PATH + 1];
! 4635: ** memset(zPathBuf, 0, sizeof(zPathBuf));
! 4636: ** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
! 4637: ** NULL, NULL);
! 4638: ** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
! 4639: ** </pre></blockquote>
1.2 misha 4640: */
1.5 ! misha 4641: SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
1.2 misha 4642:
4643: /*
1.5 ! misha 4644: ** CAPI3REF: Name Of The Folder Holding Database Files
1.2 misha 4645: **
1.5 ! misha 4646: ** ^(If this global variable is made to point to a string which is
! 4647: ** the name of a folder (a.k.a. directory), then all database files
! 4648: ** specified with a relative pathname and created or accessed by
! 4649: ** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
! 4650: ** to be relative to that directory.)^ ^If this variable is a NULL
! 4651: ** pointer, then SQLite assumes that all database files specified
! 4652: ** with a relative pathname are relative to the current directory
! 4653: ** for the process. Only the windows VFS makes use of this global
! 4654: ** variable; it is ignored by the unix VFS.
! 4655: **
! 4656: ** Changing the value of this variable while a database connection is
! 4657: ** open can result in a corrupt database.
! 4658: **
! 4659: ** It is not safe to read or modify this variable in more than one
! 4660: ** thread at a time. It is not safe to read or modify this variable
! 4661: ** if a [database connection] is being used at the same time in a separate
! 4662: ** thread.
! 4663: ** It is intended that this variable be set once
! 4664: ** as part of process initialization and before any SQLite interface
! 4665: ** routines have been called and that this variable remain unchanged
! 4666: ** thereafter.
1.1 misha 4667: **
1.5 ! misha 4668: ** ^The [data_store_directory pragma] may modify this variable and cause
! 4669: ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
! 4670: ** the [data_store_directory pragma] always assumes that any string
! 4671: ** that this variable points to is held in memory obtained from
! 4672: ** [sqlite3_malloc] and the pragma may attempt to free that memory
! 4673: ** using [sqlite3_free].
! 4674: ** Hence, if this variable is modified directly, either it should be
! 4675: ** made NULL or made to point to memory obtained from [sqlite3_malloc]
! 4676: ** or else the use of the [data_store_directory pragma] should be avoided.
1.2 misha 4677: */
1.5 ! misha 4678: SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory;
1.2 misha 4679:
4680: /*
1.5 ! misha 4681: ** CAPI3REF: Test For Auto-Commit Mode
! 4682: ** KEYWORDS: {autocommit mode}
1.2 misha 4683: **
1.5 ! misha 4684: ** ^The sqlite3_get_autocommit() interface returns non-zero or
1.4 misha 4685: ** zero if the given database connection is or is not in autocommit mode,
1.5 ! misha 4686: ** respectively. ^Autocommit mode is on by default.
! 4687: ** ^Autocommit mode is disabled by a [BEGIN] statement.
! 4688: ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
1.2 misha 4689: **
4690: ** If certain kinds of errors occur on a statement within a multi-statement
1.5 ! misha 4691: ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
1.2 misha 4692: ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
4693: ** transaction might be rolled back automatically. The only way to
1.5 ! misha 4694: ** find out whether SQLite automatically rolled back the transaction after
1.2 misha 4695: ** an error is to use this function.
4696: **
1.5 ! misha 4697: ** If another thread changes the autocommit status of the database
! 4698: ** connection while this routine is running, then the return value
! 4699: ** is undefined.
! 4700: */
! 4701: SQLITE_API int sqlite3_get_autocommit(sqlite3*);
! 4702:
! 4703: /*
! 4704: ** CAPI3REF: Find The Database Handle Of A Prepared Statement
1.4 misha 4705: **
1.5 ! misha 4706: ** ^The sqlite3_db_handle interface returns the [database connection] handle
! 4707: ** to which a [prepared statement] belongs. ^The [database connection]
! 4708: ** returned by sqlite3_db_handle is the same [database connection]
! 4709: ** that was the first argument
! 4710: ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
! 4711: ** create the statement in the first place.
! 4712: */
! 4713: SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
! 4714:
! 4715: /*
! 4716: ** CAPI3REF: Return The Filename For A Database Connection
1.4 misha 4717: **
1.5 ! misha 4718: ** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
! 4719: ** associated with database N of connection D. ^The main database file
! 4720: ** has the name "main". If there is no attached database N on the database
! 4721: ** connection D, or if database N is a temporary or in-memory database, then
! 4722: ** a NULL pointer is returned.
1.4 misha 4723: **
1.5 ! misha 4724: ** ^The filename returned by this function is the output of the
! 4725: ** xFullPathname method of the [VFS]. ^In other words, the filename
! 4726: ** will be an absolute pathname, even if the filename used
! 4727: ** to open the database originally was a URI or relative pathname.
! 4728: */
! 4729: SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
! 4730:
! 4731: /*
! 4732: ** CAPI3REF: Determine if a database is read-only
1.4 misha 4733: **
1.5 ! misha 4734: ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
! 4735: ** of connection D is read-only, 0 if it is read/write, or -1 if N is not
! 4736: ** the name of a database on connection D.
1.2 misha 4737: */
1.5 ! misha 4738: SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
1.2 misha 4739:
4740: /*
1.5 ! misha 4741: ** CAPI3REF: Find the next prepared statement
1.2 misha 4742: **
1.5 ! misha 4743: ** ^This interface returns a pointer to the next [prepared statement] after
! 4744: ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
! 4745: ** then this interface returns a pointer to the first prepared statement
! 4746: ** associated with the database connection pDb. ^If no prepared statement
! 4747: ** satisfies the conditions of this routine, it returns NULL.
1.4 misha 4748: **
1.5 ! misha 4749: ** The [database connection] pointer D in a call to
! 4750: ** [sqlite3_next_stmt(D,S)] must refer to an open database
! 4751: ** connection and in particular must not be a NULL pointer.
1.2 misha 4752: */
1.5 ! misha 4753: SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
1.2 misha 4754:
4755: /*
1.5 ! misha 4756: ** CAPI3REF: Commit And Rollback Notification Callbacks
1.2 misha 4757: **
1.5 ! misha 4758: ** ^The sqlite3_commit_hook() interface registers a callback
! 4759: ** function to be invoked whenever a transaction is [COMMIT | committed].
! 4760: ** ^Any callback set by a previous call to sqlite3_commit_hook()
1.4 misha 4761: ** for the same database connection is overridden.
1.5 ! misha 4762: ** ^The sqlite3_rollback_hook() interface registers a callback
! 4763: ** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
! 4764: ** ^Any callback set by a previous call to sqlite3_rollback_hook()
1.4 misha 4765: ** for the same database connection is overridden.
1.5 ! misha 4766: ** ^The pArg argument is passed through to the callback.
! 4767: ** ^If the callback on a commit hook function returns non-zero,
! 4768: ** then the commit is converted into a rollback.
! 4769: **
! 4770: ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
! 4771: ** return the P argument from the previous call of the same function
! 4772: ** on the same [database connection] D, or NULL for
! 4773: ** the first call for each function on D.
! 4774: **
! 4775: ** The commit and rollback hook callbacks are not reentrant.
! 4776: ** The callback implementation must not do anything that will modify
! 4777: ** the database connection that invoked the callback. Any actions
! 4778: ** to modify the database connection must be deferred until after the
! 4779: ** completion of the [sqlite3_step()] call that triggered the commit
! 4780: ** or rollback hook in the first place.
! 4781: ** Note that running any other SQL statements, including SELECT statements,
! 4782: ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
! 4783: ** the database connections for the meaning of "modify" in this paragraph.
! 4784: **
! 4785: ** ^Registering a NULL function disables the callback.
! 4786: **
! 4787: ** ^When the commit hook callback routine returns zero, the [COMMIT]
! 4788: ** operation is allowed to continue normally. ^If the commit hook
! 4789: ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
! 4790: ** ^The rollback hook is invoked on a rollback that results from a commit
! 4791: ** hook returning non-zero, just as it would be with any other rollback.
1.2 misha 4792: **
1.5 ! misha 4793: ** ^For the purposes of this API, a transaction is said to have been
1.2 misha 4794: ** rolled back if an explicit "ROLLBACK" statement is executed, or
1.4 misha 4795: ** an error or constraint causes an implicit rollback to occur.
1.5 ! misha 4796: ** ^The rollback callback is not invoked if a transaction is
1.4 misha 4797: ** automatically rolled back because the database connection is closed.
4798: **
1.5 ! misha 4799: ** See also the [sqlite3_update_hook()] interface.
1.2 misha 4800: */
1.5 ! misha 4801: SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
! 4802: SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
1.2 misha 4803:
4804: /*
1.5 ! misha 4805: ** CAPI3REF: Data Change Notification Callbacks
1.2 misha 4806: **
1.5 ! misha 4807: ** ^The sqlite3_update_hook() interface registers a callback function
! 4808: ** with the [database connection] identified by the first argument
! 4809: ** to be invoked whenever a row is updated, inserted or deleted.
! 4810: ** ^Any callback set by a previous call to this function
! 4811: ** for the same database connection is overridden.
1.4 misha 4812: **
1.5 ! misha 4813: ** ^The second argument is a pointer to the function to invoke when a
! 4814: ** row is updated, inserted or deleted.
! 4815: ** ^The first argument to the callback is a copy of the third argument
! 4816: ** to sqlite3_update_hook().
! 4817: ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
! 4818: ** or [SQLITE_UPDATE], depending on the operation that caused the callback
! 4819: ** to be invoked.
! 4820: ** ^The third and fourth arguments to the callback contain pointers to the
! 4821: ** database and table name containing the affected row.
! 4822: ** ^The final callback parameter is the [rowid] of the row.
! 4823: ** ^In the case of an update, this is the [rowid] after the update takes place.
! 4824: **
! 4825: ** ^(The update hook is not invoked when internal system tables are
! 4826: ** modified (i.e. sqlite_master and sqlite_sequence).)^
! 4827: **
! 4828: ** ^In the current implementation, the update hook
! 4829: ** is not invoked when duplication rows are deleted because of an
! 4830: ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
! 4831: ** invoked when rows are deleted using the [truncate optimization].
! 4832: ** The exceptions defined in this paragraph might change in a future
! 4833: ** release of SQLite.
! 4834: **
! 4835: ** The update hook implementation must not do anything that will modify
! 4836: ** the database connection that invoked the update hook. Any actions
! 4837: ** to modify the database connection must be deferred until after the
! 4838: ** completion of the [sqlite3_step()] call that triggered the update hook.
! 4839: ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
! 4840: ** database connections for the meaning of "modify" in this paragraph.
! 4841: **
! 4842: ** ^The sqlite3_update_hook(D,C,P) function
! 4843: ** returns the P argument from the previous call
! 4844: ** on the same [database connection] D, or NULL for
! 4845: ** the first call on D.
1.4 misha 4846: **
1.5 ! misha 4847: ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
! 4848: ** interfaces.
1.2 misha 4849: */
1.5 ! misha 4850: SQLITE_API void *sqlite3_update_hook(
1.2 misha 4851: sqlite3*,
4852: void(*)(void *,int ,char const *,char const *,sqlite3_int64),
4853: void*
4854: );
4855:
4856: /*
1.5 ! misha 4857: ** CAPI3REF: Enable Or Disable Shared Pager Cache
1.2 misha 4858: **
1.5 ! misha 4859: ** ^(This routine enables or disables the sharing of the database cache
! 4860: ** and schema data structures between [database connection | connections]
! 4861: ** to the same database. Sharing is enabled if the argument is true
! 4862: ** and disabled if the argument is false.)^
! 4863: **
! 4864: ** ^Cache sharing is enabled and disabled for an entire process.
! 4865: ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
! 4866: ** sharing was enabled or disabled for each thread separately.
1.2 misha 4867: **
1.5 ! misha 4868: ** ^(The cache sharing mode set by this interface effects all subsequent
1.2 misha 4869: ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
1.4 misha 4870: ** Existing database connections continue use the sharing mode
1.5 ! misha 4871: ** that was in effect at the time they were opened.)^
1.2 misha 4872: **
1.5 ! misha 4873: ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
! 4874: ** successfully. An [error code] is returned otherwise.)^
1.2 misha 4875: **
1.5 ! misha 4876: ** ^Shared cache is disabled by default. But this might change in
1.2 misha 4877: ** future releases of SQLite. Applications that care about shared
4878: ** cache setting should set it explicitly.
1.4 misha 4879: **
1.5 ! misha 4880: ** This interface is threadsafe on processors where writing a
! 4881: ** 32-bit integer is atomic.
1.4 misha 4882: **
1.5 ! misha 4883: ** See Also: [SQLite Shared-Cache Mode]
! 4884: */
! 4885: SQLITE_API int sqlite3_enable_shared_cache(int);
! 4886:
! 4887: /*
! 4888: ** CAPI3REF: Attempt To Free Heap Memory
1.4 misha 4889: **
1.5 ! misha 4890: ** ^The sqlite3_release_memory() interface attempts to free N bytes
! 4891: ** of heap memory by deallocating non-essential memory allocations
! 4892: ** held by the database library. Memory used to cache database
! 4893: ** pages to improve performance is an example of non-essential memory.
! 4894: ** ^sqlite3_release_memory() returns the number of bytes actually freed,
! 4895: ** which might be more or less than the amount requested.
! 4896: ** ^The sqlite3_release_memory() routine is a no-op returning zero
! 4897: ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
1.4 misha 4898: **
1.5 ! misha 4899: ** See also: [sqlite3_db_release_memory()]
1.2 misha 4900: */
1.5 ! misha 4901: SQLITE_API int sqlite3_release_memory(int);
1.2 misha 4902:
4903: /*
1.5 ! misha 4904: ** CAPI3REF: Free Memory Used By A Database Connection
1.2 misha 4905: **
1.5 ! misha 4906: ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
! 4907: ** memory as possible from database connection D. Unlike the
! 4908: ** [sqlite3_release_memory()] interface, this interface is effect even
! 4909: ** when then [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
! 4910: ** omitted.
1.4 misha 4911: **
1.5 ! misha 4912: ** See also: [sqlite3_release_memory()]
1.2 misha 4913: */
1.5 ! misha 4914: SQLITE_API int sqlite3_db_release_memory(sqlite3*);
1.2 misha 4915:
4916: /*
1.5 ! misha 4917: ** CAPI3REF: Impose A Limit On Heap Size
1.2 misha 4918: **
1.5 ! misha 4919: ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
! 4920: ** soft limit on the amount of heap memory that may be allocated by SQLite.
! 4921: ** ^SQLite strives to keep heap memory utilization below the soft heap
! 4922: ** limit by reducing the number of pages held in the page cache
! 4923: ** as heap memory usages approaches the limit.
! 4924: ** ^The soft heap limit is "soft" because even though SQLite strives to stay
! 4925: ** below the limit, it will exceed the limit rather than generate
! 4926: ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
! 4927: ** is advisory only.
1.2 misha 4928: **
1.5 ! misha 4929: ** ^The return value from sqlite3_soft_heap_limit64() is the size of
! 4930: ** the soft heap limit prior to the call, or negative in the case of an
! 4931: ** error. ^If the argument N is negative
! 4932: ** then no change is made to the soft heap limit. Hence, the current
! 4933: ** size of the soft heap limit can be determined by invoking
! 4934: ** sqlite3_soft_heap_limit64() with a negative argument.
1.2 misha 4935: **
1.5 ! misha 4936: ** ^If the argument N is zero then the soft heap limit is disabled.
1.2 misha 4937: **
1.5 ! misha 4938: ** ^(The soft heap limit is not enforced in the current implementation
! 4939: ** if one or more of following conditions are true:
1.2 misha 4940: **
1.5 ! misha 4941: ** <ul>
! 4942: ** <li> The soft heap limit is set to zero.
! 4943: ** <li> Memory accounting is disabled using a combination of the
! 4944: ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
! 4945: ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
! 4946: ** <li> An alternative page cache implementation is specified using
! 4947: ** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
! 4948: ** <li> The page cache allocates from its own memory pool supplied
! 4949: ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
! 4950: ** from the heap.
! 4951: ** </ul>)^
! 4952: **
! 4953: ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
! 4954: ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
! 4955: ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
! 4956: ** the soft heap limit is enforced on every memory allocation. Without
! 4957: ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
! 4958: ** when memory is allocated by the page cache. Testing suggests that because
! 4959: ** the page cache is the predominate memory user in SQLite, most
! 4960: ** applications will achieve adequate soft heap limit enforcement without
! 4961: ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
! 4962: **
! 4963: ** The circumstances under which SQLite will enforce the soft heap limit may
! 4964: ** changes in future releases of SQLite.
! 4965: */
! 4966: SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
! 4967:
! 4968: /*
! 4969: ** CAPI3REF: Deprecated Soft Heap Limit Interface
! 4970: ** DEPRECATED
! 4971: **
! 4972: ** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
! 4973: ** interface. This routine is provided for historical compatibility
! 4974: ** only. All new applications should use the
! 4975: ** [sqlite3_soft_heap_limit64()] interface rather than this one.
! 4976: */
! 4977: SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
! 4978:
1.2 misha 4979:
4980: /*
1.5 ! misha 4981: ** CAPI3REF: Extract Metadata About A Column Of A Table
! 4982: **
! 4983: ** ^This routine returns metadata about a specific column of a specific
! 4984: ** database table accessible using the [database connection] handle
! 4985: ** passed as the first function argument.
! 4986: **
! 4987: ** ^The column is identified by the second, third and fourth parameters to
! 4988: ** this function. ^The second parameter is either the name of the database
! 4989: ** (i.e. "main", "temp", or an attached database) containing the specified
! 4990: ** table or NULL. ^If it is NULL, then all attached databases are searched
! 4991: ** for the table using the same algorithm used by the database engine to
1.2 misha 4992: ** resolve unqualified table references.
4993: **
1.5 ! misha 4994: ** ^The third and fourth parameters to this function are the table and column
! 4995: ** name of the desired column, respectively. Neither of these parameters
1.2 misha 4996: ** may be NULL.
4997: **
1.5 ! misha 4998: ** ^Metadata is returned by writing to the memory locations passed as the 5th
! 4999: ** and subsequent parameters to this function. ^Any of these arguments may be
! 5000: ** NULL, in which case the corresponding element of metadata is omitted.
1.2 misha 5001: **
1.5 ! misha 5002: ** ^(<blockquote>
! 5003: ** <table border="1">
! 5004: ** <tr><th> Parameter <th> Output<br>Type <th> Description
! 5005: **
! 5006: ** <tr><td> 5th <td> const char* <td> Data type
! 5007: ** <tr><td> 6th <td> const char* <td> Name of default collation sequence
! 5008: ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
! 5009: ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
! 5010: ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
! 5011: ** </table>
! 5012: ** </blockquote>)^
1.2 misha 5013: **
1.5 ! misha 5014: ** ^The memory pointed to by the character pointers returned for the
! 5015: ** declaration type and collation sequence is valid only until the next
! 5016: ** call to any SQLite API function.
! 5017: **
! 5018: ** ^If the specified table is actually a view, an [error code] is returned.
! 5019: **
! 5020: ** ^If the specified column is "rowid", "oid" or "_rowid_" and an
! 5021: ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
! 5022: ** parameters are set for the explicitly declared column. ^(If there is no
! 5023: ** explicitly declared [INTEGER PRIMARY KEY] column, then the output
! 5024: ** parameters are set as follows:
1.2 misha 5025: **
5026: ** <pre>
5027: ** data type: "INTEGER"
5028: ** collation sequence: "BINARY"
5029: ** not null: 0
5030: ** primary key: 1
5031: ** auto increment: 0
1.5 ! misha 5032: ** </pre>)^
1.2 misha 5033: **
1.5 ! misha 5034: ** ^(This function may load one or more schemas from database files. If an
1.2 misha 5035: ** error occurs during this process, or if the requested table or column
1.5 ! misha 5036: ** cannot be found, an [error code] is returned and an error message left
! 5037: ** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^
1.2 misha 5038: **
1.5 ! misha 5039: ** ^This API is only available if the library was compiled with the
! 5040: ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
1.2 misha 5041: */
1.5 ! misha 5042: SQLITE_API int sqlite3_table_column_metadata(
1.2 misha 5043: sqlite3 *db, /* Connection handle */
5044: const char *zDbName, /* Database name or NULL */
5045: const char *zTableName, /* Table name */
5046: const char *zColumnName, /* Column name */
5047: char const **pzDataType, /* OUTPUT: Declared data type */
5048: char const **pzCollSeq, /* OUTPUT: Collation sequence name */
5049: int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
5050: int *pPrimaryKey, /* OUTPUT: True if column part of PK */
5051: int *pAutoinc /* OUTPUT: True if column is auto-increment */
5052: );
5053:
5054: /*
1.5 ! misha 5055: ** CAPI3REF: Load An Extension
! 5056: **
! 5057: ** ^This interface loads an SQLite extension library from the named file.
1.2 misha 5058: **
1.5 ! misha 5059: ** ^The sqlite3_load_extension() interface attempts to load an
! 5060: ** [SQLite extension] library contained in the file zFile. If
! 5061: ** the file cannot be loaded directly, attempts are made to load
! 5062: ** with various operating-system specific extensions added.
! 5063: ** So for example, if "samplelib" cannot be loaded, then names like
! 5064: ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
! 5065: ** be tried also.
! 5066: **
! 5067: ** ^The entry point is zProc.
! 5068: ** ^(zProc may be 0, in which case SQLite will try to come up with an
! 5069: ** entry point name on its own. It first tries "sqlite3_extension_init".
! 5070: ** If that does not work, it constructs a name "sqlite3_X_init" where the
! 5071: ** X is consists of the lower-case equivalent of all ASCII alphabetic
! 5072: ** characters in the filename from the last "/" to the first following
! 5073: ** "." and omitting any initial "lib".)^
! 5074: ** ^The sqlite3_load_extension() interface returns
! 5075: ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
! 5076: ** ^If an error occurs and pzErrMsg is not 0, then the
! 5077: ** [sqlite3_load_extension()] interface shall attempt to
! 5078: ** fill *pzErrMsg with error message text stored in memory
! 5079: ** obtained from [sqlite3_malloc()]. The calling function
! 5080: ** should free this memory by calling [sqlite3_free()].
! 5081: **
! 5082: ** ^Extension loading must be enabled using
! 5083: ** [sqlite3_enable_load_extension()] prior to calling this API,
! 5084: ** otherwise an error will be returned.
! 5085: **
! 5086: ** See also the [load_extension() SQL function].
1.2 misha 5087: */
1.5 ! misha 5088: SQLITE_API int sqlite3_load_extension(
1.2 misha 5089: sqlite3 *db, /* Load the extension into this database connection */
5090: const char *zFile, /* Name of the shared library containing extension */
5091: const char *zProc, /* Entry point. Derived from zFile if 0 */
5092: char **pzErrMsg /* Put error message here if not 0 */
5093: );
5094:
5095: /*
1.5 ! misha 5096: ** CAPI3REF: Enable Or Disable Extension Loading
1.2 misha 5097: **
1.5 ! misha 5098: ** ^So as not to open security holes in older applications that are
! 5099: ** unprepared to deal with [extension loading], and as a means of disabling
! 5100: ** [extension loading] while evaluating user-entered SQL, the following API
! 5101: ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
1.2 misha 5102: **
1.5 ! misha 5103: ** ^Extension loading is off by default.
! 5104: ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
! 5105: ** to turn extension loading on and call it with onoff==0 to turn
! 5106: ** it back off again.
1.2 misha 5107: */
1.5 ! misha 5108: SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
1.2 misha 5109:
5110: /*
1.5 ! misha 5111: ** CAPI3REF: Automatically Load Statically Linked Extensions
1.2 misha 5112: **
1.5 ! misha 5113: ** ^This interface causes the xEntryPoint() function to be invoked for
! 5114: ** each new [database connection] that is created. The idea here is that
! 5115: ** xEntryPoint() is the entry point for a statically linked [SQLite extension]
! 5116: ** that is to be automatically loaded into all new database connections.
1.2 misha 5117: **
1.5 ! misha 5118: ** ^(Even though the function prototype shows that xEntryPoint() takes
! 5119: ** no arguments and returns void, SQLite invokes xEntryPoint() with three
! 5120: ** arguments and expects and integer result as if the signature of the
! 5121: ** entry point where as follows:
1.2 misha 5122: **
1.5 ! misha 5123: ** <blockquote><pre>
! 5124: ** int xEntryPoint(
! 5125: ** sqlite3 *db,
! 5126: ** const char **pzErrMsg,
! 5127: ** const struct sqlite3_api_routines *pThunk
! 5128: ** );
! 5129: ** </pre></blockquote>)^
1.2 misha 5130: **
1.5 ! misha 5131: ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
! 5132: ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
! 5133: ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
! 5134: ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
! 5135: ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
! 5136: ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
! 5137: ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
1.2 misha 5138: **
1.5 ! misha 5139: ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
! 5140: ** on the list of automatic extensions is a harmless no-op. ^No entry point
! 5141: ** will be called more than once for each database connection that is opened.
1.2 misha 5142: **
1.5 ! misha 5143: ** See also: [sqlite3_reset_auto_extension()]
! 5144: ** and [sqlite3_cancel_auto_extension()]
1.2 misha 5145: */
1.5 ! misha 5146: SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void));
1.2 misha 5147:
1.5 ! misha 5148: /*
! 5149: ** CAPI3REF: Cancel Automatic Extension Loading
! 5150: **
! 5151: ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
! 5152: ** initialization routine X that was registered using a prior call to
! 5153: ** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
! 5154: ** routine returns 1 if initialization routine X was successfully
! 5155: ** unregistered and it returns 0 if X was not on the list of initialization
! 5156: ** routines.
! 5157: */
! 5158: SQLITE_API int sqlite3_cancel_auto_extension(void (*xEntryPoint)(void));
1.2 misha 5159:
5160: /*
1.5 ! misha 5161: ** CAPI3REF: Reset Automatic Extension Loading
1.2 misha 5162: **
1.5 ! misha 5163: ** ^This interface disables all automatic extensions previously
! 5164: ** registered using [sqlite3_auto_extension()].
1.2 misha 5165: */
1.5 ! misha 5166: SQLITE_API void sqlite3_reset_auto_extension(void);
1.2 misha 5167:
5168: /*
5169: ** The interface to the virtual-table mechanism is currently considered
5170: ** to be experimental. The interface might change in incompatible ways.
5171: ** If this is a problem for you, do not use the interface at this time.
5172: **
1.5 ! misha 5173: ** When the virtual-table mechanism stabilizes, we will declare the
1.2 misha 5174: ** interface fixed, support it indefinitely, and remove this comment.
5175: */
5176:
5177: /*
5178: ** Structures used by the virtual table interface
5179: */
5180: typedef struct sqlite3_vtab sqlite3_vtab;
5181: typedef struct sqlite3_index_info sqlite3_index_info;
5182: typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
5183: typedef struct sqlite3_module sqlite3_module;
5184:
5185: /*
1.5 ! misha 5186: ** CAPI3REF: Virtual Table Object
! 5187: ** KEYWORDS: sqlite3_module {virtual table module}
1.4 misha 5188: **
1.5 ! misha 5189: ** This structure, sometimes called a "virtual table module",
! 5190: ** defines the implementation of a [virtual tables].
! 5191: ** This structure consists mostly of methods for the module.
! 5192: **
! 5193: ** ^A virtual table module is created by filling in a persistent
! 5194: ** instance of this structure and passing a pointer to that instance
! 5195: ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
! 5196: ** ^The registration remains valid until it is replaced by a different
! 5197: ** module or until the [database connection] closes. The content
! 5198: ** of this structure must not change while it is registered with
! 5199: ** any database connection.
1.2 misha 5200: */
5201: struct sqlite3_module {
5202: int iVersion;
5203: int (*xCreate)(sqlite3*, void *pAux,
5204: int argc, const char *const*argv,
5205: sqlite3_vtab **ppVTab, char**);
5206: int (*xConnect)(sqlite3*, void *pAux,
5207: int argc, const char *const*argv,
5208: sqlite3_vtab **ppVTab, char**);
5209: int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
5210: int (*xDisconnect)(sqlite3_vtab *pVTab);
5211: int (*xDestroy)(sqlite3_vtab *pVTab);
5212: int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
5213: int (*xClose)(sqlite3_vtab_cursor*);
5214: int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
5215: int argc, sqlite3_value **argv);
5216: int (*xNext)(sqlite3_vtab_cursor*);
5217: int (*xEof)(sqlite3_vtab_cursor*);
5218: int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
5219: int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
5220: int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
5221: int (*xBegin)(sqlite3_vtab *pVTab);
5222: int (*xSync)(sqlite3_vtab *pVTab);
5223: int (*xCommit)(sqlite3_vtab *pVTab);
5224: int (*xRollback)(sqlite3_vtab *pVTab);
5225: int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
5226: void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
5227: void **ppArg);
5228: int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
1.5 ! misha 5229: /* The methods above are in version 1 of the sqlite_module object. Those
! 5230: ** below are for version 2 and greater. */
! 5231: int (*xSavepoint)(sqlite3_vtab *pVTab, int);
! 5232: int (*xRelease)(sqlite3_vtab *pVTab, int);
! 5233: int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
1.2 misha 5234: };
5235:
5236: /*
1.5 ! misha 5237: ** CAPI3REF: Virtual Table Indexing Information
1.4 misha 5238: ** KEYWORDS: sqlite3_index_info
5239: **
1.5 ! misha 5240: ** The sqlite3_index_info structure and its substructures is used as part
! 5241: ** of the [virtual table] interface to
! 5242: ** pass information into and receive the reply from the [xBestIndex]
! 5243: ** method of a [virtual table module]. The fields under **Inputs** are the
1.2 misha 5244: ** inputs to xBestIndex and are read-only. xBestIndex inserts its
5245: ** results into the **Outputs** fields.
5246: **
1.5 ! misha 5247: ** ^(The aConstraint[] array records WHERE clause constraints of the form:
1.2 misha 5248: **
1.5 ! misha 5249: ** <blockquote>column OP expr</blockquote>
1.2 misha 5250: **
1.5 ! misha 5251: ** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is
! 5252: ** stored in aConstraint[].op using one of the
! 5253: ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
! 5254: ** ^(The index of the column is stored in
! 5255: ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
1.2 misha 5256: ** expr on the right-hand side can be evaluated (and thus the constraint
1.5 ! misha 5257: ** is usable) and false if it cannot.)^
1.2 misha 5258: **
1.5 ! misha 5259: ** ^The optimizer automatically inverts terms of the form "expr OP column"
1.2 misha 5260: ** and makes other simplifications to the WHERE clause in an attempt to
5261: ** get as many WHERE clause terms into the form shown above as possible.
1.5 ! misha 5262: ** ^The aConstraint[] array only reports WHERE clause terms that are
! 5263: ** relevant to the particular virtual table being queried.
1.2 misha 5264: **
1.5 ! misha 5265: ** ^Information about the ORDER BY clause is stored in aOrderBy[].
! 5266: ** ^Each term of aOrderBy records a column of the ORDER BY clause.
1.2 misha 5267: **
1.5 ! misha 5268: ** The [xBestIndex] method must fill aConstraintUsage[] with information
! 5269: ** about what parameters to pass to xFilter. ^If argvIndex>0 then
1.2 misha 5270: ** the right-hand side of the corresponding aConstraint[] is evaluated
1.5 ! misha 5271: ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
1.2 misha 5272: ** is true, then the constraint is assumed to be fully handled by the
1.5 ! misha 5273: ** virtual table and is not checked again by SQLite.)^
1.2 misha 5274: **
1.5 ! misha 5275: ** ^The idxNum and idxPtr values are recorded and passed into the
! 5276: ** [xFilter] method.
! 5277: ** ^[sqlite3_free()] is used to free idxPtr if and only if
! 5278: ** needToFreeIdxPtr is true.
1.2 misha 5279: **
1.5 ! misha 5280: ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
1.2 misha 5281: ** the correct order to satisfy the ORDER BY clause so that no separate
5282: ** sorting step is required.
5283: **
1.5 ! misha 5284: ** ^The estimatedCost value is an estimate of the cost of doing the
1.2 misha 5285: ** particular lookup. A full scan of a table with N entries should have
5286: ** a cost of N. A binary search of a table of N entries should have a
5287: ** cost of approximately log(N).
5288: */
5289: struct sqlite3_index_info {
5290: /* Inputs */
5291: int nConstraint; /* Number of entries in aConstraint */
5292: struct sqlite3_index_constraint {
5293: int iColumn; /* Column on left-hand side of constraint */
5294: unsigned char op; /* Constraint operator */
5295: unsigned char usable; /* True if this constraint is usable */
5296: int iTermOffset; /* Used internally - xBestIndex should ignore */
5297: } *aConstraint; /* Table of WHERE clause constraints */
5298: int nOrderBy; /* Number of terms in the ORDER BY clause */
5299: struct sqlite3_index_orderby {
5300: int iColumn; /* Column number */
5301: unsigned char desc; /* True for DESC. False for ASC. */
5302: } *aOrderBy; /* The ORDER BY clause */
5303: /* Outputs */
5304: struct sqlite3_index_constraint_usage {
5305: int argvIndex; /* if >0, constraint is part of argv to xFilter */
5306: unsigned char omit; /* Do not code a test for this constraint */
5307: } *aConstraintUsage;
5308: int idxNum; /* Number used to identify the index */
5309: char *idxStr; /* String, possibly obtained from sqlite3_malloc */
5310: int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
5311: int orderByConsumed; /* True if output is already ordered */
5312: double estimatedCost; /* Estimated cost of using this index */
5313: };
1.5 ! misha 5314:
! 5315: /*
! 5316: ** CAPI3REF: Virtual Table Constraint Operator Codes
! 5317: **
! 5318: ** These macros defined the allowed values for the
! 5319: ** [sqlite3_index_info].aConstraint[].op field. Each value represents
! 5320: ** an operator that is part of a constraint term in the wHERE clause of
! 5321: ** a query that uses a [virtual table].
! 5322: */
1.2 misha 5323: #define SQLITE_INDEX_CONSTRAINT_EQ 2
5324: #define SQLITE_INDEX_CONSTRAINT_GT 4
5325: #define SQLITE_INDEX_CONSTRAINT_LE 8
5326: #define SQLITE_INDEX_CONSTRAINT_LT 16
5327: #define SQLITE_INDEX_CONSTRAINT_GE 32
5328: #define SQLITE_INDEX_CONSTRAINT_MATCH 64
5329:
5330: /*
1.5 ! misha 5331: ** CAPI3REF: Register A Virtual Table Implementation
1.4 misha 5332: **
1.5 ! misha 5333: ** ^These routines are used to register a new [virtual table module] name.
! 5334: ** ^Module names must be registered before
! 5335: ** creating a new [virtual table] using the module and before using a
! 5336: ** preexisting [virtual table] for the module.
! 5337: **
! 5338: ** ^The module name is registered on the [database connection] specified
! 5339: ** by the first parameter. ^The name of the module is given by the
! 5340: ** second parameter. ^The third parameter is a pointer to
! 5341: ** the implementation of the [virtual table module]. ^The fourth
! 5342: ** parameter is an arbitrary client data pointer that is passed through
! 5343: ** into the [xCreate] and [xConnect] methods of the virtual table module
! 5344: ** when a new virtual table is be being created or reinitialized.
! 5345: **
! 5346: ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
! 5347: ** is a pointer to a destructor for the pClientData. ^SQLite will
! 5348: ** invoke the destructor function (if it is not NULL) when SQLite
! 5349: ** no longer needs the pClientData pointer. ^The destructor will also
! 5350: ** be invoked if the call to sqlite3_create_module_v2() fails.
! 5351: ** ^The sqlite3_create_module()
! 5352: ** interface is equivalent to sqlite3_create_module_v2() with a NULL
! 5353: ** destructor.
1.2 misha 5354: */
1.5 ! misha 5355: SQLITE_API int sqlite3_create_module(
1.2 misha 5356: sqlite3 *db, /* SQLite connection to register module with */
5357: const char *zName, /* Name of the module */
1.5 ! misha 5358: const sqlite3_module *p, /* Methods for the module */
! 5359: void *pClientData /* Client data for xCreate/xConnect */
1.2 misha 5360: );
1.5 ! misha 5361: SQLITE_API int sqlite3_create_module_v2(
1.2 misha 5362: sqlite3 *db, /* SQLite connection to register module with */
5363: const char *zName, /* Name of the module */
1.5 ! misha 5364: const sqlite3_module *p, /* Methods for the module */
! 5365: void *pClientData, /* Client data for xCreate/xConnect */
1.2 misha 5366: void(*xDestroy)(void*) /* Module destructor function */
5367: );
5368:
5369: /*
1.5 ! misha 5370: ** CAPI3REF: Virtual Table Instance Object
1.4 misha 5371: ** KEYWORDS: sqlite3_vtab
5372: **
1.5 ! misha 5373: ** Every [virtual table module] implementation uses a subclass
! 5374: ** of this object to describe a particular instance
! 5375: ** of the [virtual table]. Each subclass will
! 5376: ** be tailored to the specific needs of the module implementation.
! 5377: ** The purpose of this superclass is to define certain fields that are
! 5378: ** common to all module implementations.
! 5379: **
! 5380: ** ^Virtual tables methods can set an error message by assigning a
! 5381: ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
! 5382: ** take care that any prior string is freed by a call to [sqlite3_free()]
! 5383: ** prior to assigning a new string to zErrMsg. ^After the error message
1.2 misha 5384: ** is delivered up to the client application, the string will be automatically
1.5 ! misha 5385: ** freed by sqlite3_free() and the zErrMsg field will be zeroed.
1.2 misha 5386: */
5387: struct sqlite3_vtab {
5388: const sqlite3_module *pModule; /* The module for this virtual table */
1.5 ! misha 5389: int nRef; /* NO LONGER USED */
1.2 misha 5390: char *zErrMsg; /* Error message from sqlite3_mprintf() */
5391: /* Virtual table implementations will typically add additional fields */
5392: };
5393:
1.4 misha 5394: /*
1.5 ! misha 5395: ** CAPI3REF: Virtual Table Cursor Object
! 5396: ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
1.4 misha 5397: **
1.5 ! misha 5398: ** Every [virtual table module] implementation uses a subclass of the
! 5399: ** following structure to describe cursors that point into the
! 5400: ** [virtual table] and are used
1.2 misha 5401: ** to loop through the virtual table. Cursors are created using the
1.5 ! misha 5402: ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
! 5403: ** by the [sqlite3_module.xClose | xClose] method. Cursors are used
! 5404: ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
! 5405: ** of the module. Each module implementation will define
1.2 misha 5406: ** the content of a cursor structure to suit its own needs.
5407: **
5408: ** This superclass exists in order to define fields of the cursor that
5409: ** are common to all implementations.
5410: */
5411: struct sqlite3_vtab_cursor {
5412: sqlite3_vtab *pVtab; /* Virtual table of this cursor */
5413: /* Virtual table implementations will typically add additional fields */
5414: };
5415:
5416: /*
1.5 ! misha 5417: ** CAPI3REF: Declare The Schema Of A Virtual Table
1.4 misha 5418: **
1.5 ! misha 5419: ** ^The [xCreate] and [xConnect] methods of a
! 5420: ** [virtual table module] call this interface
1.2 misha 5421: ** to declare the format (the names and datatypes of the columns) of
5422: ** the virtual tables they implement.
5423: */
1.5 ! misha 5424: SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
1.2 misha 5425:
5426: /*
1.5 ! misha 5427: ** CAPI3REF: Overload A Function For A Virtual Table
1.4 misha 5428: **
1.5 ! misha 5429: ** ^(Virtual tables can provide alternative implementations of functions
! 5430: ** using the [xFindFunction] method of the [virtual table module].
! 5431: ** But global versions of those functions
! 5432: ** must exist in order to be overloaded.)^
1.2 misha 5433: **
1.5 ! misha 5434: ** ^(This API makes sure a global version of a function with a particular
1.2 misha 5435: ** name and number of parameters exists. If no such function exists
1.5 ! misha 5436: ** before this API is called, a new function is created.)^ ^The implementation
1.2 misha 5437: ** of the new function always causes an exception to be thrown. So
5438: ** the new function is not good for anything by itself. Its only
1.5 ! misha 5439: ** purpose is to be a placeholder function that can be overloaded
! 5440: ** by a [virtual table].
1.2 misha 5441: */
1.5 ! misha 5442: SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
1.2 misha 5443:
5444: /*
5445: ** The interface to the virtual-table mechanism defined above (back up
5446: ** to a comment remarkably similar to this one) is currently considered
5447: ** to be experimental. The interface might change in incompatible ways.
5448: ** If this is a problem for you, do not use the interface at this time.
5449: **
5450: ** When the virtual-table mechanism stabilizes, we will declare the
5451: ** interface fixed, support it indefinitely, and remove this comment.
5452: */
5453:
5454: /*
1.5 ! misha 5455: ** CAPI3REF: A Handle To An Open BLOB
! 5456: ** KEYWORDS: {BLOB handle} {BLOB handles}
1.2 misha 5457: **
1.4 misha 5458: ** An instance of this object represents an open BLOB on which
1.5 ! misha 5459: ** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
! 5460: ** ^Objects of this type are created by [sqlite3_blob_open()]
! 5461: ** and destroyed by [sqlite3_blob_close()].
! 5462: ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
! 5463: ** can be used to read or write small subsections of the BLOB.
! 5464: ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
1.2 misha 5465: */
5466: typedef struct sqlite3_blob sqlite3_blob;
5467:
5468: /*
1.5 ! misha 5469: ** CAPI3REF: Open A BLOB For Incremental I/O
1.2 misha 5470: **
1.5 ! misha 5471: ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
! 5472: ** in row iRow, column zColumn, table zTable in database zDb;
! 5473: ** in other words, the same BLOB that would be selected by:
1.2 misha 5474: **
5475: ** <pre>
1.5 ! misha 5476: ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
! 5477: ** </pre>)^
1.4 misha 5478: **
1.5 ! misha 5479: ** ^If the flags parameter is non-zero, then the BLOB is opened for read
! 5480: ** and write access. ^If it is zero, the BLOB is opened for read access.
! 5481: ** ^It is not possible to open a column that is part of an index or primary
! 5482: ** key for writing. ^If [foreign key constraints] are enabled, it is
! 5483: ** not possible to open a column that is part of a [child key] for writing.
! 5484: **
! 5485: ** ^Note that the database name is not the filename that contains
! 5486: ** the database but rather the symbolic name of the database that
! 5487: ** appears after the AS keyword when the database is connected using [ATTACH].
! 5488: ** ^For the main database file, the database name is "main".
! 5489: ** ^For TEMP tables, the database name is "temp".
! 5490: **
! 5491: ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
! 5492: ** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
! 5493: ** to be a null pointer.)^
! 5494: ** ^This function sets the [database connection] error code and message
! 5495: ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
! 5496: ** functions. ^Note that the *ppBlob variable is always initialized in a
! 5497: ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
! 5498: ** regardless of the success or failure of this routine.
! 5499: **
! 5500: ** ^(If the row that a BLOB handle points to is modified by an
! 5501: ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
! 5502: ** then the BLOB handle is marked as "expired".
! 5503: ** This is true if any column of the row is changed, even a column
! 5504: ** other than the one the BLOB handle is open on.)^
! 5505: ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
! 5506: ** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
! 5507: ** ^(Changes written into a BLOB prior to the BLOB expiring are not
! 5508: ** rolled back by the expiration of the BLOB. Such changes will eventually
! 5509: ** commit if the transaction continues to completion.)^
! 5510: **
! 5511: ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
! 5512: ** the opened blob. ^The size of a blob may not be changed by this
! 5513: ** interface. Use the [UPDATE] SQL command to change the size of a
! 5514: ** blob.
! 5515: **
! 5516: ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
! 5517: ** and the built-in [zeroblob] SQL function can be used, if desired,
! 5518: ** to create an empty, zero-filled blob in which to read or write using
! 5519: ** this interface.
1.4 misha 5520: **
1.5 ! misha 5521: ** To avoid a resource leak, every open [BLOB handle] should eventually
! 5522: ** be released by a call to [sqlite3_blob_close()].
1.2 misha 5523: */
1.5 ! misha 5524: SQLITE_API int sqlite3_blob_open(
1.2 misha 5525: sqlite3*,
5526: const char *zDb,
5527: const char *zTable,
5528: const char *zColumn,
5529: sqlite3_int64 iRow,
5530: int flags,
5531: sqlite3_blob **ppBlob
5532: );
5533:
5534: /*
1.5 ! misha 5535: ** CAPI3REF: Move a BLOB Handle to a New Row
! 5536: **
! 5537: ** ^This function is used to move an existing blob handle so that it points
! 5538: ** to a different row of the same database table. ^The new row is identified
! 5539: ** by the rowid value passed as the second argument. Only the row can be
! 5540: ** changed. ^The database, table and column on which the blob handle is open
! 5541: ** remain the same. Moving an existing blob handle to a new row can be
! 5542: ** faster than closing the existing handle and opening a new one.
1.2 misha 5543: **
1.5 ! misha 5544: ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
! 5545: ** it must exist and there must be either a blob or text value stored in
! 5546: ** the nominated column.)^ ^If the new row is not present in the table, or if
! 5547: ** it does not contain a blob or text value, or if another error occurs, an
! 5548: ** SQLite error code is returned and the blob handle is considered aborted.
! 5549: ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
! 5550: ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
! 5551: ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
! 5552: ** always returns zero.
1.4 misha 5553: **
1.5 ! misha 5554: ** ^This function sets the database handle error code and message.
! 5555: */
! 5556: SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
! 5557:
! 5558: /*
! 5559: ** CAPI3REF: Close A BLOB Handle
1.4 misha 5560: **
1.5 ! misha 5561: ** ^Closes an open [BLOB handle].
1.4 misha 5562: **
1.5 ! misha 5563: ** ^Closing a BLOB shall cause the current transaction to commit
! 5564: ** if there are no other BLOBs, no pending prepared statements, and the
! 5565: ** database connection is in [autocommit mode].
! 5566: ** ^If any writes were made to the BLOB, they might be held in cache
! 5567: ** until the close operation if they will fit.
1.4 misha 5568: **
1.5 ! misha 5569: ** ^(Closing the BLOB often forces the changes
! 5570: ** out to disk and so if any I/O errors occur, they will likely occur
! 5571: ** at the time when the BLOB is closed. Any errors that occur during
! 5572: ** closing are reported as a non-zero return value.)^
1.4 misha 5573: **
1.5 ! misha 5574: ** ^(The BLOB is closed unconditionally. Even if this routine returns
! 5575: ** an error code, the BLOB is still closed.)^
1.4 misha 5576: **
1.5 ! misha 5577: ** ^Calling this routine with a null pointer (such as would be returned
! 5578: ** by a failed call to [sqlite3_blob_open()]) is a harmless no-op.
1.2 misha 5579: */
1.5 ! misha 5580: SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
1.2 misha 5581:
5582: /*
1.5 ! misha 5583: ** CAPI3REF: Return The Size Of An Open BLOB
1.4 misha 5584: **
1.5 ! misha 5585: ** ^Returns the size in bytes of the BLOB accessible via the
! 5586: ** successfully opened [BLOB handle] in its only argument. ^The
! 5587: ** incremental blob I/O routines can only read or overwriting existing
! 5588: ** blob content; they cannot change the size of a blob.
1.4 misha 5589: **
1.5 ! misha 5590: ** This routine only works on a [BLOB handle] which has been created
! 5591: ** by a prior successful call to [sqlite3_blob_open()] and which has not
! 5592: ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
! 5593: ** to this routine results in undefined and probably undesirable behavior.
1.2 misha 5594: */
1.5 ! misha 5595: SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
1.2 misha 5596:
5597: /*
1.5 ! misha 5598: ** CAPI3REF: Read Data From A BLOB Incrementally
1.2 misha 5599: **
1.5 ! misha 5600: ** ^(This function is used to read data from an open [BLOB handle] into a
! 5601: ** caller-supplied buffer. N bytes of data are copied into buffer Z
! 5602: ** from the open BLOB, starting at offset iOffset.)^
1.4 misha 5603: **
1.5 ! misha 5604: ** ^If offset iOffset is less than N bytes from the end of the BLOB,
! 5605: ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
! 5606: ** less than zero, [SQLITE_ERROR] is returned and no data is read.
! 5607: ** ^The size of the blob (and hence the maximum value of N+iOffset)
! 5608: ** can be determined using the [sqlite3_blob_bytes()] interface.
1.4 misha 5609: **
1.5 ! misha 5610: ** ^An attempt to read from an expired [BLOB handle] fails with an
! 5611: ** error code of [SQLITE_ABORT].
1.4 misha 5612: **
1.5 ! misha 5613: ** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
! 5614: ** Otherwise, an [error code] or an [extended error code] is returned.)^
1.4 misha 5615: **
1.5 ! misha 5616: ** This routine only works on a [BLOB handle] which has been created
! 5617: ** by a prior successful call to [sqlite3_blob_open()] and which has not
! 5618: ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
! 5619: ** to this routine results in undefined and probably undesirable behavior.
1.4 misha 5620: **
1.5 ! misha 5621: ** See also: [sqlite3_blob_write()].
1.1 misha 5622: */
1.5 ! misha 5623: SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
1.2 misha 5624:
5625: /*
1.5 ! misha 5626: ** CAPI3REF: Write Data Into A BLOB Incrementally
1.2 misha 5627: **
1.5 ! misha 5628: ** ^This function is used to write data into an open [BLOB handle] from a
! 5629: ** caller-supplied buffer. ^N bytes of data are copied from the buffer Z
! 5630: ** into the open BLOB, starting at offset iOffset.
1.2 misha 5631: **
1.5 ! misha 5632: ** ^If the [BLOB handle] passed as the first argument was not opened for
! 5633: ** writing (the flags parameter to [sqlite3_blob_open()] was zero),
! 5634: ** this function returns [SQLITE_READONLY].
1.2 misha 5635: **
1.5 ! misha 5636: ** ^This function may only modify the contents of the BLOB; it is
! 5637: ** not possible to increase the size of a BLOB using this API.
! 5638: ** ^If offset iOffset is less than N bytes from the end of the BLOB,
! 5639: ** [SQLITE_ERROR] is returned and no data is written. ^If N is
1.4 misha 5640: ** less than zero [SQLITE_ERROR] is returned and no data is written.
1.5 ! misha 5641: ** The size of the BLOB (and hence the maximum value of N+iOffset)
! 5642: ** can be determined using the [sqlite3_blob_bytes()] interface.
1.2 misha 5643: **
1.5 ! misha 5644: ** ^An attempt to write to an expired [BLOB handle] fails with an
! 5645: ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
! 5646: ** before the [BLOB handle] expired are not rolled back by the
! 5647: ** expiration of the handle, though of course those changes might
! 5648: ** have been overwritten by the statement that expired the BLOB handle
! 5649: ** or by other independent statements.
1.4 misha 5650: **
1.5 ! misha 5651: ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
! 5652: ** Otherwise, an [error code] or an [extended error code] is returned.)^
1.4 misha 5653: **
1.5 ! misha 5654: ** This routine only works on a [BLOB handle] which has been created
! 5655: ** by a prior successful call to [sqlite3_blob_open()] and which has not
! 5656: ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
! 5657: ** to this routine results in undefined and probably undesirable behavior.
1.4 misha 5658: **
1.5 ! misha 5659: ** See also: [sqlite3_blob_read()].
1.2 misha 5660: */
1.5 ! misha 5661: SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
1.2 misha 5662:
5663: /*
1.5 ! misha 5664: ** CAPI3REF: Virtual File System Objects
1.2 misha 5665: **
5666: ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
5667: ** that SQLite uses to interact
1.4 misha 5668: ** with the underlying operating system. Most SQLite builds come with a
1.2 misha 5669: ** single default VFS that is appropriate for the host computer.
5670: ** New VFSes can be registered and existing VFSes can be unregistered.
5671: ** The following interfaces are provided.
5672: **
1.5 ! misha 5673: ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
! 5674: ** ^Names are case sensitive.
! 5675: ** ^Names are zero-terminated UTF-8 strings.
! 5676: ** ^If there is no match, a NULL pointer is returned.
! 5677: ** ^If zVfsName is NULL then the default VFS is returned.
! 5678: **
! 5679: ** ^New VFSes are registered with sqlite3_vfs_register().
! 5680: ** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
! 5681: ** ^The same VFS can be registered multiple times without injury.
! 5682: ** ^To make an existing VFS into the default VFS, register it again
1.2 misha 5683: ** with the makeDflt flag set. If two different VFSes with the
5684: ** same name are registered, the behavior is undefined. If a
5685: ** VFS is registered with a name that is NULL or an empty string,
5686: ** then the behavior is undefined.
1.4 misha 5687: **
1.5 ! misha 5688: ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
! 5689: ** ^(If the default VFS is unregistered, another VFS is chosen as
! 5690: ** the default. The choice for the new VFS is arbitrary.)^
1.2 misha 5691: */
1.5 ! misha 5692: SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
! 5693: SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
! 5694: SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
1.2 misha 5695:
5696: /*
1.5 ! misha 5697: ** CAPI3REF: Mutexes
1.2 misha 5698: **
5699: ** The SQLite core uses these routines for thread
1.5 ! misha 5700: ** synchronization. Though they are intended for internal
1.2 misha 5701: ** use by SQLite, code that links against SQLite is
5702: ** permitted to use any of these routines.
5703: **
1.5 ! misha 5704: ** The SQLite source code contains multiple implementations
1.2 misha 5705: ** of these mutex routines. An appropriate implementation
1.5 ! misha 5706: ** is selected automatically at compile-time. ^(The following
1.2 misha 5707: ** implementations are available in the SQLite core:
5708: **
5709: ** <ul>
1.5 ! misha 5710: ** <li> SQLITE_MUTEX_PTHREADS
1.2 misha 5711: ** <li> SQLITE_MUTEX_W32
5712: ** <li> SQLITE_MUTEX_NOOP
1.5 ! misha 5713: ** </ul>)^
! 5714: **
! 5715: ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines
! 5716: ** that does no real locking and is appropriate for use in
! 5717: ** a single-threaded application. ^The SQLITE_MUTEX_PTHREADS and
! 5718: ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
! 5719: ** and Windows.
1.2 misha 5720: **
1.5 ! misha 5721: ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
1.2 misha 5722: ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
1.5 ! misha 5723: ** implementation is included with the library. In this case the
! 5724: ** application must supply a custom mutex implementation using the
! 5725: ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
! 5726: ** before calling sqlite3_initialize() or any other public sqlite3_
! 5727: ** function that calls sqlite3_initialize().)^
! 5728: **
! 5729: ** ^The sqlite3_mutex_alloc() routine allocates a new
! 5730: ** mutex and returns a pointer to it. ^If it returns NULL
! 5731: ** that means that a mutex could not be allocated. ^SQLite
! 5732: ** will unwind its stack and return an error. ^(The argument
1.2 misha 5733: ** to sqlite3_mutex_alloc() is one of these integer constants:
5734: **
5735: ** <ul>
5736: ** <li> SQLITE_MUTEX_FAST
5737: ** <li> SQLITE_MUTEX_RECURSIVE
5738: ** <li> SQLITE_MUTEX_STATIC_MASTER
5739: ** <li> SQLITE_MUTEX_STATIC_MEM
5740: ** <li> SQLITE_MUTEX_STATIC_MEM2
5741: ** <li> SQLITE_MUTEX_STATIC_PRNG
5742: ** <li> SQLITE_MUTEX_STATIC_LRU
1.5 ! misha 5743: ** <li> SQLITE_MUTEX_STATIC_LRU2
! 5744: ** </ul>)^
1.2 misha 5745: **
1.5 ! misha 5746: ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
! 5747: ** cause sqlite3_mutex_alloc() to create
! 5748: ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
! 5749: ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
1.2 misha 5750: ** The mutex implementation does not need to make a distinction
5751: ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
1.5 ! misha 5752: ** not want to. ^SQLite will only request a recursive mutex in
! 5753: ** cases where it really needs one. ^If a faster non-recursive mutex
1.2 misha 5754: ** implementation is available on the host platform, the mutex subsystem
5755: ** might return such a mutex in response to SQLITE_MUTEX_FAST.
5756: **
1.5 ! misha 5757: ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
! 5758: ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
! 5759: ** a pointer to a static preexisting mutex. ^Six static mutexes are
1.2 misha 5760: ** used by the current version of SQLite. Future versions of SQLite
5761: ** may add additional static mutexes. Static mutexes are for internal
5762: ** use by SQLite only. Applications that use SQLite mutexes should
5763: ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
5764: ** SQLITE_MUTEX_RECURSIVE.
5765: **
1.5 ! misha 5766: ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
1.2 misha 5767: ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
1.5 ! misha 5768: ** returns a different mutex on every call. ^But for the static
1.2 misha 5769: ** mutex types, the same mutex is returned on every call that has
1.5 ! misha 5770: ** the same type number.
1.2 misha 5771: **
1.5 ! misha 5772: ** ^The sqlite3_mutex_free() routine deallocates a previously
! 5773: ** allocated dynamic mutex. ^SQLite is careful to deallocate every
! 5774: ** dynamic mutex that it allocates. The dynamic mutexes must not be in
! 5775: ** use when they are deallocated. Attempting to deallocate a static
! 5776: ** mutex results in undefined behavior. ^SQLite never deallocates
! 5777: ** a static mutex.
1.2 misha 5778: **
1.5 ! misha 5779: ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
! 5780: ** to enter a mutex. ^If another thread is already within the mutex,
1.2 misha 5781: ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
1.5 ! misha 5782: ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
! 5783: ** upon successful entry. ^(Mutexes created using
1.4 misha 5784: ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
1.5 ! misha 5785: ** In such cases the,
1.2 misha 5786: ** mutex must be exited an equal number of times before another thread
1.5 ! misha 5787: ** can enter.)^ ^(If the same thread tries to enter any other
1.4 misha 5788: ** kind of mutex more than once, the behavior is undefined.
1.5 ! misha 5789: ** SQLite will never exhibit
! 5790: ** such behavior in its own use of mutexes.)^
1.2 misha 5791: **
1.5 ! misha 5792: ** ^(Some systems (for example, Windows 95) do not support the operation
! 5793: ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
! 5794: ** will always return SQLITE_BUSY. The SQLite core only ever uses
! 5795: ** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^
1.2 misha 5796: **
1.5 ! misha 5797: ** ^The sqlite3_mutex_leave() routine exits a mutex that was
! 5798: ** previously entered by the same thread. ^(The behavior
1.2 misha 5799: ** is undefined if the mutex is not currently entered by the
1.5 ! misha 5800: ** calling thread or is not currently allocated. SQLite will
! 5801: ** never do either.)^
! 5802: **
! 5803: ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
! 5804: ** sqlite3_mutex_leave() is a NULL pointer, then all three routines
! 5805: ** behave as no-ops.
1.2 misha 5806: **
5807: ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
5808: */
1.5 ! misha 5809: SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
! 5810: SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
! 5811: SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
! 5812: SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
! 5813: SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
! 5814:
! 5815: /*
! 5816: ** CAPI3REF: Mutex Methods Object
! 5817: **
! 5818: ** An instance of this structure defines the low-level routines
! 5819: ** used to allocate and use mutexes.
! 5820: **
! 5821: ** Usually, the default mutex implementations provided by SQLite are
! 5822: ** sufficient, however the user has the option of substituting a custom
! 5823: ** implementation for specialized deployments or systems for which SQLite
! 5824: ** does not provide a suitable implementation. In this case, the user
! 5825: ** creates and populates an instance of this structure to pass
! 5826: ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
! 5827: ** Additionally, an instance of this structure can be used as an
! 5828: ** output variable when querying the system for the current mutex
! 5829: ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
! 5830: **
! 5831: ** ^The xMutexInit method defined by this structure is invoked as
! 5832: ** part of system initialization by the sqlite3_initialize() function.
! 5833: ** ^The xMutexInit routine is called by SQLite exactly once for each
! 5834: ** effective call to [sqlite3_initialize()].
! 5835: **
! 5836: ** ^The xMutexEnd method defined by this structure is invoked as
! 5837: ** part of system shutdown by the sqlite3_shutdown() function. The
! 5838: ** implementation of this method is expected to release all outstanding
! 5839: ** resources obtained by the mutex methods implementation, especially
! 5840: ** those obtained by the xMutexInit method. ^The xMutexEnd()
! 5841: ** interface is invoked exactly once for each call to [sqlite3_shutdown()].
! 5842: **
! 5843: ** ^(The remaining seven methods defined by this structure (xMutexAlloc,
! 5844: ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
! 5845: ** xMutexNotheld) implement the following interfaces (respectively):
! 5846: **
! 5847: ** <ul>
! 5848: ** <li> [sqlite3_mutex_alloc()] </li>
! 5849: ** <li> [sqlite3_mutex_free()] </li>
! 5850: ** <li> [sqlite3_mutex_enter()] </li>
! 5851: ** <li> [sqlite3_mutex_try()] </li>
! 5852: ** <li> [sqlite3_mutex_leave()] </li>
! 5853: ** <li> [sqlite3_mutex_held()] </li>
! 5854: ** <li> [sqlite3_mutex_notheld()] </li>
! 5855: ** </ul>)^
! 5856: **
! 5857: ** The only difference is that the public sqlite3_XXX functions enumerated
! 5858: ** above silently ignore any invocations that pass a NULL pointer instead
! 5859: ** of a valid mutex handle. The implementations of the methods defined
! 5860: ** by this structure are not required to handle this case, the results
! 5861: ** of passing a NULL pointer instead of a valid mutex handle are undefined
! 5862: ** (i.e. it is acceptable to provide an implementation that segfaults if
! 5863: ** it is passed a NULL pointer).
! 5864: **
! 5865: ** The xMutexInit() method must be threadsafe. ^It must be harmless to
! 5866: ** invoke xMutexInit() multiple times within the same process and without
! 5867: ** intervening calls to xMutexEnd(). Second and subsequent calls to
! 5868: ** xMutexInit() must be no-ops.
! 5869: **
! 5870: ** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
! 5871: ** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory
! 5872: ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
! 5873: ** memory allocation for a fast or recursive mutex.
! 5874: **
! 5875: ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
! 5876: ** called, but only if the prior call to xMutexInit returned SQLITE_OK.
! 5877: ** If xMutexInit fails in any way, it is expected to clean up after itself
! 5878: ** prior to returning.
! 5879: */
! 5880: typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
! 5881: struct sqlite3_mutex_methods {
! 5882: int (*xMutexInit)(void);
! 5883: int (*xMutexEnd)(void);
! 5884: sqlite3_mutex *(*xMutexAlloc)(int);
! 5885: void (*xMutexFree)(sqlite3_mutex *);
! 5886: void (*xMutexEnter)(sqlite3_mutex *);
! 5887: int (*xMutexTry)(sqlite3_mutex *);
! 5888: void (*xMutexLeave)(sqlite3_mutex *);
! 5889: int (*xMutexHeld)(sqlite3_mutex *);
! 5890: int (*xMutexNotheld)(sqlite3_mutex *);
! 5891: };
1.2 misha 5892:
5893: /*
1.5 ! misha 5894: ** CAPI3REF: Mutex Verification Routines
1.2 misha 5895: **
5896: ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
1.5 ! misha 5897: ** are intended for use inside assert() statements. ^The SQLite core
1.2 misha 5898: ** never uses these routines except inside an assert() and applications
1.5 ! misha 5899: ** are advised to follow the lead of the core. ^The SQLite core only
1.2 misha 5900: ** provides implementations for these routines when it is compiled
1.5 ! misha 5901: ** with the SQLITE_DEBUG flag. ^External mutex implementations
1.2 misha 5902: ** are only required to provide these routines if SQLITE_DEBUG is
5903: ** defined and if NDEBUG is not defined.
5904: **
1.5 ! misha 5905: ** ^These routines should return true if the mutex in their argument
! 5906: ** is held or not held, respectively, by the calling thread.
1.2 misha 5907: **
1.5 ! misha 5908: ** ^The implementation is not required to provide versions of these
! 5909: ** routines that actually work. If the implementation does not provide working
! 5910: ** versions of these routines, it should at least provide stubs that always
! 5911: ** return true so that one does not get spurious assertion failures.
! 5912: **
! 5913: ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then
! 5914: ** the routine should return 1. This seems counter-intuitive since
! 5915: ** clearly the mutex cannot be held if it does not exist. But
1.2 misha 5916: ** the reason the mutex does not exist is because the build is not
5917: ** using mutexes. And we do not want the assert() containing the
5918: ** call to sqlite3_mutex_held() to fail, so a non-zero return is
1.5 ! misha 5919: ** the appropriate thing to do. ^The sqlite3_mutex_notheld()
1.2 misha 5920: ** interface should also return 1 when given a NULL pointer.
5921: */
1.5 ! misha 5922: #ifndef NDEBUG
! 5923: SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
! 5924: SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
! 5925: #endif
1.2 misha 5926:
5927: /*
1.5 ! misha 5928: ** CAPI3REF: Mutex Types
! 5929: **
! 5930: ** The [sqlite3_mutex_alloc()] interface takes a single argument
! 5931: ** which is one of these integer constants.
1.2 misha 5932: **
1.5 ! misha 5933: ** The set of static mutexes may change from one SQLite release to the
! 5934: ** next. Applications that override the built-in mutex logic must be
! 5935: ** prepared to accommodate additional static mutexes.
1.2 misha 5936: */
5937: #define SQLITE_MUTEX_FAST 0
5938: #define SQLITE_MUTEX_RECURSIVE 1
5939: #define SQLITE_MUTEX_STATIC_MASTER 2
5940: #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
1.5 ! misha 5941: #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
! 5942: #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
1.2 misha 5943: #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
5944: #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
1.5 ! misha 5945: #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
! 5946: #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
! 5947:
! 5948: /*
! 5949: ** CAPI3REF: Retrieve the mutex for a database connection
! 5950: **
! 5951: ** ^This interface returns a pointer the [sqlite3_mutex] object that
! 5952: ** serializes access to the [database connection] given in the argument
! 5953: ** when the [threading mode] is Serialized.
! 5954: ** ^If the [threading mode] is Single-thread or Multi-thread then this
! 5955: ** routine returns a NULL pointer.
! 5956: */
! 5957: SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
1.2 misha 5958:
5959: /*
1.5 ! misha 5960: ** CAPI3REF: Low-Level Control Of Database Files
1.2 misha 5961: **
1.5 ! misha 5962: ** ^The [sqlite3_file_control()] interface makes a direct call to the
1.2 misha 5963: ** xFileControl method for the [sqlite3_io_methods] object associated
1.5 ! misha 5964: ** with a particular database identified by the second argument. ^The
! 5965: ** name of the database is "main" for the main database or "temp" for the
! 5966: ** TEMP database, or the name that appears after the AS keyword for
! 5967: ** databases that are added using the [ATTACH] SQL command.
! 5968: ** ^A NULL pointer can be used in place of "main" to refer to the
! 5969: ** main database file.
! 5970: ** ^The third and fourth parameters to this routine
1.2 misha 5971: ** are passed directly through to the second and third parameters of
1.5 ! misha 5972: ** the xFileControl method. ^The return value of the xFileControl
1.2 misha 5973: ** method becomes the return value of this routine.
5974: **
1.5 ! misha 5975: ** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes
! 5976: ** a pointer to the underlying [sqlite3_file] object to be written into
! 5977: ** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER
! 5978: ** case is a short-circuit path which does not actually invoke the
! 5979: ** underlying sqlite3_io_methods.xFileControl method.
! 5980: **
! 5981: ** ^If the second parameter (zDbName) does not match the name of any
! 5982: ** open database file, then SQLITE_ERROR is returned. ^This error
1.2 misha 5983: ** code is not remembered and will not be recalled by [sqlite3_errcode()]
1.5 ! misha 5984: ** or [sqlite3_errmsg()]. The underlying xFileControl method might
! 5985: ** also return SQLITE_ERROR. There is no way to distinguish between
1.2 misha 5986: ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
1.5 ! misha 5987: ** xFileControl method.
1.2 misha 5988: **
5989: ** See also: [SQLITE_FCNTL_LOCKSTATE]
5990: */
1.5 ! misha 5991: SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
1.2 misha 5992:
5993: /*
1.5 ! misha 5994: ** CAPI3REF: Testing Interface
1.4 misha 5995: **
1.5 ! misha 5996: ** ^The sqlite3_test_control() interface is used to read out internal
1.4 misha 5997: ** state of SQLite and to inject faults into SQLite for testing
1.5 ! misha 5998: ** purposes. ^The first parameter is an operation code that determines
1.4 misha 5999: ** the number, meaning, and operation of all subsequent parameters.
6000: **
6001: ** This interface is not for use by applications. It exists solely
6002: ** for verifying the correct operation of the SQLite library. Depending
6003: ** on how the SQLite library is compiled, this interface might not exist.
6004: **
6005: ** The details of the operation codes, their meanings, the parameters
6006: ** they take, and what they do are all subject to change without notice.
6007: ** Unlike most of the SQLite API, this function is not guaranteed to
6008: ** operate consistently from one release to the next.
6009: */
1.5 ! misha 6010: SQLITE_API int sqlite3_test_control(int op, ...);
1.4 misha 6011:
6012: /*
1.5 ! misha 6013: ** CAPI3REF: Testing Interface Operation Codes
1.4 misha 6014: **
6015: ** These constants are the valid operation code parameters used
6016: ** as the first argument to [sqlite3_test_control()].
6017: **
1.5 ! misha 6018: ** These parameters and their meanings are subject to change
1.4 misha 6019: ** without notice. These values are for testing purposes only.
6020: ** Applications should not use any of these parameters or the
6021: ** [sqlite3_test_control()] interface.
6022: */
1.5 ! misha 6023: #define SQLITE_TESTCTRL_FIRST 5
! 6024: #define SQLITE_TESTCTRL_PRNG_SAVE 5
! 6025: #define SQLITE_TESTCTRL_PRNG_RESTORE 6
! 6026: #define SQLITE_TESTCTRL_PRNG_RESET 7
! 6027: #define SQLITE_TESTCTRL_BITVEC_TEST 8
! 6028: #define SQLITE_TESTCTRL_FAULT_INSTALL 9
! 6029: #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
! 6030: #define SQLITE_TESTCTRL_PENDING_BYTE 11
! 6031: #define SQLITE_TESTCTRL_ASSERT 12
! 6032: #define SQLITE_TESTCTRL_ALWAYS 13
! 6033: #define SQLITE_TESTCTRL_RESERVE 14
! 6034: #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
! 6035: #define SQLITE_TESTCTRL_ISKEYWORD 16
! 6036: #define SQLITE_TESTCTRL_SCRATCHMALLOC 17
! 6037: #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
! 6038: #define SQLITE_TESTCTRL_EXPLAIN_STMT 19
! 6039: #define SQLITE_TESTCTRL_LAST 19
! 6040:
! 6041: /*
! 6042: ** CAPI3REF: SQLite Runtime Status
! 6043: **
! 6044: ** ^This interface is used to retrieve runtime status information
! 6045: ** about the performance of SQLite, and optionally to reset various
! 6046: ** highwater marks. ^The first argument is an integer code for
! 6047: ** the specific parameter to measure. ^(Recognized integer codes
! 6048: ** are of the form [status parameters | SQLITE_STATUS_...].)^
! 6049: ** ^The current value of the parameter is returned into *pCurrent.
! 6050: ** ^The highest recorded value is returned in *pHighwater. ^If the
! 6051: ** resetFlag is true, then the highest record value is reset after
! 6052: ** *pHighwater is written. ^(Some parameters do not record the highest
! 6053: ** value. For those parameters
! 6054: ** nothing is written into *pHighwater and the resetFlag is ignored.)^
! 6055: ** ^(Other parameters record only the highwater mark and not the current
! 6056: ** value. For these latter parameters nothing is written into *pCurrent.)^
! 6057: **
! 6058: ** ^The sqlite3_status() routine returns SQLITE_OK on success and a
! 6059: ** non-zero [error code] on failure.
! 6060: **
! 6061: ** This routine is threadsafe but is not atomic. This routine can be
! 6062: ** called while other threads are running the same or different SQLite
! 6063: ** interfaces. However the values returned in *pCurrent and
! 6064: ** *pHighwater reflect the status of SQLite at different points in time
! 6065: ** and it is possible that another thread might change the parameter
! 6066: ** in between the times when *pCurrent and *pHighwater are written.
! 6067: **
! 6068: ** See also: [sqlite3_db_status()]
! 6069: */
! 6070: SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
! 6071:
! 6072:
! 6073: /*
! 6074: ** CAPI3REF: Status Parameters
! 6075: ** KEYWORDS: {status parameters}
! 6076: **
! 6077: ** These integer constants designate various run-time status parameters
! 6078: ** that can be returned by [sqlite3_status()].
! 6079: **
! 6080: ** <dl>
! 6081: ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
! 6082: ** <dd>This parameter is the current amount of memory checked out
! 6083: ** using [sqlite3_malloc()], either directly or indirectly. The
! 6084: ** figure includes calls made to [sqlite3_malloc()] by the application
! 6085: ** and internal memory usage by the SQLite library. Scratch memory
! 6086: ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
! 6087: ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
! 6088: ** this parameter. The amount returned is the sum of the allocation
! 6089: ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
! 6090: **
! 6091: ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
! 6092: ** <dd>This parameter records the largest memory allocation request
! 6093: ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
! 6094: ** internal equivalents). Only the value returned in the
! 6095: ** *pHighwater parameter to [sqlite3_status()] is of interest.
! 6096: ** The value written into the *pCurrent parameter is undefined.</dd>)^
! 6097: **
! 6098: ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
! 6099: ** <dd>This parameter records the number of separate memory allocations
! 6100: ** currently checked out.</dd>)^
! 6101: **
! 6102: ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
! 6103: ** <dd>This parameter returns the number of pages used out of the
! 6104: ** [pagecache memory allocator] that was configured using
! 6105: ** [SQLITE_CONFIG_PAGECACHE]. The
! 6106: ** value returned is in pages, not in bytes.</dd>)^
! 6107: **
! 6108: ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
! 6109: ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
! 6110: ** <dd>This parameter returns the number of bytes of page cache
! 6111: ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
! 6112: ** buffer and where forced to overflow to [sqlite3_malloc()]. The
! 6113: ** returned value includes allocations that overflowed because they
! 6114: ** where too large (they were larger than the "sz" parameter to
! 6115: ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
! 6116: ** no space was left in the page cache.</dd>)^
! 6117: **
! 6118: ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
! 6119: ** <dd>This parameter records the largest memory allocation request
! 6120: ** handed to [pagecache memory allocator]. Only the value returned in the
! 6121: ** *pHighwater parameter to [sqlite3_status()] is of interest.
! 6122: ** The value written into the *pCurrent parameter is undefined.</dd>)^
! 6123: **
! 6124: ** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
! 6125: ** <dd>This parameter returns the number of allocations used out of the
! 6126: ** [scratch memory allocator] configured using
! 6127: ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
! 6128: ** in bytes. Since a single thread may only have one scratch allocation
! 6129: ** outstanding at time, this parameter also reports the number of threads
! 6130: ** using scratch memory at the same time.</dd>)^
! 6131: **
! 6132: ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
! 6133: ** <dd>This parameter returns the number of bytes of scratch memory
! 6134: ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
! 6135: ** buffer and where forced to overflow to [sqlite3_malloc()]. The values
! 6136: ** returned include overflows because the requested allocation was too
! 6137: ** larger (that is, because the requested allocation was larger than the
! 6138: ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
! 6139: ** slots were available.
! 6140: ** </dd>)^
! 6141: **
! 6142: ** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
! 6143: ** <dd>This parameter records the largest memory allocation request
! 6144: ** handed to [scratch memory allocator]. Only the value returned in the
! 6145: ** *pHighwater parameter to [sqlite3_status()] is of interest.
! 6146: ** The value written into the *pCurrent parameter is undefined.</dd>)^
! 6147: **
! 6148: ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
! 6149: ** <dd>This parameter records the deepest parser stack. It is only
! 6150: ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
! 6151: ** </dl>
! 6152: **
! 6153: ** New status parameters may be added from time to time.
! 6154: */
! 6155: #define SQLITE_STATUS_MEMORY_USED 0
! 6156: #define SQLITE_STATUS_PAGECACHE_USED 1
! 6157: #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
! 6158: #define SQLITE_STATUS_SCRATCH_USED 3
! 6159: #define SQLITE_STATUS_SCRATCH_OVERFLOW 4
! 6160: #define SQLITE_STATUS_MALLOC_SIZE 5
! 6161: #define SQLITE_STATUS_PARSER_STACK 6
! 6162: #define SQLITE_STATUS_PAGECACHE_SIZE 7
! 6163: #define SQLITE_STATUS_SCRATCH_SIZE 8
! 6164: #define SQLITE_STATUS_MALLOC_COUNT 9
! 6165:
! 6166: /*
! 6167: ** CAPI3REF: Database Connection Status
! 6168: **
! 6169: ** ^This interface is used to retrieve runtime status information
! 6170: ** about a single [database connection]. ^The first argument is the
! 6171: ** database connection object to be interrogated. ^The second argument
! 6172: ** is an integer constant, taken from the set of
! 6173: ** [SQLITE_DBSTATUS options], that
! 6174: ** determines the parameter to interrogate. The set of
! 6175: ** [SQLITE_DBSTATUS options] is likely
! 6176: ** to grow in future releases of SQLite.
! 6177: **
! 6178: ** ^The current value of the requested parameter is written into *pCur
! 6179: ** and the highest instantaneous value is written into *pHiwtr. ^If
! 6180: ** the resetFlg is true, then the highest instantaneous value is
! 6181: ** reset back down to the current value.
! 6182: **
! 6183: ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
! 6184: ** non-zero [error code] on failure.
! 6185: **
! 6186: ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
! 6187: */
! 6188: SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
! 6189:
! 6190: /*
! 6191: ** CAPI3REF: Status Parameters for database connections
! 6192: ** KEYWORDS: {SQLITE_DBSTATUS options}
! 6193: **
! 6194: ** These constants are the available integer "verbs" that can be passed as
! 6195: ** the second argument to the [sqlite3_db_status()] interface.
! 6196: **
! 6197: ** New verbs may be added in future releases of SQLite. Existing verbs
! 6198: ** might be discontinued. Applications should check the return code from
! 6199: ** [sqlite3_db_status()] to make sure that the call worked.
! 6200: ** The [sqlite3_db_status()] interface will return a non-zero error code
! 6201: ** if a discontinued or unsupported verb is invoked.
! 6202: **
! 6203: ** <dl>
! 6204: ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
! 6205: ** <dd>This parameter returns the number of lookaside memory slots currently
! 6206: ** checked out.</dd>)^
! 6207: **
! 6208: ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
! 6209: ** <dd>This parameter returns the number malloc attempts that were
! 6210: ** satisfied using lookaside memory. Only the high-water value is meaningful;
! 6211: ** the current value is always zero.)^
! 6212: **
! 6213: ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
! 6214: ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
! 6215: ** <dd>This parameter returns the number malloc attempts that might have
! 6216: ** been satisfied using lookaside memory but failed due to the amount of
! 6217: ** memory requested being larger than the lookaside slot size.
! 6218: ** Only the high-water value is meaningful;
! 6219: ** the current value is always zero.)^
! 6220: **
! 6221: ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
! 6222: ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
! 6223: ** <dd>This parameter returns the number malloc attempts that might have
! 6224: ** been satisfied using lookaside memory but failed due to all lookaside
! 6225: ** memory already being in use.
! 6226: ** Only the high-water value is meaningful;
! 6227: ** the current value is always zero.)^
! 6228: **
! 6229: ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
! 6230: ** <dd>This parameter returns the approximate number of of bytes of heap
! 6231: ** memory used by all pager caches associated with the database connection.)^
! 6232: ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
! 6233: **
! 6234: ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
! 6235: ** <dd>This parameter returns the approximate number of of bytes of heap
! 6236: ** memory used to store the schema for all databases associated
! 6237: ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
! 6238: ** ^The full amount of memory used by the schemas is reported, even if the
! 6239: ** schema memory is shared with other database connections due to
! 6240: ** [shared cache mode] being enabled.
! 6241: ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
! 6242: **
! 6243: ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
! 6244: ** <dd>This parameter returns the approximate number of of bytes of heap
! 6245: ** and lookaside memory used by all prepared statements associated with
! 6246: ** the database connection.)^
! 6247: ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
! 6248: ** </dd>
! 6249: **
! 6250: ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
! 6251: ** <dd>This parameter returns the number of pager cache hits that have
! 6252: ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
! 6253: ** is always 0.
! 6254: ** </dd>
! 6255: **
! 6256: ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
! 6257: ** <dd>This parameter returns the number of pager cache misses that have
! 6258: ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
! 6259: ** is always 0.
! 6260: ** </dd>
! 6261: **
! 6262: ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
! 6263: ** <dd>This parameter returns the number of dirty cache entries that have
! 6264: ** been written to disk. Specifically, the number of pages written to the
! 6265: ** wal file in wal mode databases, or the number of pages written to the
! 6266: ** database file in rollback mode databases. Any pages written as part of
! 6267: ** transaction rollback or database recovery operations are not included.
! 6268: ** If an IO or other error occurs while writing a page to disk, the effect
! 6269: ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
! 6270: ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
! 6271: ** </dd>
! 6272: **
! 6273: ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
! 6274: ** <dd>This parameter returns zero for the current value if and only if
! 6275: ** all foreign key constraints (deferred or immediate) have been
! 6276: ** resolved.)^ ^The highwater mark is always 0.
! 6277: ** </dd>
! 6278: ** </dl>
! 6279: */
! 6280: #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
! 6281: #define SQLITE_DBSTATUS_CACHE_USED 1
! 6282: #define SQLITE_DBSTATUS_SCHEMA_USED 2
! 6283: #define SQLITE_DBSTATUS_STMT_USED 3
! 6284: #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
! 6285: #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
! 6286: #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
! 6287: #define SQLITE_DBSTATUS_CACHE_HIT 7
! 6288: #define SQLITE_DBSTATUS_CACHE_MISS 8
! 6289: #define SQLITE_DBSTATUS_CACHE_WRITE 9
! 6290: #define SQLITE_DBSTATUS_DEFERRED_FKS 10
! 6291: #define SQLITE_DBSTATUS_MAX 10 /* Largest defined DBSTATUS */
! 6292:
! 6293:
! 6294: /*
! 6295: ** CAPI3REF: Prepared Statement Status
! 6296: **
! 6297: ** ^(Each prepared statement maintains various
! 6298: ** [SQLITE_STMTSTATUS counters] that measure the number
! 6299: ** of times it has performed specific operations.)^ These counters can
! 6300: ** be used to monitor the performance characteristics of the prepared
! 6301: ** statements. For example, if the number of table steps greatly exceeds
! 6302: ** the number of table searches or result rows, that would tend to indicate
! 6303: ** that the prepared statement is using a full table scan rather than
! 6304: ** an index.
! 6305: **
! 6306: ** ^(This interface is used to retrieve and reset counter values from
! 6307: ** a [prepared statement]. The first argument is the prepared statement
! 6308: ** object to be interrogated. The second argument
! 6309: ** is an integer code for a specific [SQLITE_STMTSTATUS counter]
! 6310: ** to be interrogated.)^
! 6311: ** ^The current value of the requested counter is returned.
! 6312: ** ^If the resetFlg is true, then the counter is reset to zero after this
! 6313: ** interface call returns.
! 6314: **
! 6315: ** See also: [sqlite3_status()] and [sqlite3_db_status()].
! 6316: */
! 6317: SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
! 6318:
! 6319: /*
! 6320: ** CAPI3REF: Status Parameters for prepared statements
! 6321: ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
! 6322: **
! 6323: ** These preprocessor macros define integer codes that name counter
! 6324: ** values associated with the [sqlite3_stmt_status()] interface.
! 6325: ** The meanings of the various counters are as follows:
! 6326: **
! 6327: ** <dl>
! 6328: ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
! 6329: ** <dd>^This is the number of times that SQLite has stepped forward in
! 6330: ** a table as part of a full table scan. Large numbers for this counter
! 6331: ** may indicate opportunities for performance improvement through
! 6332: ** careful use of indices.</dd>
! 6333: **
! 6334: ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
! 6335: ** <dd>^This is the number of sort operations that have occurred.
! 6336: ** A non-zero value in this counter may indicate an opportunity to
! 6337: ** improvement performance through careful use of indices.</dd>
! 6338: **
! 6339: ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
! 6340: ** <dd>^This is the number of rows inserted into transient indices that
! 6341: ** were created automatically in order to help joins run faster.
! 6342: ** A non-zero value in this counter may indicate an opportunity to
! 6343: ** improvement performance by adding permanent indices that do not
! 6344: ** need to be reinitialized each time the statement is run.</dd>
! 6345: **
! 6346: ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
! 6347: ** <dd>^This is the number of virtual machine operations executed
! 6348: ** by the prepared statement if that number is less than or equal
! 6349: ** to 2147483647. The number of virtual machine operations can be
! 6350: ** used as a proxy for the total work done by the prepared statement.
! 6351: ** If the number of virtual machine operations exceeds 2147483647
! 6352: ** then the value returned by this statement status code is undefined.
! 6353: ** </dd>
! 6354: ** </dl>
! 6355: */
! 6356: #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
! 6357: #define SQLITE_STMTSTATUS_SORT 2
! 6358: #define SQLITE_STMTSTATUS_AUTOINDEX 3
! 6359: #define SQLITE_STMTSTATUS_VM_STEP 4
! 6360:
! 6361: /*
! 6362: ** CAPI3REF: Custom Page Cache Object
! 6363: **
! 6364: ** The sqlite3_pcache type is opaque. It is implemented by
! 6365: ** the pluggable module. The SQLite core has no knowledge of
! 6366: ** its size or internal structure and never deals with the
! 6367: ** sqlite3_pcache object except by holding and passing pointers
! 6368: ** to the object.
! 6369: **
! 6370: ** See [sqlite3_pcache_methods2] for additional information.
! 6371: */
! 6372: typedef struct sqlite3_pcache sqlite3_pcache;
! 6373:
! 6374: /*
! 6375: ** CAPI3REF: Custom Page Cache Object
! 6376: **
! 6377: ** The sqlite3_pcache_page object represents a single page in the
! 6378: ** page cache. The page cache will allocate instances of this
! 6379: ** object. Various methods of the page cache use pointers to instances
! 6380: ** of this object as parameters or as their return value.
! 6381: **
! 6382: ** See [sqlite3_pcache_methods2] for additional information.
! 6383: */
! 6384: typedef struct sqlite3_pcache_page sqlite3_pcache_page;
! 6385: struct sqlite3_pcache_page {
! 6386: void *pBuf; /* The content of the page */
! 6387: void *pExtra; /* Extra information associated with the page */
! 6388: };
! 6389:
! 6390: /*
! 6391: ** CAPI3REF: Application Defined Page Cache.
! 6392: ** KEYWORDS: {page cache}
! 6393: **
! 6394: ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
! 6395: ** register an alternative page cache implementation by passing in an
! 6396: ** instance of the sqlite3_pcache_methods2 structure.)^
! 6397: ** In many applications, most of the heap memory allocated by
! 6398: ** SQLite is used for the page cache.
! 6399: ** By implementing a
! 6400: ** custom page cache using this API, an application can better control
! 6401: ** the amount of memory consumed by SQLite, the way in which
! 6402: ** that memory is allocated and released, and the policies used to
! 6403: ** determine exactly which parts of a database file are cached and for
! 6404: ** how long.
! 6405: **
! 6406: ** The alternative page cache mechanism is an
! 6407: ** extreme measure that is only needed by the most demanding applications.
! 6408: ** The built-in page cache is recommended for most uses.
! 6409: **
! 6410: ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
! 6411: ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
! 6412: ** the application may discard the parameter after the call to
! 6413: ** [sqlite3_config()] returns.)^
! 6414: **
! 6415: ** [[the xInit() page cache method]]
! 6416: ** ^(The xInit() method is called once for each effective
! 6417: ** call to [sqlite3_initialize()])^
! 6418: ** (usually only once during the lifetime of the process). ^(The xInit()
! 6419: ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
! 6420: ** The intent of the xInit() method is to set up global data structures
! 6421: ** required by the custom page cache implementation.
! 6422: ** ^(If the xInit() method is NULL, then the
! 6423: ** built-in default page cache is used instead of the application defined
! 6424: ** page cache.)^
! 6425: **
! 6426: ** [[the xShutdown() page cache method]]
! 6427: ** ^The xShutdown() method is called by [sqlite3_shutdown()].
! 6428: ** It can be used to clean up
! 6429: ** any outstanding resources before process shutdown, if required.
! 6430: ** ^The xShutdown() method may be NULL.
! 6431: **
! 6432: ** ^SQLite automatically serializes calls to the xInit method,
! 6433: ** so the xInit method need not be threadsafe. ^The
! 6434: ** xShutdown method is only called from [sqlite3_shutdown()] so it does
! 6435: ** not need to be threadsafe either. All other methods must be threadsafe
! 6436: ** in multithreaded applications.
! 6437: **
! 6438: ** ^SQLite will never invoke xInit() more than once without an intervening
! 6439: ** call to xShutdown().
! 6440: **
! 6441: ** [[the xCreate() page cache methods]]
! 6442: ** ^SQLite invokes the xCreate() method to construct a new cache instance.
! 6443: ** SQLite will typically create one cache instance for each open database file,
! 6444: ** though this is not guaranteed. ^The
! 6445: ** first parameter, szPage, is the size in bytes of the pages that must
! 6446: ** be allocated by the cache. ^szPage will always a power of two. ^The
! 6447: ** second parameter szExtra is a number of bytes of extra storage
! 6448: ** associated with each page cache entry. ^The szExtra parameter will
! 6449: ** a number less than 250. SQLite will use the
! 6450: ** extra szExtra bytes on each page to store metadata about the underlying
! 6451: ** database page on disk. The value passed into szExtra depends
! 6452: ** on the SQLite version, the target platform, and how SQLite was compiled.
! 6453: ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
! 6454: ** created will be used to cache database pages of a file stored on disk, or
! 6455: ** false if it is used for an in-memory database. The cache implementation
! 6456: ** does not have to do anything special based with the value of bPurgeable;
! 6457: ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
! 6458: ** never invoke xUnpin() except to deliberately delete a page.
! 6459: ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
! 6460: ** false will always have the "discard" flag set to true.
! 6461: ** ^Hence, a cache created with bPurgeable false will
! 6462: ** never contain any unpinned pages.
! 6463: **
! 6464: ** [[the xCachesize() page cache method]]
! 6465: ** ^(The xCachesize() method may be called at any time by SQLite to set the
! 6466: ** suggested maximum cache-size (number of pages stored by) the cache
! 6467: ** instance passed as the first argument. This is the value configured using
! 6468: ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
! 6469: ** parameter, the implementation is not required to do anything with this
! 6470: ** value; it is advisory only.
! 6471: **
! 6472: ** [[the xPagecount() page cache methods]]
! 6473: ** The xPagecount() method must return the number of pages currently
! 6474: ** stored in the cache, both pinned and unpinned.
! 6475: **
! 6476: ** [[the xFetch() page cache methods]]
! 6477: ** The xFetch() method locates a page in the cache and returns a pointer to
! 6478: ** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
! 6479: ** The pBuf element of the returned sqlite3_pcache_page object will be a
! 6480: ** pointer to a buffer of szPage bytes used to store the content of a
! 6481: ** single database page. The pExtra element of sqlite3_pcache_page will be
! 6482: ** a pointer to the szExtra bytes of extra storage that SQLite has requested
! 6483: ** for each entry in the page cache.
! 6484: **
! 6485: ** The page to be fetched is determined by the key. ^The minimum key value
! 6486: ** is 1. After it has been retrieved using xFetch, the page is considered
! 6487: ** to be "pinned".
! 6488: **
! 6489: ** If the requested page is already in the page cache, then the page cache
! 6490: ** implementation must return a pointer to the page buffer with its content
! 6491: ** intact. If the requested page is not already in the cache, then the
! 6492: ** cache implementation should use the value of the createFlag
! 6493: ** parameter to help it determined what action to take:
! 6494: **
! 6495: ** <table border=1 width=85% align=center>
! 6496: ** <tr><th> createFlag <th> Behavior when page is not already in cache
! 6497: ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
! 6498: ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
! 6499: ** Otherwise return NULL.
! 6500: ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
! 6501: ** NULL if allocating a new page is effectively impossible.
! 6502: ** </table>
! 6503: **
! 6504: ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
! 6505: ** will only use a createFlag of 2 after a prior call with a createFlag of 1
! 6506: ** failed.)^ In between the to xFetch() calls, SQLite may
! 6507: ** attempt to unpin one or more cache pages by spilling the content of
! 6508: ** pinned pages to disk and synching the operating system disk cache.
! 6509: **
! 6510: ** [[the xUnpin() page cache method]]
! 6511: ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
! 6512: ** as its second argument. If the third parameter, discard, is non-zero,
! 6513: ** then the page must be evicted from the cache.
! 6514: ** ^If the discard parameter is
! 6515: ** zero, then the page may be discarded or retained at the discretion of
! 6516: ** page cache implementation. ^The page cache implementation
! 6517: ** may choose to evict unpinned pages at any time.
! 6518: **
! 6519: ** The cache must not perform any reference counting. A single
! 6520: ** call to xUnpin() unpins the page regardless of the number of prior calls
! 6521: ** to xFetch().
! 6522: **
! 6523: ** [[the xRekey() page cache methods]]
! 6524: ** The xRekey() method is used to change the key value associated with the
! 6525: ** page passed as the second argument. If the cache
! 6526: ** previously contains an entry associated with newKey, it must be
! 6527: ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
! 6528: ** to be pinned.
! 6529: **
! 6530: ** When SQLite calls the xTruncate() method, the cache must discard all
! 6531: ** existing cache entries with page numbers (keys) greater than or equal
! 6532: ** to the value of the iLimit parameter passed to xTruncate(). If any
! 6533: ** of these pages are pinned, they are implicitly unpinned, meaning that
! 6534: ** they can be safely discarded.
! 6535: **
! 6536: ** [[the xDestroy() page cache method]]
! 6537: ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
! 6538: ** All resources associated with the specified cache should be freed. ^After
! 6539: ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
! 6540: ** handle invalid, and will not use it with any other sqlite3_pcache_methods2
! 6541: ** functions.
! 6542: **
! 6543: ** [[the xShrink() page cache method]]
! 6544: ** ^SQLite invokes the xShrink() method when it wants the page cache to
! 6545: ** free up as much of heap memory as possible. The page cache implementation
! 6546: ** is not obligated to free any memory, but well-behaved implementations should
! 6547: ** do their best.
! 6548: */
! 6549: typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
! 6550: struct sqlite3_pcache_methods2 {
! 6551: int iVersion;
! 6552: void *pArg;
! 6553: int (*xInit)(void*);
! 6554: void (*xShutdown)(void*);
! 6555: sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
! 6556: void (*xCachesize)(sqlite3_pcache*, int nCachesize);
! 6557: int (*xPagecount)(sqlite3_pcache*);
! 6558: sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
! 6559: void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
! 6560: void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
! 6561: unsigned oldKey, unsigned newKey);
! 6562: void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
! 6563: void (*xDestroy)(sqlite3_pcache*);
! 6564: void (*xShrink)(sqlite3_pcache*);
! 6565: };
! 6566:
! 6567: /*
! 6568: ** This is the obsolete pcache_methods object that has now been replaced
! 6569: ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
! 6570: ** retained in the header file for backwards compatibility only.
! 6571: */
! 6572: typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
! 6573: struct sqlite3_pcache_methods {
! 6574: void *pArg;
! 6575: int (*xInit)(void*);
! 6576: void (*xShutdown)(void*);
! 6577: sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
! 6578: void (*xCachesize)(sqlite3_pcache*, int nCachesize);
! 6579: int (*xPagecount)(sqlite3_pcache*);
! 6580: void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
! 6581: void (*xUnpin)(sqlite3_pcache*, void*, int discard);
! 6582: void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
! 6583: void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
! 6584: void (*xDestroy)(sqlite3_pcache*);
! 6585: };
! 6586:
! 6587:
! 6588: /*
! 6589: ** CAPI3REF: Online Backup Object
! 6590: **
! 6591: ** The sqlite3_backup object records state information about an ongoing
! 6592: ** online backup operation. ^The sqlite3_backup object is created by
! 6593: ** a call to [sqlite3_backup_init()] and is destroyed by a call to
! 6594: ** [sqlite3_backup_finish()].
! 6595: **
! 6596: ** See Also: [Using the SQLite Online Backup API]
! 6597: */
! 6598: typedef struct sqlite3_backup sqlite3_backup;
! 6599:
! 6600: /*
! 6601: ** CAPI3REF: Online Backup API.
! 6602: **
! 6603: ** The backup API copies the content of one database into another.
! 6604: ** It is useful either for creating backups of databases or
! 6605: ** for copying in-memory databases to or from persistent files.
! 6606: **
! 6607: ** See Also: [Using the SQLite Online Backup API]
! 6608: **
! 6609: ** ^SQLite holds a write transaction open on the destination database file
! 6610: ** for the duration of the backup operation.
! 6611: ** ^The source database is read-locked only while it is being read;
! 6612: ** it is not locked continuously for the entire backup operation.
! 6613: ** ^Thus, the backup may be performed on a live source database without
! 6614: ** preventing other database connections from
! 6615: ** reading or writing to the source database while the backup is underway.
! 6616: **
! 6617: ** ^(To perform a backup operation:
! 6618: ** <ol>
! 6619: ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
! 6620: ** backup,
! 6621: ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
! 6622: ** the data between the two databases, and finally
! 6623: ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
! 6624: ** associated with the backup operation.
! 6625: ** </ol>)^
! 6626: ** There should be exactly one call to sqlite3_backup_finish() for each
! 6627: ** successful call to sqlite3_backup_init().
! 6628: **
! 6629: ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
! 6630: **
! 6631: ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
! 6632: ** [database connection] associated with the destination database
! 6633: ** and the database name, respectively.
! 6634: ** ^The database name is "main" for the main database, "temp" for the
! 6635: ** temporary database, or the name specified after the AS keyword in
! 6636: ** an [ATTACH] statement for an attached database.
! 6637: ** ^The S and M arguments passed to
! 6638: ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
! 6639: ** and database name of the source database, respectively.
! 6640: ** ^The source and destination [database connections] (parameters S and D)
! 6641: ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
! 6642: ** an error.
! 6643: **
! 6644: ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
! 6645: ** returned and an error code and error message are stored in the
! 6646: ** destination [database connection] D.
! 6647: ** ^The error code and message for the failed call to sqlite3_backup_init()
! 6648: ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
! 6649: ** [sqlite3_errmsg16()] functions.
! 6650: ** ^A successful call to sqlite3_backup_init() returns a pointer to an
! 6651: ** [sqlite3_backup] object.
! 6652: ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
! 6653: ** sqlite3_backup_finish() functions to perform the specified backup
! 6654: ** operation.
! 6655: **
! 6656: ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
! 6657: **
! 6658: ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
! 6659: ** the source and destination databases specified by [sqlite3_backup] object B.
! 6660: ** ^If N is negative, all remaining source pages are copied.
! 6661: ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
! 6662: ** are still more pages to be copied, then the function returns [SQLITE_OK].
! 6663: ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
! 6664: ** from source to destination, then it returns [SQLITE_DONE].
! 6665: ** ^If an error occurs while running sqlite3_backup_step(B,N),
! 6666: ** then an [error code] is returned. ^As well as [SQLITE_OK] and
! 6667: ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
! 6668: ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
! 6669: ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
! 6670: **
! 6671: ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
! 6672: ** <ol>
! 6673: ** <li> the destination database was opened read-only, or
! 6674: ** <li> the destination database is using write-ahead-log journaling
! 6675: ** and the destination and source page sizes differ, or
! 6676: ** <li> the destination database is an in-memory database and the
! 6677: ** destination and source page sizes differ.
! 6678: ** </ol>)^
! 6679: **
! 6680: ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
! 6681: ** the [sqlite3_busy_handler | busy-handler function]
! 6682: ** is invoked (if one is specified). ^If the
! 6683: ** busy-handler returns non-zero before the lock is available, then
! 6684: ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
! 6685: ** sqlite3_backup_step() can be retried later. ^If the source
! 6686: ** [database connection]
! 6687: ** is being used to write to the source database when sqlite3_backup_step()
! 6688: ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
! 6689: ** case the call to sqlite3_backup_step() can be retried later on. ^(If
! 6690: ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
! 6691: ** [SQLITE_READONLY] is returned, then
! 6692: ** there is no point in retrying the call to sqlite3_backup_step(). These
! 6693: ** errors are considered fatal.)^ The application must accept
! 6694: ** that the backup operation has failed and pass the backup operation handle
! 6695: ** to the sqlite3_backup_finish() to release associated resources.
! 6696: **
! 6697: ** ^The first call to sqlite3_backup_step() obtains an exclusive lock
! 6698: ** on the destination file. ^The exclusive lock is not released until either
! 6699: ** sqlite3_backup_finish() is called or the backup operation is complete
! 6700: ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
! 6701: ** sqlite3_backup_step() obtains a [shared lock] on the source database that
! 6702: ** lasts for the duration of the sqlite3_backup_step() call.
! 6703: ** ^Because the source database is not locked between calls to
! 6704: ** sqlite3_backup_step(), the source database may be modified mid-way
! 6705: ** through the backup process. ^If the source database is modified by an
! 6706: ** external process or via a database connection other than the one being
! 6707: ** used by the backup operation, then the backup will be automatically
! 6708: ** restarted by the next call to sqlite3_backup_step(). ^If the source
! 6709: ** database is modified by the using the same database connection as is used
! 6710: ** by the backup operation, then the backup database is automatically
! 6711: ** updated at the same time.
! 6712: **
! 6713: ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
! 6714: **
! 6715: ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
! 6716: ** application wishes to abandon the backup operation, the application
! 6717: ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
! 6718: ** ^The sqlite3_backup_finish() interfaces releases all
! 6719: ** resources associated with the [sqlite3_backup] object.
! 6720: ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
! 6721: ** active write-transaction on the destination database is rolled back.
! 6722: ** The [sqlite3_backup] object is invalid
! 6723: ** and may not be used following a call to sqlite3_backup_finish().
! 6724: **
! 6725: ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
! 6726: ** sqlite3_backup_step() errors occurred, regardless or whether or not
! 6727: ** sqlite3_backup_step() completed.
! 6728: ** ^If an out-of-memory condition or IO error occurred during any prior
! 6729: ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
! 6730: ** sqlite3_backup_finish() returns the corresponding [error code].
! 6731: **
! 6732: ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
! 6733: ** is not a permanent error and does not affect the return value of
! 6734: ** sqlite3_backup_finish().
! 6735: **
! 6736: ** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]]
! 6737: ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
! 6738: **
! 6739: ** ^Each call to sqlite3_backup_step() sets two values inside
! 6740: ** the [sqlite3_backup] object: the number of pages still to be backed
! 6741: ** up and the total number of pages in the source database file.
! 6742: ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces
! 6743: ** retrieve these two values, respectively.
! 6744: **
! 6745: ** ^The values returned by these functions are only updated by
! 6746: ** sqlite3_backup_step(). ^If the source database is modified during a backup
! 6747: ** operation, then the values are not updated to account for any extra
! 6748: ** pages that need to be updated or the size of the source database file
! 6749: ** changing.
! 6750: **
! 6751: ** <b>Concurrent Usage of Database Handles</b>
! 6752: **
! 6753: ** ^The source [database connection] may be used by the application for other
! 6754: ** purposes while a backup operation is underway or being initialized.
! 6755: ** ^If SQLite is compiled and configured to support threadsafe database
! 6756: ** connections, then the source database connection may be used concurrently
! 6757: ** from within other threads.
! 6758: **
! 6759: ** However, the application must guarantee that the destination
! 6760: ** [database connection] is not passed to any other API (by any thread) after
! 6761: ** sqlite3_backup_init() is called and before the corresponding call to
! 6762: ** sqlite3_backup_finish(). SQLite does not currently check to see
! 6763: ** if the application incorrectly accesses the destination [database connection]
! 6764: ** and so no error code is reported, but the operations may malfunction
! 6765: ** nevertheless. Use of the destination database connection while a
! 6766: ** backup is in progress might also also cause a mutex deadlock.
! 6767: **
! 6768: ** If running in [shared cache mode], the application must
! 6769: ** guarantee that the shared cache used by the destination database
! 6770: ** is not accessed while the backup is running. In practice this means
! 6771: ** that the application must guarantee that the disk file being
! 6772: ** backed up to is not accessed by any connection within the process,
! 6773: ** not just the specific connection that was passed to sqlite3_backup_init().
! 6774: **
! 6775: ** The [sqlite3_backup] object itself is partially threadsafe. Multiple
! 6776: ** threads may safely make multiple concurrent calls to sqlite3_backup_step().
! 6777: ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
! 6778: ** APIs are not strictly speaking threadsafe. If they are invoked at the
! 6779: ** same time as another thread is invoking sqlite3_backup_step() it is
! 6780: ** possible that they return invalid values.
! 6781: */
! 6782: SQLITE_API sqlite3_backup *sqlite3_backup_init(
! 6783: sqlite3 *pDest, /* Destination database handle */
! 6784: const char *zDestName, /* Destination database name */
! 6785: sqlite3 *pSource, /* Source database handle */
! 6786: const char *zSourceName /* Source database name */
! 6787: );
! 6788: SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
! 6789: SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
! 6790: SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
! 6791: SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
! 6792:
! 6793: /*
! 6794: ** CAPI3REF: Unlock Notification
! 6795: **
! 6796: ** ^When running in shared-cache mode, a database operation may fail with
! 6797: ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
! 6798: ** individual tables within the shared-cache cannot be obtained. See
! 6799: ** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
! 6800: ** ^This API may be used to register a callback that SQLite will invoke
! 6801: ** when the connection currently holding the required lock relinquishes it.
! 6802: ** ^This API is only available if the library was compiled with the
! 6803: ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
! 6804: **
! 6805: ** See Also: [Using the SQLite Unlock Notification Feature].
! 6806: **
! 6807: ** ^Shared-cache locks are released when a database connection concludes
! 6808: ** its current transaction, either by committing it or rolling it back.
! 6809: **
! 6810: ** ^When a connection (known as the blocked connection) fails to obtain a
! 6811: ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
! 6812: ** identity of the database connection (the blocking connection) that
! 6813: ** has locked the required resource is stored internally. ^After an
! 6814: ** application receives an SQLITE_LOCKED error, it may call the
! 6815: ** sqlite3_unlock_notify() method with the blocked connection handle as
! 6816: ** the first argument to register for a callback that will be invoked
! 6817: ** when the blocking connections current transaction is concluded. ^The
! 6818: ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
! 6819: ** call that concludes the blocking connections transaction.
! 6820: **
! 6821: ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
! 6822: ** there is a chance that the blocking connection will have already
! 6823: ** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
! 6824: ** If this happens, then the specified callback is invoked immediately,
! 6825: ** from within the call to sqlite3_unlock_notify().)^
! 6826: **
! 6827: ** ^If the blocked connection is attempting to obtain a write-lock on a
! 6828: ** shared-cache table, and more than one other connection currently holds
! 6829: ** a read-lock on the same table, then SQLite arbitrarily selects one of
! 6830: ** the other connections to use as the blocking connection.
! 6831: **
! 6832: ** ^(There may be at most one unlock-notify callback registered by a
! 6833: ** blocked connection. If sqlite3_unlock_notify() is called when the
! 6834: ** blocked connection already has a registered unlock-notify callback,
! 6835: ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
! 6836: ** called with a NULL pointer as its second argument, then any existing
! 6837: ** unlock-notify callback is canceled. ^The blocked connections
! 6838: ** unlock-notify callback may also be canceled by closing the blocked
! 6839: ** connection using [sqlite3_close()].
! 6840: **
! 6841: ** The unlock-notify callback is not reentrant. If an application invokes
! 6842: ** any sqlite3_xxx API functions from within an unlock-notify callback, a
! 6843: ** crash or deadlock may be the result.
! 6844: **
! 6845: ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
! 6846: ** returns SQLITE_OK.
! 6847: **
! 6848: ** <b>Callback Invocation Details</b>
! 6849: **
! 6850: ** When an unlock-notify callback is registered, the application provides a
! 6851: ** single void* pointer that is passed to the callback when it is invoked.
! 6852: ** However, the signature of the callback function allows SQLite to pass
! 6853: ** it an array of void* context pointers. The first argument passed to
! 6854: ** an unlock-notify callback is a pointer to an array of void* pointers,
! 6855: ** and the second is the number of entries in the array.
! 6856: **
! 6857: ** When a blocking connections transaction is concluded, there may be
! 6858: ** more than one blocked connection that has registered for an unlock-notify
! 6859: ** callback. ^If two or more such blocked connections have specified the
! 6860: ** same callback function, then instead of invoking the callback function
! 6861: ** multiple times, it is invoked once with the set of void* context pointers
! 6862: ** specified by the blocked connections bundled together into an array.
! 6863: ** This gives the application an opportunity to prioritize any actions
! 6864: ** related to the set of unblocked database connections.
! 6865: **
! 6866: ** <b>Deadlock Detection</b>
! 6867: **
! 6868: ** Assuming that after registering for an unlock-notify callback a
! 6869: ** database waits for the callback to be issued before taking any further
! 6870: ** action (a reasonable assumption), then using this API may cause the
! 6871: ** application to deadlock. For example, if connection X is waiting for
! 6872: ** connection Y's transaction to be concluded, and similarly connection
! 6873: ** Y is waiting on connection X's transaction, then neither connection
! 6874: ** will proceed and the system may remain deadlocked indefinitely.
! 6875: **
! 6876: ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
! 6877: ** detection. ^If a given call to sqlite3_unlock_notify() would put the
! 6878: ** system in a deadlocked state, then SQLITE_LOCKED is returned and no
! 6879: ** unlock-notify callback is registered. The system is said to be in
! 6880: ** a deadlocked state if connection A has registered for an unlock-notify
! 6881: ** callback on the conclusion of connection B's transaction, and connection
! 6882: ** B has itself registered for an unlock-notify callback when connection
! 6883: ** A's transaction is concluded. ^Indirect deadlock is also detected, so
! 6884: ** the system is also considered to be deadlocked if connection B has
! 6885: ** registered for an unlock-notify callback on the conclusion of connection
! 6886: ** C's transaction, where connection C is waiting on connection A. ^Any
! 6887: ** number of levels of indirection are allowed.
! 6888: **
! 6889: ** <b>The "DROP TABLE" Exception</b>
! 6890: **
! 6891: ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
! 6892: ** always appropriate to call sqlite3_unlock_notify(). There is however,
! 6893: ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
! 6894: ** SQLite checks if there are any currently executing SELECT statements
! 6895: ** that belong to the same connection. If there are, SQLITE_LOCKED is
! 6896: ** returned. In this case there is no "blocking connection", so invoking
! 6897: ** sqlite3_unlock_notify() results in the unlock-notify callback being
! 6898: ** invoked immediately. If the application then re-attempts the "DROP TABLE"
! 6899: ** or "DROP INDEX" query, an infinite loop might be the result.
! 6900: **
! 6901: ** One way around this problem is to check the extended error code returned
! 6902: ** by an sqlite3_step() call. ^(If there is a blocking connection, then the
! 6903: ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
! 6904: ** the special "DROP TABLE/INDEX" case, the extended error code is just
! 6905: ** SQLITE_LOCKED.)^
! 6906: */
! 6907: SQLITE_API int sqlite3_unlock_notify(
! 6908: sqlite3 *pBlocked, /* Waiting connection */
! 6909: void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
! 6910: void *pNotifyArg /* Argument to pass to xNotify */
! 6911: );
! 6912:
! 6913:
! 6914: /*
! 6915: ** CAPI3REF: String Comparison
! 6916: **
! 6917: ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
! 6918: ** and extensions to compare the contents of two buffers containing UTF-8
! 6919: ** strings in a case-independent fashion, using the same definition of "case
! 6920: ** independence" that SQLite uses internally when comparing identifiers.
! 6921: */
! 6922: SQLITE_API int sqlite3_stricmp(const char *, const char *);
! 6923: SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);
! 6924:
! 6925: /*
! 6926: ** CAPI3REF: String Globbing
! 6927: *
! 6928: ** ^The [sqlite3_strglob(P,X)] interface returns zero if string X matches
! 6929: ** the glob pattern P, and it returns non-zero if string X does not match
! 6930: ** the glob pattern P. ^The definition of glob pattern matching used in
! 6931: ** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
! 6932: ** SQL dialect used by SQLite. ^The sqlite3_strglob(P,X) function is case
! 6933: ** sensitive.
! 6934: **
! 6935: ** Note that this routine returns zero on a match and non-zero if the strings
! 6936: ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
! 6937: */
! 6938: SQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr);
! 6939:
! 6940: /*
! 6941: ** CAPI3REF: Error Logging Interface
! 6942: **
! 6943: ** ^The [sqlite3_log()] interface writes a message into the [error log]
! 6944: ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
! 6945: ** ^If logging is enabled, the zFormat string and subsequent arguments are
! 6946: ** used with [sqlite3_snprintf()] to generate the final output string.
! 6947: **
! 6948: ** The sqlite3_log() interface is intended for use by extensions such as
! 6949: ** virtual tables, collating functions, and SQL functions. While there is
! 6950: ** nothing to prevent an application from calling sqlite3_log(), doing so
! 6951: ** is considered bad form.
! 6952: **
! 6953: ** The zFormat string must not be NULL.
! 6954: **
! 6955: ** To avoid deadlocks and other threading problems, the sqlite3_log() routine
! 6956: ** will not use dynamically allocated memory. The log message is stored in
! 6957: ** a fixed-length buffer on the stack. If the log message is longer than
! 6958: ** a few hundred characters, it will be truncated to the length of the
! 6959: ** buffer.
! 6960: */
! 6961: SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
! 6962:
! 6963: /*
! 6964: ** CAPI3REF: Write-Ahead Log Commit Hook
! 6965: **
! 6966: ** ^The [sqlite3_wal_hook()] function is used to register a callback that
! 6967: ** will be invoked each time a database connection commits data to a
! 6968: ** [write-ahead log] (i.e. whenever a transaction is committed in
! 6969: ** [journal_mode | journal_mode=WAL mode]).
! 6970: **
! 6971: ** ^The callback is invoked by SQLite after the commit has taken place and
! 6972: ** the associated write-lock on the database released, so the implementation
! 6973: ** may read, write or [checkpoint] the database as required.
! 6974: **
! 6975: ** ^The first parameter passed to the callback function when it is invoked
! 6976: ** is a copy of the third parameter passed to sqlite3_wal_hook() when
! 6977: ** registering the callback. ^The second is a copy of the database handle.
! 6978: ** ^The third parameter is the name of the database that was written to -
! 6979: ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
! 6980: ** is the number of pages currently in the write-ahead log file,
! 6981: ** including those that were just committed.
! 6982: **
! 6983: ** The callback function should normally return [SQLITE_OK]. ^If an error
! 6984: ** code is returned, that error will propagate back up through the
! 6985: ** SQLite code base to cause the statement that provoked the callback
! 6986: ** to report an error, though the commit will have still occurred. If the
! 6987: ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
! 6988: ** that does not correspond to any valid SQLite error code, the results
! 6989: ** are undefined.
! 6990: **
! 6991: ** A single database handle may have at most a single write-ahead log callback
! 6992: ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
! 6993: ** previously registered write-ahead log callback. ^Note that the
! 6994: ** [sqlite3_wal_autocheckpoint()] interface and the
! 6995: ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
! 6996: ** those overwrite any prior [sqlite3_wal_hook()] settings.
! 6997: */
! 6998: SQLITE_API void *sqlite3_wal_hook(
! 6999: sqlite3*,
! 7000: int(*)(void *,sqlite3*,const char*,int),
! 7001: void*
! 7002: );
1.4 misha 7003:
1.5 ! misha 7004: /*
! 7005: ** CAPI3REF: Configure an auto-checkpoint
! 7006: **
! 7007: ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
! 7008: ** [sqlite3_wal_hook()] that causes any database on [database connection] D
! 7009: ** to automatically [checkpoint]
! 7010: ** after committing a transaction if there are N or
! 7011: ** more frames in the [write-ahead log] file. ^Passing zero or
! 7012: ** a negative value as the nFrame parameter disables automatic
! 7013: ** checkpoints entirely.
! 7014: **
! 7015: ** ^The callback registered by this function replaces any existing callback
! 7016: ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
! 7017: ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
! 7018: ** configured by this function.
! 7019: **
! 7020: ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
! 7021: ** from SQL.
! 7022: **
! 7023: ** ^Every new [database connection] defaults to having the auto-checkpoint
! 7024: ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
! 7025: ** pages. The use of this interface
! 7026: ** is only necessary if the default setting is found to be suboptimal
! 7027: ** for a particular application.
! 7028: */
! 7029: SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
! 7030:
! 7031: /*
! 7032: ** CAPI3REF: Checkpoint a database
! 7033: **
! 7034: ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X
! 7035: ** on [database connection] D to be [checkpointed]. ^If X is NULL or an
! 7036: ** empty string, then a checkpoint is run on all databases of
! 7037: ** connection D. ^If the database connection D is not in
! 7038: ** [WAL | write-ahead log mode] then this interface is a harmless no-op.
! 7039: **
! 7040: ** ^The [wal_checkpoint pragma] can be used to invoke this interface
! 7041: ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the
! 7042: ** [wal_autocheckpoint pragma] can be used to cause this interface to be
! 7043: ** run whenever the WAL reaches a certain size threshold.
! 7044: **
! 7045: ** See also: [sqlite3_wal_checkpoint_v2()]
! 7046: */
! 7047: SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
! 7048:
! 7049: /*
! 7050: ** CAPI3REF: Checkpoint a database
! 7051: **
! 7052: ** Run a checkpoint operation on WAL database zDb attached to database
! 7053: ** handle db. The specific operation is determined by the value of the
! 7054: ** eMode parameter:
! 7055: **
! 7056: ** <dl>
! 7057: ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
! 7058: ** Checkpoint as many frames as possible without waiting for any database
! 7059: ** readers or writers to finish. Sync the db file if all frames in the log
! 7060: ** are checkpointed. This mode is the same as calling
! 7061: ** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked.
! 7062: **
! 7063: ** <dt>SQLITE_CHECKPOINT_FULL<dd>
! 7064: ** This mode blocks (calls the busy-handler callback) until there is no
! 7065: ** database writer and all readers are reading from the most recent database
! 7066: ** snapshot. It then checkpoints all frames in the log file and syncs the
! 7067: ** database file. This call blocks database writers while it is running,
! 7068: ** but not database readers.
! 7069: **
! 7070: ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
! 7071: ** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after
! 7072: ** checkpointing the log file it blocks (calls the busy-handler callback)
! 7073: ** until all readers are reading from the database file only. This ensures
! 7074: ** that the next client to write to the database file restarts the log file
! 7075: ** from the beginning. This call blocks database writers while it is running,
! 7076: ** but not database readers.
! 7077: ** </dl>
! 7078: **
! 7079: ** If pnLog is not NULL, then *pnLog is set to the total number of frames in
! 7080: ** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to
! 7081: ** the total number of checkpointed frames (including any that were already
! 7082: ** checkpointed when this function is called). *pnLog and *pnCkpt may be
! 7083: ** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK.
! 7084: ** If no values are available because of an error, they are both set to -1
! 7085: ** before returning to communicate this to the caller.
! 7086: **
! 7087: ** All calls obtain an exclusive "checkpoint" lock on the database file. If
! 7088: ** any other process is running a checkpoint operation at the same time, the
! 7089: ** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a
! 7090: ** busy-handler configured, it will not be invoked in this case.
! 7091: **
! 7092: ** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive
! 7093: ** "writer" lock on the database file. If the writer lock cannot be obtained
! 7094: ** immediately, and a busy-handler is configured, it is invoked and the writer
! 7095: ** lock retried until either the busy-handler returns 0 or the lock is
! 7096: ** successfully obtained. The busy-handler is also invoked while waiting for
! 7097: ** database readers as described above. If the busy-handler returns 0 before
! 7098: ** the writer lock is obtained or while waiting for database readers, the
! 7099: ** checkpoint operation proceeds from that point in the same way as
! 7100: ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
! 7101: ** without blocking any further. SQLITE_BUSY is returned in this case.
! 7102: **
! 7103: ** If parameter zDb is NULL or points to a zero length string, then the
! 7104: ** specified operation is attempted on all WAL databases. In this case the
! 7105: ** values written to output parameters *pnLog and *pnCkpt are undefined. If
! 7106: ** an SQLITE_BUSY error is encountered when processing one or more of the
! 7107: ** attached WAL databases, the operation is still attempted on any remaining
! 7108: ** attached databases and SQLITE_BUSY is returned to the caller. If any other
! 7109: ** error occurs while processing an attached database, processing is abandoned
! 7110: ** and the error code returned to the caller immediately. If no error
! 7111: ** (SQLITE_BUSY or otherwise) is encountered while processing the attached
! 7112: ** databases, SQLITE_OK is returned.
! 7113: **
! 7114: ** If database zDb is the name of an attached database that is not in WAL
! 7115: ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If
! 7116: ** zDb is not NULL (or a zero length string) and is not the name of any
! 7117: ** attached database, SQLITE_ERROR is returned to the caller.
! 7118: */
! 7119: SQLITE_API int sqlite3_wal_checkpoint_v2(
! 7120: sqlite3 *db, /* Database handle */
! 7121: const char *zDb, /* Name of attached database (or NULL) */
! 7122: int eMode, /* SQLITE_CHECKPOINT_* value */
! 7123: int *pnLog, /* OUT: Size of WAL log in frames */
! 7124: int *pnCkpt /* OUT: Total number of frames checkpointed */
! 7125: );
1.4 misha 7126:
1.5 ! misha 7127: /*
! 7128: ** CAPI3REF: Checkpoint operation parameters
! 7129: **
! 7130: ** These constants can be used as the 3rd parameter to
! 7131: ** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()]
! 7132: ** documentation for additional information about the meaning and use of
! 7133: ** each of these values.
! 7134: */
! 7135: #define SQLITE_CHECKPOINT_PASSIVE 0
! 7136: #define SQLITE_CHECKPOINT_FULL 1
! 7137: #define SQLITE_CHECKPOINT_RESTART 2
! 7138:
! 7139: /*
! 7140: ** CAPI3REF: Virtual Table Interface Configuration
! 7141: **
! 7142: ** This function may be called by either the [xConnect] or [xCreate] method
! 7143: ** of a [virtual table] implementation to configure
! 7144: ** various facets of the virtual table interface.
! 7145: **
! 7146: ** If this interface is invoked outside the context of an xConnect or
! 7147: ** xCreate virtual table method then the behavior is undefined.
! 7148: **
! 7149: ** At present, there is only one option that may be configured using
! 7150: ** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options
! 7151: ** may be added in the future.
! 7152: */
! 7153: SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
! 7154:
! 7155: /*
! 7156: ** CAPI3REF: Virtual Table Configuration Options
! 7157: **
! 7158: ** These macros define the various options to the
! 7159: ** [sqlite3_vtab_config()] interface that [virtual table] implementations
! 7160: ** can use to customize and optimize their behavior.
! 7161: **
! 7162: ** <dl>
! 7163: ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT
! 7164: ** <dd>Calls of the form
! 7165: ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
! 7166: ** where X is an integer. If X is zero, then the [virtual table] whose
! 7167: ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
! 7168: ** support constraints. In this configuration (which is the default) if
! 7169: ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
! 7170: ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
! 7171: ** specified as part of the users SQL statement, regardless of the actual
! 7172: ** ON CONFLICT mode specified.
! 7173: **
! 7174: ** If X is non-zero, then the virtual table implementation guarantees
! 7175: ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
! 7176: ** any modifications to internal or persistent data structures have been made.
! 7177: ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
! 7178: ** is able to roll back a statement or database transaction, and abandon
! 7179: ** or continue processing the current SQL statement as appropriate.
! 7180: ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
! 7181: ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
! 7182: ** had been ABORT.
! 7183: **
! 7184: ** Virtual table implementations that are required to handle OR REPLACE
! 7185: ** must do so within the [xUpdate] method. If a call to the
! 7186: ** [sqlite3_vtab_on_conflict()] function indicates that the current ON
! 7187: ** CONFLICT policy is REPLACE, the virtual table implementation should
! 7188: ** silently replace the appropriate rows within the xUpdate callback and
! 7189: ** return SQLITE_OK. Or, if this is not possible, it may return
! 7190: ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
! 7191: ** constraint handling.
! 7192: ** </dl>
! 7193: */
! 7194: #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
! 7195:
! 7196: /*
! 7197: ** CAPI3REF: Determine The Virtual Table Conflict Policy
! 7198: **
! 7199: ** This function may only be called from within a call to the [xUpdate] method
! 7200: ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
! 7201: ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
! 7202: ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
! 7203: ** of the SQL statement that triggered the call to the [xUpdate] method of the
! 7204: ** [virtual table].
! 7205: */
! 7206: SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
! 7207:
! 7208: /*
! 7209: ** CAPI3REF: Conflict resolution modes
! 7210: **
! 7211: ** These constants are returned by [sqlite3_vtab_on_conflict()] to
! 7212: ** inform a [virtual table] implementation what the [ON CONFLICT] mode
! 7213: ** is for the SQL statement being evaluated.
! 7214: **
! 7215: ** Note that the [SQLITE_IGNORE] constant is also used as a potential
! 7216: ** return value from the [sqlite3_set_authorizer()] callback and that
! 7217: ** [SQLITE_ABORT] is also a [result code].
! 7218: */
! 7219: #define SQLITE_ROLLBACK 1
! 7220: /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
! 7221: #define SQLITE_FAIL 3
! 7222: /* #define SQLITE_ABORT 4 // Also an error code */
! 7223: #define SQLITE_REPLACE 5
1.4 misha 7224:
7225:
7226:
7227: /*
1.2 misha 7228: ** Undo the hack that converts floating point types to integer for
7229: ** builds on processors without floating point support.
7230: */
7231: #ifdef SQLITE_OMIT_FLOATING_POINT
7232: # undef double
7233: #endif
1.1 misha 7234:
7235: #ifdef __cplusplus
7236: } /* End of the 'extern "C"' block */
7237: #endif
1.5 ! misha 7238: #endif /* _SQLITE3_H_ */
! 7239:
! 7240: /*
! 7241: ** 2010 August 30
! 7242: **
! 7243: ** The author disclaims copyright to this source code. In place of
! 7244: ** a legal notice, here is a blessing:
! 7245: **
! 7246: ** May you do good and not evil.
! 7247: ** May you find forgiveness for yourself and forgive others.
! 7248: ** May you share freely, never taking more than you give.
! 7249: **
! 7250: *************************************************************************
! 7251: */
! 7252:
! 7253: #ifndef _SQLITE3RTREE_H_
! 7254: #define _SQLITE3RTREE_H_
! 7255:
! 7256:
! 7257: #ifdef __cplusplus
! 7258: extern "C" {
1.1 misha 7259: #endif
1.5 ! misha 7260:
! 7261: typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
! 7262:
! 7263: /*
! 7264: ** Register a geometry callback named zGeom that can be used as part of an
! 7265: ** R-Tree geometry query as follows:
! 7266: **
! 7267: ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
! 7268: */
! 7269: SQLITE_API int sqlite3_rtree_geometry_callback(
! 7270: sqlite3 *db,
! 7271: const char *zGeom,
! 7272: #ifdef SQLITE_RTREE_INT_ONLY
! 7273: int (*xGeom)(sqlite3_rtree_geometry*, int n, sqlite3_int64 *a, int *pRes),
! 7274: #else
! 7275: int (*xGeom)(sqlite3_rtree_geometry*, int n, double *a, int *pRes),
! 7276: #endif
! 7277: void *pContext
! 7278: );
! 7279:
! 7280:
! 7281: /*
! 7282: ** A pointer to a structure of the following type is passed as the first
! 7283: ** argument to callbacks registered using rtree_geometry_callback().
! 7284: */
! 7285: struct sqlite3_rtree_geometry {
! 7286: void *pContext; /* Copy of pContext passed to s_r_g_c() */
! 7287: int nParam; /* Size of array aParam[] */
! 7288: double *aParam; /* Parameters passed to SQL geom function */
! 7289: void *pUser; /* Callback implementation user data */
! 7290: void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */
! 7291: };
! 7292:
! 7293:
! 7294: #ifdef __cplusplus
! 7295: } /* end of the 'extern "C"' block */
! 7296: #endif
! 7297:
! 7298: #endif /* ifndef _SQLITE3RTREE_H_ */
! 7299:
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to sqlite3.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / win32 / sql / sqlite / include