1/* 2** 2001-09-15 3** 4** The author disclaims copyright to this source code. In place of 5** a legal notice, here is a blessing: 6** 7** May you do good and not evil. 8** May you find forgiveness for yourself and forgive others. 9** May you share freely, never taking more than you give. 10** 11************************************************************************* 12** This header file defines the interface that the SQLite library 13** presents to client programs. If a C-function, structure, datatype, 14** or constant definition does not appear in this file, then it is 15** not a published API of SQLite, is subject to change without 16** notice, and should not be referenced by programs that use SQLite. 17** 18** Some of the definitions that are in this file are marked as 19** "experimental". Experimental interfaces are normally new 20** features recently added to SQLite. We do not anticipate changes 21** to experimental interfaces but reserve the right to make minor changes 22** if experience from use "in the wild" suggest such changes are prudent. 23** 24** The official C-language API documentation for SQLite is derived 25** from comments in this file. This file is the authoritative source 26** on how SQLite interfaces are supposed to operate. 27** 28** The name of this file under configuration management is "sqlite.h.in". 29** The makefile makes some minor changes to this file (such as inserting 30** the version number) and changes its name to "sqlite3.h" as 31** part of the build process. 32*/ 33#ifndef SQLITE3_H 34#define SQLITE3_H 35#include <stdarg.h> /* Needed for the definition of va_list */ 36 37/* 38** Make sure we can call this stuff from C++. 39*/ 40#ifdef __cplusplus 41extern "C" { 42#endif 43 44 45/* 46** Facilitate override of interface linkage and calling conventions. 47** Be aware that these macros may not be used within this particular 48** translation of the amalgamation and its associated header file. 49** 50** The SQLITE_EXTERN and SQLITE_API macros are used to instruct the 51** compiler that the target identifier should have external linkage. 52** 53** The SQLITE_CDECL macro is used to set the calling convention for 54** public functions that accept a variable number of arguments. 55** 56** The SQLITE_APICALL macro is used to set the calling convention for 57** public functions that accept a fixed number of arguments. 58** 59** The SQLITE_STDCALL macro is no longer used and is now deprecated. 60** 61** The SQLITE_CALLBACK macro is used to set the calling convention for 62** function pointers. 63** 64** The SQLITE_SYSAPI macro is used to set the calling convention for 65** functions provided by the operating system. 66** 67** Currently, the SQLITE_CDECL, SQLITE_APICALL, SQLITE_CALLBACK, and 68** SQLITE_SYSAPI macros are used only when building for environments 69** that require non-default calling conventions. 70*/ 71#ifndef SQLITE_EXTERN 72# define SQLITE_EXTERN extern 73#endif 74#ifndef SQLITE_API 75# define SQLITE_API 76#endif 77#ifndef SQLITE_CDECL 78# define SQLITE_CDECL 79#endif 80#ifndef SQLITE_APICALL 81# define SQLITE_APICALL 82#endif 83#ifndef SQLITE_STDCALL 84# define SQLITE_STDCALL SQLITE_APICALL 85#endif 86#ifndef SQLITE_CALLBACK 87# define SQLITE_CALLBACK 88#endif 89#ifndef SQLITE_SYSAPI 90# define SQLITE_SYSAPI 91#endif 92 93/* 94** These no-op macros are used in front of interfaces to mark those 95** interfaces as either deprecated or experimental. New applications 96** should not use deprecated interfaces - they are supported for backwards 97** compatibility only. Application writers should be aware that 98** experimental interfaces are subject to change in point releases. 99** 100** These macros used to resolve to various kinds of compiler magic that 101** would generate warning messages when they were used. But that 102** compiler magic ended up generating such a flurry of bug reports 103** that we have taken it all out and gone back to using simple 104** noop macros. 105*/ 106#define SQLITE_DEPRECATED 107#define SQLITE_EXPERIMENTAL 108 109/* 110** Ensure these symbols were not defined by some previous header file. 111*/ 112#ifdef SQLITE_VERSION 113# undef SQLITE_VERSION 114#endif 115#ifdef SQLITE_VERSION_NUMBER 116# undef SQLITE_VERSION_NUMBER 117#endif 118 119/* 120** CAPI3REF: Compile-Time Library Version Numbers 121** 122** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header 123** evaluates to a string literal that is the SQLite version in the 124** format "X.Y.Z" where X is the major version number (always 3 for 125** SQLite3) and Y is the minor version number and Z is the release number.)^ 126** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer 127** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same 128** numbers used in [SQLITE_VERSION].)^ 129** The SQLITE_VERSION_NUMBER for any given release of SQLite will also 130** be larger than the release from which it is derived. Either Y will 131** be held constant and Z will be incremented or else Y will be incremented 132** and Z will be reset to zero. 133** 134** Since [version 3.6.18] ([dateof:3.6.18]), 135** SQLite source code has been stored in the 136** <a href="http://www.fossil-scm.org/">Fossil configuration management 137** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to 138** a string which identifies a particular check-in of SQLite 139** within its configuration management system. ^The SQLITE_SOURCE_ID 140** string contains the date and time of the check-in (UTC) and a SHA1 141** or SHA3-256 hash of the entire source tree. If the source code has 142** been edited in any way since it was last checked in, then the last 143** four hexadecimal digits of the hash may be modified. 144** 145** See also: [sqlite3_libversion()], 146** [sqlite3_libversion_number()], [sqlite3_sourceid()], 147** [sqlite_version()] and [sqlite_source_id()]. 148*/ 149#define SQLITE_VERSION "--VERS--" 150#define SQLITE_VERSION_NUMBER --VERSION-NUMBER-- 151#define SQLITE_SOURCE_ID "--SOURCE-ID--" 152 153/* 154** CAPI3REF: Run-Time Library Version Numbers 155** KEYWORDS: sqlite3_version sqlite3_sourceid 156** 157** These interfaces provide the same information as the [SQLITE_VERSION], 158** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros 159** but are associated with the library instead of the header file. ^(Cautious 160** programmers might include assert() statements in their application to 161** verify that values returned by these interfaces match the macros in 162** the header, and thus ensure that the application is 163** compiled with matching library and header files. 164** 165** <blockquote><pre> 166** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); 167** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 ); 168** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); 169** </pre></blockquote>)^ 170** 171** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] 172** macro. ^The sqlite3_libversion() function returns a pointer to the 173** to the sqlite3_version[] string constant. The sqlite3_libversion() 174** function is provided for use in DLLs since DLL users usually do not have 175** direct access to string constants within the DLL. ^The 176** sqlite3_libversion_number() function returns an integer equal to 177** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns 178** a pointer to a string constant whose value is the same as the 179** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built 180** using an edited copy of [the amalgamation], then the last four characters 181** of the hash might be different from [SQLITE_SOURCE_ID].)^ 182** 183** See also: [sqlite_version()] and [sqlite_source_id()]. 184*/ 185SQLITE_EXTERN const char sqlite3_version[]; 186const char *sqlite3_libversion(void); 187const char *sqlite3_sourceid(void); 188int sqlite3_libversion_number(void); 189 190/* 191** CAPI3REF: Run-Time Library Compilation Options Diagnostics 192** 193** ^The sqlite3_compileoption_used() function returns 0 or 1 194** indicating whether the specified option was defined at 195** compile time. ^The SQLITE_ prefix may be omitted from the 196** option name passed to sqlite3_compileoption_used(). 197** 198** ^The sqlite3_compileoption_get() function allows iterating 199** over the list of options that were defined at compile time by 200** returning the N-th compile time option string. ^If N is out of range, 201** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ 202** prefix is omitted from any strings returned by 203** sqlite3_compileoption_get(). 204** 205** ^Support for the diagnostic functions sqlite3_compileoption_used() 206** and sqlite3_compileoption_get() may be omitted by specifying the 207** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. 208** 209** See also: SQL functions [sqlite_compileoption_used()] and 210** [sqlite_compileoption_get()] and the [compile_options pragma]. 211*/ 212#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 213int sqlite3_compileoption_used(const char *zOptName); 214const char *sqlite3_compileoption_get(int N); 215#else 216# define sqlite3_compileoption_used(X) 0 217# define sqlite3_compileoption_get(X) ((void*)0) 218#endif 219 220/* 221** CAPI3REF: Test To See If The Library Is Threadsafe 222** 223** ^The sqlite3_threadsafe() function returns zero if and only if 224** SQLite was compiled with mutexing code omitted due to the 225** [SQLITE_THREADSAFE] compile-time option being set to 0. 226** 227** SQLite can be compiled with or without mutexes. When 228** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes 229** are enabled and SQLite is threadsafe. When the 230** [SQLITE_THREADSAFE] macro is 0, 231** the mutexes are omitted. Without the mutexes, it is not safe 232** to use SQLite concurrently from more than one thread. 233** 234** Enabling mutexes incurs a measurable performance penalty. 235** So if speed is of utmost importance, it makes sense to disable 236** the mutexes. But for maximum safety, mutexes should be enabled. 237** ^The default behavior is for mutexes to be enabled. 238** 239** This interface can be used by an application to make sure that the 240** version of SQLite that it is linking against was compiled with 241** the desired setting of the [SQLITE_THREADSAFE] macro. 242** 243** This interface only reports on the compile-time mutex setting 244** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with 245** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but 246** can be fully or partially disabled using a call to [sqlite3_config()] 247** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], 248** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the 249** sqlite3_threadsafe() function shows only the compile-time setting of 250** thread safety, not any run-time changes to that setting made by 251** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() 252** is unchanged by calls to sqlite3_config().)^ 253** 254** See the [threading mode] documentation for additional information. 255*/ 256int sqlite3_threadsafe(void); 257 258/* 259** CAPI3REF: Database Connection Handle 260** KEYWORDS: {database connection} {database connections} 261** 262** Each open SQLite database is represented by a pointer to an instance of 263** the opaque structure named "sqlite3". It is useful to think of an sqlite3 264** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 265** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 266** and [sqlite3_close_v2()] are its destructors. There are many other 267** interfaces (such as 268** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 269** [sqlite3_busy_timeout()] to name but three) that are methods on an 270** sqlite3 object. 271*/ 272typedef struct sqlite3 sqlite3; 273 274/* 275** CAPI3REF: 64-Bit Integer Types 276** KEYWORDS: sqlite_int64 sqlite_uint64 277** 278** Because there is no cross-platform way to specify 64-bit integer types 279** SQLite includes typedefs for 64-bit signed and unsigned integers. 280** 281** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. 282** The sqlite_int64 and sqlite_uint64 types are supported for backwards 283** compatibility only. 284** 285** ^The sqlite3_int64 and sqlite_int64 types can store integer values 286** between -9223372036854775808 and +9223372036854775807 inclusive. ^The 287** sqlite3_uint64 and sqlite_uint64 types can store integer values 288** between 0 and +18446744073709551615 inclusive. 289*/ 290#ifdef SQLITE_INT64_TYPE 291 typedef SQLITE_INT64_TYPE sqlite_int64; 292# ifdef SQLITE_UINT64_TYPE 293 typedef SQLITE_UINT64_TYPE sqlite_uint64; 294# else 295 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; 296# endif 297#elif defined(_MSC_VER) || defined(__BORLANDC__) 298 typedef __int64 sqlite_int64; 299 typedef unsigned __int64 sqlite_uint64; 300#else 301 typedef long long int sqlite_int64; 302 typedef unsigned long long int sqlite_uint64; 303#endif 304typedef sqlite_int64 sqlite3_int64; 305typedef sqlite_uint64 sqlite3_uint64; 306 307/* 308** If compiling for a processor that lacks floating point support, 309** substitute integer for floating-point. 310*/ 311#ifdef SQLITE_OMIT_FLOATING_POINT 312# define double sqlite3_int64 313#endif 314 315/* 316** CAPI3REF: Closing A Database Connection 317** DESTRUCTOR: sqlite3 318** 319** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors 320** for the [sqlite3] object. 321** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if 322** the [sqlite3] object is successfully destroyed and all associated 323** resources are deallocated. 324** 325** Ideally, applications should [sqlite3_finalize | finalize] all 326** [prepared statements], [sqlite3_blob_close | close] all [BLOB handles], and 327** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated 328** with the [sqlite3] object prior to attempting to close the object. 329** ^If the database connection is associated with unfinalized prepared 330** statements, BLOB handlers, and/or unfinished sqlite3_backup objects then 331** sqlite3_close() will leave the database connection open and return 332** [SQLITE_BUSY]. ^If sqlite3_close_v2() is called with unfinalized prepared 333** statements, unclosed BLOB handlers, and/or unfinished sqlite3_backups, 334** it returns [SQLITE_OK] regardless, but instead of deallocating the database 335** connection immediately, it marks the database connection as an unusable 336** "zombie" and makes arrangements to automatically deallocate the database 337** connection after all prepared statements are finalized, all BLOB handles 338** are closed, and all backups have finished. The sqlite3_close_v2() interface 339** is intended for use with host languages that are garbage collected, and 340** where the order in which destructors are called is arbitrary. 341** 342** ^If an [sqlite3] object is destroyed while a transaction is open, 343** the transaction is automatically rolled back. 344** 345** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)] 346** must be either a NULL 347** pointer or an [sqlite3] object pointer obtained 348** from [sqlite3_open()], [sqlite3_open16()], or 349** [sqlite3_open_v2()], and not previously closed. 350** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer 351** argument is a harmless no-op. 352*/ 353int sqlite3_close(sqlite3*); 354int sqlite3_close_v2(sqlite3*); 355 356/* 357** The type for a callback function. 358** This is legacy and deprecated. It is included for historical 359** compatibility and is not documented. 360*/ 361typedef int (*sqlite3_callback)(void*,int,char**, char**); 362 363/* 364** CAPI3REF: One-Step Query Execution Interface 365** METHOD: sqlite3 366** 367** The sqlite3_exec() interface is a convenience wrapper around 368** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], 369** that allows an application to run multiple statements of SQL 370** without having to use a lot of C code. 371** 372** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, 373** semicolon-separate SQL statements passed into its 2nd argument, 374** in the context of the [database connection] passed in as its 1st 375** argument. ^If the callback function of the 3rd argument to 376** sqlite3_exec() is not NULL, then it is invoked for each result row 377** coming out of the evaluated SQL statements. ^The 4th argument to 378** sqlite3_exec() is relayed through to the 1st argument of each 379** callback invocation. ^If the callback pointer to sqlite3_exec() 380** is NULL, then no callback is ever invoked and result rows are 381** ignored. 382** 383** ^If an error occurs while evaluating the SQL statements passed into 384** sqlite3_exec(), then execution of the current statement stops and 385** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() 386** is not NULL then any error message is written into memory obtained 387** from [sqlite3_malloc()] and passed back through the 5th parameter. 388** To avoid memory leaks, the application should invoke [sqlite3_free()] 389** on error message strings returned through the 5th parameter of 390** sqlite3_exec() after the error message string is no longer needed. 391** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors 392** occur, then sqlite3_exec() sets the pointer in its 5th parameter to 393** NULL before returning. 394** 395** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() 396** routine returns SQLITE_ABORT without invoking the callback again and 397** without running any subsequent SQL statements. 398** 399** ^The 2nd argument to the sqlite3_exec() callback function is the 400** number of columns in the result. ^The 3rd argument to the sqlite3_exec() 401** callback is an array of pointers to strings obtained as if from 402** [sqlite3_column_text()], one for each column. ^If an element of a 403** result row is NULL then the corresponding string pointer for the 404** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the 405** sqlite3_exec() callback is an array of pointers to strings where each 406** entry represents the name of corresponding result column as obtained 407** from [sqlite3_column_name()]. 408** 409** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer 410** to an empty string, or a pointer that contains only whitespace and/or 411** SQL comments, then no SQL statements are evaluated and the database 412** is not changed. 413** 414** Restrictions: 415** 416** <ul> 417** <li> The application must ensure that the 1st parameter to sqlite3_exec() 418** is a valid and open [database connection]. 419** <li> The application must not close the [database connection] specified by 420** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. 421** <li> The application must not modify the SQL statement text passed into 422** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. 423** </ul> 424*/ 425int sqlite3_exec( 426 sqlite3*, /* An open database */ 427 const char *sql, /* SQL to be evaluated */ 428 int (*callback)(void*,int,char**,char**), /* Callback function */ 429 void *, /* 1st argument to callback */ 430 char **errmsg /* Error msg written here */ 431); 432 433/* 434** CAPI3REF: Result Codes 435** KEYWORDS: {result code definitions} 436** 437** Many SQLite functions return an integer result code from the set shown 438** here in order to indicate success or failure. 439** 440** New error codes may be added in future versions of SQLite. 441** 442** See also: [extended result code definitions] 443*/ 444#define SQLITE_OK 0 /* Successful result */ 445/* beginning-of-error-codes */ 446#define SQLITE_ERROR 1 /* Generic error */ 447#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 448#define SQLITE_PERM 3 /* Access permission denied */ 449#define SQLITE_ABORT 4 /* Callback routine requested an abort */ 450#define SQLITE_BUSY 5 /* The database file is locked */ 451#define SQLITE_LOCKED 6 /* A table in the database is locked */ 452#define SQLITE_NOMEM 7 /* A malloc() failed */ 453#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 454#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 455#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 456#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 457#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ 458#define SQLITE_FULL 13 /* Insertion failed because database is full */ 459#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 460#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ 461#define SQLITE_EMPTY 16 /* Internal use only */ 462#define SQLITE_SCHEMA 17 /* The database schema changed */ 463#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 464#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 465#define SQLITE_MISMATCH 20 /* Data type mismatch */ 466#define SQLITE_MISUSE 21 /* Library used incorrectly */ 467#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 468#define SQLITE_AUTH 23 /* Authorization denied */ 469#define SQLITE_FORMAT 24 /* Not used */ 470#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 471#define SQLITE_NOTADB 26 /* File opened that is not a database file */ 472#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */ 473#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */ 474#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 475#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 476/* end-of-error-codes */ 477 478/* 479** CAPI3REF: Extended Result Codes 480** KEYWORDS: {extended result code definitions} 481** 482** In its default configuration, SQLite API routines return one of 30 integer 483** [result codes]. However, experience has shown that many of 484** these result codes are too coarse-grained. They do not provide as 485** much information about problems as programmers might like. In an effort to 486** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8] 487** and later) include 488** support for additional result codes that provide more detailed information 489** about errors. These [extended result codes] are enabled or disabled 490** on a per database connection basis using the 491** [sqlite3_extended_result_codes()] API. Or, the extended code for 492** the most recent error can be obtained using 493** [sqlite3_extended_errcode()]. 494*/ 495#define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8)) 496#define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8)) 497#define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR | (3<<8)) 498#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 499#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 500#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 501#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 502#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 503#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 504#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 505#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 506#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 507#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 508#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 509#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 510#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 511#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 512#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 513#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 514#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 515#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) 516#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) 517#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) 518#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) 519#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) 520#define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8)) 521#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8)) 522#define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8)) 523#define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8)) 524#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8)) 525#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8)) 526#define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR | (29<<8)) 527#define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR | (30<<8)) 528#define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR | (31<<8)) 529#define SQLITE_IOERR_DATA (SQLITE_IOERR | (32<<8)) 530#define SQLITE_IOERR_CORRUPTFS (SQLITE_IOERR | (33<<8)) 531#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) 532#define SQLITE_LOCKED_VTAB (SQLITE_LOCKED | (2<<8)) 533#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) 534#define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8)) 535#define SQLITE_BUSY_TIMEOUT (SQLITE_BUSY | (3<<8)) 536#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) 537#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) 538#define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8)) 539#define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8)) 540#define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN | (5<<8)) /* Not Used */ 541#define SQLITE_CANTOPEN_SYMLINK (SQLITE_CANTOPEN | (6<<8)) 542#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) 543#define SQLITE_CORRUPT_SEQUENCE (SQLITE_CORRUPT | (2<<8)) 544#define SQLITE_CORRUPT_INDEX (SQLITE_CORRUPT | (3<<8)) 545#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) 546#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) 547#define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8)) 548#define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8)) 549#define SQLITE_READONLY_CANTINIT (SQLITE_READONLY | (5<<8)) 550#define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY | (6<<8)) 551#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) 552#define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8)) 553#define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8)) 554#define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8)) 555#define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8)) 556#define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8)) 557#define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8)) 558#define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8)) 559#define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8)) 560#define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8)) 561#define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8)) 562#define SQLITE_CONSTRAINT_PINNED (SQLITE_CONSTRAINT |(11<<8)) 563#define SQLITE_CONSTRAINT_DATATYPE (SQLITE_CONSTRAINT |(12<<8)) 564#define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8)) 565#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8)) 566#define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8)) 567#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8)) 568#define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8)) 569#define SQLITE_OK_SYMLINK (SQLITE_OK | (2<<8)) /* internal use only */ 570 571/* 572** CAPI3REF: Flags For File Open Operations 573** 574** These bit values are intended for use in the 575** 3rd parameter to the [sqlite3_open_v2()] interface and 576** in the 4th parameter to the [sqlite3_vfs.xOpen] method. 577** 578** Only those flags marked as "Ok for sqlite3_open_v2()" may be 579** used as the third argument to the [sqlite3_open_v2()] interface. 580** The other flags have historically been ignored by sqlite3_open_v2(), 581** though future versions of SQLite might change so that an error is 582** raised if any of the disallowed bits are passed into sqlite3_open_v2(). 583** Applications should not depend on the historical behavior. 584** 585** Note in particular that passing the SQLITE_OPEN_EXCLUSIVE flag into 586** [sqlite3_open_v2()] does *not* cause the underlying database file 587** to be opened using O_EXCL. Passing SQLITE_OPEN_EXCLUSIVE into 588** [sqlite3_open_v2()] has historically be a no-op and might become an 589** error in future versions of SQLite. 590*/ 591#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ 592#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ 593#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ 594#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ 595#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ 596#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ 597#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ 598#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */ 599#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ 600#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ 601#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ 602#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ 603#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ 604#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ 605#define SQLITE_OPEN_SUPER_JOURNAL 0x00004000 /* VFS only */ 606#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ 607#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ 608#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ 609#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ 610#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ 611#define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for sqlite3_open_v2() */ 612#define SQLITE_OPEN_EXRESCODE 0x02000000 /* Extended result codes */ 613 614/* Reserved: 0x00F00000 */ 615/* Legacy compatibility: */ 616#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ 617 618 619/* 620** CAPI3REF: Device Characteristics 621** 622** The xDeviceCharacteristics method of the [sqlite3_io_methods] 623** object returns an integer which is a vector of these 624** bit values expressing I/O characteristics of the mass storage 625** device that holds the file that the [sqlite3_io_methods] 626** refers to. 627** 628** The SQLITE_IOCAP_ATOMIC property means that all writes of 629** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 630** mean that writes of blocks that are nnn bytes in size and 631** are aligned to an address which is an integer multiple of 632** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 633** that when data is appended to a file, the data is appended 634** first then the size of the file is extended, never the other 635** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 636** information is written to disk in the same order as calls 637** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that 638** after reboot following a crash or power loss, the only bytes in a 639** file that were written at the application level might have changed 640** and that adjacent bytes, even bytes within the same sector are 641** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 642** flag indicates that a file cannot be deleted when open. The 643** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on 644** read-only media and cannot be changed even by processes with 645** elevated privileges. 646** 647** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying 648** filesystem supports doing multiple write operations atomically when those 649** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and 650** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. 651*/ 652#define SQLITE_IOCAP_ATOMIC 0x00000001 653#define SQLITE_IOCAP_ATOMIC512 0x00000002 654#define SQLITE_IOCAP_ATOMIC1K 0x00000004 655#define SQLITE_IOCAP_ATOMIC2K 0x00000008 656#define SQLITE_IOCAP_ATOMIC4K 0x00000010 657#define SQLITE_IOCAP_ATOMIC8K 0x00000020 658#define SQLITE_IOCAP_ATOMIC16K 0x00000040 659#define SQLITE_IOCAP_ATOMIC32K 0x00000080 660#define SQLITE_IOCAP_ATOMIC64K 0x00000100 661#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 662#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 663#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 664#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 665#define SQLITE_IOCAP_IMMUTABLE 0x00002000 666#define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000 667 668/* 669** CAPI3REF: File Locking Levels 670** 671** SQLite uses one of these integer values as the second 672** argument to calls it makes to the xLock() and xUnlock() methods 673** of an [sqlite3_io_methods] object. These values are ordered from 674** lest restrictive to most restrictive. 675** 676** The argument to xLock() is always SHARED or higher. The argument to 677** xUnlock is either SHARED or NONE. 678*/ 679#define SQLITE_LOCK_NONE 0 /* xUnlock() only */ 680#define SQLITE_LOCK_SHARED 1 /* xLock() or xUnlock() */ 681#define SQLITE_LOCK_RESERVED 2 /* xLock() only */ 682#define SQLITE_LOCK_PENDING 3 /* xLock() only */ 683#define SQLITE_LOCK_EXCLUSIVE 4 /* xLock() only */ 684 685/* 686** CAPI3REF: Synchronization Type Flags 687** 688** When SQLite invokes the xSync() method of an 689** [sqlite3_io_methods] object it uses a combination of 690** these integer values as the second argument. 691** 692** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 693** sync operation only needs to flush data to mass storage. Inode 694** information need not be flushed. If the lower four bits of the flag 695** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. 696** If the lower four bits equal SQLITE_SYNC_FULL, that means 697** to use Mac OS X style fullsync instead of fsync(). 698** 699** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags 700** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL 701** settings. The [synchronous pragma] determines when calls to the 702** xSync VFS method occur and applies uniformly across all platforms. 703** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how 704** energetic or rigorous or forceful the sync operations are and 705** only make a difference on Mac OSX for the default SQLite code. 706** (Third-party VFS implementations might also make the distinction 707** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the 708** operating systems natively supported by SQLite, only Mac OSX 709** cares about the difference.) 710*/ 711#define SQLITE_SYNC_NORMAL 0x00002 712#define SQLITE_SYNC_FULL 0x00003 713#define SQLITE_SYNC_DATAONLY 0x00010 714 715/* 716** CAPI3REF: OS Interface Open File Handle 717** 718** An [sqlite3_file] object represents an open file in the 719** [sqlite3_vfs | OS interface layer]. Individual OS interface 720** implementations will 721** want to subclass this object by appending additional fields 722** for their own use. The pMethods entry is a pointer to an 723** [sqlite3_io_methods] object that defines methods for performing 724** I/O operations on the open file. 725*/ 726typedef struct sqlite3_file sqlite3_file; 727struct sqlite3_file { 728 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 729}; 730 731/* 732** CAPI3REF: OS Interface File Virtual Methods Object 733** 734** Every file opened by the [sqlite3_vfs.xOpen] method populates an 735** [sqlite3_file] object (or, more commonly, a subclass of the 736** [sqlite3_file] object) with a pointer to an instance of this object. 737** This object defines the methods used to perform various operations 738** against the open file represented by the [sqlite3_file] object. 739** 740** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element 741** to a non-NULL pointer, then the sqlite3_io_methods.xClose method 742** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The 743** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] 744** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element 745** to NULL. 746** 747** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 748** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 749** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] 750** flag may be ORed in to indicate that only the data of the file 751** and not its inode needs to be synced. 752** 753** The integer values to xLock() and xUnlock() are one of 754** <ul> 755** <li> [SQLITE_LOCK_NONE], 756** <li> [SQLITE_LOCK_SHARED], 757** <li> [SQLITE_LOCK_RESERVED], 758** <li> [SQLITE_LOCK_PENDING], or 759** <li> [SQLITE_LOCK_EXCLUSIVE]. 760** </ul> 761** xLock() upgrades the database file lock. In other words, xLock() moves the 762** database file lock in the direction NONE toward EXCLUSIVE. The argument to 763** xLock() is always on of SHARED, RESERVED, PENDING, or EXCLUSIVE, never 764** SQLITE_LOCK_NONE. If the database file lock is already at or above the 765** requested lock, then the call to xLock() is a no-op. 766** xUnlock() downgrades the database file lock to either SHARED or NONE. 767* If the lock is already at or below the requested lock state, then the call 768** to xUnlock() is a no-op. 769** The xCheckReservedLock() method checks whether any database connection, 770** either in this process or in some other process, is holding a RESERVED, 771** PENDING, or EXCLUSIVE lock on the file. It returns true 772** if such a lock exists and false otherwise. 773** 774** The xFileControl() method is a generic interface that allows custom 775** VFS implementations to directly control an open file using the 776** [sqlite3_file_control()] interface. The second "op" argument is an 777** integer opcode. The third argument is a generic pointer intended to 778** point to a structure that may contain arguments or space in which to 779** write return values. Potential uses for xFileControl() might be 780** functions to enable blocking locks with timeouts, to change the 781** locking strategy (for example to use dot-file locks), to inquire 782** about the status of a lock, or to break stale locks. The SQLite 783** core reserves all opcodes less than 100 for its own use. 784** A [file control opcodes | list of opcodes] less than 100 is available. 785** Applications that define a custom xFileControl method should use opcodes 786** greater than 100 to avoid conflicts. VFS implementations should 787** return [SQLITE_NOTFOUND] for file control opcodes that they do not 788** recognize. 789** 790** The xSectorSize() method returns the sector size of the 791** device that underlies the file. The sector size is the 792** minimum write that can be performed without disturbing 793** other bytes in the file. The xDeviceCharacteristics() 794** method returns a bit vector describing behaviors of the 795** underlying device: 796** 797** <ul> 798** <li> [SQLITE_IOCAP_ATOMIC] 799** <li> [SQLITE_IOCAP_ATOMIC512] 800** <li> [SQLITE_IOCAP_ATOMIC1K] 801** <li> [SQLITE_IOCAP_ATOMIC2K] 802** <li> [SQLITE_IOCAP_ATOMIC4K] 803** <li> [SQLITE_IOCAP_ATOMIC8K] 804** <li> [SQLITE_IOCAP_ATOMIC16K] 805** <li> [SQLITE_IOCAP_ATOMIC32K] 806** <li> [SQLITE_IOCAP_ATOMIC64K] 807** <li> [SQLITE_IOCAP_SAFE_APPEND] 808** <li> [SQLITE_IOCAP_SEQUENTIAL] 809** <li> [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN] 810** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE] 811** <li> [SQLITE_IOCAP_IMMUTABLE] 812** <li> [SQLITE_IOCAP_BATCH_ATOMIC] 813** </ul> 814** 815** The SQLITE_IOCAP_ATOMIC property means that all writes of 816** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 817** mean that writes of blocks that are nnn bytes in size and 818** are aligned to an address which is an integer multiple of 819** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 820** that when data is appended to a file, the data is appended 821** first then the size of the file is extended, never the other 822** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 823** information is written to disk in the same order as calls 824** to xWrite(). 825** 826** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill 827** in the unread portions of the buffer with zeros. A VFS that 828** fails to zero-fill short reads might seem to work. However, 829** failure to zero-fill short reads will eventually lead to 830** database corruption. 831*/ 832typedef struct sqlite3_io_methods sqlite3_io_methods; 833struct sqlite3_io_methods { 834 int iVersion; 835 int (*xClose)(sqlite3_file*); 836 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); 837 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 838 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 839 int (*xSync)(sqlite3_file*, int flags); 840 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 841 int (*xLock)(sqlite3_file*, int); 842 int (*xUnlock)(sqlite3_file*, int); 843 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 844 int (*xFileControl)(sqlite3_file*, int op, void *pArg); 845 int (*xSectorSize)(sqlite3_file*); 846 int (*xDeviceCharacteristics)(sqlite3_file*); 847 /* Methods above are valid for version 1 */ 848 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); 849 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); 850 void (*xShmBarrier)(sqlite3_file*); 851 int (*xShmUnmap)(sqlite3_file*, int deleteFlag); 852 /* Methods above are valid for version 2 */ 853 int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp); 854 int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p); 855 /* Methods above are valid for version 3 */ 856 /* Additional methods may be added in future releases */ 857}; 858 859/* 860** CAPI3REF: Standard File Control Opcodes 861** KEYWORDS: {file control opcodes} {file control opcode} 862** 863** These integer constants are opcodes for the xFileControl method 864** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 865** interface. 866** 867** <ul> 868** <li>[[SQLITE_FCNTL_LOCKSTATE]] 869** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 870** opcode causes the xFileControl method to write the current state of 871** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 872** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 873** into an integer that the pArg argument points to. 874** This capability is only available if SQLite is compiled with [SQLITE_DEBUG]. 875** 876** <li>[[SQLITE_FCNTL_SIZE_HINT]] 877** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS 878** layer a hint of how large the database file will grow to be during the 879** current transaction. This hint is not guaranteed to be accurate but it 880** is often close. The underlying VFS might choose to preallocate database 881** file space based on this hint in order to help writes to the database 882** file run faster. 883** 884** <li>[[SQLITE_FCNTL_SIZE_LIMIT]] 885** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that 886** implements [sqlite3_deserialize()] to set an upper bound on the size 887** of the in-memory database. The argument is a pointer to a [sqlite3_int64]. 888** If the integer pointed to is negative, then it is filled in with the 889** current limit. Otherwise the limit is set to the larger of the value 890** of the integer pointed to and the current database size. The integer 891** pointed to is set to the new limit. 892** 893** <li>[[SQLITE_FCNTL_CHUNK_SIZE]] 894** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS 895** extends and truncates the database file in chunks of a size specified 896** by the user. The fourth argument to [sqlite3_file_control()] should 897** point to an integer (type int) containing the new chunk-size to use 898** for the nominated database. Allocating database file space in large 899** chunks (say 1MB at a time), may reduce file-system fragmentation and 900** improve performance on some systems. 901** 902** <li>[[SQLITE_FCNTL_FILE_POINTER]] 903** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer 904** to the [sqlite3_file] object associated with a particular database 905** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER]. 906** 907** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]] 908** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer 909** to the [sqlite3_file] object associated with the journal file (either 910** the [rollback journal] or the [write-ahead log]) for a particular database 911** connection. See also [SQLITE_FCNTL_FILE_POINTER]. 912** 913** <li>[[SQLITE_FCNTL_SYNC_OMITTED]] 914** No longer in use. 915** 916** <li>[[SQLITE_FCNTL_SYNC]] 917** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and 918** sent to the VFS immediately before the xSync method is invoked on a 919** database file descriptor. Or, if the xSync method is not invoked 920** because the user has configured SQLite with 921** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place 922** of the xSync method. In most cases, the pointer argument passed with 923** this file-control is NULL. However, if the database file is being synced 924** as part of a multi-database commit, the argument points to a nul-terminated 925** string containing the transactions super-journal file name. VFSes that 926** do not need this signal should silently ignore this opcode. Applications 927** should not call [sqlite3_file_control()] with this opcode as doing so may 928** disrupt the operation of the specialized VFSes that do require it. 929** 930** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]] 931** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite 932** and sent to the VFS after a transaction has been committed immediately 933** but before the database is unlocked. VFSes that do not need this signal 934** should silently ignore this opcode. Applications should not call 935** [sqlite3_file_control()] with this opcode as doing so may disrupt the 936** operation of the specialized VFSes that do require it. 937** 938** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]] 939** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic 940** retry counts and intervals for certain disk I/O operations for the 941** windows [VFS] in order to provide robustness in the presence of 942** anti-virus programs. By default, the windows VFS will retry file read, 943** file write, and file delete operations up to 10 times, with a delay 944** of 25 milliseconds before the first retry and with the delay increasing 945** by an additional 25 milliseconds with each subsequent retry. This 946** opcode allows these two values (10 retries and 25 milliseconds of delay) 947** to be adjusted. The values are changed for all database connections 948** within the same process. The argument is a pointer to an array of two 949** integers where the first integer is the new retry count and the second 950** integer is the delay. If either integer is negative, then the setting 951** is not changed but instead the prior value of that setting is written 952** into the array entry, allowing the current retry settings to be 953** interrogated. The zDbName parameter is ignored. 954** 955** <li>[[SQLITE_FCNTL_PERSIST_WAL]] 956** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the 957** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary 958** write ahead log ([WAL file]) and shared memory 959** files used for transaction control 960** are automatically deleted when the latest connection to the database 961** closes. Setting persistent WAL mode causes those files to persist after 962** close. Persisting the files is useful when other processes that do not 963** have write permission on the directory containing the database file want 964** to read the database file, as the WAL and shared memory files must exist 965** in order for the database to be readable. The fourth parameter to 966** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 967** That integer is 0 to disable persistent WAL mode or 1 to enable persistent 968** WAL mode. If the integer is -1, then it is overwritten with the current 969** WAL persistence setting. 970** 971** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] 972** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the 973** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting 974** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the 975** xDeviceCharacteristics methods. The fourth parameter to 976** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 977** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage 978** mode. If the integer is -1, then it is overwritten with the current 979** zero-damage mode setting. 980** 981** <li>[[SQLITE_FCNTL_OVERWRITE]] 982** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening 983** a write transaction to indicate that, unless it is rolled back for some 984** reason, the entire database file will be overwritten by the current 985** transaction. This is used by VACUUM operations. 986** 987** <li>[[SQLITE_FCNTL_VFSNAME]] 988** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of 989** all [VFSes] in the VFS stack. The names are of all VFS shims and the 990** final bottom-level VFS are written into memory obtained from 991** [sqlite3_malloc()] and the result is stored in the char* variable 992** that the fourth parameter of [sqlite3_file_control()] points to. 993** The caller is responsible for freeing the memory when done. As with 994** all file-control actions, there is no guarantee that this will actually 995** do anything. Callers should initialize the char* variable to a NULL 996** pointer in case this file-control is not implemented. This file-control 997** is intended for diagnostic use only. 998** 999** <li>[[SQLITE_FCNTL_VFS_POINTER]] 1000** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level 1001** [VFSes] currently in use. ^(The argument X in 1002** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be 1003** of type "[sqlite3_vfs] **". This opcodes will set *X 1004** to a pointer to the top-level VFS.)^ 1005** ^When there are multiple VFS shims in the stack, this opcode finds the 1006** upper-most shim only. 1007** 1008** <li>[[SQLITE_FCNTL_PRAGMA]] 1009** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] 1010** file control is sent to the open [sqlite3_file] object corresponding 1011** to the database file to which the pragma statement refers. ^The argument 1012** to the [SQLITE_FCNTL_PRAGMA] file control is an array of 1013** pointers to strings (char**) in which the second element of the array 1014** is the name of the pragma and the third element is the argument to the 1015** pragma or NULL if the pragma has no argument. ^The handler for an 1016** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element 1017** of the char** argument point to a string obtained from [sqlite3_mprintf()] 1018** or the equivalent and that string will become the result of the pragma or 1019** the error message if the pragma fails. ^If the 1020** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal 1021** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] 1022** file control returns [SQLITE_OK], then the parser assumes that the 1023** VFS has handled the PRAGMA itself and the parser generates a no-op 1024** prepared statement if result string is NULL, or that returns a copy 1025** of the result string if the string is non-NULL. 1026** ^If the [SQLITE_FCNTL_PRAGMA] file control returns 1027** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means 1028** that the VFS encountered an error while handling the [PRAGMA] and the 1029** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] 1030** file control occurs at the beginning of pragma statement analysis and so 1031** it is able to override built-in [PRAGMA] statements. 1032** 1033** <li>[[SQLITE_FCNTL_BUSYHANDLER]] 1034** ^The [SQLITE_FCNTL_BUSYHANDLER] 1035** file-control may be invoked by SQLite on the database file handle 1036** shortly after it is opened in order to provide a custom VFS with access 1037** to the connection's busy-handler callback. The argument is of type (void**) 1038** - an array of two (void *) values. The first (void *) actually points 1039** to a function of type (int (*)(void *)). In order to invoke the connection's 1040** busy-handler, this function should be invoked with the second (void *) in 1041** the array as the only argument. If it returns non-zero, then the operation 1042** should be retried. If it returns zero, the custom VFS should abandon the 1043** current operation. 1044** 1045** <li>[[SQLITE_FCNTL_TEMPFILENAME]] 1046** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control 1047** to have SQLite generate a 1048** temporary filename using the same algorithm that is followed to generate 1049** temporary filenames for TEMP tables and other internal uses. The 1050** argument should be a char** which will be filled with the filename 1051** written into memory obtained from [sqlite3_malloc()]. The caller should 1052** invoke [sqlite3_free()] on the result to avoid a memory leak. 1053** 1054** <li>[[SQLITE_FCNTL_MMAP_SIZE]] 1055** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the 1056** maximum number of bytes that will be used for memory-mapped I/O. 1057** The argument is a pointer to a value of type sqlite3_int64 that 1058** is an advisory maximum number of bytes in the file to memory map. The 1059** pointer is overwritten with the old value. The limit is not changed if 1060** the value originally pointed to is negative, and so the current limit 1061** can be queried by passing in a pointer to a negative number. This 1062** file-control is used internally to implement [PRAGMA mmap_size]. 1063** 1064** <li>[[SQLITE_FCNTL_TRACE]] 1065** The [SQLITE_FCNTL_TRACE] file control provides advisory information 1066** to the VFS about what the higher layers of the SQLite stack are doing. 1067** This file control is used by some VFS activity tracing [shims]. 1068** The argument is a zero-terminated string. Higher layers in the 1069** SQLite stack may generate instances of this file control if 1070** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled. 1071** 1072** <li>[[SQLITE_FCNTL_HAS_MOVED]] 1073** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a 1074** pointer to an integer and it writes a boolean into that integer depending 1075** on whether or not the file has been renamed, moved, or deleted since it 1076** was first opened. 1077** 1078** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]] 1079** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the 1080** underlying native file handle associated with a file handle. This file 1081** control interprets its argument as a pointer to a native file handle and 1082** writes the resulting value there. 1083** 1084** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]] 1085** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This 1086** opcode causes the xFileControl method to swap the file handle with the one 1087** pointed to by the pArg argument. This capability is used during testing 1088** and only needs to be supported when SQLITE_TEST is defined. 1089** 1090** <li>[[SQLITE_FCNTL_WAL_BLOCK]] 1091** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might 1092** be advantageous to block on the next WAL lock if the lock is not immediately 1093** available. The WAL subsystem issues this signal during rare 1094** circumstances in order to fix a problem with priority inversion. 1095** Applications should <em>not</em> use this file-control. 1096** 1097** <li>[[SQLITE_FCNTL_ZIPVFS]] 1098** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other 1099** VFS should return SQLITE_NOTFOUND for this opcode. 1100** 1101** <li>[[SQLITE_FCNTL_RBU]] 1102** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by 1103** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for 1104** this opcode. 1105** 1106** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]] 1107** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then 1108** the file descriptor is placed in "batch write mode", which 1109** means all subsequent write operations will be deferred and done 1110** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems 1111** that do not support batch atomic writes will return SQLITE_NOTFOUND. 1112** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to 1113** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or 1114** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make 1115** no VFS interface calls on the same [sqlite3_file] file descriptor 1116** except for calls to the xWrite method and the xFileControl method 1117** with [SQLITE_FCNTL_SIZE_HINT]. 1118** 1119** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]] 1120** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write 1121** operations since the previous successful call to 1122** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically. 1123** This file control returns [SQLITE_OK] if and only if the writes were 1124** all performed successfully and have been committed to persistent storage. 1125** ^Regardless of whether or not it is successful, this file control takes 1126** the file descriptor out of batch write mode so that all subsequent 1127** write operations are independent. 1128** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without 1129** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. 1130** 1131** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]] 1132** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write 1133** operations since the previous successful call to 1134** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back. 1135** ^This file control takes the file descriptor out of batch write mode 1136** so that all subsequent write operations are independent. 1137** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without 1138** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. 1139** 1140** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]] 1141** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode is used to configure a VFS 1142** to block for up to M milliseconds before failing when attempting to 1143** obtain a file lock using the xLock or xShmLock methods of the VFS. 1144** The parameter is a pointer to a 32-bit signed integer that contains 1145** the value that M is to be set to. Before returning, the 32-bit signed 1146** integer is overwritten with the previous value of M. 1147** 1148** <li>[[SQLITE_FCNTL_DATA_VERSION]] 1149** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to 1150** a database file. The argument is a pointer to a 32-bit unsigned integer. 1151** The "data version" for the pager is written into the pointer. The 1152** "data version" changes whenever any change occurs to the corresponding 1153** database file, either through SQL statements on the same database 1154** connection or through transactions committed by separate database 1155** connections possibly in other processes. The [sqlite3_total_changes()] 1156** interface can be used to find if any database on the connection has changed, 1157** but that interface responds to changes on TEMP as well as MAIN and does 1158** not provide a mechanism to detect changes to MAIN only. Also, the 1159** [sqlite3_total_changes()] interface responds to internal changes only and 1160** omits changes made by other database connections. The 1161** [PRAGMA data_version] command provides a mechanism to detect changes to 1162** a single attached database that occur due to other database connections, 1163** but omits changes implemented by the database connection on which it is 1164** called. This file control is the only mechanism to detect changes that 1165** happen either internally or externally and that are associated with 1166** a particular attached database. 1167** 1168** <li>[[SQLITE_FCNTL_CKPT_START]] 1169** The [SQLITE_FCNTL_CKPT_START] opcode is invoked from within a checkpoint 1170** in wal mode before the client starts to copy pages from the wal 1171** file to the database file. 1172** 1173** <li>[[SQLITE_FCNTL_CKPT_DONE]] 1174** The [SQLITE_FCNTL_CKPT_DONE] opcode is invoked from within a checkpoint 1175** in wal mode after the client has finished copying pages from the wal 1176** file to the database file, but before the *-shm file is updated to 1177** record the fact that the pages have been checkpointed. 1178** </ul> 1179** 1180** <li>[[SQLITE_FCNTL_EXTERNAL_READER]] 1181** The EXPERIMENTAL [SQLITE_FCNTL_EXTERNAL_READER] opcode is used to detect 1182** whether or not there is a database client in another process with a wal-mode 1183** transaction open on the database or not. It is only available on unix.The 1184** (void*) argument passed with this file-control should be a pointer to a 1185** value of type (int). The integer value is set to 1 if the database is a wal 1186** mode database and there exists at least one client in another process that 1187** currently has an SQL transaction open on the database. It is set to 0 if 1188** the database is not a wal-mode db, or if there is no such connection in any 1189** other process. This opcode cannot be used to detect transactions opened 1190** by clients within the current process, only within other processes. 1191** </ul> 1192** 1193** <li>[[SQLITE_FCNTL_CKSM_FILE]] 1194** Used by the cksmvfs VFS module only. 1195** </ul> 1196*/ 1197#define SQLITE_FCNTL_LOCKSTATE 1 1198#define SQLITE_FCNTL_GET_LOCKPROXYFILE 2 1199#define SQLITE_FCNTL_SET_LOCKPROXYFILE 3 1200#define SQLITE_FCNTL_LAST_ERRNO 4 1201#define SQLITE_FCNTL_SIZE_HINT 5 1202#define SQLITE_FCNTL_CHUNK_SIZE 6 1203#define SQLITE_FCNTL_FILE_POINTER 7 1204#define SQLITE_FCNTL_SYNC_OMITTED 8 1205#define SQLITE_FCNTL_WIN32_AV_RETRY 9 1206#define SQLITE_FCNTL_PERSIST_WAL 10 1207#define SQLITE_FCNTL_OVERWRITE 11 1208#define SQLITE_FCNTL_VFSNAME 12 1209#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 1210#define SQLITE_FCNTL_PRAGMA 14 1211#define SQLITE_FCNTL_BUSYHANDLER 15 1212#define SQLITE_FCNTL_TEMPFILENAME 16 1213#define SQLITE_FCNTL_MMAP_SIZE 18 1214#define SQLITE_FCNTL_TRACE 19 1215#define SQLITE_FCNTL_HAS_MOVED 20 1216#define SQLITE_FCNTL_SYNC 21 1217#define SQLITE_FCNTL_COMMIT_PHASETWO 22 1218#define SQLITE_FCNTL_WIN32_SET_HANDLE 23 1219#define SQLITE_FCNTL_WAL_BLOCK 24 1220#define SQLITE_FCNTL_ZIPVFS 25 1221#define SQLITE_FCNTL_RBU 26 1222#define SQLITE_FCNTL_VFS_POINTER 27 1223#define SQLITE_FCNTL_JOURNAL_POINTER 28 1224#define SQLITE_FCNTL_WIN32_GET_HANDLE 29 1225#define SQLITE_FCNTL_PDB 30 1226#define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31 1227#define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32 1228#define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33 1229#define SQLITE_FCNTL_LOCK_TIMEOUT 34 1230#define SQLITE_FCNTL_DATA_VERSION 35 1231#define SQLITE_FCNTL_SIZE_LIMIT 36 1232#define SQLITE_FCNTL_CKPT_DONE 37 1233#define SQLITE_FCNTL_RESERVE_BYTES 38 1234#define SQLITE_FCNTL_CKPT_START 39 1235#define SQLITE_FCNTL_EXTERNAL_READER 40 1236#define SQLITE_FCNTL_CKSM_FILE 41 1237 1238/* deprecated names */ 1239#define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE 1240#define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE 1241#define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO 1242 1243 1244/* 1245** CAPI3REF: Mutex Handle 1246** 1247** The mutex module within SQLite defines [sqlite3_mutex] to be an 1248** abstract type for a mutex object. The SQLite core never looks 1249** at the internal representation of an [sqlite3_mutex]. It only 1250** deals with pointers to the [sqlite3_mutex] object. 1251** 1252** Mutexes are created using [sqlite3_mutex_alloc()]. 1253*/ 1254typedef struct sqlite3_mutex sqlite3_mutex; 1255 1256/* 1257** CAPI3REF: Loadable Extension Thunk 1258** 1259** A pointer to the opaque sqlite3_api_routines structure is passed as 1260** the third parameter to entry points of [loadable extensions]. This 1261** structure must be typedefed in order to work around compiler warnings 1262** on some platforms. 1263*/ 1264typedef struct sqlite3_api_routines sqlite3_api_routines; 1265 1266/* 1267** CAPI3REF: OS Interface Object 1268** 1269** An instance of the sqlite3_vfs object defines the interface between 1270** the SQLite core and the underlying operating system. The "vfs" 1271** in the name of the object stands for "virtual file system". See 1272** the [VFS | VFS documentation] for further information. 1273** 1274** The VFS interface is sometimes extended by adding new methods onto 1275** the end. Each time such an extension occurs, the iVersion field 1276** is incremented. The iVersion value started out as 1 in 1277** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2 1278** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased 1279** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields 1280** may be appended to the sqlite3_vfs object and the iVersion value 1281** may increase again in future versions of SQLite. 1282** Note that due to an oversight, the structure 1283** of the sqlite3_vfs object changed in the transition from 1284** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0] 1285** and yet the iVersion field was not increased. 1286** 1287** The szOsFile field is the size of the subclassed [sqlite3_file] 1288** structure used by this VFS. mxPathname is the maximum length of 1289** a pathname in this VFS. 1290** 1291** Registered sqlite3_vfs objects are kept on a linked list formed by 1292** the pNext pointer. The [sqlite3_vfs_register()] 1293** and [sqlite3_vfs_unregister()] interfaces manage this list 1294** in a thread-safe way. The [sqlite3_vfs_find()] interface 1295** searches the list. Neither the application code nor the VFS 1296** implementation should use the pNext pointer. 1297** 1298** The pNext field is the only field in the sqlite3_vfs 1299** structure that SQLite will ever modify. SQLite will only access 1300** or modify this field while holding a particular static mutex. 1301** The application should never modify anything within the sqlite3_vfs 1302** object once the object has been registered. 1303** 1304** The zName field holds the name of the VFS module. The name must 1305** be unique across all VFS modules. 1306** 1307** [[sqlite3_vfs.xOpen]] 1308** ^SQLite guarantees that the zFilename parameter to xOpen 1309** is either a NULL pointer or string obtained 1310** from xFullPathname() with an optional suffix added. 1311** ^If a suffix is added to the zFilename parameter, it will 1312** consist of a single "-" character followed by no more than 1313** 11 alphanumeric and/or "-" characters. 1314** ^SQLite further guarantees that 1315** the string will be valid and unchanged until xClose() is 1316** called. Because of the previous sentence, 1317** the [sqlite3_file] can safely store a pointer to the 1318** filename if it needs to remember the filename for some reason. 1319** If the zFilename parameter to xOpen is a NULL pointer then xOpen 1320** must invent its own temporary name for the file. ^Whenever the 1321** xFilename parameter is NULL it will also be the case that the 1322** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 1323** 1324** The flags argument to xOpen() includes all bits set in 1325** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 1326** or [sqlite3_open16()] is used, then flags includes at least 1327** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 1328** If xOpen() opens a file read-only then it sets *pOutFlags to 1329** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 1330** 1331** ^(SQLite will also add one of the following flags to the xOpen() 1332** call, depending on the object being opened: 1333** 1334** <ul> 1335** <li> [SQLITE_OPEN_MAIN_DB] 1336** <li> [SQLITE_OPEN_MAIN_JOURNAL] 1337** <li> [SQLITE_OPEN_TEMP_DB] 1338** <li> [SQLITE_OPEN_TEMP_JOURNAL] 1339** <li> [SQLITE_OPEN_TRANSIENT_DB] 1340** <li> [SQLITE_OPEN_SUBJOURNAL] 1341** <li> [SQLITE_OPEN_SUPER_JOURNAL] 1342** <li> [SQLITE_OPEN_WAL] 1343** </ul>)^ 1344** 1345** The file I/O implementation can use the object type flags to 1346** change the way it deals with files. For example, an application 1347** that does not care about crash recovery or rollback might make 1348** the open of a journal file a no-op. Writes to this journal would 1349** also be no-ops, and any attempt to read the journal would return 1350** SQLITE_IOERR. Or the implementation might recognize that a database 1351** file will be doing page-aligned sector reads and writes in a random 1352** order and set up its I/O subsystem accordingly. 1353** 1354** SQLite might also add one of the following flags to the xOpen method: 1355** 1356** <ul> 1357** <li> [SQLITE_OPEN_DELETEONCLOSE] 1358** <li> [SQLITE_OPEN_EXCLUSIVE] 1359** </ul> 1360** 1361** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 1362** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] 1363** will be set for TEMP databases and their journals, transient 1364** databases, and subjournals. 1365** 1366** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction 1367** with the [SQLITE_OPEN_CREATE] flag, which are both directly 1368** analogous to the O_EXCL and O_CREAT flags of the POSIX open() 1369** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 1370** SQLITE_OPEN_CREATE, is used to indicate that file should always 1371** be created, and that it is an error if it already exists. 1372** It is <i>not</i> used to indicate the file should be opened 1373** for exclusive access. 1374** 1375** ^At least szOsFile bytes of memory are allocated by SQLite 1376** to hold the [sqlite3_file] structure passed as the third 1377** argument to xOpen. The xOpen method does not have to 1378** allocate the structure; it should just fill it in. Note that 1379** the xOpen method must set the sqlite3_file.pMethods to either 1380** a valid [sqlite3_io_methods] object or to NULL. xOpen must do 1381** this even if the open fails. SQLite expects that the sqlite3_file.pMethods 1382** element will be valid after xOpen returns regardless of the success 1383** or failure of the xOpen call. 1384** 1385** [[sqlite3_vfs.xAccess]] 1386** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 1387** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 1388** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 1389** to test whether a file is at least readable. The SQLITE_ACCESS_READ 1390** flag is never actually used and is not implemented in the built-in 1391** VFSes of SQLite. The file is named by the second argument and can be a 1392** directory. The xAccess method returns [SQLITE_OK] on success or some 1393** non-zero error code if there is an I/O error or if the name of 1394** the file given in the second argument is illegal. If SQLITE_OK 1395** is returned, then non-zero or zero is written into *pResOut to indicate 1396** whether or not the file is accessible. 1397** 1398** ^SQLite will always allocate at least mxPathname+1 bytes for the 1399** output buffer xFullPathname. The exact size of the output buffer 1400** is also passed as a parameter to both methods. If the output buffer 1401** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 1402** handled as a fatal error by SQLite, vfs implementations should endeavor 1403** to prevent this by setting mxPathname to a sufficiently large value. 1404** 1405** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() 1406** interfaces are not strictly a part of the filesystem, but they are 1407** included in the VFS structure for completeness. 1408** The xRandomness() function attempts to return nBytes bytes 1409** of good-quality randomness into zOut. The return value is 1410** the actual number of bytes of randomness obtained. 1411** The xSleep() method causes the calling thread to sleep for at 1412** least the number of microseconds given. ^The xCurrentTime() 1413** method returns a Julian Day Number for the current date and time as 1414** a floating point value. 1415** ^The xCurrentTimeInt64() method returns, as an integer, the Julian 1416** Day Number multiplied by 86400000 (the number of milliseconds in 1417** a 24-hour day). 1418** ^SQLite will use the xCurrentTimeInt64() method to get the current 1419** date and time if that method is available (if iVersion is 2 or 1420** greater and the function pointer is not NULL) and will fall back 1421** to xCurrentTime() if xCurrentTimeInt64() is unavailable. 1422** 1423** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces 1424** are not used by the SQLite core. These optional interfaces are provided 1425** by some VFSes to facilitate testing of the VFS code. By overriding 1426** system calls with functions under its control, a test program can 1427** simulate faults and error conditions that would otherwise be difficult 1428** or impossible to induce. The set of system calls that can be overridden 1429** varies from one VFS to another, and from one version of the same VFS to the 1430** next. Applications that use these interfaces must be prepared for any 1431** or all of these interfaces to be NULL or for their behavior to change 1432** from one release to the next. Applications must not attempt to access 1433** any of these methods if the iVersion of the VFS is less than 3. 1434*/ 1435typedef struct sqlite3_vfs sqlite3_vfs; 1436typedef void (*sqlite3_syscall_ptr)(void); 1437struct sqlite3_vfs { 1438 int iVersion; /* Structure version number (currently 3) */ 1439 int szOsFile; /* Size of subclassed sqlite3_file */ 1440 int mxPathname; /* Maximum file pathname length */ 1441 sqlite3_vfs *pNext; /* Next registered VFS */ 1442 const char *zName; /* Name of this virtual file system */ 1443 void *pAppData; /* Pointer to application-specific data */ 1444 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 1445 int flags, int *pOutFlags); 1446 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 1447 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 1448 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 1449 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 1450 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 1451 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); 1452 void (*xDlClose)(sqlite3_vfs*, void*); 1453 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 1454 int (*xSleep)(sqlite3_vfs*, int microseconds); 1455 int (*xCurrentTime)(sqlite3_vfs*, double*); 1456 int (*xGetLastError)(sqlite3_vfs*, int, char *); 1457 /* 1458 ** The methods above are in version 1 of the sqlite_vfs object 1459 ** definition. Those that follow are added in version 2 or later 1460 */ 1461 int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); 1462 /* 1463 ** The methods above are in versions 1 and 2 of the sqlite_vfs object. 1464 ** Those below are for version 3 and greater. 1465 */ 1466 int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); 1467 sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); 1468 const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); 1469 /* 1470 ** The methods above are in versions 1 through 3 of the sqlite_vfs object. 1471 ** New fields may be appended in future versions. The iVersion 1472 ** value will increment whenever this happens. 1473 */ 1474}; 1475 1476/* 1477** CAPI3REF: Flags for the xAccess VFS method 1478** 1479** These integer constants can be used as the third parameter to 1480** the xAccess method of an [sqlite3_vfs] object. They determine 1481** what kind of permissions the xAccess method is looking for. 1482** With SQLITE_ACCESS_EXISTS, the xAccess method 1483** simply checks whether the file exists. 1484** With SQLITE_ACCESS_READWRITE, the xAccess method 1485** checks whether the named directory is both readable and writable 1486** (in other words, if files can be added, removed, and renamed within 1487** the directory). 1488** The SQLITE_ACCESS_READWRITE constant is currently used only by the 1489** [temp_store_directory pragma], though this could change in a future 1490** release of SQLite. 1491** With SQLITE_ACCESS_READ, the xAccess method 1492** checks whether the file is readable. The SQLITE_ACCESS_READ constant is 1493** currently unused, though it might be used in a future release of 1494** SQLite. 1495*/ 1496#define SQLITE_ACCESS_EXISTS 0 1497#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ 1498#define SQLITE_ACCESS_READ 2 /* Unused */ 1499 1500/* 1501** CAPI3REF: Flags for the xShmLock VFS method 1502** 1503** These integer constants define the various locking operations 1504** allowed by the xShmLock method of [sqlite3_io_methods]. The 1505** following are the only legal combinations of flags to the 1506** xShmLock method: 1507** 1508** <ul> 1509** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED 1510** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE 1511** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED 1512** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE 1513** </ul> 1514** 1515** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as 1516** was given on the corresponding lock. 1517** 1518** The xShmLock method can transition between unlocked and SHARED or 1519** between unlocked and EXCLUSIVE. It cannot transition between SHARED 1520** and EXCLUSIVE. 1521*/ 1522#define SQLITE_SHM_UNLOCK 1 1523#define SQLITE_SHM_LOCK 2 1524#define SQLITE_SHM_SHARED 4 1525#define SQLITE_SHM_EXCLUSIVE 8 1526 1527/* 1528** CAPI3REF: Maximum xShmLock index 1529** 1530** The xShmLock method on [sqlite3_io_methods] may use values 1531** between 0 and this upper bound as its "offset" argument. 1532** The SQLite core will never attempt to acquire or release a 1533** lock outside of this range 1534*/ 1535#define SQLITE_SHM_NLOCK 8 1536 1537 1538/* 1539** CAPI3REF: Initialize The SQLite Library 1540** 1541** ^The sqlite3_initialize() routine initializes the 1542** SQLite library. ^The sqlite3_shutdown() routine 1543** deallocates any resources that were allocated by sqlite3_initialize(). 1544** These routines are designed to aid in process initialization and 1545** shutdown on embedded systems. Workstation applications using 1546** SQLite normally do not need to invoke either of these routines. 1547** 1548** A call to sqlite3_initialize() is an "effective" call if it is 1549** the first time sqlite3_initialize() is invoked during the lifetime of 1550** the process, or if it is the first time sqlite3_initialize() is invoked 1551** following a call to sqlite3_shutdown(). ^(Only an effective call 1552** of sqlite3_initialize() does any initialization. All other calls 1553** are harmless no-ops.)^ 1554** 1555** A call to sqlite3_shutdown() is an "effective" call if it is the first 1556** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only 1557** an effective call to sqlite3_shutdown() does any deinitialization. 1558** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ 1559** 1560** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() 1561** is not. The sqlite3_shutdown() interface must only be called from a 1562** single thread. All open [database connections] must be closed and all 1563** other SQLite resources must be deallocated prior to invoking 1564** sqlite3_shutdown(). 1565** 1566** Among other things, ^sqlite3_initialize() will invoke 1567** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() 1568** will invoke sqlite3_os_end(). 1569** 1570** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. 1571** ^If for some reason, sqlite3_initialize() is unable to initialize 1572** the library (perhaps it is unable to allocate a needed resource such 1573** as a mutex) it returns an [error code] other than [SQLITE_OK]. 1574** 1575** ^The sqlite3_initialize() routine is called internally by many other 1576** SQLite interfaces so that an application usually does not need to 1577** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 1578** calls sqlite3_initialize() so the SQLite library will be automatically 1579** initialized when [sqlite3_open()] is called if it has not be initialized 1580** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] 1581** compile-time option, then the automatic calls to sqlite3_initialize() 1582** are omitted and the application must call sqlite3_initialize() directly 1583** prior to using any other SQLite interface. For maximum portability, 1584** it is recommended that applications always invoke sqlite3_initialize() 1585** directly prior to using any other SQLite interface. Future releases 1586** of SQLite may require this. In other words, the behavior exhibited 1587** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the 1588** default behavior in some future release of SQLite. 1589** 1590** The sqlite3_os_init() routine does operating-system specific 1591** initialization of the SQLite library. The sqlite3_os_end() 1592** routine undoes the effect of sqlite3_os_init(). Typical tasks 1593** performed by these routines include allocation or deallocation 1594** of static resources, initialization of global variables, 1595** setting up a default [sqlite3_vfs] module, or setting up 1596** a default configuration using [sqlite3_config()]. 1597** 1598** The application should never invoke either sqlite3_os_init() 1599** or sqlite3_os_end() directly. The application should only invoke 1600** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() 1601** interface is called automatically by sqlite3_initialize() and 1602** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate 1603** implementations for sqlite3_os_init() and sqlite3_os_end() 1604** are built into SQLite when it is compiled for Unix, Windows, or OS/2. 1605** When [custom builds | built for other platforms] 1606** (using the [SQLITE_OS_OTHER=1] compile-time 1607** option) the application must supply a suitable implementation for 1608** sqlite3_os_init() and sqlite3_os_end(). An application-supplied 1609** implementation of sqlite3_os_init() or sqlite3_os_end() 1610** must return [SQLITE_OK] on success and some other [error code] upon 1611** failure. 1612*/ 1613int sqlite3_initialize(void); 1614int sqlite3_shutdown(void); 1615int sqlite3_os_init(void); 1616int sqlite3_os_end(void); 1617 1618/* 1619** CAPI3REF: Configuring The SQLite Library 1620** 1621** The sqlite3_config() interface is used to make global configuration 1622** changes to SQLite in order to tune SQLite to the specific needs of 1623** the application. The default configuration is recommended for most 1624** applications and so this routine is usually not necessary. It is 1625** provided to support rare applications with unusual needs. 1626** 1627** <b>The sqlite3_config() interface is not threadsafe. The application 1628** must ensure that no other SQLite interfaces are invoked by other 1629** threads while sqlite3_config() is running.</b> 1630** 1631** The sqlite3_config() interface 1632** may only be invoked prior to library initialization using 1633** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 1634** ^If sqlite3_config() is called after [sqlite3_initialize()] and before 1635** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. 1636** Note, however, that ^sqlite3_config() can be called as part of the 1637** implementation of an application-defined [sqlite3_os_init()]. 1638** 1639** The first argument to sqlite3_config() is an integer 1640** [configuration option] that determines 1641** what property of SQLite is to be configured. Subsequent arguments 1642** vary depending on the [configuration option] 1643** in the first argument. 1644** 1645** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 1646** ^If the option is unknown or SQLite is unable to set the option 1647** then this routine returns a non-zero [error code]. 1648*/ 1649int sqlite3_config(int, ...); 1650 1651/* 1652** CAPI3REF: Configure database connections 1653** METHOD: sqlite3 1654** 1655** The sqlite3_db_config() interface is used to make configuration 1656** changes to a [database connection]. The interface is similar to 1657** [sqlite3_config()] except that the changes apply to a single 1658** [database connection] (specified in the first argument). 1659** 1660** The second argument to sqlite3_db_config(D,V,...) is the 1661** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code 1662** that indicates what aspect of the [database connection] is being configured. 1663** Subsequent arguments vary depending on the configuration verb. 1664** 1665** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if 1666** the call is considered successful. 1667*/ 1668int sqlite3_db_config(sqlite3*, int op, ...); 1669 1670/* 1671** CAPI3REF: Memory Allocation Routines 1672** 1673** An instance of this object defines the interface between SQLite 1674** and low-level memory allocation routines. 1675** 1676** This object is used in only one place in the SQLite interface. 1677** A pointer to an instance of this object is the argument to 1678** [sqlite3_config()] when the configuration option is 1679** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. 1680** By creating an instance of this object 1681** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) 1682** during configuration, an application can specify an alternative 1683** memory allocation subsystem for SQLite to use for all of its 1684** dynamic memory needs. 1685** 1686** Note that SQLite comes with several [built-in memory allocators] 1687** that are perfectly adequate for the overwhelming majority of applications 1688** and that this object is only useful to a tiny minority of applications 1689** with specialized memory allocation requirements. This object is 1690** also used during testing of SQLite in order to specify an alternative 1691** memory allocator that simulates memory out-of-memory conditions in 1692** order to verify that SQLite recovers gracefully from such 1693** conditions. 1694** 1695** The xMalloc, xRealloc, and xFree methods must work like the 1696** malloc(), realloc() and free() functions from the standard C library. 1697** ^SQLite guarantees that the second argument to 1698** xRealloc is always a value returned by a prior call to xRoundup. 1699** 1700** xSize should return the allocated size of a memory allocation 1701** previously obtained from xMalloc or xRealloc. The allocated size 1702** is always at least as big as the requested size but may be larger. 1703** 1704** The xRoundup method returns what would be the allocated size of 1705** a memory allocation given a particular requested size. Most memory 1706** allocators round up memory allocations at least to the next multiple 1707** of 8. Some allocators round up to a larger multiple or to a power of 2. 1708** Every memory allocation request coming in through [sqlite3_malloc()] 1709** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, 1710** that causes the corresponding memory allocation to fail. 1711** 1712** The xInit method initializes the memory allocator. For example, 1713** it might allocate any required mutexes or initialize internal data 1714** structures. The xShutdown method is invoked (indirectly) by 1715** [sqlite3_shutdown()] and should deallocate any resources acquired 1716** by xInit. The pAppData pointer is used as the only parameter to 1717** xInit and xShutdown. 1718** 1719** SQLite holds the [SQLITE_MUTEX_STATIC_MAIN] mutex when it invokes 1720** the xInit method, so the xInit method need not be threadsafe. The 1721** xShutdown method is only called from [sqlite3_shutdown()] so it does 1722** not need to be threadsafe either. For all other methods, SQLite 1723** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the 1724** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which 1725** it is by default) and so the methods are automatically serialized. 1726** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other 1727** methods must be threadsafe or else make their own arrangements for 1728** serialization. 1729** 1730** SQLite will never invoke xInit() more than once without an intervening 1731** call to xShutdown(). 1732*/ 1733typedef struct sqlite3_mem_methods sqlite3_mem_methods; 1734struct sqlite3_mem_methods { 1735 void *(*xMalloc)(int); /* Memory allocation function */ 1736 void (*xFree)(void*); /* Free a prior allocation */ 1737 void *(*xRealloc)(void*,int); /* Resize an allocation */ 1738 int (*xSize)(void*); /* Return the size of an allocation */ 1739 int (*xRoundup)(int); /* Round up request size to allocation size */ 1740 int (*xInit)(void*); /* Initialize the memory allocator */ 1741 void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1742 void *pAppData; /* Argument to xInit() and xShutdown() */ 1743}; 1744 1745/* 1746** CAPI3REF: Configuration Options 1747** KEYWORDS: {configuration option} 1748** 1749** These constants are the available integer configuration options that 1750** can be passed as the first argument to the [sqlite3_config()] interface. 1751** 1752** New configuration options may be added in future releases of SQLite. 1753** Existing configuration options might be discontinued. Applications 1754** should check the return code from [sqlite3_config()] to make sure that 1755** the call worked. The [sqlite3_config()] interface will return a 1756** non-zero [error code] if a discontinued or unsupported configuration option 1757** is invoked. 1758** 1759** <dl> 1760** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1761** <dd>There are no arguments to this option. ^This option sets the 1762** [threading mode] to Single-thread. In other words, it disables 1763** all mutexing and puts SQLite into a mode where it can only be used 1764** by a single thread. ^If SQLite is compiled with 1765** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1766** it is not possible to change the [threading mode] from its default 1767** value of Single-thread and so [sqlite3_config()] will return 1768** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD 1769** configuration option.</dd> 1770** 1771** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1772** <dd>There are no arguments to this option. ^This option sets the 1773** [threading mode] to Multi-thread. In other words, it disables 1774** mutexing on [database connection] and [prepared statement] objects. 1775** The application is responsible for serializing access to 1776** [database connections] and [prepared statements]. But other mutexes 1777** are enabled so that SQLite will be safe to use in a multi-threaded 1778** environment as long as no two threads attempt to use the same 1779** [database connection] at the same time. ^If SQLite is compiled with 1780** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1781** it is not possible to set the Multi-thread [threading mode] and 1782** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1783** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> 1784** 1785** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt> 1786** <dd>There are no arguments to this option. ^This option sets the 1787** [threading mode] to Serialized. In other words, this option enables 1788** all mutexes including the recursive 1789** mutexes on [database connection] and [prepared statement] objects. 1790** In this mode (which is the default when SQLite is compiled with 1791** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1792** to [database connections] and [prepared statements] so that the 1793** application is free to use the same [database connection] or the 1794** same [prepared statement] in different threads at the same time. 1795** ^If SQLite is compiled with 1796** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1797** it is not possible to set the Serialized [threading mode] and 1798** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1799** SQLITE_CONFIG_SERIALIZED configuration option.</dd> 1800** 1801** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> 1802** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is 1803** a pointer to an instance of the [sqlite3_mem_methods] structure. 1804** The argument specifies 1805** alternative low-level memory allocation routines to be used in place of 1806** the memory allocation routines built into SQLite.)^ ^SQLite makes 1807** its own private copy of the content of the [sqlite3_mem_methods] structure 1808** before the [sqlite3_config()] call returns.</dd> 1809** 1810** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> 1811** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which 1812** is a pointer to an instance of the [sqlite3_mem_methods] structure. 1813** The [sqlite3_mem_methods] 1814** structure is filled with the currently defined memory allocation routines.)^ 1815** This option can be used to overload the default memory allocation 1816** routines with a wrapper that simulations memory allocation failure or 1817** tracks memory usage, for example. </dd> 1818** 1819** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt> 1820** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of 1821** type int, interpreted as a boolean, which if true provides a hint to 1822** SQLite that it should avoid large memory allocations if possible. 1823** SQLite will run faster if it is free to make large memory allocations, 1824** but some application might prefer to run slower in exchange for 1825** guarantees about memory fragmentation that are possible if large 1826** allocations are avoided. This hint is normally off. 1827** </dd> 1828** 1829** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1830** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int, 1831** interpreted as a boolean, which enables or disables the collection of 1832** memory allocation statistics. ^(When memory allocation statistics are 1833** disabled, the following SQLite interfaces become non-operational: 1834** <ul> 1835** <li> [sqlite3_hard_heap_limit64()] 1836** <li> [sqlite3_memory_used()] 1837** <li> [sqlite3_memory_highwater()] 1838** <li> [sqlite3_soft_heap_limit64()] 1839** <li> [sqlite3_status64()] 1840** </ul>)^ 1841** ^Memory allocation statistics are enabled by default unless SQLite is 1842** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory 1843** allocation statistics are disabled by default. 1844** </dd> 1845** 1846** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> 1847** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used. 1848** </dd> 1849** 1850** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> 1851** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool 1852** that SQLite can use for the database page cache with the default page 1853** cache implementation. 1854** This configuration option is a no-op if an application-defined page 1855** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2]. 1856** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to 1857** 8-byte aligned memory (pMem), the size of each page cache line (sz), 1858** and the number of cache lines (N). 1859** The sz argument should be the size of the largest database page 1860** (a power of two between 512 and 65536) plus some extra bytes for each 1861** page header. ^The number of extra bytes needed by the page header 1862** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ]. 1863** ^It is harmless, apart from the wasted memory, 1864** for the sz parameter to be larger than necessary. The pMem 1865** argument must be either a NULL pointer or a pointer to an 8-byte 1866** aligned block of memory of at least sz*N bytes, otherwise 1867** subsequent behavior is undefined. 1868** ^When pMem is not NULL, SQLite will strive to use the memory provided 1869** to satisfy page cache needs, falling back to [sqlite3_malloc()] if 1870** a page cache line is larger than sz bytes or if all of the pMem buffer 1871** is exhausted. 1872** ^If pMem is NULL and N is non-zero, then each database connection 1873** does an initial bulk allocation for page cache memory 1874** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or 1875** of -1024*N bytes if N is negative, . ^If additional 1876** page cache memory is needed beyond what is provided by the initial 1877** allocation, then SQLite goes to [sqlite3_malloc()] separately for each 1878** additional cache line. </dd> 1879** 1880** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> 1881** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer 1882** that SQLite will use for all of its dynamic memory allocation needs 1883** beyond those provided for by [SQLITE_CONFIG_PAGECACHE]. 1884** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled 1885** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns 1886** [SQLITE_ERROR] if invoked otherwise. 1887** ^There are three arguments to SQLITE_CONFIG_HEAP: 1888** An 8-byte aligned pointer to the memory, 1889** the number of bytes in the memory buffer, and the minimum allocation size. 1890** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts 1891** to using its default memory allocator (the system malloc() implementation), 1892** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the 1893** memory pointer is not NULL then the alternative memory 1894** allocator is engaged to handle all of SQLites memory allocation needs. 1895** The first pointer (the memory pointer) must be aligned to an 8-byte 1896** boundary or subsequent behavior of SQLite will be undefined. 1897** The minimum allocation size is capped at 2**12. Reasonable values 1898** for the minimum allocation size are 2**5 through 2**8.</dd> 1899** 1900** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> 1901** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a 1902** pointer to an instance of the [sqlite3_mutex_methods] structure. 1903** The argument specifies alternative low-level mutex routines to be used 1904** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of 1905** the content of the [sqlite3_mutex_methods] structure before the call to 1906** [sqlite3_config()] returns. ^If SQLite is compiled with 1907** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1908** the entire mutexing subsystem is omitted from the build and hence calls to 1909** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will 1910** return [SQLITE_ERROR].</dd> 1911** 1912** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> 1913** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which 1914** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The 1915** [sqlite3_mutex_methods] 1916** structure is filled with the currently defined mutex routines.)^ 1917** This option can be used to overload the default mutex allocation 1918** routines with a wrapper used to track mutex usage for performance 1919** profiling or testing, for example. ^If SQLite is compiled with 1920** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1921** the entire mutexing subsystem is omitted from the build and hence calls to 1922** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will 1923** return [SQLITE_ERROR].</dd> 1924** 1925** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1926** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine 1927** the default size of lookaside memory on each [database connection]. 1928** The first argument is the 1929** size of each lookaside buffer slot and the second is the number of 1930** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE 1931** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] 1932** option to [sqlite3_db_config()] can be used to change the lookaside 1933** configuration on individual connections.)^ </dd> 1934** 1935** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> 1936** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is 1937** a pointer to an [sqlite3_pcache_methods2] object. This object specifies 1938** the interface to a custom page cache implementation.)^ 1939** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd> 1940** 1941** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> 1942** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which 1943** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of 1944** the current page cache implementation into that object.)^ </dd> 1945** 1946** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> 1947** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite 1948** global [error log]. 1949** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a 1950** function with a call signature of void(*)(void*,int,const char*), 1951** and a pointer to void. ^If the function pointer is not NULL, it is 1952** invoked by [sqlite3_log()] to process each logging event. ^If the 1953** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. 1954** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is 1955** passed through as the first parameter to the application-defined logger 1956** function whenever that function is invoked. ^The second parameter to 1957** the logger function is a copy of the first parameter to the corresponding 1958** [sqlite3_log()] call and is intended to be a [result code] or an 1959** [extended result code]. ^The third parameter passed to the logger is 1960** log message after formatting via [sqlite3_snprintf()]. 1961** The SQLite logging interface is not reentrant; the logger function 1962** supplied by the application must not invoke any SQLite interface. 1963** In a multi-threaded application, the application-defined logger 1964** function must be threadsafe. </dd> 1965** 1966** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI 1967** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int. 1968** If non-zero, then URI handling is globally enabled. If the parameter is zero, 1969** then URI handling is globally disabled.)^ ^If URI handling is globally 1970** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()], 1971** [sqlite3_open16()] or 1972** specified as part of [ATTACH] commands are interpreted as URIs, regardless 1973** of whether or not the [SQLITE_OPEN_URI] flag is set when the database 1974** connection is opened. ^If it is globally disabled, filenames are 1975** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the 1976** database connection is opened. ^(By default, URI handling is globally 1977** disabled. The default value may be changed by compiling with the 1978** [SQLITE_USE_URI] symbol defined.)^ 1979** 1980** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN 1981** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer 1982** argument which is interpreted as a boolean in order to enable or disable 1983** the use of covering indices for full table scans in the query optimizer. 1984** ^The default setting is determined 1985** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on" 1986** if that compile-time option is omitted. 1987** The ability to disable the use of covering indices for full table scans 1988** is because some incorrectly coded legacy applications might malfunction 1989** when the optimization is enabled. Providing the ability to 1990** disable the optimization allows the older, buggy application code to work 1991** without change even with newer versions of SQLite. 1992** 1993** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] 1994** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE 1995** <dd> These options are obsolete and should not be used by new code. 1996** They are retained for backwards compatibility but are now no-ops. 1997** </dd> 1998** 1999** [[SQLITE_CONFIG_SQLLOG]] 2000** <dt>SQLITE_CONFIG_SQLLOG 2001** <dd>This option is only available if sqlite is compiled with the 2002** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should 2003** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int). 2004** The second should be of type (void*). The callback is invoked by the library 2005** in three separate circumstances, identified by the value passed as the 2006** fourth parameter. If the fourth parameter is 0, then the database connection 2007** passed as the second argument has just been opened. The third argument 2008** points to a buffer containing the name of the main database file. If the 2009** fourth parameter is 1, then the SQL statement that the third parameter 2010** points to has just been executed. Or, if the fourth parameter is 2, then 2011** the connection being passed as the second parameter is being closed. The 2012** third parameter is passed NULL In this case. An example of using this 2013** configuration option can be seen in the "test_sqllog.c" source file in 2014** the canonical SQLite source tree.</dd> 2015** 2016** [[SQLITE_CONFIG_MMAP_SIZE]] 2017** <dt>SQLITE_CONFIG_MMAP_SIZE 2018** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values 2019** that are the default mmap size limit (the default setting for 2020** [PRAGMA mmap_size]) and the maximum allowed mmap size limit. 2021** ^The default setting can be overridden by each database connection using 2022** either the [PRAGMA mmap_size] command, or by using the 2023** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size 2024** will be silently truncated if necessary so that it does not exceed the 2025** compile-time maximum mmap size set by the 2026** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^ 2027** ^If either argument to this option is negative, then that argument is 2028** changed to its compile-time default. 2029** 2030** [[SQLITE_CONFIG_WIN32_HEAPSIZE]] 2031** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE 2032** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is 2033** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro 2034** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value 2035** that specifies the maximum size of the created heap. 2036** 2037** [[SQLITE_CONFIG_PCACHE_HDRSZ]] 2038** <dt>SQLITE_CONFIG_PCACHE_HDRSZ 2039** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which 2040** is a pointer to an integer and writes into that integer the number of extra 2041** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE]. 2042** The amount of extra space required can change depending on the compiler, 2043** target platform, and SQLite version. 2044** 2045** [[SQLITE_CONFIG_PMASZ]] 2046** <dt>SQLITE_CONFIG_PMASZ 2047** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which 2048** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded 2049** sorter to that integer. The default minimum PMA Size is set by the 2050** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched 2051** to help with sort operations when multithreaded sorting 2052** is enabled (using the [PRAGMA threads] command) and the amount of content 2053** to be sorted exceeds the page size times the minimum of the 2054** [PRAGMA cache_size] setting and this value. 2055** 2056** [[SQLITE_CONFIG_STMTJRNL_SPILL]] 2057** <dt>SQLITE_CONFIG_STMTJRNL_SPILL 2058** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which 2059** becomes the [statement journal] spill-to-disk threshold. 2060** [Statement journals] are held in memory until their size (in bytes) 2061** exceeds this threshold, at which point they are written to disk. 2062** Or if the threshold is -1, statement journals are always held 2063** exclusively in memory. 2064** Since many statement journals never become large, setting the spill 2065** threshold to a value such as 64KiB can greatly reduce the amount of 2066** I/O required to support statement rollback. 2067** The default value for this setting is controlled by the 2068** [SQLITE_STMTJRNL_SPILL] compile-time option. 2069** 2070** [[SQLITE_CONFIG_SORTERREF_SIZE]] 2071** <dt>SQLITE_CONFIG_SORTERREF_SIZE 2072** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter 2073** of type (int) - the new value of the sorter-reference size threshold. 2074** Usually, when SQLite uses an external sort to order records according 2075** to an ORDER BY clause, all fields required by the caller are present in the 2076** sorted records. However, if SQLite determines based on the declared type 2077** of a table column that its values are likely to be very large - larger 2078** than the configured sorter-reference size threshold - then a reference 2079** is stored in each sorted record and the required column values loaded 2080** from the database as records are returned in sorted order. The default 2081** value for this option is to never use this optimization. Specifying a 2082** negative value for this option restores the default behaviour. 2083** This option is only available if SQLite is compiled with the 2084** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option. 2085** 2086** [[SQLITE_CONFIG_MEMDB_MAXSIZE]] 2087** <dt>SQLITE_CONFIG_MEMDB_MAXSIZE 2088** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter 2089** [sqlite3_int64] parameter which is the default maximum size for an in-memory 2090** database created using [sqlite3_deserialize()]. This default maximum 2091** size can be adjusted up or down for individual databases using the 2092** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control|file-control]. If this 2093** configuration setting is never used, then the default maximum is determined 2094** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that 2095** compile-time option is not set, then the default maximum is 1073741824. 2096** </dl> 2097*/ 2098#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 2099#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 2100#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 2101#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 2102#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 2103#define SQLITE_CONFIG_SCRATCH 6 /* No longer used */ 2104#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 2105#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 2106#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 2107#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 2108#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 2109/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 2110#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 2111#define SQLITE_CONFIG_PCACHE 14 /* no-op */ 2112#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ 2113#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ 2114#define SQLITE_CONFIG_URI 17 /* int */ 2115#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ 2116#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ 2117#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */ 2118#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */ 2119#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */ 2120#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */ 2121#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */ 2122#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */ 2123#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */ 2124#define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */ 2125#define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */ 2126#define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */ 2127 2128/* 2129** CAPI3REF: Database Connection Configuration Options 2130** 2131** These constants are the available integer configuration options that 2132** can be passed as the second argument to the [sqlite3_db_config()] interface. 2133** 2134** New configuration options may be added in future releases of SQLite. 2135** Existing configuration options might be discontinued. Applications 2136** should check the return code from [sqlite3_db_config()] to make sure that 2137** the call worked. ^The [sqlite3_db_config()] interface will return a 2138** non-zero [error code] if a discontinued or unsupported configuration option 2139** is invoked. 2140** 2141** <dl> 2142** [[SQLITE_DBCONFIG_LOOKASIDE]] 2143** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 2144** <dd> ^This option takes three additional arguments that determine the 2145** [lookaside memory allocator] configuration for the [database connection]. 2146** ^The first argument (the third parameter to [sqlite3_db_config()] is a 2147** pointer to a memory buffer to use for lookaside memory. 2148** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb 2149** may be NULL in which case SQLite will allocate the 2150** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the 2151** size of each lookaside buffer slot. ^The third argument is the number of 2152** slots. The size of the buffer in the first argument must be greater than 2153** or equal to the product of the second and third arguments. The buffer 2154** must be aligned to an 8-byte boundary. ^If the second argument to 2155** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally 2156** rounded down to the next smaller multiple of 8. ^(The lookaside memory 2157** configuration for a database connection can only be changed when that 2158** connection is not currently using lookaside memory, or in other words 2159** when the "current value" returned by 2160** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. 2161** Any attempt to change the lookaside memory configuration when lookaside 2162** memory is in use leaves the configuration unchanged and returns 2163** [SQLITE_BUSY].)^</dd> 2164** 2165** [[SQLITE_DBCONFIG_ENABLE_FKEY]] 2166** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> 2167** <dd> ^This option is used to enable or disable the enforcement of 2168** [foreign key constraints]. There should be two additional arguments. 2169** The first argument is an integer which is 0 to disable FK enforcement, 2170** positive to enable FK enforcement or negative to leave FK enforcement 2171** unchanged. The second parameter is a pointer to an integer into which 2172** is written 0 or 1 to indicate whether FK enforcement is off or on 2173** following this call. The second parameter may be a NULL pointer, in 2174** which case the FK enforcement setting is not reported back. </dd> 2175** 2176** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]] 2177** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> 2178** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. 2179** There should be two additional arguments. 2180** The first argument is an integer which is 0 to disable triggers, 2181** positive to enable triggers or negative to leave the setting unchanged. 2182** The second parameter is a pointer to an integer into which 2183** is written 0 or 1 to indicate whether triggers are disabled or enabled 2184** following this call. The second parameter may be a NULL pointer, in 2185** which case the trigger setting is not reported back. 2186** 2187** <p>Originally this option disabled all triggers. ^(However, since 2188** SQLite version 3.35.0, TEMP triggers are still allowed even if 2189** this option is off. So, in other words, this option now only disables 2190** triggers in the main database schema or in the schemas of ATTACH-ed 2191** databases.)^ </dd> 2192** 2193** [[SQLITE_DBCONFIG_ENABLE_VIEW]] 2194** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt> 2195** <dd> ^This option is used to enable or disable [CREATE VIEW | views]. 2196** There should be two additional arguments. 2197** The first argument is an integer which is 0 to disable views, 2198** positive to enable views or negative to leave the setting unchanged. 2199** The second parameter is a pointer to an integer into which 2200** is written 0 or 1 to indicate whether views are disabled or enabled 2201** following this call. The second parameter may be a NULL pointer, in 2202** which case the view setting is not reported back. 2203** 2204** <p>Originally this option disabled all views. ^(However, since 2205** SQLite version 3.35.0, TEMP views are still allowed even if 2206** this option is off. So, in other words, this option now only disables 2207** views in the main database schema or in the schemas of ATTACH-ed 2208** databases.)^ </dd> 2209** 2210** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]] 2211** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt> 2212** <dd> ^This option is used to enable or disable the 2213** [fts3_tokenizer()] function which is part of the 2214** [FTS3] full-text search engine extension. 2215** There should be two additional arguments. 2216** The first argument is an integer which is 0 to disable fts3_tokenizer() or 2217** positive to enable fts3_tokenizer() or negative to leave the setting 2218** unchanged. 2219** The second parameter is a pointer to an integer into which 2220** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled 2221** following this call. The second parameter may be a NULL pointer, in 2222** which case the new setting is not reported back. </dd> 2223** 2224** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]] 2225** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt> 2226** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()] 2227** interface independently of the [load_extension()] SQL function. 2228** The [sqlite3_enable_load_extension()] API enables or disables both the 2229** C-API [sqlite3_load_extension()] and the SQL function [load_extension()]. 2230** There should be two additional arguments. 2231** When the first argument to this interface is 1, then only the C-API is 2232** enabled and the SQL function remains disabled. If the first argument to 2233** this interface is 0, then both the C-API and the SQL function are disabled. 2234** If the first argument is -1, then no changes are made to state of either the 2235** C-API or the SQL function. 2236** The second parameter is a pointer to an integer into which 2237** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface 2238** is disabled or enabled following this call. The second parameter may 2239** be a NULL pointer, in which case the new setting is not reported back. 2240** </dd> 2241** 2242** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt> 2243** <dd> ^This option is used to change the name of the "main" database 2244** schema. ^The sole argument is a pointer to a constant UTF8 string 2245** which will become the new schema name in place of "main". ^SQLite 2246** does not make a copy of the new main schema name string, so the application 2247** must ensure that the argument passed into this DBCONFIG option is unchanged 2248** until after the database connection closes. 2249** </dd> 2250** 2251** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]] 2252** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt> 2253** <dd> Usually, when a database in wal mode is closed or detached from a 2254** database handle, SQLite checks if this will mean that there are now no 2255** connections at all to the database. If so, it performs a checkpoint 2256** operation before closing the connection. This option may be used to 2257** override this behaviour. The first parameter passed to this operation 2258** is an integer - positive to disable checkpoints-on-close, or zero (the 2259** default) to enable them, and negative to leave the setting unchanged. 2260** The second parameter is a pointer to an integer 2261** into which is written 0 or 1 to indicate whether checkpoints-on-close 2262** have been disabled - 0 if they are not disabled, 1 if they are. 2263** </dd> 2264** 2265** [[SQLITE_DBCONFIG_ENABLE_QPSG]] <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt> 2266** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates 2267** the [query planner stability guarantee] (QPSG). When the QPSG is active, 2268** a single SQL query statement will always use the same algorithm regardless 2269** of values of [bound parameters].)^ The QPSG disables some query optimizations 2270** that look at the values of bound parameters, which can make some queries 2271** slower. But the QPSG has the advantage of more predictable behavior. With 2272** the QPSG active, SQLite will always use the same query plan in the field as 2273** was used during testing in the lab. 2274** The first argument to this setting is an integer which is 0 to disable 2275** the QPSG, positive to enable QPSG, or negative to leave the setting 2276** unchanged. The second parameter is a pointer to an integer into which 2277** is written 0 or 1 to indicate whether the QPSG is disabled or enabled 2278** following this call. 2279** </dd> 2280** 2281** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt> 2282** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not 2283** include output for any operations performed by trigger programs. This 2284** option is used to set or clear (the default) a flag that governs this 2285** behavior. The first parameter passed to this operation is an integer - 2286** positive to enable output for trigger programs, or zero to disable it, 2287** or negative to leave the setting unchanged. 2288** The second parameter is a pointer to an integer into which is written 2289** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if 2290** it is not disabled, 1 if it is. 2291** </dd> 2292** 2293** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt> 2294** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run 2295** [VACUUM] in order to reset a database back to an empty database 2296** with no schema and no content. The following process works even for 2297** a badly corrupted database file: 2298** <ol> 2299** <li> If the database connection is newly opened, make sure it has read the 2300** database schema by preparing then discarding some query against the 2301** database, or calling sqlite3_table_column_metadata(), ignoring any 2302** errors. This step is only necessary if the application desires to keep 2303** the database in WAL mode after the reset if it was in WAL mode before 2304** the reset. 2305** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0); 2306** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0); 2307** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0); 2308** </ol> 2309** Because resetting a database is destructive and irreversible, the 2310** process requires the use of this obscure API and multiple steps to help 2311** ensure that it does not happen by accident. 2312** 2313** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt> 2314** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the 2315** "defensive" flag for a database connection. When the defensive 2316** flag is enabled, language features that allow ordinary SQL to 2317** deliberately corrupt the database file are disabled. The disabled 2318** features include but are not limited to the following: 2319** <ul> 2320** <li> The [PRAGMA writable_schema=ON] statement. 2321** <li> The [PRAGMA journal_mode=OFF] statement. 2322** <li> Writes to the [sqlite_dbpage] virtual table. 2323** <li> Direct writes to [shadow tables]. 2324** </ul> 2325** </dd> 2326** 2327** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]] <dt>SQLITE_DBCONFIG_WRITABLE_SCHEMA</dt> 2328** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the 2329** "writable_schema" flag. This has the same effect and is logically equivalent 2330** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF]. 2331** The first argument to this setting is an integer which is 0 to disable 2332** the writable_schema, positive to enable writable_schema, or negative to 2333** leave the setting unchanged. The second parameter is a pointer to an 2334** integer into which is written 0 or 1 to indicate whether the writable_schema 2335** is enabled or disabled following this call. 2336** </dd> 2337** 2338** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]] 2339** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt> 2340** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates 2341** the legacy behavior of the [ALTER TABLE RENAME] command such it 2342** behaves as it did prior to [version 3.24.0] (2018-06-04). See the 2343** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for 2344** additional information. This feature can also be turned on and off 2345** using the [PRAGMA legacy_alter_table] statement. 2346** </dd> 2347** 2348** [[SQLITE_DBCONFIG_DQS_DML]] 2349** <dt>SQLITE_DBCONFIG_DQS_DML</td> 2350** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates 2351** the legacy [double-quoted string literal] misfeature for DML statements 2352** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The 2353** default value of this setting is determined by the [-DSQLITE_DQS] 2354** compile-time option. 2355** </dd> 2356** 2357** [[SQLITE_DBCONFIG_DQS_DDL]] 2358** <dt>SQLITE_DBCONFIG_DQS_DDL</td> 2359** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates 2360** the legacy [double-quoted string literal] misfeature for DDL statements, 2361** such as CREATE TABLE and CREATE INDEX. The 2362** default value of this setting is determined by the [-DSQLITE_DQS] 2363** compile-time option. 2364** </dd> 2365** 2366** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]] 2367** <dt>SQLITE_DBCONFIG_TRUSTED_SCHEMA</td> 2368** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to 2369** assume that database schemas are untainted by malicious content. 2370** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite 2371** takes additional defensive steps to protect the application from harm 2372** including: 2373** <ul> 2374** <li> Prohibit the use of SQL functions inside triggers, views, 2375** CHECK constraints, DEFAULT clauses, expression indexes, 2376** partial indexes, or generated columns 2377** unless those functions are tagged with [SQLITE_INNOCUOUS]. 2378** <li> Prohibit the use of virtual tables inside of triggers or views 2379** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS]. 2380** </ul> 2381** This setting defaults to "on" for legacy compatibility, however 2382** all applications are advised to turn it off if possible. This setting 2383** can also be controlled using the [PRAGMA trusted_schema] statement. 2384** </dd> 2385** 2386** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]] 2387** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</td> 2388** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates 2389** the legacy file format flag. When activated, this flag causes all newly 2390** created database file to have a schema format version number (the 4-byte 2391** integer found at offset 44 into the database header) of 1. This in turn 2392** means that the resulting database file will be readable and writable by 2393** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting, 2394** newly created databases are generally not understandable by SQLite versions 2395** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there 2396** is now scarcely any need to generated database files that are compatible 2397** all the way back to version 3.0.0, and so this setting is of little 2398** practical use, but is provided so that SQLite can continue to claim the 2399** ability to generate new database files that are compatible with version 2400** 3.0.0. 2401** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on, 2402** the [VACUUM] command will fail with an obscure error when attempting to 2403** process a table with generated columns and a descending index. This is 2404** not considered a bug since SQLite versions 3.3.0 and earlier do not support 2405** either generated columns or decending indexes. 2406** </dd> 2407** </dl> 2408*/ 2409#define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */ 2410#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 2411#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ 2412#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ 2413#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */ 2414#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */ 2415#define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */ 2416#define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */ 2417#define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */ 2418#define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */ 2419#define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */ 2420#define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */ 2421#define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */ 2422#define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */ 2423#define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */ 2424#define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */ 2425#define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */ 2426#define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */ 2427#define SQLITE_DBCONFIG_MAX 1017 /* Largest DBCONFIG */ 2428 2429/* 2430** CAPI3REF: Enable Or Disable Extended Result Codes 2431** METHOD: sqlite3 2432** 2433** ^The sqlite3_extended_result_codes() routine enables or disables the 2434** [extended result codes] feature of SQLite. ^The extended result 2435** codes are disabled by default for historical compatibility. 2436*/ 2437int sqlite3_extended_result_codes(sqlite3*, int onoff); 2438 2439/* 2440** CAPI3REF: Last Insert Rowid 2441** METHOD: sqlite3 2442** 2443** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables) 2444** has a unique 64-bit signed 2445** integer key called the [ROWID | "rowid"]. ^The rowid is always available 2446** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 2447** names are not also used by explicitly declared columns. ^If 2448** the table has a column of type [INTEGER PRIMARY KEY] then that column 2449** is another alias for the rowid. 2450** 2451** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of 2452** the most recent successful [INSERT] into a rowid table or [virtual table] 2453** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not 2454** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred 2455** on the database connection D, then sqlite3_last_insert_rowid(D) returns 2456** zero. 2457** 2458** As well as being set automatically as rows are inserted into database 2459** tables, the value returned by this function may be set explicitly by 2460** [sqlite3_set_last_insert_rowid()] 2461** 2462** Some virtual table implementations may INSERT rows into rowid tables as 2463** part of committing a transaction (e.g. to flush data accumulated in memory 2464** to disk). In this case subsequent calls to this function return the rowid 2465** associated with these internal INSERT operations, which leads to 2466** unintuitive results. Virtual table implementations that do write to rowid 2467** tables in this way can avoid this problem by restoring the original 2468** rowid value using [sqlite3_set_last_insert_rowid()] before returning 2469** control to the user. 2470** 2471** ^(If an [INSERT] occurs within a trigger then this routine will 2472** return the [rowid] of the inserted row as long as the trigger is 2473** running. Once the trigger program ends, the value returned 2474** by this routine reverts to what it was before the trigger was fired.)^ 2475** 2476** ^An [INSERT] that fails due to a constraint violation is not a 2477** successful [INSERT] and does not change the value returned by this 2478** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 2479** and INSERT OR ABORT make no changes to the return value of this 2480** routine when their insertion fails. ^(When INSERT OR REPLACE 2481** encounters a constraint violation, it does not fail. The 2482** INSERT continues to completion after deleting rows that caused 2483** the constraint problem so INSERT OR REPLACE will always change 2484** the return value of this interface.)^ 2485** 2486** ^For the purposes of this routine, an [INSERT] is considered to 2487** be successful even if it is subsequently rolled back. 2488** 2489** This function is accessible to SQL statements via the 2490** [last_insert_rowid() SQL function]. 2491** 2492** If a separate thread performs a new [INSERT] on the same 2493** database connection while the [sqlite3_last_insert_rowid()] 2494** function is running and thus changes the last insert [rowid], 2495** then the value returned by [sqlite3_last_insert_rowid()] is 2496** unpredictable and might not equal either the old or the new 2497** last insert [rowid]. 2498*/ 2499sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); 2500 2501/* 2502** CAPI3REF: Set the Last Insert Rowid value. 2503** METHOD: sqlite3 2504** 2505** The sqlite3_set_last_insert_rowid(D, R) method allows the application to 2506** set the value returned by calling sqlite3_last_insert_rowid(D) to R 2507** without inserting a row into the database. 2508*/ 2509void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64); 2510 2511/* 2512** CAPI3REF: Count The Number Of Rows Modified 2513** METHOD: sqlite3 2514** 2515** ^These functions return the number of rows modified, inserted or 2516** deleted by the most recently completed INSERT, UPDATE or DELETE 2517** statement on the database connection specified by the only parameter. 2518** The two functions are identical except for the type of the return value 2519** and that if the number of rows modified by the most recent INSERT, UPDATE 2520** or DELETE is greater than the maximum value supported by type "int", then 2521** the return value of sqlite3_changes() is undefined. ^Executing any other 2522** type of SQL statement does not modify the value returned by these functions. 2523** 2524** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are 2525** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], 2526** [foreign key actions] or [REPLACE] constraint resolution are not counted. 2527** 2528** Changes to a view that are intercepted by 2529** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value 2530** returned by sqlite3_changes() immediately after an INSERT, UPDATE or 2531** DELETE statement run on a view is always zero. Only changes made to real 2532** tables are counted. 2533** 2534** Things are more complicated if the sqlite3_changes() function is 2535** executed while a trigger program is running. This may happen if the 2536** program uses the [changes() SQL function], or if some other callback 2537** function invokes sqlite3_changes() directly. Essentially: 2538** 2539** <ul> 2540** <li> ^(Before entering a trigger program the value returned by 2541** sqlite3_changes() function is saved. After the trigger program 2542** has finished, the original value is restored.)^ 2543** 2544** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE 2545** statement sets the value returned by sqlite3_changes() 2546** upon completion as normal. Of course, this value will not include 2547** any changes performed by sub-triggers, as the sqlite3_changes() 2548** value will be saved and restored after each sub-trigger has run.)^ 2549** </ul> 2550** 2551** ^This means that if the changes() SQL function (or similar) is used 2552** by the first INSERT, UPDATE or DELETE statement within a trigger, it 2553** returns the value as set when the calling statement began executing. 2554** ^If it is used by the second or subsequent such statement within a trigger 2555** program, the value returned reflects the number of rows modified by the 2556** previous INSERT, UPDATE or DELETE statement within the same trigger. 2557** 2558** If a separate thread makes changes on the same database connection 2559** while [sqlite3_changes()] is running then the value returned 2560** is unpredictable and not meaningful. 2561** 2562** See also: 2563** <ul> 2564** <li> the [sqlite3_total_changes()] interface 2565** <li> the [count_changes pragma] 2566** <li> the [changes() SQL function] 2567** <li> the [data_version pragma] 2568** </ul> 2569*/ 2570int sqlite3_changes(sqlite3*); 2571sqlite3_int64 sqlite3_changes64(sqlite3*); 2572 2573/* 2574** CAPI3REF: Total Number Of Rows Modified 2575** METHOD: sqlite3 2576** 2577** ^These functions return the total number of rows inserted, modified or 2578** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed 2579** since the database connection was opened, including those executed as 2580** part of trigger programs. The two functions are identical except for the 2581** type of the return value and that if the number of rows modified by the 2582** connection exceeds the maximum value supported by type "int", then 2583** the return value of sqlite3_total_changes() is undefined. ^Executing 2584** any other type of SQL statement does not affect the value returned by 2585** sqlite3_total_changes(). 2586** 2587** ^Changes made as part of [foreign key actions] are included in the 2588** count, but those made as part of REPLACE constraint resolution are 2589** not. ^Changes to a view that are intercepted by INSTEAD OF triggers 2590** are not counted. 2591** 2592** The [sqlite3_total_changes(D)] interface only reports the number 2593** of rows that changed due to SQL statement run against database 2594** connection D. Any changes by other database connections are ignored. 2595** To detect changes against a database file from other database 2596** connections use the [PRAGMA data_version] command or the 2597** [SQLITE_FCNTL_DATA_VERSION] [file control]. 2598** 2599** If a separate thread makes changes on the same database connection 2600** while [sqlite3_total_changes()] is running then the value 2601** returned is unpredictable and not meaningful. 2602** 2603** See also: 2604** <ul> 2605** <li> the [sqlite3_changes()] interface 2606** <li> the [count_changes pragma] 2607** <li> the [changes() SQL function] 2608** <li> the [data_version pragma] 2609** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control] 2610** </ul> 2611*/ 2612int sqlite3_total_changes(sqlite3*); 2613sqlite3_int64 sqlite3_total_changes64(sqlite3*); 2614 2615/* 2616** CAPI3REF: Interrupt A Long-Running Query 2617** METHOD: sqlite3 2618** 2619** ^This function causes any pending database operation to abort and 2620** return at its earliest opportunity. This routine is typically 2621** called in response to a user action such as pressing "Cancel" 2622** or Ctrl-C where the user wants a long query operation to halt 2623** immediately. 2624** 2625** ^It is safe to call this routine from a thread different from the 2626** thread that is currently running the database operation. But it 2627** is not safe to call this routine with a [database connection] that 2628** is closed or might close before sqlite3_interrupt() returns. 2629** 2630** ^If an SQL operation is very nearly finished at the time when 2631** sqlite3_interrupt() is called, then it might not have an opportunity 2632** to be interrupted and might continue to completion. 2633** 2634** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 2635** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 2636** that is inside an explicit transaction, then the entire transaction 2637** will be rolled back automatically. 2638** 2639** ^The sqlite3_interrupt(D) call is in effect until all currently running 2640** SQL statements on [database connection] D complete. ^Any new SQL statements 2641** that are started after the sqlite3_interrupt() call and before the 2642** running statement count reaches zero are interrupted as if they had been 2643** running prior to the sqlite3_interrupt() call. ^New SQL statements 2644** that are started after the running statement count reaches zero are 2645** not effected by the sqlite3_interrupt(). 2646** ^A call to sqlite3_interrupt(D) that occurs when there are no running 2647** SQL statements is a no-op and has no effect on SQL statements 2648** that are started after the sqlite3_interrupt() call returns. 2649*/ 2650void sqlite3_interrupt(sqlite3*); 2651 2652/* 2653** CAPI3REF: Determine If An SQL Statement Is Complete 2654** 2655** These routines are useful during command-line input to determine if the 2656** currently entered text seems to form a complete SQL statement or 2657** if additional input is needed before sending the text into 2658** SQLite for parsing. ^These routines return 1 if the input string 2659** appears to be a complete SQL statement. ^A statement is judged to be 2660** complete if it ends with a semicolon token and is not a prefix of a 2661** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within 2662** string literals or quoted identifier names or comments are not 2663** independent tokens (they are part of the token in which they are 2664** embedded) and thus do not count as a statement terminator. ^Whitespace 2665** and comments that follow the final semicolon are ignored. 2666** 2667** ^These routines return 0 if the statement is incomplete. ^If a 2668** memory allocation fails, then SQLITE_NOMEM is returned. 2669** 2670** ^These routines do not parse the SQL statements thus 2671** will not detect syntactically incorrect SQL. 2672** 2673** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior 2674** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked 2675** automatically by sqlite3_complete16(). If that initialization fails, 2676** then the return value from sqlite3_complete16() will be non-zero 2677** regardless of whether or not the input SQL is complete.)^ 2678** 2679** The input to [sqlite3_complete()] must be a zero-terminated 2680** UTF-8 string. 2681** 2682** The input to [sqlite3_complete16()] must be a zero-terminated 2683** UTF-16 string in native byte order. 2684*/ 2685int sqlite3_complete(const char *sql); 2686int sqlite3_complete16(const void *sql); 2687 2688/* 2689** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors 2690** KEYWORDS: {busy-handler callback} {busy handler} 2691** METHOD: sqlite3 2692** 2693** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X 2694** that might be invoked with argument P whenever 2695** an attempt is made to access a database table associated with 2696** [database connection] D when another thread 2697** or process has the table locked. 2698** The sqlite3_busy_handler() interface is used to implement 2699** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout]. 2700** 2701** ^If the busy callback is NULL, then [SQLITE_BUSY] 2702** is returned immediately upon encountering the lock. ^If the busy callback 2703** is not NULL, then the callback might be invoked with two arguments. 2704** 2705** ^The first argument to the busy handler is a copy of the void* pointer which 2706** is the third argument to sqlite3_busy_handler(). ^The second argument to 2707** the busy handler callback is the number of times that the busy handler has 2708** been invoked previously for the same locking event. ^If the 2709** busy callback returns 0, then no additional attempts are made to 2710** access the database and [SQLITE_BUSY] is returned 2711** to the application. 2712** ^If the callback returns non-zero, then another attempt 2713** is made to access the database and the cycle repeats. 2714** 2715** The presence of a busy handler does not guarantee that it will be invoked 2716** when there is lock contention. ^If SQLite determines that invoking the busy 2717** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 2718** to the application instead of invoking the 2719** busy handler. 2720** Consider a scenario where one process is holding a read lock that 2721** it is trying to promote to a reserved lock and 2722** a second process is holding a reserved lock that it is trying 2723** to promote to an exclusive lock. The first process cannot proceed 2724** because it is blocked by the second and the second process cannot 2725** proceed because it is blocked by the first. If both processes 2726** invoke the busy handlers, neither will make any progress. Therefore, 2727** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 2728** will induce the first process to release its read lock and allow 2729** the second process to proceed. 2730** 2731** ^The default busy callback is NULL. 2732** 2733** ^(There can only be a single busy handler defined for each 2734** [database connection]. Setting a new busy handler clears any 2735** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] 2736** or evaluating [PRAGMA busy_timeout=N] will change the 2737** busy handler and thus clear any previously set busy handler. 2738** 2739** The busy callback should not take any actions which modify the 2740** database connection that invoked the busy handler. In other words, 2741** the busy handler is not reentrant. Any such actions 2742** result in undefined behavior. 2743** 2744** A busy handler must not close the database connection 2745** or [prepared statement] that invoked the busy handler. 2746*/ 2747int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*); 2748 2749/* 2750** CAPI3REF: Set A Busy Timeout 2751** METHOD: sqlite3 2752** 2753** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 2754** for a specified amount of time when a table is locked. ^The handler 2755** will sleep multiple times until at least "ms" milliseconds of sleeping 2756** have accumulated. ^After at least "ms" milliseconds of sleeping, 2757** the handler returns 0 which causes [sqlite3_step()] to return 2758** [SQLITE_BUSY]. 2759** 2760** ^Calling this routine with an argument less than or equal to zero 2761** turns off all busy handlers. 2762** 2763** ^(There can only be a single busy handler for a particular 2764** [database connection] at any given moment. If another busy handler 2765** was defined (using [sqlite3_busy_handler()]) prior to calling 2766** this routine, that other busy handler is cleared.)^ 2767** 2768** See also: [PRAGMA busy_timeout] 2769*/ 2770int sqlite3_busy_timeout(sqlite3*, int ms); 2771 2772/* 2773** CAPI3REF: Convenience Routines For Running Queries 2774** METHOD: sqlite3 2775** 2776** This is a legacy interface that is preserved for backwards compatibility. 2777** Use of this interface is not recommended. 2778** 2779** Definition: A <b>result table</b> is memory data structure created by the 2780** [sqlite3_get_table()] interface. A result table records the 2781** complete query results from one or more queries. 2782** 2783** The table conceptually has a number of rows and columns. But 2784** these numbers are not part of the result table itself. These 2785** numbers are obtained separately. Let N be the number of rows 2786** and M be the number of columns. 2787** 2788** A result table is an array of pointers to zero-terminated UTF-8 strings. 2789** There are (N+1)*M elements in the array. The first M pointers point 2790** to zero-terminated strings that contain the names of the columns. 2791** The remaining entries all point to query results. NULL values result 2792** in NULL pointers. All other values are in their UTF-8 zero-terminated 2793** string representation as returned by [sqlite3_column_text()]. 2794** 2795** A result table might consist of one or more memory allocations. 2796** It is not safe to pass a result table directly to [sqlite3_free()]. 2797** A result table should be deallocated using [sqlite3_free_table()]. 2798** 2799** ^(As an example of the result table format, suppose a query result 2800** is as follows: 2801** 2802** <blockquote><pre> 2803** Name | Age 2804** ----------------------- 2805** Alice | 43 2806** Bob | 28 2807** Cindy | 21 2808** </pre></blockquote> 2809** 2810** There are two columns (M==2) and three rows (N==3). Thus the 2811** result table has 8 entries. Suppose the result table is stored 2812** in an array named azResult. Then azResult holds this content: 2813** 2814** <blockquote><pre> 2815** azResult[0] = "Name"; 2816** azResult[1] = "Age"; 2817** azResult[2] = "Alice"; 2818** azResult[3] = "43"; 2819** azResult[4] = "Bob"; 2820** azResult[5] = "28"; 2821** azResult[6] = "Cindy"; 2822** azResult[7] = "21"; 2823** </pre></blockquote>)^ 2824** 2825** ^The sqlite3_get_table() function evaluates one or more 2826** semicolon-separated SQL statements in the zero-terminated UTF-8 2827** string of its 2nd parameter and returns a result table to the 2828** pointer given in its 3rd parameter. 2829** 2830** After the application has finished with the result from sqlite3_get_table(), 2831** it must pass the result table pointer to sqlite3_free_table() in order to 2832** release the memory that was malloced. Because of the way the 2833** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 2834** function must not try to call [sqlite3_free()] directly. Only 2835** [sqlite3_free_table()] is able to release the memory properly and safely. 2836** 2837** The sqlite3_get_table() interface is implemented as a wrapper around 2838** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 2839** to any internal data structures of SQLite. It uses only the public 2840** interface defined here. As a consequence, errors that occur in the 2841** wrapper layer outside of the internal [sqlite3_exec()] call are not 2842** reflected in subsequent calls to [sqlite3_errcode()] or 2843** [sqlite3_errmsg()]. 2844*/ 2845int sqlite3_get_table( 2846 sqlite3 *db, /* An open database */ 2847 const char *zSql, /* SQL to be evaluated */ 2848 char ***pazResult, /* Results of the query */ 2849 int *pnRow, /* Number of result rows written here */ 2850 int *pnColumn, /* Number of result columns written here */ 2851 char **pzErrmsg /* Error msg written here */ 2852); 2853void sqlite3_free_table(char **result); 2854 2855/* 2856** CAPI3REF: Formatted String Printing Functions 2857** 2858** These routines are work-alikes of the "printf()" family of functions 2859** from the standard C library. 2860** These routines understand most of the common formatting options from 2861** the standard library printf() 2862** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]). 2863** See the [built-in printf()] documentation for details. 2864** 2865** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 2866** results into memory obtained from [sqlite3_malloc64()]. 2867** The strings returned by these two routines should be 2868** released by [sqlite3_free()]. ^Both routines return a 2869** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough 2870** memory to hold the resulting string. 2871** 2872** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from 2873** the standard C library. The result is written into the 2874** buffer supplied as the second parameter whose size is given by 2875** the first parameter. Note that the order of the 2876** first two parameters is reversed from snprintf().)^ This is an 2877** historical accident that cannot be fixed without breaking 2878** backwards compatibility. ^(Note also that sqlite3_snprintf() 2879** returns a pointer to its buffer instead of the number of 2880** characters actually written into the buffer.)^ We admit that 2881** the number of characters written would be a more useful return 2882** value but we cannot change the implementation of sqlite3_snprintf() 2883** now without breaking compatibility. 2884** 2885** ^As long as the buffer size is greater than zero, sqlite3_snprintf() 2886** guarantees that the buffer is always zero-terminated. ^The first 2887** parameter "n" is the total size of the buffer, including space for 2888** the zero terminator. So the longest string that can be completely 2889** written will be n-1 characters. 2890** 2891** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). 2892** 2893** See also: [built-in printf()], [printf() SQL function] 2894*/ 2895char *sqlite3_mprintf(const char*,...); 2896char *sqlite3_vmprintf(const char*, va_list); 2897char *sqlite3_snprintf(int,char*,const char*, ...); 2898char *sqlite3_vsnprintf(int,char*,const char*, va_list); 2899 2900/* 2901** CAPI3REF: Memory Allocation Subsystem 2902** 2903** The SQLite core uses these three routines for all of its own 2904** internal memory allocation needs. "Core" in the previous sentence 2905** does not include operating-system specific [VFS] implementation. The 2906** Windows VFS uses native malloc() and free() for some operations. 2907** 2908** ^The sqlite3_malloc() routine returns a pointer to a block 2909** of memory at least N bytes in length, where N is the parameter. 2910** ^If sqlite3_malloc() is unable to obtain sufficient free 2911** memory, it returns a NULL pointer. ^If the parameter N to 2912** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 2913** a NULL pointer. 2914** 2915** ^The sqlite3_malloc64(N) routine works just like 2916** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead 2917** of a signed 32-bit integer. 2918** 2919** ^Calling sqlite3_free() with a pointer previously returned 2920** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 2921** that it might be reused. ^The sqlite3_free() routine is 2922** a no-op if is called with a NULL pointer. Passing a NULL pointer 2923** to sqlite3_free() is harmless. After being freed, memory 2924** should neither be read nor written. Even reading previously freed 2925** memory might result in a segmentation fault or other severe error. 2926** Memory corruption, a segmentation fault, or other severe error 2927** might result if sqlite3_free() is called with a non-NULL pointer that 2928** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 2929** 2930** ^The sqlite3_realloc(X,N) interface attempts to resize a 2931** prior memory allocation X to be at least N bytes. 2932** ^If the X parameter to sqlite3_realloc(X,N) 2933** is a NULL pointer then its behavior is identical to calling 2934** sqlite3_malloc(N). 2935** ^If the N parameter to sqlite3_realloc(X,N) is zero or 2936** negative then the behavior is exactly the same as calling 2937** sqlite3_free(X). 2938** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation 2939** of at least N bytes in size or NULL if insufficient memory is available. 2940** ^If M is the size of the prior allocation, then min(N,M) bytes 2941** of the prior allocation are copied into the beginning of buffer returned 2942** by sqlite3_realloc(X,N) and the prior allocation is freed. 2943** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the 2944** prior allocation is not freed. 2945** 2946** ^The sqlite3_realloc64(X,N) interfaces works the same as 2947** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead 2948** of a 32-bit signed integer. 2949** 2950** ^If X is a memory allocation previously obtained from sqlite3_malloc(), 2951** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then 2952** sqlite3_msize(X) returns the size of that memory allocation in bytes. 2953** ^The value returned by sqlite3_msize(X) might be larger than the number 2954** of bytes requested when X was allocated. ^If X is a NULL pointer then 2955** sqlite3_msize(X) returns zero. If X points to something that is not 2956** the beginning of memory allocation, or if it points to a formerly 2957** valid memory allocation that has now been freed, then the behavior 2958** of sqlite3_msize(X) is undefined and possibly harmful. 2959** 2960** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(), 2961** sqlite3_malloc64(), and sqlite3_realloc64() 2962** is always aligned to at least an 8 byte boundary, or to a 2963** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time 2964** option is used. 2965** 2966** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 2967** must be either NULL or else pointers obtained from a prior 2968** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 2969** not yet been released. 2970** 2971** The application must not read or write any part of 2972** a block of memory after it has been released using 2973** [sqlite3_free()] or [sqlite3_realloc()]. 2974*/ 2975void *sqlite3_malloc(int); 2976void *sqlite3_malloc64(sqlite3_uint64); 2977void *sqlite3_realloc(void*, int); 2978void *sqlite3_realloc64(void*, sqlite3_uint64); 2979void sqlite3_free(void*); 2980sqlite3_uint64 sqlite3_msize(void*); 2981 2982/* 2983** CAPI3REF: Memory Allocator Statistics 2984** 2985** SQLite provides these two interfaces for reporting on the status 2986** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 2987** routines, which form the built-in memory allocation subsystem. 2988** 2989** ^The [sqlite3_memory_used()] routine returns the number of bytes 2990** of memory currently outstanding (malloced but not freed). 2991** ^The [sqlite3_memory_highwater()] routine returns the maximum 2992** value of [sqlite3_memory_used()] since the high-water mark 2993** was last reset. ^The values returned by [sqlite3_memory_used()] and 2994** [sqlite3_memory_highwater()] include any overhead 2995** added by SQLite in its implementation of [sqlite3_malloc()], 2996** but not overhead added by the any underlying system library 2997** routines that [sqlite3_malloc()] may call. 2998** 2999** ^The memory high-water mark is reset to the current value of 3000** [sqlite3_memory_used()] if and only if the parameter to 3001** [sqlite3_memory_highwater()] is true. ^The value returned 3002** by [sqlite3_memory_highwater(1)] is the high-water mark 3003** prior to the reset. 3004*/ 3005sqlite3_int64 sqlite3_memory_used(void); 3006sqlite3_int64 sqlite3_memory_highwater(int resetFlag); 3007 3008/* 3009** CAPI3REF: Pseudo-Random Number Generator 3010** 3011** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 3012** select random [ROWID | ROWIDs] when inserting new records into a table that 3013** already uses the largest possible [ROWID]. The PRNG is also used for 3014** the built-in random() and randomblob() SQL functions. This interface allows 3015** applications to access the same PRNG for other purposes. 3016** 3017** ^A call to this routine stores N bytes of randomness into buffer P. 3018** ^The P parameter can be a NULL pointer. 3019** 3020** ^If this routine has not been previously called or if the previous 3021** call had N less than one or a NULL pointer for P, then the PRNG is 3022** seeded using randomness obtained from the xRandomness method of 3023** the default [sqlite3_vfs] object. 3024** ^If the previous call to this routine had an N of 1 or more and a 3025** non-NULL P then the pseudo-randomness is generated 3026** internally and without recourse to the [sqlite3_vfs] xRandomness 3027** method. 3028*/ 3029void sqlite3_randomness(int N, void *P); 3030 3031/* 3032** CAPI3REF: Compile-Time Authorization Callbacks 3033** METHOD: sqlite3 3034** KEYWORDS: {authorizer callback} 3035** 3036** ^This routine registers an authorizer callback with a particular 3037** [database connection], supplied in the first argument. 3038** ^The authorizer callback is invoked as SQL statements are being compiled 3039** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 3040** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()], 3041** and [sqlite3_prepare16_v3()]. ^At various 3042** points during the compilation process, as logic is being created 3043** to perform various actions, the authorizer callback is invoked to 3044** see if those actions are allowed. ^The authorizer callback should 3045** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 3046** specific action but allow the SQL statement to continue to be 3047** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 3048** rejected with an error. ^If the authorizer callback returns 3049** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 3050** then the [sqlite3_prepare_v2()] or equivalent call that triggered 3051** the authorizer will fail with an error message. 3052** 3053** When the callback returns [SQLITE_OK], that means the operation 3054** requested is ok. ^When the callback returns [SQLITE_DENY], the 3055** [sqlite3_prepare_v2()] or equivalent call that triggered the 3056** authorizer will fail with an error message explaining that 3057** access is denied. 3058** 3059** ^The first parameter to the authorizer callback is a copy of the third 3060** parameter to the sqlite3_set_authorizer() interface. ^The second parameter 3061** to the callback is an integer [SQLITE_COPY | action code] that specifies 3062** the particular action to be authorized. ^The third through sixth parameters 3063** to the callback are either NULL pointers or zero-terminated strings 3064** that contain additional details about the action to be authorized. 3065** Applications must always be prepared to encounter a NULL pointer in any 3066** of the third through the sixth parameters of the authorization callback. 3067** 3068** ^If the action code is [SQLITE_READ] 3069** and the callback returns [SQLITE_IGNORE] then the 3070** [prepared statement] statement is constructed to substitute 3071** a NULL value in place of the table column that would have 3072** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 3073** return can be used to deny an untrusted user access to individual 3074** columns of a table. 3075** ^When a table is referenced by a [SELECT] but no column values are 3076** extracted from that table (for example in a query like 3077** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback 3078** is invoked once for that table with a column name that is an empty string. 3079** ^If the action code is [SQLITE_DELETE] and the callback returns 3080** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the 3081** [truncate optimization] is disabled and all rows are deleted individually. 3082** 3083** An authorizer is used when [sqlite3_prepare | preparing] 3084** SQL statements from an untrusted source, to ensure that the SQL statements 3085** do not try to access data they are not allowed to see, or that they do not 3086** try to execute malicious statements that damage the database. For 3087** example, an application may allow a user to enter arbitrary 3088** SQL queries for evaluation by a database. But the application does 3089** not want the user to be able to make arbitrary changes to the 3090** database. An authorizer could then be put in place while the 3091** user-entered SQL is being [sqlite3_prepare | prepared] that 3092** disallows everything except [SELECT] statements. 3093** 3094** Applications that need to process SQL from untrusted sources 3095** might also consider lowering resource limits using [sqlite3_limit()] 3096** and limiting database size using the [max_page_count] [PRAGMA] 3097** in addition to using an authorizer. 3098** 3099** ^(Only a single authorizer can be in place on a database connection 3100** at a time. Each call to sqlite3_set_authorizer overrides the 3101** previous call.)^ ^Disable the authorizer by installing a NULL callback. 3102** The authorizer is disabled by default. 3103** 3104** The authorizer callback must not do anything that will modify 3105** the database connection that invoked the authorizer callback. 3106** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 3107** database connections for the meaning of "modify" in this paragraph. 3108** 3109** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the 3110** statement might be re-prepared during [sqlite3_step()] due to a 3111** schema change. Hence, the application should ensure that the 3112** correct authorizer callback remains in place during the [sqlite3_step()]. 3113** 3114** ^Note that the authorizer callback is invoked only during 3115** [sqlite3_prepare()] or its variants. Authorization is not 3116** performed during statement evaluation in [sqlite3_step()], unless 3117** as stated in the previous paragraph, sqlite3_step() invokes 3118** sqlite3_prepare_v2() to reprepare a statement after a schema change. 3119*/ 3120int sqlite3_set_authorizer( 3121 sqlite3*, 3122 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 3123 void *pUserData 3124); 3125 3126/* 3127** CAPI3REF: Authorizer Return Codes 3128** 3129** The [sqlite3_set_authorizer | authorizer callback function] must 3130** return either [SQLITE_OK] or one of these two constants in order 3131** to signal SQLite whether or not the action is permitted. See the 3132** [sqlite3_set_authorizer | authorizer documentation] for additional 3133** information. 3134** 3135** Note that SQLITE_IGNORE is also used as a [conflict resolution mode] 3136** returned from the [sqlite3_vtab_on_conflict()] interface. 3137*/ 3138#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 3139#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 3140 3141/* 3142** CAPI3REF: Authorizer Action Codes 3143** 3144** The [sqlite3_set_authorizer()] interface registers a callback function 3145** that is invoked to authorize certain SQL statement actions. The 3146** second parameter to the callback is an integer code that specifies 3147** what action is being authorized. These are the integer action codes that 3148** the authorizer callback may be passed. 3149** 3150** These action code values signify what kind of operation is to be 3151** authorized. The 3rd and 4th parameters to the authorization 3152** callback function will be parameters or NULL depending on which of these 3153** codes is used as the second parameter. ^(The 5th parameter to the 3154** authorizer callback is the name of the database ("main", "temp", 3155** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback 3156** is the name of the inner-most trigger or view that is responsible for 3157** the access attempt or NULL if this access attempt is directly from 3158** top-level SQL code. 3159*/ 3160/******************************************* 3rd ************ 4th ***********/ 3161#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 3162#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 3163#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 3164#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 3165#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 3166#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 3167#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 3168#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 3169#define SQLITE_DELETE 9 /* Table Name NULL */ 3170#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ 3171#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ 3172#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ 3173#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ 3174#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ 3175#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ 3176#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ 3177#define SQLITE_DROP_VIEW 17 /* View Name NULL */ 3178#define SQLITE_INSERT 18 /* Table Name NULL */ 3179#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ 3180#define SQLITE_READ 20 /* Table Name Column Name */ 3181#define SQLITE_SELECT 21 /* NULL NULL */ 3182#define SQLITE_TRANSACTION 22 /* Operation NULL */ 3183#define SQLITE_UPDATE 23 /* Table Name Column Name */ 3184#define SQLITE_ATTACH 24 /* Filename NULL */ 3185#define SQLITE_DETACH 25 /* Database Name NULL */ 3186#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 3187#define SQLITE_REINDEX 27 /* Index Name NULL */ 3188#define SQLITE_ANALYZE 28 /* Table Name NULL */ 3189#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 3190#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 3191#define SQLITE_FUNCTION 31 /* NULL Function Name */ 3192#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 3193#define SQLITE_COPY 0 /* No longer used */ 3194#define SQLITE_RECURSIVE 33 /* NULL NULL */ 3195 3196/* 3197** CAPI3REF: Tracing And Profiling Functions 3198** METHOD: sqlite3 3199** 3200** These routines are deprecated. Use the [sqlite3_trace_v2()] interface 3201** instead of the routines described here. 3202** 3203** These routines register callback functions that can be used for 3204** tracing and profiling the execution of SQL statements. 3205** 3206** ^The callback function registered by sqlite3_trace() is invoked at 3207** various times when an SQL statement is being run by [sqlite3_step()]. 3208** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the 3209** SQL statement text as the statement first begins executing. 3210** ^(Additional sqlite3_trace() callbacks might occur 3211** as each triggered subprogram is entered. The callbacks for triggers 3212** contain a UTF-8 SQL comment that identifies the trigger.)^ 3213** 3214** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit 3215** the length of [bound parameter] expansion in the output of sqlite3_trace(). 3216** 3217** ^The callback function registered by sqlite3_profile() is invoked 3218** as each SQL statement finishes. ^The profile callback contains 3219** the original statement text and an estimate of wall-clock time 3220** of how long that statement took to run. ^The profile callback 3221** time is in units of nanoseconds, however the current implementation 3222** is only capable of millisecond resolution so the six least significant 3223** digits in the time are meaningless. Future versions of SQLite 3224** might provide greater resolution on the profiler callback. Invoking 3225** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the 3226** profile callback. 3227*/ 3228SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*, 3229 void(*xTrace)(void*,const char*), void*); 3230SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*, 3231 void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 3232 3233/* 3234** CAPI3REF: SQL Trace Event Codes 3235** KEYWORDS: SQLITE_TRACE 3236** 3237** These constants identify classes of events that can be monitored 3238** using the [sqlite3_trace_v2()] tracing logic. The M argument 3239** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of 3240** the following constants. ^The first argument to the trace callback 3241** is one of the following constants. 3242** 3243** New tracing constants may be added in future releases. 3244** 3245** ^A trace callback has four arguments: xCallback(T,C,P,X). 3246** ^The T argument is one of the integer type codes above. 3247** ^The C argument is a copy of the context pointer passed in as the 3248** fourth argument to [sqlite3_trace_v2()]. 3249** The P and X arguments are pointers whose meanings depend on T. 3250** 3251** <dl> 3252** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt> 3253** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement 3254** first begins running and possibly at other times during the 3255** execution of the prepared statement, such as at the start of each 3256** trigger subprogram. ^The P argument is a pointer to the 3257** [prepared statement]. ^The X argument is a pointer to a string which 3258** is the unexpanded SQL text of the prepared statement or an SQL comment 3259** that indicates the invocation of a trigger. ^The callback can compute 3260** the same text that would have been returned by the legacy [sqlite3_trace()] 3261** interface by using the X argument when X begins with "--" and invoking 3262** [sqlite3_expanded_sql(P)] otherwise. 3263** 3264** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt> 3265** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same 3266** information as is provided by the [sqlite3_profile()] callback. 3267** ^The P argument is a pointer to the [prepared statement] and the 3268** X argument points to a 64-bit integer which is the estimated of 3269** the number of nanosecond that the prepared statement took to run. 3270** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes. 3271** 3272** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt> 3273** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared 3274** statement generates a single row of result. 3275** ^The P argument is a pointer to the [prepared statement] and the 3276** X argument is unused. 3277** 3278** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt> 3279** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database 3280** connection closes. 3281** ^The P argument is a pointer to the [database connection] object 3282** and the X argument is unused. 3283** </dl> 3284*/ 3285#define SQLITE_TRACE_STMT 0x01 3286#define SQLITE_TRACE_PROFILE 0x02 3287#define SQLITE_TRACE_ROW 0x04 3288#define SQLITE_TRACE_CLOSE 0x08 3289 3290/* 3291** CAPI3REF: SQL Trace Hook 3292** METHOD: sqlite3 3293** 3294** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback 3295** function X against [database connection] D, using property mask M 3296** and context pointer P. ^If the X callback is 3297** NULL or if the M mask is zero, then tracing is disabled. The 3298** M argument should be the bitwise OR-ed combination of 3299** zero or more [SQLITE_TRACE] constants. 3300** 3301** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides 3302** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2(). 3303** 3304** ^The X callback is invoked whenever any of the events identified by 3305** mask M occur. ^The integer return value from the callback is currently 3306** ignored, though this may change in future releases. Callback 3307** implementations should return zero to ensure future compatibility. 3308** 3309** ^A trace callback is invoked with four arguments: callback(T,C,P,X). 3310** ^The T argument is one of the [SQLITE_TRACE] 3311** constants to indicate why the callback was invoked. 3312** ^The C argument is a copy of the context pointer. 3313** The P and X arguments are pointers whose meanings depend on T. 3314** 3315** The sqlite3_trace_v2() interface is intended to replace the legacy 3316** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which 3317** are deprecated. 3318*/ 3319int sqlite3_trace_v2( 3320 sqlite3*, 3321 unsigned uMask, 3322 int(*xCallback)(unsigned,void*,void*,void*), 3323 void *pCtx 3324); 3325 3326/* 3327** CAPI3REF: Query Progress Callbacks 3328** METHOD: sqlite3 3329** 3330** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback 3331** function X to be invoked periodically during long running calls to 3332** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for 3333** database connection D. An example use for this 3334** interface is to keep a GUI updated during a large query. 3335** 3336** ^The parameter P is passed through as the only parameter to the 3337** callback function X. ^The parameter N is the approximate number of 3338** [virtual machine instructions] that are evaluated between successive 3339** invocations of the callback X. ^If N is less than one then the progress 3340** handler is disabled. 3341** 3342** ^Only a single progress handler may be defined at one time per 3343** [database connection]; setting a new progress handler cancels the 3344** old one. ^Setting parameter X to NULL disables the progress handler. 3345** ^The progress handler is also disabled by setting N to a value less 3346** than 1. 3347** 3348** ^If the progress callback returns non-zero, the operation is 3349** interrupted. This feature can be used to implement a 3350** "Cancel" button on a GUI progress dialog box. 3351** 3352** The progress handler callback must not do anything that will modify 3353** the database connection that invoked the progress handler. 3354** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 3355** database connections for the meaning of "modify" in this paragraph. 3356** 3357*/ 3358void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 3359 3360/* 3361** CAPI3REF: Opening A New Database Connection 3362** CONSTRUCTOR: sqlite3 3363** 3364** ^These routines open an SQLite database file as specified by the 3365** filename argument. ^The filename argument is interpreted as UTF-8 for 3366** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 3367** order for sqlite3_open16(). ^(A [database connection] handle is usually 3368** returned in *ppDb, even if an error occurs. The only exception is that 3369** if SQLite is unable to allocate memory to hold the [sqlite3] object, 3370** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 3371** object.)^ ^(If the database is opened (and/or created) successfully, then 3372** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The 3373** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 3374** an English language description of the error following a failure of any 3375** of the sqlite3_open() routines. 3376** 3377** ^The default encoding will be UTF-8 for databases created using 3378** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases 3379** created using sqlite3_open16() will be UTF-16 in the native byte order. 3380** 3381** Whether or not an error occurs when it is opened, resources 3382** associated with the [database connection] handle should be released by 3383** passing it to [sqlite3_close()] when it is no longer required. 3384** 3385** The sqlite3_open_v2() interface works like sqlite3_open() 3386** except that it accepts two additional parameters for additional control 3387** over the new database connection. ^(The flags parameter to 3388** sqlite3_open_v2() must include, at a minimum, one of the following 3389** three flag combinations:)^ 3390** 3391** <dl> 3392** ^(<dt>[SQLITE_OPEN_READONLY]</dt> 3393** <dd>The database is opened in read-only mode. If the database does not 3394** already exist, an error is returned.</dd>)^ 3395** 3396** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> 3397** <dd>The database is opened for reading and writing if possible, or reading 3398** only if the file is write protected by the operating system. In either 3399** case the database must already exist, otherwise an error is returned.</dd>)^ 3400** 3401** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 3402** <dd>The database is opened for reading and writing, and is created if 3403** it does not already exist. This is the behavior that is always used for 3404** sqlite3_open() and sqlite3_open16().</dd>)^ 3405** </dl> 3406** 3407** In addition to the required flags, the following optional flags are 3408** also supported: 3409** 3410** <dl> 3411** ^(<dt>[SQLITE_OPEN_URI]</dt> 3412** <dd>The filename can be interpreted as a URI if this flag is set.</dd>)^ 3413** 3414** ^(<dt>[SQLITE_OPEN_MEMORY]</dt> 3415** <dd>The database will be opened as an in-memory database. The database 3416** is named by the "filename" argument for the purposes of cache-sharing, 3417** if shared cache mode is enabled, but the "filename" is otherwise ignored. 3418** </dd>)^ 3419** 3420** ^(<dt>[SQLITE_OPEN_NOMUTEX]</dt> 3421** <dd>The new database connection will use the "multi-thread" 3422** [threading mode].)^ This means that separate threads are allowed 3423** to use SQLite at the same time, as long as each thread is using 3424** a different [database connection]. 3425** 3426** ^(<dt>[SQLITE_OPEN_FULLMUTEX]</dt> 3427** <dd>The new database connection will use the "serialized" 3428** [threading mode].)^ This means the multiple threads can safely 3429** attempt to use the same database connection at the same time. 3430** (Mutexes will block any actual concurrency, but in this mode 3431** there is no harm in trying.) 3432** 3433** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt> 3434** <dd>The database is opened [shared cache] enabled, overriding 3435** the default shared cache setting provided by 3436** [sqlite3_enable_shared_cache()].)^ 3437** The [use of shared cache mode is discouraged] and hence shared cache 3438** capabilities may be omitted from many builds of SQLite. In such cases, 3439** this option is a no-op. 3440** 3441** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt> 3442** <dd>The database is opened [shared cache] disabled, overriding 3443** the default shared cache setting provided by 3444** [sqlite3_enable_shared_cache()].)^ 3445** 3446** [[OPEN_EXRESCODE]] ^(<dt>[SQLITE_OPEN_EXRESCODE]</dt> 3447** <dd>The database connection comes up in "extended result code mode". 3448** In other words, the database behaves has if 3449** [sqlite3_extended_result_codes(db,1)] where called on the database 3450** connection as soon as the connection is created. In addition to setting 3451** the extended result code mode, this flag also causes [sqlite3_open_v2()] 3452** to return an extended result code.</dd> 3453** 3454** [[OPEN_NOFOLLOW]] ^(<dt>[SQLITE_OPEN_NOFOLLOW]</dt> 3455** <dd>The database filename is not allowed to contain a symbolic link</dd> 3456** </dl>)^ 3457** 3458** If the 3rd parameter to sqlite3_open_v2() is not one of the 3459** required combinations shown above optionally combined with other 3460** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] 3461** then the behavior is undefined. Historic versions of SQLite 3462** have silently ignored surplus bits in the flags parameter to 3463** sqlite3_open_v2(), however that behavior might not be carried through 3464** into future versions of SQLite and so applications should not rely 3465** upon it. Note in particular that the SQLITE_OPEN_EXCLUSIVE flag is a no-op 3466** for sqlite3_open_v2(). The SQLITE_OPEN_EXCLUSIVE does *not* cause 3467** the open to fail if the database already exists. The SQLITE_OPEN_EXCLUSIVE 3468** flag is intended for use by the [sqlite3_vfs|VFS interface] only, and not 3469** by sqlite3_open_v2(). 3470** 3471** ^The fourth parameter to sqlite3_open_v2() is the name of the 3472** [sqlite3_vfs] object that defines the operating system interface that 3473** the new database connection should use. ^If the fourth parameter is 3474** a NULL pointer then the default [sqlite3_vfs] object is used. 3475** 3476** ^If the filename is ":memory:", then a private, temporary in-memory database 3477** is created for the connection. ^This in-memory database will vanish when 3478** the database connection is closed. Future versions of SQLite might 3479** make use of additional special filenames that begin with the ":" character. 3480** It is recommended that when a database filename actually does begin with 3481** a ":" character you should prefix the filename with a pathname such as 3482** "./" to avoid ambiguity. 3483** 3484** ^If the filename is an empty string, then a private, temporary 3485** on-disk database will be created. ^This private database will be 3486** automatically deleted as soon as the database connection is closed. 3487** 3488** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3> 3489** 3490** ^If [URI filename] interpretation is enabled, and the filename argument 3491** begins with "file:", then the filename is interpreted as a URI. ^URI 3492** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is 3493** set in the third argument to sqlite3_open_v2(), or if it has 3494** been enabled globally using the [SQLITE_CONFIG_URI] option with the 3495** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. 3496** URI filename interpretation is turned off 3497** by default, but future releases of SQLite might enable URI filename 3498** interpretation by default. See "[URI filenames]" for additional 3499** information. 3500** 3501** URI filenames are parsed according to RFC 3986. ^If the URI contains an 3502** authority, then it must be either an empty string or the string 3503** "localhost". ^If the authority is not an empty string or "localhost", an 3504** error is returned to the caller. ^The fragment component of a URI, if 3505** present, is ignored. 3506** 3507** ^SQLite uses the path component of the URI as the name of the disk file 3508** which contains the database. ^If the path begins with a '/' character, 3509** then it is interpreted as an absolute path. ^If the path does not begin 3510** with a '/' (meaning that the authority section is omitted from the URI) 3511** then the path is interpreted as a relative path. 3512** ^(On windows, the first component of an absolute path 3513** is a drive specification (e.g. "C:").)^ 3514** 3515** [[core URI query parameters]] 3516** The query component of a URI may contain parameters that are interpreted 3517** either by SQLite itself, or by a [VFS | custom VFS implementation]. 3518** SQLite and its built-in [VFSes] interpret the 3519** following query parameters: 3520** 3521** <ul> 3522** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of 3523** a VFS object that provides the operating system interface that should 3524** be used to access the database file on disk. ^If this option is set to 3525** an empty string the default VFS object is used. ^Specifying an unknown 3526** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is 3527** present, then the VFS specified by the option takes precedence over 3528** the value passed as the fourth parameter to sqlite3_open_v2(). 3529** 3530** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw", 3531** "rwc", or "memory". Attempting to set it to any other value is 3532** an error)^. 3533** ^If "ro" is specified, then the database is opened for read-only 3534** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the 3535** third argument to sqlite3_open_v2(). ^If the mode option is set to 3536** "rw", then the database is opened for read-write (but not create) 3537** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had 3538** been set. ^Value "rwc" is equivalent to setting both 3539** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is 3540** set to "memory" then a pure [in-memory database] that never reads 3541** or writes from disk is used. ^It is an error to specify a value for 3542** the mode parameter that is less restrictive than that specified by 3543** the flags passed in the third parameter to sqlite3_open_v2(). 3544** 3545** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or 3546** "private". ^Setting it to "shared" is equivalent to setting the 3547** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to 3548** sqlite3_open_v2(). ^Setting the cache parameter to "private" is 3549** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. 3550** ^If sqlite3_open_v2() is used and the "cache" parameter is present in 3551** a URI filename, its value overrides any behavior requested by setting 3552** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. 3553** 3554** <li> <b>psow</b>: ^The psow parameter indicates whether or not the 3555** [powersafe overwrite] property does or does not apply to the 3556** storage media on which the database file resides. 3557** 3558** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter 3559** which if set disables file locking in rollback journal modes. This 3560** is useful for accessing a database on a filesystem that does not 3561** support locking. Caution: Database corruption might result if two 3562** or more processes write to the same database and any one of those 3563** processes uses nolock=1. 3564** 3565** <li> <b>immutable</b>: ^The immutable parameter is a boolean query 3566** parameter that indicates that the database file is stored on 3567** read-only media. ^When immutable is set, SQLite assumes that the 3568** database file cannot be changed, even by a process with higher 3569** privilege, and so the database is opened read-only and all locking 3570** and change detection is disabled. Caution: Setting the immutable 3571** property on a database file that does in fact change can result 3572** in incorrect query results and/or [SQLITE_CORRUPT] errors. 3573** See also: [SQLITE_IOCAP_IMMUTABLE]. 3574** 3575** </ul> 3576** 3577** ^Specifying an unknown parameter in the query component of a URI is not an 3578** error. Future versions of SQLite might understand additional query 3579** parameters. See "[query parameters with special meaning to SQLite]" for 3580** additional information. 3581** 3582** [[URI filename examples]] <h3>URI filename examples</h3> 3583** 3584** <table border="1" align=center cellpadding=5> 3585** <tr><th> URI filenames <th> Results 3586** <tr><td> file:data.db <td> 3587** Open the file "data.db" in the current directory. 3588** <tr><td> file:/home/fred/data.db<br> 3589** file:///home/fred/data.db <br> 3590** file://localhost/home/fred/data.db <br> <td> 3591** Open the database file "/home/fred/data.db". 3592** <tr><td> file://darkstar/home/fred/data.db <td> 3593** An error. "darkstar" is not a recognized authority. 3594** <tr><td style="white-space:nowrap"> 3595** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db 3596** <td> Windows only: Open the file "data.db" on fred's desktop on drive 3597** C:. Note that the %20 escaping in this example is not strictly 3598** necessary - space characters can be used literally 3599** in URI filenames. 3600** <tr><td> file:data.db?mode=ro&cache=private <td> 3601** Open file "data.db" in the current directory for read-only access. 3602** Regardless of whether or not shared-cache mode is enabled by 3603** default, use a private cache. 3604** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td> 3605** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile" 3606** that uses dot-files in place of posix advisory locking. 3607** <tr><td> file:data.db?mode=readonly <td> 3608** An error. "readonly" is not a valid option for the "mode" parameter. 3609** Use "ro" instead: "file:data.db?mode=ro". 3610** </table> 3611** 3612** ^URI hexadecimal escape sequences (%HH) are supported within the path and 3613** query components of a URI. A hexadecimal escape sequence consists of a 3614** percent sign - "%" - followed by exactly two hexadecimal digits 3615** specifying an octet value. ^Before the path or query components of a 3616** URI filename are interpreted, they are encoded using UTF-8 and all 3617** hexadecimal escape sequences replaced by a single byte containing the 3618** corresponding octet. If this process generates an invalid UTF-8 encoding, 3619** the results are undefined. 3620** 3621** <b>Note to Windows users:</b> The encoding used for the filename argument 3622** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 3623** codepage is currently defined. Filenames containing international 3624** characters must be converted to UTF-8 prior to passing them into 3625** sqlite3_open() or sqlite3_open_v2(). 3626** 3627** <b>Note to Windows Runtime users:</b> The temporary directory must be set 3628** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various 3629** features that require the use of temporary files may fail. 3630** 3631** See also: [sqlite3_temp_directory] 3632*/ 3633int sqlite3_open( 3634 const char *filename, /* Database filename (UTF-8) */ 3635 sqlite3 **ppDb /* OUT: SQLite db handle */ 3636); 3637int sqlite3_open16( 3638 const void *filename, /* Database filename (UTF-16) */ 3639 sqlite3 **ppDb /* OUT: SQLite db handle */ 3640); 3641int sqlite3_open_v2( 3642 const char *filename, /* Database filename (UTF-8) */ 3643 sqlite3 **ppDb, /* OUT: SQLite db handle */ 3644 int flags, /* Flags */ 3645 const char *zVfs /* Name of VFS module to use */ 3646); 3647 3648/* 3649** CAPI3REF: Obtain Values For URI Parameters 3650** 3651** These are utility routines, useful to [VFS|custom VFS implementations], 3652** that check if a database file was a URI that contained a specific query 3653** parameter, and if so obtains the value of that query parameter. 3654** 3655** The first parameter to these interfaces (hereafter referred to 3656** as F) must be one of: 3657** <ul> 3658** <li> A database filename pointer created by the SQLite core and 3659** passed into the xOpen() method of a VFS implemention, or 3660** <li> A filename obtained from [sqlite3_db_filename()], or 3661** <li> A new filename constructed using [sqlite3_create_filename()]. 3662** </ul> 3663** If the F parameter is not one of the above, then the behavior is 3664** undefined and probably undesirable. Older versions of SQLite were 3665** more tolerant of invalid F parameters than newer versions. 3666** 3667** If F is a suitable filename (as described in the previous paragraph) 3668** and if P is the name of the query parameter, then 3669** sqlite3_uri_parameter(F,P) returns the value of the P 3670** parameter if it exists or a NULL pointer if P does not appear as a 3671** query parameter on F. If P is a query parameter of F and it 3672** has no explicit value, then sqlite3_uri_parameter(F,P) returns 3673** a pointer to an empty string. 3674** 3675** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean 3676** parameter and returns true (1) or false (0) according to the value 3677** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the 3678** value of query parameter P is one of "yes", "true", or "on" in any 3679** case or if the value begins with a non-zero number. The 3680** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of 3681** query parameter P is one of "no", "false", or "off" in any case or 3682** if the value begins with a numeric zero. If P is not a query 3683** parameter on F or if the value of P does not match any of the 3684** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). 3685** 3686** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a 3687** 64-bit signed integer and returns that integer, or D if P does not 3688** exist. If the value of P is something other than an integer, then 3689** zero is returned. 3690** 3691** The sqlite3_uri_key(F,N) returns a pointer to the name (not 3692** the value) of the N-th query parameter for filename F, or a NULL 3693** pointer if N is less than zero or greater than the number of query 3694** parameters minus 1. The N value is zero-based so N should be 0 to obtain 3695** the name of the first query parameter, 1 for the second parameter, and 3696** so forth. 3697** 3698** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and 3699** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and 3700** is not a database file pathname pointer that the SQLite core passed 3701** into the xOpen VFS method, then the behavior of this routine is undefined 3702** and probably undesirable. 3703** 3704** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F 3705** parameter can also be the name of a rollback journal file or WAL file 3706** in addition to the main database file. Prior to version 3.31.0, these 3707** routines would only work if F was the name of the main database file. 3708** When the F parameter is the name of the rollback journal or WAL file, 3709** it has access to all the same query parameters as were found on the 3710** main database file. 3711** 3712** See the [URI filename] documentation for additional information. 3713*/ 3714const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); 3715int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); 3716sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); 3717const char *sqlite3_uri_key(const char *zFilename, int N); 3718 3719/* 3720** CAPI3REF: Translate filenames 3721** 3722** These routines are available to [VFS|custom VFS implementations] for 3723** translating filenames between the main database file, the journal file, 3724** and the WAL file. 3725** 3726** If F is the name of an sqlite database file, journal file, or WAL file 3727** passed by the SQLite core into the VFS, then sqlite3_filename_database(F) 3728** returns the name of the corresponding database file. 3729** 3730** If F is the name of an sqlite database file, journal file, or WAL file 3731** passed by the SQLite core into the VFS, or if F is a database filename 3732** obtained from [sqlite3_db_filename()], then sqlite3_filename_journal(F) 3733** returns the name of the corresponding rollback journal file. 3734** 3735** If F is the name of an sqlite database file, journal file, or WAL file 3736** that was passed by the SQLite core into the VFS, or if F is a database 3737** filename obtained from [sqlite3_db_filename()], then 3738** sqlite3_filename_wal(F) returns the name of the corresponding 3739** WAL file. 3740** 3741** In all of the above, if F is not the name of a database, journal or WAL 3742** filename passed into the VFS from the SQLite core and F is not the 3743** return value from [sqlite3_db_filename()], then the result is 3744** undefined and is likely a memory access violation. 3745*/ 3746const char *sqlite3_filename_database(const char*); 3747const char *sqlite3_filename_journal(const char*); 3748const char *sqlite3_filename_wal(const char*); 3749 3750/* 3751** CAPI3REF: Database File Corresponding To A Journal 3752** 3753** ^If X is the name of a rollback or WAL-mode journal file that is 3754** passed into the xOpen method of [sqlite3_vfs], then 3755** sqlite3_database_file_object(X) returns a pointer to the [sqlite3_file] 3756** object that represents the main database file. 3757** 3758** This routine is intended for use in custom [VFS] implementations 3759** only. It is not a general-purpose interface. 3760** The argument sqlite3_file_object(X) must be a filename pointer that 3761** has been passed into [sqlite3_vfs].xOpen method where the 3762** flags parameter to xOpen contains one of the bits 3763** [SQLITE_OPEN_MAIN_JOURNAL] or [SQLITE_OPEN_WAL]. Any other use 3764** of this routine results in undefined and probably undesirable 3765** behavior. 3766*/ 3767sqlite3_file *sqlite3_database_file_object(const char*); 3768 3769/* 3770** CAPI3REF: Create and Destroy VFS Filenames 3771** 3772** These interfces are provided for use by [VFS shim] implementations and 3773** are not useful outside of that context. 3774** 3775** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of 3776** database filename D with corresponding journal file J and WAL file W and 3777** with N URI parameters key/values pairs in the array P. The result from 3778** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that 3779** is safe to pass to routines like: 3780** <ul> 3781** <li> [sqlite3_uri_parameter()], 3782** <li> [sqlite3_uri_boolean()], 3783** <li> [sqlite3_uri_int64()], 3784** <li> [sqlite3_uri_key()], 3785** <li> [sqlite3_filename_database()], 3786** <li> [sqlite3_filename_journal()], or 3787** <li> [sqlite3_filename_wal()]. 3788** </ul> 3789** If a memory allocation error occurs, sqlite3_create_filename() might 3790** return a NULL pointer. The memory obtained from sqlite3_create_filename(X) 3791** must be released by a corresponding call to sqlite3_free_filename(Y). 3792** 3793** The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array 3794** of 2*N pointers to strings. Each pair of pointers in this array corresponds 3795** to a key and value for a query parameter. The P parameter may be a NULL 3796** pointer if N is zero. None of the 2*N pointers in the P array may be 3797** NULL pointers and key pointers should not be empty strings. 3798** None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may 3799** be NULL pointers, though they can be empty strings. 3800** 3801** The sqlite3_free_filename(Y) routine releases a memory allocation 3802** previously obtained from sqlite3_create_filename(). Invoking 3803** sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op. 3804** 3805** If the Y parameter to sqlite3_free_filename(Y) is anything other 3806** than a NULL pointer or a pointer previously acquired from 3807** sqlite3_create_filename(), then bad things such as heap 3808** corruption or segfaults may occur. The value Y should not be 3809** used again after sqlite3_free_filename(Y) has been called. This means 3810** that if the [sqlite3_vfs.xOpen()] method of a VFS has been called using Y, 3811** then the corresponding [sqlite3_module.xClose() method should also be 3812** invoked prior to calling sqlite3_free_filename(Y). 3813*/ 3814char *sqlite3_create_filename( 3815 const char *zDatabase, 3816 const char *zJournal, 3817 const char *zWal, 3818 int nParam, 3819 const char **azParam 3820); 3821void sqlite3_free_filename(char*); 3822 3823/* 3824** CAPI3REF: Error Codes And Messages 3825** METHOD: sqlite3 3826** 3827** ^If the most recent sqlite3_* API call associated with 3828** [database connection] D failed, then the sqlite3_errcode(D) interface 3829** returns the numeric [result code] or [extended result code] for that 3830** API call. 3831** ^The sqlite3_extended_errcode() 3832** interface is the same except that it always returns the 3833** [extended result code] even when extended result codes are 3834** disabled. 3835** 3836** The values returned by sqlite3_errcode() and/or 3837** sqlite3_extended_errcode() might change with each API call. 3838** Except, there are some interfaces that are guaranteed to never 3839** change the value of the error code. The error-code preserving 3840** interfaces include the following: 3841** 3842** <ul> 3843** <li> sqlite3_errcode() 3844** <li> sqlite3_extended_errcode() 3845** <li> sqlite3_errmsg() 3846** <li> sqlite3_errmsg16() 3847** <li> sqlite3_error_offset() 3848** </ul> 3849** 3850** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 3851** text that describes the error, as either UTF-8 or UTF-16 respectively. 3852** ^(Memory to hold the error message string is managed internally. 3853** The application does not need to worry about freeing the result. 3854** However, the error string might be overwritten or deallocated by 3855** subsequent calls to other SQLite interface functions.)^ 3856** 3857** ^The sqlite3_errstr() interface returns the English-language text 3858** that describes the [result code], as UTF-8. 3859** ^(Memory to hold the error message string is managed internally 3860** and must not be freed by the application)^. 3861** 3862** ^If the most recent error references a specific token in the input 3863** SQL, the sqlite3_error_offset() interface returns the byte offset 3864** of the start of that token. ^The byte offset returned by 3865** sqlite3_error_offset() assumes that the input SQL is UTF8. 3866** ^If the most recent error does not reference a specific token in the input 3867** SQL, then the sqlite3_error_offset() function returns -1. 3868** 3869** When the serialized [threading mode] is in use, it might be the 3870** case that a second error occurs on a separate thread in between 3871** the time of the first error and the call to these interfaces. 3872** When that happens, the second error will be reported since these 3873** interfaces always report the most recent result. To avoid 3874** this, each thread can obtain exclusive use of the [database connection] D 3875** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 3876** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 3877** all calls to the interfaces listed here are completed. 3878** 3879** If an interface fails with SQLITE_MISUSE, that means the interface 3880** was invoked incorrectly by the application. In that case, the 3881** error code and message may or may not be set. 3882*/ 3883int sqlite3_errcode(sqlite3 *db); 3884int sqlite3_extended_errcode(sqlite3 *db); 3885const char *sqlite3_errmsg(sqlite3*); 3886const void *sqlite3_errmsg16(sqlite3*); 3887const char *sqlite3_errstr(int); 3888int sqlite3_error_offset(sqlite3 *db); 3889 3890/* 3891** CAPI3REF: Prepared Statement Object 3892** KEYWORDS: {prepared statement} {prepared statements} 3893** 3894** An instance of this object represents a single SQL statement that 3895** has been compiled into binary form and is ready to be evaluated. 3896** 3897** Think of each SQL statement as a separate computer program. The 3898** original SQL text is source code. A prepared statement object 3899** is the compiled object code. All SQL must be converted into a 3900** prepared statement before it can be run. 3901** 3902** The life-cycle of a prepared statement object usually goes like this: 3903** 3904** <ol> 3905** <li> Create the prepared statement object using [sqlite3_prepare_v2()]. 3906** <li> Bind values to [parameters] using the sqlite3_bind_*() 3907** interfaces. 3908** <li> Run the SQL by calling [sqlite3_step()] one or more times. 3909** <li> Reset the prepared statement using [sqlite3_reset()] then go back 3910** to step 2. Do this zero or more times. 3911** <li> Destroy the object using [sqlite3_finalize()]. 3912** </ol> 3913*/ 3914typedef struct sqlite3_stmt sqlite3_stmt; 3915 3916/* 3917** CAPI3REF: Run-time Limits 3918** METHOD: sqlite3 3919** 3920** ^(This interface allows the size of various constructs to be limited 3921** on a connection by connection basis. The first parameter is the 3922** [database connection] whose limit is to be set or queried. The 3923** second parameter is one of the [limit categories] that define a 3924** class of constructs to be size limited. The third parameter is the 3925** new limit for that construct.)^ 3926** 3927** ^If the new limit is a negative number, the limit is unchanged. 3928** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a 3929** [limits | hard upper bound] 3930** set at compile-time by a C preprocessor macro called 3931** [limits | SQLITE_MAX_<i>NAME</i>]. 3932** (The "_LIMIT_" in the name is changed to "_MAX_".))^ 3933** ^Attempts to increase a limit above its hard upper bound are 3934** silently truncated to the hard upper bound. 3935** 3936** ^Regardless of whether or not the limit was changed, the 3937** [sqlite3_limit()] interface returns the prior value of the limit. 3938** ^Hence, to find the current value of a limit without changing it, 3939** simply invoke this interface with the third parameter set to -1. 3940** 3941** Run-time limits are intended for use in applications that manage 3942** both their own internal database and also databases that are controlled 3943** by untrusted external sources. An example application might be a 3944** web browser that has its own databases for storing history and 3945** separate databases controlled by JavaScript applications downloaded 3946** off the Internet. The internal databases can be given the 3947** large, default limits. Databases managed by external sources can 3948** be given much smaller limits designed to prevent a denial of service 3949** attack. Developers might also want to use the [sqlite3_set_authorizer()] 3950** interface to further control untrusted SQL. The size of the database 3951** created by an untrusted script can be contained using the 3952** [max_page_count] [PRAGMA]. 3953** 3954** New run-time limit categories may be added in future releases. 3955*/ 3956int sqlite3_limit(sqlite3*, int id, int newVal); 3957 3958/* 3959** CAPI3REF: Run-Time Limit Categories 3960** KEYWORDS: {limit category} {*limit categories} 3961** 3962** These constants define various performance limits 3963** that can be lowered at run-time using [sqlite3_limit()]. 3964** The synopsis of the meanings of the various limits is shown below. 3965** Additional information is available at [limits | Limits in SQLite]. 3966** 3967** <dl> 3968** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt> 3969** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ 3970** 3971** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> 3972** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ 3973** 3974** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt> 3975** <dd>The maximum number of columns in a table definition or in the 3976** result set of a [SELECT] or the maximum number of columns in an index 3977** or in an ORDER BY or GROUP BY clause.</dd>)^ 3978** 3979** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 3980** <dd>The maximum depth of the parse tree on any expression.</dd>)^ 3981** 3982** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 3983** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ 3984** 3985** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> 3986** <dd>The maximum number of instructions in a virtual machine program 3987** used to implement an SQL statement. If [sqlite3_prepare_v2()] or 3988** the equivalent tries to allocate space for more than this many opcodes 3989** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^ 3990** 3991** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 3992** <dd>The maximum number of arguments on a function.</dd>)^ 3993** 3994** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt> 3995** <dd>The maximum number of [ATTACH | attached databases].)^</dd> 3996** 3997** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] 3998** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 3999** <dd>The maximum length of the pattern argument to the [LIKE] or 4000** [GLOB] operators.</dd>)^ 4001** 4002** [[SQLITE_LIMIT_VARIABLE_NUMBER]] 4003** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 4004** <dd>The maximum index number of any [parameter] in an SQL statement.)^ 4005** 4006** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> 4007** <dd>The maximum depth of recursion for triggers.</dd>)^ 4008** 4009** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt> 4010** <dd>The maximum number of auxiliary worker threads that a single 4011** [prepared statement] may start.</dd>)^ 4012** </dl> 4013*/ 4014#define SQLITE_LIMIT_LENGTH 0 4015#define SQLITE_LIMIT_SQL_LENGTH 1 4016#define SQLITE_LIMIT_COLUMN 2 4017#define SQLITE_LIMIT_EXPR_DEPTH 3 4018#define SQLITE_LIMIT_COMPOUND_SELECT 4 4019#define SQLITE_LIMIT_VDBE_OP 5 4020#define SQLITE_LIMIT_FUNCTION_ARG 6 4021#define SQLITE_LIMIT_ATTACHED 7 4022#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 4023#define SQLITE_LIMIT_VARIABLE_NUMBER 9 4024#define SQLITE_LIMIT_TRIGGER_DEPTH 10 4025#define SQLITE_LIMIT_WORKER_THREADS 11 4026 4027/* 4028** CAPI3REF: Prepare Flags 4029** 4030** These constants define various flags that can be passed into 4031** "prepFlags" parameter of the [sqlite3_prepare_v3()] and 4032** [sqlite3_prepare16_v3()] interfaces. 4033** 4034** New flags may be added in future releases of SQLite. 4035** 4036** <dl> 4037** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt> 4038** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner 4039** that the prepared statement will be retained for a long time and 4040** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()] 4041** and [sqlite3_prepare16_v3()] assume that the prepared statement will 4042** be used just once or at most a few times and then destroyed using 4043** [sqlite3_finalize()] relatively soon. The current implementation acts 4044** on this hint by avoiding the use of [lookaside memory] so as not to 4045** deplete the limited store of lookaside memory. Future versions of 4046** SQLite may act on this hint differently. 4047** 4048** [[SQLITE_PREPARE_NORMALIZE]] <dt>SQLITE_PREPARE_NORMALIZE</dt> 4049** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used 4050** to be required for any prepared statement that wanted to use the 4051** [sqlite3_normalized_sql()] interface. However, the 4052** [sqlite3_normalized_sql()] interface is now available to all 4053** prepared statements, regardless of whether or not they use this 4054** flag. 4055** 4056** [[SQLITE_PREPARE_NO_VTAB]] <dt>SQLITE_PREPARE_NO_VTAB</dt> 4057** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler 4058** to return an error (error code SQLITE_ERROR) if the statement uses 4059** any virtual tables. 4060** </dl> 4061*/ 4062#define SQLITE_PREPARE_PERSISTENT 0x01 4063#define SQLITE_PREPARE_NORMALIZE 0x02 4064#define SQLITE_PREPARE_NO_VTAB 0x04 4065 4066/* 4067** CAPI3REF: Compiling An SQL Statement 4068** KEYWORDS: {SQL statement compiler} 4069** METHOD: sqlite3 4070** CONSTRUCTOR: sqlite3_stmt 4071** 4072** To execute an SQL statement, it must first be compiled into a byte-code 4073** program using one of these routines. Or, in other words, these routines 4074** are constructors for the [prepared statement] object. 4075** 4076** The preferred routine to use is [sqlite3_prepare_v2()]. The 4077** [sqlite3_prepare()] interface is legacy and should be avoided. 4078** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used 4079** for special purposes. 4080** 4081** The use of the UTF-8 interfaces is preferred, as SQLite currently 4082** does all parsing using UTF-8. The UTF-16 interfaces are provided 4083** as a convenience. The UTF-16 interfaces work by converting the 4084** input text into UTF-8, then invoking the corresponding UTF-8 interface. 4085** 4086** The first argument, "db", is a [database connection] obtained from a 4087** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or 4088** [sqlite3_open16()]. The database connection must not have been closed. 4089** 4090** The second argument, "zSql", is the statement to be compiled, encoded 4091** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(), 4092** and sqlite3_prepare_v3() 4093** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(), 4094** and sqlite3_prepare16_v3() use UTF-16. 4095** 4096** ^If the nByte argument is negative, then zSql is read up to the 4097** first zero terminator. ^If nByte is positive, then it is the 4098** number of bytes read from zSql. ^If nByte is zero, then no prepared 4099** statement is generated. 4100** If the caller knows that the supplied string is nul-terminated, then 4101** there is a small performance advantage to passing an nByte parameter that 4102** is the number of bytes in the input string <i>including</i> 4103** the nul-terminator. 4104** 4105** ^If pzTail is not NULL then *pzTail is made to point to the first byte 4106** past the end of the first SQL statement in zSql. These routines only 4107** compile the first statement in zSql, so *pzTail is left pointing to 4108** what remains uncompiled. 4109** 4110** ^*ppStmt is left pointing to a compiled [prepared statement] that can be 4111** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set 4112** to NULL. ^If the input text contains no SQL (if the input is an empty 4113** string or a comment) then *ppStmt is set to NULL. 4114** The calling procedure is responsible for deleting the compiled 4115** SQL statement using [sqlite3_finalize()] after it has finished with it. 4116** ppStmt may not be NULL. 4117** 4118** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; 4119** otherwise an [error code] is returned. 4120** 4121** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(), 4122** and sqlite3_prepare16_v3() interfaces are recommended for all new programs. 4123** The older interfaces (sqlite3_prepare() and sqlite3_prepare16()) 4124** are retained for backwards compatibility, but their use is discouraged. 4125** ^In the "vX" interfaces, the prepared statement 4126** that is returned (the [sqlite3_stmt] object) contains a copy of the 4127** original SQL text. This causes the [sqlite3_step()] interface to 4128** behave differently in three ways: 4129** 4130** <ol> 4131** <li> 4132** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 4133** always used to do, [sqlite3_step()] will automatically recompile the SQL 4134** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY] 4135** retries will occur before sqlite3_step() gives up and returns an error. 4136** </li> 4137** 4138** <li> 4139** ^When an error occurs, [sqlite3_step()] will return one of the detailed 4140** [error codes] or [extended error codes]. ^The legacy behavior was that 4141** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 4142** and the application would have to make a second call to [sqlite3_reset()] 4143** in order to find the underlying cause of the problem. With the "v2" prepare 4144** interfaces, the underlying reason for the error is returned immediately. 4145** </li> 4146** 4147** <li> 4148** ^If the specific value bound to a [parameter | host parameter] in the 4149** WHERE clause might influence the choice of query plan for a statement, 4150** then the statement will be automatically recompiled, as if there had been 4151** a schema change, on the first [sqlite3_step()] call following any change 4152** to the [sqlite3_bind_text | bindings] of that [parameter]. 4153** ^The specific value of a WHERE-clause [parameter] might influence the 4154** choice of query plan if the parameter is the left-hand side of a [LIKE] 4155** or [GLOB] operator or if the parameter is compared to an indexed column 4156** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled. 4157** </li> 4158** </ol> 4159** 4160** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having 4161** the extra prepFlags parameter, which is a bit array consisting of zero or 4162** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The 4163** sqlite3_prepare_v2() interface works exactly the same as 4164** sqlite3_prepare_v3() with a zero prepFlags parameter. 4165*/ 4166int sqlite3_prepare( 4167 sqlite3 *db, /* Database handle */ 4168 const char *zSql, /* SQL statement, UTF-8 encoded */ 4169 int nByte, /* Maximum length of zSql in bytes. */ 4170 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 4171 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 4172); 4173int sqlite3_prepare_v2( 4174 sqlite3 *db, /* Database handle */ 4175 const char *zSql, /* SQL statement, UTF-8 encoded */ 4176 int nByte, /* Maximum length of zSql in bytes. */ 4177 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 4178 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 4179); 4180int sqlite3_prepare_v3( 4181 sqlite3 *db, /* Database handle */ 4182 const char *zSql, /* SQL statement, UTF-8 encoded */ 4183 int nByte, /* Maximum length of zSql in bytes. */ 4184 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ 4185 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 4186 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 4187); 4188int sqlite3_prepare16( 4189 sqlite3 *db, /* Database handle */ 4190 const void *zSql, /* SQL statement, UTF-16 encoded */ 4191 int nByte, /* Maximum length of zSql in bytes. */ 4192 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 4193 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 4194); 4195int sqlite3_prepare16_v2( 4196 sqlite3 *db, /* Database handle */ 4197 const void *zSql, /* SQL statement, UTF-16 encoded */ 4198 int nByte, /* Maximum length of zSql in bytes. */ 4199 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 4200 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 4201); 4202int sqlite3_prepare16_v3( 4203 sqlite3 *db, /* Database handle */ 4204 const void *zSql, /* SQL statement, UTF-16 encoded */ 4205 int nByte, /* Maximum length of zSql in bytes. */ 4206 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ 4207 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 4208 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 4209); 4210 4211/* 4212** CAPI3REF: Retrieving Statement SQL 4213** METHOD: sqlite3_stmt 4214** 4215** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8 4216** SQL text used to create [prepared statement] P if P was 4217** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], 4218** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()]. 4219** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8 4220** string containing the SQL text of prepared statement P with 4221** [bound parameters] expanded. 4222** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8 4223** string containing the normalized SQL text of prepared statement P. The 4224** semantics used to normalize a SQL statement are unspecified and subject 4225** to change. At a minimum, literal values will be replaced with suitable 4226** placeholders. 4227** 4228** ^(For example, if a prepared statement is created using the SQL 4229** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345 4230** and parameter :xyz is unbound, then sqlite3_sql() will return 4231** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql() 4232** will return "SELECT 2345,NULL".)^ 4233** 4234** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory 4235** is available to hold the result, or if the result would exceed the 4236** the maximum string length determined by the [SQLITE_LIMIT_LENGTH]. 4237** 4238** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of 4239** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time 4240** option causes sqlite3_expanded_sql() to always return NULL. 4241** 4242** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P) 4243** are managed by SQLite and are automatically freed when the prepared 4244** statement is finalized. 4245** ^The string returned by sqlite3_expanded_sql(P), on the other hand, 4246** is obtained from [sqlite3_malloc()] and must be freed by the application 4247** by passing it to [sqlite3_free()]. 4248** 4249** ^The sqlite3_normalized_sql() interface is only available if 4250** the [SQLITE_ENABLE_NORMALIZE] compile-time option is defined. 4251*/ 4252const char *sqlite3_sql(sqlite3_stmt *pStmt); 4253char *sqlite3_expanded_sql(sqlite3_stmt *pStmt); 4254#ifdef SQLITE_ENABLE_NORMALIZE 4255const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt); 4256#endif 4257 4258/* 4259** CAPI3REF: Determine If An SQL Statement Writes The Database 4260** METHOD: sqlite3_stmt 4261** 4262** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if 4263** and only if the [prepared statement] X makes no direct changes to 4264** the content of the database file. 4265** 4266** Note that [application-defined SQL functions] or 4267** [virtual tables] might change the database indirectly as a side effect. 4268** ^(For example, if an application defines a function "eval()" that 4269** calls [sqlite3_exec()], then the following SQL statement would 4270** change the database file through side-effects: 4271** 4272** <blockquote><pre> 4273** SELECT eval('DELETE FROM t1') FROM t2; 4274** </pre></blockquote> 4275** 4276** But because the [SELECT] statement does not change the database file 4277** directly, sqlite3_stmt_readonly() would still return true.)^ 4278** 4279** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], 4280** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, 4281** since the statements themselves do not actually modify the database but 4282** rather they control the timing of when other statements modify the 4283** database. ^The [ATTACH] and [DETACH] statements also cause 4284** sqlite3_stmt_readonly() to return true since, while those statements 4285** change the configuration of a database connection, they do not make 4286** changes to the content of the database files on disk. 4287** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since 4288** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and 4289** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so 4290** sqlite3_stmt_readonly() returns false for those commands. 4291** 4292** ^This routine returns false if there is any possibility that the 4293** statement might change the database file. ^A false return does 4294** not guarantee that the statement will change the database file. 4295** ^For example, an UPDATE statement might have a WHERE clause that 4296** makes it a no-op, but the sqlite3_stmt_readonly() result would still 4297** be false. ^Similarly, a CREATE TABLE IF NOT EXISTS statement is a 4298** read-only no-op if the table already exists, but 4299** sqlite3_stmt_readonly() still returns false for such a statement. 4300** 4301** ^If prepared statement X is an [EXPLAIN] or [EXPLAIN QUERY PLAN] 4302** statement, then sqlite3_stmt_readonly(X) returns the same value as 4303** if the EXPLAIN or EXPLAIN QUERY PLAN prefix were omitted. 4304*/ 4305int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); 4306 4307/* 4308** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement 4309** METHOD: sqlite3_stmt 4310** 4311** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the 4312** prepared statement S is an EXPLAIN statement, or 2 if the 4313** statement S is an EXPLAIN QUERY PLAN. 4314** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is 4315** an ordinary statement or a NULL pointer. 4316*/ 4317int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt); 4318 4319/* 4320** CAPI3REF: Determine If A Prepared Statement Has Been Reset 4321** METHOD: sqlite3_stmt 4322** 4323** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the 4324** [prepared statement] S has been stepped at least once using 4325** [sqlite3_step(S)] but has neither run to completion (returned 4326** [SQLITE_DONE] from [sqlite3_step(S)]) nor 4327** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) 4328** interface returns false if S is a NULL pointer. If S is not a 4329** NULL pointer and is not a pointer to a valid [prepared statement] 4330** object, then the behavior is undefined and probably undesirable. 4331** 4332** This interface can be used in combination [sqlite3_next_stmt()] 4333** to locate all prepared statements associated with a database 4334** connection that are in need of being reset. This can be used, 4335** for example, in diagnostic routines to search for prepared 4336** statements that are holding a transaction open. 4337*/ 4338int sqlite3_stmt_busy(sqlite3_stmt*); 4339 4340/* 4341** CAPI3REF: Dynamically Typed Value Object 4342** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 4343** 4344** SQLite uses the sqlite3_value object to represent all values 4345** that can be stored in a database table. SQLite uses dynamic typing 4346** for the values it stores. ^Values stored in sqlite3_value objects 4347** can be integers, floating point values, strings, BLOBs, or NULL. 4348** 4349** An sqlite3_value object may be either "protected" or "unprotected". 4350** Some interfaces require a protected sqlite3_value. Other interfaces 4351** will accept either a protected or an unprotected sqlite3_value. 4352** Every interface that accepts sqlite3_value arguments specifies 4353** whether or not it requires a protected sqlite3_value. The 4354** [sqlite3_value_dup()] interface can be used to construct a new 4355** protected sqlite3_value from an unprotected sqlite3_value. 4356** 4357** The terms "protected" and "unprotected" refer to whether or not 4358** a mutex is held. An internal mutex is held for a protected 4359** sqlite3_value object but no mutex is held for an unprotected 4360** sqlite3_value object. If SQLite is compiled to be single-threaded 4361** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 4362** or if SQLite is run in one of reduced mutex modes 4363** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 4364** then there is no distinction between protected and unprotected 4365** sqlite3_value objects and they can be used interchangeably. However, 4366** for maximum code portability it is recommended that applications 4367** still make the distinction between protected and unprotected 4368** sqlite3_value objects even when not strictly required. 4369** 4370** ^The sqlite3_value objects that are passed as parameters into the 4371** implementation of [application-defined SQL functions] are protected. 4372** ^The sqlite3_value objects returned by [sqlite3_vtab_rhs_value()] 4373** are protected. 4374** ^The sqlite3_value object returned by 4375** [sqlite3_column_value()] is unprotected. 4376** Unprotected sqlite3_value objects may only be used as arguments 4377** to [sqlite3_result_value()], [sqlite3_bind_value()], and 4378** [sqlite3_value_dup()]. 4379** The [sqlite3_value_blob | sqlite3_value_type()] family of 4380** interfaces require protected sqlite3_value objects. 4381*/ 4382typedef struct sqlite3_value sqlite3_value; 4383 4384/* 4385** CAPI3REF: SQL Function Context Object 4386** 4387** The context in which an SQL function executes is stored in an 4388** sqlite3_context object. ^A pointer to an sqlite3_context object 4389** is always first parameter to [application-defined SQL functions]. 4390** The application-defined SQL function implementation will pass this 4391** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 4392** [sqlite3_aggregate_context()], [sqlite3_user_data()], 4393** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 4394** and/or [sqlite3_set_auxdata()]. 4395*/ 4396typedef struct sqlite3_context sqlite3_context; 4397 4398/* 4399** CAPI3REF: Binding Values To Prepared Statements 4400** KEYWORDS: {host parameter} {host parameters} {host parameter name} 4401** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 4402** METHOD: sqlite3_stmt 4403** 4404** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, 4405** literals may be replaced by a [parameter] that matches one of following 4406** templates: 4407** 4408** <ul> 4409** <li> ? 4410** <li> ?NNN 4411** <li> :VVV 4412** <li> @VVV 4413** <li> $VVV 4414** </ul> 4415** 4416** In the templates above, NNN represents an integer literal, 4417** and VVV represents an alphanumeric identifier.)^ ^The values of these 4418** parameters (also called "host parameter names" or "SQL parameters") 4419** can be set using the sqlite3_bind_*() routines defined here. 4420** 4421** ^The first argument to the sqlite3_bind_*() routines is always 4422** a pointer to the [sqlite3_stmt] object returned from 4423** [sqlite3_prepare_v2()] or its variants. 4424** 4425** ^The second argument is the index of the SQL parameter to be set. 4426** ^The leftmost SQL parameter has an index of 1. ^When the same named 4427** SQL parameter is used more than once, second and subsequent 4428** occurrences have the same index as the first occurrence. 4429** ^The index for named parameters can be looked up using the 4430** [sqlite3_bind_parameter_index()] API if desired. ^The index 4431** for "?NNN" parameters is the value of NNN. 4432** ^The NNN value must be between 1 and the [sqlite3_limit()] 4433** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 32766). 4434** 4435** ^The third argument is the value to bind to the parameter. 4436** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16() 4437** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter 4438** is ignored and the end result is the same as sqlite3_bind_null(). 4439** ^If the third parameter to sqlite3_bind_text() is not NULL, then 4440** it should be a pointer to well-formed UTF8 text. 4441** ^If the third parameter to sqlite3_bind_text16() is not NULL, then 4442** it should be a pointer to well-formed UTF16 text. 4443** ^If the third parameter to sqlite3_bind_text64() is not NULL, then 4444** it should be a pointer to a well-formed unicode string that is 4445** either UTF8 if the sixth parameter is SQLITE_UTF8, or UTF16 4446** otherwise. 4447** 4448** [[byte-order determination rules]] ^The byte-order of 4449** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF) 4450** found in first character, which is removed, or in the absence of a BOM 4451** the byte order is the native byte order of the host 4452** machine for sqlite3_bind_text16() or the byte order specified in 4453** the 6th parameter for sqlite3_bind_text64().)^ 4454** ^If UTF16 input text contains invalid unicode 4455** characters, then SQLite might change those invalid characters 4456** into the unicode replacement character: U+FFFD. 4457** 4458** ^(In those routines that have a fourth argument, its value is the 4459** number of bytes in the parameter. To be clear: the value is the 4460** number of <u>bytes</u> in the value, not the number of characters.)^ 4461** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16() 4462** is negative, then the length of the string is 4463** the number of bytes up to the first zero terminator. 4464** If the fourth parameter to sqlite3_bind_blob() is negative, then 4465** the behavior is undefined. 4466** If a non-negative fourth parameter is provided to sqlite3_bind_text() 4467** or sqlite3_bind_text16() or sqlite3_bind_text64() then 4468** that parameter must be the byte offset 4469** where the NUL terminator would occur assuming the string were NUL 4470** terminated. If any NUL characters occurs at byte offsets less than 4471** the value of the fourth parameter then the resulting string value will 4472** contain embedded NULs. The result of expressions involving strings 4473** with embedded NULs is undefined. 4474** 4475** ^The fifth argument to the BLOB and string binding interfaces controls 4476** or indicates the lifetime of the object referenced by the third parameter. 4477** These three options exist: 4478** ^ (1) A destructor to dispose of the BLOB or string after SQLite has finished 4479** with it may be passed. ^It is called to dispose of the BLOB or string even 4480** if the call to the bind API fails, except the destructor is not called if 4481** the third parameter is a NULL pointer or the fourth parameter is negative. 4482** ^ (2) The special constant, [SQLITE_STATIC], may be passsed to indicate that 4483** the application remains responsible for disposing of the object. ^In this 4484** case, the object and the provided pointer to it must remain valid until 4485** either the prepared statement is finalized or the same SQL parameter is 4486** bound to something else, whichever occurs sooner. 4487** ^ (3) The constant, [SQLITE_TRANSIENT], may be passed to indicate that the 4488** object is to be copied prior to the return from sqlite3_bind_*(). ^The 4489** object and pointer to it must remain valid until then. ^SQLite will then 4490** manage the lifetime of its private copy. 4491** 4492** ^The sixth argument to sqlite3_bind_text64() must be one of 4493** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE] 4494** to specify the encoding of the text in the third parameter. If 4495** the sixth argument to sqlite3_bind_text64() is not one of the 4496** allowed values shown above, or if the text encoding is different 4497** from the encoding specified by the sixth parameter, then the behavior 4498** is undefined. 4499** 4500** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 4501** is filled with zeroes. ^A zeroblob uses a fixed amount of memory 4502** (just an integer to hold its size) while it is being processed. 4503** Zeroblobs are intended to serve as placeholders for BLOBs whose 4504** content is later written using 4505** [sqlite3_blob_open | incremental BLOB I/O] routines. 4506** ^A negative value for the zeroblob results in a zero-length BLOB. 4507** 4508** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in 4509** [prepared statement] S to have an SQL value of NULL, but to also be 4510** associated with the pointer P of type T. ^D is either a NULL pointer or 4511** a pointer to a destructor function for P. ^SQLite will invoke the 4512** destructor D with a single argument of P when it is finished using 4513** P. The T parameter should be a static string, preferably a string 4514** literal. The sqlite3_bind_pointer() routine is part of the 4515** [pointer passing interface] added for SQLite 3.20.0. 4516** 4517** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer 4518** for the [prepared statement] or with a prepared statement for which 4519** [sqlite3_step()] has been called more recently than [sqlite3_reset()], 4520** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() 4521** routine is passed a [prepared statement] that has been finalized, the 4522** result is undefined and probably harmful. 4523** 4524** ^Bindings are not cleared by the [sqlite3_reset()] routine. 4525** ^Unbound parameters are interpreted as NULL. 4526** 4527** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an 4528** [error code] if anything goes wrong. 4529** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB 4530** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or 4531** [SQLITE_MAX_LENGTH]. 4532** ^[SQLITE_RANGE] is returned if the parameter 4533** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. 4534** 4535** See also: [sqlite3_bind_parameter_count()], 4536** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 4537*/ 4538int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 4539int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64, 4540 void(*)(void*)); 4541int sqlite3_bind_double(sqlite3_stmt*, int, double); 4542int sqlite3_bind_int(sqlite3_stmt*, int, int); 4543int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 4544int sqlite3_bind_null(sqlite3_stmt*, int); 4545int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*)); 4546int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 4547int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64, 4548 void(*)(void*), unsigned char encoding); 4549int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 4550int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*)); 4551int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 4552int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64); 4553 4554/* 4555** CAPI3REF: Number Of SQL Parameters 4556** METHOD: sqlite3_stmt 4557** 4558** ^This routine can be used to find the number of [SQL parameters] 4559** in a [prepared statement]. SQL parameters are tokens of the 4560** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 4561** placeholders for values that are [sqlite3_bind_blob | bound] 4562** to the parameters at a later time. 4563** 4564** ^(This routine actually returns the index of the largest (rightmost) 4565** parameter. For all forms except ?NNN, this will correspond to the 4566** number of unique parameters. If parameters of the ?NNN form are used, 4567** there may be gaps in the list.)^ 4568** 4569** See also: [sqlite3_bind_blob|sqlite3_bind()], 4570** [sqlite3_bind_parameter_name()], and 4571** [sqlite3_bind_parameter_index()]. 4572*/ 4573int sqlite3_bind_parameter_count(sqlite3_stmt*); 4574 4575/* 4576** CAPI3REF: Name Of A Host Parameter 4577** METHOD: sqlite3_stmt 4578** 4579** ^The sqlite3_bind_parameter_name(P,N) interface returns 4580** the name of the N-th [SQL parameter] in the [prepared statement] P. 4581** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 4582** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 4583** respectively. 4584** In other words, the initial ":" or "$" or "@" or "?" 4585** is included as part of the name.)^ 4586** ^Parameters of the form "?" without a following integer have no name 4587** and are referred to as "nameless" or "anonymous parameters". 4588** 4589** ^The first host parameter has an index of 1, not 0. 4590** 4591** ^If the value N is out of range or if the N-th parameter is 4592** nameless, then NULL is returned. ^The returned string is 4593** always in UTF-8 encoding even if the named parameter was 4594** originally specified as UTF-16 in [sqlite3_prepare16()], 4595** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()]. 4596** 4597** See also: [sqlite3_bind_blob|sqlite3_bind()], 4598** [sqlite3_bind_parameter_count()], and 4599** [sqlite3_bind_parameter_index()]. 4600*/ 4601const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); 4602 4603/* 4604** CAPI3REF: Index Of A Parameter With A Given Name 4605** METHOD: sqlite3_stmt 4606** 4607** ^Return the index of an SQL parameter given its name. ^The 4608** index value returned is suitable for use as the second 4609** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero 4610** is returned if no matching parameter is found. ^The parameter 4611** name must be given in UTF-8 even if the original statement 4612** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or 4613** [sqlite3_prepare16_v3()]. 4614** 4615** See also: [sqlite3_bind_blob|sqlite3_bind()], 4616** [sqlite3_bind_parameter_count()], and 4617** [sqlite3_bind_parameter_name()]. 4618*/ 4619int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 4620 4621/* 4622** CAPI3REF: Reset All Bindings On A Prepared Statement 4623** METHOD: sqlite3_stmt 4624** 4625** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset 4626** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 4627** ^Use this routine to reset all host parameters to NULL. 4628*/ 4629int sqlite3_clear_bindings(sqlite3_stmt*); 4630 4631/* 4632** CAPI3REF: Number Of Columns In A Result Set 4633** METHOD: sqlite3_stmt 4634** 4635** ^Return the number of columns in the result set returned by the 4636** [prepared statement]. ^If this routine returns 0, that means the 4637** [prepared statement] returns no data (for example an [UPDATE]). 4638** ^However, just because this routine returns a positive number does not 4639** mean that one or more rows of data will be returned. ^A SELECT statement 4640** will always have a positive sqlite3_column_count() but depending on the 4641** WHERE clause constraints and the table content, it might return no rows. 4642** 4643** See also: [sqlite3_data_count()] 4644*/ 4645int sqlite3_column_count(sqlite3_stmt *pStmt); 4646 4647/* 4648** CAPI3REF: Column Names In A Result Set 4649** METHOD: sqlite3_stmt 4650** 4651** ^These routines return the name assigned to a particular column 4652** in the result set of a [SELECT] statement. ^The sqlite3_column_name() 4653** interface returns a pointer to a zero-terminated UTF-8 string 4654** and sqlite3_column_name16() returns a pointer to a zero-terminated 4655** UTF-16 string. ^The first parameter is the [prepared statement] 4656** that implements the [SELECT] statement. ^The second parameter is the 4657** column number. ^The leftmost column is number 0. 4658** 4659** ^The returned string pointer is valid until either the [prepared statement] 4660** is destroyed by [sqlite3_finalize()] or until the statement is automatically 4661** reprepared by the first call to [sqlite3_step()] for a particular run 4662** or until the next call to 4663** sqlite3_column_name() or sqlite3_column_name16() on the same column. 4664** 4665** ^If sqlite3_malloc() fails during the processing of either routine 4666** (for example during a conversion from UTF-8 to UTF-16) then a 4667** NULL pointer is returned. 4668** 4669** ^The name of a result column is the value of the "AS" clause for 4670** that column, if there is an AS clause. If there is no AS clause 4671** then the name of the column is unspecified and may change from 4672** one release of SQLite to the next. 4673*/ 4674const char *sqlite3_column_name(sqlite3_stmt*, int N); 4675const void *sqlite3_column_name16(sqlite3_stmt*, int N); 4676 4677/* 4678** CAPI3REF: Source Of Data In A Query Result 4679** METHOD: sqlite3_stmt 4680** 4681** ^These routines provide a means to determine the database, table, and 4682** table column that is the origin of a particular result column in 4683** [SELECT] statement. 4684** ^The name of the database or table or column can be returned as 4685** either a UTF-8 or UTF-16 string. ^The _database_ routines return 4686** the database name, the _table_ routines return the table name, and 4687** the origin_ routines return the column name. 4688** ^The returned string is valid until the [prepared statement] is destroyed 4689** using [sqlite3_finalize()] or until the statement is automatically 4690** reprepared by the first call to [sqlite3_step()] for a particular run 4691** or until the same information is requested 4692** again in a different encoding. 4693** 4694** ^The names returned are the original un-aliased names of the 4695** database, table, and column. 4696** 4697** ^The first argument to these interfaces is a [prepared statement]. 4698** ^These functions return information about the Nth result column returned by 4699** the statement, where N is the second function argument. 4700** ^The left-most column is column 0 for these routines. 4701** 4702** ^If the Nth column returned by the statement is an expression or 4703** subquery and is not a column value, then all of these functions return 4704** NULL. ^These routines might also return NULL if a memory allocation error 4705** occurs. ^Otherwise, they return the name of the attached database, table, 4706** or column that query result column was extracted from. 4707** 4708** ^As with all other SQLite APIs, those whose names end with "16" return 4709** UTF-16 encoded strings and the other functions return UTF-8. 4710** 4711** ^These APIs are only available if the library was compiled with the 4712** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. 4713** 4714** If two or more threads call one or more 4715** [sqlite3_column_database_name | column metadata interfaces] 4716** for the same [prepared statement] and result column 4717** at the same time then the results are undefined. 4718*/ 4719const char *sqlite3_column_database_name(sqlite3_stmt*,int); 4720const void *sqlite3_column_database_name16(sqlite3_stmt*,int); 4721const char *sqlite3_column_table_name(sqlite3_stmt*,int); 4722const void *sqlite3_column_table_name16(sqlite3_stmt*,int); 4723const char *sqlite3_column_origin_name(sqlite3_stmt*,int); 4724const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); 4725 4726/* 4727** CAPI3REF: Declared Datatype Of A Query Result 4728** METHOD: sqlite3_stmt 4729** 4730** ^(The first parameter is a [prepared statement]. 4731** If this statement is a [SELECT] statement and the Nth column of the 4732** returned result set of that [SELECT] is a table column (not an 4733** expression or subquery) then the declared type of the table 4734** column is returned.)^ ^If the Nth column of the result set is an 4735** expression or subquery, then a NULL pointer is returned. 4736** ^The returned string is always UTF-8 encoded. 4737** 4738** ^(For example, given the database schema: 4739** 4740** CREATE TABLE t1(c1 VARIANT); 4741** 4742** and the following statement to be compiled: 4743** 4744** SELECT c1 + 1, c1 FROM t1; 4745** 4746** this routine would return the string "VARIANT" for the second result 4747** column (i==1), and a NULL pointer for the first result column (i==0).)^ 4748** 4749** ^SQLite uses dynamic run-time typing. ^So just because a column 4750** is declared to contain a particular type does not mean that the 4751** data stored in that column is of the declared type. SQLite is 4752** strongly typed, but the typing is dynamic not static. ^Type 4753** is associated with individual values, not with the containers 4754** used to hold those values. 4755*/ 4756const char *sqlite3_column_decltype(sqlite3_stmt*,int); 4757const void *sqlite3_column_decltype16(sqlite3_stmt*,int); 4758 4759/* 4760** CAPI3REF: Evaluate An SQL Statement 4761** METHOD: sqlite3_stmt 4762** 4763** After a [prepared statement] has been prepared using any of 4764** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()], 4765** or [sqlite3_prepare16_v3()] or one of the legacy 4766** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 4767** must be called one or more times to evaluate the statement. 4768** 4769** The details of the behavior of the sqlite3_step() interface depend 4770** on whether the statement was prepared using the newer "vX" interfaces 4771** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()], 4772** [sqlite3_prepare16_v2()] or the older legacy 4773** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 4774** new "vX" interface is recommended for new applications but the legacy 4775** interface will continue to be supported. 4776** 4777** ^In the legacy interface, the return value will be either [SQLITE_BUSY], 4778** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 4779** ^With the "v2" interface, any of the other [result codes] or 4780** [extended result codes] might be returned as well. 4781** 4782** ^[SQLITE_BUSY] means that the database engine was unable to acquire the 4783** database locks it needs to do its job. ^If the statement is a [COMMIT] 4784** or occurs outside of an explicit transaction, then you can retry the 4785** statement. If the statement is not a [COMMIT] and occurs within an 4786** explicit transaction then you should rollback the transaction before 4787** continuing. 4788** 4789** ^[SQLITE_DONE] means that the statement has finished executing 4790** successfully. sqlite3_step() should not be called again on this virtual 4791** machine without first calling [sqlite3_reset()] to reset the virtual 4792** machine back to its initial state. 4793** 4794** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] 4795** is returned each time a new row of data is ready for processing by the 4796** caller. The values may be accessed using the [column access functions]. 4797** sqlite3_step() is called again to retrieve the next row of data. 4798** 4799** ^[SQLITE_ERROR] means that a run-time error (such as a constraint 4800** violation) has occurred. sqlite3_step() should not be called again on 4801** the VM. More information may be found by calling [sqlite3_errmsg()]. 4802** ^With the legacy interface, a more specific error code (for example, 4803** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 4804** can be obtained by calling [sqlite3_reset()] on the 4805** [prepared statement]. ^In the "v2" interface, 4806** the more specific error code is returned directly by sqlite3_step(). 4807** 4808** [SQLITE_MISUSE] means that the this routine was called inappropriately. 4809** Perhaps it was called on a [prepared statement] that has 4810** already been [sqlite3_finalize | finalized] or on one that had 4811** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 4812** be the case that the same database connection is being used by two or 4813** more threads at the same moment in time. 4814** 4815** For all versions of SQLite up to and including 3.6.23.1, a call to 4816** [sqlite3_reset()] was required after sqlite3_step() returned anything 4817** other than [SQLITE_ROW] before any subsequent invocation of 4818** sqlite3_step(). Failure to reset the prepared statement using 4819** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from 4820** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1], 4821** sqlite3_step() began 4822** calling [sqlite3_reset()] automatically in this circumstance rather 4823** than returning [SQLITE_MISUSE]. This is not considered a compatibility 4824** break because any application that ever receives an SQLITE_MISUSE error 4825** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option 4826** can be used to restore the legacy behavior. 4827** 4828** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 4829** API always returns a generic error code, [SQLITE_ERROR], following any 4830** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 4831** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 4832** specific [error codes] that better describes the error. 4833** We admit that this is a goofy design. The problem has been fixed 4834** with the "v2" interface. If you prepare all of your SQL statements 4835** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()] 4836** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead 4837** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 4838** then the more specific [error codes] are returned directly 4839** by sqlite3_step(). The use of the "vX" interfaces is recommended. 4840*/ 4841int sqlite3_step(sqlite3_stmt*); 4842 4843/* 4844** CAPI3REF: Number of columns in a result set 4845** METHOD: sqlite3_stmt 4846** 4847** ^The sqlite3_data_count(P) interface returns the number of columns in the 4848** current row of the result set of [prepared statement] P. 4849** ^If prepared statement P does not have results ready to return 4850** (via calls to the [sqlite3_column_int | sqlite3_column()] family of 4851** interfaces) then sqlite3_data_count(P) returns 0. 4852** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. 4853** ^The sqlite3_data_count(P) routine returns 0 if the previous call to 4854** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P) 4855** will return non-zero if previous call to [sqlite3_step](P) returned 4856** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] 4857** where it always returns zero since each step of that multi-step 4858** pragma returns 0 columns of data. 4859** 4860** See also: [sqlite3_column_count()] 4861*/ 4862int sqlite3_data_count(sqlite3_stmt *pStmt); 4863 4864/* 4865** CAPI3REF: Fundamental Datatypes 4866** KEYWORDS: SQLITE_TEXT 4867** 4868** ^(Every value in SQLite has one of five fundamental datatypes: 4869** 4870** <ul> 4871** <li> 64-bit signed integer 4872** <li> 64-bit IEEE floating point number 4873** <li> string 4874** <li> BLOB 4875** <li> NULL 4876** </ul>)^ 4877** 4878** These constants are codes for each of those types. 4879** 4880** Note that the SQLITE_TEXT constant was also used in SQLite version 2 4881** for a completely different meaning. Software that links against both 4882** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 4883** SQLITE_TEXT. 4884*/ 4885#define SQLITE_INTEGER 1 4886#define SQLITE_FLOAT 2 4887#define SQLITE_BLOB 4 4888#define SQLITE_NULL 5 4889#ifdef SQLITE_TEXT 4890# undef SQLITE_TEXT 4891#else 4892# define SQLITE_TEXT 3 4893#endif 4894#define SQLITE3_TEXT 3 4895 4896/* 4897** CAPI3REF: Result Values From A Query 4898** KEYWORDS: {column access functions} 4899** METHOD: sqlite3_stmt 4900** 4901** <b>Summary:</b> 4902** <blockquote><table border=0 cellpadding=0 cellspacing=0> 4903** <tr><td><b>sqlite3_column_blob</b><td>→<td>BLOB result 4904** <tr><td><b>sqlite3_column_double</b><td>→<td>REAL result 4905** <tr><td><b>sqlite3_column_int</b><td>→<td>32-bit INTEGER result 4906** <tr><td><b>sqlite3_column_int64</b><td>→<td>64-bit INTEGER result 4907** <tr><td><b>sqlite3_column_text</b><td>→<td>UTF-8 TEXT result 4908** <tr><td><b>sqlite3_column_text16</b><td>→<td>UTF-16 TEXT result 4909** <tr><td><b>sqlite3_column_value</b><td>→<td>The result as an 4910** [sqlite3_value|unprotected sqlite3_value] object. 4911** <tr><td> <td> <td> 4912** <tr><td><b>sqlite3_column_bytes</b><td>→<td>Size of a BLOB 4913** or a UTF-8 TEXT result in bytes 4914** <tr><td><b>sqlite3_column_bytes16 </b> 4915** <td>→ <td>Size of UTF-16 4916** TEXT in bytes 4917** <tr><td><b>sqlite3_column_type</b><td>→<td>Default 4918** datatype of the result 4919** </table></blockquote> 4920** 4921** <b>Details:</b> 4922** 4923** ^These routines return information about a single column of the current 4924** result row of a query. ^In every case the first argument is a pointer 4925** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 4926** that was returned from [sqlite3_prepare_v2()] or one of its variants) 4927** and the second argument is the index of the column for which information 4928** should be returned. ^The leftmost column of the result set has the index 0. 4929** ^The number of columns in the result can be determined using 4930** [sqlite3_column_count()]. 4931** 4932** If the SQL statement does not currently point to a valid row, or if the 4933** column index is out of range, the result is undefined. 4934** These routines may only be called when the most recent call to 4935** [sqlite3_step()] has returned [SQLITE_ROW] and neither 4936** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 4937** If any of these routines are called after [sqlite3_reset()] or 4938** [sqlite3_finalize()] or after [sqlite3_step()] has returned 4939** something other than [SQLITE_ROW], the results are undefined. 4940** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 4941** are called from a different thread while any of these routines 4942** are pending, then the results are undefined. 4943** 4944** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16) 4945** each return the value of a result column in a specific data format. If 4946** the result column is not initially in the requested format (for example, 4947** if the query returns an integer but the sqlite3_column_text() interface 4948** is used to extract the value) then an automatic type conversion is performed. 4949** 4950** ^The sqlite3_column_type() routine returns the 4951** [SQLITE_INTEGER | datatype code] for the initial data type 4952** of the result column. ^The returned value is one of [SQLITE_INTEGER], 4953** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. 4954** The return value of sqlite3_column_type() can be used to decide which 4955** of the first six interface should be used to extract the column value. 4956** The value returned by sqlite3_column_type() is only meaningful if no 4957** automatic type conversions have occurred for the value in question. 4958** After a type conversion, the result of calling sqlite3_column_type() 4959** is undefined, though harmless. Future 4960** versions of SQLite may change the behavior of sqlite3_column_type() 4961** following a type conversion. 4962** 4963** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes() 4964** or sqlite3_column_bytes16() interfaces can be used to determine the size 4965** of that BLOB or string. 4966** 4967** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 4968** routine returns the number of bytes in that BLOB or string. 4969** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts 4970** the string to UTF-8 and then returns the number of bytes. 4971** ^If the result is a numeric value then sqlite3_column_bytes() uses 4972** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 4973** the number of bytes in that string. 4974** ^If the result is NULL, then sqlite3_column_bytes() returns zero. 4975** 4976** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() 4977** routine returns the number of bytes in that BLOB or string. 4978** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts 4979** the string to UTF-16 and then returns the number of bytes. 4980** ^If the result is a numeric value then sqlite3_column_bytes16() uses 4981** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns 4982** the number of bytes in that string. 4983** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. 4984** 4985** ^The values returned by [sqlite3_column_bytes()] and 4986** [sqlite3_column_bytes16()] do not include the zero terminators at the end 4987** of the string. ^For clarity: the values returned by 4988** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of 4989** bytes in the string, not the number of characters. 4990** 4991** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 4992** even empty strings, are always zero-terminated. ^The return 4993** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. 4994** 4995** ^Strings returned by sqlite3_column_text16() always have the endianness 4996** which is native to the platform, regardless of the text encoding set 4997** for the database. 4998** 4999** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an 5000** [unprotected sqlite3_value] object. In a multithreaded environment, 5001** an unprotected sqlite3_value object may only be used safely with 5002** [sqlite3_bind_value()] and [sqlite3_result_value()]. 5003** If the [unprotected sqlite3_value] object returned by 5004** [sqlite3_column_value()] is used in any other way, including calls 5005** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 5006** or [sqlite3_value_bytes()], the behavior is not threadsafe. 5007** Hence, the sqlite3_column_value() interface 5008** is normally only useful within the implementation of 5009** [application-defined SQL functions] or [virtual tables], not within 5010** top-level application code. 5011** 5012** These routines may attempt to convert the datatype of the result. 5013** ^For example, if the internal representation is FLOAT and a text result 5014** is requested, [sqlite3_snprintf()] is used internally to perform the 5015** conversion automatically. ^(The following table details the conversions 5016** that are applied: 5017** 5018** <blockquote> 5019** <table border="1"> 5020** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 5021** 5022** <tr><td> NULL <td> INTEGER <td> Result is 0 5023** <tr><td> NULL <td> FLOAT <td> Result is 0.0 5024** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer 5025** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer 5026** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 5027** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 5028** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 5029** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER 5030** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 5031** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB 5032** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER 5033** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL 5034** <tr><td> TEXT <td> BLOB <td> No change 5035** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER 5036** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL 5037** <tr><td> BLOB <td> TEXT <td> [CAST] to TEXT, ensure zero terminator 5038** </table> 5039** </blockquote>)^ 5040** 5041** Note that when type conversions occur, pointers returned by prior 5042** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 5043** sqlite3_column_text16() may be invalidated. 5044** Type conversions and pointer invalidations might occur 5045** in the following cases: 5046** 5047** <ul> 5048** <li> The initial content is a BLOB and sqlite3_column_text() or 5049** sqlite3_column_text16() is called. A zero-terminator might 5050** need to be added to the string.</li> 5051** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 5052** sqlite3_column_text16() is called. The content must be converted 5053** to UTF-16.</li> 5054** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 5055** sqlite3_column_text() is called. The content must be converted 5056** to UTF-8.</li> 5057** </ul> 5058** 5059** ^Conversions between UTF-16be and UTF-16le are always done in place and do 5060** not invalidate a prior pointer, though of course the content of the buffer 5061** that the prior pointer references will have been modified. Other kinds 5062** of conversion are done in place when it is possible, but sometimes they 5063** are not possible and in those cases prior pointers are invalidated. 5064** 5065** The safest policy is to invoke these routines 5066** in one of the following ways: 5067** 5068** <ul> 5069** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 5070** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 5071** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 5072** </ul> 5073** 5074** In other words, you should call sqlite3_column_text(), 5075** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 5076** into the desired format, then invoke sqlite3_column_bytes() or 5077** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 5078** to sqlite3_column_text() or sqlite3_column_blob() with calls to 5079** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 5080** with calls to sqlite3_column_bytes(). 5081** 5082** ^The pointers returned are valid until a type conversion occurs as 5083** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 5084** [sqlite3_finalize()] is called. ^The memory space used to hold strings 5085** and BLOBs is freed automatically. Do not pass the pointers returned 5086** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 5087** [sqlite3_free()]. 5088** 5089** As long as the input parameters are correct, these routines will only 5090** fail if an out-of-memory error occurs during a format conversion. 5091** Only the following subset of interfaces are subject to out-of-memory 5092** errors: 5093** 5094** <ul> 5095** <li> sqlite3_column_blob() 5096** <li> sqlite3_column_text() 5097** <li> sqlite3_column_text16() 5098** <li> sqlite3_column_bytes() 5099** <li> sqlite3_column_bytes16() 5100** </ul> 5101** 5102** If an out-of-memory error occurs, then the return value from these 5103** routines is the same as if the column had contained an SQL NULL value. 5104** Valid SQL NULL returns can be distinguished from out-of-memory errors 5105** by invoking the [sqlite3_errcode()] immediately after the suspect 5106** return value is obtained and before any 5107** other SQLite interface is called on the same [database connection]. 5108*/ 5109const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 5110double sqlite3_column_double(sqlite3_stmt*, int iCol); 5111int sqlite3_column_int(sqlite3_stmt*, int iCol); 5112sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 5113const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 5114const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 5115sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 5116int sqlite3_column_bytes(sqlite3_stmt*, int iCol); 5117int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 5118int sqlite3_column_type(sqlite3_stmt*, int iCol); 5119 5120/* 5121** CAPI3REF: Destroy A Prepared Statement Object 5122** DESTRUCTOR: sqlite3_stmt 5123** 5124** ^The sqlite3_finalize() function is called to delete a [prepared statement]. 5125** ^If the most recent evaluation of the statement encountered no errors 5126** or if the statement is never been evaluated, then sqlite3_finalize() returns 5127** SQLITE_OK. ^If the most recent evaluation of statement S failed, then 5128** sqlite3_finalize(S) returns the appropriate [error code] or 5129** [extended error code]. 5130** 5131** ^The sqlite3_finalize(S) routine can be called at any point during 5132** the life cycle of [prepared statement] S: 5133** before statement S is ever evaluated, after 5134** one or more calls to [sqlite3_reset()], or after any call 5135** to [sqlite3_step()] regardless of whether or not the statement has 5136** completed execution. 5137** 5138** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. 5139** 5140** The application must finalize every [prepared statement] in order to avoid 5141** resource leaks. It is a grievous error for the application to try to use 5142** a prepared statement after it has been finalized. Any use of a prepared 5143** statement after it has been finalized can result in undefined and 5144** undesirable behavior such as segfaults and heap corruption. 5145*/ 5146int sqlite3_finalize(sqlite3_stmt *pStmt); 5147 5148/* 5149** CAPI3REF: Reset A Prepared Statement Object 5150** METHOD: sqlite3_stmt 5151** 5152** The sqlite3_reset() function is called to reset a [prepared statement] 5153** object back to its initial state, ready to be re-executed. 5154** ^Any SQL statement variables that had values bound to them using 5155** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 5156** Use [sqlite3_clear_bindings()] to reset the bindings. 5157** 5158** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S 5159** back to the beginning of its program. 5160** 5161** ^If the most recent call to [sqlite3_step(S)] for the 5162** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 5163** or if [sqlite3_step(S)] has never before been called on S, 5164** then [sqlite3_reset(S)] returns [SQLITE_OK]. 5165** 5166** ^If the most recent call to [sqlite3_step(S)] for the 5167** [prepared statement] S indicated an error, then 5168** [sqlite3_reset(S)] returns an appropriate [error code]. 5169** 5170** ^The [sqlite3_reset(S)] interface does not change the values 5171** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 5172*/ 5173int sqlite3_reset(sqlite3_stmt *pStmt); 5174 5175/* 5176** CAPI3REF: Create Or Redefine SQL Functions 5177** KEYWORDS: {function creation routines} 5178** METHOD: sqlite3 5179** 5180** ^These functions (collectively known as "function creation routines") 5181** are used to add SQL functions or aggregates or to redefine the behavior 5182** of existing SQL functions or aggregates. The only differences between 5183** the three "sqlite3_create_function*" routines are the text encoding 5184** expected for the second parameter (the name of the function being 5185** created) and the presence or absence of a destructor callback for 5186** the application data pointer. Function sqlite3_create_window_function() 5187** is similar, but allows the user to supply the extra callback functions 5188** needed by [aggregate window functions]. 5189** 5190** ^The first parameter is the [database connection] to which the SQL 5191** function is to be added. ^If an application uses more than one database 5192** connection then application-defined SQL functions must be added 5193** to each database connection separately. 5194** 5195** ^The second parameter is the name of the SQL function to be created or 5196** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 5197** representation, exclusive of the zero-terminator. ^Note that the name 5198** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. 5199** ^Any attempt to create a function with a longer name 5200** will result in [SQLITE_MISUSE] being returned. 5201** 5202** ^The third parameter (nArg) 5203** is the number of arguments that the SQL function or 5204** aggregate takes. ^If this parameter is -1, then the SQL function or 5205** aggregate may take any number of arguments between 0 and the limit 5206** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third 5207** parameter is less than -1 or greater than 127 then the behavior is 5208** undefined. 5209** 5210** ^The fourth parameter, eTextRep, specifies what 5211** [SQLITE_UTF8 | text encoding] this SQL function prefers for 5212** its parameters. The application should set this parameter to 5213** [SQLITE_UTF16LE] if the function implementation invokes 5214** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the 5215** implementation invokes [sqlite3_value_text16be()] on an input, or 5216** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8] 5217** otherwise. ^The same SQL function may be registered multiple times using 5218** different preferred text encodings, with different implementations for 5219** each encoding. 5220** ^When multiple implementations of the same function are available, SQLite 5221** will pick the one that involves the least amount of data conversion. 5222** 5223** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC] 5224** to signal that the function will always return the same result given 5225** the same inputs within a single SQL statement. Most SQL functions are 5226** deterministic. The built-in [random()] SQL function is an example of a 5227** function that is not deterministic. The SQLite query planner is able to 5228** perform additional optimizations on deterministic functions, so use 5229** of the [SQLITE_DETERMINISTIC] flag is recommended where possible. 5230** 5231** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY] 5232** flag, which if present prevents the function from being invoked from 5233** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions, 5234** index expressions, or the WHERE clause of partial indexes. 5235** 5236** For best security, the [SQLITE_DIRECTONLY] flag is recommended for 5237** all application-defined SQL functions that do not need to be 5238** used inside of triggers, view, CHECK constraints, or other elements of 5239** the database schema. This flags is especially recommended for SQL 5240** functions that have side effects or reveal internal application state. 5241** Without this flag, an attacker might be able to modify the schema of 5242** a database file to include invocations of the function with parameters 5243** chosen by the attacker, which the application will then execute when 5244** the database file is opened and read. 5245** 5246** ^(The fifth parameter is an arbitrary pointer. The implementation of the 5247** function can gain access to this pointer using [sqlite3_user_data()].)^ 5248** 5249** ^The sixth, seventh and eighth parameters passed to the three 5250** "sqlite3_create_function*" functions, xFunc, xStep and xFinal, are 5251** pointers to C-language functions that implement the SQL function or 5252** aggregate. ^A scalar SQL function requires an implementation of the xFunc 5253** callback only; NULL pointers must be passed as the xStep and xFinal 5254** parameters. ^An aggregate SQL function requires an implementation of xStep 5255** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing 5256** SQL function or aggregate, pass NULL pointers for all three function 5257** callbacks. 5258** 5259** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue 5260** and xInverse) passed to sqlite3_create_window_function are pointers to 5261** C-language callbacks that implement the new function. xStep and xFinal 5262** must both be non-NULL. xValue and xInverse may either both be NULL, in 5263** which case a regular aggregate function is created, or must both be 5264** non-NULL, in which case the new function may be used as either an aggregate 5265** or aggregate window function. More details regarding the implementation 5266** of aggregate window functions are 5267** [user-defined window functions|available here]. 5268** 5269** ^(If the final parameter to sqlite3_create_function_v2() or 5270** sqlite3_create_window_function() is not NULL, then it is destructor for 5271** the application data pointer. The destructor is invoked when the function 5272** is deleted, either by being overloaded or when the database connection 5273** closes.)^ ^The destructor is also invoked if the call to 5274** sqlite3_create_function_v2() fails. ^When the destructor callback is 5275** invoked, it is passed a single argument which is a copy of the application 5276** data pointer which was the fifth parameter to sqlite3_create_function_v2(). 5277** 5278** ^It is permitted to register multiple implementations of the same 5279** functions with the same name but with either differing numbers of 5280** arguments or differing preferred text encodings. ^SQLite will use 5281** the implementation that most closely matches the way in which the 5282** SQL function is used. ^A function implementation with a non-negative 5283** nArg parameter is a better match than a function implementation with 5284** a negative nArg. ^A function where the preferred text encoding 5285** matches the database encoding is a better 5286** match than a function where the encoding is different. 5287** ^A function where the encoding difference is between UTF16le and UTF16be 5288** is a closer match than a function where the encoding difference is 5289** between UTF8 and UTF16. 5290** 5291** ^Built-in functions may be overloaded by new application-defined functions. 5292** 5293** ^An application-defined function is permitted to call other 5294** SQLite interfaces. However, such calls must not 5295** close the database connection nor finalize or reset the prepared 5296** statement in which the function is running. 5297*/ 5298int sqlite3_create_function( 5299 sqlite3 *db, 5300 const char *zFunctionName, 5301 int nArg, 5302 int eTextRep, 5303 void *pApp, 5304 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 5305 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 5306 void (*xFinal)(sqlite3_context*) 5307); 5308int sqlite3_create_function16( 5309 sqlite3 *db, 5310 const void *zFunctionName, 5311 int nArg, 5312 int eTextRep, 5313 void *pApp, 5314 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 5315 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 5316 void (*xFinal)(sqlite3_context*) 5317); 5318int sqlite3_create_function_v2( 5319 sqlite3 *db, 5320 const char *zFunctionName, 5321 int nArg, 5322 int eTextRep, 5323 void *pApp, 5324 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 5325 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 5326 void (*xFinal)(sqlite3_context*), 5327 void(*xDestroy)(void*) 5328); 5329int sqlite3_create_window_function( 5330 sqlite3 *db, 5331 const char *zFunctionName, 5332 int nArg, 5333 int eTextRep, 5334 void *pApp, 5335 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 5336 void (*xFinal)(sqlite3_context*), 5337 void (*xValue)(sqlite3_context*), 5338 void (*xInverse)(sqlite3_context*,int,sqlite3_value**), 5339 void(*xDestroy)(void*) 5340); 5341 5342/* 5343** CAPI3REF: Text Encodings 5344** 5345** These constant define integer codes that represent the various 5346** text encodings supported by SQLite. 5347*/ 5348#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */ 5349#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */ 5350#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */ 5351#define SQLITE_UTF16 4 /* Use native byte order */ 5352#define SQLITE_ANY 5 /* Deprecated */ 5353#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 5354 5355/* 5356** CAPI3REF: Function Flags 5357** 5358** These constants may be ORed together with the 5359** [SQLITE_UTF8 | preferred text encoding] as the fourth argument 5360** to [sqlite3_create_function()], [sqlite3_create_function16()], or 5361** [sqlite3_create_function_v2()]. 5362** 5363** <dl> 5364** [[SQLITE_DETERMINISTIC]] <dt>SQLITE_DETERMINISTIC</dt><dd> 5365** The SQLITE_DETERMINISTIC flag means that the new function always gives 5366** the same output when the input parameters are the same. 5367** The [abs|abs() function] is deterministic, for example, but 5368** [randomblob|randomblob()] is not. Functions must 5369** be deterministic in order to be used in certain contexts such as 5370** with the WHERE clause of [partial indexes] or in [generated columns]. 5371** SQLite might also optimize deterministic functions by factoring them 5372** out of inner loops. 5373** </dd> 5374** 5375** [[SQLITE_DIRECTONLY]] <dt>SQLITE_DIRECTONLY</dt><dd> 5376** The SQLITE_DIRECTONLY flag means that the function may only be invoked 5377** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in 5378** schema structures such as [CHECK constraints], [DEFAULT clauses], 5379** [expression indexes], [partial indexes], or [generated columns]. 5380** The SQLITE_DIRECTONLY flags is a security feature which is recommended 5381** for all [application-defined SQL functions], and especially for functions 5382** that have side-effects or that could potentially leak sensitive 5383** information. 5384** </dd> 5385** 5386** [[SQLITE_INNOCUOUS]] <dt>SQLITE_INNOCUOUS</dt><dd> 5387** The SQLITE_INNOCUOUS flag means that the function is unlikely 5388** to cause problems even if misused. An innocuous function should have 5389** no side effects and should not depend on any values other than its 5390** input parameters. The [abs|abs() function] is an example of an 5391** innocuous function. 5392** The [load_extension() SQL function] is not innocuous because of its 5393** side effects. 5394** <p> SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not 5395** exactly the same. The [random|random() function] is an example of a 5396** function that is innocuous but not deterministic. 5397** <p>Some heightened security settings 5398** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF]) 5399** disable the use of SQL functions inside views and triggers and in 5400** schema structures such as [CHECK constraints], [DEFAULT clauses], 5401** [expression indexes], [partial indexes], and [generated columns] unless 5402** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions 5403** are innocuous. Developers are advised to avoid using the 5404** SQLITE_INNOCUOUS flag for application-defined functions unless the 5405** function has been carefully audited and found to be free of potentially 5406** security-adverse side-effects and information-leaks. 5407** </dd> 5408** 5409** [[SQLITE_SUBTYPE]] <dt>SQLITE_SUBTYPE</dt><dd> 5410** The SQLITE_SUBTYPE flag indicates to SQLite that a function may call 5411** [sqlite3_value_subtype()] to inspect the sub-types of its arguments. 5412** Specifying this flag makes no difference for scalar or aggregate user 5413** functions. However, if it is not specified for a user-defined window 5414** function, then any sub-types belonging to arguments passed to the window 5415** function may be discarded before the window function is called (i.e. 5416** sqlite3_value_subtype() will always return 0). 5417** </dd> 5418** </dl> 5419*/ 5420#define SQLITE_DETERMINISTIC 0x000000800 5421#define SQLITE_DIRECTONLY 0x000080000 5422#define SQLITE_SUBTYPE 0x000100000 5423#define SQLITE_INNOCUOUS 0x000200000 5424 5425/* 5426** CAPI3REF: Deprecated Functions 5427** DEPRECATED 5428** 5429** These functions are [deprecated]. In order to maintain 5430** backwards compatibility with older code, these functions continue 5431** to be supported. However, new applications should avoid 5432** the use of these functions. To encourage programmers to avoid 5433** these functions, we will not explain what they do. 5434*/ 5435#ifndef SQLITE_OMIT_DEPRECATED 5436SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 5437SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 5438SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 5439SQLITE_DEPRECATED int sqlite3_global_recover(void); 5440SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 5441SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int), 5442 void*,sqlite3_int64); 5443#endif 5444 5445/* 5446** CAPI3REF: Obtaining SQL Values 5447** METHOD: sqlite3_value 5448** 5449** <b>Summary:</b> 5450** <blockquote><table border=0 cellpadding=0 cellspacing=0> 5451** <tr><td><b>sqlite3_value_blob</b><td>→<td>BLOB value 5452** <tr><td><b>sqlite3_value_double</b><td>→<td>REAL value 5453** <tr><td><b>sqlite3_value_int</b><td>→<td>32-bit INTEGER value 5454** <tr><td><b>sqlite3_value_int64</b><td>→<td>64-bit INTEGER value 5455** <tr><td><b>sqlite3_value_pointer</b><td>→<td>Pointer value 5456** <tr><td><b>sqlite3_value_text</b><td>→<td>UTF-8 TEXT value 5457** <tr><td><b>sqlite3_value_text16</b><td>→<td>UTF-16 TEXT value in 5458** the native byteorder 5459** <tr><td><b>sqlite3_value_text16be</b><td>→<td>UTF-16be TEXT value 5460** <tr><td><b>sqlite3_value_text16le</b><td>→<td>UTF-16le TEXT value 5461** <tr><td> <td> <td> 5462** <tr><td><b>sqlite3_value_bytes</b><td>→<td>Size of a BLOB 5463** or a UTF-8 TEXT in bytes 5464** <tr><td><b>sqlite3_value_bytes16 </b> 5465** <td>→ <td>Size of UTF-16 5466** TEXT in bytes 5467** <tr><td><b>sqlite3_value_type</b><td>→<td>Default 5468** datatype of the value 5469** <tr><td><b>sqlite3_value_numeric_type </b> 5470** <td>→ <td>Best numeric datatype of the value 5471** <tr><td><b>sqlite3_value_nochange </b> 5472** <td>→ <td>True if the column is unchanged in an UPDATE 5473** against a virtual table. 5474** <tr><td><b>sqlite3_value_frombind </b> 5475** <td>→ <td>True if value originated from a [bound parameter] 5476** </table></blockquote> 5477** 5478** <b>Details:</b> 5479** 5480** These routines extract type, size, and content information from 5481** [protected sqlite3_value] objects. Protected sqlite3_value objects 5482** are used to pass parameter information into the functions that 5483** implement [application-defined SQL functions] and [virtual tables]. 5484** 5485** These routines work only with [protected sqlite3_value] objects. 5486** Any attempt to use these routines on an [unprotected sqlite3_value] 5487** is not threadsafe. 5488** 5489** ^These routines work just like the corresponding [column access functions] 5490** except that these routines take a single [protected sqlite3_value] object 5491** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 5492** 5493** ^The sqlite3_value_text16() interface extracts a UTF-16 string 5494** in the native byte-order of the host machine. ^The 5495** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 5496** extract UTF-16 strings as big-endian and little-endian respectively. 5497** 5498** ^If [sqlite3_value] object V was initialized 5499** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)] 5500** and if X and Y are strings that compare equal according to strcmp(X,Y), 5501** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise, 5502** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer() 5503** routine is part of the [pointer passing interface] added for SQLite 3.20.0. 5504** 5505** ^(The sqlite3_value_type(V) interface returns the 5506** [SQLITE_INTEGER | datatype code] for the initial datatype of the 5507** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER], 5508** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^ 5509** Other interfaces might change the datatype for an sqlite3_value object. 5510** For example, if the datatype is initially SQLITE_INTEGER and 5511** sqlite3_value_text(V) is called to extract a text value for that 5512** integer, then subsequent calls to sqlite3_value_type(V) might return 5513** SQLITE_TEXT. Whether or not a persistent internal datatype conversion 5514** occurs is undefined and may change from one release of SQLite to the next. 5515** 5516** ^(The sqlite3_value_numeric_type() interface attempts to apply 5517** numeric affinity to the value. This means that an attempt is 5518** made to convert the value to an integer or floating point. If 5519** such a conversion is possible without loss of information (in other 5520** words, if the value is a string that looks like a number) 5521** then the conversion is performed. Otherwise no conversion occurs. 5522** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ 5523** 5524** ^(The sqlite3_value_encoding(X) interface returns one of [SQLITE_UTF8], 5525** [SQLITE_UTF16BE], or [SQLITE_UTF16LE] according to the current encoding 5526** of the value X, assuming that X has type TEXT.)^ If sqlite3_value_type(X) 5527** returns something other than SQLITE_TEXT, then the return value from 5528** sqlite3_value_encoding(X) is meaningless. ^Calls to 5529** sqlite3_value_text(X), sqlite3_value_text16(X), sqlite3_value_text16be(X), 5530** sqlite3_value_text16le(X), sqlite3_value_bytes(X), or 5531** sqlite3_value_bytes16(X) might change the encoding of the value X and 5532** thus change the return from subsequent calls to sqlite3_value_encoding(X). 5533** 5534** ^Within the [xUpdate] method of a [virtual table], the 5535** sqlite3_value_nochange(X) interface returns true if and only if 5536** the column corresponding to X is unchanged by the UPDATE operation 5537** that the xUpdate method call was invoked to implement and if 5538** and the prior [xColumn] method call that was invoked to extracted 5539** the value for that column returned without setting a result (probably 5540** because it queried [sqlite3_vtab_nochange()] and found that the column 5541** was unchanging). ^Within an [xUpdate] method, any value for which 5542** sqlite3_value_nochange(X) is true will in all other respects appear 5543** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other 5544** than within an [xUpdate] method call for an UPDATE statement, then 5545** the return value is arbitrary and meaningless. 5546** 5547** ^The sqlite3_value_frombind(X) interface returns non-zero if the 5548** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()] 5549** interfaces. ^If X comes from an SQL literal value, or a table column, 5550** or an expression, then sqlite3_value_frombind(X) returns zero. 5551** 5552** Please pay particular attention to the fact that the pointer returned 5553** from [sqlite3_value_blob()], [sqlite3_value_text()], or 5554** [sqlite3_value_text16()] can be invalidated by a subsequent call to 5555** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 5556** or [sqlite3_value_text16()]. 5557** 5558** These routines must be called from the same thread as 5559** the SQL function that supplied the [sqlite3_value*] parameters. 5560** 5561** As long as the input parameter is correct, these routines can only 5562** fail if an out-of-memory error occurs during a format conversion. 5563** Only the following subset of interfaces are subject to out-of-memory 5564** errors: 5565** 5566** <ul> 5567** <li> sqlite3_value_blob() 5568** <li> sqlite3_value_text() 5569** <li> sqlite3_value_text16() 5570** <li> sqlite3_value_text16le() 5571** <li> sqlite3_value_text16be() 5572** <li> sqlite3_value_bytes() 5573** <li> sqlite3_value_bytes16() 5574** </ul> 5575** 5576** If an out-of-memory error occurs, then the return value from these 5577** routines is the same as if the column had contained an SQL NULL value. 5578** Valid SQL NULL returns can be distinguished from out-of-memory errors 5579** by invoking the [sqlite3_errcode()] immediately after the suspect 5580** return value is obtained and before any 5581** other SQLite interface is called on the same [database connection]. 5582*/ 5583const void *sqlite3_value_blob(sqlite3_value*); 5584double sqlite3_value_double(sqlite3_value*); 5585int sqlite3_value_int(sqlite3_value*); 5586sqlite3_int64 sqlite3_value_int64(sqlite3_value*); 5587void *sqlite3_value_pointer(sqlite3_value*, const char*); 5588const unsigned char *sqlite3_value_text(sqlite3_value*); 5589const void *sqlite3_value_text16(sqlite3_value*); 5590const void *sqlite3_value_text16le(sqlite3_value*); 5591const void *sqlite3_value_text16be(sqlite3_value*); 5592int sqlite3_value_bytes(sqlite3_value*); 5593int sqlite3_value_bytes16(sqlite3_value*); 5594int sqlite3_value_type(sqlite3_value*); 5595int sqlite3_value_numeric_type(sqlite3_value*); 5596int sqlite3_value_nochange(sqlite3_value*); 5597int sqlite3_value_frombind(sqlite3_value*); 5598int sqlite3_value_encoding(sqlite3_value*); 5599 5600/* 5601** CAPI3REF: Finding The Subtype Of SQL Values 5602** METHOD: sqlite3_value 5603** 5604** The sqlite3_value_subtype(V) function returns the subtype for 5605** an [application-defined SQL function] argument V. The subtype 5606** information can be used to pass a limited amount of context from 5607** one SQL function to another. Use the [sqlite3_result_subtype()] 5608** routine to set the subtype for the return value of an SQL function. 5609*/ 5610unsigned int sqlite3_value_subtype(sqlite3_value*); 5611 5612/* 5613** CAPI3REF: Copy And Free SQL Values 5614** METHOD: sqlite3_value 5615** 5616** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value] 5617** object D and returns a pointer to that copy. ^The [sqlite3_value] returned 5618** is a [protected sqlite3_value] object even if the input is not. 5619** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a 5620** memory allocation fails. ^If V is a [pointer value], then the result 5621** of sqlite3_value_dup(V) is a NULL value. 5622** 5623** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object 5624** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer 5625** then sqlite3_value_free(V) is a harmless no-op. 5626*/ 5627sqlite3_value *sqlite3_value_dup(const sqlite3_value*); 5628void sqlite3_value_free(sqlite3_value*); 5629 5630/* 5631** CAPI3REF: Obtain Aggregate Function Context 5632** METHOD: sqlite3_context 5633** 5634** Implementations of aggregate SQL functions use this 5635** routine to allocate memory for storing their state. 5636** 5637** ^The first time the sqlite3_aggregate_context(C,N) routine is called 5638** for a particular aggregate function, SQLite allocates 5639** N bytes of memory, zeroes out that memory, and returns a pointer 5640** to the new memory. ^On second and subsequent calls to 5641** sqlite3_aggregate_context() for the same aggregate function instance, 5642** the same buffer is returned. Sqlite3_aggregate_context() is normally 5643** called once for each invocation of the xStep callback and then one 5644** last time when the xFinal callback is invoked. ^(When no rows match 5645** an aggregate query, the xStep() callback of the aggregate function 5646** implementation is never called and xFinal() is called exactly once. 5647** In those cases, sqlite3_aggregate_context() might be called for the 5648** first time from within xFinal().)^ 5649** 5650** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer 5651** when first called if N is less than or equal to zero or if a memory 5652** allocation error occurs. 5653** 5654** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is 5655** determined by the N parameter on first successful call. Changing the 5656** value of N in any subsequent call to sqlite3_aggregate_context() within 5657** the same aggregate function instance will not resize the memory 5658** allocation.)^ Within the xFinal callback, it is customary to set 5659** N=0 in calls to sqlite3_aggregate_context(C,N) so that no 5660** pointless memory allocations occur. 5661** 5662** ^SQLite automatically frees the memory allocated by 5663** sqlite3_aggregate_context() when the aggregate query concludes. 5664** 5665** The first parameter must be a copy of the 5666** [sqlite3_context | SQL function context] that is the first parameter 5667** to the xStep or xFinal callback routine that implements the aggregate 5668** function. 5669** 5670** This routine must be called from the same thread in which 5671** the aggregate SQL function is running. 5672*/ 5673void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); 5674 5675/* 5676** CAPI3REF: User Data For Functions 5677** METHOD: sqlite3_context 5678** 5679** ^The sqlite3_user_data() interface returns a copy of 5680** the pointer that was the pUserData parameter (the 5th parameter) 5681** of the [sqlite3_create_function()] 5682** and [sqlite3_create_function16()] routines that originally 5683** registered the application defined function. 5684** 5685** This routine must be called from the same thread in which 5686** the application-defined function is running. 5687*/ 5688void *sqlite3_user_data(sqlite3_context*); 5689 5690/* 5691** CAPI3REF: Database Connection For Functions 5692** METHOD: sqlite3_context 5693** 5694** ^The sqlite3_context_db_handle() interface returns a copy of 5695** the pointer to the [database connection] (the 1st parameter) 5696** of the [sqlite3_create_function()] 5697** and [sqlite3_create_function16()] routines that originally 5698** registered the application defined function. 5699*/ 5700sqlite3 *sqlite3_context_db_handle(sqlite3_context*); 5701 5702/* 5703** CAPI3REF: Function Auxiliary Data 5704** METHOD: sqlite3_context 5705** 5706** These functions may be used by (non-aggregate) SQL functions to 5707** associate metadata with argument values. If the same value is passed to 5708** multiple invocations of the same SQL function during query execution, under 5709** some circumstances the associated metadata may be preserved. An example 5710** of where this might be useful is in a regular-expression matching 5711** function. The compiled version of the regular expression can be stored as 5712** metadata associated with the pattern string. 5713** Then as long as the pattern string remains the same, 5714** the compiled regular expression can be reused on multiple 5715** invocations of the same function. 5716** 5717** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the metadata 5718** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument 5719** value to the application-defined function. ^N is zero for the left-most 5720** function argument. ^If there is no metadata 5721** associated with the function argument, the sqlite3_get_auxdata(C,N) interface 5722** returns a NULL pointer. 5723** 5724** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th 5725** argument of the application-defined function. ^Subsequent 5726** calls to sqlite3_get_auxdata(C,N) return P from the most recent 5727** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or 5728** NULL if the metadata has been discarded. 5729** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL, 5730** SQLite will invoke the destructor function X with parameter P exactly 5731** once, when the metadata is discarded. 5732** SQLite is free to discard the metadata at any time, including: <ul> 5733** <li> ^(when the corresponding function parameter changes)^, or 5734** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the 5735** SQL statement)^, or 5736** <li> ^(when sqlite3_set_auxdata() is invoked again on the same 5737** parameter)^, or 5738** <li> ^(during the original sqlite3_set_auxdata() call when a memory 5739** allocation error occurs.)^ </ul> 5740** 5741** Note the last bullet in particular. The destructor X in 5742** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the 5743** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata() 5744** should be called near the end of the function implementation and the 5745** function implementation should not make any use of P after 5746** sqlite3_set_auxdata() has been called. 5747** 5748** ^(In practice, metadata is preserved between function calls for 5749** function parameters that are compile-time constants, including literal 5750** values and [parameters] and expressions composed from the same.)^ 5751** 5752** The value of the N parameter to these interfaces should be non-negative. 5753** Future enhancements may make use of negative N values to define new 5754** kinds of function caching behavior. 5755** 5756** These routines must be called from the same thread in which 5757** the SQL function is running. 5758*/ 5759void *sqlite3_get_auxdata(sqlite3_context*, int N); 5760void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 5761 5762 5763/* 5764** CAPI3REF: Constants Defining Special Destructor Behavior 5765** 5766** These are special values for the destructor that is passed in as the 5767** final argument to routines like [sqlite3_result_blob()]. ^If the destructor 5768** argument is SQLITE_STATIC, it means that the content pointer is constant 5769** and will never change. It does not need to be destroyed. ^The 5770** SQLITE_TRANSIENT value means that the content will likely change in 5771** the near future and that SQLite should make its own private copy of 5772** the content before returning. 5773** 5774** The typedef is necessary to work around problems in certain 5775** C++ compilers. 5776*/ 5777typedef void (*sqlite3_destructor_type)(void*); 5778#define SQLITE_STATIC ((sqlite3_destructor_type)0) 5779#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 5780 5781/* 5782** CAPI3REF: Setting The Result Of An SQL Function 5783** METHOD: sqlite3_context 5784** 5785** These routines are used by the xFunc or xFinal callbacks that 5786** implement SQL functions and aggregates. See 5787** [sqlite3_create_function()] and [sqlite3_create_function16()] 5788** for additional information. 5789** 5790** These functions work very much like the [parameter binding] family of 5791** functions used to bind values to host parameters in prepared statements. 5792** Refer to the [SQL parameter] documentation for additional information. 5793** 5794** ^The sqlite3_result_blob() interface sets the result from 5795** an application-defined function to be the BLOB whose content is pointed 5796** to by the second parameter and which is N bytes long where N is the 5797** third parameter. 5798** 5799** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N) 5800** interfaces set the result of the application-defined function to be 5801** a BLOB containing all zero bytes and N bytes in size. 5802** 5803** ^The sqlite3_result_double() interface sets the result from 5804** an application-defined function to be a floating point value specified 5805** by its 2nd argument. 5806** 5807** ^The sqlite3_result_error() and sqlite3_result_error16() functions 5808** cause the implemented SQL function to throw an exception. 5809** ^SQLite uses the string pointed to by the 5810** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 5811** as the text of an error message. ^SQLite interprets the error 5812** message string from sqlite3_result_error() as UTF-8. ^SQLite 5813** interprets the string from sqlite3_result_error16() as UTF-16 using 5814** the same [byte-order determination rules] as [sqlite3_bind_text16()]. 5815** ^If the third parameter to sqlite3_result_error() 5816** or sqlite3_result_error16() is negative then SQLite takes as the error 5817** message all text up through the first zero character. 5818** ^If the third parameter to sqlite3_result_error() or 5819** sqlite3_result_error16() is non-negative then SQLite takes that many 5820** bytes (not characters) from the 2nd parameter as the error message. 5821** ^The sqlite3_result_error() and sqlite3_result_error16() 5822** routines make a private copy of the error message text before 5823** they return. Hence, the calling function can deallocate or 5824** modify the text after they return without harm. 5825** ^The sqlite3_result_error_code() function changes the error code 5826** returned by SQLite as a result of an error in a function. ^By default, 5827** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() 5828** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 5829** 5830** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an 5831** error indicating that a string or BLOB is too long to represent. 5832** 5833** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an 5834** error indicating that a memory allocation failed. 5835** 5836** ^The sqlite3_result_int() interface sets the return value 5837** of the application-defined function to be the 32-bit signed integer 5838** value given in the 2nd argument. 5839** ^The sqlite3_result_int64() interface sets the return value 5840** of the application-defined function to be the 64-bit signed integer 5841** value given in the 2nd argument. 5842** 5843** ^The sqlite3_result_null() interface sets the return value 5844** of the application-defined function to be NULL. 5845** 5846** ^The sqlite3_result_text(), sqlite3_result_text16(), 5847** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 5848** set the return value of the application-defined function to be 5849** a text string which is represented as UTF-8, UTF-16 native byte order, 5850** UTF-16 little endian, or UTF-16 big endian, respectively. 5851** ^The sqlite3_result_text64() interface sets the return value of an 5852** application-defined function to be a text string in an encoding 5853** specified by the fifth (and last) parameter, which must be one 5854** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]. 5855** ^SQLite takes the text result from the application from 5856** the 2nd parameter of the sqlite3_result_text* interfaces. 5857** ^If the 3rd parameter to the sqlite3_result_text* interfaces 5858** is negative, then SQLite takes result text from the 2nd parameter 5859** through the first zero character. 5860** ^If the 3rd parameter to the sqlite3_result_text* interfaces 5861** is non-negative, then as many bytes (not characters) of the text 5862** pointed to by the 2nd parameter are taken as the application-defined 5863** function result. If the 3rd parameter is non-negative, then it 5864** must be the byte offset into the string where the NUL terminator would 5865** appear if the string where NUL terminated. If any NUL characters occur 5866** in the string at a byte offset that is less than the value of the 3rd 5867** parameter, then the resulting string will contain embedded NULs and the 5868** result of expressions operating on strings with embedded NULs is undefined. 5869** ^If the 4th parameter to the sqlite3_result_text* interfaces 5870** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 5871** function as the destructor on the text or BLOB result when it has 5872** finished using that result. 5873** ^If the 4th parameter to the sqlite3_result_text* interfaces or to 5874** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 5875** assumes that the text or BLOB result is in constant space and does not 5876** copy the content of the parameter nor call a destructor on the content 5877** when it has finished using that result. 5878** ^If the 4th parameter to the sqlite3_result_text* interfaces 5879** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 5880** then SQLite makes a copy of the result into space obtained 5881** from [sqlite3_malloc()] before it returns. 5882** 5883** ^For the sqlite3_result_text16(), sqlite3_result_text16le(), and 5884** sqlite3_result_text16be() routines, and for sqlite3_result_text64() 5885** when the encoding is not UTF8, if the input UTF16 begins with a 5886** byte-order mark (BOM, U+FEFF) then the BOM is removed from the 5887** string and the rest of the string is interpreted according to the 5888** byte-order specified by the BOM. ^The byte-order specified by 5889** the BOM at the beginning of the text overrides the byte-order 5890** specified by the interface procedure. ^So, for example, if 5891** sqlite3_result_text16le() is invoked with text that begins 5892** with bytes 0xfe, 0xff (a big-endian byte-order mark) then the 5893** first two bytes of input are skipped and the remaining input 5894** is interpreted as UTF16BE text. 5895** 5896** ^For UTF16 input text to the sqlite3_result_text16(), 5897** sqlite3_result_text16be(), sqlite3_result_text16le(), and 5898** sqlite3_result_text64() routines, if the text contains invalid 5899** UTF16 characters, the invalid characters might be converted 5900** into the unicode replacement character, U+FFFD. 5901** 5902** ^The sqlite3_result_value() interface sets the result of 5903** the application-defined function to be a copy of the 5904** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The 5905** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 5906** so that the [sqlite3_value] specified in the parameter may change or 5907** be deallocated after sqlite3_result_value() returns without harm. 5908** ^A [protected sqlite3_value] object may always be used where an 5909** [unprotected sqlite3_value] object is required, so either 5910** kind of [sqlite3_value] object can be used with this interface. 5911** 5912** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an 5913** SQL NULL value, just like [sqlite3_result_null(C)], except that it 5914** also associates the host-language pointer P or type T with that 5915** NULL value such that the pointer can be retrieved within an 5916** [application-defined SQL function] using [sqlite3_value_pointer()]. 5917** ^If the D parameter is not NULL, then it is a pointer to a destructor 5918** for the P parameter. ^SQLite invokes D with P as its only argument 5919** when SQLite is finished with P. The T parameter should be a static 5920** string and preferably a string literal. The sqlite3_result_pointer() 5921** routine is part of the [pointer passing interface] added for SQLite 3.20.0. 5922** 5923** If these routines are called from within the different thread 5924** than the one containing the application-defined function that received 5925** the [sqlite3_context] pointer, the results are undefined. 5926*/ 5927void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 5928void sqlite3_result_blob64(sqlite3_context*,const void*, 5929 sqlite3_uint64,void(*)(void*)); 5930void sqlite3_result_double(sqlite3_context*, double); 5931void sqlite3_result_error(sqlite3_context*, const char*, int); 5932void sqlite3_result_error16(sqlite3_context*, const void*, int); 5933void sqlite3_result_error_toobig(sqlite3_context*); 5934void sqlite3_result_error_nomem(sqlite3_context*); 5935void sqlite3_result_error_code(sqlite3_context*, int); 5936void sqlite3_result_int(sqlite3_context*, int); 5937void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 5938void sqlite3_result_null(sqlite3_context*); 5939void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 5940void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64, 5941 void(*)(void*), unsigned char encoding); 5942void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 5943void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 5944void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 5945void sqlite3_result_value(sqlite3_context*, sqlite3_value*); 5946void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*)); 5947void sqlite3_result_zeroblob(sqlite3_context*, int n); 5948int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n); 5949 5950 5951/* 5952** CAPI3REF: Setting The Subtype Of An SQL Function 5953** METHOD: sqlite3_context 5954** 5955** The sqlite3_result_subtype(C,T) function causes the subtype of 5956** the result from the [application-defined SQL function] with 5957** [sqlite3_context] C to be the value T. Only the lower 8 bits 5958** of the subtype T are preserved in current versions of SQLite; 5959** higher order bits are discarded. 5960** The number of subtype bytes preserved by SQLite might increase 5961** in future releases of SQLite. 5962*/ 5963void sqlite3_result_subtype(sqlite3_context*,unsigned int); 5964 5965/* 5966** CAPI3REF: Define New Collating Sequences 5967** METHOD: sqlite3 5968** 5969** ^These functions add, remove, or modify a [collation] associated 5970** with the [database connection] specified as the first argument. 5971** 5972** ^The name of the collation is a UTF-8 string 5973** for sqlite3_create_collation() and sqlite3_create_collation_v2() 5974** and a UTF-16 string in native byte order for sqlite3_create_collation16(). 5975** ^Collation names that compare equal according to [sqlite3_strnicmp()] are 5976** considered to be the same name. 5977** 5978** ^(The third argument (eTextRep) must be one of the constants: 5979** <ul> 5980** <li> [SQLITE_UTF8], 5981** <li> [SQLITE_UTF16LE], 5982** <li> [SQLITE_UTF16BE], 5983** <li> [SQLITE_UTF16], or 5984** <li> [SQLITE_UTF16_ALIGNED]. 5985** </ul>)^ 5986** ^The eTextRep argument determines the encoding of strings passed 5987** to the collating function callback, xCompare. 5988** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep 5989** force strings to be UTF16 with native byte order. 5990** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin 5991** on an even byte address. 5992** 5993** ^The fourth argument, pArg, is an application data pointer that is passed 5994** through as the first argument to the collating function callback. 5995** 5996** ^The fifth argument, xCompare, is a pointer to the collating function. 5997** ^Multiple collating functions can be registered using the same name but 5998** with different eTextRep parameters and SQLite will use whichever 5999** function requires the least amount of data transformation. 6000** ^If the xCompare argument is NULL then the collating function is 6001** deleted. ^When all collating functions having the same name are deleted, 6002** that collation is no longer usable. 6003** 6004** ^The collating function callback is invoked with a copy of the pArg 6005** application data pointer and with two strings in the encoding specified 6006** by the eTextRep argument. The two integer parameters to the collating 6007** function callback are the length of the two strings, in bytes. The collating 6008** function must return an integer that is negative, zero, or positive 6009** if the first string is less than, equal to, or greater than the second, 6010** respectively. A collating function must always return the same answer 6011** given the same inputs. If two or more collating functions are registered 6012** to the same collation name (using different eTextRep values) then all 6013** must give an equivalent answer when invoked with equivalent strings. 6014** The collating function must obey the following properties for all 6015** strings A, B, and C: 6016** 6017** <ol> 6018** <li> If A==B then B==A. 6019** <li> If A==B and B==C then A==C. 6020** <li> If A<B THEN B>A. 6021** <li> If A<B and B<C then A<C. 6022** </ol> 6023** 6024** If a collating function fails any of the above constraints and that 6025** collating function is registered and used, then the behavior of SQLite 6026** is undefined. 6027** 6028** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() 6029** with the addition that the xDestroy callback is invoked on pArg when 6030** the collating function is deleted. 6031** ^Collating functions are deleted when they are overridden by later 6032** calls to the collation creation functions or when the 6033** [database connection] is closed using [sqlite3_close()]. 6034** 6035** ^The xDestroy callback is <u>not</u> called if the 6036** sqlite3_create_collation_v2() function fails. Applications that invoke 6037** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should 6038** check the return code and dispose of the application data pointer 6039** themselves rather than expecting SQLite to deal with it for them. 6040** This is different from every other SQLite interface. The inconsistency 6041** is unfortunate but cannot be changed without breaking backwards 6042** compatibility. 6043** 6044** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. 6045*/ 6046int sqlite3_create_collation( 6047 sqlite3*, 6048 const char *zName, 6049 int eTextRep, 6050 void *pArg, 6051 int(*xCompare)(void*,int,const void*,int,const void*) 6052); 6053int sqlite3_create_collation_v2( 6054 sqlite3*, 6055 const char *zName, 6056 int eTextRep, 6057 void *pArg, 6058 int(*xCompare)(void*,int,const void*,int,const void*), 6059 void(*xDestroy)(void*) 6060); 6061int sqlite3_create_collation16( 6062 sqlite3*, 6063 const void *zName, 6064 int eTextRep, 6065 void *pArg, 6066 int(*xCompare)(void*,int,const void*,int,const void*) 6067); 6068 6069/* 6070** CAPI3REF: Collation Needed Callbacks 6071** METHOD: sqlite3 6072** 6073** ^To avoid having to register all collation sequences before a database 6074** can be used, a single callback function may be registered with the 6075** [database connection] to be invoked whenever an undefined collation 6076** sequence is required. 6077** 6078** ^If the function is registered using the sqlite3_collation_needed() API, 6079** then it is passed the names of undefined collation sequences as strings 6080** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, 6081** the names are passed as UTF-16 in machine native byte order. 6082** ^A call to either function replaces the existing collation-needed callback. 6083** 6084** ^(When the callback is invoked, the first argument passed is a copy 6085** of the second argument to sqlite3_collation_needed() or 6086** sqlite3_collation_needed16(). The second argument is the database 6087** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 6088** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 6089** sequence function required. The fourth parameter is the name of the 6090** required collation sequence.)^ 6091** 6092** The callback function should register the desired collation using 6093** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 6094** [sqlite3_create_collation_v2()]. 6095*/ 6096int sqlite3_collation_needed( 6097 sqlite3*, 6098 void*, 6099 void(*)(void*,sqlite3*,int eTextRep,const char*) 6100); 6101int sqlite3_collation_needed16( 6102 sqlite3*, 6103 void*, 6104 void(*)(void*,sqlite3*,int eTextRep,const void*) 6105); 6106 6107#ifdef SQLITE_ENABLE_CEROD 6108/* 6109** Specify the activation key for a CEROD database. Unless 6110** activated, none of the CEROD routines will work. 6111*/ 6112void sqlite3_activate_cerod( 6113 const char *zPassPhrase /* Activation phrase */ 6114); 6115#endif 6116 6117/* 6118** CAPI3REF: Suspend Execution For A Short Time 6119** 6120** The sqlite3_sleep() function causes the current thread to suspend execution 6121** for at least a number of milliseconds specified in its parameter. 6122** 6123** If the operating system does not support sleep requests with 6124** millisecond time resolution, then the time will be rounded up to 6125** the nearest second. The number of milliseconds of sleep actually 6126** requested from the operating system is returned. 6127** 6128** ^SQLite implements this interface by calling the xSleep() 6129** method of the default [sqlite3_vfs] object. If the xSleep() method 6130** of the default VFS is not implemented correctly, or not implemented at 6131** all, then the behavior of sqlite3_sleep() may deviate from the description 6132** in the previous paragraphs. 6133*/ 6134int sqlite3_sleep(int); 6135 6136/* 6137** CAPI3REF: Name Of The Folder Holding Temporary Files 6138** 6139** ^(If this global variable is made to point to a string which is 6140** the name of a folder (a.k.a. directory), then all temporary files 6141** created by SQLite when using a built-in [sqlite3_vfs | VFS] 6142** will be placed in that directory.)^ ^If this variable 6143** is a NULL pointer, then SQLite performs a search for an appropriate 6144** temporary file directory. 6145** 6146** Applications are strongly discouraged from using this global variable. 6147** It is required to set a temporary folder on Windows Runtime (WinRT). 6148** But for all other platforms, it is highly recommended that applications 6149** neither read nor write this variable. This global variable is a relic 6150** that exists for backwards compatibility of legacy applications and should 6151** be avoided in new projects. 6152** 6153** It is not safe to read or modify this variable in more than one 6154** thread at a time. It is not safe to read or modify this variable 6155** if a [database connection] is being used at the same time in a separate 6156** thread. 6157** It is intended that this variable be set once 6158** as part of process initialization and before any SQLite interface 6159** routines have been called and that this variable remain unchanged 6160** thereafter. 6161** 6162** ^The [temp_store_directory pragma] may modify this variable and cause 6163** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 6164** the [temp_store_directory pragma] always assumes that any string 6165** that this variable points to is held in memory obtained from 6166** [sqlite3_malloc] and the pragma may attempt to free that memory 6167** using [sqlite3_free]. 6168** Hence, if this variable is modified directly, either it should be 6169** made NULL or made to point to memory obtained from [sqlite3_malloc] 6170** or else the use of the [temp_store_directory pragma] should be avoided. 6171** Except when requested by the [temp_store_directory pragma], SQLite 6172** does not free the memory that sqlite3_temp_directory points to. If 6173** the application wants that memory to be freed, it must do 6174** so itself, taking care to only do so after all [database connection] 6175** objects have been destroyed. 6176** 6177** <b>Note to Windows Runtime users:</b> The temporary directory must be set 6178** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various 6179** features that require the use of temporary files may fail. Here is an 6180** example of how to do this using C++ with the Windows Runtime: 6181** 6182** <blockquote><pre> 6183** LPCWSTR zPath = Windows::Storage::ApplicationData::Current-> 6184** TemporaryFolder->Path->Data(); 6185** char zPathBuf[MAX_PATH + 1]; 6186** memset(zPathBuf, 0, sizeof(zPathBuf)); 6187** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf), 6188** NULL, NULL); 6189** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf); 6190** </pre></blockquote> 6191*/ 6192SQLITE_EXTERN char *sqlite3_temp_directory; 6193 6194/* 6195** CAPI3REF: Name Of The Folder Holding Database Files 6196** 6197** ^(If this global variable is made to point to a string which is 6198** the name of a folder (a.k.a. directory), then all database files 6199** specified with a relative pathname and created or accessed by 6200** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed 6201** to be relative to that directory.)^ ^If this variable is a NULL 6202** pointer, then SQLite assumes that all database files specified 6203** with a relative pathname are relative to the current directory 6204** for the process. Only the windows VFS makes use of this global 6205** variable; it is ignored by the unix VFS. 6206** 6207** Changing the value of this variable while a database connection is 6208** open can result in a corrupt database. 6209** 6210** It is not safe to read or modify this variable in more than one 6211** thread at a time. It is not safe to read or modify this variable 6212** if a [database connection] is being used at the same time in a separate 6213** thread. 6214** It is intended that this variable be set once 6215** as part of process initialization and before any SQLite interface 6216** routines have been called and that this variable remain unchanged 6217** thereafter. 6218** 6219** ^The [data_store_directory pragma] may modify this variable and cause 6220** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 6221** the [data_store_directory pragma] always assumes that any string 6222** that this variable points to is held in memory obtained from 6223** [sqlite3_malloc] and the pragma may attempt to free that memory 6224** using [sqlite3_free]. 6225** Hence, if this variable is modified directly, either it should be 6226** made NULL or made to point to memory obtained from [sqlite3_malloc] 6227** or else the use of the [data_store_directory pragma] should be avoided. 6228*/ 6229SQLITE_EXTERN char *sqlite3_data_directory; 6230 6231/* 6232** CAPI3REF: Win32 Specific Interface 6233** 6234** These interfaces are available only on Windows. The 6235** [sqlite3_win32_set_directory] interface is used to set the value associated 6236** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to 6237** zValue, depending on the value of the type parameter. The zValue parameter 6238** should be NULL to cause the previous value to be freed via [sqlite3_free]; 6239** a non-NULL value will be copied into memory obtained from [sqlite3_malloc] 6240** prior to being used. The [sqlite3_win32_set_directory] interface returns 6241** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported, 6242** or [SQLITE_NOMEM] if memory could not be allocated. The value of the 6243** [sqlite3_data_directory] variable is intended to act as a replacement for 6244** the current directory on the sub-platforms of Win32 where that concept is 6245** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and 6246** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the 6247** sqlite3_win32_set_directory interface except the string parameter must be 6248** UTF-8 or UTF-16, respectively. 6249*/ 6250int sqlite3_win32_set_directory( 6251 unsigned long type, /* Identifier for directory being set or reset */ 6252 void *zValue /* New value for directory being set or reset */ 6253); 6254int sqlite3_win32_set_directory8(unsigned long type, const char *zValue); 6255int sqlite3_win32_set_directory16(unsigned long type, const void *zValue); 6256 6257/* 6258** CAPI3REF: Win32 Directory Types 6259** 6260** These macros are only available on Windows. They define the allowed values 6261** for the type argument to the [sqlite3_win32_set_directory] interface. 6262*/ 6263#define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1 6264#define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2 6265 6266/* 6267** CAPI3REF: Test For Auto-Commit Mode 6268** KEYWORDS: {autocommit mode} 6269** METHOD: sqlite3 6270** 6271** ^The sqlite3_get_autocommit() interface returns non-zero or 6272** zero if the given database connection is or is not in autocommit mode, 6273** respectively. ^Autocommit mode is on by default. 6274** ^Autocommit mode is disabled by a [BEGIN] statement. 6275** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 6276** 6277** If certain kinds of errors occur on a statement within a multi-statement 6278** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 6279** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 6280** transaction might be rolled back automatically. The only way to 6281** find out whether SQLite automatically rolled back the transaction after 6282** an error is to use this function. 6283** 6284** If another thread changes the autocommit status of the database 6285** connection while this routine is running, then the return value 6286** is undefined. 6287*/ 6288int sqlite3_get_autocommit(sqlite3*); 6289 6290/* 6291** CAPI3REF: Find The Database Handle Of A Prepared Statement 6292** METHOD: sqlite3_stmt 6293** 6294** ^The sqlite3_db_handle interface returns the [database connection] handle 6295** to which a [prepared statement] belongs. ^The [database connection] 6296** returned by sqlite3_db_handle is the same [database connection] 6297** that was the first argument 6298** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 6299** create the statement in the first place. 6300*/ 6301sqlite3 *sqlite3_db_handle(sqlite3_stmt*); 6302 6303/* 6304** CAPI3REF: Return The Schema Name For A Database Connection 6305** METHOD: sqlite3 6306** 6307** ^The sqlite3_db_name(D,N) interface returns a pointer to the schema name 6308** for the N-th database on database connection D, or a NULL pointer of N is 6309** out of range. An N value of 0 means the main database file. An N of 1 is 6310** the "temp" schema. Larger values of N correspond to various ATTACH-ed 6311** databases. 6312** 6313** Space to hold the string that is returned by sqlite3_db_name() is managed 6314** by SQLite itself. The string might be deallocated by any operation that 6315** changes the schema, including [ATTACH] or [DETACH] or calls to 6316** [sqlite3_serialize()] or [sqlite3_deserialize()], even operations that 6317** occur on a different thread. Applications that need to 6318** remember the string long-term should make their own copy. Applications that 6319** are accessing the same database connection simultaneously on multiple 6320** threads should mutex-protect calls to this API and should make their own 6321** private copy of the result prior to releasing the mutex. 6322*/ 6323const char *sqlite3_db_name(sqlite3 *db, int N); 6324 6325/* 6326** CAPI3REF: Return The Filename For A Database Connection 6327** METHOD: sqlite3 6328** 6329** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename 6330** associated with database N of connection D. 6331** ^If there is no attached database N on the database 6332** connection D, or if database N is a temporary or in-memory database, then 6333** this function will return either a NULL pointer or an empty string. 6334** 6335** ^The string value returned by this routine is owned and managed by 6336** the database connection. ^The value will be valid until the database N 6337** is [DETACH]-ed or until the database connection closes. 6338** 6339** ^The filename returned by this function is the output of the 6340** xFullPathname method of the [VFS]. ^In other words, the filename 6341** will be an absolute pathname, even if the filename used 6342** to open the database originally was a URI or relative pathname. 6343** 6344** If the filename pointer returned by this routine is not NULL, then it 6345** can be used as the filename input parameter to these routines: 6346** <ul> 6347** <li> [sqlite3_uri_parameter()] 6348** <li> [sqlite3_uri_boolean()] 6349** <li> [sqlite3_uri_int64()] 6350** <li> [sqlite3_filename_database()] 6351** <li> [sqlite3_filename_journal()] 6352** <li> [sqlite3_filename_wal()] 6353** </ul> 6354*/ 6355const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); 6356 6357/* 6358** CAPI3REF: Determine if a database is read-only 6359** METHOD: sqlite3 6360** 6361** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N 6362** of connection D is read-only, 0 if it is read/write, or -1 if N is not 6363** the name of a database on connection D. 6364*/ 6365int sqlite3_db_readonly(sqlite3 *db, const char *zDbName); 6366 6367/* 6368** CAPI3REF: Determine the transaction state of a database 6369** METHOD: sqlite3 6370** 6371** ^The sqlite3_txn_state(D,S) interface returns the current 6372** [transaction state] of schema S in database connection D. ^If S is NULL, 6373** then the highest transaction state of any schema on database connection D 6374** is returned. Transaction states are (in order of lowest to highest): 6375** <ol> 6376** <li value="0"> SQLITE_TXN_NONE 6377** <li value="1"> SQLITE_TXN_READ 6378** <li value="2"> SQLITE_TXN_WRITE 6379** </ol> 6380** ^If the S argument to sqlite3_txn_state(D,S) is not the name of 6381** a valid schema, then -1 is returned. 6382*/ 6383int sqlite3_txn_state(sqlite3*,const char *zSchema); 6384 6385/* 6386** CAPI3REF: Allowed return values from [sqlite3_txn_state()] 6387** KEYWORDS: {transaction state} 6388** 6389** These constants define the current transaction state of a database file. 6390** ^The [sqlite3_txn_state(D,S)] interface returns one of these 6391** constants in order to describe the transaction state of schema S 6392** in [database connection] D. 6393** 6394** <dl> 6395** [[SQLITE_TXN_NONE]] <dt>SQLITE_TXN_NONE</dt> 6396** <dd>The SQLITE_TXN_NONE state means that no transaction is currently 6397** pending.</dd> 6398** 6399** [[SQLITE_TXN_READ]] <dt>SQLITE_TXN_READ</dt> 6400** <dd>The SQLITE_TXN_READ state means that the database is currently 6401** in a read transaction. Content has been read from the database file 6402** but nothing in the database file has changed. The transaction state 6403** will advanced to SQLITE_TXN_WRITE if any changes occur and there are 6404** no other conflicting concurrent write transactions. The transaction 6405** state will revert to SQLITE_TXN_NONE following a [ROLLBACK] or 6406** [COMMIT].</dd> 6407** 6408** [[SQLITE_TXN_WRITE]] <dt>SQLITE_TXN_WRITE</dt> 6409** <dd>The SQLITE_TXN_WRITE state means that the database is currently 6410** in a write transaction. Content has been written to the database file 6411** but has not yet committed. The transaction state will change to 6412** to SQLITE_TXN_NONE at the next [ROLLBACK] or [COMMIT].</dd> 6413*/ 6414#define SQLITE_TXN_NONE 0 6415#define SQLITE_TXN_READ 1 6416#define SQLITE_TXN_WRITE 2 6417 6418/* 6419** CAPI3REF: Find the next prepared statement 6420** METHOD: sqlite3 6421** 6422** ^This interface returns a pointer to the next [prepared statement] after 6423** pStmt associated with the [database connection] pDb. ^If pStmt is NULL 6424** then this interface returns a pointer to the first prepared statement 6425** associated with the database connection pDb. ^If no prepared statement 6426** satisfies the conditions of this routine, it returns NULL. 6427** 6428** The [database connection] pointer D in a call to 6429** [sqlite3_next_stmt(D,S)] must refer to an open database 6430** connection and in particular must not be a NULL pointer. 6431*/ 6432sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 6433 6434/* 6435** CAPI3REF: Commit And Rollback Notification Callbacks 6436** METHOD: sqlite3 6437** 6438** ^The sqlite3_commit_hook() interface registers a callback 6439** function to be invoked whenever a transaction is [COMMIT | committed]. 6440** ^Any callback set by a previous call to sqlite3_commit_hook() 6441** for the same database connection is overridden. 6442** ^The sqlite3_rollback_hook() interface registers a callback 6443** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. 6444** ^Any callback set by a previous call to sqlite3_rollback_hook() 6445** for the same database connection is overridden. 6446** ^The pArg argument is passed through to the callback. 6447** ^If the callback on a commit hook function returns non-zero, 6448** then the commit is converted into a rollback. 6449** 6450** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions 6451** return the P argument from the previous call of the same function 6452** on the same [database connection] D, or NULL for 6453** the first call for each function on D. 6454** 6455** The commit and rollback hook callbacks are not reentrant. 6456** The callback implementation must not do anything that will modify 6457** the database connection that invoked the callback. Any actions 6458** to modify the database connection must be deferred until after the 6459** completion of the [sqlite3_step()] call that triggered the commit 6460** or rollback hook in the first place. 6461** Note that running any other SQL statements, including SELECT statements, 6462** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify 6463** the database connections for the meaning of "modify" in this paragraph. 6464** 6465** ^Registering a NULL function disables the callback. 6466** 6467** ^When the commit hook callback routine returns zero, the [COMMIT] 6468** operation is allowed to continue normally. ^If the commit hook 6469** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. 6470** ^The rollback hook is invoked on a rollback that results from a commit 6471** hook returning non-zero, just as it would be with any other rollback. 6472** 6473** ^For the purposes of this API, a transaction is said to have been 6474** rolled back if an explicit "ROLLBACK" statement is executed, or 6475** an error or constraint causes an implicit rollback to occur. 6476** ^The rollback callback is not invoked if a transaction is 6477** automatically rolled back because the database connection is closed. 6478** 6479** See also the [sqlite3_update_hook()] interface. 6480*/ 6481void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 6482void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 6483 6484/* 6485** CAPI3REF: Autovacuum Compaction Amount Callback 6486** METHOD: sqlite3 6487** 6488** ^The sqlite3_autovacuum_pages(D,C,P,X) interface registers a callback 6489** function C that is invoked prior to each autovacuum of the database 6490** file. ^The callback is passed a copy of the generic data pointer (P), 6491** the schema-name of the attached database that is being autovacuumed, 6492** the size of the database file in pages, the number of free pages, 6493** and the number of bytes per page, respectively. The callback should 6494** return the number of free pages that should be removed by the 6495** autovacuum. ^If the callback returns zero, then no autovacuum happens. 6496** ^If the value returned is greater than or equal to the number of 6497** free pages, then a complete autovacuum happens. 6498** 6499** <p>^If there are multiple ATTACH-ed database files that are being 6500** modified as part of a transaction commit, then the autovacuum pages 6501** callback is invoked separately for each file. 6502** 6503** <p><b>The callback is not reentrant.</b> The callback function should 6504** not attempt to invoke any other SQLite interface. If it does, bad 6505** things may happen, including segmentation faults and corrupt database 6506** files. The callback function should be a simple function that 6507** does some arithmetic on its input parameters and returns a result. 6508** 6509** ^The X parameter to sqlite3_autovacuum_pages(D,C,P,X) is an optional 6510** destructor for the P parameter. ^If X is not NULL, then X(P) is 6511** invoked whenever the database connection closes or when the callback 6512** is overwritten by another invocation of sqlite3_autovacuum_pages(). 6513** 6514** <p>^There is only one autovacuum pages callback per database connection. 6515** ^Each call to the sqlite3_autovacuum_pages() interface overrides all 6516** previous invocations for that database connection. ^If the callback 6517** argument (C) to sqlite3_autovacuum_pages(D,C,P,X) is a NULL pointer, 6518** then the autovacuum steps callback is cancelled. The return value 6519** from sqlite3_autovacuum_pages() is normally SQLITE_OK, but might 6520** be some other error code if something goes wrong. The current 6521** implementation will only return SQLITE_OK or SQLITE_MISUSE, but other 6522** return codes might be added in future releases. 6523** 6524** <p>If no autovacuum pages callback is specified (the usual case) or 6525** a NULL pointer is provided for the callback, 6526** then the default behavior is to vacuum all free pages. So, in other 6527** words, the default behavior is the same as if the callback function 6528** were something like this: 6529** 6530** <blockquote><pre> 6531** unsigned int demonstration_autovac_pages_callback( 6532** void *pClientData, 6533** const char *zSchema, 6534** unsigned int nDbPage, 6535** unsigned int nFreePage, 6536** unsigned int nBytePerPage 6537** ){ 6538** return nFreePage; 6539** } 6540** </pre></blockquote> 6541*/ 6542int sqlite3_autovacuum_pages( 6543 sqlite3 *db, 6544 unsigned int(*)(void*,const char*,unsigned int,unsigned int,unsigned int), 6545 void*, 6546 void(*)(void*) 6547); 6548 6549 6550/* 6551** CAPI3REF: Data Change Notification Callbacks 6552** METHOD: sqlite3 6553** 6554** ^The sqlite3_update_hook() interface registers a callback function 6555** with the [database connection] identified by the first argument 6556** to be invoked whenever a row is updated, inserted or deleted in 6557** a [rowid table]. 6558** ^Any callback set by a previous call to this function 6559** for the same database connection is overridden. 6560** 6561** ^The second argument is a pointer to the function to invoke when a 6562** row is updated, inserted or deleted in a rowid table. 6563** ^The first argument to the callback is a copy of the third argument 6564** to sqlite3_update_hook(). 6565** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 6566** or [SQLITE_UPDATE], depending on the operation that caused the callback 6567** to be invoked. 6568** ^The third and fourth arguments to the callback contain pointers to the 6569** database and table name containing the affected row. 6570** ^The final callback parameter is the [rowid] of the row. 6571** ^In the case of an update, this is the [rowid] after the update takes place. 6572** 6573** ^(The update hook is not invoked when internal system tables are 6574** modified (i.e. sqlite_sequence).)^ 6575** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified. 6576** 6577** ^In the current implementation, the update hook 6578** is not invoked when conflicting rows are deleted because of an 6579** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook 6580** invoked when rows are deleted using the [truncate optimization]. 6581** The exceptions defined in this paragraph might change in a future 6582** release of SQLite. 6583** 6584** The update hook implementation must not do anything that will modify 6585** the database connection that invoked the update hook. Any actions 6586** to modify the database connection must be deferred until after the 6587** completion of the [sqlite3_step()] call that triggered the update hook. 6588** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 6589** database connections for the meaning of "modify" in this paragraph. 6590** 6591** ^The sqlite3_update_hook(D,C,P) function 6592** returns the P argument from the previous call 6593** on the same [database connection] D, or NULL for 6594** the first call on D. 6595** 6596** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()], 6597** and [sqlite3_preupdate_hook()] interfaces. 6598*/ 6599void *sqlite3_update_hook( 6600 sqlite3*, 6601 void(*)(void *,int ,char const *,char const *,sqlite3_int64), 6602 void* 6603); 6604 6605/* 6606** CAPI3REF: Enable Or Disable Shared Pager Cache 6607** 6608** ^(This routine enables or disables the sharing of the database cache 6609** and schema data structures between [database connection | connections] 6610** to the same database. Sharing is enabled if the argument is true 6611** and disabled if the argument is false.)^ 6612** 6613** This interface is omitted if SQLite is compiled with 6614** [-DSQLITE_OMIT_SHARED_CACHE]. The [-DSQLITE_OMIT_SHARED_CACHE] 6615** compile-time option is recommended because the 6616** [use of shared cache mode is discouraged]. 6617** 6618** ^Cache sharing is enabled and disabled for an entire process. 6619** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]). 6620** In prior versions of SQLite, 6621** sharing was enabled or disabled for each thread separately. 6622** 6623** ^(The cache sharing mode set by this interface effects all subsequent 6624** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 6625** Existing database connections continue to use the sharing mode 6626** that was in effect at the time they were opened.)^ 6627** 6628** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled 6629** successfully. An [error code] is returned otherwise.)^ 6630** 6631** ^Shared cache is disabled by default. It is recommended that it stay 6632** that way. In other words, do not use this routine. This interface 6633** continues to be provided for historical compatibility, but its use is 6634** discouraged. Any use of shared cache is discouraged. If shared cache 6635** must be used, it is recommended that shared cache only be enabled for 6636** individual database connections using the [sqlite3_open_v2()] interface 6637** with the [SQLITE_OPEN_SHAREDCACHE] flag. 6638** 6639** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0 6640** and will always return SQLITE_MISUSE. On those systems, 6641** shared cache mode should be enabled per-database connection via 6642** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE]. 6643** 6644** This interface is threadsafe on processors where writing a 6645** 32-bit integer is atomic. 6646** 6647** See Also: [SQLite Shared-Cache Mode] 6648*/ 6649int sqlite3_enable_shared_cache(int); 6650 6651/* 6652** CAPI3REF: Attempt To Free Heap Memory 6653** 6654** ^The sqlite3_release_memory() interface attempts to free N bytes 6655** of heap memory by deallocating non-essential memory allocations 6656** held by the database library. Memory used to cache database 6657** pages to improve performance is an example of non-essential memory. 6658** ^sqlite3_release_memory() returns the number of bytes actually freed, 6659** which might be more or less than the amount requested. 6660** ^The sqlite3_release_memory() routine is a no-op returning zero 6661** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. 6662** 6663** See also: [sqlite3_db_release_memory()] 6664*/ 6665int sqlite3_release_memory(int); 6666 6667/* 6668** CAPI3REF: Free Memory Used By A Database Connection 6669** METHOD: sqlite3 6670** 6671** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap 6672** memory as possible from database connection D. Unlike the 6673** [sqlite3_release_memory()] interface, this interface is in effect even 6674** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is 6675** omitted. 6676** 6677** See also: [sqlite3_release_memory()] 6678*/ 6679int sqlite3_db_release_memory(sqlite3*); 6680 6681/* 6682** CAPI3REF: Impose A Limit On Heap Size 6683** 6684** These interfaces impose limits on the amount of heap memory that will be 6685** by all database connections within a single process. 6686** 6687** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the 6688** soft limit on the amount of heap memory that may be allocated by SQLite. 6689** ^SQLite strives to keep heap memory utilization below the soft heap 6690** limit by reducing the number of pages held in the page cache 6691** as heap memory usages approaches the limit. 6692** ^The soft heap limit is "soft" because even though SQLite strives to stay 6693** below the limit, it will exceed the limit rather than generate 6694** an [SQLITE_NOMEM] error. In other words, the soft heap limit 6695** is advisory only. 6696** 6697** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of 6698** N bytes on the amount of memory that will be allocated. ^The 6699** sqlite3_hard_heap_limit64(N) interface is similar to 6700** sqlite3_soft_heap_limit64(N) except that memory allocations will fail 6701** when the hard heap limit is reached. 6702** 6703** ^The return value from both sqlite3_soft_heap_limit64() and 6704** sqlite3_hard_heap_limit64() is the size of 6705** the heap limit prior to the call, or negative in the case of an 6706** error. ^If the argument N is negative 6707** then no change is made to the heap limit. Hence, the current 6708** size of heap limits can be determined by invoking 6709** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1). 6710** 6711** ^Setting the heap limits to zero disables the heap limiter mechanism. 6712** 6713** ^The soft heap limit may not be greater than the hard heap limit. 6714** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N) 6715** is invoked with a value of N that is greater than the hard heap limit, 6716** the soft heap limit is set to the value of the hard heap limit. 6717** ^The soft heap limit is automatically enabled whenever the hard heap 6718** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and 6719** the soft heap limit is outside the range of 1..N, then the soft heap 6720** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the 6721** hard heap limit is enabled makes the soft heap limit equal to the 6722** hard heap limit. 6723** 6724** The memory allocation limits can also be adjusted using 6725** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit]. 6726** 6727** ^(The heap limits are not enforced in the current implementation 6728** if one or more of following conditions are true: 6729** 6730** <ul> 6731** <li> The limit value is set to zero. 6732** <li> Memory accounting is disabled using a combination of the 6733** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and 6734** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. 6735** <li> An alternative page cache implementation is specified using 6736** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...). 6737** <li> The page cache allocates from its own memory pool supplied 6738** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than 6739** from the heap. 6740** </ul>)^ 6741** 6742** The circumstances under which SQLite will enforce the heap limits may 6743** changes in future releases of SQLite. 6744*/ 6745sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); 6746sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N); 6747 6748/* 6749** CAPI3REF: Deprecated Soft Heap Limit Interface 6750** DEPRECATED 6751** 6752** This is a deprecated version of the [sqlite3_soft_heap_limit64()] 6753** interface. This routine is provided for historical compatibility 6754** only. All new applications should use the 6755** [sqlite3_soft_heap_limit64()] interface rather than this one. 6756*/ 6757SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); 6758 6759 6760/* 6761** CAPI3REF: Extract Metadata About A Column Of A Table 6762** METHOD: sqlite3 6763** 6764** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns 6765** information about column C of table T in database D 6766** on [database connection] X.)^ ^The sqlite3_table_column_metadata() 6767** interface returns SQLITE_OK and fills in the non-NULL pointers in 6768** the final five arguments with appropriate values if the specified 6769** column exists. ^The sqlite3_table_column_metadata() interface returns 6770** SQLITE_ERROR if the specified column does not exist. 6771** ^If the column-name parameter to sqlite3_table_column_metadata() is a 6772** NULL pointer, then this routine simply checks for the existence of the 6773** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it 6774** does not. If the table name parameter T in a call to 6775** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is 6776** undefined behavior. 6777** 6778** ^The column is identified by the second, third and fourth parameters to 6779** this function. ^(The second parameter is either the name of the database 6780** (i.e. "main", "temp", or an attached database) containing the specified 6781** table or NULL.)^ ^If it is NULL, then all attached databases are searched 6782** for the table using the same algorithm used by the database engine to 6783** resolve unqualified table references. 6784** 6785** ^The third and fourth parameters to this function are the table and column 6786** name of the desired column, respectively. 6787** 6788** ^Metadata is returned by writing to the memory locations passed as the 5th 6789** and subsequent parameters to this function. ^Any of these arguments may be 6790** NULL, in which case the corresponding element of metadata is omitted. 6791** 6792** ^(<blockquote> 6793** <table border="1"> 6794** <tr><th> Parameter <th> Output<br>Type <th> Description 6795** 6796** <tr><td> 5th <td> const char* <td> Data type 6797** <tr><td> 6th <td> const char* <td> Name of default collation sequence 6798** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 6799** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 6800** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] 6801** </table> 6802** </blockquote>)^ 6803** 6804** ^The memory pointed to by the character pointers returned for the 6805** declaration type and collation sequence is valid until the next 6806** call to any SQLite API function. 6807** 6808** ^If the specified table is actually a view, an [error code] is returned. 6809** 6810** ^If the specified column is "rowid", "oid" or "_rowid_" and the table 6811** is not a [WITHOUT ROWID] table and an 6812** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output 6813** parameters are set for the explicitly declared column. ^(If there is no 6814** [INTEGER PRIMARY KEY] column, then the outputs 6815** for the [rowid] are set as follows: 6816** 6817** <pre> 6818** data type: "INTEGER" 6819** collation sequence: "BINARY" 6820** not null: 0 6821** primary key: 1 6822** auto increment: 0 6823** </pre>)^ 6824** 6825** ^This function causes all database schemas to be read from disk and 6826** parsed, if that has not already been done, and returns an error if 6827** any errors are encountered while loading the schema. 6828*/ 6829int sqlite3_table_column_metadata( 6830 sqlite3 *db, /* Connection handle */ 6831 const char *zDbName, /* Database name or NULL */ 6832 const char *zTableName, /* Table name */ 6833 const char *zColumnName, /* Column name */ 6834 char const **pzDataType, /* OUTPUT: Declared data type */ 6835 char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 6836 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 6837 int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 6838 int *pAutoinc /* OUTPUT: True if column is auto-increment */ 6839); 6840 6841/* 6842** CAPI3REF: Load An Extension 6843** METHOD: sqlite3 6844** 6845** ^This interface loads an SQLite extension library from the named file. 6846** 6847** ^The sqlite3_load_extension() interface attempts to load an 6848** [SQLite extension] library contained in the file zFile. If 6849** the file cannot be loaded directly, attempts are made to load 6850** with various operating-system specific extensions added. 6851** So for example, if "samplelib" cannot be loaded, then names like 6852** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might 6853** be tried also. 6854** 6855** ^The entry point is zProc. 6856** ^(zProc may be 0, in which case SQLite will try to come up with an 6857** entry point name on its own. It first tries "sqlite3_extension_init". 6858** If that does not work, it constructs a name "sqlite3_X_init" where the 6859** X is consists of the lower-case equivalent of all ASCII alphabetic 6860** characters in the filename from the last "/" to the first following 6861** "." and omitting any initial "lib".)^ 6862** ^The sqlite3_load_extension() interface returns 6863** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 6864** ^If an error occurs and pzErrMsg is not 0, then the 6865** [sqlite3_load_extension()] interface shall attempt to 6866** fill *pzErrMsg with error message text stored in memory 6867** obtained from [sqlite3_malloc()]. The calling function 6868** should free this memory by calling [sqlite3_free()]. 6869** 6870** ^Extension loading must be enabled using 6871** [sqlite3_enable_load_extension()] or 6872** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL) 6873** prior to calling this API, 6874** otherwise an error will be returned. 6875** 6876** <b>Security warning:</b> It is recommended that the 6877** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this 6878** interface. The use of the [sqlite3_enable_load_extension()] interface 6879** should be avoided. This will keep the SQL function [load_extension()] 6880** disabled and prevent SQL injections from giving attackers 6881** access to extension loading capabilities. 6882** 6883** See also the [load_extension() SQL function]. 6884*/ 6885int sqlite3_load_extension( 6886 sqlite3 *db, /* Load the extension into this database connection */ 6887 const char *zFile, /* Name of the shared library containing extension */ 6888 const char *zProc, /* Entry point. Derived from zFile if 0 */ 6889 char **pzErrMsg /* Put error message here if not 0 */ 6890); 6891 6892/* 6893** CAPI3REF: Enable Or Disable Extension Loading 6894** METHOD: sqlite3 6895** 6896** ^So as not to open security holes in older applications that are 6897** unprepared to deal with [extension loading], and as a means of disabling 6898** [extension loading] while evaluating user-entered SQL, the following API 6899** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 6900** 6901** ^Extension loading is off by default. 6902** ^Call the sqlite3_enable_load_extension() routine with onoff==1 6903** to turn extension loading on and call it with onoff==0 to turn 6904** it back off again. 6905** 6906** ^This interface enables or disables both the C-API 6907** [sqlite3_load_extension()] and the SQL function [load_extension()]. 6908** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..) 6909** to enable or disable only the C-API.)^ 6910** 6911** <b>Security warning:</b> It is recommended that extension loading 6912** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method 6913** rather than this interface, so the [load_extension()] SQL function 6914** remains disabled. This will prevent SQL injections from giving attackers 6915** access to extension loading capabilities. 6916*/ 6917int sqlite3_enable_load_extension(sqlite3 *db, int onoff); 6918 6919/* 6920** CAPI3REF: Automatically Load Statically Linked Extensions 6921** 6922** ^This interface causes the xEntryPoint() function to be invoked for 6923** each new [database connection] that is created. The idea here is that 6924** xEntryPoint() is the entry point for a statically linked [SQLite extension] 6925** that is to be automatically loaded into all new database connections. 6926** 6927** ^(Even though the function prototype shows that xEntryPoint() takes 6928** no arguments and returns void, SQLite invokes xEntryPoint() with three 6929** arguments and expects an integer result as if the signature of the 6930** entry point where as follows: 6931** 6932** <blockquote><pre> 6933** int xEntryPoint( 6934** sqlite3 *db, 6935** const char **pzErrMsg, 6936** const struct sqlite3_api_routines *pThunk 6937** ); 6938** </pre></blockquote>)^ 6939** 6940** If the xEntryPoint routine encounters an error, it should make *pzErrMsg 6941** point to an appropriate error message (obtained from [sqlite3_mprintf()]) 6942** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg 6943** is NULL before calling the xEntryPoint(). ^SQLite will invoke 6944** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any 6945** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], 6946** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. 6947** 6948** ^Calling sqlite3_auto_extension(X) with an entry point X that is already 6949** on the list of automatic extensions is a harmless no-op. ^No entry point 6950** will be called more than once for each database connection that is opened. 6951** 6952** See also: [sqlite3_reset_auto_extension()] 6953** and [sqlite3_cancel_auto_extension()] 6954*/ 6955int sqlite3_auto_extension(void(*xEntryPoint)(void)); 6956 6957/* 6958** CAPI3REF: Cancel Automatic Extension Loading 6959** 6960** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the 6961** initialization routine X that was registered using a prior call to 6962** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)] 6963** routine returns 1 if initialization routine X was successfully 6964** unregistered and it returns 0 if X was not on the list of initialization 6965** routines. 6966*/ 6967int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void)); 6968 6969/* 6970** CAPI3REF: Reset Automatic Extension Loading 6971** 6972** ^This interface disables all automatic extensions previously 6973** registered using [sqlite3_auto_extension()]. 6974*/ 6975void sqlite3_reset_auto_extension(void); 6976 6977/* 6978** The interface to the virtual-table mechanism is currently considered 6979** to be experimental. The interface might change in incompatible ways. 6980** If this is a problem for you, do not use the interface at this time. 6981** 6982** When the virtual-table mechanism stabilizes, we will declare the 6983** interface fixed, support it indefinitely, and remove this comment. 6984*/ 6985 6986/* 6987** Structures used by the virtual table interface 6988*/ 6989typedef struct sqlite3_vtab sqlite3_vtab; 6990typedef struct sqlite3_index_info sqlite3_index_info; 6991typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 6992typedef struct sqlite3_module sqlite3_module; 6993 6994/* 6995** CAPI3REF: Virtual Table Object 6996** KEYWORDS: sqlite3_module {virtual table module} 6997** 6998** This structure, sometimes called a "virtual table module", 6999** defines the implementation of a [virtual table]. 7000** This structure consists mostly of methods for the module. 7001** 7002** ^A virtual table module is created by filling in a persistent 7003** instance of this structure and passing a pointer to that instance 7004** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. 7005** ^The registration remains valid until it is replaced by a different 7006** module or until the [database connection] closes. The content 7007** of this structure must not change while it is registered with 7008** any database connection. 7009*/ 7010struct sqlite3_module { 7011 int iVersion; 7012 int (*xCreate)(sqlite3*, void *pAux, 7013 int argc, const char *const*argv, 7014 sqlite3_vtab **ppVTab, char**); 7015 int (*xConnect)(sqlite3*, void *pAux, 7016 int argc, const char *const*argv, 7017 sqlite3_vtab **ppVTab, char**); 7018 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); 7019 int (*xDisconnect)(sqlite3_vtab *pVTab); 7020 int (*xDestroy)(sqlite3_vtab *pVTab); 7021 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); 7022 int (*xClose)(sqlite3_vtab_cursor*); 7023 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, 7024 int argc, sqlite3_value **argv); 7025 int (*xNext)(sqlite3_vtab_cursor*); 7026 int (*xEof)(sqlite3_vtab_cursor*); 7027 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); 7028 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 7029 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 7030 int (*xBegin)(sqlite3_vtab *pVTab); 7031 int (*xSync)(sqlite3_vtab *pVTab); 7032 int (*xCommit)(sqlite3_vtab *pVTab); 7033 int (*xRollback)(sqlite3_vtab *pVTab); 7034 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 7035 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 7036 void **ppArg); 7037 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 7038 /* The methods above are in version 1 of the sqlite_module object. Those 7039 ** below are for version 2 and greater. */ 7040 int (*xSavepoint)(sqlite3_vtab *pVTab, int); 7041 int (*xRelease)(sqlite3_vtab *pVTab, int); 7042 int (*xRollbackTo)(sqlite3_vtab *pVTab, int); 7043 /* The methods above are in versions 1 and 2 of the sqlite_module object. 7044 ** Those below are for version 3 and greater. */ 7045 int (*xShadowName)(const char*); 7046}; 7047 7048/* 7049** CAPI3REF: Virtual Table Indexing Information 7050** KEYWORDS: sqlite3_index_info 7051** 7052** The sqlite3_index_info structure and its substructures is used as part 7053** of the [virtual table] interface to 7054** pass information into and receive the reply from the [xBestIndex] 7055** method of a [virtual table module]. The fields under **Inputs** are the 7056** inputs to xBestIndex and are read-only. xBestIndex inserts its 7057** results into the **Outputs** fields. 7058** 7059** ^(The aConstraint[] array records WHERE clause constraints of the form: 7060** 7061** <blockquote>column OP expr</blockquote> 7062** 7063** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is 7064** stored in aConstraint[].op using one of the 7065** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ 7066** ^(The index of the column is stored in 7067** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the 7068** expr on the right-hand side can be evaluated (and thus the constraint 7069** is usable) and false if it cannot.)^ 7070** 7071** ^The optimizer automatically inverts terms of the form "expr OP column" 7072** and makes other simplifications to the WHERE clause in an attempt to 7073** get as many WHERE clause terms into the form shown above as possible. 7074** ^The aConstraint[] array only reports WHERE clause terms that are 7075** relevant to the particular virtual table being queried. 7076** 7077** ^Information about the ORDER BY clause is stored in aOrderBy[]. 7078** ^Each term of aOrderBy records a column of the ORDER BY clause. 7079** 7080** The colUsed field indicates which columns of the virtual table may be 7081** required by the current scan. Virtual table columns are numbered from 7082** zero in the order in which they appear within the CREATE TABLE statement 7083** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), 7084** the corresponding bit is set within the colUsed mask if the column may be 7085** required by SQLite. If the table has at least 64 columns and any column 7086** to the right of the first 63 is required, then bit 63 of colUsed is also 7087** set. In other words, column iCol may be required if the expression 7088** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to 7089** non-zero. 7090** 7091** The [xBestIndex] method must fill aConstraintUsage[] with information 7092** about what parameters to pass to xFilter. ^If argvIndex>0 then 7093** the right-hand side of the corresponding aConstraint[] is evaluated 7094** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit 7095** is true, then the constraint is assumed to be fully handled by the 7096** virtual table and might not be checked again by the byte code.)^ ^(The 7097** aConstraintUsage[].omit flag is an optimization hint. When the omit flag 7098** is left in its default setting of false, the constraint will always be 7099** checked separately in byte code. If the omit flag is change to true, then 7100** the constraint may or may not be checked in byte code. In other words, 7101** when the omit flag is true there is no guarantee that the constraint will 7102** not be checked again using byte code.)^ 7103** 7104** ^The idxNum and idxPtr values are recorded and passed into the 7105** [xFilter] method. 7106** ^[sqlite3_free()] is used to free idxPtr if and only if 7107** needToFreeIdxPtr is true. 7108** 7109** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in 7110** the correct order to satisfy the ORDER BY clause so that no separate 7111** sorting step is required. 7112** 7113** ^The estimatedCost value is an estimate of the cost of a particular 7114** strategy. A cost of N indicates that the cost of the strategy is similar 7115** to a linear scan of an SQLite table with N rows. A cost of log(N) 7116** indicates that the expense of the operation is similar to that of a 7117** binary search on a unique indexed field of an SQLite table with N rows. 7118** 7119** ^The estimatedRows value is an estimate of the number of rows that 7120** will be returned by the strategy. 7121** 7122** The xBestIndex method may optionally populate the idxFlags field with a 7123** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag - 7124** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite 7125** assumes that the strategy may visit at most one row. 7126** 7127** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then 7128** SQLite also assumes that if a call to the xUpdate() method is made as 7129** part of the same statement to delete or update a virtual table row and the 7130** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback 7131** any database changes. In other words, if the xUpdate() returns 7132** SQLITE_CONSTRAINT, the database contents must be exactly as they were 7133** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not 7134** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by 7135** the xUpdate method are automatically rolled back by SQLite. 7136** 7137** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info 7138** structure for SQLite [version 3.8.2] ([dateof:3.8.2]). 7139** If a virtual table extension is 7140** used with an SQLite version earlier than 3.8.2, the results of attempting 7141** to read or write the estimatedRows field are undefined (but are likely 7142** to include crashing the application). The estimatedRows field should 7143** therefore only be used if [sqlite3_libversion_number()] returns a 7144** value greater than or equal to 3008002. Similarly, the idxFlags field 7145** was added for [version 3.9.0] ([dateof:3.9.0]). 7146** It may therefore only be used if 7147** sqlite3_libversion_number() returns a value greater than or equal to 7148** 3009000. 7149*/ 7150struct sqlite3_index_info { 7151 /* Inputs */ 7152 int nConstraint; /* Number of entries in aConstraint */ 7153 struct sqlite3_index_constraint { 7154 int iColumn; /* Column constrained. -1 for ROWID */ 7155 unsigned char op; /* Constraint operator */ 7156 unsigned char usable; /* True if this constraint is usable */ 7157 int iTermOffset; /* Used internally - xBestIndex should ignore */ 7158 } *aConstraint; /* Table of WHERE clause constraints */ 7159 int nOrderBy; /* Number of terms in the ORDER BY clause */ 7160 struct sqlite3_index_orderby { 7161 int iColumn; /* Column number */ 7162 unsigned char desc; /* True for DESC. False for ASC. */ 7163 } *aOrderBy; /* The ORDER BY clause */ 7164 /* Outputs */ 7165 struct sqlite3_index_constraint_usage { 7166 int argvIndex; /* if >0, constraint is part of argv to xFilter */ 7167 unsigned char omit; /* Do not code a test for this constraint */ 7168 } *aConstraintUsage; 7169 int idxNum; /* Number used to identify the index */ 7170 char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 7171 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 7172 int orderByConsumed; /* True if output is already ordered */ 7173 double estimatedCost; /* Estimated cost of using this index */ 7174 /* Fields below are only available in SQLite 3.8.2 and later */ 7175 sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ 7176 /* Fields below are only available in SQLite 3.9.0 and later */ 7177 int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ 7178 /* Fields below are only available in SQLite 3.10.0 and later */ 7179 sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ 7180}; 7181 7182/* 7183** CAPI3REF: Virtual Table Scan Flags 7184** 7185** Virtual table implementations are allowed to set the 7186** [sqlite3_index_info].idxFlags field to some combination of 7187** these bits. 7188*/ 7189#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ 7190 7191/* 7192** CAPI3REF: Virtual Table Constraint Operator Codes 7193** 7194** These macros define the allowed values for the 7195** [sqlite3_index_info].aConstraint[].op field. Each value represents 7196** an operator that is part of a constraint term in the WHERE clause of 7197** a query that uses a [virtual table]. 7198** 7199** ^The left-hand operand of the operator is given by the corresponding 7200** aConstraint[].iColumn field. ^An iColumn of -1 indicates the left-hand 7201** operand is the rowid. 7202** The SQLITE_INDEX_CONSTRAINT_LIMIT and SQLITE_INDEX_CONSTRAINT_OFFSET 7203** operators have no left-hand operand, and so for those operators the 7204** corresponding aConstraint[].iColumn is meaningless and should not be 7205** used. 7206** 7207** All operator values from SQLITE_INDEX_CONSTRAINT_FUNCTION through 7208** value 255 are reserved to represent functions that are overloaded 7209** by the [xFindFunction|xFindFunction method] of the virtual table 7210** implementation. 7211** 7212** The right-hand operands for each constraint might be accessible using 7213** the [sqlite3_vtab_rhs_value()] interface. Usually the right-hand 7214** operand is only available if it appears as a single constant literal 7215** in the input SQL. If the right-hand operand is another column or an 7216** expression (even a constant expression) or a parameter, then the 7217** sqlite3_vtab_rhs_value() probably will not be able to extract it. 7218** ^The SQLITE_INDEX_CONSTRAINT_ISNULL and 7219** SQLITE_INDEX_CONSTRAINT_ISNOTNULL operators have no right-hand operand 7220** and hence calls to sqlite3_vtab_rhs_value() for those operators will 7221** always return SQLITE_NOTFOUND. 7222** 7223** The collating sequence to be used for comparison can be found using 7224** the [sqlite3_vtab_collation()] interface. For most real-world virtual 7225** tables, the collating sequence of constraints does not matter (for example 7226** because the constraints are numeric) and so the sqlite3_vtab_collation() 7227** interface is no commonly needed. 7228*/ 7229#define SQLITE_INDEX_CONSTRAINT_EQ 2 7230#define SQLITE_INDEX_CONSTRAINT_GT 4 7231#define SQLITE_INDEX_CONSTRAINT_LE 8 7232#define SQLITE_INDEX_CONSTRAINT_LT 16 7233#define SQLITE_INDEX_CONSTRAINT_GE 32 7234#define SQLITE_INDEX_CONSTRAINT_MATCH 64 7235#define SQLITE_INDEX_CONSTRAINT_LIKE 65 7236#define SQLITE_INDEX_CONSTRAINT_GLOB 66 7237#define SQLITE_INDEX_CONSTRAINT_REGEXP 67 7238#define SQLITE_INDEX_CONSTRAINT_NE 68 7239#define SQLITE_INDEX_CONSTRAINT_ISNOT 69 7240#define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 7241#define SQLITE_INDEX_CONSTRAINT_ISNULL 71 7242#define SQLITE_INDEX_CONSTRAINT_IS 72 7243#define SQLITE_INDEX_CONSTRAINT_LIMIT 73 7244#define SQLITE_INDEX_CONSTRAINT_OFFSET 74 7245#define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 7246 7247/* 7248** CAPI3REF: Register A Virtual Table Implementation 7249** METHOD: sqlite3 7250** 7251** ^These routines are used to register a new [virtual table module] name. 7252** ^Module names must be registered before 7253** creating a new [virtual table] using the module and before using a 7254** preexisting [virtual table] for the module. 7255** 7256** ^The module name is registered on the [database connection] specified 7257** by the first parameter. ^The name of the module is given by the 7258** second parameter. ^The third parameter is a pointer to 7259** the implementation of the [virtual table module]. ^The fourth 7260** parameter is an arbitrary client data pointer that is passed through 7261** into the [xCreate] and [xConnect] methods of the virtual table module 7262** when a new virtual table is be being created or reinitialized. 7263** 7264** ^The sqlite3_create_module_v2() interface has a fifth parameter which 7265** is a pointer to a destructor for the pClientData. ^SQLite will 7266** invoke the destructor function (if it is not NULL) when SQLite 7267** no longer needs the pClientData pointer. ^The destructor will also 7268** be invoked if the call to sqlite3_create_module_v2() fails. 7269** ^The sqlite3_create_module() 7270** interface is equivalent to sqlite3_create_module_v2() with a NULL 7271** destructor. 7272** 7273** ^If the third parameter (the pointer to the sqlite3_module object) is 7274** NULL then no new module is created and any existing modules with the 7275** same name are dropped. 7276** 7277** See also: [sqlite3_drop_modules()] 7278*/ 7279int sqlite3_create_module( 7280 sqlite3 *db, /* SQLite connection to register module with */ 7281 const char *zName, /* Name of the module */ 7282 const sqlite3_module *p, /* Methods for the module */ 7283 void *pClientData /* Client data for xCreate/xConnect */ 7284); 7285int sqlite3_create_module_v2( 7286 sqlite3 *db, /* SQLite connection to register module with */ 7287 const char *zName, /* Name of the module */ 7288 const sqlite3_module *p, /* Methods for the module */ 7289 void *pClientData, /* Client data for xCreate/xConnect */ 7290 void(*xDestroy)(void*) /* Module destructor function */ 7291); 7292 7293/* 7294** CAPI3REF: Remove Unnecessary Virtual Table Implementations 7295** METHOD: sqlite3 7296** 7297** ^The sqlite3_drop_modules(D,L) interface removes all virtual 7298** table modules from database connection D except those named on list L. 7299** The L parameter must be either NULL or a pointer to an array of pointers 7300** to strings where the array is terminated by a single NULL pointer. 7301** ^If the L parameter is NULL, then all virtual table modules are removed. 7302** 7303** See also: [sqlite3_create_module()] 7304*/ 7305int sqlite3_drop_modules( 7306 sqlite3 *db, /* Remove modules from this connection */ 7307 const char **azKeep /* Except, do not remove the ones named here */ 7308); 7309 7310/* 7311** CAPI3REF: Virtual Table Instance Object 7312** KEYWORDS: sqlite3_vtab 7313** 7314** Every [virtual table module] implementation uses a subclass 7315** of this object to describe a particular instance 7316** of the [virtual table]. Each subclass will 7317** be tailored to the specific needs of the module implementation. 7318** The purpose of this superclass is to define certain fields that are 7319** common to all module implementations. 7320** 7321** ^Virtual tables methods can set an error message by assigning a 7322** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 7323** take care that any prior string is freed by a call to [sqlite3_free()] 7324** prior to assigning a new string to zErrMsg. ^After the error message 7325** is delivered up to the client application, the string will be automatically 7326** freed by sqlite3_free() and the zErrMsg field will be zeroed. 7327*/ 7328struct sqlite3_vtab { 7329 const sqlite3_module *pModule; /* The module for this virtual table */ 7330 int nRef; /* Number of open cursors */ 7331 char *zErrMsg; /* Error message from sqlite3_mprintf() */ 7332 /* Virtual table implementations will typically add additional fields */ 7333}; 7334 7335/* 7336** CAPI3REF: Virtual Table Cursor Object 7337** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} 7338** 7339** Every [virtual table module] implementation uses a subclass of the 7340** following structure to describe cursors that point into the 7341** [virtual table] and are used 7342** to loop through the virtual table. Cursors are created using the 7343** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed 7344** by the [sqlite3_module.xClose | xClose] method. Cursors are used 7345** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods 7346** of the module. Each module implementation will define 7347** the content of a cursor structure to suit its own needs. 7348** 7349** This superclass exists in order to define fields of the cursor that 7350** are common to all implementations. 7351*/ 7352struct sqlite3_vtab_cursor { 7353 sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 7354 /* Virtual table implementations will typically add additional fields */ 7355}; 7356 7357/* 7358** CAPI3REF: Declare The Schema Of A Virtual Table 7359** 7360** ^The [xCreate] and [xConnect] methods of a 7361** [virtual table module] call this interface 7362** to declare the format (the names and datatypes of the columns) of 7363** the virtual tables they implement. 7364*/ 7365int sqlite3_declare_vtab(sqlite3*, const char *zSQL); 7366 7367/* 7368** CAPI3REF: Overload A Function For A Virtual Table 7369** METHOD: sqlite3 7370** 7371** ^(Virtual tables can provide alternative implementations of functions 7372** using the [xFindFunction] method of the [virtual table module]. 7373** But global versions of those functions 7374** must exist in order to be overloaded.)^ 7375** 7376** ^(This API makes sure a global version of a function with a particular 7377** name and number of parameters exists. If no such function exists 7378** before this API is called, a new function is created.)^ ^The implementation 7379** of the new function always causes an exception to be thrown. So 7380** the new function is not good for anything by itself. Its only 7381** purpose is to be a placeholder function that can be overloaded 7382** by a [virtual table]. 7383*/ 7384int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); 7385 7386/* 7387** The interface to the virtual-table mechanism defined above (back up 7388** to a comment remarkably similar to this one) is currently considered 7389** to be experimental. The interface might change in incompatible ways. 7390** If this is a problem for you, do not use the interface at this time. 7391** 7392** When the virtual-table mechanism stabilizes, we will declare the 7393** interface fixed, support it indefinitely, and remove this comment. 7394*/ 7395 7396/* 7397** CAPI3REF: A Handle To An Open BLOB 7398** KEYWORDS: {BLOB handle} {BLOB handles} 7399** 7400** An instance of this object represents an open BLOB on which 7401** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 7402** ^Objects of this type are created by [sqlite3_blob_open()] 7403** and destroyed by [sqlite3_blob_close()]. 7404** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 7405** can be used to read or write small subsections of the BLOB. 7406** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 7407*/ 7408typedef struct sqlite3_blob sqlite3_blob; 7409 7410/* 7411** CAPI3REF: Open A BLOB For Incremental I/O 7412** METHOD: sqlite3 7413** CONSTRUCTOR: sqlite3_blob 7414** 7415** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located 7416** in row iRow, column zColumn, table zTable in database zDb; 7417** in other words, the same BLOB that would be selected by: 7418** 7419** <pre> 7420** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; 7421** </pre>)^ 7422** 7423** ^(Parameter zDb is not the filename that contains the database, but 7424** rather the symbolic name of the database. For attached databases, this is 7425** the name that appears after the AS keyword in the [ATTACH] statement. 7426** For the main database file, the database name is "main". For TEMP 7427** tables, the database name is "temp".)^ 7428** 7429** ^If the flags parameter is non-zero, then the BLOB is opened for read 7430** and write access. ^If the flags parameter is zero, the BLOB is opened for 7431** read-only access. 7432** 7433** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored 7434** in *ppBlob. Otherwise an [error code] is returned and, unless the error 7435** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided 7436** the API is not misused, it is always safe to call [sqlite3_blob_close()] 7437** on *ppBlob after this function it returns. 7438** 7439** This function fails with SQLITE_ERROR if any of the following are true: 7440** <ul> 7441** <li> ^(Database zDb does not exist)^, 7442** <li> ^(Table zTable does not exist within database zDb)^, 7443** <li> ^(Table zTable is a WITHOUT ROWID table)^, 7444** <li> ^(Column zColumn does not exist)^, 7445** <li> ^(Row iRow is not present in the table)^, 7446** <li> ^(The specified column of row iRow contains a value that is not 7447** a TEXT or BLOB value)^, 7448** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE 7449** constraint and the blob is being opened for read/write access)^, 7450** <li> ^([foreign key constraints | Foreign key constraints] are enabled, 7451** column zColumn is part of a [child key] definition and the blob is 7452** being opened for read/write access)^. 7453** </ul> 7454** 7455** ^Unless it returns SQLITE_MISUSE, this function sets the 7456** [database connection] error code and message accessible via 7457** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. 7458** 7459** A BLOB referenced by sqlite3_blob_open() may be read using the 7460** [sqlite3_blob_read()] interface and modified by using 7461** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a 7462** different row of the same table using the [sqlite3_blob_reopen()] 7463** interface. However, the column, table, or database of a [BLOB handle] 7464** cannot be changed after the [BLOB handle] is opened. 7465** 7466** ^(If the row that a BLOB handle points to is modified by an 7467** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 7468** then the BLOB handle is marked as "expired". 7469** This is true if any column of the row is changed, even a column 7470** other than the one the BLOB handle is open on.)^ 7471** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 7472** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. 7473** ^(Changes written into a BLOB prior to the BLOB expiring are not 7474** rolled back by the expiration of the BLOB. Such changes will eventually 7475** commit if the transaction continues to completion.)^ 7476** 7477** ^Use the [sqlite3_blob_bytes()] interface to determine the size of 7478** the opened blob. ^The size of a blob may not be changed by this 7479** interface. Use the [UPDATE] SQL command to change the size of a 7480** blob. 7481** 7482** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces 7483** and the built-in [zeroblob] SQL function may be used to create a 7484** zero-filled blob to read or write using the incremental-blob interface. 7485** 7486** To avoid a resource leak, every open [BLOB handle] should eventually 7487** be released by a call to [sqlite3_blob_close()]. 7488** 7489** See also: [sqlite3_blob_close()], 7490** [sqlite3_blob_reopen()], [sqlite3_blob_read()], 7491** [sqlite3_blob_bytes()], [sqlite3_blob_write()]. 7492*/ 7493int sqlite3_blob_open( 7494 sqlite3*, 7495 const char *zDb, 7496 const char *zTable, 7497 const char *zColumn, 7498 sqlite3_int64 iRow, 7499 int flags, 7500 sqlite3_blob **ppBlob 7501); 7502 7503/* 7504** CAPI3REF: Move a BLOB Handle to a New Row 7505** METHOD: sqlite3_blob 7506** 7507** ^This function is used to move an existing [BLOB handle] so that it points 7508** to a different row of the same database table. ^The new row is identified 7509** by the rowid value passed as the second argument. Only the row can be 7510** changed. ^The database, table and column on which the blob handle is open 7511** remain the same. Moving an existing [BLOB handle] to a new row is 7512** faster than closing the existing handle and opening a new one. 7513** 7514** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - 7515** it must exist and there must be either a blob or text value stored in 7516** the nominated column.)^ ^If the new row is not present in the table, or if 7517** it does not contain a blob or text value, or if another error occurs, an 7518** SQLite error code is returned and the blob handle is considered aborted. 7519** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or 7520** [sqlite3_blob_reopen()] on an aborted blob handle immediately return 7521** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle 7522** always returns zero. 7523** 7524** ^This function sets the database handle error code and message. 7525*/ 7526int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); 7527 7528/* 7529** CAPI3REF: Close A BLOB Handle 7530** DESTRUCTOR: sqlite3_blob 7531** 7532** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed 7533** unconditionally. Even if this routine returns an error code, the 7534** handle is still closed.)^ 7535** 7536** ^If the blob handle being closed was opened for read-write access, and if 7537** the database is in auto-commit mode and there are no other open read-write 7538** blob handles or active write statements, the current transaction is 7539** committed. ^If an error occurs while committing the transaction, an error 7540** code is returned and the transaction rolled back. 7541** 7542** Calling this function with an argument that is not a NULL pointer or an 7543** open blob handle results in undefined behaviour. ^Calling this routine 7544** with a null pointer (such as would be returned by a failed call to 7545** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function 7546** is passed a valid open blob handle, the values returned by the 7547** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning. 7548*/ 7549int sqlite3_blob_close(sqlite3_blob *); 7550 7551/* 7552** CAPI3REF: Return The Size Of An Open BLOB 7553** METHOD: sqlite3_blob 7554** 7555** ^Returns the size in bytes of the BLOB accessible via the 7556** successfully opened [BLOB handle] in its only argument. ^The 7557** incremental blob I/O routines can only read or overwriting existing 7558** blob content; they cannot change the size of a blob. 7559** 7560** This routine only works on a [BLOB handle] which has been created 7561** by a prior successful call to [sqlite3_blob_open()] and which has not 7562** been closed by [sqlite3_blob_close()]. Passing any other pointer in 7563** to this routine results in undefined and probably undesirable behavior. 7564*/ 7565int sqlite3_blob_bytes(sqlite3_blob *); 7566 7567/* 7568** CAPI3REF: Read Data From A BLOB Incrementally 7569** METHOD: sqlite3_blob 7570** 7571** ^(This function is used to read data from an open [BLOB handle] into a 7572** caller-supplied buffer. N bytes of data are copied into buffer Z 7573** from the open BLOB, starting at offset iOffset.)^ 7574** 7575** ^If offset iOffset is less than N bytes from the end of the BLOB, 7576** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is 7577** less than zero, [SQLITE_ERROR] is returned and no data is read. 7578** ^The size of the blob (and hence the maximum value of N+iOffset) 7579** can be determined using the [sqlite3_blob_bytes()] interface. 7580** 7581** ^An attempt to read from an expired [BLOB handle] fails with an 7582** error code of [SQLITE_ABORT]. 7583** 7584** ^(On success, sqlite3_blob_read() returns SQLITE_OK. 7585** Otherwise, an [error code] or an [extended error code] is returned.)^ 7586** 7587** This routine only works on a [BLOB handle] which has been created 7588** by a prior successful call to [sqlite3_blob_open()] and which has not 7589** been closed by [sqlite3_blob_close()]. Passing any other pointer in 7590** to this routine results in undefined and probably undesirable behavior. 7591** 7592** See also: [sqlite3_blob_write()]. 7593*/ 7594int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 7595 7596/* 7597** CAPI3REF: Write Data Into A BLOB Incrementally 7598** METHOD: sqlite3_blob 7599** 7600** ^(This function is used to write data into an open [BLOB handle] from a 7601** caller-supplied buffer. N bytes of data are copied from the buffer Z 7602** into the open BLOB, starting at offset iOffset.)^ 7603** 7604** ^(On success, sqlite3_blob_write() returns SQLITE_OK. 7605** Otherwise, an [error code] or an [extended error code] is returned.)^ 7606** ^Unless SQLITE_MISUSE is returned, this function sets the 7607** [database connection] error code and message accessible via 7608** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. 7609** 7610** ^If the [BLOB handle] passed as the first argument was not opened for 7611** writing (the flags parameter to [sqlite3_blob_open()] was zero), 7612** this function returns [SQLITE_READONLY]. 7613** 7614** This function may only modify the contents of the BLOB; it is 7615** not possible to increase the size of a BLOB using this API. 7616** ^If offset iOffset is less than N bytes from the end of the BLOB, 7617** [SQLITE_ERROR] is returned and no data is written. The size of the 7618** BLOB (and hence the maximum value of N+iOffset) can be determined 7619** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less 7620** than zero [SQLITE_ERROR] is returned and no data is written. 7621** 7622** ^An attempt to write to an expired [BLOB handle] fails with an 7623** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred 7624** before the [BLOB handle] expired are not rolled back by the 7625** expiration of the handle, though of course those changes might 7626** have been overwritten by the statement that expired the BLOB handle 7627** or by other independent statements. 7628** 7629** This routine only works on a [BLOB handle] which has been created 7630** by a prior successful call to [sqlite3_blob_open()] and which has not 7631** been closed by [sqlite3_blob_close()]. Passing any other pointer in 7632** to this routine results in undefined and probably undesirable behavior. 7633** 7634** See also: [sqlite3_blob_read()]. 7635*/ 7636int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); 7637 7638/* 7639** CAPI3REF: Virtual File System Objects 7640** 7641** A virtual filesystem (VFS) is an [sqlite3_vfs] object 7642** that SQLite uses to interact 7643** with the underlying operating system. Most SQLite builds come with a 7644** single default VFS that is appropriate for the host computer. 7645** New VFSes can be registered and existing VFSes can be unregistered. 7646** The following interfaces are provided. 7647** 7648** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 7649** ^Names are case sensitive. 7650** ^Names are zero-terminated UTF-8 strings. 7651** ^If there is no match, a NULL pointer is returned. 7652** ^If zVfsName is NULL then the default VFS is returned. 7653** 7654** ^New VFSes are registered with sqlite3_vfs_register(). 7655** ^Each new VFS becomes the default VFS if the makeDflt flag is set. 7656** ^The same VFS can be registered multiple times without injury. 7657** ^To make an existing VFS into the default VFS, register it again 7658** with the makeDflt flag set. If two different VFSes with the 7659** same name are registered, the behavior is undefined. If a 7660** VFS is registered with a name that is NULL or an empty string, 7661** then the behavior is undefined. 7662** 7663** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. 7664** ^(If the default VFS is unregistered, another VFS is chosen as 7665** the default. The choice for the new VFS is arbitrary.)^ 7666*/ 7667sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); 7668int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 7669int sqlite3_vfs_unregister(sqlite3_vfs*); 7670 7671/* 7672** CAPI3REF: Mutexes 7673** 7674** The SQLite core uses these routines for thread 7675** synchronization. Though they are intended for internal 7676** use by SQLite, code that links against SQLite is 7677** permitted to use any of these routines. 7678** 7679** The SQLite source code contains multiple implementations 7680** of these mutex routines. An appropriate implementation 7681** is selected automatically at compile-time. The following 7682** implementations are available in the SQLite core: 7683** 7684** <ul> 7685** <li> SQLITE_MUTEX_PTHREADS 7686** <li> SQLITE_MUTEX_W32 7687** <li> SQLITE_MUTEX_NOOP 7688** </ul> 7689** 7690** The SQLITE_MUTEX_NOOP implementation is a set of routines 7691** that does no real locking and is appropriate for use in 7692** a single-threaded application. The SQLITE_MUTEX_PTHREADS and 7693** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix 7694** and Windows. 7695** 7696** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 7697** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 7698** implementation is included with the library. In this case the 7699** application must supply a custom mutex implementation using the 7700** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 7701** before calling sqlite3_initialize() or any other public sqlite3_ 7702** function that calls sqlite3_initialize(). 7703** 7704** ^The sqlite3_mutex_alloc() routine allocates a new 7705** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc() 7706** routine returns NULL if it is unable to allocate the requested 7707** mutex. The argument to sqlite3_mutex_alloc() must one of these 7708** integer constants: 7709** 7710** <ul> 7711** <li> SQLITE_MUTEX_FAST 7712** <li> SQLITE_MUTEX_RECURSIVE 7713** <li> SQLITE_MUTEX_STATIC_MAIN 7714** <li> SQLITE_MUTEX_STATIC_MEM 7715** <li> SQLITE_MUTEX_STATIC_OPEN 7716** <li> SQLITE_MUTEX_STATIC_PRNG 7717** <li> SQLITE_MUTEX_STATIC_LRU 7718** <li> SQLITE_MUTEX_STATIC_PMEM 7719** <li> SQLITE_MUTEX_STATIC_APP1 7720** <li> SQLITE_MUTEX_STATIC_APP2 7721** <li> SQLITE_MUTEX_STATIC_APP3 7722** <li> SQLITE_MUTEX_STATIC_VFS1 7723** <li> SQLITE_MUTEX_STATIC_VFS2 7724** <li> SQLITE_MUTEX_STATIC_VFS3 7725** </ul> 7726** 7727** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) 7728** cause sqlite3_mutex_alloc() to create 7729** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 7730** is used but not necessarily so when SQLITE_MUTEX_FAST is used. 7731** The mutex implementation does not need to make a distinction 7732** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 7733** not want to. SQLite will only request a recursive mutex in 7734** cases where it really needs one. If a faster non-recursive mutex 7735** implementation is available on the host platform, the mutex subsystem 7736** might return such a mutex in response to SQLITE_MUTEX_FAST. 7737** 7738** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other 7739** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return 7740** a pointer to a static preexisting mutex. ^Nine static mutexes are 7741** used by the current version of SQLite. Future versions of SQLite 7742** may add additional static mutexes. Static mutexes are for internal 7743** use by SQLite only. Applications that use SQLite mutexes should 7744** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 7745** SQLITE_MUTEX_RECURSIVE. 7746** 7747** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 7748** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 7749** returns a different mutex on every call. ^For the static 7750** mutex types, the same mutex is returned on every call that has 7751** the same type number. 7752** 7753** ^The sqlite3_mutex_free() routine deallocates a previously 7754** allocated dynamic mutex. Attempting to deallocate a static 7755** mutex results in undefined behavior. 7756** 7757** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 7758** to enter a mutex. ^If another thread is already within the mutex, 7759** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 7760** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] 7761** upon successful entry. ^(Mutexes created using 7762** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 7763** In such cases, the 7764** mutex must be exited an equal number of times before another thread 7765** can enter.)^ If the same thread tries to enter any mutex other 7766** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined. 7767** 7768** ^(Some systems (for example, Windows 95) do not support the operation 7769** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 7770** will always return SQLITE_BUSY. The SQLite core only ever uses 7771** sqlite3_mutex_try() as an optimization so this is acceptable 7772** behavior.)^ 7773** 7774** ^The sqlite3_mutex_leave() routine exits a mutex that was 7775** previously entered by the same thread. The behavior 7776** is undefined if the mutex is not currently entered by the 7777** calling thread or is not currently allocated. 7778** 7779** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 7780** sqlite3_mutex_leave() is a NULL pointer, then all three routines 7781** behave as no-ops. 7782** 7783** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 7784*/ 7785sqlite3_mutex *sqlite3_mutex_alloc(int); 7786void sqlite3_mutex_free(sqlite3_mutex*); 7787void sqlite3_mutex_enter(sqlite3_mutex*); 7788int sqlite3_mutex_try(sqlite3_mutex*); 7789void sqlite3_mutex_leave(sqlite3_mutex*); 7790 7791/* 7792** CAPI3REF: Mutex Methods Object 7793** 7794** An instance of this structure defines the low-level routines 7795** used to allocate and use mutexes. 7796** 7797** Usually, the default mutex implementations provided by SQLite are 7798** sufficient, however the application has the option of substituting a custom 7799** implementation for specialized deployments or systems for which SQLite 7800** does not provide a suitable implementation. In this case, the application 7801** creates and populates an instance of this structure to pass 7802** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 7803** Additionally, an instance of this structure can be used as an 7804** output variable when querying the system for the current mutex 7805** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 7806** 7807** ^The xMutexInit method defined by this structure is invoked as 7808** part of system initialization by the sqlite3_initialize() function. 7809** ^The xMutexInit routine is called by SQLite exactly once for each 7810** effective call to [sqlite3_initialize()]. 7811** 7812** ^The xMutexEnd method defined by this structure is invoked as 7813** part of system shutdown by the sqlite3_shutdown() function. The 7814** implementation of this method is expected to release all outstanding 7815** resources obtained by the mutex methods implementation, especially 7816** those obtained by the xMutexInit method. ^The xMutexEnd() 7817** interface is invoked exactly once for each call to [sqlite3_shutdown()]. 7818** 7819** ^(The remaining seven methods defined by this structure (xMutexAlloc, 7820** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 7821** xMutexNotheld) implement the following interfaces (respectively): 7822** 7823** <ul> 7824** <li> [sqlite3_mutex_alloc()] </li> 7825** <li> [sqlite3_mutex_free()] </li> 7826** <li> [sqlite3_mutex_enter()] </li> 7827** <li> [sqlite3_mutex_try()] </li> 7828** <li> [sqlite3_mutex_leave()] </li> 7829** <li> [sqlite3_mutex_held()] </li> 7830** <li> [sqlite3_mutex_notheld()] </li> 7831** </ul>)^ 7832** 7833** The only difference is that the public sqlite3_XXX functions enumerated 7834** above silently ignore any invocations that pass a NULL pointer instead 7835** of a valid mutex handle. The implementations of the methods defined 7836** by this structure are not required to handle this case. The results 7837** of passing a NULL pointer instead of a valid mutex handle are undefined 7838** (i.e. it is acceptable to provide an implementation that segfaults if 7839** it is passed a NULL pointer). 7840** 7841** The xMutexInit() method must be threadsafe. It must be harmless to 7842** invoke xMutexInit() multiple times within the same process and without 7843** intervening calls to xMutexEnd(). Second and subsequent calls to 7844** xMutexInit() must be no-ops. 7845** 7846** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] 7847** and its associates). Similarly, xMutexAlloc() must not use SQLite memory 7848** allocation for a static mutex. ^However xMutexAlloc() may use SQLite 7849** memory allocation for a fast or recursive mutex. 7850** 7851** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is 7852** called, but only if the prior call to xMutexInit returned SQLITE_OK. 7853** If xMutexInit fails in any way, it is expected to clean up after itself 7854** prior to returning. 7855*/ 7856typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 7857struct sqlite3_mutex_methods { 7858 int (*xMutexInit)(void); 7859 int (*xMutexEnd)(void); 7860 sqlite3_mutex *(*xMutexAlloc)(int); 7861 void (*xMutexFree)(sqlite3_mutex *); 7862 void (*xMutexEnter)(sqlite3_mutex *); 7863 int (*xMutexTry)(sqlite3_mutex *); 7864 void (*xMutexLeave)(sqlite3_mutex *); 7865 int (*xMutexHeld)(sqlite3_mutex *); 7866 int (*xMutexNotheld)(sqlite3_mutex *); 7867}; 7868 7869/* 7870** CAPI3REF: Mutex Verification Routines 7871** 7872** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 7873** are intended for use inside assert() statements. The SQLite core 7874** never uses these routines except inside an assert() and applications 7875** are advised to follow the lead of the core. The SQLite core only 7876** provides implementations for these routines when it is compiled 7877** with the SQLITE_DEBUG flag. External mutex implementations 7878** are only required to provide these routines if SQLITE_DEBUG is 7879** defined and if NDEBUG is not defined. 7880** 7881** These routines should return true if the mutex in their argument 7882** is held or not held, respectively, by the calling thread. 7883** 7884** The implementation is not required to provide versions of these 7885** routines that actually work. If the implementation does not provide working 7886** versions of these routines, it should at least provide stubs that always 7887** return true so that one does not get spurious assertion failures. 7888** 7889** If the argument to sqlite3_mutex_held() is a NULL pointer then 7890** the routine should return 1. This seems counter-intuitive since 7891** clearly the mutex cannot be held if it does not exist. But 7892** the reason the mutex does not exist is because the build is not 7893** using mutexes. And we do not want the assert() containing the 7894** call to sqlite3_mutex_held() to fail, so a non-zero return is 7895** the appropriate thing to do. The sqlite3_mutex_notheld() 7896** interface should also return 1 when given a NULL pointer. 7897*/ 7898#ifndef NDEBUG 7899int sqlite3_mutex_held(sqlite3_mutex*); 7900int sqlite3_mutex_notheld(sqlite3_mutex*); 7901#endif 7902 7903/* 7904** CAPI3REF: Mutex Types 7905** 7906** The [sqlite3_mutex_alloc()] interface takes a single argument 7907** which is one of these integer constants. 7908** 7909** The set of static mutexes may change from one SQLite release to the 7910** next. Applications that override the built-in mutex logic must be 7911** prepared to accommodate additional static mutexes. 7912*/ 7913#define SQLITE_MUTEX_FAST 0 7914#define SQLITE_MUTEX_RECURSIVE 1 7915#define SQLITE_MUTEX_STATIC_MAIN 2 7916#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 7917#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 7918#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 7919#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */ 7920#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 7921#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ 7922#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ 7923#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */ 7924#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */ 7925#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */ 7926#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */ 7927#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */ 7928#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */ 7929 7930/* Legacy compatibility: */ 7931#define SQLITE_MUTEX_STATIC_MASTER 2 7932 7933 7934/* 7935** CAPI3REF: Retrieve the mutex for a database connection 7936** METHOD: sqlite3 7937** 7938** ^This interface returns a pointer the [sqlite3_mutex] object that 7939** serializes access to the [database connection] given in the argument 7940** when the [threading mode] is Serialized. 7941** ^If the [threading mode] is Single-thread or Multi-thread then this 7942** routine returns a NULL pointer. 7943*/ 7944sqlite3_mutex *sqlite3_db_mutex(sqlite3*); 7945 7946/* 7947** CAPI3REF: Low-Level Control Of Database Files 7948** METHOD: sqlite3 7949** KEYWORDS: {file control} 7950** 7951** ^The [sqlite3_file_control()] interface makes a direct call to the 7952** xFileControl method for the [sqlite3_io_methods] object associated 7953** with a particular database identified by the second argument. ^The 7954** name of the database is "main" for the main database or "temp" for the 7955** TEMP database, or the name that appears after the AS keyword for 7956** databases that are added using the [ATTACH] SQL command. 7957** ^A NULL pointer can be used in place of "main" to refer to the 7958** main database file. 7959** ^The third and fourth parameters to this routine 7960** are passed directly through to the second and third parameters of 7961** the xFileControl method. ^The return value of the xFileControl 7962** method becomes the return value of this routine. 7963** 7964** A few opcodes for [sqlite3_file_control()] are handled directly 7965** by the SQLite core and never invoke the 7966** sqlite3_io_methods.xFileControl method. 7967** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes 7968** a pointer to the underlying [sqlite3_file] object to be written into 7969** the space pointed to by the 4th parameter. The 7970** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns 7971** the [sqlite3_file] object associated with the journal file instead of 7972** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns 7973** a pointer to the underlying [sqlite3_vfs] object for the file. 7974** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter 7975** from the pager. 7976** 7977** ^If the second parameter (zDbName) does not match the name of any 7978** open database file, then SQLITE_ERROR is returned. ^This error 7979** code is not remembered and will not be recalled by [sqlite3_errcode()] 7980** or [sqlite3_errmsg()]. The underlying xFileControl method might 7981** also return SQLITE_ERROR. There is no way to distinguish between 7982** an incorrect zDbName and an SQLITE_ERROR return from the underlying 7983** xFileControl method. 7984** 7985** See also: [file control opcodes] 7986*/ 7987int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); 7988 7989/* 7990** CAPI3REF: Testing Interface 7991** 7992** ^The sqlite3_test_control() interface is used to read out internal 7993** state of SQLite and to inject faults into SQLite for testing 7994** purposes. ^The first parameter is an operation code that determines 7995** the number, meaning, and operation of all subsequent parameters. 7996** 7997** This interface is not for use by applications. It exists solely 7998** for verifying the correct operation of the SQLite library. Depending 7999** on how the SQLite library is compiled, this interface might not exist. 8000** 8001** The details of the operation codes, their meanings, the parameters 8002** they take, and what they do are all subject to change without notice. 8003** Unlike most of the SQLite API, this function is not guaranteed to 8004** operate consistently from one release to the next. 8005*/ 8006int sqlite3_test_control(int op, ...); 8007 8008/* 8009** CAPI3REF: Testing Interface Operation Codes 8010** 8011** These constants are the valid operation code parameters used 8012** as the first argument to [sqlite3_test_control()]. 8013** 8014** These parameters and their meanings are subject to change 8015** without notice. These values are for testing purposes only. 8016** Applications should not use any of these parameters or the 8017** [sqlite3_test_control()] interface. 8018*/ 8019#define SQLITE_TESTCTRL_FIRST 5 8020#define SQLITE_TESTCTRL_PRNG_SAVE 5 8021#define SQLITE_TESTCTRL_PRNG_RESTORE 6 8022#define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */ 8023#define SQLITE_TESTCTRL_BITVEC_TEST 8 8024#define SQLITE_TESTCTRL_FAULT_INSTALL 9 8025#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 8026#define SQLITE_TESTCTRL_PENDING_BYTE 11 8027#define SQLITE_TESTCTRL_ASSERT 12 8028#define SQLITE_TESTCTRL_ALWAYS 13 8029#define SQLITE_TESTCTRL_RESERVE 14 /* NOT USED */ 8030#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 8031#define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */ 8032#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */ 8033#define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17 8034#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 8035#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */ 8036#define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19 8037#define SQLITE_TESTCTRL_NEVER_CORRUPT 20 8038#define SQLITE_TESTCTRL_VDBE_COVERAGE 21 8039#define SQLITE_TESTCTRL_BYTEORDER 22 8040#define SQLITE_TESTCTRL_ISINIT 23 8041#define SQLITE_TESTCTRL_SORTER_MMAP 24 8042#define SQLITE_TESTCTRL_IMPOSTER 25 8043#define SQLITE_TESTCTRL_PARSER_COVERAGE 26 8044#define SQLITE_TESTCTRL_RESULT_INTREAL 27 8045#define SQLITE_TESTCTRL_PRNG_SEED 28 8046#define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29 8047#define SQLITE_TESTCTRL_SEEK_COUNT 30 8048#define SQLITE_TESTCTRL_TRACEFLAGS 31 8049#define SQLITE_TESTCTRL_TUNE 32 8050#define SQLITE_TESTCTRL_LOGEST 33 8051#define SQLITE_TESTCTRL_LAST 33 /* Largest TESTCTRL */ 8052 8053/* 8054** CAPI3REF: SQL Keyword Checking 8055** 8056** These routines provide access to the set of SQL language keywords 8057** recognized by SQLite. Applications can uses these routines to determine 8058** whether or not a specific identifier needs to be escaped (for example, 8059** by enclosing in double-quotes) so as not to confuse the parser. 8060** 8061** The sqlite3_keyword_count() interface returns the number of distinct 8062** keywords understood by SQLite. 8063** 8064** The sqlite3_keyword_name(N,Z,L) interface finds the N-th keyword and 8065** makes *Z point to that keyword expressed as UTF8 and writes the number 8066** of bytes in the keyword into *L. The string that *Z points to is not 8067** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns 8068** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z 8069** or L are NULL or invalid pointers then calls to 8070** sqlite3_keyword_name(N,Z,L) result in undefined behavior. 8071** 8072** The sqlite3_keyword_check(Z,L) interface checks to see whether or not 8073** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero 8074** if it is and zero if not. 8075** 8076** The parser used by SQLite is forgiving. It is often possible to use 8077** a keyword as an identifier as long as such use does not result in a 8078** parsing ambiguity. For example, the statement 8079** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and 8080** creates a new table named "BEGIN" with three columns named 8081** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid 8082** using keywords as identifiers. Common techniques used to avoid keyword 8083** name collisions include: 8084** <ul> 8085** <li> Put all identifier names inside double-quotes. This is the official 8086** SQL way to escape identifier names. 8087** <li> Put identifier names inside [...]. This is not standard SQL, 8088** but it is what SQL Server does and so lots of programmers use this 8089** technique. 8090** <li> Begin every identifier with the letter "Z" as no SQL keywords start 8091** with "Z". 8092** <li> Include a digit somewhere in every identifier name. 8093** </ul> 8094** 8095** Note that the number of keywords understood by SQLite can depend on 8096** compile-time options. For example, "VACUUM" is not a keyword if 8097** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also, 8098** new keywords may be added to future releases of SQLite. 8099*/ 8100int sqlite3_keyword_count(void); 8101int sqlite3_keyword_name(int,const char**,int*); 8102int sqlite3_keyword_check(const char*,int); 8103 8104/* 8105** CAPI3REF: Dynamic String Object 8106** KEYWORDS: {dynamic string} 8107** 8108** An instance of the sqlite3_str object contains a dynamically-sized 8109** string under construction. 8110** 8111** The lifecycle of an sqlite3_str object is as follows: 8112** <ol> 8113** <li> ^The sqlite3_str object is created using [sqlite3_str_new()]. 8114** <li> ^Text is appended to the sqlite3_str object using various 8115** methods, such as [sqlite3_str_appendf()]. 8116** <li> ^The sqlite3_str object is destroyed and the string it created 8117** is returned using the [sqlite3_str_finish()] interface. 8118** </ol> 8119*/ 8120typedef struct sqlite3_str sqlite3_str; 8121 8122/* 8123** CAPI3REF: Create A New Dynamic String Object 8124** CONSTRUCTOR: sqlite3_str 8125** 8126** ^The [sqlite3_str_new(D)] interface allocates and initializes 8127** a new [sqlite3_str] object. To avoid memory leaks, the object returned by 8128** [sqlite3_str_new()] must be freed by a subsequent call to 8129** [sqlite3_str_finish(X)]. 8130** 8131** ^The [sqlite3_str_new(D)] interface always returns a pointer to a 8132** valid [sqlite3_str] object, though in the event of an out-of-memory 8133** error the returned object might be a special singleton that will 8134** silently reject new text, always return SQLITE_NOMEM from 8135** [sqlite3_str_errcode()], always return 0 for 8136** [sqlite3_str_length()], and always return NULL from 8137** [sqlite3_str_finish(X)]. It is always safe to use the value 8138** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter 8139** to any of the other [sqlite3_str] methods. 8140** 8141** The D parameter to [sqlite3_str_new(D)] may be NULL. If the 8142** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum 8143** length of the string contained in the [sqlite3_str] object will be 8144** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead 8145** of [SQLITE_MAX_LENGTH]. 8146*/ 8147sqlite3_str *sqlite3_str_new(sqlite3*); 8148 8149/* 8150** CAPI3REF: Finalize A Dynamic String 8151** DESTRUCTOR: sqlite3_str 8152** 8153** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X 8154** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()] 8155** that contains the constructed string. The calling application should 8156** pass the returned value to [sqlite3_free()] to avoid a memory leak. 8157** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any 8158** errors were encountered during construction of the string. ^The 8159** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the 8160** string in [sqlite3_str] object X is zero bytes long. 8161*/ 8162char *sqlite3_str_finish(sqlite3_str*); 8163 8164/* 8165** CAPI3REF: Add Content To A Dynamic String 8166** METHOD: sqlite3_str 8167** 8168** These interfaces add content to an sqlite3_str object previously obtained 8169** from [sqlite3_str_new()]. 8170** 8171** ^The [sqlite3_str_appendf(X,F,...)] and 8172** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf] 8173** functionality of SQLite to append formatted text onto the end of 8174** [sqlite3_str] object X. 8175** 8176** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S 8177** onto the end of the [sqlite3_str] object X. N must be non-negative. 8178** S must contain at least N non-zero bytes of content. To append a 8179** zero-terminated string in its entirety, use the [sqlite3_str_appendall()] 8180** method instead. 8181** 8182** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of 8183** zero-terminated string S onto the end of [sqlite3_str] object X. 8184** 8185** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the 8186** single-byte character C onto the end of [sqlite3_str] object X. 8187** ^This method can be used, for example, to add whitespace indentation. 8188** 8189** ^The [sqlite3_str_reset(X)] method resets the string under construction 8190** inside [sqlite3_str] object X back to zero bytes in length. 8191** 8192** These methods do not return a result code. ^If an error occurs, that fact 8193** is recorded in the [sqlite3_str] object and can be recovered by a 8194** subsequent call to [sqlite3_str_errcode(X)]. 8195*/ 8196void sqlite3_str_appendf(sqlite3_str*, const char *zFormat, ...); 8197void sqlite3_str_vappendf(sqlite3_str*, const char *zFormat, va_list); 8198void sqlite3_str_append(sqlite3_str*, const char *zIn, int N); 8199void sqlite3_str_appendall(sqlite3_str*, const char *zIn); 8200void sqlite3_str_appendchar(sqlite3_str*, int N, char C); 8201void sqlite3_str_reset(sqlite3_str*); 8202 8203/* 8204** CAPI3REF: Status Of A Dynamic String 8205** METHOD: sqlite3_str 8206** 8207** These interfaces return the current status of an [sqlite3_str] object. 8208** 8209** ^If any prior errors have occurred while constructing the dynamic string 8210** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return 8211** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns 8212** [SQLITE_NOMEM] following any out-of-memory error, or 8213** [SQLITE_TOOBIG] if the size of the dynamic string exceeds 8214** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors. 8215** 8216** ^The [sqlite3_str_length(X)] method returns the current length, in bytes, 8217** of the dynamic string under construction in [sqlite3_str] object X. 8218** ^The length returned by [sqlite3_str_length(X)] does not include the 8219** zero-termination byte. 8220** 8221** ^The [sqlite3_str_value(X)] method returns a pointer to the current 8222** content of the dynamic string under construction in X. The value 8223** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X 8224** and might be freed or altered by any subsequent method on the same 8225** [sqlite3_str] object. Applications must not used the pointer returned 8226** [sqlite3_str_value(X)] after any subsequent method call on the same 8227** object. ^Applications may change the content of the string returned 8228** by [sqlite3_str_value(X)] as long as they do not write into any bytes 8229** outside the range of 0 to [sqlite3_str_length(X)] and do not read or 8230** write any byte after any subsequent sqlite3_str method call. 8231*/ 8232int sqlite3_str_errcode(sqlite3_str*); 8233int sqlite3_str_length(sqlite3_str*); 8234char *sqlite3_str_value(sqlite3_str*); 8235 8236/* 8237** CAPI3REF: SQLite Runtime Status 8238** 8239** ^These interfaces are used to retrieve runtime status information 8240** about the performance of SQLite, and optionally to reset various 8241** highwater marks. ^The first argument is an integer code for 8242** the specific parameter to measure. ^(Recognized integer codes 8243** are of the form [status parameters | SQLITE_STATUS_...].)^ 8244** ^The current value of the parameter is returned into *pCurrent. 8245** ^The highest recorded value is returned in *pHighwater. ^If the 8246** resetFlag is true, then the highest record value is reset after 8247** *pHighwater is written. ^(Some parameters do not record the highest 8248** value. For those parameters 8249** nothing is written into *pHighwater and the resetFlag is ignored.)^ 8250** ^(Other parameters record only the highwater mark and not the current 8251** value. For these latter parameters nothing is written into *pCurrent.)^ 8252** 8253** ^The sqlite3_status() and sqlite3_status64() routines return 8254** SQLITE_OK on success and a non-zero [error code] on failure. 8255** 8256** If either the current value or the highwater mark is too large to 8257** be represented by a 32-bit integer, then the values returned by 8258** sqlite3_status() are undefined. 8259** 8260** See also: [sqlite3_db_status()] 8261*/ 8262int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 8263int sqlite3_status64( 8264 int op, 8265 sqlite3_int64 *pCurrent, 8266 sqlite3_int64 *pHighwater, 8267 int resetFlag 8268); 8269 8270 8271/* 8272** CAPI3REF: Status Parameters 8273** KEYWORDS: {status parameters} 8274** 8275** These integer constants designate various run-time status parameters 8276** that can be returned by [sqlite3_status()]. 8277** 8278** <dl> 8279** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> 8280** <dd>This parameter is the current amount of memory checked out 8281** using [sqlite3_malloc()], either directly or indirectly. The 8282** figure includes calls made to [sqlite3_malloc()] by the application 8283** and internal memory usage by the SQLite library. Auxiliary page-cache 8284** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 8285** this parameter. The amount returned is the sum of the allocation 8286** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ 8287** 8288** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> 8289** <dd>This parameter records the largest memory allocation request 8290** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 8291** internal equivalents). Only the value returned in the 8292** *pHighwater parameter to [sqlite3_status()] is of interest. 8293** The value written into the *pCurrent parameter is undefined.</dd>)^ 8294** 8295** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> 8296** <dd>This parameter records the number of separate memory allocations 8297** currently checked out.</dd>)^ 8298** 8299** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> 8300** <dd>This parameter returns the number of pages used out of the 8301** [pagecache memory allocator] that was configured using 8302** [SQLITE_CONFIG_PAGECACHE]. The 8303** value returned is in pages, not in bytes.</dd>)^ 8304** 8305** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] 8306** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 8307** <dd>This parameter returns the number of bytes of page cache 8308** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] 8309** buffer and where forced to overflow to [sqlite3_malloc()]. The 8310** returned value includes allocations that overflowed because they 8311** where too large (they were larger than the "sz" parameter to 8312** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 8313** no space was left in the page cache.</dd>)^ 8314** 8315** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 8316** <dd>This parameter records the largest memory allocation request 8317** handed to the [pagecache memory allocator]. Only the value returned in the 8318** *pHighwater parameter to [sqlite3_status()] is of interest. 8319** The value written into the *pCurrent parameter is undefined.</dd>)^ 8320** 8321** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt> 8322** <dd>No longer used.</dd> 8323** 8324** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 8325** <dd>No longer used.</dd> 8326** 8327** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 8328** <dd>No longer used.</dd> 8329** 8330** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> 8331** <dd>The *pHighwater parameter records the deepest parser stack. 8332** The *pCurrent value is undefined. The *pHighwater value is only 8333** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ 8334** </dl> 8335** 8336** New status parameters may be added from time to time. 8337*/ 8338#define SQLITE_STATUS_MEMORY_USED 0 8339#define SQLITE_STATUS_PAGECACHE_USED 1 8340#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 8341#define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */ 8342#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */ 8343#define SQLITE_STATUS_MALLOC_SIZE 5 8344#define SQLITE_STATUS_PARSER_STACK 6 8345#define SQLITE_STATUS_PAGECACHE_SIZE 7 8346#define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */ 8347#define SQLITE_STATUS_MALLOC_COUNT 9 8348 8349/* 8350** CAPI3REF: Database Connection Status 8351** METHOD: sqlite3 8352** 8353** ^This interface is used to retrieve runtime status information 8354** about a single [database connection]. ^The first argument is the 8355** database connection object to be interrogated. ^The second argument 8356** is an integer constant, taken from the set of 8357** [SQLITE_DBSTATUS options], that 8358** determines the parameter to interrogate. The set of 8359** [SQLITE_DBSTATUS options] is likely 8360** to grow in future releases of SQLite. 8361** 8362** ^The current value of the requested parameter is written into *pCur 8363** and the highest instantaneous value is written into *pHiwtr. ^If 8364** the resetFlg is true, then the highest instantaneous value is 8365** reset back down to the current value. 8366** 8367** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a 8368** non-zero [error code] on failure. 8369** 8370** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 8371*/ 8372int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 8373 8374/* 8375** CAPI3REF: Status Parameters for database connections 8376** KEYWORDS: {SQLITE_DBSTATUS options} 8377** 8378** These constants are the available integer "verbs" that can be passed as 8379** the second argument to the [sqlite3_db_status()] interface. 8380** 8381** New verbs may be added in future releases of SQLite. Existing verbs 8382** might be discontinued. Applications should check the return code from 8383** [sqlite3_db_status()] to make sure that the call worked. 8384** The [sqlite3_db_status()] interface will return a non-zero error code 8385** if a discontinued or unsupported verb is invoked. 8386** 8387** <dl> 8388** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 8389** <dd>This parameter returns the number of lookaside memory slots currently 8390** checked out.</dd>)^ 8391** 8392** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> 8393** <dd>This parameter returns the number of malloc attempts that were 8394** satisfied using lookaside memory. Only the high-water value is meaningful; 8395** the current value is always zero.)^ 8396** 8397** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] 8398** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> 8399** <dd>This parameter returns the number malloc attempts that might have 8400** been satisfied using lookaside memory but failed due to the amount of 8401** memory requested being larger than the lookaside slot size. 8402** Only the high-water value is meaningful; 8403** the current value is always zero.)^ 8404** 8405** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] 8406** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> 8407** <dd>This parameter returns the number malloc attempts that might have 8408** been satisfied using lookaside memory but failed due to all lookaside 8409** memory already being in use. 8410** Only the high-water value is meaningful; 8411** the current value is always zero.)^ 8412** 8413** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> 8414** <dd>This parameter returns the approximate number of bytes of heap 8415** memory used by all pager caches associated with the database connection.)^ 8416** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. 8417** 8418** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]] 8419** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt> 8420** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a 8421** pager cache is shared between two or more connections the bytes of heap 8422** memory used by that pager cache is divided evenly between the attached 8423** connections.)^ In other words, if none of the pager caches associated 8424** with the database connection are shared, this request returns the same 8425** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are 8426** shared, the value returned by this call will be smaller than that returned 8427** by DBSTATUS_CACHE_USED. ^The highwater mark associated with 8428** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. 8429** 8430** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> 8431** <dd>This parameter returns the approximate number of bytes of heap 8432** memory used to store the schema for all databases associated 8433** with the connection - main, temp, and any [ATTACH]-ed databases.)^ 8434** ^The full amount of memory used by the schemas is reported, even if the 8435** schema memory is shared with other database connections due to 8436** [shared cache mode] being enabled. 8437** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. 8438** 8439** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> 8440** <dd>This parameter returns the approximate number of bytes of heap 8441** and lookaside memory used by all prepared statements associated with 8442** the database connection.)^ 8443** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. 8444** </dd> 8445** 8446** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> 8447** <dd>This parameter returns the number of pager cache hits that have 8448** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT 8449** is always 0. 8450** </dd> 8451** 8452** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> 8453** <dd>This parameter returns the number of pager cache misses that have 8454** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS 8455** is always 0. 8456** </dd> 8457** 8458** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt> 8459** <dd>This parameter returns the number of dirty cache entries that have 8460** been written to disk. Specifically, the number of pages written to the 8461** wal file in wal mode databases, or the number of pages written to the 8462** database file in rollback mode databases. Any pages written as part of 8463** transaction rollback or database recovery operations are not included. 8464** If an IO or other error occurs while writing a page to disk, the effect 8465** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The 8466** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. 8467** </dd> 8468** 8469** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt> 8470** <dd>This parameter returns the number of dirty cache entries that have 8471** been written to disk in the middle of a transaction due to the page 8472** cache overflowing. Transactions are more efficient if they are written 8473** to disk all at once. When pages spill mid-transaction, that introduces 8474** additional overhead. This parameter can be used help identify 8475** inefficiencies that can be resolved by increasing the cache size. 8476** </dd> 8477** 8478** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt> 8479** <dd>This parameter returns zero for the current value if and only if 8480** all foreign key constraints (deferred or immediate) have been 8481** resolved.)^ ^The highwater mark is always 0. 8482** </dd> 8483** </dl> 8484*/ 8485#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 8486#define SQLITE_DBSTATUS_CACHE_USED 1 8487#define SQLITE_DBSTATUS_SCHEMA_USED 2 8488#define SQLITE_DBSTATUS_STMT_USED 3 8489#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 8490#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 8491#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 8492#define SQLITE_DBSTATUS_CACHE_HIT 7 8493#define SQLITE_DBSTATUS_CACHE_MISS 8 8494#define SQLITE_DBSTATUS_CACHE_WRITE 9 8495#define SQLITE_DBSTATUS_DEFERRED_FKS 10 8496#define SQLITE_DBSTATUS_CACHE_USED_SHARED 11 8497#define SQLITE_DBSTATUS_CACHE_SPILL 12 8498#define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */ 8499 8500 8501/* 8502** CAPI3REF: Prepared Statement Status 8503** METHOD: sqlite3_stmt 8504** 8505** ^(Each prepared statement maintains various 8506** [SQLITE_STMTSTATUS counters] that measure the number 8507** of times it has performed specific operations.)^ These counters can 8508** be used to monitor the performance characteristics of the prepared 8509** statements. For example, if the number of table steps greatly exceeds 8510** the number of table searches or result rows, that would tend to indicate 8511** that the prepared statement is using a full table scan rather than 8512** an index. 8513** 8514** ^(This interface is used to retrieve and reset counter values from 8515** a [prepared statement]. The first argument is the prepared statement 8516** object to be interrogated. The second argument 8517** is an integer code for a specific [SQLITE_STMTSTATUS counter] 8518** to be interrogated.)^ 8519** ^The current value of the requested counter is returned. 8520** ^If the resetFlg is true, then the counter is reset to zero after this 8521** interface call returns. 8522** 8523** See also: [sqlite3_status()] and [sqlite3_db_status()]. 8524*/ 8525int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 8526 8527/* 8528** CAPI3REF: Status Parameters for prepared statements 8529** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} 8530** 8531** These preprocessor macros define integer codes that name counter 8532** values associated with the [sqlite3_stmt_status()] interface. 8533** The meanings of the various counters are as follows: 8534** 8535** <dl> 8536** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 8537** <dd>^This is the number of times that SQLite has stepped forward in 8538** a table as part of a full table scan. Large numbers for this counter 8539** may indicate opportunities for performance improvement through 8540** careful use of indices.</dd> 8541** 8542** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> 8543** <dd>^This is the number of sort operations that have occurred. 8544** A non-zero value in this counter may indicate an opportunity to 8545** improvement performance through careful use of indices.</dd> 8546** 8547** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> 8548** <dd>^This is the number of rows inserted into transient indices that 8549** were created automatically in order to help joins run faster. 8550** A non-zero value in this counter may indicate an opportunity to 8551** improvement performance by adding permanent indices that do not 8552** need to be reinitialized each time the statement is run.</dd> 8553** 8554** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt> 8555** <dd>^This is the number of virtual machine operations executed 8556** by the prepared statement if that number is less than or equal 8557** to 2147483647. The number of virtual machine operations can be 8558** used as a proxy for the total work done by the prepared statement. 8559** If the number of virtual machine operations exceeds 2147483647 8560** then the value returned by this statement status code is undefined. 8561** 8562** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt> 8563** <dd>^This is the number of times that the prepare statement has been 8564** automatically regenerated due to schema changes or changes to 8565** [bound parameters] that might affect the query plan. 8566** 8567** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt> 8568** <dd>^This is the number of times that the prepared statement has 8569** been run. A single "run" for the purposes of this counter is one 8570** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()]. 8571** The counter is incremented on the first [sqlite3_step()] call of each 8572** cycle. 8573** 8574** [[SQLITE_STMTSTATUS_FILTER_MISS]] 8575** [[SQLITE_STMTSTATUS_FILTER HIT]] 8576** <dt>SQLITE_STMTSTATUS_FILTER_HIT<br> 8577** SQLITE_STMTSTATUS_FILTER_MISS</dt> 8578** <dd>^SQLITE_STMTSTATUS_FILTER_HIT is the number of times that a join 8579** step was bypassed because a Bloom filter returned not-found. The 8580** corresponding SQLITE_STMTSTATUS_FILTER_MISS value is the number of 8581** times that the Bloom filter returned a find, and thus the join step 8582** had to be processed as normal. 8583** 8584** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt> 8585** <dd>^This is the approximate number of bytes of heap memory 8586** used to store the prepared statement. ^This value is not actually 8587** a counter, and so the resetFlg parameter to sqlite3_stmt_status() 8588** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED. 8589** </dd> 8590** </dl> 8591*/ 8592#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 8593#define SQLITE_STMTSTATUS_SORT 2 8594#define SQLITE_STMTSTATUS_AUTOINDEX 3 8595#define SQLITE_STMTSTATUS_VM_STEP 4 8596#define SQLITE_STMTSTATUS_REPREPARE 5 8597#define SQLITE_STMTSTATUS_RUN 6 8598#define SQLITE_STMTSTATUS_FILTER_MISS 7 8599#define SQLITE_STMTSTATUS_FILTER_HIT 8 8600#define SQLITE_STMTSTATUS_MEMUSED 99 8601 8602/* 8603** CAPI3REF: Custom Page Cache Object 8604** 8605** The sqlite3_pcache type is opaque. It is implemented by 8606** the pluggable module. The SQLite core has no knowledge of 8607** its size or internal structure and never deals with the 8608** sqlite3_pcache object except by holding and passing pointers 8609** to the object. 8610** 8611** See [sqlite3_pcache_methods2] for additional information. 8612*/ 8613typedef struct sqlite3_pcache sqlite3_pcache; 8614 8615/* 8616** CAPI3REF: Custom Page Cache Object 8617** 8618** The sqlite3_pcache_page object represents a single page in the 8619** page cache. The page cache will allocate instances of this 8620** object. Various methods of the page cache use pointers to instances 8621** of this object as parameters or as their return value. 8622** 8623** See [sqlite3_pcache_methods2] for additional information. 8624*/ 8625typedef struct sqlite3_pcache_page sqlite3_pcache_page; 8626struct sqlite3_pcache_page { 8627 void *pBuf; /* The content of the page */ 8628 void *pExtra; /* Extra information associated with the page */ 8629}; 8630 8631/* 8632** CAPI3REF: Application Defined Page Cache. 8633** KEYWORDS: {page cache} 8634** 8635** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can 8636** register an alternative page cache implementation by passing in an 8637** instance of the sqlite3_pcache_methods2 structure.)^ 8638** In many applications, most of the heap memory allocated by 8639** SQLite is used for the page cache. 8640** By implementing a 8641** custom page cache using this API, an application can better control 8642** the amount of memory consumed by SQLite, the way in which 8643** that memory is allocated and released, and the policies used to 8644** determine exactly which parts of a database file are cached and for 8645** how long. 8646** 8647** The alternative page cache mechanism is an 8648** extreme measure that is only needed by the most demanding applications. 8649** The built-in page cache is recommended for most uses. 8650** 8651** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an 8652** internal buffer by SQLite within the call to [sqlite3_config]. Hence 8653** the application may discard the parameter after the call to 8654** [sqlite3_config()] returns.)^ 8655** 8656** [[the xInit() page cache method]] 8657** ^(The xInit() method is called once for each effective 8658** call to [sqlite3_initialize()])^ 8659** (usually only once during the lifetime of the process). ^(The xInit() 8660** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ 8661** The intent of the xInit() method is to set up global data structures 8662** required by the custom page cache implementation. 8663** ^(If the xInit() method is NULL, then the 8664** built-in default page cache is used instead of the application defined 8665** page cache.)^ 8666** 8667** [[the xShutdown() page cache method]] 8668** ^The xShutdown() method is called by [sqlite3_shutdown()]. 8669** It can be used to clean up 8670** any outstanding resources before process shutdown, if required. 8671** ^The xShutdown() method may be NULL. 8672** 8673** ^SQLite automatically serializes calls to the xInit method, 8674** so the xInit method need not be threadsafe. ^The 8675** xShutdown method is only called from [sqlite3_shutdown()] so it does 8676** not need to be threadsafe either. All other methods must be threadsafe 8677** in multithreaded applications. 8678** 8679** ^SQLite will never invoke xInit() more than once without an intervening 8680** call to xShutdown(). 8681** 8682** [[the xCreate() page cache methods]] 8683** ^SQLite invokes the xCreate() method to construct a new cache instance. 8684** SQLite will typically create one cache instance for each open database file, 8685** though this is not guaranteed. ^The 8686** first parameter, szPage, is the size in bytes of the pages that must 8687** be allocated by the cache. ^szPage will always a power of two. ^The 8688** second parameter szExtra is a number of bytes of extra storage 8689** associated with each page cache entry. ^The szExtra parameter will 8690** a number less than 250. SQLite will use the 8691** extra szExtra bytes on each page to store metadata about the underlying 8692** database page on disk. The value passed into szExtra depends 8693** on the SQLite version, the target platform, and how SQLite was compiled. 8694** ^The third argument to xCreate(), bPurgeable, is true if the cache being 8695** created will be used to cache database pages of a file stored on disk, or 8696** false if it is used for an in-memory database. The cache implementation 8697** does not have to do anything special based with the value of bPurgeable; 8698** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will 8699** never invoke xUnpin() except to deliberately delete a page. 8700** ^In other words, calls to xUnpin() on a cache with bPurgeable set to 8701** false will always have the "discard" flag set to true. 8702** ^Hence, a cache created with bPurgeable false will 8703** never contain any unpinned pages. 8704** 8705** [[the xCachesize() page cache method]] 8706** ^(The xCachesize() method may be called at any time by SQLite to set the 8707** suggested maximum cache-size (number of pages stored by) the cache 8708** instance passed as the first argument. This is the value configured using 8709** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable 8710** parameter, the implementation is not required to do anything with this 8711** value; it is advisory only. 8712** 8713** [[the xPagecount() page cache methods]] 8714** The xPagecount() method must return the number of pages currently 8715** stored in the cache, both pinned and unpinned. 8716** 8717** [[the xFetch() page cache methods]] 8718** The xFetch() method locates a page in the cache and returns a pointer to 8719** an sqlite3_pcache_page object associated with that page, or a NULL pointer. 8720** The pBuf element of the returned sqlite3_pcache_page object will be a 8721** pointer to a buffer of szPage bytes used to store the content of a 8722** single database page. The pExtra element of sqlite3_pcache_page will be 8723** a pointer to the szExtra bytes of extra storage that SQLite has requested 8724** for each entry in the page cache. 8725** 8726** The page to be fetched is determined by the key. ^The minimum key value 8727** is 1. After it has been retrieved using xFetch, the page is considered 8728** to be "pinned". 8729** 8730** If the requested page is already in the page cache, then the page cache 8731** implementation must return a pointer to the page buffer with its content 8732** intact. If the requested page is not already in the cache, then the 8733** cache implementation should use the value of the createFlag 8734** parameter to help it determined what action to take: 8735** 8736** <table border=1 width=85% align=center> 8737** <tr><th> createFlag <th> Behavior when page is not already in cache 8738** <tr><td> 0 <td> Do not allocate a new page. Return NULL. 8739** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. 8740** Otherwise return NULL. 8741** <tr><td> 2 <td> Make every effort to allocate a new page. Only return 8742** NULL if allocating a new page is effectively impossible. 8743** </table> 8744** 8745** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite 8746** will only use a createFlag of 2 after a prior call with a createFlag of 1 8747** failed.)^ In between the xFetch() calls, SQLite may 8748** attempt to unpin one or more cache pages by spilling the content of 8749** pinned pages to disk and synching the operating system disk cache. 8750** 8751** [[the xUnpin() page cache method]] 8752** ^xUnpin() is called by SQLite with a pointer to a currently pinned page 8753** as its second argument. If the third parameter, discard, is non-zero, 8754** then the page must be evicted from the cache. 8755** ^If the discard parameter is 8756** zero, then the page may be discarded or retained at the discretion of 8757** page cache implementation. ^The page cache implementation 8758** may choose to evict unpinned pages at any time. 8759** 8760** The cache must not perform any reference counting. A single 8761** call to xUnpin() unpins the page regardless of the number of prior calls 8762** to xFetch(). 8763** 8764** [[the xRekey() page cache methods]] 8765** The xRekey() method is used to change the key value associated with the 8766** page passed as the second argument. If the cache 8767** previously contains an entry associated with newKey, it must be 8768** discarded. ^Any prior cache entry associated with newKey is guaranteed not 8769** to be pinned. 8770** 8771** When SQLite calls the xTruncate() method, the cache must discard all 8772** existing cache entries with page numbers (keys) greater than or equal 8773** to the value of the iLimit parameter passed to xTruncate(). If any 8774** of these pages are pinned, they are implicitly unpinned, meaning that 8775** they can be safely discarded. 8776** 8777** [[the xDestroy() page cache method]] 8778** ^The xDestroy() method is used to delete a cache allocated by xCreate(). 8779** All resources associated with the specified cache should be freed. ^After 8780** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 8781** handle invalid, and will not use it with any other sqlite3_pcache_methods2 8782** functions. 8783** 8784** [[the xShrink() page cache method]] 8785** ^SQLite invokes the xShrink() method when it wants the page cache to 8786** free up as much of heap memory as possible. The page cache implementation 8787** is not obligated to free any memory, but well-behaved implementations should 8788** do their best. 8789*/ 8790typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2; 8791struct sqlite3_pcache_methods2 { 8792 int iVersion; 8793 void *pArg; 8794 int (*xInit)(void*); 8795 void (*xShutdown)(void*); 8796 sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); 8797 void (*xCachesize)(sqlite3_pcache*, int nCachesize); 8798 int (*xPagecount)(sqlite3_pcache*); 8799 sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 8800 void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); 8801 void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, 8802 unsigned oldKey, unsigned newKey); 8803 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 8804 void (*xDestroy)(sqlite3_pcache*); 8805 void (*xShrink)(sqlite3_pcache*); 8806}; 8807 8808/* 8809** This is the obsolete pcache_methods object that has now been replaced 8810** by sqlite3_pcache_methods2. This object is not used by SQLite. It is 8811** retained in the header file for backwards compatibility only. 8812*/ 8813typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 8814struct sqlite3_pcache_methods { 8815 void *pArg; 8816 int (*xInit)(void*); 8817 void (*xShutdown)(void*); 8818 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 8819 void (*xCachesize)(sqlite3_pcache*, int nCachesize); 8820 int (*xPagecount)(sqlite3_pcache*); 8821 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 8822 void (*xUnpin)(sqlite3_pcache*, void*, int discard); 8823 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 8824 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 8825 void (*xDestroy)(sqlite3_pcache*); 8826}; 8827 8828 8829/* 8830** CAPI3REF: Online Backup Object 8831** 8832** The sqlite3_backup object records state information about an ongoing 8833** online backup operation. ^The sqlite3_backup object is created by 8834** a call to [sqlite3_backup_init()] and is destroyed by a call to 8835** [sqlite3_backup_finish()]. 8836** 8837** See Also: [Using the SQLite Online Backup API] 8838*/ 8839typedef struct sqlite3_backup sqlite3_backup; 8840 8841/* 8842** CAPI3REF: Online Backup API. 8843** 8844** The backup API copies the content of one database into another. 8845** It is useful either for creating backups of databases or 8846** for copying in-memory databases to or from persistent files. 8847** 8848** See Also: [Using the SQLite Online Backup API] 8849** 8850** ^SQLite holds a write transaction open on the destination database file 8851** for the duration of the backup operation. 8852** ^The source database is read-locked only while it is being read; 8853** it is not locked continuously for the entire backup operation. 8854** ^Thus, the backup may be performed on a live source database without 8855** preventing other database connections from 8856** reading or writing to the source database while the backup is underway. 8857** 8858** ^(To perform a backup operation: 8859** <ol> 8860** <li><b>sqlite3_backup_init()</b> is called once to initialize the 8861** backup, 8862** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 8863** the data between the two databases, and finally 8864** <li><b>sqlite3_backup_finish()</b> is called to release all resources 8865** associated with the backup operation. 8866** </ol>)^ 8867** There should be exactly one call to sqlite3_backup_finish() for each 8868** successful call to sqlite3_backup_init(). 8869** 8870** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> 8871** 8872** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the 8873** [database connection] associated with the destination database 8874** and the database name, respectively. 8875** ^The database name is "main" for the main database, "temp" for the 8876** temporary database, or the name specified after the AS keyword in 8877** an [ATTACH] statement for an attached database. 8878** ^The S and M arguments passed to 8879** sqlite3_backup_init(D,N,S,M) identify the [database connection] 8880** and database name of the source database, respectively. 8881** ^The source and destination [database connections] (parameters S and D) 8882** must be different or else sqlite3_backup_init(D,N,S,M) will fail with 8883** an error. 8884** 8885** ^A call to sqlite3_backup_init() will fail, returning NULL, if 8886** there is already a read or read-write transaction open on the 8887** destination database. 8888** 8889** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is 8890** returned and an error code and error message are stored in the 8891** destination [database connection] D. 8892** ^The error code and message for the failed call to sqlite3_backup_init() 8893** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or 8894** [sqlite3_errmsg16()] functions. 8895** ^A successful call to sqlite3_backup_init() returns a pointer to an 8896** [sqlite3_backup] object. 8897** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and 8898** sqlite3_backup_finish() functions to perform the specified backup 8899** operation. 8900** 8901** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> 8902** 8903** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 8904** the source and destination databases specified by [sqlite3_backup] object B. 8905** ^If N is negative, all remaining source pages are copied. 8906** ^If sqlite3_backup_step(B,N) successfully copies N pages and there 8907** are still more pages to be copied, then the function returns [SQLITE_OK]. 8908** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages 8909** from source to destination, then it returns [SQLITE_DONE]. 8910** ^If an error occurs while running sqlite3_backup_step(B,N), 8911** then an [error code] is returned. ^As well as [SQLITE_OK] and 8912** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], 8913** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an 8914** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. 8915** 8916** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if 8917** <ol> 8918** <li> the destination database was opened read-only, or 8919** <li> the destination database is using write-ahead-log journaling 8920** and the destination and source page sizes differ, or 8921** <li> the destination database is an in-memory database and the 8922** destination and source page sizes differ. 8923** </ol>)^ 8924** 8925** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then 8926** the [sqlite3_busy_handler | busy-handler function] 8927** is invoked (if one is specified). ^If the 8928** busy-handler returns non-zero before the lock is available, then 8929** [SQLITE_BUSY] is returned to the caller. ^In this case the call to 8930** sqlite3_backup_step() can be retried later. ^If the source 8931** [database connection] 8932** is being used to write to the source database when sqlite3_backup_step() 8933** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this 8934** case the call to sqlite3_backup_step() can be retried later on. ^(If 8935** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or 8936** [SQLITE_READONLY] is returned, then 8937** there is no point in retrying the call to sqlite3_backup_step(). These 8938** errors are considered fatal.)^ The application must accept 8939** that the backup operation has failed and pass the backup operation handle 8940** to the sqlite3_backup_finish() to release associated resources. 8941** 8942** ^The first call to sqlite3_backup_step() obtains an exclusive lock 8943** on the destination file. ^The exclusive lock is not released until either 8944** sqlite3_backup_finish() is called or the backup operation is complete 8945** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to 8946** sqlite3_backup_step() obtains a [shared lock] on the source database that 8947** lasts for the duration of the sqlite3_backup_step() call. 8948** ^Because the source database is not locked between calls to 8949** sqlite3_backup_step(), the source database may be modified mid-way 8950** through the backup process. ^If the source database is modified by an 8951** external process or via a database connection other than the one being 8952** used by the backup operation, then the backup will be automatically 8953** restarted by the next call to sqlite3_backup_step(). ^If the source 8954** database is modified by the using the same database connection as is used 8955** by the backup operation, then the backup database is automatically 8956** updated at the same time. 8957** 8958** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> 8959** 8960** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the 8961** application wishes to abandon the backup operation, the application 8962** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). 8963** ^The sqlite3_backup_finish() interfaces releases all 8964** resources associated with the [sqlite3_backup] object. 8965** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any 8966** active write-transaction on the destination database is rolled back. 8967** The [sqlite3_backup] object is invalid 8968** and may not be used following a call to sqlite3_backup_finish(). 8969** 8970** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no 8971** sqlite3_backup_step() errors occurred, regardless or whether or not 8972** sqlite3_backup_step() completed. 8973** ^If an out-of-memory condition or IO error occurred during any prior 8974** sqlite3_backup_step() call on the same [sqlite3_backup] object, then 8975** sqlite3_backup_finish() returns the corresponding [error code]. 8976** 8977** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() 8978** is not a permanent error and does not affect the return value of 8979** sqlite3_backup_finish(). 8980** 8981** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]] 8982** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> 8983** 8984** ^The sqlite3_backup_remaining() routine returns the number of pages still 8985** to be backed up at the conclusion of the most recent sqlite3_backup_step(). 8986** ^The sqlite3_backup_pagecount() routine returns the total number of pages 8987** in the source database at the conclusion of the most recent 8988** sqlite3_backup_step(). 8989** ^(The values returned by these functions are only updated by 8990** sqlite3_backup_step(). If the source database is modified in a way that 8991** changes the size of the source database or the number of pages remaining, 8992** those changes are not reflected in the output of sqlite3_backup_pagecount() 8993** and sqlite3_backup_remaining() until after the next 8994** sqlite3_backup_step().)^ 8995** 8996** <b>Concurrent Usage of Database Handles</b> 8997** 8998** ^The source [database connection] may be used by the application for other 8999** purposes while a backup operation is underway or being initialized. 9000** ^If SQLite is compiled and configured to support threadsafe database 9001** connections, then the source database connection may be used concurrently 9002** from within other threads. 9003** 9004** However, the application must guarantee that the destination 9005** [database connection] is not passed to any other API (by any thread) after 9006** sqlite3_backup_init() is called and before the corresponding call to 9007** sqlite3_backup_finish(). SQLite does not currently check to see 9008** if the application incorrectly accesses the destination [database connection] 9009** and so no error code is reported, but the operations may malfunction 9010** nevertheless. Use of the destination database connection while a 9011** backup is in progress might also cause a mutex deadlock. 9012** 9013** If running in [shared cache mode], the application must 9014** guarantee that the shared cache used by the destination database 9015** is not accessed while the backup is running. In practice this means 9016** that the application must guarantee that the disk file being 9017** backed up to is not accessed by any connection within the process, 9018** not just the specific connection that was passed to sqlite3_backup_init(). 9019** 9020** The [sqlite3_backup] object itself is partially threadsafe. Multiple 9021** threads may safely make multiple concurrent calls to sqlite3_backup_step(). 9022** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() 9023** APIs are not strictly speaking threadsafe. If they are invoked at the 9024** same time as another thread is invoking sqlite3_backup_step() it is 9025** possible that they return invalid values. 9026*/ 9027sqlite3_backup *sqlite3_backup_init( 9028 sqlite3 *pDest, /* Destination database handle */ 9029 const char *zDestName, /* Destination database name */ 9030 sqlite3 *pSource, /* Source database handle */ 9031 const char *zSourceName /* Source database name */ 9032); 9033int sqlite3_backup_step(sqlite3_backup *p, int nPage); 9034int sqlite3_backup_finish(sqlite3_backup *p); 9035int sqlite3_backup_remaining(sqlite3_backup *p); 9036int sqlite3_backup_pagecount(sqlite3_backup *p); 9037 9038/* 9039** CAPI3REF: Unlock Notification 9040** METHOD: sqlite3 9041** 9042** ^When running in shared-cache mode, a database operation may fail with 9043** an [SQLITE_LOCKED] error if the required locks on the shared-cache or 9044** individual tables within the shared-cache cannot be obtained. See 9045** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 9046** ^This API may be used to register a callback that SQLite will invoke 9047** when the connection currently holding the required lock relinquishes it. 9048** ^This API is only available if the library was compiled with the 9049** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. 9050** 9051** See Also: [Using the SQLite Unlock Notification Feature]. 9052** 9053** ^Shared-cache locks are released when a database connection concludes 9054** its current transaction, either by committing it or rolling it back. 9055** 9056** ^When a connection (known as the blocked connection) fails to obtain a 9057** shared-cache lock and SQLITE_LOCKED is returned to the caller, the 9058** identity of the database connection (the blocking connection) that 9059** has locked the required resource is stored internally. ^After an 9060** application receives an SQLITE_LOCKED error, it may call the 9061** sqlite3_unlock_notify() method with the blocked connection handle as 9062** the first argument to register for a callback that will be invoked 9063** when the blocking connections current transaction is concluded. ^The 9064** callback is invoked from within the [sqlite3_step] or [sqlite3_close] 9065** call that concludes the blocking connection's transaction. 9066** 9067** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, 9068** there is a chance that the blocking connection will have already 9069** concluded its transaction by the time sqlite3_unlock_notify() is invoked. 9070** If this happens, then the specified callback is invoked immediately, 9071** from within the call to sqlite3_unlock_notify().)^ 9072** 9073** ^If the blocked connection is attempting to obtain a write-lock on a 9074** shared-cache table, and more than one other connection currently holds 9075** a read-lock on the same table, then SQLite arbitrarily selects one of 9076** the other connections to use as the blocking connection. 9077** 9078** ^(There may be at most one unlock-notify callback registered by a 9079** blocked connection. If sqlite3_unlock_notify() is called when the 9080** blocked connection already has a registered unlock-notify callback, 9081** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is 9082** called with a NULL pointer as its second argument, then any existing 9083** unlock-notify callback is canceled. ^The blocked connections 9084** unlock-notify callback may also be canceled by closing the blocked 9085** connection using [sqlite3_close()]. 9086** 9087** The unlock-notify callback is not reentrant. If an application invokes 9088** any sqlite3_xxx API functions from within an unlock-notify callback, a 9089** crash or deadlock may be the result. 9090** 9091** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always 9092** returns SQLITE_OK. 9093** 9094** <b>Callback Invocation Details</b> 9095** 9096** When an unlock-notify callback is registered, the application provides a 9097** single void* pointer that is passed to the callback when it is invoked. 9098** However, the signature of the callback function allows SQLite to pass 9099** it an array of void* context pointers. The first argument passed to 9100** an unlock-notify callback is a pointer to an array of void* pointers, 9101** and the second is the number of entries in the array. 9102** 9103** When a blocking connection's transaction is concluded, there may be 9104** more than one blocked connection that has registered for an unlock-notify 9105** callback. ^If two or more such blocked connections have specified the 9106** same callback function, then instead of invoking the callback function 9107** multiple times, it is invoked once with the set of void* context pointers 9108** specified by the blocked connections bundled together into an array. 9109** This gives the application an opportunity to prioritize any actions 9110** related to the set of unblocked database connections. 9111** 9112** <b>Deadlock Detection</b> 9113** 9114** Assuming that after registering for an unlock-notify callback a 9115** database waits for the callback to be issued before taking any further 9116** action (a reasonable assumption), then using this API may cause the 9117** application to deadlock. For example, if connection X is waiting for 9118** connection Y's transaction to be concluded, and similarly connection 9119** Y is waiting on connection X's transaction, then neither connection 9120** will proceed and the system may remain deadlocked indefinitely. 9121** 9122** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock 9123** detection. ^If a given call to sqlite3_unlock_notify() would put the 9124** system in a deadlocked state, then SQLITE_LOCKED is returned and no 9125** unlock-notify callback is registered. The system is said to be in 9126** a deadlocked state if connection A has registered for an unlock-notify 9127** callback on the conclusion of connection B's transaction, and connection 9128** B has itself registered for an unlock-notify callback when connection 9129** A's transaction is concluded. ^Indirect deadlock is also detected, so 9130** the system is also considered to be deadlocked if connection B has 9131** registered for an unlock-notify callback on the conclusion of connection 9132** C's transaction, where connection C is waiting on connection A. ^Any 9133** number of levels of indirection are allowed. 9134** 9135** <b>The "DROP TABLE" Exception</b> 9136** 9137** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 9138** always appropriate to call sqlite3_unlock_notify(). There is however, 9139** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, 9140** SQLite checks if there are any currently executing SELECT statements 9141** that belong to the same connection. If there are, SQLITE_LOCKED is 9142** returned. In this case there is no "blocking connection", so invoking 9143** sqlite3_unlock_notify() results in the unlock-notify callback being 9144** invoked immediately. If the application then re-attempts the "DROP TABLE" 9145** or "DROP INDEX" query, an infinite loop might be the result. 9146** 9147** One way around this problem is to check the extended error code returned 9148** by an sqlite3_step() call. ^(If there is a blocking connection, then the 9149** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in 9150** the special "DROP TABLE/INDEX" case, the extended error code is just 9151** SQLITE_LOCKED.)^ 9152*/ 9153int sqlite3_unlock_notify( 9154 sqlite3 *pBlocked, /* Waiting connection */ 9155 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 9156 void *pNotifyArg /* Argument to pass to xNotify */ 9157); 9158 9159 9160/* 9161** CAPI3REF: String Comparison 9162** 9163** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications 9164** and extensions to compare the contents of two buffers containing UTF-8 9165** strings in a case-independent fashion, using the same definition of "case 9166** independence" that SQLite uses internally when comparing identifiers. 9167*/ 9168int sqlite3_stricmp(const char *, const char *); 9169int sqlite3_strnicmp(const char *, const char *, int); 9170 9171/* 9172** CAPI3REF: String Globbing 9173* 9174** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if 9175** string X matches the [GLOB] pattern P. 9176** ^The definition of [GLOB] pattern matching used in 9177** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the 9178** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function 9179** is case sensitive. 9180** 9181** Note that this routine returns zero on a match and non-zero if the strings 9182** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. 9183** 9184** See also: [sqlite3_strlike()]. 9185*/ 9186int sqlite3_strglob(const char *zGlob, const char *zStr); 9187 9188/* 9189** CAPI3REF: String LIKE Matching 9190* 9191** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if 9192** string X matches the [LIKE] pattern P with escape character E. 9193** ^The definition of [LIKE] pattern matching used in 9194** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E" 9195** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without 9196** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0. 9197** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case 9198** insensitive - equivalent upper and lower case ASCII characters match 9199** one another. 9200** 9201** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though 9202** only ASCII characters are case folded. 9203** 9204** Note that this routine returns zero on a match and non-zero if the strings 9205** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. 9206** 9207** See also: [sqlite3_strglob()]. 9208*/ 9209int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc); 9210 9211/* 9212** CAPI3REF: Error Logging Interface 9213** 9214** ^The [sqlite3_log()] interface writes a message into the [error log] 9215** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. 9216** ^If logging is enabled, the zFormat string and subsequent arguments are 9217** used with [sqlite3_snprintf()] to generate the final output string. 9218** 9219** The sqlite3_log() interface is intended for use by extensions such as 9220** virtual tables, collating functions, and SQL functions. While there is 9221** nothing to prevent an application from calling sqlite3_log(), doing so 9222** is considered bad form. 9223** 9224** The zFormat string must not be NULL. 9225** 9226** To avoid deadlocks and other threading problems, the sqlite3_log() routine 9227** will not use dynamically allocated memory. The log message is stored in 9228** a fixed-length buffer on the stack. If the log message is longer than 9229** a few hundred characters, it will be truncated to the length of the 9230** buffer. 9231*/ 9232void sqlite3_log(int iErrCode, const char *zFormat, ...); 9233 9234/* 9235** CAPI3REF: Write-Ahead Log Commit Hook 9236** METHOD: sqlite3 9237** 9238** ^The [sqlite3_wal_hook()] function is used to register a callback that 9239** is invoked each time data is committed to a database in wal mode. 9240** 9241** ^(The callback is invoked by SQLite after the commit has taken place and 9242** the associated write-lock on the database released)^, so the implementation 9243** may read, write or [checkpoint] the database as required. 9244** 9245** ^The first parameter passed to the callback function when it is invoked 9246** is a copy of the third parameter passed to sqlite3_wal_hook() when 9247** registering the callback. ^The second is a copy of the database handle. 9248** ^The third parameter is the name of the database that was written to - 9249** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter 9250** is the number of pages currently in the write-ahead log file, 9251** including those that were just committed. 9252** 9253** The callback function should normally return [SQLITE_OK]. ^If an error 9254** code is returned, that error will propagate back up through the 9255** SQLite code base to cause the statement that provoked the callback 9256** to report an error, though the commit will have still occurred. If the 9257** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value 9258** that does not correspond to any valid SQLite error code, the results 9259** are undefined. 9260** 9261** A single database handle may have at most a single write-ahead log callback 9262** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any 9263** previously registered write-ahead log callback. ^The return value is 9264** a copy of the third parameter from the previous call, if any, or 0. 9265** ^Note that the [sqlite3_wal_autocheckpoint()] interface and the 9266** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will 9267** overwrite any prior [sqlite3_wal_hook()] settings. 9268*/ 9269void *sqlite3_wal_hook( 9270 sqlite3*, 9271 int(*)(void *,sqlite3*,const char*,int), 9272 void* 9273); 9274 9275/* 9276** CAPI3REF: Configure an auto-checkpoint 9277** METHOD: sqlite3 9278** 9279** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around 9280** [sqlite3_wal_hook()] that causes any database on [database connection] D 9281** to automatically [checkpoint] 9282** after committing a transaction if there are N or 9283** more frames in the [write-ahead log] file. ^Passing zero or 9284** a negative value as the nFrame parameter disables automatic 9285** checkpoints entirely. 9286** 9287** ^The callback registered by this function replaces any existing callback 9288** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback 9289** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism 9290** configured by this function. 9291** 9292** ^The [wal_autocheckpoint pragma] can be used to invoke this interface 9293** from SQL. 9294** 9295** ^Checkpoints initiated by this mechanism are 9296** [sqlite3_wal_checkpoint_v2|PASSIVE]. 9297** 9298** ^Every new [database connection] defaults to having the auto-checkpoint 9299** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] 9300** pages. The use of this interface 9301** is only necessary if the default setting is found to be suboptimal 9302** for a particular application. 9303*/ 9304int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); 9305 9306/* 9307** CAPI3REF: Checkpoint a database 9308** METHOD: sqlite3 9309** 9310** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to 9311** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^ 9312** 9313** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the 9314** [write-ahead log] for database X on [database connection] D to be 9315** transferred into the database file and for the write-ahead log to 9316** be reset. See the [checkpointing] documentation for addition 9317** information. 9318** 9319** This interface used to be the only way to cause a checkpoint to 9320** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()] 9321** interface was added. This interface is retained for backwards 9322** compatibility and as a convenience for applications that need to manually 9323** start a callback but which do not need the full power (and corresponding 9324** complication) of [sqlite3_wal_checkpoint_v2()]. 9325*/ 9326int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); 9327 9328/* 9329** CAPI3REF: Checkpoint a database 9330** METHOD: sqlite3 9331** 9332** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint 9333** operation on database X of [database connection] D in mode M. Status 9334** information is written back into integers pointed to by L and C.)^ 9335** ^(The M parameter must be a valid [checkpoint mode]:)^ 9336** 9337** <dl> 9338** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> 9339** ^Checkpoint as many frames as possible without waiting for any database 9340** readers or writers to finish, then sync the database file if all frames 9341** in the log were checkpointed. ^The [busy-handler callback] 9342** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode. 9343** ^On the other hand, passive mode might leave the checkpoint unfinished 9344** if there are concurrent readers or writers. 9345** 9346** <dt>SQLITE_CHECKPOINT_FULL<dd> 9347** ^This mode blocks (it invokes the 9348** [sqlite3_busy_handler|busy-handler callback]) until there is no 9349** database writer and all readers are reading from the most recent database 9350** snapshot. ^It then checkpoints all frames in the log file and syncs the 9351** database file. ^This mode blocks new database writers while it is pending, 9352** but new database readers are allowed to continue unimpeded. 9353** 9354** <dt>SQLITE_CHECKPOINT_RESTART<dd> 9355** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition 9356** that after checkpointing the log file it blocks (calls the 9357** [busy-handler callback]) 9358** until all readers are reading from the database file only. ^This ensures 9359** that the next writer will restart the log file from the beginning. 9360** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new 9361** database writer attempts while it is pending, but does not impede readers. 9362** 9363** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd> 9364** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the 9365** addition that it also truncates the log file to zero bytes just prior 9366** to a successful return. 9367** </dl> 9368** 9369** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in 9370** the log file or to -1 if the checkpoint could not run because 9371** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not 9372** NULL,then *pnCkpt is set to the total number of checkpointed frames in the 9373** log file (including any that were already checkpointed before the function 9374** was called) or to -1 if the checkpoint could not run due to an error or 9375** because the database is not in WAL mode. ^Note that upon successful 9376** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been 9377** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero. 9378** 9379** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If 9380** any other process is running a checkpoint operation at the same time, the 9381** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a 9382** busy-handler configured, it will not be invoked in this case. 9383** 9384** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the 9385** exclusive "writer" lock on the database file. ^If the writer lock cannot be 9386** obtained immediately, and a busy-handler is configured, it is invoked and 9387** the writer lock retried until either the busy-handler returns 0 or the lock 9388** is successfully obtained. ^The busy-handler is also invoked while waiting for 9389** database readers as described above. ^If the busy-handler returns 0 before 9390** the writer lock is obtained or while waiting for database readers, the 9391** checkpoint operation proceeds from that point in the same way as 9392** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible 9393** without blocking any further. ^SQLITE_BUSY is returned in this case. 9394** 9395** ^If parameter zDb is NULL or points to a zero length string, then the 9396** specified operation is attempted on all WAL databases [attached] to 9397** [database connection] db. In this case the 9398** values written to output parameters *pnLog and *pnCkpt are undefined. ^If 9399** an SQLITE_BUSY error is encountered when processing one or more of the 9400** attached WAL databases, the operation is still attempted on any remaining 9401** attached databases and SQLITE_BUSY is returned at the end. ^If any other 9402** error occurs while processing an attached database, processing is abandoned 9403** and the error code is returned to the caller immediately. ^If no error 9404** (SQLITE_BUSY or otherwise) is encountered while processing the attached 9405** databases, SQLITE_OK is returned. 9406** 9407** ^If database zDb is the name of an attached database that is not in WAL 9408** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If 9409** zDb is not NULL (or a zero length string) and is not the name of any 9410** attached database, SQLITE_ERROR is returned to the caller. 9411** 9412** ^Unless it returns SQLITE_MISUSE, 9413** the sqlite3_wal_checkpoint_v2() interface 9414** sets the error information that is queried by 9415** [sqlite3_errcode()] and [sqlite3_errmsg()]. 9416** 9417** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface 9418** from SQL. 9419*/ 9420int sqlite3_wal_checkpoint_v2( 9421 sqlite3 *db, /* Database handle */ 9422 const char *zDb, /* Name of attached database (or NULL) */ 9423 int eMode, /* SQLITE_CHECKPOINT_* value */ 9424 int *pnLog, /* OUT: Size of WAL log in frames */ 9425 int *pnCkpt /* OUT: Total number of frames checkpointed */ 9426); 9427 9428/* 9429** CAPI3REF: Checkpoint Mode Values 9430** KEYWORDS: {checkpoint mode} 9431** 9432** These constants define all valid values for the "checkpoint mode" passed 9433** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface. 9434** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the 9435** meaning of each of these checkpoint modes. 9436*/ 9437#define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */ 9438#define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */ 9439#define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for readers */ 9440#define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */ 9441 9442/* 9443** CAPI3REF: Virtual Table Interface Configuration 9444** 9445** This function may be called by either the [xConnect] or [xCreate] method 9446** of a [virtual table] implementation to configure 9447** various facets of the virtual table interface. 9448** 9449** If this interface is invoked outside the context of an xConnect or 9450** xCreate virtual table method then the behavior is undefined. 9451** 9452** In the call sqlite3_vtab_config(D,C,...) the D parameter is the 9453** [database connection] in which the virtual table is being created and 9454** which is passed in as the first argument to the [xConnect] or [xCreate] 9455** method that is invoking sqlite3_vtab_config(). The C parameter is one 9456** of the [virtual table configuration options]. The presence and meaning 9457** of parameters after C depend on which [virtual table configuration option] 9458** is used. 9459*/ 9460int sqlite3_vtab_config(sqlite3*, int op, ...); 9461 9462/* 9463** CAPI3REF: Virtual Table Configuration Options 9464** KEYWORDS: {virtual table configuration options} 9465** KEYWORDS: {virtual table configuration option} 9466** 9467** These macros define the various options to the 9468** [sqlite3_vtab_config()] interface that [virtual table] implementations 9469** can use to customize and optimize their behavior. 9470** 9471** <dl> 9472** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]] 9473** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt> 9474** <dd>Calls of the form 9475** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, 9476** where X is an integer. If X is zero, then the [virtual table] whose 9477** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not 9478** support constraints. In this configuration (which is the default) if 9479** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire 9480** statement is rolled back as if [ON CONFLICT | OR ABORT] had been 9481** specified as part of the users SQL statement, regardless of the actual 9482** ON CONFLICT mode specified. 9483** 9484** If X is non-zero, then the virtual table implementation guarantees 9485** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before 9486** any modifications to internal or persistent data structures have been made. 9487** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite 9488** is able to roll back a statement or database transaction, and abandon 9489** or continue processing the current SQL statement as appropriate. 9490** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns 9491** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode 9492** had been ABORT. 9493** 9494** Virtual table implementations that are required to handle OR REPLACE 9495** must do so within the [xUpdate] method. If a call to the 9496** [sqlite3_vtab_on_conflict()] function indicates that the current ON 9497** CONFLICT policy is REPLACE, the virtual table implementation should 9498** silently replace the appropriate rows within the xUpdate callback and 9499** return SQLITE_OK. Or, if this is not possible, it may return 9500** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT 9501** constraint handling. 9502** </dd> 9503** 9504** [[SQLITE_VTAB_DIRECTONLY]]<dt>SQLITE_VTAB_DIRECTONLY</dt> 9505** <dd>Calls of the form 9506** [sqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the 9507** the [xConnect] or [xCreate] methods of a [virtual table] implmentation 9508** prohibits that virtual table from being used from within triggers and 9509** views. 9510** </dd> 9511** 9512** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt> 9513** <dd>Calls of the form 9514** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the 9515** the [xConnect] or [xCreate] methods of a [virtual table] implmentation 9516** identify that virtual table as being safe to use from within triggers 9517** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the 9518** virtual table can do no serious harm even if it is controlled by a 9519** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS 9520** flag unless absolutely necessary. 9521** </dd> 9522** </dl> 9523*/ 9524#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 9525#define SQLITE_VTAB_INNOCUOUS 2 9526#define SQLITE_VTAB_DIRECTONLY 3 9527 9528/* 9529** CAPI3REF: Determine The Virtual Table Conflict Policy 9530** 9531** This function may only be called from within a call to the [xUpdate] method 9532** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The 9533** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], 9534** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode 9535** of the SQL statement that triggered the call to the [xUpdate] method of the 9536** [virtual table]. 9537*/ 9538int sqlite3_vtab_on_conflict(sqlite3 *); 9539 9540/* 9541** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE 9542** 9543** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn] 9544** method of a [virtual table], then it might return true if the 9545** column is being fetched as part of an UPDATE operation during which the 9546** column value will not change. The virtual table implementation can use 9547** this hint as permission to substitute a return value that is less 9548** expensive to compute and that the corresponding 9549** [xUpdate] method understands as a "no-change" value. 9550** 9551** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that 9552** the column is not changed by the UPDATE statement, then the xColumn 9553** method can optionally return without setting a result, without calling 9554** any of the [sqlite3_result_int|sqlite3_result_xxxxx() interfaces]. 9555** In that case, [sqlite3_value_nochange(X)] will return true for the 9556** same column in the [xUpdate] method. 9557** 9558** The sqlite3_vtab_nochange() routine is an optimization. Virtual table 9559** implementations should continue to give a correct answer even if the 9560** sqlite3_vtab_nochange() interface were to always return false. In the 9561** current implementation, the sqlite3_vtab_nochange() interface does always 9562** returns false for the enhanced [UPDATE FROM] statement. 9563*/ 9564int sqlite3_vtab_nochange(sqlite3_context*); 9565 9566/* 9567** CAPI3REF: Determine The Collation For a Virtual Table Constraint 9568** METHOD: sqlite3_index_info 9569** 9570** This function may only be called from within a call to the [xBestIndex] 9571** method of a [virtual table]. This function returns a pointer to a string 9572** that is the name of the appropriate collation sequence to use for text 9573** comparisons on the constraint identified by its arguments. 9574** 9575** The first argument must be the pointer to the [sqlite3_index_info] object 9576** that is the first parameter to the xBestIndex() method. The second argument 9577** must be an index into the aConstraint[] array belonging to the 9578** sqlite3_index_info structure passed to xBestIndex. 9579** 9580** Important: 9581** The first parameter must be the same pointer that is passed into the 9582** xBestMethod() method. The first parameter may not be a pointer to a 9583** different [sqlite3_index_info] object, even an exact copy. 9584** 9585** The return value is computed as follows: 9586** 9587** <ol> 9588** <li><p> If the constraint comes from a WHERE clause expression that contains 9589** a [COLLATE operator], then the name of the collation specified by 9590** that COLLATE operator is returned. 9591** <li><p> If there is no COLLATE operator, but the column that is the subject 9592** of the constraint specifies an alternative collating sequence via 9593** a [COLLATE clause] on the column definition within the CREATE TABLE 9594** statement that was passed into [sqlite3_declare_vtab()], then the 9595** name of that alternative collating sequence is returned. 9596** <li><p> Otherwise, "BINARY" is returned. 9597** </ol> 9598*/ 9599SQLITE_EXPERIMENTAL const char *sqlite3_vtab_collation(sqlite3_index_info*,int); 9600 9601/* 9602** CAPI3REF: Determine if a virtual table query is DISTINCT 9603** METHOD: sqlite3_index_info 9604** 9605** This API may only be used from within an [xBestIndex|xBestIndex method] 9606** of a [virtual table] implementation. The result of calling this 9607** interface from outside of xBestIndex() is undefined and probably harmful. 9608** 9609** ^The sqlite3_vtab_distinct() interface returns an integer between 0 and 9610** 3. The integer returned by sqlite3_vtab_distinct() 9611** gives the virtual table additional information about how the query 9612** planner wants the output to be ordered. As long as the virtual table 9613** can meet the ordering requirements of the query planner, it may set 9614** the "orderByConsumed" flag. 9615** 9616** <ol><li value="0"><p> 9617** ^If the sqlite3_vtab_distinct() interface returns 0, that means 9618** that the query planner needs the virtual table to return all rows in the 9619** sort order defined by the "nOrderBy" and "aOrderBy" fields of the 9620** [sqlite3_index_info] object. This is the default expectation. If the 9621** virtual table outputs all rows in sorted order, then it is always safe for 9622** the xBestIndex method to set the "orderByConsumed" flag, regardless of 9623** the return value from sqlite3_vtab_distinct(). 9624** <li value="1"><p> 9625** ^(If the sqlite3_vtab_distinct() interface returns 1, that means 9626** that the query planner does not need the rows to be returned in sorted order 9627** as long as all rows with the same values in all columns identified by the 9628** "aOrderBy" field are adjacent.)^ This mode is used when the query planner 9629** is doing a GROUP BY. 9630** <li value="2"><p> 9631** ^(If the sqlite3_vtab_distinct() interface returns 2, that means 9632** that the query planner does not need the rows returned in any particular 9633** order, as long as rows with the same values in all "aOrderBy" columns 9634** are adjacent.)^ ^(Furthermore, only a single row for each particular 9635** combination of values in the columns identified by the "aOrderBy" field 9636** needs to be returned.)^ ^It is always ok for two or more rows with the same 9637** values in all "aOrderBy" columns to be returned, as long as all such rows 9638** are adjacent. ^The virtual table may, if it chooses, omit extra rows 9639** that have the same value for all columns identified by "aOrderBy". 9640** ^However omitting the extra rows is optional. 9641** This mode is used for a DISTINCT query. 9642** <li value="3"><p> 9643** ^(If the sqlite3_vtab_distinct() interface returns 3, that means 9644** that the query planner needs only distinct rows but it does need the 9645** rows to be sorted.)^ ^The virtual table implementation is free to omit 9646** rows that are identical in all aOrderBy columns, if it wants to, but 9647** it is not required to omit any rows. This mode is used for queries 9648** that have both DISTINCT and ORDER BY clauses. 9649** </ol> 9650** 9651** ^For the purposes of comparing virtual table output values to see if the 9652** values are same value for sorting purposes, two NULL values are considered 9653** to be the same. In other words, the comparison operator is "IS" 9654** (or "IS NOT DISTINCT FROM") and not "==". 9655** 9656** If a virtual table implementation is unable to meet the requirements 9657** specified above, then it must not set the "orderByConsumed" flag in the 9658** [sqlite3_index_info] object or an incorrect answer may result. 9659** 9660** ^A virtual table implementation is always free to return rows in any order 9661** it wants, as long as the "orderByConsumed" flag is not set. ^When the 9662** the "orderByConsumed" flag is unset, the query planner will add extra 9663** [bytecode] to ensure that the final results returned by the SQL query are 9664** ordered correctly. The use of the "orderByConsumed" flag and the 9665** sqlite3_vtab_distinct() interface is merely an optimization. ^Careful 9666** use of the sqlite3_vtab_distinct() interface and the "orderByConsumed" 9667** flag might help queries against a virtual table to run faster. Being 9668** overly aggressive and setting the "orderByConsumed" flag when it is not 9669** valid to do so, on the other hand, might cause SQLite to return incorrect 9670** results. 9671*/ 9672int sqlite3_vtab_distinct(sqlite3_index_info*); 9673 9674/* 9675** CAPI3REF: Identify and handle IN constraints in xBestIndex 9676** 9677** This interface may only be used from within an 9678** [xBestIndex|xBestIndex() method] of a [virtual table] implementation. 9679** The result of invoking this interface from any other context is 9680** undefined and probably harmful. 9681** 9682** ^(A constraint on a virtual table of the form 9683** "[IN operator|column IN (...)]" is 9684** communicated to the xBestIndex method as a 9685** [SQLITE_INDEX_CONSTRAINT_EQ] constraint.)^ If xBestIndex wants to use 9686** this constraint, it must set the corresponding 9687** aConstraintUsage[].argvIndex to a postive integer. ^(Then, under 9688** the usual mode of handling IN operators, SQLite generates [bytecode] 9689** that invokes the [xFilter|xFilter() method] once for each value 9690** on the right-hand side of the IN operator.)^ Thus the virtual table 9691** only sees a single value from the right-hand side of the IN operator 9692** at a time. 9693** 9694** In some cases, however, it would be advantageous for the virtual 9695** table to see all values on the right-hand of the IN operator all at 9696** once. The sqlite3_vtab_in() interfaces facilitates this in two ways: 9697** 9698** <ol> 9699** <li><p> 9700** ^A call to sqlite3_vtab_in(P,N,-1) will return true (non-zero) 9701** if and only if the [sqlite3_index_info|P->aConstraint][N] constraint 9702** is an [IN operator] that can be processed all at once. ^In other words, 9703** sqlite3_vtab_in() with -1 in the third argument is a mechanism 9704** by which the virtual table can ask SQLite if all-at-once processing 9705** of the IN operator is even possible. 9706** 9707** <li><p> 9708** ^A call to sqlite3_vtab_in(P,N,F) with F==1 or F==0 indicates 9709** to SQLite that the virtual table does or does not want to process 9710** the IN operator all-at-once, respectively. ^Thus when the third 9711** parameter (F) is non-negative, this interface is the mechanism by 9712** which the virtual table tells SQLite how it wants to process the 9713** IN operator. 9714** </ol> 9715** 9716** ^The sqlite3_vtab_in(P,N,F) interface can be invoked multiple times 9717** within the same xBestIndex method call. ^For any given P,N pair, 9718** the return value from sqlite3_vtab_in(P,N,F) will always be the same 9719** within the same xBestIndex call. ^If the interface returns true 9720** (non-zero), that means that the constraint is an IN operator 9721** that can be processed all-at-once. ^If the constraint is not an IN 9722** operator or cannot be processed all-at-once, then the interface returns 9723** false. 9724** 9725** ^(All-at-once processing of the IN operator is selected if both of the 9726** following conditions are met: 9727** 9728** <ol> 9729** <li><p> The P->aConstraintUsage[N].argvIndex value is set to a positive 9730** integer. This is how the virtual table tells SQLite that it wants to 9731** use the N-th constraint. 9732** 9733** <li><p> The last call to sqlite3_vtab_in(P,N,F) for which F was 9734** non-negative had F>=1. 9735** </ol>)^ 9736** 9737** ^If either or both of the conditions above are false, then SQLite uses 9738** the traditional one-at-a-time processing strategy for the IN constraint. 9739** ^If both conditions are true, then the argvIndex-th parameter to the 9740** xFilter method will be an [sqlite3_value] that appears to be NULL, 9741** but which can be passed to [sqlite3_vtab_in_first()] and 9742** [sqlite3_vtab_in_next()] to find all values on the right-hand side 9743** of the IN constraint. 9744*/ 9745int sqlite3_vtab_in(sqlite3_index_info*, int iCons, int bHandle); 9746 9747/* 9748** CAPI3REF: Find all elements on the right-hand side of an IN constraint. 9749** 9750** These interfaces are only useful from within the 9751** [xFilter|xFilter() method] of a [virtual table] implementation. 9752** The result of invoking these interfaces from any other context 9753** is undefined and probably harmful. 9754** 9755** The X parameter in a call to sqlite3_vtab_in_first(X,P) or 9756** sqlite3_vtab_in_next(X,P) must be one of the parameters to the 9757** xFilter method which invokes these routines, and specifically 9758** a parameter that was previously selected for all-at-once IN constraint 9759** processing use the [sqlite3_vtab_in()] interface in the 9760** [xBestIndex|xBestIndex method]. ^(If the X parameter is not 9761** an xFilter argument that was selected for all-at-once IN constraint 9762** processing, then these routines return [SQLITE_MISUSE])^ or perhaps 9763** exhibit some other undefined or harmful behavior. 9764** 9765** ^(Use these routines to access all values on the right-hand side 9766** of the IN constraint using code like the following: 9767** 9768** <blockquote><pre> 9769** for(rc=sqlite3_vtab_in_first(pList, &pVal); 9770** rc==SQLITE_OK && pVal 9771** rc=sqlite3_vtab_in_next(pList, &pVal) 9772** ){ 9773** // do something with pVal 9774** } 9775** if( rc!=SQLITE_OK ){ 9776** // an error has occurred 9777** } 9778** </pre></blockquote>)^ 9779** 9780** ^On success, the sqlite3_vtab_in_first(X,P) and sqlite3_vtab_in_next(X,P) 9781** routines return SQLITE_OK and set *P to point to the first or next value 9782** on the RHS of the IN constraint. ^If there are no more values on the 9783** right hand side of the IN constraint, then *P is set to NULL and these 9784** routines return [SQLITE_DONE]. ^The return value might be 9785** some other value, such as SQLITE_NOMEM, in the event of a malfunction. 9786** 9787** The *ppOut values returned by these routines are only valid until the 9788** next call to either of these routines or until the end of the xFilter 9789** method from which these routines were called. If the virtual table 9790** implementation needs to retain the *ppOut values for longer, it must make 9791** copies. The *ppOut values are [protected sqlite3_value|protected]. 9792*/ 9793int sqlite3_vtab_in_first(sqlite3_value *pVal, sqlite3_value **ppOut); 9794int sqlite3_vtab_in_next(sqlite3_value *pVal, sqlite3_value **ppOut); 9795 9796/* 9797** CAPI3REF: Constraint values in xBestIndex() 9798** METHOD: sqlite3_index_info 9799** 9800** This API may only be used from within the [xBestIndex|xBestIndex method] 9801** of a [virtual table] implementation. The result of calling this interface 9802** from outside of an xBestIndex method are undefined and probably harmful. 9803** 9804** ^When the sqlite3_vtab_rhs_value(P,J,V) interface is invoked from within 9805** the [xBestIndex] method of a [virtual table] implementation, with P being 9806** a copy of the [sqlite3_index_info] object pointer passed into xBestIndex and 9807** J being a 0-based index into P->aConstraint[], then this routine 9808** attempts to set *V to the value of the right-hand operand of 9809** that constraint if the right-hand operand is known. ^If the 9810** right-hand operand is not known, then *V is set to a NULL pointer. 9811** ^The sqlite3_vtab_rhs_value(P,J,V) interface returns SQLITE_OK if 9812** and only if *V is set to a value. ^The sqlite3_vtab_rhs_value(P,J,V) 9813** inteface returns SQLITE_NOTFOUND if the right-hand side of the J-th 9814** constraint is not available. ^The sqlite3_vtab_rhs_value() interface 9815** can return an result code other than SQLITE_OK or SQLITE_NOTFOUND if 9816** something goes wrong. 9817** 9818** The sqlite3_vtab_rhs_value() interface is usually only successful if 9819** the right-hand operand of a constraint is a literal value in the original 9820** SQL statement. If the right-hand operand is an expression or a reference 9821** to some other column or a [host parameter], then sqlite3_vtab_rhs_value() 9822** will probably return [SQLITE_NOTFOUND]. 9823** 9824** ^(Some constraints, such as [SQLITE_INDEX_CONSTRAINT_ISNULL] and 9825** [SQLITE_INDEX_CONSTRAINT_ISNOTNULL], have no right-hand operand. For such 9826** constraints, sqlite3_vtab_rhs_value() always returns SQLITE_NOTFOUND.)^ 9827** 9828** ^The [sqlite3_value] object returned in *V is a protected sqlite3_value 9829** and remains valid for the duration of the xBestIndex method call. 9830** ^When xBestIndex returns, the sqlite3_value object returned by 9831** sqlite3_vtab_rhs_value() is automatically deallocated. 9832** 9833** The "_rhs_" in the name of this routine is an abbreviation for 9834** "Right-Hand Side". 9835*/ 9836int sqlite3_vtab_rhs_value(sqlite3_index_info*, int, sqlite3_value **ppVal); 9837 9838/* 9839** CAPI3REF: Conflict resolution modes 9840** KEYWORDS: {conflict resolution mode} 9841** 9842** These constants are returned by [sqlite3_vtab_on_conflict()] to 9843** inform a [virtual table] implementation what the [ON CONFLICT] mode 9844** is for the SQL statement being evaluated. 9845** 9846** Note that the [SQLITE_IGNORE] constant is also used as a potential 9847** return value from the [sqlite3_set_authorizer()] callback and that 9848** [SQLITE_ABORT] is also a [result code]. 9849*/ 9850#define SQLITE_ROLLBACK 1 9851/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ 9852#define SQLITE_FAIL 3 9853/* #define SQLITE_ABORT 4 // Also an error code */ 9854#define SQLITE_REPLACE 5 9855 9856/* 9857** CAPI3REF: Prepared Statement Scan Status Opcodes 9858** KEYWORDS: {scanstatus options} 9859** 9860** The following constants can be used for the T parameter to the 9861** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a 9862** different metric for sqlite3_stmt_scanstatus() to return. 9863** 9864** When the value returned to V is a string, space to hold that string is 9865** managed by the prepared statement S and will be automatically freed when 9866** S is finalized. 9867** 9868** <dl> 9869** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt> 9870** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be 9871** set to the total number of times that the X-th loop has run.</dd> 9872** 9873** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt> 9874** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be set 9875** to the total number of rows examined by all iterations of the X-th loop.</dd> 9876** 9877** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt> 9878** <dd>^The "double" variable pointed to by the V parameter will be set to the 9879** query planner's estimate for the average number of rows output from each 9880** iteration of the X-th loop. If the query planner's estimates was accurate, 9881** then this value will approximate the quotient NVISIT/NLOOP and the 9882** product of this value for all prior loops with the same SELECTID will 9883** be the NLOOP value for the current loop. 9884** 9885** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt> 9886** <dd>^The "const char *" variable pointed to by the V parameter will be set 9887** to a zero-terminated UTF-8 string containing the name of the index or table 9888** used for the X-th loop. 9889** 9890** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt> 9891** <dd>^The "const char *" variable pointed to by the V parameter will be set 9892** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] 9893** description for the X-th loop. 9894** 9895** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt> 9896** <dd>^The "int" variable pointed to by the V parameter will be set to the 9897** "select-id" for the X-th loop. The select-id identifies which query or 9898** subquery the loop is part of. The main query has a select-id of zero. 9899** The select-id is the same value as is output in the first column 9900** of an [EXPLAIN QUERY PLAN] query. 9901** </dl> 9902*/ 9903#define SQLITE_SCANSTAT_NLOOP 0 9904#define SQLITE_SCANSTAT_NVISIT 1 9905#define SQLITE_SCANSTAT_EST 2 9906#define SQLITE_SCANSTAT_NAME 3 9907#define SQLITE_SCANSTAT_EXPLAIN 4 9908#define SQLITE_SCANSTAT_SELECTID 5 9909 9910/* 9911** CAPI3REF: Prepared Statement Scan Status 9912** METHOD: sqlite3_stmt 9913** 9914** This interface returns information about the predicted and measured 9915** performance for pStmt. Advanced applications can use this 9916** interface to compare the predicted and the measured performance and 9917** issue warnings and/or rerun [ANALYZE] if discrepancies are found. 9918** 9919** Since this interface is expected to be rarely used, it is only 9920** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS] 9921** compile-time option. 9922** 9923** The "iScanStatusOp" parameter determines which status information to return. 9924** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior 9925** of this interface is undefined. 9926** ^The requested measurement is written into a variable pointed to by 9927** the "pOut" parameter. 9928** Parameter "idx" identifies the specific loop to retrieve statistics for. 9929** Loops are numbered starting from zero. ^If idx is out of range - less than 9930** zero or greater than or equal to the total number of loops used to implement 9931** the statement - a non-zero value is returned and the variable that pOut 9932** points to is unchanged. 9933** 9934** ^Statistics might not be available for all loops in all statements. ^In cases 9935** where there exist loops with no available statistics, this function behaves 9936** as if the loop did not exist - it returns non-zero and leave the variable 9937** that pOut points to unchanged. 9938** 9939** See also: [sqlite3_stmt_scanstatus_reset()] 9940*/ 9941int sqlite3_stmt_scanstatus( 9942 sqlite3_stmt *pStmt, /* Prepared statement for which info desired */ 9943 int idx, /* Index of loop to report on */ 9944 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */ 9945 void *pOut /* Result written here */ 9946); 9947 9948/* 9949** CAPI3REF: Zero Scan-Status Counters 9950** METHOD: sqlite3_stmt 9951** 9952** ^Zero all [sqlite3_stmt_scanstatus()] related event counters. 9953** 9954** This API is only available if the library is built with pre-processor 9955** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined. 9956*/ 9957void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*); 9958 9959/* 9960** CAPI3REF: Flush caches to disk mid-transaction 9961** METHOD: sqlite3 9962** 9963** ^If a write-transaction is open on [database connection] D when the 9964** [sqlite3_db_cacheflush(D)] interface invoked, any dirty 9965** pages in the pager-cache that are not currently in use are written out 9966** to disk. A dirty page may be in use if a database cursor created by an 9967** active SQL statement is reading from it, or if it is page 1 of a database 9968** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)] 9969** interface flushes caches for all schemas - "main", "temp", and 9970** any [attached] databases. 9971** 9972** ^If this function needs to obtain extra database locks before dirty pages 9973** can be flushed to disk, it does so. ^If those locks cannot be obtained 9974** immediately and there is a busy-handler callback configured, it is invoked 9975** in the usual manner. ^If the required lock still cannot be obtained, then 9976** the database is skipped and an attempt made to flush any dirty pages 9977** belonging to the next (if any) database. ^If any databases are skipped 9978** because locks cannot be obtained, but no other error occurs, this 9979** function returns SQLITE_BUSY. 9980** 9981** ^If any other error occurs while flushing dirty pages to disk (for 9982** example an IO error or out-of-memory condition), then processing is 9983** abandoned and an SQLite [error code] is returned to the caller immediately. 9984** 9985** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK. 9986** 9987** ^This function does not set the database handle error code or message 9988** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions. 9989*/ 9990int sqlite3_db_cacheflush(sqlite3*); 9991 9992/* 9993** CAPI3REF: The pre-update hook. 9994** METHOD: sqlite3 9995** 9996** ^These interfaces are only available if SQLite is compiled using the 9997** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option. 9998** 9999** ^The [sqlite3_preupdate_hook()] interface registers a callback function 10000** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation 10001** on a database table. 10002** ^At most one preupdate hook may be registered at a time on a single 10003** [database connection]; each call to [sqlite3_preupdate_hook()] overrides 10004** the previous setting. 10005** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()] 10006** with a NULL pointer as the second parameter. 10007** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as 10008** the first parameter to callbacks. 10009** 10010** ^The preupdate hook only fires for changes to real database tables; the 10011** preupdate hook is not invoked for changes to [virtual tables] or to 10012** system tables like sqlite_sequence or sqlite_stat1. 10013** 10014** ^The second parameter to the preupdate callback is a pointer to 10015** the [database connection] that registered the preupdate hook. 10016** ^The third parameter to the preupdate callback is one of the constants 10017** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the 10018** kind of update operation that is about to occur. 10019** ^(The fourth parameter to the preupdate callback is the name of the 10020** database within the database connection that is being modified. This 10021** will be "main" for the main database or "temp" for TEMP tables or 10022** the name given after the AS keyword in the [ATTACH] statement for attached 10023** databases.)^ 10024** ^The fifth parameter to the preupdate callback is the name of the 10025** table that is being modified. 10026** 10027** For an UPDATE or DELETE operation on a [rowid table], the sixth 10028** parameter passed to the preupdate callback is the initial [rowid] of the 10029** row being modified or deleted. For an INSERT operation on a rowid table, 10030** or any operation on a WITHOUT ROWID table, the value of the sixth 10031** parameter is undefined. For an INSERT or UPDATE on a rowid table the 10032** seventh parameter is the final rowid value of the row being inserted 10033** or updated. The value of the seventh parameter passed to the callback 10034** function is not defined for operations on WITHOUT ROWID tables, or for 10035** DELETE operations on rowid tables. 10036** 10037** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()], 10038** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces 10039** provide additional information about a preupdate event. These routines 10040** may only be called from within a preupdate callback. Invoking any of 10041** these routines from outside of a preupdate callback or with a 10042** [database connection] pointer that is different from the one supplied 10043** to the preupdate callback results in undefined and probably undesirable 10044** behavior. 10045** 10046** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns 10047** in the row that is being inserted, updated, or deleted. 10048** 10049** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to 10050** a [protected sqlite3_value] that contains the value of the Nth column of 10051** the table row before it is updated. The N parameter must be between 0 10052** and one less than the number of columns or the behavior will be 10053** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE 10054** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the 10055** behavior is undefined. The [sqlite3_value] that P points to 10056** will be destroyed when the preupdate callback returns. 10057** 10058** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to 10059** a [protected sqlite3_value] that contains the value of the Nth column of 10060** the table row after it is updated. The N parameter must be between 0 10061** and one less than the number of columns or the behavior will be 10062** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE 10063** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the 10064** behavior is undefined. The [sqlite3_value] that P points to 10065** will be destroyed when the preupdate callback returns. 10066** 10067** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate 10068** callback was invoked as a result of a direct insert, update, or delete 10069** operation; or 1 for inserts, updates, or deletes invoked by top-level 10070** triggers; or 2 for changes resulting from triggers called by top-level 10071** triggers; and so forth. 10072** 10073** When the [sqlite3_blob_write()] API is used to update a blob column, 10074** the pre-update hook is invoked with SQLITE_DELETE. This is because the 10075** in this case the new values are not available. In this case, when a 10076** callback made with op==SQLITE_DELETE is actuall a write using the 10077** sqlite3_blob_write() API, the [sqlite3_preupdate_blobwrite()] returns 10078** the index of the column being written. In other cases, where the 10079** pre-update hook is being invoked for some other reason, including a 10080** regular DELETE, sqlite3_preupdate_blobwrite() returns -1. 10081** 10082** See also: [sqlite3_update_hook()] 10083*/ 10084#if defined(SQLITE_ENABLE_PREUPDATE_HOOK) 10085void *sqlite3_preupdate_hook( 10086 sqlite3 *db, 10087 void(*xPreUpdate)( 10088 void *pCtx, /* Copy of third arg to preupdate_hook() */ 10089 sqlite3 *db, /* Database handle */ 10090 int op, /* SQLITE_UPDATE, DELETE or INSERT */ 10091 char const *zDb, /* Database name */ 10092 char const *zName, /* Table name */ 10093 sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */ 10094 sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */ 10095 ), 10096 void* 10097); 10098int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **); 10099int sqlite3_preupdate_count(sqlite3 *); 10100int sqlite3_preupdate_depth(sqlite3 *); 10101int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **); 10102int sqlite3_preupdate_blobwrite(sqlite3 *); 10103#endif 10104 10105/* 10106** CAPI3REF: Low-level system error code 10107** METHOD: sqlite3 10108** 10109** ^Attempt to return the underlying operating system error code or error 10110** number that caused the most recent I/O error or failure to open a file. 10111** The return value is OS-dependent. For example, on unix systems, after 10112** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be 10113** called to get back the underlying "errno" that caused the problem, such 10114** as ENOSPC, EAUTH, EISDIR, and so forth. 10115*/ 10116int sqlite3_system_errno(sqlite3*); 10117 10118/* 10119** CAPI3REF: Database Snapshot 10120** KEYWORDS: {snapshot} {sqlite3_snapshot} 10121** 10122** An instance of the snapshot object records the state of a [WAL mode] 10123** database for some specific point in history. 10124** 10125** In [WAL mode], multiple [database connections] that are open on the 10126** same database file can each be reading a different historical version 10127** of the database file. When a [database connection] begins a read 10128** transaction, that connection sees an unchanging copy of the database 10129** as it existed for the point in time when the transaction first started. 10130** Subsequent changes to the database from other connections are not seen 10131** by the reader until a new read transaction is started. 10132** 10133** The sqlite3_snapshot object records state information about an historical 10134** version of the database file so that it is possible to later open a new read 10135** transaction that sees that historical version of the database rather than 10136** the most recent version. 10137*/ 10138typedef struct sqlite3_snapshot { 10139 unsigned char hidden[48]; 10140} sqlite3_snapshot; 10141 10142/* 10143** CAPI3REF: Record A Database Snapshot 10144** CONSTRUCTOR: sqlite3_snapshot 10145** 10146** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a 10147** new [sqlite3_snapshot] object that records the current state of 10148** schema S in database connection D. ^On success, the 10149** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly 10150** created [sqlite3_snapshot] object into *P and returns SQLITE_OK. 10151** If there is not already a read-transaction open on schema S when 10152** this function is called, one is opened automatically. 10153** 10154** The following must be true for this function to succeed. If any of 10155** the following statements are false when sqlite3_snapshot_get() is 10156** called, SQLITE_ERROR is returned. The final value of *P is undefined 10157** in this case. 10158** 10159** <ul> 10160** <li> The database handle must not be in [autocommit mode]. 10161** 10162** <li> Schema S of [database connection] D must be a [WAL mode] database. 10163** 10164** <li> There must not be a write transaction open on schema S of database 10165** connection D. 10166** 10167** <li> One or more transactions must have been written to the current wal 10168** file since it was created on disk (by any connection). This means 10169** that a snapshot cannot be taken on a wal mode database with no wal 10170** file immediately after it is first opened. At least one transaction 10171** must be written to it first. 10172** </ul> 10173** 10174** This function may also return SQLITE_NOMEM. If it is called with the 10175** database handle in autocommit mode but fails for some other reason, 10176** whether or not a read transaction is opened on schema S is undefined. 10177** 10178** The [sqlite3_snapshot] object returned from a successful call to 10179** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()] 10180** to avoid a memory leak. 10181** 10182** The [sqlite3_snapshot_get()] interface is only available when the 10183** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. 10184*/ 10185SQLITE_EXPERIMENTAL int sqlite3_snapshot_get( 10186 sqlite3 *db, 10187 const char *zSchema, 10188 sqlite3_snapshot **ppSnapshot 10189); 10190 10191/* 10192** CAPI3REF: Start a read transaction on an historical snapshot 10193** METHOD: sqlite3_snapshot 10194** 10195** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read 10196** transaction or upgrades an existing one for schema S of 10197** [database connection] D such that the read transaction refers to 10198** historical [snapshot] P, rather than the most recent change to the 10199** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK 10200** on success or an appropriate [error code] if it fails. 10201** 10202** ^In order to succeed, the database connection must not be in 10203** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there 10204** is already a read transaction open on schema S, then the database handle 10205** must have no active statements (SELECT statements that have been passed 10206** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()). 10207** SQLITE_ERROR is returned if either of these conditions is violated, or 10208** if schema S does not exist, or if the snapshot object is invalid. 10209** 10210** ^A call to sqlite3_snapshot_open() will fail to open if the specified 10211** snapshot has been overwritten by a [checkpoint]. In this case 10212** SQLITE_ERROR_SNAPSHOT is returned. 10213** 10214** If there is already a read transaction open when this function is 10215** invoked, then the same read transaction remains open (on the same 10216** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT 10217** is returned. If another error code - for example SQLITE_PROTOCOL or an 10218** SQLITE_IOERR error code - is returned, then the final state of the 10219** read transaction is undefined. If SQLITE_OK is returned, then the 10220** read transaction is now open on database snapshot P. 10221** 10222** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the 10223** database connection D does not know that the database file for 10224** schema S is in [WAL mode]. A database connection might not know 10225** that the database file is in [WAL mode] if there has been no prior 10226** I/O on that database connection, or if the database entered [WAL mode] 10227** after the most recent I/O on the database connection.)^ 10228** (Hint: Run "[PRAGMA application_id]" against a newly opened 10229** database connection in order to make it ready to use snapshots.) 10230** 10231** The [sqlite3_snapshot_open()] interface is only available when the 10232** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. 10233*/ 10234SQLITE_EXPERIMENTAL int sqlite3_snapshot_open( 10235 sqlite3 *db, 10236 const char *zSchema, 10237 sqlite3_snapshot *pSnapshot 10238); 10239 10240/* 10241** CAPI3REF: Destroy a snapshot 10242** DESTRUCTOR: sqlite3_snapshot 10243** 10244** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P. 10245** The application must eventually free every [sqlite3_snapshot] object 10246** using this routine to avoid a memory leak. 10247** 10248** The [sqlite3_snapshot_free()] interface is only available when the 10249** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. 10250*/ 10251SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*); 10252 10253/* 10254** CAPI3REF: Compare the ages of two snapshot handles. 10255** METHOD: sqlite3_snapshot 10256** 10257** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages 10258** of two valid snapshot handles. 10259** 10260** If the two snapshot handles are not associated with the same database 10261** file, the result of the comparison is undefined. 10262** 10263** Additionally, the result of the comparison is only valid if both of the 10264** snapshot handles were obtained by calling sqlite3_snapshot_get() since the 10265** last time the wal file was deleted. The wal file is deleted when the 10266** database is changed back to rollback mode or when the number of database 10267** clients drops to zero. If either snapshot handle was obtained before the 10268** wal file was last deleted, the value returned by this function 10269** is undefined. 10270** 10271** Otherwise, this API returns a negative value if P1 refers to an older 10272** snapshot than P2, zero if the two handles refer to the same database 10273** snapshot, and a positive value if P1 is a newer snapshot than P2. 10274** 10275** This interface is only available if SQLite is compiled with the 10276** [SQLITE_ENABLE_SNAPSHOT] option. 10277*/ 10278SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp( 10279 sqlite3_snapshot *p1, 10280 sqlite3_snapshot *p2 10281); 10282 10283/* 10284** CAPI3REF: Recover snapshots from a wal file 10285** METHOD: sqlite3_snapshot 10286** 10287** If a [WAL file] remains on disk after all database connections close 10288** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control] 10289** or because the last process to have the database opened exited without 10290** calling [sqlite3_close()]) and a new connection is subsequently opened 10291** on that database and [WAL file], the [sqlite3_snapshot_open()] interface 10292** will only be able to open the last transaction added to the WAL file 10293** even though the WAL file contains other valid transactions. 10294** 10295** This function attempts to scan the WAL file associated with database zDb 10296** of database handle db and make all valid snapshots available to 10297** sqlite3_snapshot_open(). It is an error if there is already a read 10298** transaction open on the database, or if the database is not a WAL mode 10299** database. 10300** 10301** SQLITE_OK is returned if successful, or an SQLite error code otherwise. 10302** 10303** This interface is only available if SQLite is compiled with the 10304** [SQLITE_ENABLE_SNAPSHOT] option. 10305*/ 10306SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb); 10307 10308/* 10309** CAPI3REF: Serialize a database 10310** 10311** The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory 10312** that is a serialization of the S database on [database connection] D. 10313** If P is not a NULL pointer, then the size of the database in bytes 10314** is written into *P. 10315** 10316** For an ordinary on-disk database file, the serialization is just a 10317** copy of the disk file. For an in-memory database or a "TEMP" database, 10318** the serialization is the same sequence of bytes which would be written 10319** to disk if that database where backed up to disk. 10320** 10321** The usual case is that sqlite3_serialize() copies the serialization of 10322** the database into memory obtained from [sqlite3_malloc64()] and returns 10323** a pointer to that memory. The caller is responsible for freeing the 10324** returned value to avoid a memory leak. However, if the F argument 10325** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations 10326** are made, and the sqlite3_serialize() function will return a pointer 10327** to the contiguous memory representation of the database that SQLite 10328** is currently using for that database, or NULL if the no such contiguous 10329** memory representation of the database exists. A contiguous memory 10330** representation of the database will usually only exist if there has 10331** been a prior call to [sqlite3_deserialize(D,S,...)] with the same 10332** values of D and S. 10333** The size of the database is written into *P even if the 10334** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy 10335** of the database exists. 10336** 10337** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the 10338** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory 10339** allocation error occurs. 10340** 10341** This interface is omitted if SQLite is compiled with the 10342** [SQLITE_OMIT_DESERIALIZE] option. 10343*/ 10344unsigned char *sqlite3_serialize( 10345 sqlite3 *db, /* The database connection */ 10346 const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */ 10347 sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */ 10348 unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */ 10349); 10350 10351/* 10352** CAPI3REF: Flags for sqlite3_serialize 10353** 10354** Zero or more of the following constants can be OR-ed together for 10355** the F argument to [sqlite3_serialize(D,S,P,F)]. 10356** 10357** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return 10358** a pointer to contiguous in-memory database that it is currently using, 10359** without making a copy of the database. If SQLite is not currently using 10360** a contiguous in-memory database, then this option causes 10361** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be 10362** using a contiguous in-memory database if it has been initialized by a 10363** prior call to [sqlite3_deserialize()]. 10364*/ 10365#define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */ 10366 10367/* 10368** CAPI3REF: Deserialize a database 10369** 10370** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the 10371** [database connection] D to disconnect from database S and then 10372** reopen S as an in-memory database based on the serialization contained 10373** in P. The serialized database P is N bytes in size. M is the size of 10374** the buffer P, which might be larger than N. If M is larger than N, and 10375** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is 10376** permitted to add content to the in-memory database as long as the total 10377** size does not exceed M bytes. 10378** 10379** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will 10380** invoke sqlite3_free() on the serialization buffer when the database 10381** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then 10382** SQLite will try to increase the buffer size using sqlite3_realloc64() 10383** if writes on the database cause it to grow larger than M bytes. 10384** 10385** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the 10386** database is currently in a read transaction or is involved in a backup 10387** operation. 10388** 10389** It is not possible to deserialized into the TEMP database. If the 10390** S argument to sqlite3_deserialize(D,S,P,N,M,F) is "temp" then the 10391** function returns SQLITE_ERROR. 10392** 10393** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the 10394** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then 10395** [sqlite3_free()] is invoked on argument P prior to returning. 10396** 10397** This interface is omitted if SQLite is compiled with the 10398** [SQLITE_OMIT_DESERIALIZE] option. 10399*/ 10400int sqlite3_deserialize( 10401 sqlite3 *db, /* The database connection */ 10402 const char *zSchema, /* Which DB to reopen with the deserialization */ 10403 unsigned char *pData, /* The serialized database content */ 10404 sqlite3_int64 szDb, /* Number bytes in the deserialization */ 10405 sqlite3_int64 szBuf, /* Total size of buffer pData[] */ 10406 unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */ 10407); 10408 10409/* 10410** CAPI3REF: Flags for sqlite3_deserialize() 10411** 10412** The following are allowed values for 6th argument (the F argument) to 10413** the [sqlite3_deserialize(D,S,P,N,M,F)] interface. 10414** 10415** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization 10416** in the P argument is held in memory obtained from [sqlite3_malloc64()] 10417** and that SQLite should take ownership of this memory and automatically 10418** free it when it has finished using it. Without this flag, the caller 10419** is responsible for freeing any dynamically allocated memory. 10420** 10421** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to 10422** grow the size of the database using calls to [sqlite3_realloc64()]. This 10423** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used. 10424** Without this flag, the deserialized database cannot increase in size beyond 10425** the number of bytes specified by the M parameter. 10426** 10427** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database 10428** should be treated as read-only. 10429*/ 10430#define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */ 10431#define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */ 10432#define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */ 10433 10434/* 10435** Undo the hack that converts floating point types to integer for 10436** builds on processors without floating point support. 10437*/ 10438#ifdef SQLITE_OMIT_FLOATING_POINT 10439# undef double 10440#endif 10441 10442#ifdef __cplusplus 10443} /* End of the 'extern "C"' block */ 10444#endif 10445#endif /* SQLITE3_H */ 10446