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** Provide the ability to override linkage features of the interface. 47*/ 48#ifndef SQLITE_EXTERN 49# define SQLITE_EXTERN extern 50#endif 51#ifndef SQLITE_API 52# define SQLITE_API 53#endif 54#ifndef SQLITE_CDECL 55# define SQLITE_CDECL 56#endif 57#ifndef SQLITE_APICALL 58# define SQLITE_APICALL 59#endif 60#ifndef SQLITE_STDCALL 61# define SQLITE_STDCALL SQLITE_APICALL 62#endif 63#ifndef SQLITE_CALLBACK 64# define SQLITE_CALLBACK 65#endif 66#ifndef SQLITE_SYSAPI 67# define SQLITE_SYSAPI 68#endif 69 70/* 71** These no-op macros are used in front of interfaces to mark those 72** interfaces as either deprecated or experimental. New applications 73** should not use deprecated interfaces - they are supported for backwards 74** compatibility only. Application writers should be aware that 75** experimental interfaces are subject to change in point releases. 76** 77** These macros used to resolve to various kinds of compiler magic that 78** would generate warning messages when they were used. But that 79** compiler magic ended up generating such a flurry of bug reports 80** that we have taken it all out and gone back to using simple 81** noop macros. 82*/ 83#define SQLITE_DEPRECATED 84#define SQLITE_EXPERIMENTAL 85 86/* 87** Ensure these symbols were not defined by some previous header file. 88*/ 89#ifdef SQLITE_VERSION 90# undef SQLITE_VERSION 91#endif 92#ifdef SQLITE_VERSION_NUMBER 93# undef SQLITE_VERSION_NUMBER 94#endif 95 96/* 97** CAPI3REF: Compile-Time Library Version Numbers 98** 99** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header 100** evaluates to a string literal that is the SQLite version in the 101** format "X.Y.Z" where X is the major version number (always 3 for 102** SQLite3) and Y is the minor version number and Z is the release number.)^ 103** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer 104** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same 105** numbers used in [SQLITE_VERSION].)^ 106** The SQLITE_VERSION_NUMBER for any given release of SQLite will also 107** be larger than the release from which it is derived. Either Y will 108** be held constant and Z will be incremented or else Y will be incremented 109** and Z will be reset to zero. 110** 111** Since [version 3.6.18] ([dateof:3.6.18]), 112** SQLite source code has been stored in the 113** <a href="http://www.fossil-scm.org/">Fossil configuration management 114** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to 115** a string which identifies a particular check-in of SQLite 116** within its configuration management system. ^The SQLITE_SOURCE_ID 117** string contains the date and time of the check-in (UTC) and a SHA1 118** or SHA3-256 hash of the entire source tree. If the source code has 119** been edited in any way since it was last checked in, then the last 120** four hexadecimal digits of the hash may be modified. 121** 122** See also: [sqlite3_libversion()], 123** [sqlite3_libversion_number()], [sqlite3_sourceid()], 124** [sqlite_version()] and [sqlite_source_id()]. 125*/ 126#define SQLITE_VERSION "--VERS--" 127#define SQLITE_VERSION_NUMBER --VERSION-NUMBER-- 128#define SQLITE_SOURCE_ID "--SOURCE-ID--" 129 130/* 131** CAPI3REF: Run-Time Library Version Numbers 132** KEYWORDS: sqlite3_version sqlite3_sourceid 133** 134** These interfaces provide the same information as the [SQLITE_VERSION], 135** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros 136** but are associated with the library instead of the header file. ^(Cautious 137** programmers might include assert() statements in their application to 138** verify that values returned by these interfaces match the macros in 139** the header, and thus ensure that the application is 140** compiled with matching library and header files. 141** 142** <blockquote><pre> 143** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); 144** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 ); 145** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); 146** </pre></blockquote>)^ 147** 148** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] 149** macro. ^The sqlite3_libversion() function returns a pointer to the 150** to the sqlite3_version[] string constant. The sqlite3_libversion() 151** function is provided for use in DLLs since DLL users usually do not have 152** direct access to string constants within the DLL. ^The 153** sqlite3_libversion_number() function returns an integer equal to 154** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns 155** a pointer to a string constant whose value is the same as the 156** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built 157** using an edited copy of [the amalgamation], then the last four characters 158** of the hash might be different from [SQLITE_SOURCE_ID].)^ 159** 160** See also: [sqlite_version()] and [sqlite_source_id()]. 161*/ 162SQLITE_EXTERN const char sqlite3_version[]; 163const char *sqlite3_libversion(void); 164const char *sqlite3_sourceid(void); 165int sqlite3_libversion_number(void); 166 167/* 168** CAPI3REF: Run-Time Library Compilation Options Diagnostics 169** 170** ^The sqlite3_compileoption_used() function returns 0 or 1 171** indicating whether the specified option was defined at 172** compile time. ^The SQLITE_ prefix may be omitted from the 173** option name passed to sqlite3_compileoption_used(). 174** 175** ^The sqlite3_compileoption_get() function allows iterating 176** over the list of options that were defined at compile time by 177** returning the N-th compile time option string. ^If N is out of range, 178** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ 179** prefix is omitted from any strings returned by 180** sqlite3_compileoption_get(). 181** 182** ^Support for the diagnostic functions sqlite3_compileoption_used() 183** and sqlite3_compileoption_get() may be omitted by specifying the 184** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. 185** 186** See also: SQL functions [sqlite_compileoption_used()] and 187** [sqlite_compileoption_get()] and the [compile_options pragma]. 188*/ 189#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 190int sqlite3_compileoption_used(const char *zOptName); 191const char *sqlite3_compileoption_get(int N); 192#else 193# define sqlite3_compileoption_used(X) 0 194# define sqlite3_compileoption_get(X) ((void*)0) 195#endif 196 197/* 198** CAPI3REF: Test To See If The Library Is Threadsafe 199** 200** ^The sqlite3_threadsafe() function returns zero if and only if 201** SQLite was compiled with mutexing code omitted due to the 202** [SQLITE_THREADSAFE] compile-time option being set to 0. 203** 204** SQLite can be compiled with or without mutexes. When 205** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes 206** are enabled and SQLite is threadsafe. When the 207** [SQLITE_THREADSAFE] macro is 0, 208** the mutexes are omitted. Without the mutexes, it is not safe 209** to use SQLite concurrently from more than one thread. 210** 211** Enabling mutexes incurs a measurable performance penalty. 212** So if speed is of utmost importance, it makes sense to disable 213** the mutexes. But for maximum safety, mutexes should be enabled. 214** ^The default behavior is for mutexes to be enabled. 215** 216** This interface can be used by an application to make sure that the 217** version of SQLite that it is linking against was compiled with 218** the desired setting of the [SQLITE_THREADSAFE] macro. 219** 220** This interface only reports on the compile-time mutex setting 221** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with 222** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but 223** can be fully or partially disabled using a call to [sqlite3_config()] 224** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], 225** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the 226** sqlite3_threadsafe() function shows only the compile-time setting of 227** thread safety, not any run-time changes to that setting made by 228** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() 229** is unchanged by calls to sqlite3_config().)^ 230** 231** See the [threading mode] documentation for additional information. 232*/ 233int sqlite3_threadsafe(void); 234 235/* 236** CAPI3REF: Database Connection Handle 237** KEYWORDS: {database connection} {database connections} 238** 239** Each open SQLite database is represented by a pointer to an instance of 240** the opaque structure named "sqlite3". It is useful to think of an sqlite3 241** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 242** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 243** and [sqlite3_close_v2()] are its destructors. There are many other 244** interfaces (such as 245** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 246** [sqlite3_busy_timeout()] to name but three) that are methods on an 247** sqlite3 object. 248*/ 249typedef struct sqlite3 sqlite3; 250 251/* 252** CAPI3REF: 64-Bit Integer Types 253** KEYWORDS: sqlite_int64 sqlite_uint64 254** 255** Because there is no cross-platform way to specify 64-bit integer types 256** SQLite includes typedefs for 64-bit signed and unsigned integers. 257** 258** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. 259** The sqlite_int64 and sqlite_uint64 types are supported for backwards 260** compatibility only. 261** 262** ^The sqlite3_int64 and sqlite_int64 types can store integer values 263** between -9223372036854775808 and +9223372036854775807 inclusive. ^The 264** sqlite3_uint64 and sqlite_uint64 types can store integer values 265** between 0 and +18446744073709551615 inclusive. 266*/ 267#ifdef SQLITE_INT64_TYPE 268 typedef SQLITE_INT64_TYPE sqlite_int64; 269# ifdef SQLITE_UINT64_TYPE 270 typedef SQLITE_UINT64_TYPE sqlite_uint64; 271# else 272 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; 273# endif 274#elif defined(_MSC_VER) || defined(__BORLANDC__) 275 typedef __int64 sqlite_int64; 276 typedef unsigned __int64 sqlite_uint64; 277#else 278 typedef long long int sqlite_int64; 279 typedef unsigned long long int sqlite_uint64; 280#endif 281typedef sqlite_int64 sqlite3_int64; 282typedef sqlite_uint64 sqlite3_uint64; 283 284/* 285** If compiling for a processor that lacks floating point support, 286** substitute integer for floating-point. 287*/ 288#ifdef SQLITE_OMIT_FLOATING_POINT 289# define double sqlite3_int64 290#endif 291 292/* 293** CAPI3REF: Closing A Database Connection 294** DESTRUCTOR: sqlite3 295** 296** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors 297** for the [sqlite3] object. 298** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if 299** the [sqlite3] object is successfully destroyed and all associated 300** resources are deallocated. 301** 302** ^If the database connection is associated with unfinalized prepared 303** statements or unfinished sqlite3_backup objects then sqlite3_close() 304** will leave the database connection open and return [SQLITE_BUSY]. 305** ^If sqlite3_close_v2() is called with unfinalized prepared statements 306** and/or unfinished sqlite3_backups, then the database connection becomes 307** an unusable "zombie" which will automatically be deallocated when the 308** last prepared statement is finalized or the last sqlite3_backup is 309** finished. The sqlite3_close_v2() interface is intended for use with 310** host languages that are garbage collected, and where the order in which 311** destructors are called is arbitrary. 312** 313** Applications should [sqlite3_finalize | finalize] all [prepared statements], 314** [sqlite3_blob_close | close] all [BLOB handles], and 315** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated 316** with the [sqlite3] object prior to attempting to close the object. ^If 317** sqlite3_close_v2() is called on a [database connection] that still has 318** outstanding [prepared statements], [BLOB handles], and/or 319** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation 320** of resources is deferred until all [prepared statements], [BLOB handles], 321** and [sqlite3_backup] objects are also destroyed. 322** 323** ^If an [sqlite3] object is destroyed while a transaction is open, 324** the transaction is automatically rolled back. 325** 326** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)] 327** must be either a NULL 328** pointer or an [sqlite3] object pointer obtained 329** from [sqlite3_open()], [sqlite3_open16()], or 330** [sqlite3_open_v2()], and not previously closed. 331** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer 332** argument is a harmless no-op. 333*/ 334int sqlite3_close(sqlite3*); 335int sqlite3_close_v2(sqlite3*); 336 337/* 338** The type for a callback function. 339** This is legacy and deprecated. It is included for historical 340** compatibility and is not documented. 341*/ 342typedef int (*sqlite3_callback)(void*,int,char**, char**); 343 344/* 345** CAPI3REF: One-Step Query Execution Interface 346** METHOD: sqlite3 347** 348** The sqlite3_exec() interface is a convenience wrapper around 349** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], 350** that allows an application to run multiple statements of SQL 351** without having to use a lot of C code. 352** 353** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, 354** semicolon-separate SQL statements passed into its 2nd argument, 355** in the context of the [database connection] passed in as its 1st 356** argument. ^If the callback function of the 3rd argument to 357** sqlite3_exec() is not NULL, then it is invoked for each result row 358** coming out of the evaluated SQL statements. ^The 4th argument to 359** sqlite3_exec() is relayed through to the 1st argument of each 360** callback invocation. ^If the callback pointer to sqlite3_exec() 361** is NULL, then no callback is ever invoked and result rows are 362** ignored. 363** 364** ^If an error occurs while evaluating the SQL statements passed into 365** sqlite3_exec(), then execution of the current statement stops and 366** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() 367** is not NULL then any error message is written into memory obtained 368** from [sqlite3_malloc()] and passed back through the 5th parameter. 369** To avoid memory leaks, the application should invoke [sqlite3_free()] 370** on error message strings returned through the 5th parameter of 371** sqlite3_exec() after the error message string is no longer needed. 372** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors 373** occur, then sqlite3_exec() sets the pointer in its 5th parameter to 374** NULL before returning. 375** 376** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() 377** routine returns SQLITE_ABORT without invoking the callback again and 378** without running any subsequent SQL statements. 379** 380** ^The 2nd argument to the sqlite3_exec() callback function is the 381** number of columns in the result. ^The 3rd argument to the sqlite3_exec() 382** callback is an array of pointers to strings obtained as if from 383** [sqlite3_column_text()], one for each column. ^If an element of a 384** result row is NULL then the corresponding string pointer for the 385** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the 386** sqlite3_exec() callback is an array of pointers to strings where each 387** entry represents the name of corresponding result column as obtained 388** from [sqlite3_column_name()]. 389** 390** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer 391** to an empty string, or a pointer that contains only whitespace and/or 392** SQL comments, then no SQL statements are evaluated and the database 393** is not changed. 394** 395** Restrictions: 396** 397** <ul> 398** <li> The application must ensure that the 1st parameter to sqlite3_exec() 399** is a valid and open [database connection]. 400** <li> The application must not close the [database connection] specified by 401** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. 402** <li> The application must not modify the SQL statement text passed into 403** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. 404** </ul> 405*/ 406int sqlite3_exec( 407 sqlite3*, /* An open database */ 408 const char *sql, /* SQL to be evaluated */ 409 int (*callback)(void*,int,char**,char**), /* Callback function */ 410 void *, /* 1st argument to callback */ 411 char **errmsg /* Error msg written here */ 412); 413 414/* 415** CAPI3REF: Result Codes 416** KEYWORDS: {result code definitions} 417** 418** Many SQLite functions return an integer result code from the set shown 419** here in order to indicate success or failure. 420** 421** New error codes may be added in future versions of SQLite. 422** 423** See also: [extended result code definitions] 424*/ 425#define SQLITE_OK 0 /* Successful result */ 426/* beginning-of-error-codes */ 427#define SQLITE_ERROR 1 /* Generic error */ 428#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 429#define SQLITE_PERM 3 /* Access permission denied */ 430#define SQLITE_ABORT 4 /* Callback routine requested an abort */ 431#define SQLITE_BUSY 5 /* The database file is locked */ 432#define SQLITE_LOCKED 6 /* A table in the database is locked */ 433#define SQLITE_NOMEM 7 /* A malloc() failed */ 434#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 435#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 436#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 437#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 438#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ 439#define SQLITE_FULL 13 /* Insertion failed because database is full */ 440#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 441#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ 442#define SQLITE_EMPTY 16 /* Internal use only */ 443#define SQLITE_SCHEMA 17 /* The database schema changed */ 444#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 445#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 446#define SQLITE_MISMATCH 20 /* Data type mismatch */ 447#define SQLITE_MISUSE 21 /* Library used incorrectly */ 448#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 449#define SQLITE_AUTH 23 /* Authorization denied */ 450#define SQLITE_FORMAT 24 /* Not used */ 451#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 452#define SQLITE_NOTADB 26 /* File opened that is not a database file */ 453#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */ 454#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */ 455#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 456#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 457/* end-of-error-codes */ 458 459/* 460** CAPI3REF: Extended Result Codes 461** KEYWORDS: {extended result code definitions} 462** 463** In its default configuration, SQLite API routines return one of 30 integer 464** [result codes]. However, experience has shown that many of 465** these result codes are too coarse-grained. They do not provide as 466** much information about problems as programmers might like. In an effort to 467** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8] 468** and later) include 469** support for additional result codes that provide more detailed information 470** about errors. These [extended result codes] are enabled or disabled 471** on a per database connection basis using the 472** [sqlite3_extended_result_codes()] API. Or, the extended code for 473** the most recent error can be obtained using 474** [sqlite3_extended_errcode()]. 475*/ 476#define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8)) 477#define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8)) 478#define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR | (3<<8)) 479#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 480#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 481#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 482#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 483#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 484#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 485#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 486#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 487#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 488#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 489#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 490#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 491#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 492#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 493#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 494#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 495#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 496#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) 497#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) 498#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) 499#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) 500#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) 501#define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8)) 502#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8)) 503#define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8)) 504#define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8)) 505#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8)) 506#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8)) 507#define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR | (29<<8)) 508#define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR | (30<<8)) 509#define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR | (31<<8)) 510#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) 511#define SQLITE_LOCKED_VTAB (SQLITE_LOCKED | (2<<8)) 512#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) 513#define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8)) 514#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) 515#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) 516#define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8)) 517#define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8)) 518#define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN | (5<<8)) /* Not Used */ 519#define SQLITE_CANTOPEN_SYMLINK (SQLITE_CANTOPEN | (6<<8)) 520#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) 521#define SQLITE_CORRUPT_SEQUENCE (SQLITE_CORRUPT | (2<<8)) 522#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) 523#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) 524#define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8)) 525#define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8)) 526#define SQLITE_READONLY_CANTINIT (SQLITE_READONLY | (5<<8)) 527#define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY | (6<<8)) 528#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) 529#define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8)) 530#define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8)) 531#define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8)) 532#define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8)) 533#define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8)) 534#define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8)) 535#define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8)) 536#define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8)) 537#define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8)) 538#define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8)) 539#define SQLITE_CONSTRAINT_PINNED (SQLITE_CONSTRAINT |(11<<8)) 540#define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8)) 541#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8)) 542#define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8)) 543#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8)) 544#define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8)) 545#define SQLITE_OK_SYMLINK (SQLITE_OK | (2<<8)) 546 547/* 548** CAPI3REF: Flags For File Open Operations 549** 550** These bit values are intended for use in the 551** 3rd parameter to the [sqlite3_open_v2()] interface and 552** in the 4th parameter to the [sqlite3_vfs.xOpen] method. 553*/ 554#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ 555#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ 556#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ 557#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ 558#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ 559#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ 560#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ 561#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */ 562#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ 563#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ 564#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ 565#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ 566#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ 567#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ 568#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ 569#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ 570#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ 571#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ 572#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ 573#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ 574#define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for sqlite3_open_v2() */ 575 576/* Reserved: 0x00F00000 */ 577 578/* 579** CAPI3REF: Device Characteristics 580** 581** The xDeviceCharacteristics method of the [sqlite3_io_methods] 582** object returns an integer which is a vector of these 583** bit values expressing I/O characteristics of the mass storage 584** device that holds the file that the [sqlite3_io_methods] 585** refers to. 586** 587** The SQLITE_IOCAP_ATOMIC property means that all writes of 588** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 589** mean that writes of blocks that are nnn bytes in size and 590** are aligned to an address which is an integer multiple of 591** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 592** that when data is appended to a file, the data is appended 593** first then the size of the file is extended, never the other 594** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 595** information is written to disk in the same order as calls 596** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that 597** after reboot following a crash or power loss, the only bytes in a 598** file that were written at the application level might have changed 599** and that adjacent bytes, even bytes within the same sector are 600** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 601** flag indicates that a file cannot be deleted when open. The 602** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on 603** read-only media and cannot be changed even by processes with 604** elevated privileges. 605** 606** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying 607** filesystem supports doing multiple write operations atomically when those 608** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and 609** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. 610*/ 611#define SQLITE_IOCAP_ATOMIC 0x00000001 612#define SQLITE_IOCAP_ATOMIC512 0x00000002 613#define SQLITE_IOCAP_ATOMIC1K 0x00000004 614#define SQLITE_IOCAP_ATOMIC2K 0x00000008 615#define SQLITE_IOCAP_ATOMIC4K 0x00000010 616#define SQLITE_IOCAP_ATOMIC8K 0x00000020 617#define SQLITE_IOCAP_ATOMIC16K 0x00000040 618#define SQLITE_IOCAP_ATOMIC32K 0x00000080 619#define SQLITE_IOCAP_ATOMIC64K 0x00000100 620#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 621#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 622#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 623#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 624#define SQLITE_IOCAP_IMMUTABLE 0x00002000 625#define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000 626 627/* 628** CAPI3REF: File Locking Levels 629** 630** SQLite uses one of these integer values as the second 631** argument to calls it makes to the xLock() and xUnlock() methods 632** of an [sqlite3_io_methods] object. 633*/ 634#define SQLITE_LOCK_NONE 0 635#define SQLITE_LOCK_SHARED 1 636#define SQLITE_LOCK_RESERVED 2 637#define SQLITE_LOCK_PENDING 3 638#define SQLITE_LOCK_EXCLUSIVE 4 639 640/* 641** CAPI3REF: Synchronization Type Flags 642** 643** When SQLite invokes the xSync() method of an 644** [sqlite3_io_methods] object it uses a combination of 645** these integer values as the second argument. 646** 647** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 648** sync operation only needs to flush data to mass storage. Inode 649** information need not be flushed. If the lower four bits of the flag 650** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. 651** If the lower four bits equal SQLITE_SYNC_FULL, that means 652** to use Mac OS X style fullsync instead of fsync(). 653** 654** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags 655** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL 656** settings. The [synchronous pragma] determines when calls to the 657** xSync VFS method occur and applies uniformly across all platforms. 658** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how 659** energetic or rigorous or forceful the sync operations are and 660** only make a difference on Mac OSX for the default SQLite code. 661** (Third-party VFS implementations might also make the distinction 662** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the 663** operating systems natively supported by SQLite, only Mac OSX 664** cares about the difference.) 665*/ 666#define SQLITE_SYNC_NORMAL 0x00002 667#define SQLITE_SYNC_FULL 0x00003 668#define SQLITE_SYNC_DATAONLY 0x00010 669 670/* 671** CAPI3REF: OS Interface Open File Handle 672** 673** An [sqlite3_file] object represents an open file in the 674** [sqlite3_vfs | OS interface layer]. Individual OS interface 675** implementations will 676** want to subclass this object by appending additional fields 677** for their own use. The pMethods entry is a pointer to an 678** [sqlite3_io_methods] object that defines methods for performing 679** I/O operations on the open file. 680*/ 681typedef struct sqlite3_file sqlite3_file; 682struct sqlite3_file { 683 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 684}; 685 686/* 687** CAPI3REF: OS Interface File Virtual Methods Object 688** 689** Every file opened by the [sqlite3_vfs.xOpen] method populates an 690** [sqlite3_file] object (or, more commonly, a subclass of the 691** [sqlite3_file] object) with a pointer to an instance of this object. 692** This object defines the methods used to perform various operations 693** against the open file represented by the [sqlite3_file] object. 694** 695** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element 696** to a non-NULL pointer, then the sqlite3_io_methods.xClose method 697** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The 698** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] 699** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element 700** to NULL. 701** 702** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 703** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 704** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] 705** flag may be ORed in to indicate that only the data of the file 706** and not its inode needs to be synced. 707** 708** The integer values to xLock() and xUnlock() are one of 709** <ul> 710** <li> [SQLITE_LOCK_NONE], 711** <li> [SQLITE_LOCK_SHARED], 712** <li> [SQLITE_LOCK_RESERVED], 713** <li> [SQLITE_LOCK_PENDING], or 714** <li> [SQLITE_LOCK_EXCLUSIVE]. 715** </ul> 716** xLock() increases the lock. xUnlock() decreases the lock. 717** The xCheckReservedLock() method checks whether any database connection, 718** either in this process or in some other process, is holding a RESERVED, 719** PENDING, or EXCLUSIVE lock on the file. It returns true 720** if such a lock exists and false otherwise. 721** 722** The xFileControl() method is a generic interface that allows custom 723** VFS implementations to directly control an open file using the 724** [sqlite3_file_control()] interface. The second "op" argument is an 725** integer opcode. The third argument is a generic pointer intended to 726** point to a structure that may contain arguments or space in which to 727** write return values. Potential uses for xFileControl() might be 728** functions to enable blocking locks with timeouts, to change the 729** locking strategy (for example to use dot-file locks), to inquire 730** about the status of a lock, or to break stale locks. The SQLite 731** core reserves all opcodes less than 100 for its own use. 732** A [file control opcodes | list of opcodes] less than 100 is available. 733** Applications that define a custom xFileControl method should use opcodes 734** greater than 100 to avoid conflicts. VFS implementations should 735** return [SQLITE_NOTFOUND] for file control opcodes that they do not 736** recognize. 737** 738** The xSectorSize() method returns the sector size of the 739** device that underlies the file. The sector size is the 740** minimum write that can be performed without disturbing 741** other bytes in the file. The xDeviceCharacteristics() 742** method returns a bit vector describing behaviors of the 743** underlying device: 744** 745** <ul> 746** <li> [SQLITE_IOCAP_ATOMIC] 747** <li> [SQLITE_IOCAP_ATOMIC512] 748** <li> [SQLITE_IOCAP_ATOMIC1K] 749** <li> [SQLITE_IOCAP_ATOMIC2K] 750** <li> [SQLITE_IOCAP_ATOMIC4K] 751** <li> [SQLITE_IOCAP_ATOMIC8K] 752** <li> [SQLITE_IOCAP_ATOMIC16K] 753** <li> [SQLITE_IOCAP_ATOMIC32K] 754** <li> [SQLITE_IOCAP_ATOMIC64K] 755** <li> [SQLITE_IOCAP_SAFE_APPEND] 756** <li> [SQLITE_IOCAP_SEQUENTIAL] 757** <li> [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN] 758** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE] 759** <li> [SQLITE_IOCAP_IMMUTABLE] 760** <li> [SQLITE_IOCAP_BATCH_ATOMIC] 761** </ul> 762** 763** The SQLITE_IOCAP_ATOMIC property means that all writes of 764** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 765** mean that writes of blocks that are nnn bytes in size and 766** are aligned to an address which is an integer multiple of 767** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 768** that when data is appended to a file, the data is appended 769** first then the size of the file is extended, never the other 770** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 771** information is written to disk in the same order as calls 772** to xWrite(). 773** 774** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill 775** in the unread portions of the buffer with zeros. A VFS that 776** fails to zero-fill short reads might seem to work. However, 777** failure to zero-fill short reads will eventually lead to 778** database corruption. 779*/ 780typedef struct sqlite3_io_methods sqlite3_io_methods; 781struct sqlite3_io_methods { 782 int iVersion; 783 int (*xClose)(sqlite3_file*); 784 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); 785 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 786 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 787 int (*xSync)(sqlite3_file*, int flags); 788 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 789 int (*xLock)(sqlite3_file*, int); 790 int (*xUnlock)(sqlite3_file*, int); 791 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 792 int (*xFileControl)(sqlite3_file*, int op, void *pArg); 793 int (*xSectorSize)(sqlite3_file*); 794 int (*xDeviceCharacteristics)(sqlite3_file*); 795 /* Methods above are valid for version 1 */ 796 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); 797 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); 798 void (*xShmBarrier)(sqlite3_file*); 799 int (*xShmUnmap)(sqlite3_file*, int deleteFlag); 800 /* Methods above are valid for version 2 */ 801 int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp); 802 int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p); 803 /* Methods above are valid for version 3 */ 804 /* Additional methods may be added in future releases */ 805}; 806 807/* 808** CAPI3REF: Standard File Control Opcodes 809** KEYWORDS: {file control opcodes} {file control opcode} 810** 811** These integer constants are opcodes for the xFileControl method 812** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 813** interface. 814** 815** <ul> 816** <li>[[SQLITE_FCNTL_LOCKSTATE]] 817** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 818** opcode causes the xFileControl method to write the current state of 819** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 820** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 821** into an integer that the pArg argument points to. This capability 822** is used during testing and is only available when the SQLITE_TEST 823** compile-time option is used. 824** 825** <li>[[SQLITE_FCNTL_SIZE_HINT]] 826** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS 827** layer a hint of how large the database file will grow to be during the 828** current transaction. This hint is not guaranteed to be accurate but it 829** is often close. The underlying VFS might choose to preallocate database 830** file space based on this hint in order to help writes to the database 831** file run faster. 832** 833** <li>[[SQLITE_FCNTL_SIZE_LIMIT]] 834** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that 835** implements [sqlite3_deserialize()] to set an upper bound on the size 836** of the in-memory database. The argument is a pointer to a [sqlite3_int64]. 837** If the integer pointed to is negative, then it is filled in with the 838** current limit. Otherwise the limit is set to the larger of the value 839** of the integer pointed to and the current database size. The integer 840** pointed to is set to the new limit. 841** 842** <li>[[SQLITE_FCNTL_CHUNK_SIZE]] 843** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS 844** extends and truncates the database file in chunks of a size specified 845** by the user. The fourth argument to [sqlite3_file_control()] should 846** point to an integer (type int) containing the new chunk-size to use 847** for the nominated database. Allocating database file space in large 848** chunks (say 1MB at a time), may reduce file-system fragmentation and 849** improve performance on some systems. 850** 851** <li>[[SQLITE_FCNTL_FILE_POINTER]] 852** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer 853** to the [sqlite3_file] object associated with a particular database 854** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER]. 855** 856** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]] 857** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer 858** to the [sqlite3_file] object associated with the journal file (either 859** the [rollback journal] or the [write-ahead log]) for a particular database 860** connection. See also [SQLITE_FCNTL_FILE_POINTER]. 861** 862** <li>[[SQLITE_FCNTL_SYNC_OMITTED]] 863** No longer in use. 864** 865** <li>[[SQLITE_FCNTL_SYNC]] 866** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and 867** sent to the VFS immediately before the xSync method is invoked on a 868** database file descriptor. Or, if the xSync method is not invoked 869** because the user has configured SQLite with 870** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place 871** of the xSync method. In most cases, the pointer argument passed with 872** this file-control is NULL. However, if the database file is being synced 873** as part of a multi-database commit, the argument points to a nul-terminated 874** string containing the transactions master-journal file name. VFSes that 875** do not need this signal should silently ignore this opcode. Applications 876** should not call [sqlite3_file_control()] with this opcode as doing so may 877** disrupt the operation of the specialized VFSes that do require it. 878** 879** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]] 880** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite 881** and sent to the VFS after a transaction has been committed immediately 882** but before the database is unlocked. VFSes that do not need this signal 883** should silently ignore this opcode. Applications should not call 884** [sqlite3_file_control()] with this opcode as doing so may disrupt the 885** operation of the specialized VFSes that do require it. 886** 887** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]] 888** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic 889** retry counts and intervals for certain disk I/O operations for the 890** windows [VFS] in order to provide robustness in the presence of 891** anti-virus programs. By default, the windows VFS will retry file read, 892** file write, and file delete operations up to 10 times, with a delay 893** of 25 milliseconds before the first retry and with the delay increasing 894** by an additional 25 milliseconds with each subsequent retry. This 895** opcode allows these two values (10 retries and 25 milliseconds of delay) 896** to be adjusted. The values are changed for all database connections 897** within the same process. The argument is a pointer to an array of two 898** integers where the first integer is the new retry count and the second 899** integer is the delay. If either integer is negative, then the setting 900** is not changed but instead the prior value of that setting is written 901** into the array entry, allowing the current retry settings to be 902** interrogated. The zDbName parameter is ignored. 903** 904** <li>[[SQLITE_FCNTL_PERSIST_WAL]] 905** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the 906** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary 907** write ahead log ([WAL file]) and shared memory 908** files used for transaction control 909** are automatically deleted when the latest connection to the database 910** closes. Setting persistent WAL mode causes those files to persist after 911** close. Persisting the files is useful when other processes that do not 912** have write permission on the directory containing the database file want 913** to read the database file, as the WAL and shared memory files must exist 914** in order for the database to be readable. The fourth parameter to 915** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 916** That integer is 0 to disable persistent WAL mode or 1 to enable persistent 917** WAL mode. If the integer is -1, then it is overwritten with the current 918** WAL persistence setting. 919** 920** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] 921** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the 922** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting 923** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the 924** xDeviceCharacteristics methods. The fourth parameter to 925** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 926** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage 927** mode. If the integer is -1, then it is overwritten with the current 928** zero-damage mode setting. 929** 930** <li>[[SQLITE_FCNTL_OVERWRITE]] 931** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening 932** a write transaction to indicate that, unless it is rolled back for some 933** reason, the entire database file will be overwritten by the current 934** transaction. This is used by VACUUM operations. 935** 936** <li>[[SQLITE_FCNTL_VFSNAME]] 937** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of 938** all [VFSes] in the VFS stack. The names are of all VFS shims and the 939** final bottom-level VFS are written into memory obtained from 940** [sqlite3_malloc()] and the result is stored in the char* variable 941** that the fourth parameter of [sqlite3_file_control()] points to. 942** The caller is responsible for freeing the memory when done. As with 943** all file-control actions, there is no guarantee that this will actually 944** do anything. Callers should initialize the char* variable to a NULL 945** pointer in case this file-control is not implemented. This file-control 946** is intended for diagnostic use only. 947** 948** <li>[[SQLITE_FCNTL_VFS_POINTER]] 949** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level 950** [VFSes] currently in use. ^(The argument X in 951** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be 952** of type "[sqlite3_vfs] **". This opcodes will set *X 953** to a pointer to the top-level VFS.)^ 954** ^When there are multiple VFS shims in the stack, this opcode finds the 955** upper-most shim only. 956** 957** <li>[[SQLITE_FCNTL_PRAGMA]] 958** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] 959** file control is sent to the open [sqlite3_file] object corresponding 960** to the database file to which the pragma statement refers. ^The argument 961** to the [SQLITE_FCNTL_PRAGMA] file control is an array of 962** pointers to strings (char**) in which the second element of the array 963** is the name of the pragma and the third element is the argument to the 964** pragma or NULL if the pragma has no argument. ^The handler for an 965** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element 966** of the char** argument point to a string obtained from [sqlite3_mprintf()] 967** or the equivalent and that string will become the result of the pragma or 968** the error message if the pragma fails. ^If the 969** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal 970** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] 971** file control returns [SQLITE_OK], then the parser assumes that the 972** VFS has handled the PRAGMA itself and the parser generates a no-op 973** prepared statement if result string is NULL, or that returns a copy 974** of the result string if the string is non-NULL. 975** ^If the [SQLITE_FCNTL_PRAGMA] file control returns 976** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means 977** that the VFS encountered an error while handling the [PRAGMA] and the 978** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] 979** file control occurs at the beginning of pragma statement analysis and so 980** it is able to override built-in [PRAGMA] statements. 981** 982** <li>[[SQLITE_FCNTL_BUSYHANDLER]] 983** ^The [SQLITE_FCNTL_BUSYHANDLER] 984** file-control may be invoked by SQLite on the database file handle 985** shortly after it is opened in order to provide a custom VFS with access 986** to the connection's busy-handler callback. The argument is of type (void**) 987** - an array of two (void *) values. The first (void *) actually points 988** to a function of type (int (*)(void *)). In order to invoke the connection's 989** busy-handler, this function should be invoked with the second (void *) in 990** the array as the only argument. If it returns non-zero, then the operation 991** should be retried. If it returns zero, the custom VFS should abandon the 992** current operation. 993** 994** <li>[[SQLITE_FCNTL_TEMPFILENAME]] 995** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control 996** to have SQLite generate a 997** temporary filename using the same algorithm that is followed to generate 998** temporary filenames for TEMP tables and other internal uses. The 999** argument should be a char** which will be filled with the filename 1000** written into memory obtained from [sqlite3_malloc()]. The caller should 1001** invoke [sqlite3_free()] on the result to avoid a memory leak. 1002** 1003** <li>[[SQLITE_FCNTL_MMAP_SIZE]] 1004** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the 1005** maximum number of bytes that will be used for memory-mapped I/O. 1006** The argument is a pointer to a value of type sqlite3_int64 that 1007** is an advisory maximum number of bytes in the file to memory map. The 1008** pointer is overwritten with the old value. The limit is not changed if 1009** the value originally pointed to is negative, and so the current limit 1010** can be queried by passing in a pointer to a negative number. This 1011** file-control is used internally to implement [PRAGMA mmap_size]. 1012** 1013** <li>[[SQLITE_FCNTL_TRACE]] 1014** The [SQLITE_FCNTL_TRACE] file control provides advisory information 1015** to the VFS about what the higher layers of the SQLite stack are doing. 1016** This file control is used by some VFS activity tracing [shims]. 1017** The argument is a zero-terminated string. Higher layers in the 1018** SQLite stack may generate instances of this file control if 1019** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled. 1020** 1021** <li>[[SQLITE_FCNTL_HAS_MOVED]] 1022** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a 1023** pointer to an integer and it writes a boolean into that integer depending 1024** on whether or not the file has been renamed, moved, or deleted since it 1025** was first opened. 1026** 1027** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]] 1028** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the 1029** underlying native file handle associated with a file handle. This file 1030** control interprets its argument as a pointer to a native file handle and 1031** writes the resulting value there. 1032** 1033** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]] 1034** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This 1035** opcode causes the xFileControl method to swap the file handle with the one 1036** pointed to by the pArg argument. This capability is used during testing 1037** and only needs to be supported when SQLITE_TEST is defined. 1038** 1039** <li>[[SQLITE_FCNTL_WAL_BLOCK]] 1040** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might 1041** be advantageous to block on the next WAL lock if the lock is not immediately 1042** available. The WAL subsystem issues this signal during rare 1043** circumstances in order to fix a problem with priority inversion. 1044** Applications should <em>not</em> use this file-control. 1045** 1046** <li>[[SQLITE_FCNTL_ZIPVFS]] 1047** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other 1048** VFS should return SQLITE_NOTFOUND for this opcode. 1049** 1050** <li>[[SQLITE_FCNTL_RBU]] 1051** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by 1052** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for 1053** this opcode. 1054** 1055** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]] 1056** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then 1057** the file descriptor is placed in "batch write mode", which 1058** means all subsequent write operations will be deferred and done 1059** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems 1060** that do not support batch atomic writes will return SQLITE_NOTFOUND. 1061** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to 1062** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or 1063** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make 1064** no VFS interface calls on the same [sqlite3_file] file descriptor 1065** except for calls to the xWrite method and the xFileControl method 1066** with [SQLITE_FCNTL_SIZE_HINT]. 1067** 1068** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]] 1069** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write 1070** operations since the previous successful call to 1071** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically. 1072** This file control returns [SQLITE_OK] if and only if the writes were 1073** all performed successfully and have been committed to persistent storage. 1074** ^Regardless of whether or not it is successful, this file control takes 1075** the file descriptor out of batch write mode so that all subsequent 1076** write operations are independent. 1077** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without 1078** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. 1079** 1080** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]] 1081** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write 1082** operations since the previous successful call to 1083** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back. 1084** ^This file control takes the file descriptor out of batch write mode 1085** so that all subsequent write operations are independent. 1086** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without 1087** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. 1088** 1089** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]] 1090** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode causes attempts to obtain 1091** a file lock using the xLock or xShmLock methods of the VFS to wait 1092** for up to M milliseconds before failing, where M is the single 1093** unsigned integer parameter. 1094** 1095** <li>[[SQLITE_FCNTL_DATA_VERSION]] 1096** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to 1097** a database file. The argument is a pointer to a 32-bit unsigned integer. 1098** The "data version" for the pager is written into the pointer. The 1099** "data version" changes whenever any change occurs to the corresponding 1100** database file, either through SQL statements on the same database 1101** connection or through transactions committed by separate database 1102** connections possibly in other processes. The [sqlite3_total_changes()] 1103** interface can be used to find if any database on the connection has changed, 1104** but that interface responds to changes on TEMP as well as MAIN and does 1105** not provide a mechanism to detect changes to MAIN only. Also, the 1106** [sqlite3_total_changes()] interface responds to internal changes only and 1107** omits changes made by other database connections. The 1108** [PRAGMA data_version] command provides a mechanism to detect changes to 1109** a single attached database that occur due to other database connections, 1110** but omits changes implemented by the database connection on which it is 1111** called. This file control is the only mechanism to detect changes that 1112** happen either internally or externally and that are associated with 1113** a particular attached database. 1114** </ul> 1115*/ 1116#define SQLITE_FCNTL_LOCKSTATE 1 1117#define SQLITE_FCNTL_GET_LOCKPROXYFILE 2 1118#define SQLITE_FCNTL_SET_LOCKPROXYFILE 3 1119#define SQLITE_FCNTL_LAST_ERRNO 4 1120#define SQLITE_FCNTL_SIZE_HINT 5 1121#define SQLITE_FCNTL_CHUNK_SIZE 6 1122#define SQLITE_FCNTL_FILE_POINTER 7 1123#define SQLITE_FCNTL_SYNC_OMITTED 8 1124#define SQLITE_FCNTL_WIN32_AV_RETRY 9 1125#define SQLITE_FCNTL_PERSIST_WAL 10 1126#define SQLITE_FCNTL_OVERWRITE 11 1127#define SQLITE_FCNTL_VFSNAME 12 1128#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 1129#define SQLITE_FCNTL_PRAGMA 14 1130#define SQLITE_FCNTL_BUSYHANDLER 15 1131#define SQLITE_FCNTL_TEMPFILENAME 16 1132#define SQLITE_FCNTL_MMAP_SIZE 18 1133#define SQLITE_FCNTL_TRACE 19 1134#define SQLITE_FCNTL_HAS_MOVED 20 1135#define SQLITE_FCNTL_SYNC 21 1136#define SQLITE_FCNTL_COMMIT_PHASETWO 22 1137#define SQLITE_FCNTL_WIN32_SET_HANDLE 23 1138#define SQLITE_FCNTL_WAL_BLOCK 24 1139#define SQLITE_FCNTL_ZIPVFS 25 1140#define SQLITE_FCNTL_RBU 26 1141#define SQLITE_FCNTL_VFS_POINTER 27 1142#define SQLITE_FCNTL_JOURNAL_POINTER 28 1143#define SQLITE_FCNTL_WIN32_GET_HANDLE 29 1144#define SQLITE_FCNTL_PDB 30 1145#define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31 1146#define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32 1147#define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33 1148#define SQLITE_FCNTL_LOCK_TIMEOUT 34 1149#define SQLITE_FCNTL_DATA_VERSION 35 1150#define SQLITE_FCNTL_SIZE_LIMIT 36 1151 1152/* deprecated names */ 1153#define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE 1154#define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE 1155#define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO 1156 1157 1158/* 1159** CAPI3REF: Mutex Handle 1160** 1161** The mutex module within SQLite defines [sqlite3_mutex] to be an 1162** abstract type for a mutex object. The SQLite core never looks 1163** at the internal representation of an [sqlite3_mutex]. It only 1164** deals with pointers to the [sqlite3_mutex] object. 1165** 1166** Mutexes are created using [sqlite3_mutex_alloc()]. 1167*/ 1168typedef struct sqlite3_mutex sqlite3_mutex; 1169 1170/* 1171** CAPI3REF: Loadable Extension Thunk 1172** 1173** A pointer to the opaque sqlite3_api_routines structure is passed as 1174** the third parameter to entry points of [loadable extensions]. This 1175** structure must be typedefed in order to work around compiler warnings 1176** on some platforms. 1177*/ 1178typedef struct sqlite3_api_routines sqlite3_api_routines; 1179 1180/* 1181** CAPI3REF: OS Interface Object 1182** 1183** An instance of the sqlite3_vfs object defines the interface between 1184** the SQLite core and the underlying operating system. The "vfs" 1185** in the name of the object stands for "virtual file system". See 1186** the [VFS | VFS documentation] for further information. 1187** 1188** The VFS interface is sometimes extended by adding new methods onto 1189** the end. Each time such an extension occurs, the iVersion field 1190** is incremented. The iVersion value started out as 1 in 1191** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2 1192** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased 1193** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields 1194** may be appended to the sqlite3_vfs object and the iVersion value 1195** may increase again in future versions of SQLite. 1196** Note that due to an oversight, the structure 1197** of the sqlite3_vfs object changed in the transition from 1198** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0] 1199** and yet the iVersion field was not increased. 1200** 1201** The szOsFile field is the size of the subclassed [sqlite3_file] 1202** structure used by this VFS. mxPathname is the maximum length of 1203** a pathname in this VFS. 1204** 1205** Registered sqlite3_vfs objects are kept on a linked list formed by 1206** the pNext pointer. The [sqlite3_vfs_register()] 1207** and [sqlite3_vfs_unregister()] interfaces manage this list 1208** in a thread-safe way. The [sqlite3_vfs_find()] interface 1209** searches the list. Neither the application code nor the VFS 1210** implementation should use the pNext pointer. 1211** 1212** The pNext field is the only field in the sqlite3_vfs 1213** structure that SQLite will ever modify. SQLite will only access 1214** or modify this field while holding a particular static mutex. 1215** The application should never modify anything within the sqlite3_vfs 1216** object once the object has been registered. 1217** 1218** The zName field holds the name of the VFS module. The name must 1219** be unique across all VFS modules. 1220** 1221** [[sqlite3_vfs.xOpen]] 1222** ^SQLite guarantees that the zFilename parameter to xOpen 1223** is either a NULL pointer or string obtained 1224** from xFullPathname() with an optional suffix added. 1225** ^If a suffix is added to the zFilename parameter, it will 1226** consist of a single "-" character followed by no more than 1227** 11 alphanumeric and/or "-" characters. 1228** ^SQLite further guarantees that 1229** the string will be valid and unchanged until xClose() is 1230** called. Because of the previous sentence, 1231** the [sqlite3_file] can safely store a pointer to the 1232** filename if it needs to remember the filename for some reason. 1233** If the zFilename parameter to xOpen is a NULL pointer then xOpen 1234** must invent its own temporary name for the file. ^Whenever the 1235** xFilename parameter is NULL it will also be the case that the 1236** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 1237** 1238** The flags argument to xOpen() includes all bits set in 1239** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 1240** or [sqlite3_open16()] is used, then flags includes at least 1241** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 1242** If xOpen() opens a file read-only then it sets *pOutFlags to 1243** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 1244** 1245** ^(SQLite will also add one of the following flags to the xOpen() 1246** call, depending on the object being opened: 1247** 1248** <ul> 1249** <li> [SQLITE_OPEN_MAIN_DB] 1250** <li> [SQLITE_OPEN_MAIN_JOURNAL] 1251** <li> [SQLITE_OPEN_TEMP_DB] 1252** <li> [SQLITE_OPEN_TEMP_JOURNAL] 1253** <li> [SQLITE_OPEN_TRANSIENT_DB] 1254** <li> [SQLITE_OPEN_SUBJOURNAL] 1255** <li> [SQLITE_OPEN_MASTER_JOURNAL] 1256** <li> [SQLITE_OPEN_WAL] 1257** </ul>)^ 1258** 1259** The file I/O implementation can use the object type flags to 1260** change the way it deals with files. For example, an application 1261** that does not care about crash recovery or rollback might make 1262** the open of a journal file a no-op. Writes to this journal would 1263** also be no-ops, and any attempt to read the journal would return 1264** SQLITE_IOERR. Or the implementation might recognize that a database 1265** file will be doing page-aligned sector reads and writes in a random 1266** order and set up its I/O subsystem accordingly. 1267** 1268** SQLite might also add one of the following flags to the xOpen method: 1269** 1270** <ul> 1271** <li> [SQLITE_OPEN_DELETEONCLOSE] 1272** <li> [SQLITE_OPEN_EXCLUSIVE] 1273** </ul> 1274** 1275** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 1276** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] 1277** will be set for TEMP databases and their journals, transient 1278** databases, and subjournals. 1279** 1280** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction 1281** with the [SQLITE_OPEN_CREATE] flag, which are both directly 1282** analogous to the O_EXCL and O_CREAT flags of the POSIX open() 1283** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 1284** SQLITE_OPEN_CREATE, is used to indicate that file should always 1285** be created, and that it is an error if it already exists. 1286** It is <i>not</i> used to indicate the file should be opened 1287** for exclusive access. 1288** 1289** ^At least szOsFile bytes of memory are allocated by SQLite 1290** to hold the [sqlite3_file] structure passed as the third 1291** argument to xOpen. The xOpen method does not have to 1292** allocate the structure; it should just fill it in. Note that 1293** the xOpen method must set the sqlite3_file.pMethods to either 1294** a valid [sqlite3_io_methods] object or to NULL. xOpen must do 1295** this even if the open fails. SQLite expects that the sqlite3_file.pMethods 1296** element will be valid after xOpen returns regardless of the success 1297** or failure of the xOpen call. 1298** 1299** [[sqlite3_vfs.xAccess]] 1300** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 1301** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 1302** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 1303** to test whether a file is at least readable. The SQLITE_ACCESS_READ 1304** flag is never actually used and is not implemented in the built-in 1305** VFSes of SQLite. The file is named by the second argument and can be a 1306** directory. The xAccess method returns [SQLITE_OK] on success or some 1307** non-zero error code if there is an I/O error or if the name of 1308** the file given in the second argument is illegal. If SQLITE_OK 1309** is returned, then non-zero or zero is written into *pResOut to indicate 1310** whether or not the file is accessible. 1311** 1312** ^SQLite will always allocate at least mxPathname+1 bytes for the 1313** output buffer xFullPathname. The exact size of the output buffer 1314** is also passed as a parameter to both methods. If the output buffer 1315** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 1316** handled as a fatal error by SQLite, vfs implementations should endeavor 1317** to prevent this by setting mxPathname to a sufficiently large value. 1318** 1319** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() 1320** interfaces are not strictly a part of the filesystem, but they are 1321** included in the VFS structure for completeness. 1322** The xRandomness() function attempts to return nBytes bytes 1323** of good-quality randomness into zOut. The return value is 1324** the actual number of bytes of randomness obtained. 1325** The xSleep() method causes the calling thread to sleep for at 1326** least the number of microseconds given. ^The xCurrentTime() 1327** method returns a Julian Day Number for the current date and time as 1328** a floating point value. 1329** ^The xCurrentTimeInt64() method returns, as an integer, the Julian 1330** Day Number multiplied by 86400000 (the number of milliseconds in 1331** a 24-hour day). 1332** ^SQLite will use the xCurrentTimeInt64() method to get the current 1333** date and time if that method is available (if iVersion is 2 or 1334** greater and the function pointer is not NULL) and will fall back 1335** to xCurrentTime() if xCurrentTimeInt64() is unavailable. 1336** 1337** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces 1338** are not used by the SQLite core. These optional interfaces are provided 1339** by some VFSes to facilitate testing of the VFS code. By overriding 1340** system calls with functions under its control, a test program can 1341** simulate faults and error conditions that would otherwise be difficult 1342** or impossible to induce. The set of system calls that can be overridden 1343** varies from one VFS to another, and from one version of the same VFS to the 1344** next. Applications that use these interfaces must be prepared for any 1345** or all of these interfaces to be NULL or for their behavior to change 1346** from one release to the next. Applications must not attempt to access 1347** any of these methods if the iVersion of the VFS is less than 3. 1348*/ 1349typedef struct sqlite3_vfs sqlite3_vfs; 1350typedef void (*sqlite3_syscall_ptr)(void); 1351struct sqlite3_vfs { 1352 int iVersion; /* Structure version number (currently 3) */ 1353 int szOsFile; /* Size of subclassed sqlite3_file */ 1354 int mxPathname; /* Maximum file pathname length */ 1355 sqlite3_vfs *pNext; /* Next registered VFS */ 1356 const char *zName; /* Name of this virtual file system */ 1357 void *pAppData; /* Pointer to application-specific data */ 1358 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 1359 int flags, int *pOutFlags); 1360 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 1361 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 1362 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 1363 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 1364 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 1365 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); 1366 void (*xDlClose)(sqlite3_vfs*, void*); 1367 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 1368 int (*xSleep)(sqlite3_vfs*, int microseconds); 1369 int (*xCurrentTime)(sqlite3_vfs*, double*); 1370 int (*xGetLastError)(sqlite3_vfs*, int, char *); 1371 /* 1372 ** The methods above are in version 1 of the sqlite_vfs object 1373 ** definition. Those that follow are added in version 2 or later 1374 */ 1375 int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); 1376 /* 1377 ** The methods above are in versions 1 and 2 of the sqlite_vfs object. 1378 ** Those below are for version 3 and greater. 1379 */ 1380 int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); 1381 sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); 1382 const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); 1383 /* 1384 ** The methods above are in versions 1 through 3 of the sqlite_vfs object. 1385 ** New fields may be appended in future versions. The iVersion 1386 ** value will increment whenever this happens. 1387 */ 1388}; 1389 1390/* 1391** CAPI3REF: Flags for the xAccess VFS method 1392** 1393** These integer constants can be used as the third parameter to 1394** the xAccess method of an [sqlite3_vfs] object. They determine 1395** what kind of permissions the xAccess method is looking for. 1396** With SQLITE_ACCESS_EXISTS, the xAccess method 1397** simply checks whether the file exists. 1398** With SQLITE_ACCESS_READWRITE, the xAccess method 1399** checks whether the named directory is both readable and writable 1400** (in other words, if files can be added, removed, and renamed within 1401** the directory). 1402** The SQLITE_ACCESS_READWRITE constant is currently used only by the 1403** [temp_store_directory pragma], though this could change in a future 1404** release of SQLite. 1405** With SQLITE_ACCESS_READ, the xAccess method 1406** checks whether the file is readable. The SQLITE_ACCESS_READ constant is 1407** currently unused, though it might be used in a future release of 1408** SQLite. 1409*/ 1410#define SQLITE_ACCESS_EXISTS 0 1411#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ 1412#define SQLITE_ACCESS_READ 2 /* Unused */ 1413 1414/* 1415** CAPI3REF: Flags for the xShmLock VFS method 1416** 1417** These integer constants define the various locking operations 1418** allowed by the xShmLock method of [sqlite3_io_methods]. The 1419** following are the only legal combinations of flags to the 1420** xShmLock method: 1421** 1422** <ul> 1423** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED 1424** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE 1425** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED 1426** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE 1427** </ul> 1428** 1429** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as 1430** was given on the corresponding lock. 1431** 1432** The xShmLock method can transition between unlocked and SHARED or 1433** between unlocked and EXCLUSIVE. It cannot transition between SHARED 1434** and EXCLUSIVE. 1435*/ 1436#define SQLITE_SHM_UNLOCK 1 1437#define SQLITE_SHM_LOCK 2 1438#define SQLITE_SHM_SHARED 4 1439#define SQLITE_SHM_EXCLUSIVE 8 1440 1441/* 1442** CAPI3REF: Maximum xShmLock index 1443** 1444** The xShmLock method on [sqlite3_io_methods] may use values 1445** between 0 and this upper bound as its "offset" argument. 1446** The SQLite core will never attempt to acquire or release a 1447** lock outside of this range 1448*/ 1449#define SQLITE_SHM_NLOCK 8 1450 1451 1452/* 1453** CAPI3REF: Initialize The SQLite Library 1454** 1455** ^The sqlite3_initialize() routine initializes the 1456** SQLite library. ^The sqlite3_shutdown() routine 1457** deallocates any resources that were allocated by sqlite3_initialize(). 1458** These routines are designed to aid in process initialization and 1459** shutdown on embedded systems. Workstation applications using 1460** SQLite normally do not need to invoke either of these routines. 1461** 1462** A call to sqlite3_initialize() is an "effective" call if it is 1463** the first time sqlite3_initialize() is invoked during the lifetime of 1464** the process, or if it is the first time sqlite3_initialize() is invoked 1465** following a call to sqlite3_shutdown(). ^(Only an effective call 1466** of sqlite3_initialize() does any initialization. All other calls 1467** are harmless no-ops.)^ 1468** 1469** A call to sqlite3_shutdown() is an "effective" call if it is the first 1470** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only 1471** an effective call to sqlite3_shutdown() does any deinitialization. 1472** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ 1473** 1474** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() 1475** is not. The sqlite3_shutdown() interface must only be called from a 1476** single thread. All open [database connections] must be closed and all 1477** other SQLite resources must be deallocated prior to invoking 1478** sqlite3_shutdown(). 1479** 1480** Among other things, ^sqlite3_initialize() will invoke 1481** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() 1482** will invoke sqlite3_os_end(). 1483** 1484** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. 1485** ^If for some reason, sqlite3_initialize() is unable to initialize 1486** the library (perhaps it is unable to allocate a needed resource such 1487** as a mutex) it returns an [error code] other than [SQLITE_OK]. 1488** 1489** ^The sqlite3_initialize() routine is called internally by many other 1490** SQLite interfaces so that an application usually does not need to 1491** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 1492** calls sqlite3_initialize() so the SQLite library will be automatically 1493** initialized when [sqlite3_open()] is called if it has not be initialized 1494** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] 1495** compile-time option, then the automatic calls to sqlite3_initialize() 1496** are omitted and the application must call sqlite3_initialize() directly 1497** prior to using any other SQLite interface. For maximum portability, 1498** it is recommended that applications always invoke sqlite3_initialize() 1499** directly prior to using any other SQLite interface. Future releases 1500** of SQLite may require this. In other words, the behavior exhibited 1501** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the 1502** default behavior in some future release of SQLite. 1503** 1504** The sqlite3_os_init() routine does operating-system specific 1505** initialization of the SQLite library. The sqlite3_os_end() 1506** routine undoes the effect of sqlite3_os_init(). Typical tasks 1507** performed by these routines include allocation or deallocation 1508** of static resources, initialization of global variables, 1509** setting up a default [sqlite3_vfs] module, or setting up 1510** a default configuration using [sqlite3_config()]. 1511** 1512** The application should never invoke either sqlite3_os_init() 1513** or sqlite3_os_end() directly. The application should only invoke 1514** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() 1515** interface is called automatically by sqlite3_initialize() and 1516** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate 1517** implementations for sqlite3_os_init() and sqlite3_os_end() 1518** are built into SQLite when it is compiled for Unix, Windows, or OS/2. 1519** When [custom builds | built for other platforms] 1520** (using the [SQLITE_OS_OTHER=1] compile-time 1521** option) the application must supply a suitable implementation for 1522** sqlite3_os_init() and sqlite3_os_end(). An application-supplied 1523** implementation of sqlite3_os_init() or sqlite3_os_end() 1524** must return [SQLITE_OK] on success and some other [error code] upon 1525** failure. 1526*/ 1527int sqlite3_initialize(void); 1528int sqlite3_shutdown(void); 1529int sqlite3_os_init(void); 1530int sqlite3_os_end(void); 1531 1532/* 1533** CAPI3REF: Configuring The SQLite Library 1534** 1535** The sqlite3_config() interface is used to make global configuration 1536** changes to SQLite in order to tune SQLite to the specific needs of 1537** the application. The default configuration is recommended for most 1538** applications and so this routine is usually not necessary. It is 1539** provided to support rare applications with unusual needs. 1540** 1541** <b>The sqlite3_config() interface is not threadsafe. The application 1542** must ensure that no other SQLite interfaces are invoked by other 1543** threads while sqlite3_config() is running.</b> 1544** 1545** The sqlite3_config() interface 1546** may only be invoked prior to library initialization using 1547** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 1548** ^If sqlite3_config() is called after [sqlite3_initialize()] and before 1549** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. 1550** Note, however, that ^sqlite3_config() can be called as part of the 1551** implementation of an application-defined [sqlite3_os_init()]. 1552** 1553** The first argument to sqlite3_config() is an integer 1554** [configuration option] that determines 1555** what property of SQLite is to be configured. Subsequent arguments 1556** vary depending on the [configuration option] 1557** in the first argument. 1558** 1559** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 1560** ^If the option is unknown or SQLite is unable to set the option 1561** then this routine returns a non-zero [error code]. 1562*/ 1563int sqlite3_config(int, ...); 1564 1565/* 1566** CAPI3REF: Configure database connections 1567** METHOD: sqlite3 1568** 1569** The sqlite3_db_config() interface is used to make configuration 1570** changes to a [database connection]. The interface is similar to 1571** [sqlite3_config()] except that the changes apply to a single 1572** [database connection] (specified in the first argument). 1573** 1574** The second argument to sqlite3_db_config(D,V,...) is the 1575** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code 1576** that indicates what aspect of the [database connection] is being configured. 1577** Subsequent arguments vary depending on the configuration verb. 1578** 1579** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if 1580** the call is considered successful. 1581*/ 1582int sqlite3_db_config(sqlite3*, int op, ...); 1583 1584/* 1585** CAPI3REF: Memory Allocation Routines 1586** 1587** An instance of this object defines the interface between SQLite 1588** and low-level memory allocation routines. 1589** 1590** This object is used in only one place in the SQLite interface. 1591** A pointer to an instance of this object is the argument to 1592** [sqlite3_config()] when the configuration option is 1593** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. 1594** By creating an instance of this object 1595** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) 1596** during configuration, an application can specify an alternative 1597** memory allocation subsystem for SQLite to use for all of its 1598** dynamic memory needs. 1599** 1600** Note that SQLite comes with several [built-in memory allocators] 1601** that are perfectly adequate for the overwhelming majority of applications 1602** and that this object is only useful to a tiny minority of applications 1603** with specialized memory allocation requirements. This object is 1604** also used during testing of SQLite in order to specify an alternative 1605** memory allocator that simulates memory out-of-memory conditions in 1606** order to verify that SQLite recovers gracefully from such 1607** conditions. 1608** 1609** The xMalloc, xRealloc, and xFree methods must work like the 1610** malloc(), realloc() and free() functions from the standard C library. 1611** ^SQLite guarantees that the second argument to 1612** xRealloc is always a value returned by a prior call to xRoundup. 1613** 1614** xSize should return the allocated size of a memory allocation 1615** previously obtained from xMalloc or xRealloc. The allocated size 1616** is always at least as big as the requested size but may be larger. 1617** 1618** The xRoundup method returns what would be the allocated size of 1619** a memory allocation given a particular requested size. Most memory 1620** allocators round up memory allocations at least to the next multiple 1621** of 8. Some allocators round up to a larger multiple or to a power of 2. 1622** Every memory allocation request coming in through [sqlite3_malloc()] 1623** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, 1624** that causes the corresponding memory allocation to fail. 1625** 1626** The xInit method initializes the memory allocator. For example, 1627** it might allocate any required mutexes or initialize internal data 1628** structures. The xShutdown method is invoked (indirectly) by 1629** [sqlite3_shutdown()] and should deallocate any resources acquired 1630** by xInit. The pAppData pointer is used as the only parameter to 1631** xInit and xShutdown. 1632** 1633** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes 1634** the xInit method, so the xInit method need not be threadsafe. The 1635** xShutdown method is only called from [sqlite3_shutdown()] so it does 1636** not need to be threadsafe either. For all other methods, SQLite 1637** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the 1638** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which 1639** it is by default) and so the methods are automatically serialized. 1640** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other 1641** methods must be threadsafe or else make their own arrangements for 1642** serialization. 1643** 1644** SQLite will never invoke xInit() more than once without an intervening 1645** call to xShutdown(). 1646*/ 1647typedef struct sqlite3_mem_methods sqlite3_mem_methods; 1648struct sqlite3_mem_methods { 1649 void *(*xMalloc)(int); /* Memory allocation function */ 1650 void (*xFree)(void*); /* Free a prior allocation */ 1651 void *(*xRealloc)(void*,int); /* Resize an allocation */ 1652 int (*xSize)(void*); /* Return the size of an allocation */ 1653 int (*xRoundup)(int); /* Round up request size to allocation size */ 1654 int (*xInit)(void*); /* Initialize the memory allocator */ 1655 void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1656 void *pAppData; /* Argument to xInit() and xShutdown() */ 1657}; 1658 1659/* 1660** CAPI3REF: Configuration Options 1661** KEYWORDS: {configuration option} 1662** 1663** These constants are the available integer configuration options that 1664** can be passed as the first argument to the [sqlite3_config()] interface. 1665** 1666** New configuration options may be added in future releases of SQLite. 1667** Existing configuration options might be discontinued. Applications 1668** should check the return code from [sqlite3_config()] to make sure that 1669** the call worked. The [sqlite3_config()] interface will return a 1670** non-zero [error code] if a discontinued or unsupported configuration option 1671** is invoked. 1672** 1673** <dl> 1674** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1675** <dd>There are no arguments to this option. ^This option sets the 1676** [threading mode] to Single-thread. In other words, it disables 1677** all mutexing and puts SQLite into a mode where it can only be used 1678** by a single thread. ^If SQLite is compiled with 1679** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1680** it is not possible to change the [threading mode] from its default 1681** value of Single-thread and so [sqlite3_config()] will return 1682** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD 1683** configuration option.</dd> 1684** 1685** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1686** <dd>There are no arguments to this option. ^This option sets the 1687** [threading mode] to Multi-thread. In other words, it disables 1688** mutexing on [database connection] and [prepared statement] objects. 1689** The application is responsible for serializing access to 1690** [database connections] and [prepared statements]. But other mutexes 1691** are enabled so that SQLite will be safe to use in a multi-threaded 1692** environment as long as no two threads attempt to use the same 1693** [database connection] at the same time. ^If SQLite is compiled with 1694** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1695** it is not possible to set the Multi-thread [threading mode] and 1696** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1697** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> 1698** 1699** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt> 1700** <dd>There are no arguments to this option. ^This option sets the 1701** [threading mode] to Serialized. In other words, this option enables 1702** all mutexes including the recursive 1703** mutexes on [database connection] and [prepared statement] objects. 1704** In this mode (which is the default when SQLite is compiled with 1705** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1706** to [database connections] and [prepared statements] so that the 1707** application is free to use the same [database connection] or the 1708** same [prepared statement] in different threads at the same time. 1709** ^If SQLite is compiled with 1710** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1711** it is not possible to set the Serialized [threading mode] and 1712** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1713** SQLITE_CONFIG_SERIALIZED configuration option.</dd> 1714** 1715** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> 1716** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is 1717** a pointer to an instance of the [sqlite3_mem_methods] structure. 1718** The argument specifies 1719** alternative low-level memory allocation routines to be used in place of 1720** the memory allocation routines built into SQLite.)^ ^SQLite makes 1721** its own private copy of the content of the [sqlite3_mem_methods] structure 1722** before the [sqlite3_config()] call returns.</dd> 1723** 1724** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> 1725** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which 1726** is a pointer to an instance of the [sqlite3_mem_methods] structure. 1727** The [sqlite3_mem_methods] 1728** structure is filled with the currently defined memory allocation routines.)^ 1729** This option can be used to overload the default memory allocation 1730** routines with a wrapper that simulations memory allocation failure or 1731** tracks memory usage, for example. </dd> 1732** 1733** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt> 1734** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of 1735** type int, interpreted as a boolean, which if true provides a hint to 1736** SQLite that it should avoid large memory allocations if possible. 1737** SQLite will run faster if it is free to make large memory allocations, 1738** but some application might prefer to run slower in exchange for 1739** guarantees about memory fragmentation that are possible if large 1740** allocations are avoided. This hint is normally off. 1741** </dd> 1742** 1743** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1744** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int, 1745** interpreted as a boolean, which enables or disables the collection of 1746** memory allocation statistics. ^(When memory allocation statistics are 1747** disabled, the following SQLite interfaces become non-operational: 1748** <ul> 1749** <li> [sqlite3_hard_heap_limit64()] 1750** <li> [sqlite3_memory_used()] 1751** <li> [sqlite3_memory_highwater()] 1752** <li> [sqlite3_soft_heap_limit64()] 1753** <li> [sqlite3_status64()] 1754** </ul>)^ 1755** ^Memory allocation statistics are enabled by default unless SQLite is 1756** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory 1757** allocation statistics are disabled by default. 1758** </dd> 1759** 1760** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> 1761** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used. 1762** </dd> 1763** 1764** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> 1765** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool 1766** that SQLite can use for the database page cache with the default page 1767** cache implementation. 1768** This configuration option is a no-op if an application-defined page 1769** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2]. 1770** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to 1771** 8-byte aligned memory (pMem), the size of each page cache line (sz), 1772** and the number of cache lines (N). 1773** The sz argument should be the size of the largest database page 1774** (a power of two between 512 and 65536) plus some extra bytes for each 1775** page header. ^The number of extra bytes needed by the page header 1776** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ]. 1777** ^It is harmless, apart from the wasted memory, 1778** for the sz parameter to be larger than necessary. The pMem 1779** argument must be either a NULL pointer or a pointer to an 8-byte 1780** aligned block of memory of at least sz*N bytes, otherwise 1781** subsequent behavior is undefined. 1782** ^When pMem is not NULL, SQLite will strive to use the memory provided 1783** to satisfy page cache needs, falling back to [sqlite3_malloc()] if 1784** a page cache line is larger than sz bytes or if all of the pMem buffer 1785** is exhausted. 1786** ^If pMem is NULL and N is non-zero, then each database connection 1787** does an initial bulk allocation for page cache memory 1788** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or 1789** of -1024*N bytes if N is negative, . ^If additional 1790** page cache memory is needed beyond what is provided by the initial 1791** allocation, then SQLite goes to [sqlite3_malloc()] separately for each 1792** additional cache line. </dd> 1793** 1794** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> 1795** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer 1796** that SQLite will use for all of its dynamic memory allocation needs 1797** beyond those provided for by [SQLITE_CONFIG_PAGECACHE]. 1798** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled 1799** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns 1800** [SQLITE_ERROR] if invoked otherwise. 1801** ^There are three arguments to SQLITE_CONFIG_HEAP: 1802** An 8-byte aligned pointer to the memory, 1803** the number of bytes in the memory buffer, and the minimum allocation size. 1804** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts 1805** to using its default memory allocator (the system malloc() implementation), 1806** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the 1807** memory pointer is not NULL then the alternative memory 1808** allocator is engaged to handle all of SQLites memory allocation needs. 1809** The first pointer (the memory pointer) must be aligned to an 8-byte 1810** boundary or subsequent behavior of SQLite will be undefined. 1811** The minimum allocation size is capped at 2**12. Reasonable values 1812** for the minimum allocation size are 2**5 through 2**8.</dd> 1813** 1814** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> 1815** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a 1816** pointer to an instance of the [sqlite3_mutex_methods] structure. 1817** The argument specifies alternative low-level mutex routines to be used 1818** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of 1819** the content of the [sqlite3_mutex_methods] structure before the call to 1820** [sqlite3_config()] returns. ^If SQLite is compiled with 1821** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1822** the entire mutexing subsystem is omitted from the build and hence calls to 1823** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will 1824** return [SQLITE_ERROR].</dd> 1825** 1826** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> 1827** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which 1828** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The 1829** [sqlite3_mutex_methods] 1830** structure is filled with the currently defined mutex routines.)^ 1831** This option can be used to overload the default mutex allocation 1832** routines with a wrapper used to track mutex usage for performance 1833** profiling or testing, for example. ^If SQLite is compiled with 1834** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1835** the entire mutexing subsystem is omitted from the build and hence calls to 1836** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will 1837** return [SQLITE_ERROR].</dd> 1838** 1839** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1840** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine 1841** the default size of lookaside memory on each [database connection]. 1842** The first argument is the 1843** size of each lookaside buffer slot and the second is the number of 1844** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE 1845** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] 1846** option to [sqlite3_db_config()] can be used to change the lookaside 1847** configuration on individual connections.)^ </dd> 1848** 1849** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> 1850** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is 1851** a pointer to an [sqlite3_pcache_methods2] object. This object specifies 1852** the interface to a custom page cache implementation.)^ 1853** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd> 1854** 1855** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> 1856** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which 1857** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of 1858** the current page cache implementation into that object.)^ </dd> 1859** 1860** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> 1861** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite 1862** global [error log]. 1863** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a 1864** function with a call signature of void(*)(void*,int,const char*), 1865** and a pointer to void. ^If the function pointer is not NULL, it is 1866** invoked by [sqlite3_log()] to process each logging event. ^If the 1867** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. 1868** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is 1869** passed through as the first parameter to the application-defined logger 1870** function whenever that function is invoked. ^The second parameter to 1871** the logger function is a copy of the first parameter to the corresponding 1872** [sqlite3_log()] call and is intended to be a [result code] or an 1873** [extended result code]. ^The third parameter passed to the logger is 1874** log message after formatting via [sqlite3_snprintf()]. 1875** The SQLite logging interface is not reentrant; the logger function 1876** supplied by the application must not invoke any SQLite interface. 1877** In a multi-threaded application, the application-defined logger 1878** function must be threadsafe. </dd> 1879** 1880** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI 1881** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int. 1882** If non-zero, then URI handling is globally enabled. If the parameter is zero, 1883** then URI handling is globally disabled.)^ ^If URI handling is globally 1884** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()], 1885** [sqlite3_open16()] or 1886** specified as part of [ATTACH] commands are interpreted as URIs, regardless 1887** of whether or not the [SQLITE_OPEN_URI] flag is set when the database 1888** connection is opened. ^If it is globally disabled, filenames are 1889** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the 1890** database connection is opened. ^(By default, URI handling is globally 1891** disabled. The default value may be changed by compiling with the 1892** [SQLITE_USE_URI] symbol defined.)^ 1893** 1894** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN 1895** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer 1896** argument which is interpreted as a boolean in order to enable or disable 1897** the use of covering indices for full table scans in the query optimizer. 1898** ^The default setting is determined 1899** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on" 1900** if that compile-time option is omitted. 1901** The ability to disable the use of covering indices for full table scans 1902** is because some incorrectly coded legacy applications might malfunction 1903** when the optimization is enabled. Providing the ability to 1904** disable the optimization allows the older, buggy application code to work 1905** without change even with newer versions of SQLite. 1906** 1907** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] 1908** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE 1909** <dd> These options are obsolete and should not be used by new code. 1910** They are retained for backwards compatibility but are now no-ops. 1911** </dd> 1912** 1913** [[SQLITE_CONFIG_SQLLOG]] 1914** <dt>SQLITE_CONFIG_SQLLOG 1915** <dd>This option is only available if sqlite is compiled with the 1916** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should 1917** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int). 1918** The second should be of type (void*). The callback is invoked by the library 1919** in three separate circumstances, identified by the value passed as the 1920** fourth parameter. If the fourth parameter is 0, then the database connection 1921** passed as the second argument has just been opened. The third argument 1922** points to a buffer containing the name of the main database file. If the 1923** fourth parameter is 1, then the SQL statement that the third parameter 1924** points to has just been executed. Or, if the fourth parameter is 2, then 1925** the connection being passed as the second parameter is being closed. The 1926** third parameter is passed NULL In this case. An example of using this 1927** configuration option can be seen in the "test_sqllog.c" source file in 1928** the canonical SQLite source tree.</dd> 1929** 1930** [[SQLITE_CONFIG_MMAP_SIZE]] 1931** <dt>SQLITE_CONFIG_MMAP_SIZE 1932** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values 1933** that are the default mmap size limit (the default setting for 1934** [PRAGMA mmap_size]) and the maximum allowed mmap size limit. 1935** ^The default setting can be overridden by each database connection using 1936** either the [PRAGMA mmap_size] command, or by using the 1937** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size 1938** will be silently truncated if necessary so that it does not exceed the 1939** compile-time maximum mmap size set by the 1940** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^ 1941** ^If either argument to this option is negative, then that argument is 1942** changed to its compile-time default. 1943** 1944** [[SQLITE_CONFIG_WIN32_HEAPSIZE]] 1945** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE 1946** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is 1947** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro 1948** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value 1949** that specifies the maximum size of the created heap. 1950** 1951** [[SQLITE_CONFIG_PCACHE_HDRSZ]] 1952** <dt>SQLITE_CONFIG_PCACHE_HDRSZ 1953** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which 1954** is a pointer to an integer and writes into that integer the number of extra 1955** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE]. 1956** The amount of extra space required can change depending on the compiler, 1957** target platform, and SQLite version. 1958** 1959** [[SQLITE_CONFIG_PMASZ]] 1960** <dt>SQLITE_CONFIG_PMASZ 1961** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which 1962** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded 1963** sorter to that integer. The default minimum PMA Size is set by the 1964** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched 1965** to help with sort operations when multithreaded sorting 1966** is enabled (using the [PRAGMA threads] command) and the amount of content 1967** to be sorted exceeds the page size times the minimum of the 1968** [PRAGMA cache_size] setting and this value. 1969** 1970** [[SQLITE_CONFIG_STMTJRNL_SPILL]] 1971** <dt>SQLITE_CONFIG_STMTJRNL_SPILL 1972** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which 1973** becomes the [statement journal] spill-to-disk threshold. 1974** [Statement journals] are held in memory until their size (in bytes) 1975** exceeds this threshold, at which point they are written to disk. 1976** Or if the threshold is -1, statement journals are always held 1977** exclusively in memory. 1978** Since many statement journals never become large, setting the spill 1979** threshold to a value such as 64KiB can greatly reduce the amount of 1980** I/O required to support statement rollback. 1981** The default value for this setting is controlled by the 1982** [SQLITE_STMTJRNL_SPILL] compile-time option. 1983** 1984** [[SQLITE_CONFIG_SORTERREF_SIZE]] 1985** <dt>SQLITE_CONFIG_SORTERREF_SIZE 1986** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter 1987** of type (int) - the new value of the sorter-reference size threshold. 1988** Usually, when SQLite uses an external sort to order records according 1989** to an ORDER BY clause, all fields required by the caller are present in the 1990** sorted records. However, if SQLite determines based on the declared type 1991** of a table column that its values are likely to be very large - larger 1992** than the configured sorter-reference size threshold - then a reference 1993** is stored in each sorted record and the required column values loaded 1994** from the database as records are returned in sorted order. The default 1995** value for this option is to never use this optimization. Specifying a 1996** negative value for this option restores the default behaviour. 1997** This option is only available if SQLite is compiled with the 1998** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option. 1999** 2000** [[SQLITE_CONFIG_MEMDB_MAXSIZE]] 2001** <dt>SQLITE_CONFIG_MEMDB_MAXSIZE 2002** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter 2003** [sqlite3_int64] parameter which is the default maximum size for an in-memory 2004** database created using [sqlite3_deserialize()]. This default maximum 2005** size can be adjusted up or down for individual databases using the 2006** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control|file-control]. If this 2007** configuration setting is never used, then the default maximum is determined 2008** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that 2009** compile-time option is not set, then the default maximum is 1073741824. 2010** </dl> 2011*/ 2012#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 2013#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 2014#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 2015#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 2016#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 2017#define SQLITE_CONFIG_SCRATCH 6 /* No longer used */ 2018#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 2019#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 2020#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 2021#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 2022#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 2023/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 2024#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 2025#define SQLITE_CONFIG_PCACHE 14 /* no-op */ 2026#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ 2027#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ 2028#define SQLITE_CONFIG_URI 17 /* int */ 2029#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ 2030#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ 2031#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */ 2032#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */ 2033#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */ 2034#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */ 2035#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */ 2036#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */ 2037#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */ 2038#define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */ 2039#define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */ 2040#define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */ 2041 2042/* 2043** CAPI3REF: Database Connection Configuration Options 2044** 2045** These constants are the available integer configuration options that 2046** can be passed as the second argument to the [sqlite3_db_config()] interface. 2047** 2048** New configuration options may be added in future releases of SQLite. 2049** Existing configuration options might be discontinued. Applications 2050** should check the return code from [sqlite3_db_config()] to make sure that 2051** the call worked. ^The [sqlite3_db_config()] interface will return a 2052** non-zero [error code] if a discontinued or unsupported configuration option 2053** is invoked. 2054** 2055** <dl> 2056** [[SQLITE_DBCONFIG_LOOKASIDE]] 2057** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 2058** <dd> ^This option takes three additional arguments that determine the 2059** [lookaside memory allocator] configuration for the [database connection]. 2060** ^The first argument (the third parameter to [sqlite3_db_config()] is a 2061** pointer to a memory buffer to use for lookaside memory. 2062** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb 2063** may be NULL in which case SQLite will allocate the 2064** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the 2065** size of each lookaside buffer slot. ^The third argument is the number of 2066** slots. The size of the buffer in the first argument must be greater than 2067** or equal to the product of the second and third arguments. The buffer 2068** must be aligned to an 8-byte boundary. ^If the second argument to 2069** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally 2070** rounded down to the next smaller multiple of 8. ^(The lookaside memory 2071** configuration for a database connection can only be changed when that 2072** connection is not currently using lookaside memory, or in other words 2073** when the "current value" returned by 2074** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. 2075** Any attempt to change the lookaside memory configuration when lookaside 2076** memory is in use leaves the configuration unchanged and returns 2077** [SQLITE_BUSY].)^</dd> 2078** 2079** [[SQLITE_DBCONFIG_ENABLE_FKEY]] 2080** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> 2081** <dd> ^This option is used to enable or disable the enforcement of 2082** [foreign key constraints]. There should be two additional arguments. 2083** The first argument is an integer which is 0 to disable FK enforcement, 2084** positive to enable FK enforcement or negative to leave FK enforcement 2085** unchanged. The second parameter is a pointer to an integer into which 2086** is written 0 or 1 to indicate whether FK enforcement is off or on 2087** following this call. The second parameter may be a NULL pointer, in 2088** which case the FK enforcement setting is not reported back. </dd> 2089** 2090** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]] 2091** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> 2092** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. 2093** There should be two additional arguments. 2094** The first argument is an integer which is 0 to disable triggers, 2095** positive to enable triggers or negative to leave the setting unchanged. 2096** The second parameter is a pointer to an integer into which 2097** is written 0 or 1 to indicate whether triggers are disabled or enabled 2098** following this call. The second parameter may be a NULL pointer, in 2099** which case the trigger setting is not reported back. </dd> 2100** 2101** [[SQLITE_DBCONFIG_ENABLE_VIEW]] 2102** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt> 2103** <dd> ^This option is used to enable or disable [CREATE VIEW | views]. 2104** There should be two additional arguments. 2105** The first argument is an integer which is 0 to disable views, 2106** positive to enable views or negative to leave the setting unchanged. 2107** The second parameter is a pointer to an integer into which 2108** is written 0 or 1 to indicate whether views are disabled or enabled 2109** following this call. The second parameter may be a NULL pointer, in 2110** which case the view setting is not reported back. </dd> 2111** 2112** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]] 2113** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt> 2114** <dd> ^This option is used to enable or disable the 2115** [fts3_tokenizer()] function which is part of the 2116** [FTS3] full-text search engine extension. 2117** There should be two additional arguments. 2118** The first argument is an integer which is 0 to disable fts3_tokenizer() or 2119** positive to enable fts3_tokenizer() or negative to leave the setting 2120** unchanged. 2121** The second parameter is a pointer to an integer into which 2122** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled 2123** following this call. The second parameter may be a NULL pointer, in 2124** which case the new setting is not reported back. </dd> 2125** 2126** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]] 2127** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt> 2128** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()] 2129** interface independently of the [load_extension()] SQL function. 2130** The [sqlite3_enable_load_extension()] API enables or disables both the 2131** C-API [sqlite3_load_extension()] and the SQL function [load_extension()]. 2132** There should be two additional arguments. 2133** When the first argument to this interface is 1, then only the C-API is 2134** enabled and the SQL function remains disabled. If the first argument to 2135** this interface is 0, then both the C-API and the SQL function are disabled. 2136** If the first argument is -1, then no changes are made to state of either the 2137** C-API or the SQL function. 2138** The second parameter is a pointer to an integer into which 2139** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface 2140** is disabled or enabled following this call. The second parameter may 2141** be a NULL pointer, in which case the new setting is not reported back. 2142** </dd> 2143** 2144** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt> 2145** <dd> ^This option is used to change the name of the "main" database 2146** schema. ^The sole argument is a pointer to a constant UTF8 string 2147** which will become the new schema name in place of "main". ^SQLite 2148** does not make a copy of the new main schema name string, so the application 2149** must ensure that the argument passed into this DBCONFIG option is unchanged 2150** until after the database connection closes. 2151** </dd> 2152** 2153** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]] 2154** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt> 2155** <dd> Usually, when a database in wal mode is closed or detached from a 2156** database handle, SQLite checks if this will mean that there are now no 2157** connections at all to the database. If so, it performs a checkpoint 2158** operation before closing the connection. This option may be used to 2159** override this behaviour. The first parameter passed to this operation 2160** is an integer - positive to disable checkpoints-on-close, or zero (the 2161** default) to enable them, and negative to leave the setting unchanged. 2162** The second parameter is a pointer to an integer 2163** into which is written 0 or 1 to indicate whether checkpoints-on-close 2164** have been disabled - 0 if they are not disabled, 1 if they are. 2165** </dd> 2166** 2167** [[SQLITE_DBCONFIG_ENABLE_QPSG]] <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt> 2168** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates 2169** the [query planner stability guarantee] (QPSG). When the QPSG is active, 2170** a single SQL query statement will always use the same algorithm regardless 2171** of values of [bound parameters].)^ The QPSG disables some query optimizations 2172** that look at the values of bound parameters, which can make some queries 2173** slower. But the QPSG has the advantage of more predictable behavior. With 2174** the QPSG active, SQLite will always use the same query plan in the field as 2175** was used during testing in the lab. 2176** The first argument to this setting is an integer which is 0 to disable 2177** the QPSG, positive to enable QPSG, or negative to leave the setting 2178** unchanged. The second parameter is a pointer to an integer into which 2179** is written 0 or 1 to indicate whether the QPSG is disabled or enabled 2180** following this call. 2181** </dd> 2182** 2183** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt> 2184** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not 2185** include output for any operations performed by trigger programs. This 2186** option is used to set or clear (the default) a flag that governs this 2187** behavior. The first parameter passed to this operation is an integer - 2188** positive to enable output for trigger programs, or zero to disable it, 2189** or negative to leave the setting unchanged. 2190** The second parameter is a pointer to an integer into which is written 2191** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if 2192** it is not disabled, 1 if it is. 2193** </dd> 2194** 2195** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt> 2196** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run 2197** [VACUUM] in order to reset a database back to an empty database 2198** with no schema and no content. The following process works even for 2199** a badly corrupted database file: 2200** <ol> 2201** <li> If the database connection is newly opened, make sure it has read the 2202** database schema by preparing then discarding some query against the 2203** database, or calling sqlite3_table_column_metadata(), ignoring any 2204** errors. This step is only necessary if the application desires to keep 2205** the database in WAL mode after the reset if it was in WAL mode before 2206** the reset. 2207** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0); 2208** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0); 2209** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0); 2210** </ol> 2211** Because resetting a database is destructive and irreversible, the 2212** process requires the use of this obscure API and multiple steps to help 2213** ensure that it does not happen by accident. 2214** 2215** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt> 2216** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the 2217** "defensive" flag for a database connection. When the defensive 2218** flag is enabled, language features that allow ordinary SQL to 2219** deliberately corrupt the database file are disabled. The disabled 2220** features include but are not limited to the following: 2221** <ul> 2222** <li> The [PRAGMA writable_schema=ON] statement. 2223** <li> The [PRAGMA journal_mode=OFF] statement. 2224** <li> Writes to the [sqlite_dbpage] virtual table. 2225** <li> Direct writes to [shadow tables]. 2226** </ul> 2227** </dd> 2228** 2229** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]] <dt>SQLITE_DBCONFIG_WRITABLE_SCHEMA</dt> 2230** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the 2231** "writable_schema" flag. This has the same effect and is logically equivalent 2232** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF]. 2233** The first argument to this setting is an integer which is 0 to disable 2234** the writable_schema, positive to enable writable_schema, or negative to 2235** leave the setting unchanged. The second parameter is a pointer to an 2236** integer into which is written 0 or 1 to indicate whether the writable_schema 2237** is enabled or disabled following this call. 2238** </dd> 2239** 2240** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]] 2241** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt> 2242** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates 2243** the legacy behavior of the [ALTER TABLE RENAME] command such it 2244** behaves as it did prior to [version 3.24.0] (2018-06-04). See the 2245** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for 2246** additional information. This feature can also be turned on and off 2247** using the [PRAGMA legacy_alter_table] statement. 2248** </dd> 2249** 2250** [[SQLITE_DBCONFIG_DQS_DML]] 2251** <dt>SQLITE_DBCONFIG_DQS_DML</td> 2252** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates 2253** the legacy [double-quoted string literal] misfeature for DML statements 2254** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The 2255** default value of this setting is determined by the [-DSQLITE_DQS] 2256** compile-time option. 2257** </dd> 2258** 2259** [[SQLITE_DBCONFIG_DQS_DDL]] 2260** <dt>SQLITE_DBCONFIG_DQS_DDL</td> 2261** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates 2262** the legacy [double-quoted string literal] misfeature for DDL statements, 2263** such as CREATE TABLE and CREATE INDEX. The 2264** default value of this setting is determined by the [-DSQLITE_DQS] 2265** compile-time option. 2266** </dd> 2267** 2268** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]] 2269** <dt>SQLITE_DBCONFIG_TRUSTED_SCHEMA</td> 2270** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells the SQLite to 2271** assume that database schemas are untainted by malicious content. 2272** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite 2273** takes additional defensive steps to protect the application from harm 2274** including, but not limited to, the following: 2275** <ul> 2276** <li> Prohibit the use of SQL functions inside triggers, views, 2277** CHECK constraints, DEFAULT VALUEs, index definitions, and/or 2278** generated columns unless those functions are tagged 2279** with [SQLITE_INNOCUOUS]. 2280** <li> Pohibit the use of virtual tables inside of triggers and/or views 2281** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS]. 2282** </ul> 2283** This setting defaults to "on" for legacy compatibility, however 2284** all applications are advised to turn it off if possible. 2285** </dd> 2286** 2287** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]] 2288** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</td> 2289** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates 2290** the legacy file format flag. When activated, this flag causes all newly 2291** created database file to have a schema format version number (the 4-byte 2292** integer found at offset 44 into the database header) of 1. This in turn 2293** means that the resulting database file will be readable and writable by 2294** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting, 2295** newly created databases are generally not understandable by SQLite versions 2296** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there 2297** is now scarcely any need to generated database files that are compatible 2298** all the way back to version 3.0.0, and so this setting is of little 2299** practical use, but is provided so that SQLite can continue to claim the 2300** ability to generate new database files that are compatible with version 2301** 3.0.0. 2302** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on, 2303** the [VACUUM] command will fail with an obscure error when attempting to 2304** process a table with generated columns and a descending index. This is 2305** not considered a bug since SQLite versions 3.3.0 and earlier do not support 2306** either generated columns or decending indexes. 2307** </dd> 2308** </dl> 2309*/ 2310#define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */ 2311#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 2312#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ 2313#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ 2314#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */ 2315#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */ 2316#define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */ 2317#define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */ 2318#define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */ 2319#define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */ 2320#define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */ 2321#define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */ 2322#define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */ 2323#define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */ 2324#define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */ 2325#define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */ 2326#define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */ 2327#define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */ 2328#define SQLITE_DBCONFIG_MAX 1017 /* Largest DBCONFIG */ 2329 2330/* 2331** CAPI3REF: Enable Or Disable Extended Result Codes 2332** METHOD: sqlite3 2333** 2334** ^The sqlite3_extended_result_codes() routine enables or disables the 2335** [extended result codes] feature of SQLite. ^The extended result 2336** codes are disabled by default for historical compatibility. 2337*/ 2338int sqlite3_extended_result_codes(sqlite3*, int onoff); 2339 2340/* 2341** CAPI3REF: Last Insert Rowid 2342** METHOD: sqlite3 2343** 2344** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables) 2345** has a unique 64-bit signed 2346** integer key called the [ROWID | "rowid"]. ^The rowid is always available 2347** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 2348** names are not also used by explicitly declared columns. ^If 2349** the table has a column of type [INTEGER PRIMARY KEY] then that column 2350** is another alias for the rowid. 2351** 2352** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of 2353** the most recent successful [INSERT] into a rowid table or [virtual table] 2354** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not 2355** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred 2356** on the database connection D, then sqlite3_last_insert_rowid(D) returns 2357** zero. 2358** 2359** As well as being set automatically as rows are inserted into database 2360** tables, the value returned by this function may be set explicitly by 2361** [sqlite3_set_last_insert_rowid()] 2362** 2363** Some virtual table implementations may INSERT rows into rowid tables as 2364** part of committing a transaction (e.g. to flush data accumulated in memory 2365** to disk). In this case subsequent calls to this function return the rowid 2366** associated with these internal INSERT operations, which leads to 2367** unintuitive results. Virtual table implementations that do write to rowid 2368** tables in this way can avoid this problem by restoring the original 2369** rowid value using [sqlite3_set_last_insert_rowid()] before returning 2370** control to the user. 2371** 2372** ^(If an [INSERT] occurs within a trigger then this routine will 2373** return the [rowid] of the inserted row as long as the trigger is 2374** running. Once the trigger program ends, the value returned 2375** by this routine reverts to what it was before the trigger was fired.)^ 2376** 2377** ^An [INSERT] that fails due to a constraint violation is not a 2378** successful [INSERT] and does not change the value returned by this 2379** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 2380** and INSERT OR ABORT make no changes to the return value of this 2381** routine when their insertion fails. ^(When INSERT OR REPLACE 2382** encounters a constraint violation, it does not fail. The 2383** INSERT continues to completion after deleting rows that caused 2384** the constraint problem so INSERT OR REPLACE will always change 2385** the return value of this interface.)^ 2386** 2387** ^For the purposes of this routine, an [INSERT] is considered to 2388** be successful even if it is subsequently rolled back. 2389** 2390** This function is accessible to SQL statements via the 2391** [last_insert_rowid() SQL function]. 2392** 2393** If a separate thread performs a new [INSERT] on the same 2394** database connection while the [sqlite3_last_insert_rowid()] 2395** function is running and thus changes the last insert [rowid], 2396** then the value returned by [sqlite3_last_insert_rowid()] is 2397** unpredictable and might not equal either the old or the new 2398** last insert [rowid]. 2399*/ 2400sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); 2401 2402/* 2403** CAPI3REF: Set the Last Insert Rowid value. 2404** METHOD: sqlite3 2405** 2406** The sqlite3_set_last_insert_rowid(D, R) method allows the application to 2407** set the value returned by calling sqlite3_last_insert_rowid(D) to R 2408** without inserting a row into the database. 2409*/ 2410void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64); 2411 2412/* 2413** CAPI3REF: Count The Number Of Rows Modified 2414** METHOD: sqlite3 2415** 2416** ^This function returns the number of rows modified, inserted or 2417** deleted by the most recently completed INSERT, UPDATE or DELETE 2418** statement on the database connection specified by the only parameter. 2419** ^Executing any other type of SQL statement does not modify the value 2420** returned by this function. 2421** 2422** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are 2423** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], 2424** [foreign key actions] or [REPLACE] constraint resolution are not counted. 2425** 2426** Changes to a view that are intercepted by 2427** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value 2428** returned by sqlite3_changes() immediately after an INSERT, UPDATE or 2429** DELETE statement run on a view is always zero. Only changes made to real 2430** tables are counted. 2431** 2432** Things are more complicated if the sqlite3_changes() function is 2433** executed while a trigger program is running. This may happen if the 2434** program uses the [changes() SQL function], or if some other callback 2435** function invokes sqlite3_changes() directly. Essentially: 2436** 2437** <ul> 2438** <li> ^(Before entering a trigger program the value returned by 2439** sqlite3_changes() function is saved. After the trigger program 2440** has finished, the original value is restored.)^ 2441** 2442** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE 2443** statement sets the value returned by sqlite3_changes() 2444** upon completion as normal. Of course, this value will not include 2445** any changes performed by sub-triggers, as the sqlite3_changes() 2446** value will be saved and restored after each sub-trigger has run.)^ 2447** </ul> 2448** 2449** ^This means that if the changes() SQL function (or similar) is used 2450** by the first INSERT, UPDATE or DELETE statement within a trigger, it 2451** returns the value as set when the calling statement began executing. 2452** ^If it is used by the second or subsequent such statement within a trigger 2453** program, the value returned reflects the number of rows modified by the 2454** previous INSERT, UPDATE or DELETE statement within the same trigger. 2455** 2456** If a separate thread makes changes on the same database connection 2457** while [sqlite3_changes()] is running then the value returned 2458** is unpredictable and not meaningful. 2459** 2460** See also: 2461** <ul> 2462** <li> the [sqlite3_total_changes()] interface 2463** <li> the [count_changes pragma] 2464** <li> the [changes() SQL function] 2465** <li> the [data_version pragma] 2466** </ul> 2467*/ 2468int sqlite3_changes(sqlite3*); 2469 2470/* 2471** CAPI3REF: Total Number Of Rows Modified 2472** METHOD: sqlite3 2473** 2474** ^This function returns the total number of rows inserted, modified or 2475** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed 2476** since the database connection was opened, including those executed as 2477** part of trigger programs. ^Executing any other type of SQL statement 2478** does not affect the value returned by sqlite3_total_changes(). 2479** 2480** ^Changes made as part of [foreign key actions] are included in the 2481** count, but those made as part of REPLACE constraint resolution are 2482** not. ^Changes to a view that are intercepted by INSTEAD OF triggers 2483** are not counted. 2484** 2485** The [sqlite3_total_changes(D)] interface only reports the number 2486** of rows that changed due to SQL statement run against database 2487** connection D. Any changes by other database connections are ignored. 2488** To detect changes against a database file from other database 2489** connections use the [PRAGMA data_version] command or the 2490** [SQLITE_FCNTL_DATA_VERSION] [file control]. 2491** 2492** If a separate thread makes changes on the same database connection 2493** while [sqlite3_total_changes()] is running then the value 2494** returned is unpredictable and not meaningful. 2495** 2496** See also: 2497** <ul> 2498** <li> the [sqlite3_changes()] interface 2499** <li> the [count_changes pragma] 2500** <li> the [changes() SQL function] 2501** <li> the [data_version pragma] 2502** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control] 2503** </ul> 2504*/ 2505int sqlite3_total_changes(sqlite3*); 2506 2507/* 2508** CAPI3REF: Interrupt A Long-Running Query 2509** METHOD: sqlite3 2510** 2511** ^This function causes any pending database operation to abort and 2512** return at its earliest opportunity. This routine is typically 2513** called in response to a user action such as pressing "Cancel" 2514** or Ctrl-C where the user wants a long query operation to halt 2515** immediately. 2516** 2517** ^It is safe to call this routine from a thread different from the 2518** thread that is currently running the database operation. But it 2519** is not safe to call this routine with a [database connection] that 2520** is closed or might close before sqlite3_interrupt() returns. 2521** 2522** ^If an SQL operation is very nearly finished at the time when 2523** sqlite3_interrupt() is called, then it might not have an opportunity 2524** to be interrupted and might continue to completion. 2525** 2526** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 2527** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 2528** that is inside an explicit transaction, then the entire transaction 2529** will be rolled back automatically. 2530** 2531** ^The sqlite3_interrupt(D) call is in effect until all currently running 2532** SQL statements on [database connection] D complete. ^Any new SQL statements 2533** that are started after the sqlite3_interrupt() call and before the 2534** running statement count reaches zero are interrupted as if they had been 2535** running prior to the sqlite3_interrupt() call. ^New SQL statements 2536** that are started after the running statement count reaches zero are 2537** not effected by the sqlite3_interrupt(). 2538** ^A call to sqlite3_interrupt(D) that occurs when there are no running 2539** SQL statements is a no-op and has no effect on SQL statements 2540** that are started after the sqlite3_interrupt() call returns. 2541*/ 2542void sqlite3_interrupt(sqlite3*); 2543 2544/* 2545** CAPI3REF: Determine If An SQL Statement Is Complete 2546** 2547** These routines are useful during command-line input to determine if the 2548** currently entered text seems to form a complete SQL statement or 2549** if additional input is needed before sending the text into 2550** SQLite for parsing. ^These routines return 1 if the input string 2551** appears to be a complete SQL statement. ^A statement is judged to be 2552** complete if it ends with a semicolon token and is not a prefix of a 2553** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within 2554** string literals or quoted identifier names or comments are not 2555** independent tokens (they are part of the token in which they are 2556** embedded) and thus do not count as a statement terminator. ^Whitespace 2557** and comments that follow the final semicolon are ignored. 2558** 2559** ^These routines return 0 if the statement is incomplete. ^If a 2560** memory allocation fails, then SQLITE_NOMEM is returned. 2561** 2562** ^These routines do not parse the SQL statements thus 2563** will not detect syntactically incorrect SQL. 2564** 2565** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior 2566** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked 2567** automatically by sqlite3_complete16(). If that initialization fails, 2568** then the return value from sqlite3_complete16() will be non-zero 2569** regardless of whether or not the input SQL is complete.)^ 2570** 2571** The input to [sqlite3_complete()] must be a zero-terminated 2572** UTF-8 string. 2573** 2574** The input to [sqlite3_complete16()] must be a zero-terminated 2575** UTF-16 string in native byte order. 2576*/ 2577int sqlite3_complete(const char *sql); 2578int sqlite3_complete16(const void *sql); 2579 2580/* 2581** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors 2582** KEYWORDS: {busy-handler callback} {busy handler} 2583** METHOD: sqlite3 2584** 2585** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X 2586** that might be invoked with argument P whenever 2587** an attempt is made to access a database table associated with 2588** [database connection] D when another thread 2589** or process has the table locked. 2590** The sqlite3_busy_handler() interface is used to implement 2591** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout]. 2592** 2593** ^If the busy callback is NULL, then [SQLITE_BUSY] 2594** is returned immediately upon encountering the lock. ^If the busy callback 2595** is not NULL, then the callback might be invoked with two arguments. 2596** 2597** ^The first argument to the busy handler is a copy of the void* pointer which 2598** is the third argument to sqlite3_busy_handler(). ^The second argument to 2599** the busy handler callback is the number of times that the busy handler has 2600** been invoked previously for the same locking event. ^If the 2601** busy callback returns 0, then no additional attempts are made to 2602** access the database and [SQLITE_BUSY] is returned 2603** to the application. 2604** ^If the callback returns non-zero, then another attempt 2605** is made to access the database and the cycle repeats. 2606** 2607** The presence of a busy handler does not guarantee that it will be invoked 2608** when there is lock contention. ^If SQLite determines that invoking the busy 2609** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 2610** to the application instead of invoking the 2611** busy handler. 2612** Consider a scenario where one process is holding a read lock that 2613** it is trying to promote to a reserved lock and 2614** a second process is holding a reserved lock that it is trying 2615** to promote to an exclusive lock. The first process cannot proceed 2616** because it is blocked by the second and the second process cannot 2617** proceed because it is blocked by the first. If both processes 2618** invoke the busy handlers, neither will make any progress. Therefore, 2619** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 2620** will induce the first process to release its read lock and allow 2621** the second process to proceed. 2622** 2623** ^The default busy callback is NULL. 2624** 2625** ^(There can only be a single busy handler defined for each 2626** [database connection]. Setting a new busy handler clears any 2627** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] 2628** or evaluating [PRAGMA busy_timeout=N] will change the 2629** busy handler and thus clear any previously set busy handler. 2630** 2631** The busy callback should not take any actions which modify the 2632** database connection that invoked the busy handler. In other words, 2633** the busy handler is not reentrant. Any such actions 2634** result in undefined behavior. 2635** 2636** A busy handler must not close the database connection 2637** or [prepared statement] that invoked the busy handler. 2638*/ 2639int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*); 2640 2641/* 2642** CAPI3REF: Set A Busy Timeout 2643** METHOD: sqlite3 2644** 2645** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 2646** for a specified amount of time when a table is locked. ^The handler 2647** will sleep multiple times until at least "ms" milliseconds of sleeping 2648** have accumulated. ^After at least "ms" milliseconds of sleeping, 2649** the handler returns 0 which causes [sqlite3_step()] to return 2650** [SQLITE_BUSY]. 2651** 2652** ^Calling this routine with an argument less than or equal to zero 2653** turns off all busy handlers. 2654** 2655** ^(There can only be a single busy handler for a particular 2656** [database connection] at any given moment. If another busy handler 2657** was defined (using [sqlite3_busy_handler()]) prior to calling 2658** this routine, that other busy handler is cleared.)^ 2659** 2660** See also: [PRAGMA busy_timeout] 2661*/ 2662int sqlite3_busy_timeout(sqlite3*, int ms); 2663 2664/* 2665** CAPI3REF: Convenience Routines For Running Queries 2666** METHOD: sqlite3 2667** 2668** This is a legacy interface that is preserved for backwards compatibility. 2669** Use of this interface is not recommended. 2670** 2671** Definition: A <b>result table</b> is memory data structure created by the 2672** [sqlite3_get_table()] interface. A result table records the 2673** complete query results from one or more queries. 2674** 2675** The table conceptually has a number of rows and columns. But 2676** these numbers are not part of the result table itself. These 2677** numbers are obtained separately. Let N be the number of rows 2678** and M be the number of columns. 2679** 2680** A result table is an array of pointers to zero-terminated UTF-8 strings. 2681** There are (N+1)*M elements in the array. The first M pointers point 2682** to zero-terminated strings that contain the names of the columns. 2683** The remaining entries all point to query results. NULL values result 2684** in NULL pointers. All other values are in their UTF-8 zero-terminated 2685** string representation as returned by [sqlite3_column_text()]. 2686** 2687** A result table might consist of one or more memory allocations. 2688** It is not safe to pass a result table directly to [sqlite3_free()]. 2689** A result table should be deallocated using [sqlite3_free_table()]. 2690** 2691** ^(As an example of the result table format, suppose a query result 2692** is as follows: 2693** 2694** <blockquote><pre> 2695** Name | Age 2696** ----------------------- 2697** Alice | 43 2698** Bob | 28 2699** Cindy | 21 2700** </pre></blockquote> 2701** 2702** There are two columns (M==2) and three rows (N==3). Thus the 2703** result table has 8 entries. Suppose the result table is stored 2704** in an array named azResult. Then azResult holds this content: 2705** 2706** <blockquote><pre> 2707** azResult[0] = "Name"; 2708** azResult[1] = "Age"; 2709** azResult[2] = "Alice"; 2710** azResult[3] = "43"; 2711** azResult[4] = "Bob"; 2712** azResult[5] = "28"; 2713** azResult[6] = "Cindy"; 2714** azResult[7] = "21"; 2715** </pre></blockquote>)^ 2716** 2717** ^The sqlite3_get_table() function evaluates one or more 2718** semicolon-separated SQL statements in the zero-terminated UTF-8 2719** string of its 2nd parameter and returns a result table to the 2720** pointer given in its 3rd parameter. 2721** 2722** After the application has finished with the result from sqlite3_get_table(), 2723** it must pass the result table pointer to sqlite3_free_table() in order to 2724** release the memory that was malloced. Because of the way the 2725** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 2726** function must not try to call [sqlite3_free()] directly. Only 2727** [sqlite3_free_table()] is able to release the memory properly and safely. 2728** 2729** The sqlite3_get_table() interface is implemented as a wrapper around 2730** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 2731** to any internal data structures of SQLite. It uses only the public 2732** interface defined here. As a consequence, errors that occur in the 2733** wrapper layer outside of the internal [sqlite3_exec()] call are not 2734** reflected in subsequent calls to [sqlite3_errcode()] or 2735** [sqlite3_errmsg()]. 2736*/ 2737int sqlite3_get_table( 2738 sqlite3 *db, /* An open database */ 2739 const char *zSql, /* SQL to be evaluated */ 2740 char ***pazResult, /* Results of the query */ 2741 int *pnRow, /* Number of result rows written here */ 2742 int *pnColumn, /* Number of result columns written here */ 2743 char **pzErrmsg /* Error msg written here */ 2744); 2745void sqlite3_free_table(char **result); 2746 2747/* 2748** CAPI3REF: Formatted String Printing Functions 2749** 2750** These routines are work-alikes of the "printf()" family of functions 2751** from the standard C library. 2752** These routines understand most of the common formatting options from 2753** the standard library printf() 2754** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]). 2755** See the [built-in printf()] documentation for details. 2756** 2757** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 2758** results into memory obtained from [sqlite3_malloc64()]. 2759** The strings returned by these two routines should be 2760** released by [sqlite3_free()]. ^Both routines return a 2761** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough 2762** memory to hold the resulting string. 2763** 2764** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from 2765** the standard C library. The result is written into the 2766** buffer supplied as the second parameter whose size is given by 2767** the first parameter. Note that the order of the 2768** first two parameters is reversed from snprintf().)^ This is an 2769** historical accident that cannot be fixed without breaking 2770** backwards compatibility. ^(Note also that sqlite3_snprintf() 2771** returns a pointer to its buffer instead of the number of 2772** characters actually written into the buffer.)^ We admit that 2773** the number of characters written would be a more useful return 2774** value but we cannot change the implementation of sqlite3_snprintf() 2775** now without breaking compatibility. 2776** 2777** ^As long as the buffer size is greater than zero, sqlite3_snprintf() 2778** guarantees that the buffer is always zero-terminated. ^The first 2779** parameter "n" is the total size of the buffer, including space for 2780** the zero terminator. So the longest string that can be completely 2781** written will be n-1 characters. 2782** 2783** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). 2784** 2785** See also: [built-in printf()], [printf() SQL function] 2786*/ 2787char *sqlite3_mprintf(const char*,...); 2788char *sqlite3_vmprintf(const char*, va_list); 2789char *sqlite3_snprintf(int,char*,const char*, ...); 2790char *sqlite3_vsnprintf(int,char*,const char*, va_list); 2791 2792/* 2793** CAPI3REF: Memory Allocation Subsystem 2794** 2795** The SQLite core uses these three routines for all of its own 2796** internal memory allocation needs. "Core" in the previous sentence 2797** does not include operating-system specific VFS implementation. The 2798** Windows VFS uses native malloc() and free() for some operations. 2799** 2800** ^The sqlite3_malloc() routine returns a pointer to a block 2801** of memory at least N bytes in length, where N is the parameter. 2802** ^If sqlite3_malloc() is unable to obtain sufficient free 2803** memory, it returns a NULL pointer. ^If the parameter N to 2804** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 2805** a NULL pointer. 2806** 2807** ^The sqlite3_malloc64(N) routine works just like 2808** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead 2809** of a signed 32-bit integer. 2810** 2811** ^Calling sqlite3_free() with a pointer previously returned 2812** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 2813** that it might be reused. ^The sqlite3_free() routine is 2814** a no-op if is called with a NULL pointer. Passing a NULL pointer 2815** to sqlite3_free() is harmless. After being freed, memory 2816** should neither be read nor written. Even reading previously freed 2817** memory might result in a segmentation fault or other severe error. 2818** Memory corruption, a segmentation fault, or other severe error 2819** might result if sqlite3_free() is called with a non-NULL pointer that 2820** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 2821** 2822** ^The sqlite3_realloc(X,N) interface attempts to resize a 2823** prior memory allocation X to be at least N bytes. 2824** ^If the X parameter to sqlite3_realloc(X,N) 2825** is a NULL pointer then its behavior is identical to calling 2826** sqlite3_malloc(N). 2827** ^If the N parameter to sqlite3_realloc(X,N) is zero or 2828** negative then the behavior is exactly the same as calling 2829** sqlite3_free(X). 2830** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation 2831** of at least N bytes in size or NULL if insufficient memory is available. 2832** ^If M is the size of the prior allocation, then min(N,M) bytes 2833** of the prior allocation are copied into the beginning of buffer returned 2834** by sqlite3_realloc(X,N) and the prior allocation is freed. 2835** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the 2836** prior allocation is not freed. 2837** 2838** ^The sqlite3_realloc64(X,N) interfaces works the same as 2839** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead 2840** of a 32-bit signed integer. 2841** 2842** ^If X is a memory allocation previously obtained from sqlite3_malloc(), 2843** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then 2844** sqlite3_msize(X) returns the size of that memory allocation in bytes. 2845** ^The value returned by sqlite3_msize(X) might be larger than the number 2846** of bytes requested when X was allocated. ^If X is a NULL pointer then 2847** sqlite3_msize(X) returns zero. If X points to something that is not 2848** the beginning of memory allocation, or if it points to a formerly 2849** valid memory allocation that has now been freed, then the behavior 2850** of sqlite3_msize(X) is undefined and possibly harmful. 2851** 2852** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(), 2853** sqlite3_malloc64(), and sqlite3_realloc64() 2854** is always aligned to at least an 8 byte boundary, or to a 2855** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time 2856** option is used. 2857** 2858** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 2859** must be either NULL or else pointers obtained from a prior 2860** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 2861** not yet been released. 2862** 2863** The application must not read or write any part of 2864** a block of memory after it has been released using 2865** [sqlite3_free()] or [sqlite3_realloc()]. 2866*/ 2867void *sqlite3_malloc(int); 2868void *sqlite3_malloc64(sqlite3_uint64); 2869void *sqlite3_realloc(void*, int); 2870void *sqlite3_realloc64(void*, sqlite3_uint64); 2871void sqlite3_free(void*); 2872sqlite3_uint64 sqlite3_msize(void*); 2873 2874/* 2875** CAPI3REF: Memory Allocator Statistics 2876** 2877** SQLite provides these two interfaces for reporting on the status 2878** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 2879** routines, which form the built-in memory allocation subsystem. 2880** 2881** ^The [sqlite3_memory_used()] routine returns the number of bytes 2882** of memory currently outstanding (malloced but not freed). 2883** ^The [sqlite3_memory_highwater()] routine returns the maximum 2884** value of [sqlite3_memory_used()] since the high-water mark 2885** was last reset. ^The values returned by [sqlite3_memory_used()] and 2886** [sqlite3_memory_highwater()] include any overhead 2887** added by SQLite in its implementation of [sqlite3_malloc()], 2888** but not overhead added by the any underlying system library 2889** routines that [sqlite3_malloc()] may call. 2890** 2891** ^The memory high-water mark is reset to the current value of 2892** [sqlite3_memory_used()] if and only if the parameter to 2893** [sqlite3_memory_highwater()] is true. ^The value returned 2894** by [sqlite3_memory_highwater(1)] is the high-water mark 2895** prior to the reset. 2896*/ 2897sqlite3_int64 sqlite3_memory_used(void); 2898sqlite3_int64 sqlite3_memory_highwater(int resetFlag); 2899 2900/* 2901** CAPI3REF: Pseudo-Random Number Generator 2902** 2903** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 2904** select random [ROWID | ROWIDs] when inserting new records into a table that 2905** already uses the largest possible [ROWID]. The PRNG is also used for 2906** the built-in random() and randomblob() SQL functions. This interface allows 2907** applications to access the same PRNG for other purposes. 2908** 2909** ^A call to this routine stores N bytes of randomness into buffer P. 2910** ^The P parameter can be a NULL pointer. 2911** 2912** ^If this routine has not been previously called or if the previous 2913** call had N less than one or a NULL pointer for P, then the PRNG is 2914** seeded using randomness obtained from the xRandomness method of 2915** the default [sqlite3_vfs] object. 2916** ^If the previous call to this routine had an N of 1 or more and a 2917** non-NULL P then the pseudo-randomness is generated 2918** internally and without recourse to the [sqlite3_vfs] xRandomness 2919** method. 2920*/ 2921void sqlite3_randomness(int N, void *P); 2922 2923/* 2924** CAPI3REF: Compile-Time Authorization Callbacks 2925** METHOD: sqlite3 2926** KEYWORDS: {authorizer callback} 2927** 2928** ^This routine registers an authorizer callback with a particular 2929** [database connection], supplied in the first argument. 2930** ^The authorizer callback is invoked as SQL statements are being compiled 2931** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 2932** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()], 2933** and [sqlite3_prepare16_v3()]. ^At various 2934** points during the compilation process, as logic is being created 2935** to perform various actions, the authorizer callback is invoked to 2936** see if those actions are allowed. ^The authorizer callback should 2937** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 2938** specific action but allow the SQL statement to continue to be 2939** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 2940** rejected with an error. ^If the authorizer callback returns 2941** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 2942** then the [sqlite3_prepare_v2()] or equivalent call that triggered 2943** the authorizer will fail with an error message. 2944** 2945** When the callback returns [SQLITE_OK], that means the operation 2946** requested is ok. ^When the callback returns [SQLITE_DENY], the 2947** [sqlite3_prepare_v2()] or equivalent call that triggered the 2948** authorizer will fail with an error message explaining that 2949** access is denied. 2950** 2951** ^The first parameter to the authorizer callback is a copy of the third 2952** parameter to the sqlite3_set_authorizer() interface. ^The second parameter 2953** to the callback is an integer [SQLITE_COPY | action code] that specifies 2954** the particular action to be authorized. ^The third through sixth parameters 2955** to the callback are either NULL pointers or zero-terminated strings 2956** that contain additional details about the action to be authorized. 2957** Applications must always be prepared to encounter a NULL pointer in any 2958** of the third through the sixth parameters of the authorization callback. 2959** 2960** ^If the action code is [SQLITE_READ] 2961** and the callback returns [SQLITE_IGNORE] then the 2962** [prepared statement] statement is constructed to substitute 2963** a NULL value in place of the table column that would have 2964** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 2965** return can be used to deny an untrusted user access to individual 2966** columns of a table. 2967** ^When a table is referenced by a [SELECT] but no column values are 2968** extracted from that table (for example in a query like 2969** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback 2970** is invoked once for that table with a column name that is an empty string. 2971** ^If the action code is [SQLITE_DELETE] and the callback returns 2972** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the 2973** [truncate optimization] is disabled and all rows are deleted individually. 2974** 2975** An authorizer is used when [sqlite3_prepare | preparing] 2976** SQL statements from an untrusted source, to ensure that the SQL statements 2977** do not try to access data they are not allowed to see, or that they do not 2978** try to execute malicious statements that damage the database. For 2979** example, an application may allow a user to enter arbitrary 2980** SQL queries for evaluation by a database. But the application does 2981** not want the user to be able to make arbitrary changes to the 2982** database. An authorizer could then be put in place while the 2983** user-entered SQL is being [sqlite3_prepare | prepared] that 2984** disallows everything except [SELECT] statements. 2985** 2986** Applications that need to process SQL from untrusted sources 2987** might also consider lowering resource limits using [sqlite3_limit()] 2988** and limiting database size using the [max_page_count] [PRAGMA] 2989** in addition to using an authorizer. 2990** 2991** ^(Only a single authorizer can be in place on a database connection 2992** at a time. Each call to sqlite3_set_authorizer overrides the 2993** previous call.)^ ^Disable the authorizer by installing a NULL callback. 2994** The authorizer is disabled by default. 2995** 2996** The authorizer callback must not do anything that will modify 2997** the database connection that invoked the authorizer callback. 2998** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2999** database connections for the meaning of "modify" in this paragraph. 3000** 3001** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the 3002** statement might be re-prepared during [sqlite3_step()] due to a 3003** schema change. Hence, the application should ensure that the 3004** correct authorizer callback remains in place during the [sqlite3_step()]. 3005** 3006** ^Note that the authorizer callback is invoked only during 3007** [sqlite3_prepare()] or its variants. Authorization is not 3008** performed during statement evaluation in [sqlite3_step()], unless 3009** as stated in the previous paragraph, sqlite3_step() invokes 3010** sqlite3_prepare_v2() to reprepare a statement after a schema change. 3011*/ 3012int sqlite3_set_authorizer( 3013 sqlite3*, 3014 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 3015 void *pUserData 3016); 3017 3018/* 3019** CAPI3REF: Authorizer Return Codes 3020** 3021** The [sqlite3_set_authorizer | authorizer callback function] must 3022** return either [SQLITE_OK] or one of these two constants in order 3023** to signal SQLite whether or not the action is permitted. See the 3024** [sqlite3_set_authorizer | authorizer documentation] for additional 3025** information. 3026** 3027** Note that SQLITE_IGNORE is also used as a [conflict resolution mode] 3028** returned from the [sqlite3_vtab_on_conflict()] interface. 3029*/ 3030#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 3031#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 3032 3033/* 3034** CAPI3REF: Authorizer Action Codes 3035** 3036** The [sqlite3_set_authorizer()] interface registers a callback function 3037** that is invoked to authorize certain SQL statement actions. The 3038** second parameter to the callback is an integer code that specifies 3039** what action is being authorized. These are the integer action codes that 3040** the authorizer callback may be passed. 3041** 3042** These action code values signify what kind of operation is to be 3043** authorized. The 3rd and 4th parameters to the authorization 3044** callback function will be parameters or NULL depending on which of these 3045** codes is used as the second parameter. ^(The 5th parameter to the 3046** authorizer callback is the name of the database ("main", "temp", 3047** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback 3048** is the name of the inner-most trigger or view that is responsible for 3049** the access attempt or NULL if this access attempt is directly from 3050** top-level SQL code. 3051*/ 3052/******************************************* 3rd ************ 4th ***********/ 3053#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 3054#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 3055#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 3056#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 3057#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 3058#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 3059#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 3060#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 3061#define SQLITE_DELETE 9 /* Table Name NULL */ 3062#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ 3063#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ 3064#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ 3065#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ 3066#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ 3067#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ 3068#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ 3069#define SQLITE_DROP_VIEW 17 /* View Name NULL */ 3070#define SQLITE_INSERT 18 /* Table Name NULL */ 3071#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ 3072#define SQLITE_READ 20 /* Table Name Column Name */ 3073#define SQLITE_SELECT 21 /* NULL NULL */ 3074#define SQLITE_TRANSACTION 22 /* Operation NULL */ 3075#define SQLITE_UPDATE 23 /* Table Name Column Name */ 3076#define SQLITE_ATTACH 24 /* Filename NULL */ 3077#define SQLITE_DETACH 25 /* Database Name NULL */ 3078#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 3079#define SQLITE_REINDEX 27 /* Index Name NULL */ 3080#define SQLITE_ANALYZE 28 /* Table Name NULL */ 3081#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 3082#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 3083#define SQLITE_FUNCTION 31 /* NULL Function Name */ 3084#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 3085#define SQLITE_COPY 0 /* No longer used */ 3086#define SQLITE_RECURSIVE 33 /* NULL NULL */ 3087 3088/* 3089** CAPI3REF: Tracing And Profiling Functions 3090** METHOD: sqlite3 3091** 3092** These routines are deprecated. Use the [sqlite3_trace_v2()] interface 3093** instead of the routines described here. 3094** 3095** These routines register callback functions that can be used for 3096** tracing and profiling the execution of SQL statements. 3097** 3098** ^The callback function registered by sqlite3_trace() is invoked at 3099** various times when an SQL statement is being run by [sqlite3_step()]. 3100** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the 3101** SQL statement text as the statement first begins executing. 3102** ^(Additional sqlite3_trace() callbacks might occur 3103** as each triggered subprogram is entered. The callbacks for triggers 3104** contain a UTF-8 SQL comment that identifies the trigger.)^ 3105** 3106** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit 3107** the length of [bound parameter] expansion in the output of sqlite3_trace(). 3108** 3109** ^The callback function registered by sqlite3_profile() is invoked 3110** as each SQL statement finishes. ^The profile callback contains 3111** the original statement text and an estimate of wall-clock time 3112** of how long that statement took to run. ^The profile callback 3113** time is in units of nanoseconds, however the current implementation 3114** is only capable of millisecond resolution so the six least significant 3115** digits in the time are meaningless. Future versions of SQLite 3116** might provide greater resolution on the profiler callback. Invoking 3117** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the 3118** profile callback. 3119*/ 3120SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*, 3121 void(*xTrace)(void*,const char*), void*); 3122SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*, 3123 void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 3124 3125/* 3126** CAPI3REF: SQL Trace Event Codes 3127** KEYWORDS: SQLITE_TRACE 3128** 3129** These constants identify classes of events that can be monitored 3130** using the [sqlite3_trace_v2()] tracing logic. The M argument 3131** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of 3132** the following constants. ^The first argument to the trace callback 3133** is one of the following constants. 3134** 3135** New tracing constants may be added in future releases. 3136** 3137** ^A trace callback has four arguments: xCallback(T,C,P,X). 3138** ^The T argument is one of the integer type codes above. 3139** ^The C argument is a copy of the context pointer passed in as the 3140** fourth argument to [sqlite3_trace_v2()]. 3141** The P and X arguments are pointers whose meanings depend on T. 3142** 3143** <dl> 3144** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt> 3145** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement 3146** first begins running and possibly at other times during the 3147** execution of the prepared statement, such as at the start of each 3148** trigger subprogram. ^The P argument is a pointer to the 3149** [prepared statement]. ^The X argument is a pointer to a string which 3150** is the unexpanded SQL text of the prepared statement or an SQL comment 3151** that indicates the invocation of a trigger. ^The callback can compute 3152** the same text that would have been returned by the legacy [sqlite3_trace()] 3153** interface by using the X argument when X begins with "--" and invoking 3154** [sqlite3_expanded_sql(P)] otherwise. 3155** 3156** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt> 3157** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same 3158** information as is provided by the [sqlite3_profile()] callback. 3159** ^The P argument is a pointer to the [prepared statement] and the 3160** X argument points to a 64-bit integer which is the estimated of 3161** the number of nanosecond that the prepared statement took to run. 3162** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes. 3163** 3164** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt> 3165** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared 3166** statement generates a single row of result. 3167** ^The P argument is a pointer to the [prepared statement] and the 3168** X argument is unused. 3169** 3170** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt> 3171** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database 3172** connection closes. 3173** ^The P argument is a pointer to the [database connection] object 3174** and the X argument is unused. 3175** </dl> 3176*/ 3177#define SQLITE_TRACE_STMT 0x01 3178#define SQLITE_TRACE_PROFILE 0x02 3179#define SQLITE_TRACE_ROW 0x04 3180#define SQLITE_TRACE_CLOSE 0x08 3181 3182/* 3183** CAPI3REF: SQL Trace Hook 3184** METHOD: sqlite3 3185** 3186** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback 3187** function X against [database connection] D, using property mask M 3188** and context pointer P. ^If the X callback is 3189** NULL or if the M mask is zero, then tracing is disabled. The 3190** M argument should be the bitwise OR-ed combination of 3191** zero or more [SQLITE_TRACE] constants. 3192** 3193** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides 3194** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2(). 3195** 3196** ^The X callback is invoked whenever any of the events identified by 3197** mask M occur. ^The integer return value from the callback is currently 3198** ignored, though this may change in future releases. Callback 3199** implementations should return zero to ensure future compatibility. 3200** 3201** ^A trace callback is invoked with four arguments: callback(T,C,P,X). 3202** ^The T argument is one of the [SQLITE_TRACE] 3203** constants to indicate why the callback was invoked. 3204** ^The C argument is a copy of the context pointer. 3205** The P and X arguments are pointers whose meanings depend on T. 3206** 3207** The sqlite3_trace_v2() interface is intended to replace the legacy 3208** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which 3209** are deprecated. 3210*/ 3211int sqlite3_trace_v2( 3212 sqlite3*, 3213 unsigned uMask, 3214 int(*xCallback)(unsigned,void*,void*,void*), 3215 void *pCtx 3216); 3217 3218/* 3219** CAPI3REF: Query Progress Callbacks 3220** METHOD: sqlite3 3221** 3222** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback 3223** function X to be invoked periodically during long running calls to 3224** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for 3225** database connection D. An example use for this 3226** interface is to keep a GUI updated during a large query. 3227** 3228** ^The parameter P is passed through as the only parameter to the 3229** callback function X. ^The parameter N is the approximate number of 3230** [virtual machine instructions] that are evaluated between successive 3231** invocations of the callback X. ^If N is less than one then the progress 3232** handler is disabled. 3233** 3234** ^Only a single progress handler may be defined at one time per 3235** [database connection]; setting a new progress handler cancels the 3236** old one. ^Setting parameter X to NULL disables the progress handler. 3237** ^The progress handler is also disabled by setting N to a value less 3238** than 1. 3239** 3240** ^If the progress callback returns non-zero, the operation is 3241** interrupted. This feature can be used to implement a 3242** "Cancel" button on a GUI progress dialog box. 3243** 3244** The progress handler callback must not do anything that will modify 3245** the database connection that invoked the progress handler. 3246** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 3247** database connections for the meaning of "modify" in this paragraph. 3248** 3249*/ 3250void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 3251 3252/* 3253** CAPI3REF: Opening A New Database Connection 3254** CONSTRUCTOR: sqlite3 3255** 3256** ^These routines open an SQLite database file as specified by the 3257** filename argument. ^The filename argument is interpreted as UTF-8 for 3258** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 3259** order for sqlite3_open16(). ^(A [database connection] handle is usually 3260** returned in *ppDb, even if an error occurs. The only exception is that 3261** if SQLite is unable to allocate memory to hold the [sqlite3] object, 3262** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 3263** object.)^ ^(If the database is opened (and/or created) successfully, then 3264** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The 3265** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 3266** an English language description of the error following a failure of any 3267** of the sqlite3_open() routines. 3268** 3269** ^The default encoding will be UTF-8 for databases created using 3270** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases 3271** created using sqlite3_open16() will be UTF-16 in the native byte order. 3272** 3273** Whether or not an error occurs when it is opened, resources 3274** associated with the [database connection] handle should be released by 3275** passing it to [sqlite3_close()] when it is no longer required. 3276** 3277** The sqlite3_open_v2() interface works like sqlite3_open() 3278** except that it accepts two additional parameters for additional control 3279** over the new database connection. ^(The flags parameter to 3280** sqlite3_open_v2() can take one of 3281** the following three values, optionally combined with the 3282** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], 3283** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ 3284** 3285** <dl> 3286** ^(<dt>[SQLITE_OPEN_READONLY]</dt> 3287** <dd>The database is opened in read-only mode. If the database does not 3288** already exist, an error is returned.</dd>)^ 3289** 3290** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> 3291** <dd>The database is opened for reading and writing if possible, or reading 3292** only if the file is write protected by the operating system. In either 3293** case the database must already exist, otherwise an error is returned.</dd>)^ 3294** 3295** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 3296** <dd>The database is opened for reading and writing, and is created if 3297** it does not already exist. This is the behavior that is always used for 3298** sqlite3_open() and sqlite3_open16().</dd>)^ 3299** </dl> 3300** 3301** If the 3rd parameter to sqlite3_open_v2() is not one of the 3302** combinations shown above optionally combined with other 3303** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] 3304** then the behavior is undefined. 3305** 3306** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 3307** opens in the multi-thread [threading mode] as long as the single-thread 3308** mode has not been set at compile-time or start-time. ^If the 3309** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 3310** in the serialized [threading mode] unless single-thread was 3311** previously selected at compile-time or start-time. 3312** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be 3313** eligible to use [shared cache mode], regardless of whether or not shared 3314** cache is enabled using [sqlite3_enable_shared_cache()]. ^The 3315** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not 3316** participate in [shared cache mode] even if it is enabled. 3317** 3318** ^The fourth parameter to sqlite3_open_v2() is the name of the 3319** [sqlite3_vfs] object that defines the operating system interface that 3320** the new database connection should use. ^If the fourth parameter is 3321** a NULL pointer then the default [sqlite3_vfs] object is used. 3322** 3323** ^If the filename is ":memory:", then a private, temporary in-memory database 3324** is created for the connection. ^This in-memory database will vanish when 3325** the database connection is closed. Future versions of SQLite might 3326** make use of additional special filenames that begin with the ":" character. 3327** It is recommended that when a database filename actually does begin with 3328** a ":" character you should prefix the filename with a pathname such as 3329** "./" to avoid ambiguity. 3330** 3331** ^If the filename is an empty string, then a private, temporary 3332** on-disk database will be created. ^This private database will be 3333** automatically deleted as soon as the database connection is closed. 3334** 3335** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3> 3336** 3337** ^If [URI filename] interpretation is enabled, and the filename argument 3338** begins with "file:", then the filename is interpreted as a URI. ^URI 3339** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is 3340** set in the third argument to sqlite3_open_v2(), or if it has 3341** been enabled globally using the [SQLITE_CONFIG_URI] option with the 3342** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. 3343** URI filename interpretation is turned off 3344** by default, but future releases of SQLite might enable URI filename 3345** interpretation by default. See "[URI filenames]" for additional 3346** information. 3347** 3348** URI filenames are parsed according to RFC 3986. ^If the URI contains an 3349** authority, then it must be either an empty string or the string 3350** "localhost". ^If the authority is not an empty string or "localhost", an 3351** error is returned to the caller. ^The fragment component of a URI, if 3352** present, is ignored. 3353** 3354** ^SQLite uses the path component of the URI as the name of the disk file 3355** which contains the database. ^If the path begins with a '/' character, 3356** then it is interpreted as an absolute path. ^If the path does not begin 3357** with a '/' (meaning that the authority section is omitted from the URI) 3358** then the path is interpreted as a relative path. 3359** ^(On windows, the first component of an absolute path 3360** is a drive specification (e.g. "C:").)^ 3361** 3362** [[core URI query parameters]] 3363** The query component of a URI may contain parameters that are interpreted 3364** either by SQLite itself, or by a [VFS | custom VFS implementation]. 3365** SQLite and its built-in [VFSes] interpret the 3366** following query parameters: 3367** 3368** <ul> 3369** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of 3370** a VFS object that provides the operating system interface that should 3371** be used to access the database file on disk. ^If this option is set to 3372** an empty string the default VFS object is used. ^Specifying an unknown 3373** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is 3374** present, then the VFS specified by the option takes precedence over 3375** the value passed as the fourth parameter to sqlite3_open_v2(). 3376** 3377** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw", 3378** "rwc", or "memory". Attempting to set it to any other value is 3379** an error)^. 3380** ^If "ro" is specified, then the database is opened for read-only 3381** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the 3382** third argument to sqlite3_open_v2(). ^If the mode option is set to 3383** "rw", then the database is opened for read-write (but not create) 3384** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had 3385** been set. ^Value "rwc" is equivalent to setting both 3386** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is 3387** set to "memory" then a pure [in-memory database] that never reads 3388** or writes from disk is used. ^It is an error to specify a value for 3389** the mode parameter that is less restrictive than that specified by 3390** the flags passed in the third parameter to sqlite3_open_v2(). 3391** 3392** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or 3393** "private". ^Setting it to "shared" is equivalent to setting the 3394** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to 3395** sqlite3_open_v2(). ^Setting the cache parameter to "private" is 3396** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. 3397** ^If sqlite3_open_v2() is used and the "cache" parameter is present in 3398** a URI filename, its value overrides any behavior requested by setting 3399** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. 3400** 3401** <li> <b>psow</b>: ^The psow parameter indicates whether or not the 3402** [powersafe overwrite] property does or does not apply to the 3403** storage media on which the database file resides. 3404** 3405** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter 3406** which if set disables file locking in rollback journal modes. This 3407** is useful for accessing a database on a filesystem that does not 3408** support locking. Caution: Database corruption might result if two 3409** or more processes write to the same database and any one of those 3410** processes uses nolock=1. 3411** 3412** <li> <b>immutable</b>: ^The immutable parameter is a boolean query 3413** parameter that indicates that the database file is stored on 3414** read-only media. ^When immutable is set, SQLite assumes that the 3415** database file cannot be changed, even by a process with higher 3416** privilege, and so the database is opened read-only and all locking 3417** and change detection is disabled. Caution: Setting the immutable 3418** property on a database file that does in fact change can result 3419** in incorrect query results and/or [SQLITE_CORRUPT] errors. 3420** See also: [SQLITE_IOCAP_IMMUTABLE]. 3421** 3422** </ul> 3423** 3424** ^Specifying an unknown parameter in the query component of a URI is not an 3425** error. Future versions of SQLite might understand additional query 3426** parameters. See "[query parameters with special meaning to SQLite]" for 3427** additional information. 3428** 3429** [[URI filename examples]] <h3>URI filename examples</h3> 3430** 3431** <table border="1" align=center cellpadding=5> 3432** <tr><th> URI filenames <th> Results 3433** <tr><td> file:data.db <td> 3434** Open the file "data.db" in the current directory. 3435** <tr><td> file:/home/fred/data.db<br> 3436** file:///home/fred/data.db <br> 3437** file://localhost/home/fred/data.db <br> <td> 3438** Open the database file "/home/fred/data.db". 3439** <tr><td> file://darkstar/home/fred/data.db <td> 3440** An error. "darkstar" is not a recognized authority. 3441** <tr><td style="white-space:nowrap"> 3442** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db 3443** <td> Windows only: Open the file "data.db" on fred's desktop on drive 3444** C:. Note that the %20 escaping in this example is not strictly 3445** necessary - space characters can be used literally 3446** in URI filenames. 3447** <tr><td> file:data.db?mode=ro&cache=private <td> 3448** Open file "data.db" in the current directory for read-only access. 3449** Regardless of whether or not shared-cache mode is enabled by 3450** default, use a private cache. 3451** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td> 3452** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile" 3453** that uses dot-files in place of posix advisory locking. 3454** <tr><td> file:data.db?mode=readonly <td> 3455** An error. "readonly" is not a valid option for the "mode" parameter. 3456** </table> 3457** 3458** ^URI hexadecimal escape sequences (%HH) are supported within the path and 3459** query components of a URI. A hexadecimal escape sequence consists of a 3460** percent sign - "%" - followed by exactly two hexadecimal digits 3461** specifying an octet value. ^Before the path or query components of a 3462** URI filename are interpreted, they are encoded using UTF-8 and all 3463** hexadecimal escape sequences replaced by a single byte containing the 3464** corresponding octet. If this process generates an invalid UTF-8 encoding, 3465** the results are undefined. 3466** 3467** <b>Note to Windows users:</b> The encoding used for the filename argument 3468** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 3469** codepage is currently defined. Filenames containing international 3470** characters must be converted to UTF-8 prior to passing them into 3471** sqlite3_open() or sqlite3_open_v2(). 3472** 3473** <b>Note to Windows Runtime users:</b> The temporary directory must be set 3474** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various 3475** features that require the use of temporary files may fail. 3476** 3477** See also: [sqlite3_temp_directory] 3478*/ 3479int sqlite3_open( 3480 const char *filename, /* Database filename (UTF-8) */ 3481 sqlite3 **ppDb /* OUT: SQLite db handle */ 3482); 3483int sqlite3_open16( 3484 const void *filename, /* Database filename (UTF-16) */ 3485 sqlite3 **ppDb /* OUT: SQLite db handle */ 3486); 3487int sqlite3_open_v2( 3488 const char *filename, /* Database filename (UTF-8) */ 3489 sqlite3 **ppDb, /* OUT: SQLite db handle */ 3490 int flags, /* Flags */ 3491 const char *zVfs /* Name of VFS module to use */ 3492); 3493 3494/* 3495** CAPI3REF: Obtain Values For URI Parameters 3496** 3497** These are utility routines, useful to VFS implementations, that check 3498** to see if a database file was a URI that contained a specific query 3499** parameter, and if so obtains the value of that query parameter. 3500** 3501** If F is the database filename pointer passed into the xOpen() method of 3502** a VFS implementation when the flags parameter to xOpen() has one or 3503** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and 3504** P is the name of the query parameter, then 3505** sqlite3_uri_parameter(F,P) returns the value of the P 3506** parameter if it exists or a NULL pointer if P does not appear as a 3507** query parameter on F. If P is a query parameter of F and it 3508** has no explicit value, then sqlite3_uri_parameter(F,P) returns 3509** a pointer to an empty string. 3510** 3511** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean 3512** parameter and returns true (1) or false (0) according to the value 3513** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the 3514** value of query parameter P is one of "yes", "true", or "on" in any 3515** case or if the value begins with a non-zero number. The 3516** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of 3517** query parameter P is one of "no", "false", or "off" in any case or 3518** if the value begins with a numeric zero. If P is not a query 3519** parameter on F or if the value of P does not match any of the 3520** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). 3521** 3522** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a 3523** 64-bit signed integer and returns that integer, or D if P does not 3524** exist. If the value of P is something other than an integer, then 3525** zero is returned. 3526** 3527** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and 3528** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and 3529** is not a database file pathname pointer that SQLite passed into the xOpen 3530** VFS method, then the behavior of this routine is undefined and probably 3531** undesirable. 3532** 3533** See the [URI filename] documentation for additional information. 3534*/ 3535const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); 3536int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); 3537sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); 3538 3539 3540/* 3541** CAPI3REF: Error Codes And Messages 3542** METHOD: sqlite3 3543** 3544** ^If the most recent sqlite3_* API call associated with 3545** [database connection] D failed, then the sqlite3_errcode(D) interface 3546** returns the numeric [result code] or [extended result code] for that 3547** API call. 3548** ^The sqlite3_extended_errcode() 3549** interface is the same except that it always returns the 3550** [extended result code] even when extended result codes are 3551** disabled. 3552** 3553** The values returned by sqlite3_errcode() and/or 3554** sqlite3_extended_errcode() might change with each API call. 3555** Except, there are some interfaces that are guaranteed to never 3556** change the value of the error code. The error-code preserving 3557** interfaces are: 3558** 3559** <ul> 3560** <li> sqlite3_errcode() 3561** <li> sqlite3_extended_errcode() 3562** <li> sqlite3_errmsg() 3563** <li> sqlite3_errmsg16() 3564** </ul> 3565** 3566** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 3567** text that describes the error, as either UTF-8 or UTF-16 respectively. 3568** ^(Memory to hold the error message string is managed internally. 3569** The application does not need to worry about freeing the result. 3570** However, the error string might be overwritten or deallocated by 3571** subsequent calls to other SQLite interface functions.)^ 3572** 3573** ^The sqlite3_errstr() interface returns the English-language text 3574** that describes the [result code], as UTF-8. 3575** ^(Memory to hold the error message string is managed internally 3576** and must not be freed by the application)^. 3577** 3578** When the serialized [threading mode] is in use, it might be the 3579** case that a second error occurs on a separate thread in between 3580** the time of the first error and the call to these interfaces. 3581** When that happens, the second error will be reported since these 3582** interfaces always report the most recent result. To avoid 3583** this, each thread can obtain exclusive use of the [database connection] D 3584** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 3585** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 3586** all calls to the interfaces listed here are completed. 3587** 3588** If an interface fails with SQLITE_MISUSE, that means the interface 3589** was invoked incorrectly by the application. In that case, the 3590** error code and message may or may not be set. 3591*/ 3592int sqlite3_errcode(sqlite3 *db); 3593int sqlite3_extended_errcode(sqlite3 *db); 3594const char *sqlite3_errmsg(sqlite3*); 3595const void *sqlite3_errmsg16(sqlite3*); 3596const char *sqlite3_errstr(int); 3597 3598/* 3599** CAPI3REF: Prepared Statement Object 3600** KEYWORDS: {prepared statement} {prepared statements} 3601** 3602** An instance of this object represents a single SQL statement that 3603** has been compiled into binary form and is ready to be evaluated. 3604** 3605** Think of each SQL statement as a separate computer program. The 3606** original SQL text is source code. A prepared statement object 3607** is the compiled object code. All SQL must be converted into a 3608** prepared statement before it can be run. 3609** 3610** The life-cycle of a prepared statement object usually goes like this: 3611** 3612** <ol> 3613** <li> Create the prepared statement object using [sqlite3_prepare_v2()]. 3614** <li> Bind values to [parameters] using the sqlite3_bind_*() 3615** interfaces. 3616** <li> Run the SQL by calling [sqlite3_step()] one or more times. 3617** <li> Reset the prepared statement using [sqlite3_reset()] then go back 3618** to step 2. Do this zero or more times. 3619** <li> Destroy the object using [sqlite3_finalize()]. 3620** </ol> 3621*/ 3622typedef struct sqlite3_stmt sqlite3_stmt; 3623 3624/* 3625** CAPI3REF: Run-time Limits 3626** METHOD: sqlite3 3627** 3628** ^(This interface allows the size of various constructs to be limited 3629** on a connection by connection basis. The first parameter is the 3630** [database connection] whose limit is to be set or queried. The 3631** second parameter is one of the [limit categories] that define a 3632** class of constructs to be size limited. The third parameter is the 3633** new limit for that construct.)^ 3634** 3635** ^If the new limit is a negative number, the limit is unchanged. 3636** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a 3637** [limits | hard upper bound] 3638** set at compile-time by a C preprocessor macro called 3639** [limits | SQLITE_MAX_<i>NAME</i>]. 3640** (The "_LIMIT_" in the name is changed to "_MAX_".))^ 3641** ^Attempts to increase a limit above its hard upper bound are 3642** silently truncated to the hard upper bound. 3643** 3644** ^Regardless of whether or not the limit was changed, the 3645** [sqlite3_limit()] interface returns the prior value of the limit. 3646** ^Hence, to find the current value of a limit without changing it, 3647** simply invoke this interface with the third parameter set to -1. 3648** 3649** Run-time limits are intended for use in applications that manage 3650** both their own internal database and also databases that are controlled 3651** by untrusted external sources. An example application might be a 3652** web browser that has its own databases for storing history and 3653** separate databases controlled by JavaScript applications downloaded 3654** off the Internet. The internal databases can be given the 3655** large, default limits. Databases managed by external sources can 3656** be given much smaller limits designed to prevent a denial of service 3657** attack. Developers might also want to use the [sqlite3_set_authorizer()] 3658** interface to further control untrusted SQL. The size of the database 3659** created by an untrusted script can be contained using the 3660** [max_page_count] [PRAGMA]. 3661** 3662** New run-time limit categories may be added in future releases. 3663*/ 3664int sqlite3_limit(sqlite3*, int id, int newVal); 3665 3666/* 3667** CAPI3REF: Run-Time Limit Categories 3668** KEYWORDS: {limit category} {*limit categories} 3669** 3670** These constants define various performance limits 3671** that can be lowered at run-time using [sqlite3_limit()]. 3672** The synopsis of the meanings of the various limits is shown below. 3673** Additional information is available at [limits | Limits in SQLite]. 3674** 3675** <dl> 3676** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt> 3677** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ 3678** 3679** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> 3680** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ 3681** 3682** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt> 3683** <dd>The maximum number of columns in a table definition or in the 3684** result set of a [SELECT] or the maximum number of columns in an index 3685** or in an ORDER BY or GROUP BY clause.</dd>)^ 3686** 3687** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 3688** <dd>The maximum depth of the parse tree on any expression.</dd>)^ 3689** 3690** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 3691** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ 3692** 3693** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> 3694** <dd>The maximum number of instructions in a virtual machine program 3695** used to implement an SQL statement. If [sqlite3_prepare_v2()] or 3696** the equivalent tries to allocate space for more than this many opcodes 3697** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^ 3698** 3699** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 3700** <dd>The maximum number of arguments on a function.</dd>)^ 3701** 3702** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt> 3703** <dd>The maximum number of [ATTACH | attached databases].)^</dd> 3704** 3705** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] 3706** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 3707** <dd>The maximum length of the pattern argument to the [LIKE] or 3708** [GLOB] operators.</dd>)^ 3709** 3710** [[SQLITE_LIMIT_VARIABLE_NUMBER]] 3711** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 3712** <dd>The maximum index number of any [parameter] in an SQL statement.)^ 3713** 3714** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> 3715** <dd>The maximum depth of recursion for triggers.</dd>)^ 3716** 3717** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt> 3718** <dd>The maximum number of auxiliary worker threads that a single 3719** [prepared statement] may start.</dd>)^ 3720** </dl> 3721*/ 3722#define SQLITE_LIMIT_LENGTH 0 3723#define SQLITE_LIMIT_SQL_LENGTH 1 3724#define SQLITE_LIMIT_COLUMN 2 3725#define SQLITE_LIMIT_EXPR_DEPTH 3 3726#define SQLITE_LIMIT_COMPOUND_SELECT 4 3727#define SQLITE_LIMIT_VDBE_OP 5 3728#define SQLITE_LIMIT_FUNCTION_ARG 6 3729#define SQLITE_LIMIT_ATTACHED 7 3730#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 3731#define SQLITE_LIMIT_VARIABLE_NUMBER 9 3732#define SQLITE_LIMIT_TRIGGER_DEPTH 10 3733#define SQLITE_LIMIT_WORKER_THREADS 11 3734 3735/* 3736** CAPI3REF: Prepare Flags 3737** 3738** These constants define various flags that can be passed into 3739** "prepFlags" parameter of the [sqlite3_prepare_v3()] and 3740** [sqlite3_prepare16_v3()] interfaces. 3741** 3742** New flags may be added in future releases of SQLite. 3743** 3744** <dl> 3745** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt> 3746** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner 3747** that the prepared statement will be retained for a long time and 3748** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()] 3749** and [sqlite3_prepare16_v3()] assume that the prepared statement will 3750** be used just once or at most a few times and then destroyed using 3751** [sqlite3_finalize()] relatively soon. The current implementation acts 3752** on this hint by avoiding the use of [lookaside memory] so as not to 3753** deplete the limited store of lookaside memory. Future versions of 3754** SQLite may act on this hint differently. 3755** 3756** [[SQLITE_PREPARE_NORMALIZE]] <dt>SQLITE_PREPARE_NORMALIZE</dt> 3757** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used 3758** to be required for any prepared statement that wanted to use the 3759** [sqlite3_normalized_sql()] interface. However, the 3760** [sqlite3_normalized_sql()] interface is now available to all 3761** prepared statements, regardless of whether or not they use this 3762** flag. 3763** 3764** [[SQLITE_PREPARE_NO_VTAB]] <dt>SQLITE_PREPARE_NO_VTAB</dt> 3765** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler 3766** to return an error (error code SQLITE_ERROR) if the statement uses 3767** any virtual tables. 3768** </dl> 3769*/ 3770#define SQLITE_PREPARE_PERSISTENT 0x01 3771#define SQLITE_PREPARE_NORMALIZE 0x02 3772#define SQLITE_PREPARE_NO_VTAB 0x04 3773 3774/* 3775** CAPI3REF: Compiling An SQL Statement 3776** KEYWORDS: {SQL statement compiler} 3777** METHOD: sqlite3 3778** CONSTRUCTOR: sqlite3_stmt 3779** 3780** To execute an SQL statement, it must first be compiled into a byte-code 3781** program using one of these routines. Or, in other words, these routines 3782** are constructors for the [prepared statement] object. 3783** 3784** The preferred routine to use is [sqlite3_prepare_v2()]. The 3785** [sqlite3_prepare()] interface is legacy and should be avoided. 3786** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used 3787** for special purposes. 3788** 3789** The use of the UTF-8 interfaces is preferred, as SQLite currently 3790** does all parsing using UTF-8. The UTF-16 interfaces are provided 3791** as a convenience. The UTF-16 interfaces work by converting the 3792** input text into UTF-8, then invoking the corresponding UTF-8 interface. 3793** 3794** The first argument, "db", is a [database connection] obtained from a 3795** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or 3796** [sqlite3_open16()]. The database connection must not have been closed. 3797** 3798** The second argument, "zSql", is the statement to be compiled, encoded 3799** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(), 3800** and sqlite3_prepare_v3() 3801** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(), 3802** and sqlite3_prepare16_v3() use UTF-16. 3803** 3804** ^If the nByte argument is negative, then zSql is read up to the 3805** first zero terminator. ^If nByte is positive, then it is the 3806** number of bytes read from zSql. ^If nByte is zero, then no prepared 3807** statement is generated. 3808** If the caller knows that the supplied string is nul-terminated, then 3809** there is a small performance advantage to passing an nByte parameter that 3810** is the number of bytes in the input string <i>including</i> 3811** the nul-terminator. 3812** 3813** ^If pzTail is not NULL then *pzTail is made to point to the first byte 3814** past the end of the first SQL statement in zSql. These routines only 3815** compile the first statement in zSql, so *pzTail is left pointing to 3816** what remains uncompiled. 3817** 3818** ^*ppStmt is left pointing to a compiled [prepared statement] that can be 3819** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set 3820** to NULL. ^If the input text contains no SQL (if the input is an empty 3821** string or a comment) then *ppStmt is set to NULL. 3822** The calling procedure is responsible for deleting the compiled 3823** SQL statement using [sqlite3_finalize()] after it has finished with it. 3824** ppStmt may not be NULL. 3825** 3826** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; 3827** otherwise an [error code] is returned. 3828** 3829** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(), 3830** and sqlite3_prepare16_v3() interfaces are recommended for all new programs. 3831** The older interfaces (sqlite3_prepare() and sqlite3_prepare16()) 3832** are retained for backwards compatibility, but their use is discouraged. 3833** ^In the "vX" interfaces, the prepared statement 3834** that is returned (the [sqlite3_stmt] object) contains a copy of the 3835** original SQL text. This causes the [sqlite3_step()] interface to 3836** behave differently in three ways: 3837** 3838** <ol> 3839** <li> 3840** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 3841** always used to do, [sqlite3_step()] will automatically recompile the SQL 3842** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY] 3843** retries will occur before sqlite3_step() gives up and returns an error. 3844** </li> 3845** 3846** <li> 3847** ^When an error occurs, [sqlite3_step()] will return one of the detailed 3848** [error codes] or [extended error codes]. ^The legacy behavior was that 3849** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 3850** and the application would have to make a second call to [sqlite3_reset()] 3851** in order to find the underlying cause of the problem. With the "v2" prepare 3852** interfaces, the underlying reason for the error is returned immediately. 3853** </li> 3854** 3855** <li> 3856** ^If the specific value bound to a [parameter | host parameter] in the 3857** WHERE clause might influence the choice of query plan for a statement, 3858** then the statement will be automatically recompiled, as if there had been 3859** a schema change, on the first [sqlite3_step()] call following any change 3860** to the [sqlite3_bind_text | bindings] of that [parameter]. 3861** ^The specific value of a WHERE-clause [parameter] might influence the 3862** choice of query plan if the parameter is the left-hand side of a [LIKE] 3863** or [GLOB] operator or if the parameter is compared to an indexed column 3864** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled. 3865** </li> 3866** </ol> 3867** 3868** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having 3869** the extra prepFlags parameter, which is a bit array consisting of zero or 3870** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The 3871** sqlite3_prepare_v2() interface works exactly the same as 3872** sqlite3_prepare_v3() with a zero prepFlags parameter. 3873*/ 3874int sqlite3_prepare( 3875 sqlite3 *db, /* Database handle */ 3876 const char *zSql, /* SQL statement, UTF-8 encoded */ 3877 int nByte, /* Maximum length of zSql in bytes. */ 3878 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 3879 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 3880); 3881int sqlite3_prepare_v2( 3882 sqlite3 *db, /* Database handle */ 3883 const char *zSql, /* SQL statement, UTF-8 encoded */ 3884 int nByte, /* Maximum length of zSql in bytes. */ 3885 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 3886 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 3887); 3888int sqlite3_prepare_v3( 3889 sqlite3 *db, /* Database handle */ 3890 const char *zSql, /* SQL statement, UTF-8 encoded */ 3891 int nByte, /* Maximum length of zSql in bytes. */ 3892 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ 3893 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 3894 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 3895); 3896int sqlite3_prepare16( 3897 sqlite3 *db, /* Database handle */ 3898 const void *zSql, /* SQL statement, UTF-16 encoded */ 3899 int nByte, /* Maximum length of zSql in bytes. */ 3900 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 3901 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 3902); 3903int sqlite3_prepare16_v2( 3904 sqlite3 *db, /* Database handle */ 3905 const void *zSql, /* SQL statement, UTF-16 encoded */ 3906 int nByte, /* Maximum length of zSql in bytes. */ 3907 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 3908 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 3909); 3910int sqlite3_prepare16_v3( 3911 sqlite3 *db, /* Database handle */ 3912 const void *zSql, /* SQL statement, UTF-16 encoded */ 3913 int nByte, /* Maximum length of zSql in bytes. */ 3914 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ 3915 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 3916 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 3917); 3918 3919/* 3920** CAPI3REF: Retrieving Statement SQL 3921** METHOD: sqlite3_stmt 3922** 3923** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8 3924** SQL text used to create [prepared statement] P if P was 3925** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], 3926** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()]. 3927** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8 3928** string containing the SQL text of prepared statement P with 3929** [bound parameters] expanded. 3930** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8 3931** string containing the normalized SQL text of prepared statement P. The 3932** semantics used to normalize a SQL statement are unspecified and subject 3933** to change. At a minimum, literal values will be replaced with suitable 3934** placeholders. 3935** 3936** ^(For example, if a prepared statement is created using the SQL 3937** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345 3938** and parameter :xyz is unbound, then sqlite3_sql() will return 3939** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql() 3940** will return "SELECT 2345,NULL".)^ 3941** 3942** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory 3943** is available to hold the result, or if the result would exceed the 3944** the maximum string length determined by the [SQLITE_LIMIT_LENGTH]. 3945** 3946** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of 3947** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time 3948** option causes sqlite3_expanded_sql() to always return NULL. 3949** 3950** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P) 3951** are managed by SQLite and are automatically freed when the prepared 3952** statement is finalized. 3953** ^The string returned by sqlite3_expanded_sql(P), on the other hand, 3954** is obtained from [sqlite3_malloc()] and must be free by the application 3955** by passing it to [sqlite3_free()]. 3956*/ 3957const char *sqlite3_sql(sqlite3_stmt *pStmt); 3958char *sqlite3_expanded_sql(sqlite3_stmt *pStmt); 3959const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt); 3960 3961/* 3962** CAPI3REF: Determine If An SQL Statement Writes The Database 3963** METHOD: sqlite3_stmt 3964** 3965** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if 3966** and only if the [prepared statement] X makes no direct changes to 3967** the content of the database file. 3968** 3969** Note that [application-defined SQL functions] or 3970** [virtual tables] might change the database indirectly as a side effect. 3971** ^(For example, if an application defines a function "eval()" that 3972** calls [sqlite3_exec()], then the following SQL statement would 3973** change the database file through side-effects: 3974** 3975** <blockquote><pre> 3976** SELECT eval('DELETE FROM t1') FROM t2; 3977** </pre></blockquote> 3978** 3979** But because the [SELECT] statement does not change the database file 3980** directly, sqlite3_stmt_readonly() would still return true.)^ 3981** 3982** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], 3983** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, 3984** since the statements themselves do not actually modify the database but 3985** rather they control the timing of when other statements modify the 3986** database. ^The [ATTACH] and [DETACH] statements also cause 3987** sqlite3_stmt_readonly() to return true since, while those statements 3988** change the configuration of a database connection, they do not make 3989** changes to the content of the database files on disk. 3990** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since 3991** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and 3992** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so 3993** sqlite3_stmt_readonly() returns false for those commands. 3994*/ 3995int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); 3996 3997/* 3998** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement 3999** METHOD: sqlite3_stmt 4000** 4001** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the 4002** prepared statement S is an EXPLAIN statement, or 2 if the 4003** statement S is an EXPLAIN QUERY PLAN. 4004** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is 4005** an ordinary statement or a NULL pointer. 4006*/ 4007int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt); 4008 4009/* 4010** CAPI3REF: Determine If A Prepared Statement Has Been Reset 4011** METHOD: sqlite3_stmt 4012** 4013** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the 4014** [prepared statement] S has been stepped at least once using 4015** [sqlite3_step(S)] but has neither run to completion (returned 4016** [SQLITE_DONE] from [sqlite3_step(S)]) nor 4017** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) 4018** interface returns false if S is a NULL pointer. If S is not a 4019** NULL pointer and is not a pointer to a valid [prepared statement] 4020** object, then the behavior is undefined and probably undesirable. 4021** 4022** This interface can be used in combination [sqlite3_next_stmt()] 4023** to locate all prepared statements associated with a database 4024** connection that are in need of being reset. This can be used, 4025** for example, in diagnostic routines to search for prepared 4026** statements that are holding a transaction open. 4027*/ 4028int sqlite3_stmt_busy(sqlite3_stmt*); 4029 4030/* 4031** CAPI3REF: Dynamically Typed Value Object 4032** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 4033** 4034** SQLite uses the sqlite3_value object to represent all values 4035** that can be stored in a database table. SQLite uses dynamic typing 4036** for the values it stores. ^Values stored in sqlite3_value objects 4037** can be integers, floating point values, strings, BLOBs, or NULL. 4038** 4039** An sqlite3_value object may be either "protected" or "unprotected". 4040** Some interfaces require a protected sqlite3_value. Other interfaces 4041** will accept either a protected or an unprotected sqlite3_value. 4042** Every interface that accepts sqlite3_value arguments specifies 4043** whether or not it requires a protected sqlite3_value. The 4044** [sqlite3_value_dup()] interface can be used to construct a new 4045** protected sqlite3_value from an unprotected sqlite3_value. 4046** 4047** The terms "protected" and "unprotected" refer to whether or not 4048** a mutex is held. An internal mutex is held for a protected 4049** sqlite3_value object but no mutex is held for an unprotected 4050** sqlite3_value object. If SQLite is compiled to be single-threaded 4051** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 4052** or if SQLite is run in one of reduced mutex modes 4053** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 4054** then there is no distinction between protected and unprotected 4055** sqlite3_value objects and they can be used interchangeably. However, 4056** for maximum code portability it is recommended that applications 4057** still make the distinction between protected and unprotected 4058** sqlite3_value objects even when not strictly required. 4059** 4060** ^The sqlite3_value objects that are passed as parameters into the 4061** implementation of [application-defined SQL functions] are protected. 4062** ^The sqlite3_value object returned by 4063** [sqlite3_column_value()] is unprotected. 4064** Unprotected sqlite3_value objects may only be used as arguments 4065** to [sqlite3_result_value()], [sqlite3_bind_value()], and 4066** [sqlite3_value_dup()]. 4067** The [sqlite3_value_blob | sqlite3_value_type()] family of 4068** interfaces require protected sqlite3_value objects. 4069*/ 4070typedef struct sqlite3_value sqlite3_value; 4071 4072/* 4073** CAPI3REF: SQL Function Context Object 4074** 4075** The context in which an SQL function executes is stored in an 4076** sqlite3_context object. ^A pointer to an sqlite3_context object 4077** is always first parameter to [application-defined SQL functions]. 4078** The application-defined SQL function implementation will pass this 4079** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 4080** [sqlite3_aggregate_context()], [sqlite3_user_data()], 4081** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 4082** and/or [sqlite3_set_auxdata()]. 4083*/ 4084typedef struct sqlite3_context sqlite3_context; 4085 4086/* 4087** CAPI3REF: Binding Values To Prepared Statements 4088** KEYWORDS: {host parameter} {host parameters} {host parameter name} 4089** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 4090** METHOD: sqlite3_stmt 4091** 4092** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, 4093** literals may be replaced by a [parameter] that matches one of following 4094** templates: 4095** 4096** <ul> 4097** <li> ? 4098** <li> ?NNN 4099** <li> :VVV 4100** <li> @VVV 4101** <li> $VVV 4102** </ul> 4103** 4104** In the templates above, NNN represents an integer literal, 4105** and VVV represents an alphanumeric identifier.)^ ^The values of these 4106** parameters (also called "host parameter names" or "SQL parameters") 4107** can be set using the sqlite3_bind_*() routines defined here. 4108** 4109** ^The first argument to the sqlite3_bind_*() routines is always 4110** a pointer to the [sqlite3_stmt] object returned from 4111** [sqlite3_prepare_v2()] or its variants. 4112** 4113** ^The second argument is the index of the SQL parameter to be set. 4114** ^The leftmost SQL parameter has an index of 1. ^When the same named 4115** SQL parameter is used more than once, second and subsequent 4116** occurrences have the same index as the first occurrence. 4117** ^The index for named parameters can be looked up using the 4118** [sqlite3_bind_parameter_index()] API if desired. ^The index 4119** for "?NNN" parameters is the value of NNN. 4120** ^The NNN value must be between 1 and the [sqlite3_limit()] 4121** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 4122** 4123** ^The third argument is the value to bind to the parameter. 4124** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16() 4125** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter 4126** is ignored and the end result is the same as sqlite3_bind_null(). 4127** 4128** ^(In those routines that have a fourth argument, its value is the 4129** number of bytes in the parameter. To be clear: the value is the 4130** number of <u>bytes</u> in the value, not the number of characters.)^ 4131** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16() 4132** is negative, then the length of the string is 4133** the number of bytes up to the first zero terminator. 4134** If the fourth parameter to sqlite3_bind_blob() is negative, then 4135** the behavior is undefined. 4136** If a non-negative fourth parameter is provided to sqlite3_bind_text() 4137** or sqlite3_bind_text16() or sqlite3_bind_text64() then 4138** that parameter must be the byte offset 4139** where the NUL terminator would occur assuming the string were NUL 4140** terminated. If any NUL characters occur at byte offsets less than 4141** the value of the fourth parameter then the resulting string value will 4142** contain embedded NULs. The result of expressions involving strings 4143** with embedded NULs is undefined. 4144** 4145** ^The fifth argument to the BLOB and string binding interfaces 4146** is a destructor used to dispose of the BLOB or 4147** string after SQLite has finished with it. ^The destructor is called 4148** to dispose of the BLOB or string even if the call to the bind API fails, 4149** except the destructor is not called if the third parameter is a NULL 4150** pointer or the fourth parameter is negative. 4151** ^If the fifth argument is 4152** the special value [SQLITE_STATIC], then SQLite assumes that the 4153** information is in static, unmanaged space and does not need to be freed. 4154** ^If the fifth argument has the value [SQLITE_TRANSIENT], then 4155** SQLite makes its own private copy of the data immediately, before 4156** the sqlite3_bind_*() routine returns. 4157** 4158** ^The sixth argument to sqlite3_bind_text64() must be one of 4159** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE] 4160** to specify the encoding of the text in the third parameter. If 4161** the sixth argument to sqlite3_bind_text64() is not one of the 4162** allowed values shown above, or if the text encoding is different 4163** from the encoding specified by the sixth parameter, then the behavior 4164** is undefined. 4165** 4166** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 4167** is filled with zeroes. ^A zeroblob uses a fixed amount of memory 4168** (just an integer to hold its size) while it is being processed. 4169** Zeroblobs are intended to serve as placeholders for BLOBs whose 4170** content is later written using 4171** [sqlite3_blob_open | incremental BLOB I/O] routines. 4172** ^A negative value for the zeroblob results in a zero-length BLOB. 4173** 4174** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in 4175** [prepared statement] S to have an SQL value of NULL, but to also be 4176** associated with the pointer P of type T. ^D is either a NULL pointer or 4177** a pointer to a destructor function for P. ^SQLite will invoke the 4178** destructor D with a single argument of P when it is finished using 4179** P. The T parameter should be a static string, preferably a string 4180** literal. The sqlite3_bind_pointer() routine is part of the 4181** [pointer passing interface] added for SQLite 3.20.0. 4182** 4183** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer 4184** for the [prepared statement] or with a prepared statement for which 4185** [sqlite3_step()] has been called more recently than [sqlite3_reset()], 4186** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() 4187** routine is passed a [prepared statement] that has been finalized, the 4188** result is undefined and probably harmful. 4189** 4190** ^Bindings are not cleared by the [sqlite3_reset()] routine. 4191** ^Unbound parameters are interpreted as NULL. 4192** 4193** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an 4194** [error code] if anything goes wrong. 4195** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB 4196** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or 4197** [SQLITE_MAX_LENGTH]. 4198** ^[SQLITE_RANGE] is returned if the parameter 4199** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. 4200** 4201** See also: [sqlite3_bind_parameter_count()], 4202** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 4203*/ 4204int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 4205int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64, 4206 void(*)(void*)); 4207int sqlite3_bind_double(sqlite3_stmt*, int, double); 4208int sqlite3_bind_int(sqlite3_stmt*, int, int); 4209int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 4210int sqlite3_bind_null(sqlite3_stmt*, int); 4211int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*)); 4212int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 4213int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64, 4214 void(*)(void*), unsigned char encoding); 4215int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 4216int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*)); 4217int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 4218int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64); 4219 4220/* 4221** CAPI3REF: Number Of SQL Parameters 4222** METHOD: sqlite3_stmt 4223** 4224** ^This routine can be used to find the number of [SQL parameters] 4225** in a [prepared statement]. SQL parameters are tokens of the 4226** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 4227** placeholders for values that are [sqlite3_bind_blob | bound] 4228** to the parameters at a later time. 4229** 4230** ^(This routine actually returns the index of the largest (rightmost) 4231** parameter. For all forms except ?NNN, this will correspond to the 4232** number of unique parameters. If parameters of the ?NNN form are used, 4233** there may be gaps in the list.)^ 4234** 4235** See also: [sqlite3_bind_blob|sqlite3_bind()], 4236** [sqlite3_bind_parameter_name()], and 4237** [sqlite3_bind_parameter_index()]. 4238*/ 4239int sqlite3_bind_parameter_count(sqlite3_stmt*); 4240 4241/* 4242** CAPI3REF: Name Of A Host Parameter 4243** METHOD: sqlite3_stmt 4244** 4245** ^The sqlite3_bind_parameter_name(P,N) interface returns 4246** the name of the N-th [SQL parameter] in the [prepared statement] P. 4247** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 4248** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 4249** respectively. 4250** In other words, the initial ":" or "$" or "@" or "?" 4251** is included as part of the name.)^ 4252** ^Parameters of the form "?" without a following integer have no name 4253** and are referred to as "nameless" or "anonymous parameters". 4254** 4255** ^The first host parameter has an index of 1, not 0. 4256** 4257** ^If the value N is out of range or if the N-th parameter is 4258** nameless, then NULL is returned. ^The returned string is 4259** always in UTF-8 encoding even if the named parameter was 4260** originally specified as UTF-16 in [sqlite3_prepare16()], 4261** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()]. 4262** 4263** See also: [sqlite3_bind_blob|sqlite3_bind()], 4264** [sqlite3_bind_parameter_count()], and 4265** [sqlite3_bind_parameter_index()]. 4266*/ 4267const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); 4268 4269/* 4270** CAPI3REF: Index Of A Parameter With A Given Name 4271** METHOD: sqlite3_stmt 4272** 4273** ^Return the index of an SQL parameter given its name. ^The 4274** index value returned is suitable for use as the second 4275** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero 4276** is returned if no matching parameter is found. ^The parameter 4277** name must be given in UTF-8 even if the original statement 4278** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or 4279** [sqlite3_prepare16_v3()]. 4280** 4281** See also: [sqlite3_bind_blob|sqlite3_bind()], 4282** [sqlite3_bind_parameter_count()], and 4283** [sqlite3_bind_parameter_name()]. 4284*/ 4285int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 4286 4287/* 4288** CAPI3REF: Reset All Bindings On A Prepared Statement 4289** METHOD: sqlite3_stmt 4290** 4291** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset 4292** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 4293** ^Use this routine to reset all host parameters to NULL. 4294*/ 4295int sqlite3_clear_bindings(sqlite3_stmt*); 4296 4297/* 4298** CAPI3REF: Number Of Columns In A Result Set 4299** METHOD: sqlite3_stmt 4300** 4301** ^Return the number of columns in the result set returned by the 4302** [prepared statement]. ^If this routine returns 0, that means the 4303** [prepared statement] returns no data (for example an [UPDATE]). 4304** ^However, just because this routine returns a positive number does not 4305** mean that one or more rows of data will be returned. ^A SELECT statement 4306** will always have a positive sqlite3_column_count() but depending on the 4307** WHERE clause constraints and the table content, it might return no rows. 4308** 4309** See also: [sqlite3_data_count()] 4310*/ 4311int sqlite3_column_count(sqlite3_stmt *pStmt); 4312 4313/* 4314** CAPI3REF: Column Names In A Result Set 4315** METHOD: sqlite3_stmt 4316** 4317** ^These routines return the name assigned to a particular column 4318** in the result set of a [SELECT] statement. ^The sqlite3_column_name() 4319** interface returns a pointer to a zero-terminated UTF-8 string 4320** and sqlite3_column_name16() returns a pointer to a zero-terminated 4321** UTF-16 string. ^The first parameter is the [prepared statement] 4322** that implements the [SELECT] statement. ^The second parameter is the 4323** column number. ^The leftmost column is number 0. 4324** 4325** ^The returned string pointer is valid until either the [prepared statement] 4326** is destroyed by [sqlite3_finalize()] or until the statement is automatically 4327** reprepared by the first call to [sqlite3_step()] for a particular run 4328** or until the next call to 4329** sqlite3_column_name() or sqlite3_column_name16() on the same column. 4330** 4331** ^If sqlite3_malloc() fails during the processing of either routine 4332** (for example during a conversion from UTF-8 to UTF-16) then a 4333** NULL pointer is returned. 4334** 4335** ^The name of a result column is the value of the "AS" clause for 4336** that column, if there is an AS clause. If there is no AS clause 4337** then the name of the column is unspecified and may change from 4338** one release of SQLite to the next. 4339*/ 4340const char *sqlite3_column_name(sqlite3_stmt*, int N); 4341const void *sqlite3_column_name16(sqlite3_stmt*, int N); 4342 4343/* 4344** CAPI3REF: Source Of Data In A Query Result 4345** METHOD: sqlite3_stmt 4346** 4347** ^These routines provide a means to determine the database, table, and 4348** table column that is the origin of a particular result column in 4349** [SELECT] statement. 4350** ^The name of the database or table or column can be returned as 4351** either a UTF-8 or UTF-16 string. ^The _database_ routines return 4352** the database name, the _table_ routines return the table name, and 4353** the origin_ routines return the column name. 4354** ^The returned string is valid until the [prepared statement] is destroyed 4355** using [sqlite3_finalize()] or until the statement is automatically 4356** reprepared by the first call to [sqlite3_step()] for a particular run 4357** or until the same information is requested 4358** again in a different encoding. 4359** 4360** ^The names returned are the original un-aliased names of the 4361** database, table, and column. 4362** 4363** ^The first argument to these interfaces is a [prepared statement]. 4364** ^These functions return information about the Nth result column returned by 4365** the statement, where N is the second function argument. 4366** ^The left-most column is column 0 for these routines. 4367** 4368** ^If the Nth column returned by the statement is an expression or 4369** subquery and is not a column value, then all of these functions return 4370** NULL. ^These routines might also return NULL if a memory allocation error 4371** occurs. ^Otherwise, they return the name of the attached database, table, 4372** or column that query result column was extracted from. 4373** 4374** ^As with all other SQLite APIs, those whose names end with "16" return 4375** UTF-16 encoded strings and the other functions return UTF-8. 4376** 4377** ^These APIs are only available if the library was compiled with the 4378** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. 4379** 4380** If two or more threads call one or more 4381** [sqlite3_column_database_name | column metadata interfaces] 4382** for the same [prepared statement] and result column 4383** at the same time then the results are undefined. 4384*/ 4385const char *sqlite3_column_database_name(sqlite3_stmt*,int); 4386const void *sqlite3_column_database_name16(sqlite3_stmt*,int); 4387const char *sqlite3_column_table_name(sqlite3_stmt*,int); 4388const void *sqlite3_column_table_name16(sqlite3_stmt*,int); 4389const char *sqlite3_column_origin_name(sqlite3_stmt*,int); 4390const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); 4391 4392/* 4393** CAPI3REF: Declared Datatype Of A Query Result 4394** METHOD: sqlite3_stmt 4395** 4396** ^(The first parameter is a [prepared statement]. 4397** If this statement is a [SELECT] statement and the Nth column of the 4398** returned result set of that [SELECT] is a table column (not an 4399** expression or subquery) then the declared type of the table 4400** column is returned.)^ ^If the Nth column of the result set is an 4401** expression or subquery, then a NULL pointer is returned. 4402** ^The returned string is always UTF-8 encoded. 4403** 4404** ^(For example, given the database schema: 4405** 4406** CREATE TABLE t1(c1 VARIANT); 4407** 4408** and the following statement to be compiled: 4409** 4410** SELECT c1 + 1, c1 FROM t1; 4411** 4412** this routine would return the string "VARIANT" for the second result 4413** column (i==1), and a NULL pointer for the first result column (i==0).)^ 4414** 4415** ^SQLite uses dynamic run-time typing. ^So just because a column 4416** is declared to contain a particular type does not mean that the 4417** data stored in that column is of the declared type. SQLite is 4418** strongly typed, but the typing is dynamic not static. ^Type 4419** is associated with individual values, not with the containers 4420** used to hold those values. 4421*/ 4422const char *sqlite3_column_decltype(sqlite3_stmt*,int); 4423const void *sqlite3_column_decltype16(sqlite3_stmt*,int); 4424 4425/* 4426** CAPI3REF: Evaluate An SQL Statement 4427** METHOD: sqlite3_stmt 4428** 4429** After a [prepared statement] has been prepared using any of 4430** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()], 4431** or [sqlite3_prepare16_v3()] or one of the legacy 4432** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 4433** must be called one or more times to evaluate the statement. 4434** 4435** The details of the behavior of the sqlite3_step() interface depend 4436** on whether the statement was prepared using the newer "vX" interfaces 4437** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()], 4438** [sqlite3_prepare16_v2()] or the older legacy 4439** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 4440** new "vX" interface is recommended for new applications but the legacy 4441** interface will continue to be supported. 4442** 4443** ^In the legacy interface, the return value will be either [SQLITE_BUSY], 4444** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 4445** ^With the "v2" interface, any of the other [result codes] or 4446** [extended result codes] might be returned as well. 4447** 4448** ^[SQLITE_BUSY] means that the database engine was unable to acquire the 4449** database locks it needs to do its job. ^If the statement is a [COMMIT] 4450** or occurs outside of an explicit transaction, then you can retry the 4451** statement. If the statement is not a [COMMIT] and occurs within an 4452** explicit transaction then you should rollback the transaction before 4453** continuing. 4454** 4455** ^[SQLITE_DONE] means that the statement has finished executing 4456** successfully. sqlite3_step() should not be called again on this virtual 4457** machine without first calling [sqlite3_reset()] to reset the virtual 4458** machine back to its initial state. 4459** 4460** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] 4461** is returned each time a new row of data is ready for processing by the 4462** caller. The values may be accessed using the [column access functions]. 4463** sqlite3_step() is called again to retrieve the next row of data. 4464** 4465** ^[SQLITE_ERROR] means that a run-time error (such as a constraint 4466** violation) has occurred. sqlite3_step() should not be called again on 4467** the VM. More information may be found by calling [sqlite3_errmsg()]. 4468** ^With the legacy interface, a more specific error code (for example, 4469** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 4470** can be obtained by calling [sqlite3_reset()] on the 4471** [prepared statement]. ^In the "v2" interface, 4472** the more specific error code is returned directly by sqlite3_step(). 4473** 4474** [SQLITE_MISUSE] means that the this routine was called inappropriately. 4475** Perhaps it was called on a [prepared statement] that has 4476** already been [sqlite3_finalize | finalized] or on one that had 4477** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 4478** be the case that the same database connection is being used by two or 4479** more threads at the same moment in time. 4480** 4481** For all versions of SQLite up to and including 3.6.23.1, a call to 4482** [sqlite3_reset()] was required after sqlite3_step() returned anything 4483** other than [SQLITE_ROW] before any subsequent invocation of 4484** sqlite3_step(). Failure to reset the prepared statement using 4485** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from 4486** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1], 4487** sqlite3_step() began 4488** calling [sqlite3_reset()] automatically in this circumstance rather 4489** than returning [SQLITE_MISUSE]. This is not considered a compatibility 4490** break because any application that ever receives an SQLITE_MISUSE error 4491** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option 4492** can be used to restore the legacy behavior. 4493** 4494** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 4495** API always returns a generic error code, [SQLITE_ERROR], following any 4496** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 4497** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 4498** specific [error codes] that better describes the error. 4499** We admit that this is a goofy design. The problem has been fixed 4500** with the "v2" interface. If you prepare all of your SQL statements 4501** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()] 4502** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead 4503** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 4504** then the more specific [error codes] are returned directly 4505** by sqlite3_step(). The use of the "vX" interfaces is recommended. 4506*/ 4507int sqlite3_step(sqlite3_stmt*); 4508 4509/* 4510** CAPI3REF: Number of columns in a result set 4511** METHOD: sqlite3_stmt 4512** 4513** ^The sqlite3_data_count(P) interface returns the number of columns in the 4514** current row of the result set of [prepared statement] P. 4515** ^If prepared statement P does not have results ready to return 4516** (via calls to the [sqlite3_column_int | sqlite3_column()] family of 4517** interfaces) then sqlite3_data_count(P) returns 0. 4518** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. 4519** ^The sqlite3_data_count(P) routine returns 0 if the previous call to 4520** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P) 4521** will return non-zero if previous call to [sqlite3_step](P) returned 4522** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] 4523** where it always returns zero since each step of that multi-step 4524** pragma returns 0 columns of data. 4525** 4526** See also: [sqlite3_column_count()] 4527*/ 4528int sqlite3_data_count(sqlite3_stmt *pStmt); 4529 4530/* 4531** CAPI3REF: Fundamental Datatypes 4532** KEYWORDS: SQLITE_TEXT 4533** 4534** ^(Every value in SQLite has one of five fundamental datatypes: 4535** 4536** <ul> 4537** <li> 64-bit signed integer 4538** <li> 64-bit IEEE floating point number 4539** <li> string 4540** <li> BLOB 4541** <li> NULL 4542** </ul>)^ 4543** 4544** These constants are codes for each of those types. 4545** 4546** Note that the SQLITE_TEXT constant was also used in SQLite version 2 4547** for a completely different meaning. Software that links against both 4548** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 4549** SQLITE_TEXT. 4550*/ 4551#define SQLITE_INTEGER 1 4552#define SQLITE_FLOAT 2 4553#define SQLITE_BLOB 4 4554#define SQLITE_NULL 5 4555#ifdef SQLITE_TEXT 4556# undef SQLITE_TEXT 4557#else 4558# define SQLITE_TEXT 3 4559#endif 4560#define SQLITE3_TEXT 3 4561 4562/* 4563** CAPI3REF: Result Values From A Query 4564** KEYWORDS: {column access functions} 4565** METHOD: sqlite3_stmt 4566** 4567** <b>Summary:</b> 4568** <blockquote><table border=0 cellpadding=0 cellspacing=0> 4569** <tr><td><b>sqlite3_column_blob</b><td>→<td>BLOB result 4570** <tr><td><b>sqlite3_column_double</b><td>→<td>REAL result 4571** <tr><td><b>sqlite3_column_int</b><td>→<td>32-bit INTEGER result 4572** <tr><td><b>sqlite3_column_int64</b><td>→<td>64-bit INTEGER result 4573** <tr><td><b>sqlite3_column_text</b><td>→<td>UTF-8 TEXT result 4574** <tr><td><b>sqlite3_column_text16</b><td>→<td>UTF-16 TEXT result 4575** <tr><td><b>sqlite3_column_value</b><td>→<td>The result as an 4576** [sqlite3_value|unprotected sqlite3_value] object. 4577** <tr><td> <td> <td> 4578** <tr><td><b>sqlite3_column_bytes</b><td>→<td>Size of a BLOB 4579** or a UTF-8 TEXT result in bytes 4580** <tr><td><b>sqlite3_column_bytes16 </b> 4581** <td>→ <td>Size of UTF-16 4582** TEXT in bytes 4583** <tr><td><b>sqlite3_column_type</b><td>→<td>Default 4584** datatype of the result 4585** </table></blockquote> 4586** 4587** <b>Details:</b> 4588** 4589** ^These routines return information about a single column of the current 4590** result row of a query. ^In every case the first argument is a pointer 4591** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 4592** that was returned from [sqlite3_prepare_v2()] or one of its variants) 4593** and the second argument is the index of the column for which information 4594** should be returned. ^The leftmost column of the result set has the index 0. 4595** ^The number of columns in the result can be determined using 4596** [sqlite3_column_count()]. 4597** 4598** If the SQL statement does not currently point to a valid row, or if the 4599** column index is out of range, the result is undefined. 4600** These routines may only be called when the most recent call to 4601** [sqlite3_step()] has returned [SQLITE_ROW] and neither 4602** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 4603** If any of these routines are called after [sqlite3_reset()] or 4604** [sqlite3_finalize()] or after [sqlite3_step()] has returned 4605** something other than [SQLITE_ROW], the results are undefined. 4606** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 4607** are called from a different thread while any of these routines 4608** are pending, then the results are undefined. 4609** 4610** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16) 4611** each return the value of a result column in a specific data format. If 4612** the result column is not initially in the requested format (for example, 4613** if the query returns an integer but the sqlite3_column_text() interface 4614** is used to extract the value) then an automatic type conversion is performed. 4615** 4616** ^The sqlite3_column_type() routine returns the 4617** [SQLITE_INTEGER | datatype code] for the initial data type 4618** of the result column. ^The returned value is one of [SQLITE_INTEGER], 4619** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. 4620** The return value of sqlite3_column_type() can be used to decide which 4621** of the first six interface should be used to extract the column value. 4622** The value returned by sqlite3_column_type() is only meaningful if no 4623** automatic type conversions have occurred for the value in question. 4624** After a type conversion, the result of calling sqlite3_column_type() 4625** is undefined, though harmless. Future 4626** versions of SQLite may change the behavior of sqlite3_column_type() 4627** following a type conversion. 4628** 4629** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes() 4630** or sqlite3_column_bytes16() interfaces can be used to determine the size 4631** of that BLOB or string. 4632** 4633** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 4634** routine returns the number of bytes in that BLOB or string. 4635** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts 4636** the string to UTF-8 and then returns the number of bytes. 4637** ^If the result is a numeric value then sqlite3_column_bytes() uses 4638** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 4639** the number of bytes in that string. 4640** ^If the result is NULL, then sqlite3_column_bytes() returns zero. 4641** 4642** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() 4643** routine returns the number of bytes in that BLOB or string. 4644** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts 4645** the string to UTF-16 and then returns the number of bytes. 4646** ^If the result is a numeric value then sqlite3_column_bytes16() uses 4647** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns 4648** the number of bytes in that string. 4649** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. 4650** 4651** ^The values returned by [sqlite3_column_bytes()] and 4652** [sqlite3_column_bytes16()] do not include the zero terminators at the end 4653** of the string. ^For clarity: the values returned by 4654** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of 4655** bytes in the string, not the number of characters. 4656** 4657** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 4658** even empty strings, are always zero-terminated. ^The return 4659** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. 4660** 4661** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an 4662** [unprotected sqlite3_value] object. In a multithreaded environment, 4663** an unprotected sqlite3_value object may only be used safely with 4664** [sqlite3_bind_value()] and [sqlite3_result_value()]. 4665** If the [unprotected sqlite3_value] object returned by 4666** [sqlite3_column_value()] is used in any other way, including calls 4667** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 4668** or [sqlite3_value_bytes()], the behavior is not threadsafe. 4669** Hence, the sqlite3_column_value() interface 4670** is normally only useful within the implementation of 4671** [application-defined SQL functions] or [virtual tables], not within 4672** top-level application code. 4673** 4674** The these routines may attempt to convert the datatype of the result. 4675** ^For example, if the internal representation is FLOAT and a text result 4676** is requested, [sqlite3_snprintf()] is used internally to perform the 4677** conversion automatically. ^(The following table details the conversions 4678** that are applied: 4679** 4680** <blockquote> 4681** <table border="1"> 4682** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 4683** 4684** <tr><td> NULL <td> INTEGER <td> Result is 0 4685** <tr><td> NULL <td> FLOAT <td> Result is 0.0 4686** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer 4687** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer 4688** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 4689** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 4690** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 4691** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER 4692** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 4693** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB 4694** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER 4695** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL 4696** <tr><td> TEXT <td> BLOB <td> No change 4697** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER 4698** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL 4699** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 4700** </table> 4701** </blockquote>)^ 4702** 4703** Note that when type conversions occur, pointers returned by prior 4704** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 4705** sqlite3_column_text16() may be invalidated. 4706** Type conversions and pointer invalidations might occur 4707** in the following cases: 4708** 4709** <ul> 4710** <li> The initial content is a BLOB and sqlite3_column_text() or 4711** sqlite3_column_text16() is called. A zero-terminator might 4712** need to be added to the string.</li> 4713** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 4714** sqlite3_column_text16() is called. The content must be converted 4715** to UTF-16.</li> 4716** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 4717** sqlite3_column_text() is called. The content must be converted 4718** to UTF-8.</li> 4719** </ul> 4720** 4721** ^Conversions between UTF-16be and UTF-16le are always done in place and do 4722** not invalidate a prior pointer, though of course the content of the buffer 4723** that the prior pointer references will have been modified. Other kinds 4724** of conversion are done in place when it is possible, but sometimes they 4725** are not possible and in those cases prior pointers are invalidated. 4726** 4727** The safest policy is to invoke these routines 4728** in one of the following ways: 4729** 4730** <ul> 4731** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 4732** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 4733** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 4734** </ul> 4735** 4736** In other words, you should call sqlite3_column_text(), 4737** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 4738** into the desired format, then invoke sqlite3_column_bytes() or 4739** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 4740** to sqlite3_column_text() or sqlite3_column_blob() with calls to 4741** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 4742** with calls to sqlite3_column_bytes(). 4743** 4744** ^The pointers returned are valid until a type conversion occurs as 4745** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 4746** [sqlite3_finalize()] is called. ^The memory space used to hold strings 4747** and BLOBs is freed automatically. Do not pass the pointers returned 4748** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 4749** [sqlite3_free()]. 4750** 4751** As long as the input parameters are correct, these routines will only 4752** fail if an out-of-memory error occurs during a format conversion. 4753** Only the following subset of interfaces are subject to out-of-memory 4754** errors: 4755** 4756** <ul> 4757** <li> sqlite3_column_blob() 4758** <li> sqlite3_column_text() 4759** <li> sqlite3_column_text16() 4760** <li> sqlite3_column_bytes() 4761** <li> sqlite3_column_bytes16() 4762** </ul> 4763** 4764** If an out-of-memory error occurs, then the return value from these 4765** routines is the same as if the column had contained an SQL NULL value. 4766** Valid SQL NULL returns can be distinguished from out-of-memory errors 4767** by invoking the [sqlite3_errcode()] immediately after the suspect 4768** return value is obtained and before any 4769** other SQLite interface is called on the same [database connection]. 4770*/ 4771const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 4772double sqlite3_column_double(sqlite3_stmt*, int iCol); 4773int sqlite3_column_int(sqlite3_stmt*, int iCol); 4774sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 4775const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 4776const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 4777sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 4778int sqlite3_column_bytes(sqlite3_stmt*, int iCol); 4779int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 4780int sqlite3_column_type(sqlite3_stmt*, int iCol); 4781 4782/* 4783** CAPI3REF: Destroy A Prepared Statement Object 4784** DESTRUCTOR: sqlite3_stmt 4785** 4786** ^The sqlite3_finalize() function is called to delete a [prepared statement]. 4787** ^If the most recent evaluation of the statement encountered no errors 4788** or if the statement is never been evaluated, then sqlite3_finalize() returns 4789** SQLITE_OK. ^If the most recent evaluation of statement S failed, then 4790** sqlite3_finalize(S) returns the appropriate [error code] or 4791** [extended error code]. 4792** 4793** ^The sqlite3_finalize(S) routine can be called at any point during 4794** the life cycle of [prepared statement] S: 4795** before statement S is ever evaluated, after 4796** one or more calls to [sqlite3_reset()], or after any call 4797** to [sqlite3_step()] regardless of whether or not the statement has 4798** completed execution. 4799** 4800** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. 4801** 4802** The application must finalize every [prepared statement] in order to avoid 4803** resource leaks. It is a grievous error for the application to try to use 4804** a prepared statement after it has been finalized. Any use of a prepared 4805** statement after it has been finalized can result in undefined and 4806** undesirable behavior such as segfaults and heap corruption. 4807*/ 4808int sqlite3_finalize(sqlite3_stmt *pStmt); 4809 4810/* 4811** CAPI3REF: Reset A Prepared Statement Object 4812** METHOD: sqlite3_stmt 4813** 4814** The sqlite3_reset() function is called to reset a [prepared statement] 4815** object back to its initial state, ready to be re-executed. 4816** ^Any SQL statement variables that had values bound to them using 4817** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 4818** Use [sqlite3_clear_bindings()] to reset the bindings. 4819** 4820** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S 4821** back to the beginning of its program. 4822** 4823** ^If the most recent call to [sqlite3_step(S)] for the 4824** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 4825** or if [sqlite3_step(S)] has never before been called on S, 4826** then [sqlite3_reset(S)] returns [SQLITE_OK]. 4827** 4828** ^If the most recent call to [sqlite3_step(S)] for the 4829** [prepared statement] S indicated an error, then 4830** [sqlite3_reset(S)] returns an appropriate [error code]. 4831** 4832** ^The [sqlite3_reset(S)] interface does not change the values 4833** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 4834*/ 4835int sqlite3_reset(sqlite3_stmt *pStmt); 4836 4837/* 4838** CAPI3REF: Create Or Redefine SQL Functions 4839** KEYWORDS: {function creation routines} 4840** KEYWORDS: {application-defined SQL function} 4841** KEYWORDS: {application-defined SQL functions} 4842** METHOD: sqlite3 4843** 4844** ^These functions (collectively known as "function creation routines") 4845** are used to add SQL functions or aggregates or to redefine the behavior 4846** of existing SQL functions or aggregates. The only differences between 4847** the three "sqlite3_create_function*" routines are the text encoding 4848** expected for the second parameter (the name of the function being 4849** created) and the presence or absence of a destructor callback for 4850** the application data pointer. Function sqlite3_create_window_function() 4851** is similar, but allows the user to supply the extra callback functions 4852** needed by [aggregate window functions]. 4853** 4854** ^The first parameter is the [database connection] to which the SQL 4855** function is to be added. ^If an application uses more than one database 4856** connection then application-defined SQL functions must be added 4857** to each database connection separately. 4858** 4859** ^The second parameter is the name of the SQL function to be created or 4860** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 4861** representation, exclusive of the zero-terminator. ^Note that the name 4862** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. 4863** ^Any attempt to create a function with a longer name 4864** will result in [SQLITE_MISUSE] being returned. 4865** 4866** ^The third parameter (nArg) 4867** is the number of arguments that the SQL function or 4868** aggregate takes. ^If this parameter is -1, then the SQL function or 4869** aggregate may take any number of arguments between 0 and the limit 4870** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third 4871** parameter is less than -1 or greater than 127 then the behavior is 4872** undefined. 4873** 4874** ^The fourth parameter, eTextRep, specifies what 4875** [SQLITE_UTF8 | text encoding] this SQL function prefers for 4876** its parameters. The application should set this parameter to 4877** [SQLITE_UTF16LE] if the function implementation invokes 4878** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the 4879** implementation invokes [sqlite3_value_text16be()] on an input, or 4880** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8] 4881** otherwise. ^The same SQL function may be registered multiple times using 4882** different preferred text encodings, with different implementations for 4883** each encoding. 4884** ^When multiple implementations of the same function are available, SQLite 4885** will pick the one that involves the least amount of data conversion. 4886** 4887** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC] 4888** to signal that the function will always return the same result given 4889** the same inputs within a single SQL statement. Most SQL functions are 4890** deterministic. The built-in [random()] SQL function is an example of a 4891** function that is not deterministic. The SQLite query planner is able to 4892** perform additional optimizations on deterministic functions, so use 4893** of the [SQLITE_DETERMINISTIC] flag is recommended where possible. 4894** 4895** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY] 4896** flag, which if present prevents the function from being invoked from 4897** within VIEWs or TRIGGERs. For security reasons, the [SQLITE_DIRECTONLY] 4898** flag is recommended for any application-defined SQL function that has 4899** side-effects. 4900** 4901** ^(The fifth parameter is an arbitrary pointer. The implementation of the 4902** function can gain access to this pointer using [sqlite3_user_data()].)^ 4903** 4904** ^The sixth, seventh and eighth parameters passed to the three 4905** "sqlite3_create_function*" functions, xFunc, xStep and xFinal, are 4906** pointers to C-language functions that implement the SQL function or 4907** aggregate. ^A scalar SQL function requires an implementation of the xFunc 4908** callback only; NULL pointers must be passed as the xStep and xFinal 4909** parameters. ^An aggregate SQL function requires an implementation of xStep 4910** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing 4911** SQL function or aggregate, pass NULL pointers for all three function 4912** callbacks. 4913** 4914** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue 4915** and xInverse) passed to sqlite3_create_window_function are pointers to 4916** C-language callbacks that implement the new function. xStep and xFinal 4917** must both be non-NULL. xValue and xInverse may either both be NULL, in 4918** which case a regular aggregate function is created, or must both be 4919** non-NULL, in which case the new function may be used as either an aggregate 4920** or aggregate window function. More details regarding the implementation 4921** of aggregate window functions are 4922** [user-defined window functions|available here]. 4923** 4924** ^(If the final parameter to sqlite3_create_function_v2() or 4925** sqlite3_create_window_function() is not NULL, then it is destructor for 4926** the application data pointer. The destructor is invoked when the function 4927** is deleted, either by being overloaded or when the database connection 4928** closes.)^ ^The destructor is also invoked if the call to 4929** sqlite3_create_function_v2() fails. ^When the destructor callback is 4930** invoked, it is passed a single argument which is a copy of the application 4931** data pointer which was the fifth parameter to sqlite3_create_function_v2(). 4932** 4933** ^It is permitted to register multiple implementations of the same 4934** functions with the same name but with either differing numbers of 4935** arguments or differing preferred text encodings. ^SQLite will use 4936** the implementation that most closely matches the way in which the 4937** SQL function is used. ^A function implementation with a non-negative 4938** nArg parameter is a better match than a function implementation with 4939** a negative nArg. ^A function where the preferred text encoding 4940** matches the database encoding is a better 4941** match than a function where the encoding is different. 4942** ^A function where the encoding difference is between UTF16le and UTF16be 4943** is a closer match than a function where the encoding difference is 4944** between UTF8 and UTF16. 4945** 4946** ^Built-in functions may be overloaded by new application-defined functions. 4947** 4948** ^An application-defined function is permitted to call other 4949** SQLite interfaces. However, such calls must not 4950** close the database connection nor finalize or reset the prepared 4951** statement in which the function is running. 4952*/ 4953int sqlite3_create_function( 4954 sqlite3 *db, 4955 const char *zFunctionName, 4956 int nArg, 4957 int eTextRep, 4958 void *pApp, 4959 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 4960 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 4961 void (*xFinal)(sqlite3_context*) 4962); 4963int sqlite3_create_function16( 4964 sqlite3 *db, 4965 const void *zFunctionName, 4966 int nArg, 4967 int eTextRep, 4968 void *pApp, 4969 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 4970 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 4971 void (*xFinal)(sqlite3_context*) 4972); 4973int sqlite3_create_function_v2( 4974 sqlite3 *db, 4975 const char *zFunctionName, 4976 int nArg, 4977 int eTextRep, 4978 void *pApp, 4979 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 4980 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 4981 void (*xFinal)(sqlite3_context*), 4982 void(*xDestroy)(void*) 4983); 4984int sqlite3_create_window_function( 4985 sqlite3 *db, 4986 const char *zFunctionName, 4987 int nArg, 4988 int eTextRep, 4989 void *pApp, 4990 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 4991 void (*xFinal)(sqlite3_context*), 4992 void (*xValue)(sqlite3_context*), 4993 void (*xInverse)(sqlite3_context*,int,sqlite3_value**), 4994 void(*xDestroy)(void*) 4995); 4996 4997/* 4998** CAPI3REF: Text Encodings 4999** 5000** These constant define integer codes that represent the various 5001** text encodings supported by SQLite. 5002*/ 5003#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */ 5004#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */ 5005#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */ 5006#define SQLITE_UTF16 4 /* Use native byte order */ 5007#define SQLITE_ANY 5 /* Deprecated */ 5008#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 5009 5010/* 5011** CAPI3REF: Function Flags 5012** 5013** These constants may be ORed together with the 5014** [SQLITE_UTF8 | preferred text encoding] as the fourth argument 5015** to [sqlite3_create_function()], [sqlite3_create_function16()], or 5016** [sqlite3_create_function_v2()]. 5017** 5018** The SQLITE_DETERMINISTIC flag means that the new function always gives 5019** the same output when the input parameters are the same. 5020** The [abs|abs() function] is deterministic, for example, but 5021** [randomblob|randomblob()] is not. Functions must 5022** be deterministic in order to be used in certain contexts such as 5023** [CHECK constraints] or [generated columns]. SQLite might also optimize 5024** deterministic functions by factoring them out of inner loops. 5025** 5026** The SQLITE_INNOCUOUS flag means that the new function is unlikely 5027** to cause problems even if misused. An innocuous function should have 5028** no side effects and consume few resources. The [abs|abs() function] 5029** is an example of an innocuous function. 5030** The [load_extension() SQL function] is not innocuous because of its 5031** side effects. Some heightened security settings 5032** ([SQLITE_DBCONFIG_UNSAFE_FUNC_IN_VIEW]) 5033** disable the use of SQLlfunctions inside views and triggers unless 5034** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions 5035** are innocuous. Developers are advised to avoid using the 5036** SQLITE_INNOCUOUS flag for application-defined functions unless the 5037** function is specifically intended for use inside of views and triggers. 5038** 5039** The SQLITE_DIRECTONLY flag means that the function may only be invoked 5040** from top-level SQL, and cannot be used in VIEWs or TRIGGERs. This is 5041** a security feature which is recommended for all 5042** [application-defined SQL functions] that have side-effects. This flag 5043** prevents an attacker from adding triggers and views to a schema then 5044** tricking a high-privilege application into causing unintended side-effects 5045** while performing ordinary queries. 5046** 5047** The SQLITE_SUBTYPE flag indicates to SQLite that a function may call 5048** [sqlite3_value_subtype()] to inspect the sub-types of its arguments. 5049** Specifying this flag makes no difference for scalar or aggregate user 5050** functions. However, if it is not specified for a user-defined window 5051** function, then any sub-types belonging to arguments passed to the window 5052** function may be discarded before the window function is called (i.e. 5053** sqlite3_value_subtype() will always return 0). 5054*/ 5055#define SQLITE_DETERMINISTIC 0x000000800 5056#define SQLITE_DIRECTONLY 0x000080000 5057#define SQLITE_SUBTYPE 0x000100000 5058#define SQLITE_INNOCUOUS 0x000200000 5059 5060/* 5061** CAPI3REF: Deprecated Functions 5062** DEPRECATED 5063** 5064** These functions are [deprecated]. In order to maintain 5065** backwards compatibility with older code, these functions continue 5066** to be supported. However, new applications should avoid 5067** the use of these functions. To encourage programmers to avoid 5068** these functions, we will not explain what they do. 5069*/ 5070#ifndef SQLITE_OMIT_DEPRECATED 5071SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 5072SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 5073SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 5074SQLITE_DEPRECATED int sqlite3_global_recover(void); 5075SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 5076SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int), 5077 void*,sqlite3_int64); 5078#endif 5079 5080/* 5081** CAPI3REF: Obtaining SQL Values 5082** METHOD: sqlite3_value 5083** 5084** <b>Summary:</b> 5085** <blockquote><table border=0 cellpadding=0 cellspacing=0> 5086** <tr><td><b>sqlite3_value_blob</b><td>→<td>BLOB value 5087** <tr><td><b>sqlite3_value_double</b><td>→<td>REAL value 5088** <tr><td><b>sqlite3_value_int</b><td>→<td>32-bit INTEGER value 5089** <tr><td><b>sqlite3_value_int64</b><td>→<td>64-bit INTEGER value 5090** <tr><td><b>sqlite3_value_pointer</b><td>→<td>Pointer value 5091** <tr><td><b>sqlite3_value_text</b><td>→<td>UTF-8 TEXT value 5092** <tr><td><b>sqlite3_value_text16</b><td>→<td>UTF-16 TEXT value in 5093** the native byteorder 5094** <tr><td><b>sqlite3_value_text16be</b><td>→<td>UTF-16be TEXT value 5095** <tr><td><b>sqlite3_value_text16le</b><td>→<td>UTF-16le TEXT value 5096** <tr><td> <td> <td> 5097** <tr><td><b>sqlite3_value_bytes</b><td>→<td>Size of a BLOB 5098** or a UTF-8 TEXT in bytes 5099** <tr><td><b>sqlite3_value_bytes16 </b> 5100** <td>→ <td>Size of UTF-16 5101** TEXT in bytes 5102** <tr><td><b>sqlite3_value_type</b><td>→<td>Default 5103** datatype of the value 5104** <tr><td><b>sqlite3_value_numeric_type </b> 5105** <td>→ <td>Best numeric datatype of the value 5106** <tr><td><b>sqlite3_value_nochange </b> 5107** <td>→ <td>True if the column is unchanged in an UPDATE 5108** against a virtual table. 5109** <tr><td><b>sqlite3_value_frombind </b> 5110** <td>→ <td>True if value originated from a [bound parameter] 5111** </table></blockquote> 5112** 5113** <b>Details:</b> 5114** 5115** These routines extract type, size, and content information from 5116** [protected sqlite3_value] objects. Protected sqlite3_value objects 5117** are used to pass parameter information into the functions that 5118** implement [application-defined SQL functions] and [virtual tables]. 5119** 5120** These routines work only with [protected sqlite3_value] objects. 5121** Any attempt to use these routines on an [unprotected sqlite3_value] 5122** is not threadsafe. 5123** 5124** ^These routines work just like the corresponding [column access functions] 5125** except that these routines take a single [protected sqlite3_value] object 5126** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 5127** 5128** ^The sqlite3_value_text16() interface extracts a UTF-16 string 5129** in the native byte-order of the host machine. ^The 5130** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 5131** extract UTF-16 strings as big-endian and little-endian respectively. 5132** 5133** ^If [sqlite3_value] object V was initialized 5134** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)] 5135** and if X and Y are strings that compare equal according to strcmp(X,Y), 5136** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise, 5137** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer() 5138** routine is part of the [pointer passing interface] added for SQLite 3.20.0. 5139** 5140** ^(The sqlite3_value_type(V) interface returns the 5141** [SQLITE_INTEGER | datatype code] for the initial datatype of the 5142** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER], 5143** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^ 5144** Other interfaces might change the datatype for an sqlite3_value object. 5145** For example, if the datatype is initially SQLITE_INTEGER and 5146** sqlite3_value_text(V) is called to extract a text value for that 5147** integer, then subsequent calls to sqlite3_value_type(V) might return 5148** SQLITE_TEXT. Whether or not a persistent internal datatype conversion 5149** occurs is undefined and may change from one release of SQLite to the next. 5150** 5151** ^(The sqlite3_value_numeric_type() interface attempts to apply 5152** numeric affinity to the value. This means that an attempt is 5153** made to convert the value to an integer or floating point. If 5154** such a conversion is possible without loss of information (in other 5155** words, if the value is a string that looks like a number) 5156** then the conversion is performed. Otherwise no conversion occurs. 5157** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ 5158** 5159** ^Within the [xUpdate] method of a [virtual table], the 5160** sqlite3_value_nochange(X) interface returns true if and only if 5161** the column corresponding to X is unchanged by the UPDATE operation 5162** that the xUpdate method call was invoked to implement and if 5163** and the prior [xColumn] method call that was invoked to extracted 5164** the value for that column returned without setting a result (probably 5165** because it queried [sqlite3_vtab_nochange()] and found that the column 5166** was unchanging). ^Within an [xUpdate] method, any value for which 5167** sqlite3_value_nochange(X) is true will in all other respects appear 5168** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other 5169** than within an [xUpdate] method call for an UPDATE statement, then 5170** the return value is arbitrary and meaningless. 5171** 5172** ^The sqlite3_value_frombind(X) interface returns non-zero if the 5173** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()] 5174** interfaces. ^If X comes from an SQL literal value, or a table column, 5175** or an expression, then sqlite3_value_frombind(X) returns zero. 5176** 5177** Please pay particular attention to the fact that the pointer returned 5178** from [sqlite3_value_blob()], [sqlite3_value_text()], or 5179** [sqlite3_value_text16()] can be invalidated by a subsequent call to 5180** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 5181** or [sqlite3_value_text16()]. 5182** 5183** These routines must be called from the same thread as 5184** the SQL function that supplied the [sqlite3_value*] parameters. 5185** 5186** As long as the input parameter is correct, these routines can only 5187** fail if an out-of-memory error occurs during a format conversion. 5188** Only the following subset of interfaces are subject to out-of-memory 5189** errors: 5190** 5191** <ul> 5192** <li> sqlite3_value_blob() 5193** <li> sqlite3_value_text() 5194** <li> sqlite3_value_text16() 5195** <li> sqlite3_value_text16le() 5196** <li> sqlite3_value_text16be() 5197** <li> sqlite3_value_bytes() 5198** <li> sqlite3_value_bytes16() 5199** </ul> 5200** 5201** If an out-of-memory error occurs, then the return value from these 5202** routines is the same as if the column had contained an SQL NULL value. 5203** Valid SQL NULL returns can be distinguished from out-of-memory errors 5204** by invoking the [sqlite3_errcode()] immediately after the suspect 5205** return value is obtained and before any 5206** other SQLite interface is called on the same [database connection]. 5207*/ 5208const void *sqlite3_value_blob(sqlite3_value*); 5209double sqlite3_value_double(sqlite3_value*); 5210int sqlite3_value_int(sqlite3_value*); 5211sqlite3_int64 sqlite3_value_int64(sqlite3_value*); 5212void *sqlite3_value_pointer(sqlite3_value*, const char*); 5213const unsigned char *sqlite3_value_text(sqlite3_value*); 5214const void *sqlite3_value_text16(sqlite3_value*); 5215const void *sqlite3_value_text16le(sqlite3_value*); 5216const void *sqlite3_value_text16be(sqlite3_value*); 5217int sqlite3_value_bytes(sqlite3_value*); 5218int sqlite3_value_bytes16(sqlite3_value*); 5219int sqlite3_value_type(sqlite3_value*); 5220int sqlite3_value_numeric_type(sqlite3_value*); 5221int sqlite3_value_nochange(sqlite3_value*); 5222int sqlite3_value_frombind(sqlite3_value*); 5223 5224/* 5225** CAPI3REF: Finding The Subtype Of SQL Values 5226** METHOD: sqlite3_value 5227** 5228** The sqlite3_value_subtype(V) function returns the subtype for 5229** an [application-defined SQL function] argument V. The subtype 5230** information can be used to pass a limited amount of context from 5231** one SQL function to another. Use the [sqlite3_result_subtype()] 5232** routine to set the subtype for the return value of an SQL function. 5233*/ 5234unsigned int sqlite3_value_subtype(sqlite3_value*); 5235 5236/* 5237** CAPI3REF: Copy And Free SQL Values 5238** METHOD: sqlite3_value 5239** 5240** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value] 5241** object D and returns a pointer to that copy. ^The [sqlite3_value] returned 5242** is a [protected sqlite3_value] object even if the input is not. 5243** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a 5244** memory allocation fails. 5245** 5246** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object 5247** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer 5248** then sqlite3_value_free(V) is a harmless no-op. 5249*/ 5250sqlite3_value *sqlite3_value_dup(const sqlite3_value*); 5251void sqlite3_value_free(sqlite3_value*); 5252 5253/* 5254** CAPI3REF: Obtain Aggregate Function Context 5255** METHOD: sqlite3_context 5256** 5257** Implementations of aggregate SQL functions use this 5258** routine to allocate memory for storing their state. 5259** 5260** ^The first time the sqlite3_aggregate_context(C,N) routine is called 5261** for a particular aggregate function, SQLite allocates 5262** N bytes of memory, zeroes out that memory, and returns a pointer 5263** to the new memory. ^On second and subsequent calls to 5264** sqlite3_aggregate_context() for the same aggregate function instance, 5265** the same buffer is returned. Sqlite3_aggregate_context() is normally 5266** called once for each invocation of the xStep callback and then one 5267** last time when the xFinal callback is invoked. ^(When no rows match 5268** an aggregate query, the xStep() callback of the aggregate function 5269** implementation is never called and xFinal() is called exactly once. 5270** In those cases, sqlite3_aggregate_context() might be called for the 5271** first time from within xFinal().)^ 5272** 5273** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer 5274** when first called if N is less than or equal to zero or if a memory 5275** allocate error occurs. 5276** 5277** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is 5278** determined by the N parameter on first successful call. Changing the 5279** value of N in any subsequents call to sqlite3_aggregate_context() within 5280** the same aggregate function instance will not resize the memory 5281** allocation.)^ Within the xFinal callback, it is customary to set 5282** N=0 in calls to sqlite3_aggregate_context(C,N) so that no 5283** pointless memory allocations occur. 5284** 5285** ^SQLite automatically frees the memory allocated by 5286** sqlite3_aggregate_context() when the aggregate query concludes. 5287** 5288** The first parameter must be a copy of the 5289** [sqlite3_context | SQL function context] that is the first parameter 5290** to the xStep or xFinal callback routine that implements the aggregate 5291** function. 5292** 5293** This routine must be called from the same thread in which 5294** the aggregate SQL function is running. 5295*/ 5296void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); 5297 5298/* 5299** CAPI3REF: User Data For Functions 5300** METHOD: sqlite3_context 5301** 5302** ^The sqlite3_user_data() interface returns a copy of 5303** the pointer that was the pUserData parameter (the 5th parameter) 5304** of the [sqlite3_create_function()] 5305** and [sqlite3_create_function16()] routines that originally 5306** registered the application defined function. 5307** 5308** This routine must be called from the same thread in which 5309** the application-defined function is running. 5310*/ 5311void *sqlite3_user_data(sqlite3_context*); 5312 5313/* 5314** CAPI3REF: Database Connection For Functions 5315** METHOD: sqlite3_context 5316** 5317** ^The sqlite3_context_db_handle() interface returns a copy of 5318** the pointer to the [database connection] (the 1st parameter) 5319** of the [sqlite3_create_function()] 5320** and [sqlite3_create_function16()] routines that originally 5321** registered the application defined function. 5322*/ 5323sqlite3 *sqlite3_context_db_handle(sqlite3_context*); 5324 5325/* 5326** CAPI3REF: Function Auxiliary Data 5327** METHOD: sqlite3_context 5328** 5329** These functions may be used by (non-aggregate) SQL functions to 5330** associate metadata with argument values. If the same value is passed to 5331** multiple invocations of the same SQL function during query execution, under 5332** some circumstances the associated metadata may be preserved. An example 5333** of where this might be useful is in a regular-expression matching 5334** function. The compiled version of the regular expression can be stored as 5335** metadata associated with the pattern string. 5336** Then as long as the pattern string remains the same, 5337** the compiled regular expression can be reused on multiple 5338** invocations of the same function. 5339** 5340** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the metadata 5341** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument 5342** value to the application-defined function. ^N is zero for the left-most 5343** function argument. ^If there is no metadata 5344** associated with the function argument, the sqlite3_get_auxdata(C,N) interface 5345** returns a NULL pointer. 5346** 5347** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th 5348** argument of the application-defined function. ^Subsequent 5349** calls to sqlite3_get_auxdata(C,N) return P from the most recent 5350** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or 5351** NULL if the metadata has been discarded. 5352** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL, 5353** SQLite will invoke the destructor function X with parameter P exactly 5354** once, when the metadata is discarded. 5355** SQLite is free to discard the metadata at any time, including: <ul> 5356** <li> ^(when the corresponding function parameter changes)^, or 5357** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the 5358** SQL statement)^, or 5359** <li> ^(when sqlite3_set_auxdata() is invoked again on the same 5360** parameter)^, or 5361** <li> ^(during the original sqlite3_set_auxdata() call when a memory 5362** allocation error occurs.)^ </ul> 5363** 5364** Note the last bullet in particular. The destructor X in 5365** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the 5366** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata() 5367** should be called near the end of the function implementation and the 5368** function implementation should not make any use of P after 5369** sqlite3_set_auxdata() has been called. 5370** 5371** ^(In practice, metadata is preserved between function calls for 5372** function parameters that are compile-time constants, including literal 5373** values and [parameters] and expressions composed from the same.)^ 5374** 5375** The value of the N parameter to these interfaces should be non-negative. 5376** Future enhancements may make use of negative N values to define new 5377** kinds of function caching behavior. 5378** 5379** These routines must be called from the same thread in which 5380** the SQL function is running. 5381*/ 5382void *sqlite3_get_auxdata(sqlite3_context*, int N); 5383void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 5384 5385 5386/* 5387** CAPI3REF: Constants Defining Special Destructor Behavior 5388** 5389** These are special values for the destructor that is passed in as the 5390** final argument to routines like [sqlite3_result_blob()]. ^If the destructor 5391** argument is SQLITE_STATIC, it means that the content pointer is constant 5392** and will never change. It does not need to be destroyed. ^The 5393** SQLITE_TRANSIENT value means that the content will likely change in 5394** the near future and that SQLite should make its own private copy of 5395** the content before returning. 5396** 5397** The typedef is necessary to work around problems in certain 5398** C++ compilers. 5399*/ 5400typedef void (*sqlite3_destructor_type)(void*); 5401#define SQLITE_STATIC ((sqlite3_destructor_type)0) 5402#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 5403 5404/* 5405** CAPI3REF: Setting The Result Of An SQL Function 5406** METHOD: sqlite3_context 5407** 5408** These routines are used by the xFunc or xFinal callbacks that 5409** implement SQL functions and aggregates. See 5410** [sqlite3_create_function()] and [sqlite3_create_function16()] 5411** for additional information. 5412** 5413** These functions work very much like the [parameter binding] family of 5414** functions used to bind values to host parameters in prepared statements. 5415** Refer to the [SQL parameter] documentation for additional information. 5416** 5417** ^The sqlite3_result_blob() interface sets the result from 5418** an application-defined function to be the BLOB whose content is pointed 5419** to by the second parameter and which is N bytes long where N is the 5420** third parameter. 5421** 5422** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N) 5423** interfaces set the result of the application-defined function to be 5424** a BLOB containing all zero bytes and N bytes in size. 5425** 5426** ^The sqlite3_result_double() interface sets the result from 5427** an application-defined function to be a floating point value specified 5428** by its 2nd argument. 5429** 5430** ^The sqlite3_result_error() and sqlite3_result_error16() functions 5431** cause the implemented SQL function to throw an exception. 5432** ^SQLite uses the string pointed to by the 5433** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 5434** as the text of an error message. ^SQLite interprets the error 5435** message string from sqlite3_result_error() as UTF-8. ^SQLite 5436** interprets the string from sqlite3_result_error16() as UTF-16 in native 5437** byte order. ^If the third parameter to sqlite3_result_error() 5438** or sqlite3_result_error16() is negative then SQLite takes as the error 5439** message all text up through the first zero character. 5440** ^If the third parameter to sqlite3_result_error() or 5441** sqlite3_result_error16() is non-negative then SQLite takes that many 5442** bytes (not characters) from the 2nd parameter as the error message. 5443** ^The sqlite3_result_error() and sqlite3_result_error16() 5444** routines make a private copy of the error message text before 5445** they return. Hence, the calling function can deallocate or 5446** modify the text after they return without harm. 5447** ^The sqlite3_result_error_code() function changes the error code 5448** returned by SQLite as a result of an error in a function. ^By default, 5449** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() 5450** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 5451** 5452** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an 5453** error indicating that a string or BLOB is too long to represent. 5454** 5455** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an 5456** error indicating that a memory allocation failed. 5457** 5458** ^The sqlite3_result_int() interface sets the return value 5459** of the application-defined function to be the 32-bit signed integer 5460** value given in the 2nd argument. 5461** ^The sqlite3_result_int64() interface sets the return value 5462** of the application-defined function to be the 64-bit signed integer 5463** value given in the 2nd argument. 5464** 5465** ^The sqlite3_result_null() interface sets the return value 5466** of the application-defined function to be NULL. 5467** 5468** ^The sqlite3_result_text(), sqlite3_result_text16(), 5469** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 5470** set the return value of the application-defined function to be 5471** a text string which is represented as UTF-8, UTF-16 native byte order, 5472** UTF-16 little endian, or UTF-16 big endian, respectively. 5473** ^The sqlite3_result_text64() interface sets the return value of an 5474** application-defined function to be a text string in an encoding 5475** specified by the fifth (and last) parameter, which must be one 5476** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]. 5477** ^SQLite takes the text result from the application from 5478** the 2nd parameter of the sqlite3_result_text* interfaces. 5479** ^If the 3rd parameter to the sqlite3_result_text* interfaces 5480** is negative, then SQLite takes result text from the 2nd parameter 5481** through the first zero character. 5482** ^If the 3rd parameter to the sqlite3_result_text* interfaces 5483** is non-negative, then as many bytes (not characters) of the text 5484** pointed to by the 2nd parameter are taken as the application-defined 5485** function result. If the 3rd parameter is non-negative, then it 5486** must be the byte offset into the string where the NUL terminator would 5487** appear if the string where NUL terminated. If any NUL characters occur 5488** in the string at a byte offset that is less than the value of the 3rd 5489** parameter, then the resulting string will contain embedded NULs and the 5490** result of expressions operating on strings with embedded NULs is undefined. 5491** ^If the 4th parameter to the sqlite3_result_text* interfaces 5492** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 5493** function as the destructor on the text or BLOB result when it has 5494** finished using that result. 5495** ^If the 4th parameter to the sqlite3_result_text* interfaces or to 5496** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 5497** assumes that the text or BLOB result is in constant space and does not 5498** copy the content of the parameter nor call a destructor on the content 5499** when it has finished using that result. 5500** ^If the 4th parameter to the sqlite3_result_text* interfaces 5501** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 5502** then SQLite makes a copy of the result into space obtained 5503** from [sqlite3_malloc()] before it returns. 5504** 5505** ^The sqlite3_result_value() interface sets the result of 5506** the application-defined function to be a copy of the 5507** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The 5508** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 5509** so that the [sqlite3_value] specified in the parameter may change or 5510** be deallocated after sqlite3_result_value() returns without harm. 5511** ^A [protected sqlite3_value] object may always be used where an 5512** [unprotected sqlite3_value] object is required, so either 5513** kind of [sqlite3_value] object can be used with this interface. 5514** 5515** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an 5516** SQL NULL value, just like [sqlite3_result_null(C)], except that it 5517** also associates the host-language pointer P or type T with that 5518** NULL value such that the pointer can be retrieved within an 5519** [application-defined SQL function] using [sqlite3_value_pointer()]. 5520** ^If the D parameter is not NULL, then it is a pointer to a destructor 5521** for the P parameter. ^SQLite invokes D with P as its only argument 5522** when SQLite is finished with P. The T parameter should be a static 5523** string and preferably a string literal. The sqlite3_result_pointer() 5524** routine is part of the [pointer passing interface] added for SQLite 3.20.0. 5525** 5526** If these routines are called from within the different thread 5527** than the one containing the application-defined function that received 5528** the [sqlite3_context] pointer, the results are undefined. 5529*/ 5530void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 5531void sqlite3_result_blob64(sqlite3_context*,const void*, 5532 sqlite3_uint64,void(*)(void*)); 5533void sqlite3_result_double(sqlite3_context*, double); 5534void sqlite3_result_error(sqlite3_context*, const char*, int); 5535void sqlite3_result_error16(sqlite3_context*, const void*, int); 5536void sqlite3_result_error_toobig(sqlite3_context*); 5537void sqlite3_result_error_nomem(sqlite3_context*); 5538void sqlite3_result_error_code(sqlite3_context*, int); 5539void sqlite3_result_int(sqlite3_context*, int); 5540void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 5541void sqlite3_result_null(sqlite3_context*); 5542void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 5543void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64, 5544 void(*)(void*), unsigned char encoding); 5545void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 5546void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 5547void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 5548void sqlite3_result_value(sqlite3_context*, sqlite3_value*); 5549void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*)); 5550void sqlite3_result_zeroblob(sqlite3_context*, int n); 5551int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n); 5552 5553 5554/* 5555** CAPI3REF: Setting The Subtype Of An SQL Function 5556** METHOD: sqlite3_context 5557** 5558** The sqlite3_result_subtype(C,T) function causes the subtype of 5559** the result from the [application-defined SQL function] with 5560** [sqlite3_context] C to be the value T. Only the lower 8 bits 5561** of the subtype T are preserved in current versions of SQLite; 5562** higher order bits are discarded. 5563** The number of subtype bytes preserved by SQLite might increase 5564** in future releases of SQLite. 5565*/ 5566void sqlite3_result_subtype(sqlite3_context*,unsigned int); 5567 5568/* 5569** CAPI3REF: Define New Collating Sequences 5570** METHOD: sqlite3 5571** 5572** ^These functions add, remove, or modify a [collation] associated 5573** with the [database connection] specified as the first argument. 5574** 5575** ^The name of the collation is a UTF-8 string 5576** for sqlite3_create_collation() and sqlite3_create_collation_v2() 5577** and a UTF-16 string in native byte order for sqlite3_create_collation16(). 5578** ^Collation names that compare equal according to [sqlite3_strnicmp()] are 5579** considered to be the same name. 5580** 5581** ^(The third argument (eTextRep) must be one of the constants: 5582** <ul> 5583** <li> [SQLITE_UTF8], 5584** <li> [SQLITE_UTF16LE], 5585** <li> [SQLITE_UTF16BE], 5586** <li> [SQLITE_UTF16], or 5587** <li> [SQLITE_UTF16_ALIGNED]. 5588** </ul>)^ 5589** ^The eTextRep argument determines the encoding of strings passed 5590** to the collating function callback, xCompare. 5591** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep 5592** force strings to be UTF16 with native byte order. 5593** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin 5594** on an even byte address. 5595** 5596** ^The fourth argument, pArg, is an application data pointer that is passed 5597** through as the first argument to the collating function callback. 5598** 5599** ^The fifth argument, xCompare, is a pointer to the collating function. 5600** ^Multiple collating functions can be registered using the same name but 5601** with different eTextRep parameters and SQLite will use whichever 5602** function requires the least amount of data transformation. 5603** ^If the xCompare argument is NULL then the collating function is 5604** deleted. ^When all collating functions having the same name are deleted, 5605** that collation is no longer usable. 5606** 5607** ^The collating function callback is invoked with a copy of the pArg 5608** application data pointer and with two strings in the encoding specified 5609** by the eTextRep argument. The two integer parameters to the collating 5610** function callback are the length of the two strings, in bytes. The collating 5611** function must return an integer that is negative, zero, or positive 5612** if the first string is less than, equal to, or greater than the second, 5613** respectively. A collating function must always return the same answer 5614** given the same inputs. If two or more collating functions are registered 5615** to the same collation name (using different eTextRep values) then all 5616** must give an equivalent answer when invoked with equivalent strings. 5617** The collating function must obey the following properties for all 5618** strings A, B, and C: 5619** 5620** <ol> 5621** <li> If A==B then B==A. 5622** <li> If A==B and B==C then A==C. 5623** <li> If A<B THEN B>A. 5624** <li> If A<B and B<C then A<C. 5625** </ol> 5626** 5627** If a collating function fails any of the above constraints and that 5628** collating function is registered and used, then the behavior of SQLite 5629** is undefined. 5630** 5631** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() 5632** with the addition that the xDestroy callback is invoked on pArg when 5633** the collating function is deleted. 5634** ^Collating functions are deleted when they are overridden by later 5635** calls to the collation creation functions or when the 5636** [database connection] is closed using [sqlite3_close()]. 5637** 5638** ^The xDestroy callback is <u>not</u> called if the 5639** sqlite3_create_collation_v2() function fails. Applications that invoke 5640** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should 5641** check the return code and dispose of the application data pointer 5642** themselves rather than expecting SQLite to deal with it for them. 5643** This is different from every other SQLite interface. The inconsistency 5644** is unfortunate but cannot be changed without breaking backwards 5645** compatibility. 5646** 5647** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. 5648*/ 5649int sqlite3_create_collation( 5650 sqlite3*, 5651 const char *zName, 5652 int eTextRep, 5653 void *pArg, 5654 int(*xCompare)(void*,int,const void*,int,const void*) 5655); 5656int sqlite3_create_collation_v2( 5657 sqlite3*, 5658 const char *zName, 5659 int eTextRep, 5660 void *pArg, 5661 int(*xCompare)(void*,int,const void*,int,const void*), 5662 void(*xDestroy)(void*) 5663); 5664int sqlite3_create_collation16( 5665 sqlite3*, 5666 const void *zName, 5667 int eTextRep, 5668 void *pArg, 5669 int(*xCompare)(void*,int,const void*,int,const void*) 5670); 5671 5672/* 5673** CAPI3REF: Collation Needed Callbacks 5674** METHOD: sqlite3 5675** 5676** ^To avoid having to register all collation sequences before a database 5677** can be used, a single callback function may be registered with the 5678** [database connection] to be invoked whenever an undefined collation 5679** sequence is required. 5680** 5681** ^If the function is registered using the sqlite3_collation_needed() API, 5682** then it is passed the names of undefined collation sequences as strings 5683** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, 5684** the names are passed as UTF-16 in machine native byte order. 5685** ^A call to either function replaces the existing collation-needed callback. 5686** 5687** ^(When the callback is invoked, the first argument passed is a copy 5688** of the second argument to sqlite3_collation_needed() or 5689** sqlite3_collation_needed16(). The second argument is the database 5690** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 5691** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 5692** sequence function required. The fourth parameter is the name of the 5693** required collation sequence.)^ 5694** 5695** The callback function should register the desired collation using 5696** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 5697** [sqlite3_create_collation_v2()]. 5698*/ 5699int sqlite3_collation_needed( 5700 sqlite3*, 5701 void*, 5702 void(*)(void*,sqlite3*,int eTextRep,const char*) 5703); 5704int sqlite3_collation_needed16( 5705 sqlite3*, 5706 void*, 5707 void(*)(void*,sqlite3*,int eTextRep,const void*) 5708); 5709 5710#ifdef SQLITE_HAS_CODEC 5711/* 5712** Specify the key for an encrypted database. This routine should be 5713** called right after sqlite3_open(). 5714** 5715** The code to implement this API is not available in the public release 5716** of SQLite. 5717*/ 5718int sqlite3_key( 5719 sqlite3 *db, /* Database to be rekeyed */ 5720 const void *pKey, int nKey /* The key */ 5721); 5722int sqlite3_key_v2( 5723 sqlite3 *db, /* Database to be rekeyed */ 5724 const char *zDbName, /* Name of the database */ 5725 const void *pKey, int nKey /* The key */ 5726); 5727 5728/* 5729** Change the key on an open database. If the current database is not 5730** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 5731** database is decrypted. 5732** 5733** The code to implement this API is not available in the public release 5734** of SQLite. 5735*/ 5736int sqlite3_rekey( 5737 sqlite3 *db, /* Database to be rekeyed */ 5738 const void *pKey, int nKey /* The new key */ 5739); 5740int sqlite3_rekey_v2( 5741 sqlite3 *db, /* Database to be rekeyed */ 5742 const char *zDbName, /* Name of the database */ 5743 const void *pKey, int nKey /* The new key */ 5744); 5745 5746/* 5747** Specify the activation key for a SEE database. Unless 5748** activated, none of the SEE routines will work. 5749*/ 5750void sqlite3_activate_see( 5751 const char *zPassPhrase /* Activation phrase */ 5752); 5753#endif 5754 5755#ifdef SQLITE_ENABLE_CEROD 5756/* 5757** Specify the activation key for a CEROD database. Unless 5758** activated, none of the CEROD routines will work. 5759*/ 5760void sqlite3_activate_cerod( 5761 const char *zPassPhrase /* Activation phrase */ 5762); 5763#endif 5764 5765/* 5766** CAPI3REF: Suspend Execution For A Short Time 5767** 5768** The sqlite3_sleep() function causes the current thread to suspend execution 5769** for at least a number of milliseconds specified in its parameter. 5770** 5771** If the operating system does not support sleep requests with 5772** millisecond time resolution, then the time will be rounded up to 5773** the nearest second. The number of milliseconds of sleep actually 5774** requested from the operating system is returned. 5775** 5776** ^SQLite implements this interface by calling the xSleep() 5777** method of the default [sqlite3_vfs] object. If the xSleep() method 5778** of the default VFS is not implemented correctly, or not implemented at 5779** all, then the behavior of sqlite3_sleep() may deviate from the description 5780** in the previous paragraphs. 5781*/ 5782int sqlite3_sleep(int); 5783 5784/* 5785** CAPI3REF: Name Of The Folder Holding Temporary Files 5786** 5787** ^(If this global variable is made to point to a string which is 5788** the name of a folder (a.k.a. directory), then all temporary files 5789** created by SQLite when using a built-in [sqlite3_vfs | VFS] 5790** will be placed in that directory.)^ ^If this variable 5791** is a NULL pointer, then SQLite performs a search for an appropriate 5792** temporary file directory. 5793** 5794** Applications are strongly discouraged from using this global variable. 5795** It is required to set a temporary folder on Windows Runtime (WinRT). 5796** But for all other platforms, it is highly recommended that applications 5797** neither read nor write this variable. This global variable is a relic 5798** that exists for backwards compatibility of legacy applications and should 5799** be avoided in new projects. 5800** 5801** It is not safe to read or modify this variable in more than one 5802** thread at a time. It is not safe to read or modify this variable 5803** if a [database connection] is being used at the same time in a separate 5804** thread. 5805** It is intended that this variable be set once 5806** as part of process initialization and before any SQLite interface 5807** routines have been called and that this variable remain unchanged 5808** thereafter. 5809** 5810** ^The [temp_store_directory pragma] may modify this variable and cause 5811** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 5812** the [temp_store_directory pragma] always assumes that any string 5813** that this variable points to is held in memory obtained from 5814** [sqlite3_malloc] and the pragma may attempt to free that memory 5815** using [sqlite3_free]. 5816** Hence, if this variable is modified directly, either it should be 5817** made NULL or made to point to memory obtained from [sqlite3_malloc] 5818** or else the use of the [temp_store_directory pragma] should be avoided. 5819** Except when requested by the [temp_store_directory pragma], SQLite 5820** does not free the memory that sqlite3_temp_directory points to. If 5821** the application wants that memory to be freed, it must do 5822** so itself, taking care to only do so after all [database connection] 5823** objects have been destroyed. 5824** 5825** <b>Note to Windows Runtime users:</b> The temporary directory must be set 5826** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various 5827** features that require the use of temporary files may fail. Here is an 5828** example of how to do this using C++ with the Windows Runtime: 5829** 5830** <blockquote><pre> 5831** LPCWSTR zPath = Windows::Storage::ApplicationData::Current-> 5832** TemporaryFolder->Path->Data(); 5833** char zPathBuf[MAX_PATH + 1]; 5834** memset(zPathBuf, 0, sizeof(zPathBuf)); 5835** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf), 5836** NULL, NULL); 5837** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf); 5838** </pre></blockquote> 5839*/ 5840SQLITE_EXTERN char *sqlite3_temp_directory; 5841 5842/* 5843** CAPI3REF: Name Of The Folder Holding Database Files 5844** 5845** ^(If this global variable is made to point to a string which is 5846** the name of a folder (a.k.a. directory), then all database files 5847** specified with a relative pathname and created or accessed by 5848** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed 5849** to be relative to that directory.)^ ^If this variable is a NULL 5850** pointer, then SQLite assumes that all database files specified 5851** with a relative pathname are relative to the current directory 5852** for the process. Only the windows VFS makes use of this global 5853** variable; it is ignored by the unix VFS. 5854** 5855** Changing the value of this variable while a database connection is 5856** open can result in a corrupt database. 5857** 5858** It is not safe to read or modify this variable in more than one 5859** thread at a time. It is not safe to read or modify this variable 5860** if a [database connection] is being used at the same time in a separate 5861** thread. 5862** It is intended that this variable be set once 5863** as part of process initialization and before any SQLite interface 5864** routines have been called and that this variable remain unchanged 5865** thereafter. 5866** 5867** ^The [data_store_directory pragma] may modify this variable and cause 5868** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 5869** the [data_store_directory pragma] always assumes that any string 5870** that this variable points to is held in memory obtained from 5871** [sqlite3_malloc] and the pragma may attempt to free that memory 5872** using [sqlite3_free]. 5873** Hence, if this variable is modified directly, either it should be 5874** made NULL or made to point to memory obtained from [sqlite3_malloc] 5875** or else the use of the [data_store_directory pragma] should be avoided. 5876*/ 5877SQLITE_EXTERN char *sqlite3_data_directory; 5878 5879/* 5880** CAPI3REF: Win32 Specific Interface 5881** 5882** These interfaces are available only on Windows. The 5883** [sqlite3_win32_set_directory] interface is used to set the value associated 5884** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to 5885** zValue, depending on the value of the type parameter. The zValue parameter 5886** should be NULL to cause the previous value to be freed via [sqlite3_free]; 5887** a non-NULL value will be copied into memory obtained from [sqlite3_malloc] 5888** prior to being used. The [sqlite3_win32_set_directory] interface returns 5889** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported, 5890** or [SQLITE_NOMEM] if memory could not be allocated. The value of the 5891** [sqlite3_data_directory] variable is intended to act as a replacement for 5892** the current directory on the sub-platforms of Win32 where that concept is 5893** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and 5894** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the 5895** sqlite3_win32_set_directory interface except the string parameter must be 5896** UTF-8 or UTF-16, respectively. 5897*/ 5898int sqlite3_win32_set_directory( 5899 unsigned long type, /* Identifier for directory being set or reset */ 5900 void *zValue /* New value for directory being set or reset */ 5901); 5902int sqlite3_win32_set_directory8(unsigned long type, const char *zValue); 5903int sqlite3_win32_set_directory16(unsigned long type, const void *zValue); 5904 5905/* 5906** CAPI3REF: Win32 Directory Types 5907** 5908** These macros are only available on Windows. They define the allowed values 5909** for the type argument to the [sqlite3_win32_set_directory] interface. 5910*/ 5911#define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1 5912#define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2 5913 5914/* 5915** CAPI3REF: Test For Auto-Commit Mode 5916** KEYWORDS: {autocommit mode} 5917** METHOD: sqlite3 5918** 5919** ^The sqlite3_get_autocommit() interface returns non-zero or 5920** zero if the given database connection is or is not in autocommit mode, 5921** respectively. ^Autocommit mode is on by default. 5922** ^Autocommit mode is disabled by a [BEGIN] statement. 5923** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 5924** 5925** If certain kinds of errors occur on a statement within a multi-statement 5926** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 5927** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 5928** transaction might be rolled back automatically. The only way to 5929** find out whether SQLite automatically rolled back the transaction after 5930** an error is to use this function. 5931** 5932** If another thread changes the autocommit status of the database 5933** connection while this routine is running, then the return value 5934** is undefined. 5935*/ 5936int sqlite3_get_autocommit(sqlite3*); 5937 5938/* 5939** CAPI3REF: Find The Database Handle Of A Prepared Statement 5940** METHOD: sqlite3_stmt 5941** 5942** ^The sqlite3_db_handle interface returns the [database connection] handle 5943** to which a [prepared statement] belongs. ^The [database connection] 5944** returned by sqlite3_db_handle is the same [database connection] 5945** that was the first argument 5946** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 5947** create the statement in the first place. 5948*/ 5949sqlite3 *sqlite3_db_handle(sqlite3_stmt*); 5950 5951/* 5952** CAPI3REF: Return The Filename For A Database Connection 5953** METHOD: sqlite3 5954** 5955** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename 5956** associated with database N of connection D. 5957** ^If there is no attached database N on the database 5958** connection D, or if database N is a temporary or in-memory database, then 5959** this function will return either a NULL pointer or an empty string. 5960** 5961** ^The string value returned by this routine is owned and managed by 5962** the database connection. ^The value will be valid until the database N 5963** is [DETACH]-ed or until the database connection closes. 5964** 5965** ^The filename returned by this function is the output of the 5966** xFullPathname method of the [VFS]. ^In other words, the filename 5967** will be an absolute pathname, even if the filename used 5968** to open the database originally was a URI or relative pathname. 5969*/ 5970const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); 5971 5972/* 5973** CAPI3REF: Determine if a database is read-only 5974** METHOD: sqlite3 5975** 5976** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N 5977** of connection D is read-only, 0 if it is read/write, or -1 if N is not 5978** the name of a database on connection D. 5979*/ 5980int sqlite3_db_readonly(sqlite3 *db, const char *zDbName); 5981 5982/* 5983** CAPI3REF: Find the next prepared statement 5984** METHOD: sqlite3 5985** 5986** ^This interface returns a pointer to the next [prepared statement] after 5987** pStmt associated with the [database connection] pDb. ^If pStmt is NULL 5988** then this interface returns a pointer to the first prepared statement 5989** associated with the database connection pDb. ^If no prepared statement 5990** satisfies the conditions of this routine, it returns NULL. 5991** 5992** The [database connection] pointer D in a call to 5993** [sqlite3_next_stmt(D,S)] must refer to an open database 5994** connection and in particular must not be a NULL pointer. 5995*/ 5996sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 5997 5998/* 5999** CAPI3REF: Commit And Rollback Notification Callbacks 6000** METHOD: sqlite3 6001** 6002** ^The sqlite3_commit_hook() interface registers a callback 6003** function to be invoked whenever a transaction is [COMMIT | committed]. 6004** ^Any callback set by a previous call to sqlite3_commit_hook() 6005** for the same database connection is overridden. 6006** ^The sqlite3_rollback_hook() interface registers a callback 6007** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. 6008** ^Any callback set by a previous call to sqlite3_rollback_hook() 6009** for the same database connection is overridden. 6010** ^The pArg argument is passed through to the callback. 6011** ^If the callback on a commit hook function returns non-zero, 6012** then the commit is converted into a rollback. 6013** 6014** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions 6015** return the P argument from the previous call of the same function 6016** on the same [database connection] D, or NULL for 6017** the first call for each function on D. 6018** 6019** The commit and rollback hook callbacks are not reentrant. 6020** The callback implementation must not do anything that will modify 6021** the database connection that invoked the callback. Any actions 6022** to modify the database connection must be deferred until after the 6023** completion of the [sqlite3_step()] call that triggered the commit 6024** or rollback hook in the first place. 6025** Note that running any other SQL statements, including SELECT statements, 6026** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify 6027** the database connections for the meaning of "modify" in this paragraph. 6028** 6029** ^Registering a NULL function disables the callback. 6030** 6031** ^When the commit hook callback routine returns zero, the [COMMIT] 6032** operation is allowed to continue normally. ^If the commit hook 6033** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. 6034** ^The rollback hook is invoked on a rollback that results from a commit 6035** hook returning non-zero, just as it would be with any other rollback. 6036** 6037** ^For the purposes of this API, a transaction is said to have been 6038** rolled back if an explicit "ROLLBACK" statement is executed, or 6039** an error or constraint causes an implicit rollback to occur. 6040** ^The rollback callback is not invoked if a transaction is 6041** automatically rolled back because the database connection is closed. 6042** 6043** See also the [sqlite3_update_hook()] interface. 6044*/ 6045void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 6046void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 6047 6048/* 6049** CAPI3REF: Data Change Notification Callbacks 6050** METHOD: sqlite3 6051** 6052** ^The sqlite3_update_hook() interface registers a callback function 6053** with the [database connection] identified by the first argument 6054** to be invoked whenever a row is updated, inserted or deleted in 6055** a [rowid table]. 6056** ^Any callback set by a previous call to this function 6057** for the same database connection is overridden. 6058** 6059** ^The second argument is a pointer to the function to invoke when a 6060** row is updated, inserted or deleted in a rowid table. 6061** ^The first argument to the callback is a copy of the third argument 6062** to sqlite3_update_hook(). 6063** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 6064** or [SQLITE_UPDATE], depending on the operation that caused the callback 6065** to be invoked. 6066** ^The third and fourth arguments to the callback contain pointers to the 6067** database and table name containing the affected row. 6068** ^The final callback parameter is the [rowid] of the row. 6069** ^In the case of an update, this is the [rowid] after the update takes place. 6070** 6071** ^(The update hook is not invoked when internal system tables are 6072** modified (i.e. sqlite_master and sqlite_sequence).)^ 6073** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified. 6074** 6075** ^In the current implementation, the update hook 6076** is not invoked when conflicting rows are deleted because of an 6077** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook 6078** invoked when rows are deleted using the [truncate optimization]. 6079** The exceptions defined in this paragraph might change in a future 6080** release of SQLite. 6081** 6082** The update hook implementation must not do anything that will modify 6083** the database connection that invoked the update hook. Any actions 6084** to modify the database connection must be deferred until after the 6085** completion of the [sqlite3_step()] call that triggered the update hook. 6086** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 6087** database connections for the meaning of "modify" in this paragraph. 6088** 6089** ^The sqlite3_update_hook(D,C,P) function 6090** returns the P argument from the previous call 6091** on the same [database connection] D, or NULL for 6092** the first call on D. 6093** 6094** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()], 6095** and [sqlite3_preupdate_hook()] interfaces. 6096*/ 6097void *sqlite3_update_hook( 6098 sqlite3*, 6099 void(*)(void *,int ,char const *,char const *,sqlite3_int64), 6100 void* 6101); 6102 6103/* 6104** CAPI3REF: Enable Or Disable Shared Pager Cache 6105** 6106** ^(This routine enables or disables the sharing of the database cache 6107** and schema data structures between [database connection | connections] 6108** to the same database. Sharing is enabled if the argument is true 6109** and disabled if the argument is false.)^ 6110** 6111** ^Cache sharing is enabled and disabled for an entire process. 6112** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]). 6113** In prior versions of SQLite, 6114** sharing was enabled or disabled for each thread separately. 6115** 6116** ^(The cache sharing mode set by this interface effects all subsequent 6117** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 6118** Existing database connections continue to use the sharing mode 6119** that was in effect at the time they were opened.)^ 6120** 6121** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled 6122** successfully. An [error code] is returned otherwise.)^ 6123** 6124** ^Shared cache is disabled by default. It is recommended that it stay 6125** that way. In other words, do not use this routine. This interface 6126** continues to be provided for historical compatibility, but its use is 6127** discouraged. Any use of shared cache is discouraged. If shared cache 6128** must be used, it is recommended that shared cache only be enabled for 6129** individual database connections using the [sqlite3_open_v2()] interface 6130** with the [SQLITE_OPEN_SHAREDCACHE] flag. 6131** 6132** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0 6133** and will always return SQLITE_MISUSE. On those systems, 6134** shared cache mode should be enabled per-database connection via 6135** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE]. 6136** 6137** This interface is threadsafe on processors where writing a 6138** 32-bit integer is atomic. 6139** 6140** See Also: [SQLite Shared-Cache Mode] 6141*/ 6142int sqlite3_enable_shared_cache(int); 6143 6144/* 6145** CAPI3REF: Attempt To Free Heap Memory 6146** 6147** ^The sqlite3_release_memory() interface attempts to free N bytes 6148** of heap memory by deallocating non-essential memory allocations 6149** held by the database library. Memory used to cache database 6150** pages to improve performance is an example of non-essential memory. 6151** ^sqlite3_release_memory() returns the number of bytes actually freed, 6152** which might be more or less than the amount requested. 6153** ^The sqlite3_release_memory() routine is a no-op returning zero 6154** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. 6155** 6156** See also: [sqlite3_db_release_memory()] 6157*/ 6158int sqlite3_release_memory(int); 6159 6160/* 6161** CAPI3REF: Free Memory Used By A Database Connection 6162** METHOD: sqlite3 6163** 6164** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap 6165** memory as possible from database connection D. Unlike the 6166** [sqlite3_release_memory()] interface, this interface is in effect even 6167** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is 6168** omitted. 6169** 6170** See also: [sqlite3_release_memory()] 6171*/ 6172int sqlite3_db_release_memory(sqlite3*); 6173 6174/* 6175** CAPI3REF: Impose A Limit On Heap Size 6176** 6177** These interfaces impose limits on the amount of heap memory that will be 6178** by all database connections within a single process. 6179** 6180** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the 6181** soft limit on the amount of heap memory that may be allocated by SQLite. 6182** ^SQLite strives to keep heap memory utilization below the soft heap 6183** limit by reducing the number of pages held in the page cache 6184** as heap memory usages approaches the limit. 6185** ^The soft heap limit is "soft" because even though SQLite strives to stay 6186** below the limit, it will exceed the limit rather than generate 6187** an [SQLITE_NOMEM] error. In other words, the soft heap limit 6188** is advisory only. 6189** 6190** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of 6191** N bytes on the amount of memory that will be allocated. ^The 6192** sqlite3_hard_heap_limit64(N) interface is similar to 6193** sqlite3_soft_heap_limit64(N) except that memory allocations will fail 6194** when the hard heap limit is reached. 6195** 6196** ^The return value from both sqlite3_soft_heap_limit64() and 6197** sqlite3_hard_heap_limit64() is the size of 6198** the heap limit prior to the call, or negative in the case of an 6199** error. ^If the argument N is negative 6200** then no change is made to the heap limit. Hence, the current 6201** size of heap limits can be determined by invoking 6202** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1). 6203** 6204** ^Setting the heap limits to zero disables the heap limiter mechanism. 6205** 6206** ^The soft heap limit may not be greater than the hard heap limit. 6207** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N) 6208** is invoked with a value of N that is greater than the hard heap limit, 6209** the the soft heap limit is set to the value of the hard heap limit. 6210** ^The soft heap limit is automatically enabled whenever the hard heap 6211** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and 6212** the soft heap limit is outside the range of 1..N, then the soft heap 6213** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the 6214** hard heap limit is enabled makes the soft heap limit equal to the 6215** hard heap limit. 6216** 6217** The memory allocation limits can also be adjusted using 6218** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit]. 6219** 6220** ^(The heap limits are not enforced in the current implementation 6221** if one or more of following conditions are true: 6222** 6223** <ul> 6224** <li> The limit value is set to zero. 6225** <li> Memory accounting is disabled using a combination of the 6226** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and 6227** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. 6228** <li> An alternative page cache implementation is specified using 6229** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...). 6230** <li> The page cache allocates from its own memory pool supplied 6231** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than 6232** from the heap. 6233** </ul>)^ 6234** 6235** The circumstances under which SQLite will enforce the heap limits may 6236** changes in future releases of SQLite. 6237*/ 6238sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); 6239sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N); 6240 6241/* 6242** CAPI3REF: Deprecated Soft Heap Limit Interface 6243** DEPRECATED 6244** 6245** This is a deprecated version of the [sqlite3_soft_heap_limit64()] 6246** interface. This routine is provided for historical compatibility 6247** only. All new applications should use the 6248** [sqlite3_soft_heap_limit64()] interface rather than this one. 6249*/ 6250SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); 6251 6252 6253/* 6254** CAPI3REF: Extract Metadata About A Column Of A Table 6255** METHOD: sqlite3 6256** 6257** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns 6258** information about column C of table T in database D 6259** on [database connection] X.)^ ^The sqlite3_table_column_metadata() 6260** interface returns SQLITE_OK and fills in the non-NULL pointers in 6261** the final five arguments with appropriate values if the specified 6262** column exists. ^The sqlite3_table_column_metadata() interface returns 6263** SQLITE_ERROR if the specified column does not exist. 6264** ^If the column-name parameter to sqlite3_table_column_metadata() is a 6265** NULL pointer, then this routine simply checks for the existence of the 6266** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it 6267** does not. If the table name parameter T in a call to 6268** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is 6269** undefined behavior. 6270** 6271** ^The column is identified by the second, third and fourth parameters to 6272** this function. ^(The second parameter is either the name of the database 6273** (i.e. "main", "temp", or an attached database) containing the specified 6274** table or NULL.)^ ^If it is NULL, then all attached databases are searched 6275** for the table using the same algorithm used by the database engine to 6276** resolve unqualified table references. 6277** 6278** ^The third and fourth parameters to this function are the table and column 6279** name of the desired column, respectively. 6280** 6281** ^Metadata is returned by writing to the memory locations passed as the 5th 6282** and subsequent parameters to this function. ^Any of these arguments may be 6283** NULL, in which case the corresponding element of metadata is omitted. 6284** 6285** ^(<blockquote> 6286** <table border="1"> 6287** <tr><th> Parameter <th> Output<br>Type <th> Description 6288** 6289** <tr><td> 5th <td> const char* <td> Data type 6290** <tr><td> 6th <td> const char* <td> Name of default collation sequence 6291** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 6292** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 6293** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] 6294** </table> 6295** </blockquote>)^ 6296** 6297** ^The memory pointed to by the character pointers returned for the 6298** declaration type and collation sequence is valid until the next 6299** call to any SQLite API function. 6300** 6301** ^If the specified table is actually a view, an [error code] is returned. 6302** 6303** ^If the specified column is "rowid", "oid" or "_rowid_" and the table 6304** is not a [WITHOUT ROWID] table and an 6305** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output 6306** parameters are set for the explicitly declared column. ^(If there is no 6307** [INTEGER PRIMARY KEY] column, then the outputs 6308** for the [rowid] are set as follows: 6309** 6310** <pre> 6311** data type: "INTEGER" 6312** collation sequence: "BINARY" 6313** not null: 0 6314** primary key: 1 6315** auto increment: 0 6316** </pre>)^ 6317** 6318** ^This function causes all database schemas to be read from disk and 6319** parsed, if that has not already been done, and returns an error if 6320** any errors are encountered while loading the schema. 6321*/ 6322int sqlite3_table_column_metadata( 6323 sqlite3 *db, /* Connection handle */ 6324 const char *zDbName, /* Database name or NULL */ 6325 const char *zTableName, /* Table name */ 6326 const char *zColumnName, /* Column name */ 6327 char const **pzDataType, /* OUTPUT: Declared data type */ 6328 char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 6329 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 6330 int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 6331 int *pAutoinc /* OUTPUT: True if column is auto-increment */ 6332); 6333 6334/* 6335** CAPI3REF: Load An Extension 6336** METHOD: sqlite3 6337** 6338** ^This interface loads an SQLite extension library from the named file. 6339** 6340** ^The sqlite3_load_extension() interface attempts to load an 6341** [SQLite extension] library contained in the file zFile. If 6342** the file cannot be loaded directly, attempts are made to load 6343** with various operating-system specific extensions added. 6344** So for example, if "samplelib" cannot be loaded, then names like 6345** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might 6346** be tried also. 6347** 6348** ^The entry point is zProc. 6349** ^(zProc may be 0, in which case SQLite will try to come up with an 6350** entry point name on its own. It first tries "sqlite3_extension_init". 6351** If that does not work, it constructs a name "sqlite3_X_init" where the 6352** X is consists of the lower-case equivalent of all ASCII alphabetic 6353** characters in the filename from the last "/" to the first following 6354** "." and omitting any initial "lib".)^ 6355** ^The sqlite3_load_extension() interface returns 6356** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 6357** ^If an error occurs and pzErrMsg is not 0, then the 6358** [sqlite3_load_extension()] interface shall attempt to 6359** fill *pzErrMsg with error message text stored in memory 6360** obtained from [sqlite3_malloc()]. The calling function 6361** should free this memory by calling [sqlite3_free()]. 6362** 6363** ^Extension loading must be enabled using 6364** [sqlite3_enable_load_extension()] or 6365** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL) 6366** prior to calling this API, 6367** otherwise an error will be returned. 6368** 6369** <b>Security warning:</b> It is recommended that the 6370** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this 6371** interface. The use of the [sqlite3_enable_load_extension()] interface 6372** should be avoided. This will keep the SQL function [load_extension()] 6373** disabled and prevent SQL injections from giving attackers 6374** access to extension loading capabilities. 6375** 6376** See also the [load_extension() SQL function]. 6377*/ 6378int sqlite3_load_extension( 6379 sqlite3 *db, /* Load the extension into this database connection */ 6380 const char *zFile, /* Name of the shared library containing extension */ 6381 const char *zProc, /* Entry point. Derived from zFile if 0 */ 6382 char **pzErrMsg /* Put error message here if not 0 */ 6383); 6384 6385/* 6386** CAPI3REF: Enable Or Disable Extension Loading 6387** METHOD: sqlite3 6388** 6389** ^So as not to open security holes in older applications that are 6390** unprepared to deal with [extension loading], and as a means of disabling 6391** [extension loading] while evaluating user-entered SQL, the following API 6392** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 6393** 6394** ^Extension loading is off by default. 6395** ^Call the sqlite3_enable_load_extension() routine with onoff==1 6396** to turn extension loading on and call it with onoff==0 to turn 6397** it back off again. 6398** 6399** ^This interface enables or disables both the C-API 6400** [sqlite3_load_extension()] and the SQL function [load_extension()]. 6401** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..) 6402** to enable or disable only the C-API.)^ 6403** 6404** <b>Security warning:</b> It is recommended that extension loading 6405** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method 6406** rather than this interface, so the [load_extension()] SQL function 6407** remains disabled. This will prevent SQL injections from giving attackers 6408** access to extension loading capabilities. 6409*/ 6410int sqlite3_enable_load_extension(sqlite3 *db, int onoff); 6411 6412/* 6413** CAPI3REF: Automatically Load Statically Linked Extensions 6414** 6415** ^This interface causes the xEntryPoint() function to be invoked for 6416** each new [database connection] that is created. The idea here is that 6417** xEntryPoint() is the entry point for a statically linked [SQLite extension] 6418** that is to be automatically loaded into all new database connections. 6419** 6420** ^(Even though the function prototype shows that xEntryPoint() takes 6421** no arguments and returns void, SQLite invokes xEntryPoint() with three 6422** arguments and expects an integer result as if the signature of the 6423** entry point where as follows: 6424** 6425** <blockquote><pre> 6426** int xEntryPoint( 6427** sqlite3 *db, 6428** const char **pzErrMsg, 6429** const struct sqlite3_api_routines *pThunk 6430** ); 6431** </pre></blockquote>)^ 6432** 6433** If the xEntryPoint routine encounters an error, it should make *pzErrMsg 6434** point to an appropriate error message (obtained from [sqlite3_mprintf()]) 6435** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg 6436** is NULL before calling the xEntryPoint(). ^SQLite will invoke 6437** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any 6438** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], 6439** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. 6440** 6441** ^Calling sqlite3_auto_extension(X) with an entry point X that is already 6442** on the list of automatic extensions is a harmless no-op. ^No entry point 6443** will be called more than once for each database connection that is opened. 6444** 6445** See also: [sqlite3_reset_auto_extension()] 6446** and [sqlite3_cancel_auto_extension()] 6447*/ 6448int sqlite3_auto_extension(void(*xEntryPoint)(void)); 6449 6450/* 6451** CAPI3REF: Cancel Automatic Extension Loading 6452** 6453** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the 6454** initialization routine X that was registered using a prior call to 6455** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)] 6456** routine returns 1 if initialization routine X was successfully 6457** unregistered and it returns 0 if X was not on the list of initialization 6458** routines. 6459*/ 6460int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void)); 6461 6462/* 6463** CAPI3REF: Reset Automatic Extension Loading 6464** 6465** ^This interface disables all automatic extensions previously 6466** registered using [sqlite3_auto_extension()]. 6467*/ 6468void sqlite3_reset_auto_extension(void); 6469 6470/* 6471** The interface to the virtual-table mechanism is currently considered 6472** to be experimental. The interface might change in incompatible ways. 6473** If this is a problem for you, do not use the interface at this time. 6474** 6475** When the virtual-table mechanism stabilizes, we will declare the 6476** interface fixed, support it indefinitely, and remove this comment. 6477*/ 6478 6479/* 6480** Structures used by the virtual table interface 6481*/ 6482typedef struct sqlite3_vtab sqlite3_vtab; 6483typedef struct sqlite3_index_info sqlite3_index_info; 6484typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 6485typedef struct sqlite3_module sqlite3_module; 6486 6487/* 6488** CAPI3REF: Virtual Table Object 6489** KEYWORDS: sqlite3_module {virtual table module} 6490** 6491** This structure, sometimes called a "virtual table module", 6492** defines the implementation of a [virtual table]. 6493** This structure consists mostly of methods for the module. 6494** 6495** ^A virtual table module is created by filling in a persistent 6496** instance of this structure and passing a pointer to that instance 6497** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. 6498** ^The registration remains valid until it is replaced by a different 6499** module or until the [database connection] closes. The content 6500** of this structure must not change while it is registered with 6501** any database connection. 6502*/ 6503struct sqlite3_module { 6504 int iVersion; 6505 int (*xCreate)(sqlite3*, void *pAux, 6506 int argc, const char *const*argv, 6507 sqlite3_vtab **ppVTab, char**); 6508 int (*xConnect)(sqlite3*, void *pAux, 6509 int argc, const char *const*argv, 6510 sqlite3_vtab **ppVTab, char**); 6511 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); 6512 int (*xDisconnect)(sqlite3_vtab *pVTab); 6513 int (*xDestroy)(sqlite3_vtab *pVTab); 6514 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); 6515 int (*xClose)(sqlite3_vtab_cursor*); 6516 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, 6517 int argc, sqlite3_value **argv); 6518 int (*xNext)(sqlite3_vtab_cursor*); 6519 int (*xEof)(sqlite3_vtab_cursor*); 6520 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); 6521 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 6522 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 6523 int (*xBegin)(sqlite3_vtab *pVTab); 6524 int (*xSync)(sqlite3_vtab *pVTab); 6525 int (*xCommit)(sqlite3_vtab *pVTab); 6526 int (*xRollback)(sqlite3_vtab *pVTab); 6527 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 6528 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 6529 void **ppArg); 6530 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 6531 /* The methods above are in version 1 of the sqlite_module object. Those 6532 ** below are for version 2 and greater. */ 6533 int (*xSavepoint)(sqlite3_vtab *pVTab, int); 6534 int (*xRelease)(sqlite3_vtab *pVTab, int); 6535 int (*xRollbackTo)(sqlite3_vtab *pVTab, int); 6536 /* The methods above are in versions 1 and 2 of the sqlite_module object. 6537 ** Those below are for version 3 and greater. */ 6538 int (*xShadowName)(const char*); 6539}; 6540 6541/* 6542** CAPI3REF: Virtual Table Indexing Information 6543** KEYWORDS: sqlite3_index_info 6544** 6545** The sqlite3_index_info structure and its substructures is used as part 6546** of the [virtual table] interface to 6547** pass information into and receive the reply from the [xBestIndex] 6548** method of a [virtual table module]. The fields under **Inputs** are the 6549** inputs to xBestIndex and are read-only. xBestIndex inserts its 6550** results into the **Outputs** fields. 6551** 6552** ^(The aConstraint[] array records WHERE clause constraints of the form: 6553** 6554** <blockquote>column OP expr</blockquote> 6555** 6556** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is 6557** stored in aConstraint[].op using one of the 6558** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ 6559** ^(The index of the column is stored in 6560** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the 6561** expr on the right-hand side can be evaluated (and thus the constraint 6562** is usable) and false if it cannot.)^ 6563** 6564** ^The optimizer automatically inverts terms of the form "expr OP column" 6565** and makes other simplifications to the WHERE clause in an attempt to 6566** get as many WHERE clause terms into the form shown above as possible. 6567** ^The aConstraint[] array only reports WHERE clause terms that are 6568** relevant to the particular virtual table being queried. 6569** 6570** ^Information about the ORDER BY clause is stored in aOrderBy[]. 6571** ^Each term of aOrderBy records a column of the ORDER BY clause. 6572** 6573** The colUsed field indicates which columns of the virtual table may be 6574** required by the current scan. Virtual table columns are numbered from 6575** zero in the order in which they appear within the CREATE TABLE statement 6576** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), 6577** the corresponding bit is set within the colUsed mask if the column may be 6578** required by SQLite. If the table has at least 64 columns and any column 6579** to the right of the first 63 is required, then bit 63 of colUsed is also 6580** set. In other words, column iCol may be required if the expression 6581** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to 6582** non-zero. 6583** 6584** The [xBestIndex] method must fill aConstraintUsage[] with information 6585** about what parameters to pass to xFilter. ^If argvIndex>0 then 6586** the right-hand side of the corresponding aConstraint[] is evaluated 6587** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit 6588** is true, then the constraint is assumed to be fully handled by the 6589** virtual table and might not be checked again by the byte code.)^ ^(The 6590** aConstraintUsage[].omit flag is an optimization hint. When the omit flag 6591** is left in its default setting of false, the constraint will always be 6592** checked separately in byte code. If the omit flag is change to true, then 6593** the constraint may or may not be checked in byte code. In other words, 6594** when the omit flag is true there is no guarantee that the constraint will 6595** not be checked again using byte code.)^ 6596** 6597** ^The idxNum and idxPtr values are recorded and passed into the 6598** [xFilter] method. 6599** ^[sqlite3_free()] is used to free idxPtr if and only if 6600** needToFreeIdxPtr is true. 6601** 6602** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in 6603** the correct order to satisfy the ORDER BY clause so that no separate 6604** sorting step is required. 6605** 6606** ^The estimatedCost value is an estimate of the cost of a particular 6607** strategy. A cost of N indicates that the cost of the strategy is similar 6608** to a linear scan of an SQLite table with N rows. A cost of log(N) 6609** indicates that the expense of the operation is similar to that of a 6610** binary search on a unique indexed field of an SQLite table with N rows. 6611** 6612** ^The estimatedRows value is an estimate of the number of rows that 6613** will be returned by the strategy. 6614** 6615** The xBestIndex method may optionally populate the idxFlags field with a 6616** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag - 6617** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite 6618** assumes that the strategy may visit at most one row. 6619** 6620** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then 6621** SQLite also assumes that if a call to the xUpdate() method is made as 6622** part of the same statement to delete or update a virtual table row and the 6623** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback 6624** any database changes. In other words, if the xUpdate() returns 6625** SQLITE_CONSTRAINT, the database contents must be exactly as they were 6626** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not 6627** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by 6628** the xUpdate method are automatically rolled back by SQLite. 6629** 6630** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info 6631** structure for SQLite [version 3.8.2] ([dateof:3.8.2]). 6632** If a virtual table extension is 6633** used with an SQLite version earlier than 3.8.2, the results of attempting 6634** to read or write the estimatedRows field are undefined (but are likely 6635** to include crashing the application). The estimatedRows field should 6636** therefore only be used if [sqlite3_libversion_number()] returns a 6637** value greater than or equal to 3008002. Similarly, the idxFlags field 6638** was added for [version 3.9.0] ([dateof:3.9.0]). 6639** It may therefore only be used if 6640** sqlite3_libversion_number() returns a value greater than or equal to 6641** 3009000. 6642*/ 6643struct sqlite3_index_info { 6644 /* Inputs */ 6645 int nConstraint; /* Number of entries in aConstraint */ 6646 struct sqlite3_index_constraint { 6647 int iColumn; /* Column constrained. -1 for ROWID */ 6648 unsigned char op; /* Constraint operator */ 6649 unsigned char usable; /* True if this constraint is usable */ 6650 int iTermOffset; /* Used internally - xBestIndex should ignore */ 6651 } *aConstraint; /* Table of WHERE clause constraints */ 6652 int nOrderBy; /* Number of terms in the ORDER BY clause */ 6653 struct sqlite3_index_orderby { 6654 int iColumn; /* Column number */ 6655 unsigned char desc; /* True for DESC. False for ASC. */ 6656 } *aOrderBy; /* The ORDER BY clause */ 6657 /* Outputs */ 6658 struct sqlite3_index_constraint_usage { 6659 int argvIndex; /* if >0, constraint is part of argv to xFilter */ 6660 unsigned char omit; /* Do not code a test for this constraint */ 6661 } *aConstraintUsage; 6662 int idxNum; /* Number used to identify the index */ 6663 char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 6664 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 6665 int orderByConsumed; /* True if output is already ordered */ 6666 double estimatedCost; /* Estimated cost of using this index */ 6667 /* Fields below are only available in SQLite 3.8.2 and later */ 6668 sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ 6669 /* Fields below are only available in SQLite 3.9.0 and later */ 6670 int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ 6671 /* Fields below are only available in SQLite 3.10.0 and later */ 6672 sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ 6673}; 6674 6675/* 6676** CAPI3REF: Virtual Table Scan Flags 6677** 6678** Virtual table implementations are allowed to set the 6679** [sqlite3_index_info].idxFlags field to some combination of 6680** these bits. 6681*/ 6682#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ 6683 6684/* 6685** CAPI3REF: Virtual Table Constraint Operator Codes 6686** 6687** These macros define the allowed values for the 6688** [sqlite3_index_info].aConstraint[].op field. Each value represents 6689** an operator that is part of a constraint term in the wHERE clause of 6690** a query that uses a [virtual table]. 6691*/ 6692#define SQLITE_INDEX_CONSTRAINT_EQ 2 6693#define SQLITE_INDEX_CONSTRAINT_GT 4 6694#define SQLITE_INDEX_CONSTRAINT_LE 8 6695#define SQLITE_INDEX_CONSTRAINT_LT 16 6696#define SQLITE_INDEX_CONSTRAINT_GE 32 6697#define SQLITE_INDEX_CONSTRAINT_MATCH 64 6698#define SQLITE_INDEX_CONSTRAINT_LIKE 65 6699#define SQLITE_INDEX_CONSTRAINT_GLOB 66 6700#define SQLITE_INDEX_CONSTRAINT_REGEXP 67 6701#define SQLITE_INDEX_CONSTRAINT_NE 68 6702#define SQLITE_INDEX_CONSTRAINT_ISNOT 69 6703#define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 6704#define SQLITE_INDEX_CONSTRAINT_ISNULL 71 6705#define SQLITE_INDEX_CONSTRAINT_IS 72 6706#define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 6707 6708/* 6709** CAPI3REF: Register A Virtual Table Implementation 6710** METHOD: sqlite3 6711** 6712** ^These routines are used to register a new [virtual table module] name. 6713** ^Module names must be registered before 6714** creating a new [virtual table] using the module and before using a 6715** preexisting [virtual table] for the module. 6716** 6717** ^The module name is registered on the [database connection] specified 6718** by the first parameter. ^The name of the module is given by the 6719** second parameter. ^The third parameter is a pointer to 6720** the implementation of the [virtual table module]. ^The fourth 6721** parameter is an arbitrary client data pointer that is passed through 6722** into the [xCreate] and [xConnect] methods of the virtual table module 6723** when a new virtual table is be being created or reinitialized. 6724** 6725** ^The sqlite3_create_module_v2() interface has a fifth parameter which 6726** is a pointer to a destructor for the pClientData. ^SQLite will 6727** invoke the destructor function (if it is not NULL) when SQLite 6728** no longer needs the pClientData pointer. ^The destructor will also 6729** be invoked if the call to sqlite3_create_module_v2() fails. 6730** ^The sqlite3_create_module() 6731** interface is equivalent to sqlite3_create_module_v2() with a NULL 6732** destructor. 6733** 6734** ^If the third parameter (the pointer to the sqlite3_module object) is 6735** NULL then no new module is create and any existing modules with the 6736** same name are dropped. 6737** 6738** See also: [sqlite3_drop_modules()] 6739*/ 6740int sqlite3_create_module( 6741 sqlite3 *db, /* SQLite connection to register module with */ 6742 const char *zName, /* Name of the module */ 6743 const sqlite3_module *p, /* Methods for the module */ 6744 void *pClientData /* Client data for xCreate/xConnect */ 6745); 6746int sqlite3_create_module_v2( 6747 sqlite3 *db, /* SQLite connection to register module with */ 6748 const char *zName, /* Name of the module */ 6749 const sqlite3_module *p, /* Methods for the module */ 6750 void *pClientData, /* Client data for xCreate/xConnect */ 6751 void(*xDestroy)(void*) /* Module destructor function */ 6752); 6753 6754/* 6755** CAPI3REF: Remove Unnecessary Virtual Table Implementations 6756** METHOD: sqlite3 6757** 6758** ^The sqlite3_drop_modules(D,L) interface removes all virtual 6759** table modules from database connection D except those named on list L. 6760** The L parameter must be either NULL or a pointer to an array of pointers 6761** to strings where the array is terminated by a single NULL pointer. 6762** ^If the L parameter is NULL, then all virtual table modules are removed. 6763** 6764** See also: [sqlite3_create_module()] 6765*/ 6766int sqlite3_drop_modules( 6767 sqlite3 *db, /* Remove modules from this connection */ 6768 const char **azKeep /* Except, do not remove the ones named here */ 6769); 6770 6771/* 6772** CAPI3REF: Virtual Table Instance Object 6773** KEYWORDS: sqlite3_vtab 6774** 6775** Every [virtual table module] implementation uses a subclass 6776** of this object to describe a particular instance 6777** of the [virtual table]. Each subclass will 6778** be tailored to the specific needs of the module implementation. 6779** The purpose of this superclass is to define certain fields that are 6780** common to all module implementations. 6781** 6782** ^Virtual tables methods can set an error message by assigning a 6783** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 6784** take care that any prior string is freed by a call to [sqlite3_free()] 6785** prior to assigning a new string to zErrMsg. ^After the error message 6786** is delivered up to the client application, the string will be automatically 6787** freed by sqlite3_free() and the zErrMsg field will be zeroed. 6788*/ 6789struct sqlite3_vtab { 6790 const sqlite3_module *pModule; /* The module for this virtual table */ 6791 int nRef; /* Number of open cursors */ 6792 char *zErrMsg; /* Error message from sqlite3_mprintf() */ 6793 /* Virtual table implementations will typically add additional fields */ 6794}; 6795 6796/* 6797** CAPI3REF: Virtual Table Cursor Object 6798** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} 6799** 6800** Every [virtual table module] implementation uses a subclass of the 6801** following structure to describe cursors that point into the 6802** [virtual table] and are used 6803** to loop through the virtual table. Cursors are created using the 6804** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed 6805** by the [sqlite3_module.xClose | xClose] method. Cursors are used 6806** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods 6807** of the module. Each module implementation will define 6808** the content of a cursor structure to suit its own needs. 6809** 6810** This superclass exists in order to define fields of the cursor that 6811** are common to all implementations. 6812*/ 6813struct sqlite3_vtab_cursor { 6814 sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 6815 /* Virtual table implementations will typically add additional fields */ 6816}; 6817 6818/* 6819** CAPI3REF: Declare The Schema Of A Virtual Table 6820** 6821** ^The [xCreate] and [xConnect] methods of a 6822** [virtual table module] call this interface 6823** to declare the format (the names and datatypes of the columns) of 6824** the virtual tables they implement. 6825*/ 6826int sqlite3_declare_vtab(sqlite3*, const char *zSQL); 6827 6828/* 6829** CAPI3REF: Overload A Function For A Virtual Table 6830** METHOD: sqlite3 6831** 6832** ^(Virtual tables can provide alternative implementations of functions 6833** using the [xFindFunction] method of the [virtual table module]. 6834** But global versions of those functions 6835** must exist in order to be overloaded.)^ 6836** 6837** ^(This API makes sure a global version of a function with a particular 6838** name and number of parameters exists. If no such function exists 6839** before this API is called, a new function is created.)^ ^The implementation 6840** of the new function always causes an exception to be thrown. So 6841** the new function is not good for anything by itself. Its only 6842** purpose is to be a placeholder function that can be overloaded 6843** by a [virtual table]. 6844*/ 6845int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); 6846 6847/* 6848** The interface to the virtual-table mechanism defined above (back up 6849** to a comment remarkably similar to this one) is currently considered 6850** to be experimental. The interface might change in incompatible ways. 6851** If this is a problem for you, do not use the interface at this time. 6852** 6853** When the virtual-table mechanism stabilizes, we will declare the 6854** interface fixed, support it indefinitely, and remove this comment. 6855*/ 6856 6857/* 6858** CAPI3REF: A Handle To An Open BLOB 6859** KEYWORDS: {BLOB handle} {BLOB handles} 6860** 6861** An instance of this object represents an open BLOB on which 6862** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 6863** ^Objects of this type are created by [sqlite3_blob_open()] 6864** and destroyed by [sqlite3_blob_close()]. 6865** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 6866** can be used to read or write small subsections of the BLOB. 6867** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 6868*/ 6869typedef struct sqlite3_blob sqlite3_blob; 6870 6871/* 6872** CAPI3REF: Open A BLOB For Incremental I/O 6873** METHOD: sqlite3 6874** CONSTRUCTOR: sqlite3_blob 6875** 6876** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located 6877** in row iRow, column zColumn, table zTable in database zDb; 6878** in other words, the same BLOB that would be selected by: 6879** 6880** <pre> 6881** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; 6882** </pre>)^ 6883** 6884** ^(Parameter zDb is not the filename that contains the database, but 6885** rather the symbolic name of the database. For attached databases, this is 6886** the name that appears after the AS keyword in the [ATTACH] statement. 6887** For the main database file, the database name is "main". For TEMP 6888** tables, the database name is "temp".)^ 6889** 6890** ^If the flags parameter is non-zero, then the BLOB is opened for read 6891** and write access. ^If the flags parameter is zero, the BLOB is opened for 6892** read-only access. 6893** 6894** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored 6895** in *ppBlob. Otherwise an [error code] is returned and, unless the error 6896** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided 6897** the API is not misused, it is always safe to call [sqlite3_blob_close()] 6898** on *ppBlob after this function it returns. 6899** 6900** This function fails with SQLITE_ERROR if any of the following are true: 6901** <ul> 6902** <li> ^(Database zDb does not exist)^, 6903** <li> ^(Table zTable does not exist within database zDb)^, 6904** <li> ^(Table zTable is a WITHOUT ROWID table)^, 6905** <li> ^(Column zColumn does not exist)^, 6906** <li> ^(Row iRow is not present in the table)^, 6907** <li> ^(The specified column of row iRow contains a value that is not 6908** a TEXT or BLOB value)^, 6909** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE 6910** constraint and the blob is being opened for read/write access)^, 6911** <li> ^([foreign key constraints | Foreign key constraints] are enabled, 6912** column zColumn is part of a [child key] definition and the blob is 6913** being opened for read/write access)^. 6914** </ul> 6915** 6916** ^Unless it returns SQLITE_MISUSE, this function sets the 6917** [database connection] error code and message accessible via 6918** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. 6919** 6920** A BLOB referenced by sqlite3_blob_open() may be read using the 6921** [sqlite3_blob_read()] interface and modified by using 6922** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a 6923** different row of the same table using the [sqlite3_blob_reopen()] 6924** interface. However, the column, table, or database of a [BLOB handle] 6925** cannot be changed after the [BLOB handle] is opened. 6926** 6927** ^(If the row that a BLOB handle points to is modified by an 6928** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 6929** then the BLOB handle is marked as "expired". 6930** This is true if any column of the row is changed, even a column 6931** other than the one the BLOB handle is open on.)^ 6932** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 6933** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. 6934** ^(Changes written into a BLOB prior to the BLOB expiring are not 6935** rolled back by the expiration of the BLOB. Such changes will eventually 6936** commit if the transaction continues to completion.)^ 6937** 6938** ^Use the [sqlite3_blob_bytes()] interface to determine the size of 6939** the opened blob. ^The size of a blob may not be changed by this 6940** interface. Use the [UPDATE] SQL command to change the size of a 6941** blob. 6942** 6943** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces 6944** and the built-in [zeroblob] SQL function may be used to create a 6945** zero-filled blob to read or write using the incremental-blob interface. 6946** 6947** To avoid a resource leak, every open [BLOB handle] should eventually 6948** be released by a call to [sqlite3_blob_close()]. 6949** 6950** See also: [sqlite3_blob_close()], 6951** [sqlite3_blob_reopen()], [sqlite3_blob_read()], 6952** [sqlite3_blob_bytes()], [sqlite3_blob_write()]. 6953*/ 6954int sqlite3_blob_open( 6955 sqlite3*, 6956 const char *zDb, 6957 const char *zTable, 6958 const char *zColumn, 6959 sqlite3_int64 iRow, 6960 int flags, 6961 sqlite3_blob **ppBlob 6962); 6963 6964/* 6965** CAPI3REF: Move a BLOB Handle to a New Row 6966** METHOD: sqlite3_blob 6967** 6968** ^This function is used to move an existing [BLOB handle] so that it points 6969** to a different row of the same database table. ^The new row is identified 6970** by the rowid value passed as the second argument. Only the row can be 6971** changed. ^The database, table and column on which the blob handle is open 6972** remain the same. Moving an existing [BLOB handle] to a new row is 6973** faster than closing the existing handle and opening a new one. 6974** 6975** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - 6976** it must exist and there must be either a blob or text value stored in 6977** the nominated column.)^ ^If the new row is not present in the table, or if 6978** it does not contain a blob or text value, or if another error occurs, an 6979** SQLite error code is returned and the blob handle is considered aborted. 6980** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or 6981** [sqlite3_blob_reopen()] on an aborted blob handle immediately return 6982** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle 6983** always returns zero. 6984** 6985** ^This function sets the database handle error code and message. 6986*/ 6987int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); 6988 6989/* 6990** CAPI3REF: Close A BLOB Handle 6991** DESTRUCTOR: sqlite3_blob 6992** 6993** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed 6994** unconditionally. Even if this routine returns an error code, the 6995** handle is still closed.)^ 6996** 6997** ^If the blob handle being closed was opened for read-write access, and if 6998** the database is in auto-commit mode and there are no other open read-write 6999** blob handles or active write statements, the current transaction is 7000** committed. ^If an error occurs while committing the transaction, an error 7001** code is returned and the transaction rolled back. 7002** 7003** Calling this function with an argument that is not a NULL pointer or an 7004** open blob handle results in undefined behaviour. ^Calling this routine 7005** with a null pointer (such as would be returned by a failed call to 7006** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function 7007** is passed a valid open blob handle, the values returned by the 7008** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning. 7009*/ 7010int sqlite3_blob_close(sqlite3_blob *); 7011 7012/* 7013** CAPI3REF: Return The Size Of An Open BLOB 7014** METHOD: sqlite3_blob 7015** 7016** ^Returns the size in bytes of the BLOB accessible via the 7017** successfully opened [BLOB handle] in its only argument. ^The 7018** incremental blob I/O routines can only read or overwriting existing 7019** blob content; they cannot change the size of a blob. 7020** 7021** This routine only works on a [BLOB handle] which has been created 7022** by a prior successful call to [sqlite3_blob_open()] and which has not 7023** been closed by [sqlite3_blob_close()]. Passing any other pointer in 7024** to this routine results in undefined and probably undesirable behavior. 7025*/ 7026int sqlite3_blob_bytes(sqlite3_blob *); 7027 7028/* 7029** CAPI3REF: Read Data From A BLOB Incrementally 7030** METHOD: sqlite3_blob 7031** 7032** ^(This function is used to read data from an open [BLOB handle] into a 7033** caller-supplied buffer. N bytes of data are copied into buffer Z 7034** from the open BLOB, starting at offset iOffset.)^ 7035** 7036** ^If offset iOffset is less than N bytes from the end of the BLOB, 7037** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is 7038** less than zero, [SQLITE_ERROR] is returned and no data is read. 7039** ^The size of the blob (and hence the maximum value of N+iOffset) 7040** can be determined using the [sqlite3_blob_bytes()] interface. 7041** 7042** ^An attempt to read from an expired [BLOB handle] fails with an 7043** error code of [SQLITE_ABORT]. 7044** 7045** ^(On success, sqlite3_blob_read() returns SQLITE_OK. 7046** Otherwise, an [error code] or an [extended error code] is returned.)^ 7047** 7048** This routine only works on a [BLOB handle] which has been created 7049** by a prior successful call to [sqlite3_blob_open()] and which has not 7050** been closed by [sqlite3_blob_close()]. Passing any other pointer in 7051** to this routine results in undefined and probably undesirable behavior. 7052** 7053** See also: [sqlite3_blob_write()]. 7054*/ 7055int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 7056 7057/* 7058** CAPI3REF: Write Data Into A BLOB Incrementally 7059** METHOD: sqlite3_blob 7060** 7061** ^(This function is used to write data into an open [BLOB handle] from a 7062** caller-supplied buffer. N bytes of data are copied from the buffer Z 7063** into the open BLOB, starting at offset iOffset.)^ 7064** 7065** ^(On success, sqlite3_blob_write() returns SQLITE_OK. 7066** Otherwise, an [error code] or an [extended error code] is returned.)^ 7067** ^Unless SQLITE_MISUSE is returned, this function sets the 7068** [database connection] error code and message accessible via 7069** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. 7070** 7071** ^If the [BLOB handle] passed as the first argument was not opened for 7072** writing (the flags parameter to [sqlite3_blob_open()] was zero), 7073** this function returns [SQLITE_READONLY]. 7074** 7075** This function may only modify the contents of the BLOB; it is 7076** not possible to increase the size of a BLOB using this API. 7077** ^If offset iOffset is less than N bytes from the end of the BLOB, 7078** [SQLITE_ERROR] is returned and no data is written. The size of the 7079** BLOB (and hence the maximum value of N+iOffset) can be determined 7080** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less 7081** than zero [SQLITE_ERROR] is returned and no data is written. 7082** 7083** ^An attempt to write to an expired [BLOB handle] fails with an 7084** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred 7085** before the [BLOB handle] expired are not rolled back by the 7086** expiration of the handle, though of course those changes might 7087** have been overwritten by the statement that expired the BLOB handle 7088** or by other independent statements. 7089** 7090** This routine only works on a [BLOB handle] which has been created 7091** by a prior successful call to [sqlite3_blob_open()] and which has not 7092** been closed by [sqlite3_blob_close()]. Passing any other pointer in 7093** to this routine results in undefined and probably undesirable behavior. 7094** 7095** See also: [sqlite3_blob_read()]. 7096*/ 7097int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); 7098 7099/* 7100** CAPI3REF: Virtual File System Objects 7101** 7102** A virtual filesystem (VFS) is an [sqlite3_vfs] object 7103** that SQLite uses to interact 7104** with the underlying operating system. Most SQLite builds come with a 7105** single default VFS that is appropriate for the host computer. 7106** New VFSes can be registered and existing VFSes can be unregistered. 7107** The following interfaces are provided. 7108** 7109** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 7110** ^Names are case sensitive. 7111** ^Names are zero-terminated UTF-8 strings. 7112** ^If there is no match, a NULL pointer is returned. 7113** ^If zVfsName is NULL then the default VFS is returned. 7114** 7115** ^New VFSes are registered with sqlite3_vfs_register(). 7116** ^Each new VFS becomes the default VFS if the makeDflt flag is set. 7117** ^The same VFS can be registered multiple times without injury. 7118** ^To make an existing VFS into the default VFS, register it again 7119** with the makeDflt flag set. If two different VFSes with the 7120** same name are registered, the behavior is undefined. If a 7121** VFS is registered with a name that is NULL or an empty string, 7122** then the behavior is undefined. 7123** 7124** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. 7125** ^(If the default VFS is unregistered, another VFS is chosen as 7126** the default. The choice for the new VFS is arbitrary.)^ 7127*/ 7128sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); 7129int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 7130int sqlite3_vfs_unregister(sqlite3_vfs*); 7131 7132/* 7133** CAPI3REF: Mutexes 7134** 7135** The SQLite core uses these routines for thread 7136** synchronization. Though they are intended for internal 7137** use by SQLite, code that links against SQLite is 7138** permitted to use any of these routines. 7139** 7140** The SQLite source code contains multiple implementations 7141** of these mutex routines. An appropriate implementation 7142** is selected automatically at compile-time. The following 7143** implementations are available in the SQLite core: 7144** 7145** <ul> 7146** <li> SQLITE_MUTEX_PTHREADS 7147** <li> SQLITE_MUTEX_W32 7148** <li> SQLITE_MUTEX_NOOP 7149** </ul> 7150** 7151** The SQLITE_MUTEX_NOOP implementation is a set of routines 7152** that does no real locking and is appropriate for use in 7153** a single-threaded application. The SQLITE_MUTEX_PTHREADS and 7154** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix 7155** and Windows. 7156** 7157** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 7158** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 7159** implementation is included with the library. In this case the 7160** application must supply a custom mutex implementation using the 7161** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 7162** before calling sqlite3_initialize() or any other public sqlite3_ 7163** function that calls sqlite3_initialize(). 7164** 7165** ^The sqlite3_mutex_alloc() routine allocates a new 7166** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc() 7167** routine returns NULL if it is unable to allocate the requested 7168** mutex. The argument to sqlite3_mutex_alloc() must one of these 7169** integer constants: 7170** 7171** <ul> 7172** <li> SQLITE_MUTEX_FAST 7173** <li> SQLITE_MUTEX_RECURSIVE 7174** <li> SQLITE_MUTEX_STATIC_MASTER 7175** <li> SQLITE_MUTEX_STATIC_MEM 7176** <li> SQLITE_MUTEX_STATIC_OPEN 7177** <li> SQLITE_MUTEX_STATIC_PRNG 7178** <li> SQLITE_MUTEX_STATIC_LRU 7179** <li> SQLITE_MUTEX_STATIC_PMEM 7180** <li> SQLITE_MUTEX_STATIC_APP1 7181** <li> SQLITE_MUTEX_STATIC_APP2 7182** <li> SQLITE_MUTEX_STATIC_APP3 7183** <li> SQLITE_MUTEX_STATIC_VFS1 7184** <li> SQLITE_MUTEX_STATIC_VFS2 7185** <li> SQLITE_MUTEX_STATIC_VFS3 7186** </ul> 7187** 7188** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) 7189** cause sqlite3_mutex_alloc() to create 7190** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 7191** is used but not necessarily so when SQLITE_MUTEX_FAST is used. 7192** The mutex implementation does not need to make a distinction 7193** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 7194** not want to. SQLite will only request a recursive mutex in 7195** cases where it really needs one. If a faster non-recursive mutex 7196** implementation is available on the host platform, the mutex subsystem 7197** might return such a mutex in response to SQLITE_MUTEX_FAST. 7198** 7199** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other 7200** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return 7201** a pointer to a static preexisting mutex. ^Nine static mutexes are 7202** used by the current version of SQLite. Future versions of SQLite 7203** may add additional static mutexes. Static mutexes are for internal 7204** use by SQLite only. Applications that use SQLite mutexes should 7205** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 7206** SQLITE_MUTEX_RECURSIVE. 7207** 7208** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 7209** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 7210** returns a different mutex on every call. ^For the static 7211** mutex types, the same mutex is returned on every call that has 7212** the same type number. 7213** 7214** ^The sqlite3_mutex_free() routine deallocates a previously 7215** allocated dynamic mutex. Attempting to deallocate a static 7216** mutex results in undefined behavior. 7217** 7218** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 7219** to enter a mutex. ^If another thread is already within the mutex, 7220** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 7221** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] 7222** upon successful entry. ^(Mutexes created using 7223** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 7224** In such cases, the 7225** mutex must be exited an equal number of times before another thread 7226** can enter.)^ If the same thread tries to enter any mutex other 7227** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined. 7228** 7229** ^(Some systems (for example, Windows 95) do not support the operation 7230** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 7231** will always return SQLITE_BUSY. The SQLite core only ever uses 7232** sqlite3_mutex_try() as an optimization so this is acceptable 7233** behavior.)^ 7234** 7235** ^The sqlite3_mutex_leave() routine exits a mutex that was 7236** previously entered by the same thread. The behavior 7237** is undefined if the mutex is not currently entered by the 7238** calling thread or is not currently allocated. 7239** 7240** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 7241** sqlite3_mutex_leave() is a NULL pointer, then all three routines 7242** behave as no-ops. 7243** 7244** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 7245*/ 7246sqlite3_mutex *sqlite3_mutex_alloc(int); 7247void sqlite3_mutex_free(sqlite3_mutex*); 7248void sqlite3_mutex_enter(sqlite3_mutex*); 7249int sqlite3_mutex_try(sqlite3_mutex*); 7250void sqlite3_mutex_leave(sqlite3_mutex*); 7251 7252/* 7253** CAPI3REF: Mutex Methods Object 7254** 7255** An instance of this structure defines the low-level routines 7256** used to allocate and use mutexes. 7257** 7258** Usually, the default mutex implementations provided by SQLite are 7259** sufficient, however the application has the option of substituting a custom 7260** implementation for specialized deployments or systems for which SQLite 7261** does not provide a suitable implementation. In this case, the application 7262** creates and populates an instance of this structure to pass 7263** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 7264** Additionally, an instance of this structure can be used as an 7265** output variable when querying the system for the current mutex 7266** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 7267** 7268** ^The xMutexInit method defined by this structure is invoked as 7269** part of system initialization by the sqlite3_initialize() function. 7270** ^The xMutexInit routine is called by SQLite exactly once for each 7271** effective call to [sqlite3_initialize()]. 7272** 7273** ^The xMutexEnd method defined by this structure is invoked as 7274** part of system shutdown by the sqlite3_shutdown() function. The 7275** implementation of this method is expected to release all outstanding 7276** resources obtained by the mutex methods implementation, especially 7277** those obtained by the xMutexInit method. ^The xMutexEnd() 7278** interface is invoked exactly once for each call to [sqlite3_shutdown()]. 7279** 7280** ^(The remaining seven methods defined by this structure (xMutexAlloc, 7281** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 7282** xMutexNotheld) implement the following interfaces (respectively): 7283** 7284** <ul> 7285** <li> [sqlite3_mutex_alloc()] </li> 7286** <li> [sqlite3_mutex_free()] </li> 7287** <li> [sqlite3_mutex_enter()] </li> 7288** <li> [sqlite3_mutex_try()] </li> 7289** <li> [sqlite3_mutex_leave()] </li> 7290** <li> [sqlite3_mutex_held()] </li> 7291** <li> [sqlite3_mutex_notheld()] </li> 7292** </ul>)^ 7293** 7294** The only difference is that the public sqlite3_XXX functions enumerated 7295** above silently ignore any invocations that pass a NULL pointer instead 7296** of a valid mutex handle. The implementations of the methods defined 7297** by this structure are not required to handle this case. The results 7298** of passing a NULL pointer instead of a valid mutex handle are undefined 7299** (i.e. it is acceptable to provide an implementation that segfaults if 7300** it is passed a NULL pointer). 7301** 7302** The xMutexInit() method must be threadsafe. It must be harmless to 7303** invoke xMutexInit() multiple times within the same process and without 7304** intervening calls to xMutexEnd(). Second and subsequent calls to 7305** xMutexInit() must be no-ops. 7306** 7307** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] 7308** and its associates). Similarly, xMutexAlloc() must not use SQLite memory 7309** allocation for a static mutex. ^However xMutexAlloc() may use SQLite 7310** memory allocation for a fast or recursive mutex. 7311** 7312** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is 7313** called, but only if the prior call to xMutexInit returned SQLITE_OK. 7314** If xMutexInit fails in any way, it is expected to clean up after itself 7315** prior to returning. 7316*/ 7317typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 7318struct sqlite3_mutex_methods { 7319 int (*xMutexInit)(void); 7320 int (*xMutexEnd)(void); 7321 sqlite3_mutex *(*xMutexAlloc)(int); 7322 void (*xMutexFree)(sqlite3_mutex *); 7323 void (*xMutexEnter)(sqlite3_mutex *); 7324 int (*xMutexTry)(sqlite3_mutex *); 7325 void (*xMutexLeave)(sqlite3_mutex *); 7326 int (*xMutexHeld)(sqlite3_mutex *); 7327 int (*xMutexNotheld)(sqlite3_mutex *); 7328}; 7329 7330/* 7331** CAPI3REF: Mutex Verification Routines 7332** 7333** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 7334** are intended for use inside assert() statements. The SQLite core 7335** never uses these routines except inside an assert() and applications 7336** are advised to follow the lead of the core. The SQLite core only 7337** provides implementations for these routines when it is compiled 7338** with the SQLITE_DEBUG flag. External mutex implementations 7339** are only required to provide these routines if SQLITE_DEBUG is 7340** defined and if NDEBUG is not defined. 7341** 7342** These routines should return true if the mutex in their argument 7343** is held or not held, respectively, by the calling thread. 7344** 7345** The implementation is not required to provide versions of these 7346** routines that actually work. If the implementation does not provide working 7347** versions of these routines, it should at least provide stubs that always 7348** return true so that one does not get spurious assertion failures. 7349** 7350** If the argument to sqlite3_mutex_held() is a NULL pointer then 7351** the routine should return 1. This seems counter-intuitive since 7352** clearly the mutex cannot be held if it does not exist. But 7353** the reason the mutex does not exist is because the build is not 7354** using mutexes. And we do not want the assert() containing the 7355** call to sqlite3_mutex_held() to fail, so a non-zero return is 7356** the appropriate thing to do. The sqlite3_mutex_notheld() 7357** interface should also return 1 when given a NULL pointer. 7358*/ 7359#ifndef NDEBUG 7360int sqlite3_mutex_held(sqlite3_mutex*); 7361int sqlite3_mutex_notheld(sqlite3_mutex*); 7362#endif 7363 7364/* 7365** CAPI3REF: Mutex Types 7366** 7367** The [sqlite3_mutex_alloc()] interface takes a single argument 7368** which is one of these integer constants. 7369** 7370** The set of static mutexes may change from one SQLite release to the 7371** next. Applications that override the built-in mutex logic must be 7372** prepared to accommodate additional static mutexes. 7373*/ 7374#define SQLITE_MUTEX_FAST 0 7375#define SQLITE_MUTEX_RECURSIVE 1 7376#define SQLITE_MUTEX_STATIC_MASTER 2 7377#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 7378#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 7379#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 7380#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */ 7381#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 7382#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ 7383#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ 7384#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */ 7385#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */ 7386#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */ 7387#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */ 7388#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */ 7389#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */ 7390 7391/* 7392** CAPI3REF: Retrieve the mutex for a database connection 7393** METHOD: sqlite3 7394** 7395** ^This interface returns a pointer the [sqlite3_mutex] object that 7396** serializes access to the [database connection] given in the argument 7397** when the [threading mode] is Serialized. 7398** ^If the [threading mode] is Single-thread or Multi-thread then this 7399** routine returns a NULL pointer. 7400*/ 7401sqlite3_mutex *sqlite3_db_mutex(sqlite3*); 7402 7403/* 7404** CAPI3REF: Low-Level Control Of Database Files 7405** METHOD: sqlite3 7406** KEYWORDS: {file control} 7407** 7408** ^The [sqlite3_file_control()] interface makes a direct call to the 7409** xFileControl method for the [sqlite3_io_methods] object associated 7410** with a particular database identified by the second argument. ^The 7411** name of the database is "main" for the main database or "temp" for the 7412** TEMP database, or the name that appears after the AS keyword for 7413** databases that are added using the [ATTACH] SQL command. 7414** ^A NULL pointer can be used in place of "main" to refer to the 7415** main database file. 7416** ^The third and fourth parameters to this routine 7417** are passed directly through to the second and third parameters of 7418** the xFileControl method. ^The return value of the xFileControl 7419** method becomes the return value of this routine. 7420** 7421** A few opcodes for [sqlite3_file_control()] are handled directly 7422** by the SQLite core and never invoke the 7423** sqlite3_io_methods.xFileControl method. 7424** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes 7425** a pointer to the underlying [sqlite3_file] object to be written into 7426** the space pointed to by the 4th parameter. The 7427** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns 7428** the [sqlite3_file] object associated with the journal file instead of 7429** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns 7430** a pointer to the underlying [sqlite3_vfs] object for the file. 7431** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter 7432** from the pager. 7433** 7434** ^If the second parameter (zDbName) does not match the name of any 7435** open database file, then SQLITE_ERROR is returned. ^This error 7436** code is not remembered and will not be recalled by [sqlite3_errcode()] 7437** or [sqlite3_errmsg()]. The underlying xFileControl method might 7438** also return SQLITE_ERROR. There is no way to distinguish between 7439** an incorrect zDbName and an SQLITE_ERROR return from the underlying 7440** xFileControl method. 7441** 7442** See also: [file control opcodes] 7443*/ 7444int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); 7445 7446/* 7447** CAPI3REF: Testing Interface 7448** 7449** ^The sqlite3_test_control() interface is used to read out internal 7450** state of SQLite and to inject faults into SQLite for testing 7451** purposes. ^The first parameter is an operation code that determines 7452** the number, meaning, and operation of all subsequent parameters. 7453** 7454** This interface is not for use by applications. It exists solely 7455** for verifying the correct operation of the SQLite library. Depending 7456** on how the SQLite library is compiled, this interface might not exist. 7457** 7458** The details of the operation codes, their meanings, the parameters 7459** they take, and what they do are all subject to change without notice. 7460** Unlike most of the SQLite API, this function is not guaranteed to 7461** operate consistently from one release to the next. 7462*/ 7463int sqlite3_test_control(int op, ...); 7464 7465/* 7466** CAPI3REF: Testing Interface Operation Codes 7467** 7468** These constants are the valid operation code parameters used 7469** as the first argument to [sqlite3_test_control()]. 7470** 7471** These parameters and their meanings are subject to change 7472** without notice. These values are for testing purposes only. 7473** Applications should not use any of these parameters or the 7474** [sqlite3_test_control()] interface. 7475*/ 7476#define SQLITE_TESTCTRL_FIRST 5 7477#define SQLITE_TESTCTRL_PRNG_SAVE 5 7478#define SQLITE_TESTCTRL_PRNG_RESTORE 6 7479#define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */ 7480#define SQLITE_TESTCTRL_BITVEC_TEST 8 7481#define SQLITE_TESTCTRL_FAULT_INSTALL 9 7482#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 7483#define SQLITE_TESTCTRL_PENDING_BYTE 11 7484#define SQLITE_TESTCTRL_ASSERT 12 7485#define SQLITE_TESTCTRL_ALWAYS 13 7486#define SQLITE_TESTCTRL_RESERVE 14 7487#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 7488#define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */ 7489#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */ 7490#define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17 7491#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 7492#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */ 7493#define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19 7494#define SQLITE_TESTCTRL_NEVER_CORRUPT 20 7495#define SQLITE_TESTCTRL_VDBE_COVERAGE 21 7496#define SQLITE_TESTCTRL_BYTEORDER 22 7497#define SQLITE_TESTCTRL_ISINIT 23 7498#define SQLITE_TESTCTRL_SORTER_MMAP 24 7499#define SQLITE_TESTCTRL_IMPOSTER 25 7500#define SQLITE_TESTCTRL_PARSER_COVERAGE 26 7501#define SQLITE_TESTCTRL_RESULT_INTREAL 27 7502#define SQLITE_TESTCTRL_PRNG_SEED 28 7503#define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29 7504#define SQLITE_TESTCTRL_LAST 29 /* Largest TESTCTRL */ 7505 7506/* 7507** CAPI3REF: SQL Keyword Checking 7508** 7509** These routines provide access to the set of SQL language keywords 7510** recognized by SQLite. Applications can uses these routines to determine 7511** whether or not a specific identifier needs to be escaped (for example, 7512** by enclosing in double-quotes) so as not to confuse the parser. 7513** 7514** The sqlite3_keyword_count() interface returns the number of distinct 7515** keywords understood by SQLite. 7516** 7517** The sqlite3_keyword_name(N,Z,L) interface finds the N-th keyword and 7518** makes *Z point to that keyword expressed as UTF8 and writes the number 7519** of bytes in the keyword into *L. The string that *Z points to is not 7520** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns 7521** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z 7522** or L are NULL or invalid pointers then calls to 7523** sqlite3_keyword_name(N,Z,L) result in undefined behavior. 7524** 7525** The sqlite3_keyword_check(Z,L) interface checks to see whether or not 7526** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero 7527** if it is and zero if not. 7528** 7529** The parser used by SQLite is forgiving. It is often possible to use 7530** a keyword as an identifier as long as such use does not result in a 7531** parsing ambiguity. For example, the statement 7532** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and 7533** creates a new table named "BEGIN" with three columns named 7534** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid 7535** using keywords as identifiers. Common techniques used to avoid keyword 7536** name collisions include: 7537** <ul> 7538** <li> Put all identifier names inside double-quotes. This is the official 7539** SQL way to escape identifier names. 7540** <li> Put identifier names inside [...]. This is not standard SQL, 7541** but it is what SQL Server does and so lots of programmers use this 7542** technique. 7543** <li> Begin every identifier with the letter "Z" as no SQL keywords start 7544** with "Z". 7545** <li> Include a digit somewhere in every identifier name. 7546** </ul> 7547** 7548** Note that the number of keywords understood by SQLite can depend on 7549** compile-time options. For example, "VACUUM" is not a keyword if 7550** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also, 7551** new keywords may be added to future releases of SQLite. 7552*/ 7553int sqlite3_keyword_count(void); 7554int sqlite3_keyword_name(int,const char**,int*); 7555int sqlite3_keyword_check(const char*,int); 7556 7557/* 7558** CAPI3REF: Dynamic String Object 7559** KEYWORDS: {dynamic string} 7560** 7561** An instance of the sqlite3_str object contains a dynamically-sized 7562** string under construction. 7563** 7564** The lifecycle of an sqlite3_str object is as follows: 7565** <ol> 7566** <li> ^The sqlite3_str object is created using [sqlite3_str_new()]. 7567** <li> ^Text is appended to the sqlite3_str object using various 7568** methods, such as [sqlite3_str_appendf()]. 7569** <li> ^The sqlite3_str object is destroyed and the string it created 7570** is returned using the [sqlite3_str_finish()] interface. 7571** </ol> 7572*/ 7573typedef struct sqlite3_str sqlite3_str; 7574 7575/* 7576** CAPI3REF: Create A New Dynamic String Object 7577** CONSTRUCTOR: sqlite3_str 7578** 7579** ^The [sqlite3_str_new(D)] interface allocates and initializes 7580** a new [sqlite3_str] object. To avoid memory leaks, the object returned by 7581** [sqlite3_str_new()] must be freed by a subsequent call to 7582** [sqlite3_str_finish(X)]. 7583** 7584** ^The [sqlite3_str_new(D)] interface always returns a pointer to a 7585** valid [sqlite3_str] object, though in the event of an out-of-memory 7586** error the returned object might be a special singleton that will 7587** silently reject new text, always return SQLITE_NOMEM from 7588** [sqlite3_str_errcode()], always return 0 for 7589** [sqlite3_str_length()], and always return NULL from 7590** [sqlite3_str_finish(X)]. It is always safe to use the value 7591** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter 7592** to any of the other [sqlite3_str] methods. 7593** 7594** The D parameter to [sqlite3_str_new(D)] may be NULL. If the 7595** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum 7596** length of the string contained in the [sqlite3_str] object will be 7597** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead 7598** of [SQLITE_MAX_LENGTH]. 7599*/ 7600sqlite3_str *sqlite3_str_new(sqlite3*); 7601 7602/* 7603** CAPI3REF: Finalize A Dynamic String 7604** DESTRUCTOR: sqlite3_str 7605** 7606** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X 7607** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()] 7608** that contains the constructed string. The calling application should 7609** pass the returned value to [sqlite3_free()] to avoid a memory leak. 7610** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any 7611** errors were encountered during construction of the string. ^The 7612** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the 7613** string in [sqlite3_str] object X is zero bytes long. 7614*/ 7615char *sqlite3_str_finish(sqlite3_str*); 7616 7617/* 7618** CAPI3REF: Add Content To A Dynamic String 7619** METHOD: sqlite3_str 7620** 7621** These interfaces add content to an sqlite3_str object previously obtained 7622** from [sqlite3_str_new()]. 7623** 7624** ^The [sqlite3_str_appendf(X,F,...)] and 7625** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf] 7626** functionality of SQLite to append formatted text onto the end of 7627** [sqlite3_str] object X. 7628** 7629** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S 7630** onto the end of the [sqlite3_str] object X. N must be non-negative. 7631** S must contain at least N non-zero bytes of content. To append a 7632** zero-terminated string in its entirety, use the [sqlite3_str_appendall()] 7633** method instead. 7634** 7635** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of 7636** zero-terminated string S onto the end of [sqlite3_str] object X. 7637** 7638** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the 7639** single-byte character C onto the end of [sqlite3_str] object X. 7640** ^This method can be used, for example, to add whitespace indentation. 7641** 7642** ^The [sqlite3_str_reset(X)] method resets the string under construction 7643** inside [sqlite3_str] object X back to zero bytes in length. 7644** 7645** These methods do not return a result code. ^If an error occurs, that fact 7646** is recorded in the [sqlite3_str] object and can be recovered by a 7647** subsequent call to [sqlite3_str_errcode(X)]. 7648*/ 7649void sqlite3_str_appendf(sqlite3_str*, const char *zFormat, ...); 7650void sqlite3_str_vappendf(sqlite3_str*, const char *zFormat, va_list); 7651void sqlite3_str_append(sqlite3_str*, const char *zIn, int N); 7652void sqlite3_str_appendall(sqlite3_str*, const char *zIn); 7653void sqlite3_str_appendchar(sqlite3_str*, int N, char C); 7654void sqlite3_str_reset(sqlite3_str*); 7655 7656/* 7657** CAPI3REF: Status Of A Dynamic String 7658** METHOD: sqlite3_str 7659** 7660** These interfaces return the current status of an [sqlite3_str] object. 7661** 7662** ^If any prior errors have occurred while constructing the dynamic string 7663** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return 7664** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns 7665** [SQLITE_NOMEM] following any out-of-memory error, or 7666** [SQLITE_TOOBIG] if the size of the dynamic string exceeds 7667** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors. 7668** 7669** ^The [sqlite3_str_length(X)] method returns the current length, in bytes, 7670** of the dynamic string under construction in [sqlite3_str] object X. 7671** ^The length returned by [sqlite3_str_length(X)] does not include the 7672** zero-termination byte. 7673** 7674** ^The [sqlite3_str_value(X)] method returns a pointer to the current 7675** content of the dynamic string under construction in X. The value 7676** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X 7677** and might be freed or altered by any subsequent method on the same 7678** [sqlite3_str] object. Applications must not used the pointer returned 7679** [sqlite3_str_value(X)] after any subsequent method call on the same 7680** object. ^Applications may change the content of the string returned 7681** by [sqlite3_str_value(X)] as long as they do not write into any bytes 7682** outside the range of 0 to [sqlite3_str_length(X)] and do not read or 7683** write any byte after any subsequent sqlite3_str method call. 7684*/ 7685int sqlite3_str_errcode(sqlite3_str*); 7686int sqlite3_str_length(sqlite3_str*); 7687char *sqlite3_str_value(sqlite3_str*); 7688 7689/* 7690** CAPI3REF: SQLite Runtime Status 7691** 7692** ^These interfaces are used to retrieve runtime status information 7693** about the performance of SQLite, and optionally to reset various 7694** highwater marks. ^The first argument is an integer code for 7695** the specific parameter to measure. ^(Recognized integer codes 7696** are of the form [status parameters | SQLITE_STATUS_...].)^ 7697** ^The current value of the parameter is returned into *pCurrent. 7698** ^The highest recorded value is returned in *pHighwater. ^If the 7699** resetFlag is true, then the highest record value is reset after 7700** *pHighwater is written. ^(Some parameters do not record the highest 7701** value. For those parameters 7702** nothing is written into *pHighwater and the resetFlag is ignored.)^ 7703** ^(Other parameters record only the highwater mark and not the current 7704** value. For these latter parameters nothing is written into *pCurrent.)^ 7705** 7706** ^The sqlite3_status() and sqlite3_status64() routines return 7707** SQLITE_OK on success and a non-zero [error code] on failure. 7708** 7709** If either the current value or the highwater mark is too large to 7710** be represented by a 32-bit integer, then the values returned by 7711** sqlite3_status() are undefined. 7712** 7713** See also: [sqlite3_db_status()] 7714*/ 7715int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 7716int sqlite3_status64( 7717 int op, 7718 sqlite3_int64 *pCurrent, 7719 sqlite3_int64 *pHighwater, 7720 int resetFlag 7721); 7722 7723 7724/* 7725** CAPI3REF: Status Parameters 7726** KEYWORDS: {status parameters} 7727** 7728** These integer constants designate various run-time status parameters 7729** that can be returned by [sqlite3_status()]. 7730** 7731** <dl> 7732** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> 7733** <dd>This parameter is the current amount of memory checked out 7734** using [sqlite3_malloc()], either directly or indirectly. The 7735** figure includes calls made to [sqlite3_malloc()] by the application 7736** and internal memory usage by the SQLite library. Auxiliary page-cache 7737** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 7738** this parameter. The amount returned is the sum of the allocation 7739** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ 7740** 7741** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> 7742** <dd>This parameter records the largest memory allocation request 7743** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 7744** internal equivalents). Only the value returned in the 7745** *pHighwater parameter to [sqlite3_status()] is of interest. 7746** The value written into the *pCurrent parameter is undefined.</dd>)^ 7747** 7748** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> 7749** <dd>This parameter records the number of separate memory allocations 7750** currently checked out.</dd>)^ 7751** 7752** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> 7753** <dd>This parameter returns the number of pages used out of the 7754** [pagecache memory allocator] that was configured using 7755** [SQLITE_CONFIG_PAGECACHE]. The 7756** value returned is in pages, not in bytes.</dd>)^ 7757** 7758** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] 7759** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 7760** <dd>This parameter returns the number of bytes of page cache 7761** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] 7762** buffer and where forced to overflow to [sqlite3_malloc()]. The 7763** returned value includes allocations that overflowed because they 7764** where too large (they were larger than the "sz" parameter to 7765** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 7766** no space was left in the page cache.</dd>)^ 7767** 7768** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 7769** <dd>This parameter records the largest memory allocation request 7770** handed to the [pagecache memory allocator]. Only the value returned in the 7771** *pHighwater parameter to [sqlite3_status()] is of interest. 7772** The value written into the *pCurrent parameter is undefined.</dd>)^ 7773** 7774** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt> 7775** <dd>No longer used.</dd> 7776** 7777** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 7778** <dd>No longer used.</dd> 7779** 7780** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 7781** <dd>No longer used.</dd> 7782** 7783** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> 7784** <dd>The *pHighwater parameter records the deepest parser stack. 7785** The *pCurrent value is undefined. The *pHighwater value is only 7786** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ 7787** </dl> 7788** 7789** New status parameters may be added from time to time. 7790*/ 7791#define SQLITE_STATUS_MEMORY_USED 0 7792#define SQLITE_STATUS_PAGECACHE_USED 1 7793#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 7794#define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */ 7795#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */ 7796#define SQLITE_STATUS_MALLOC_SIZE 5 7797#define SQLITE_STATUS_PARSER_STACK 6 7798#define SQLITE_STATUS_PAGECACHE_SIZE 7 7799#define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */ 7800#define SQLITE_STATUS_MALLOC_COUNT 9 7801 7802/* 7803** CAPI3REF: Database Connection Status 7804** METHOD: sqlite3 7805** 7806** ^This interface is used to retrieve runtime status information 7807** about a single [database connection]. ^The first argument is the 7808** database connection object to be interrogated. ^The second argument 7809** is an integer constant, taken from the set of 7810** [SQLITE_DBSTATUS options], that 7811** determines the parameter to interrogate. The set of 7812** [SQLITE_DBSTATUS options] is likely 7813** to grow in future releases of SQLite. 7814** 7815** ^The current value of the requested parameter is written into *pCur 7816** and the highest instantaneous value is written into *pHiwtr. ^If 7817** the resetFlg is true, then the highest instantaneous value is 7818** reset back down to the current value. 7819** 7820** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a 7821** non-zero [error code] on failure. 7822** 7823** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 7824*/ 7825int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 7826 7827/* 7828** CAPI3REF: Status Parameters for database connections 7829** KEYWORDS: {SQLITE_DBSTATUS options} 7830** 7831** These constants are the available integer "verbs" that can be passed as 7832** the second argument to the [sqlite3_db_status()] interface. 7833** 7834** New verbs may be added in future releases of SQLite. Existing verbs 7835** might be discontinued. Applications should check the return code from 7836** [sqlite3_db_status()] to make sure that the call worked. 7837** The [sqlite3_db_status()] interface will return a non-zero error code 7838** if a discontinued or unsupported verb is invoked. 7839** 7840** <dl> 7841** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 7842** <dd>This parameter returns the number of lookaside memory slots currently 7843** checked out.</dd>)^ 7844** 7845** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> 7846** <dd>This parameter returns the number of malloc attempts that were 7847** satisfied using lookaside memory. Only the high-water value is meaningful; 7848** the current value is always zero.)^ 7849** 7850** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] 7851** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> 7852** <dd>This parameter returns the number malloc attempts that might have 7853** been satisfied using lookaside memory but failed due to the amount of 7854** memory requested being larger than the lookaside slot size. 7855** Only the high-water value is meaningful; 7856** the current value is always zero.)^ 7857** 7858** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] 7859** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> 7860** <dd>This parameter returns the number malloc attempts that might have 7861** been satisfied using lookaside memory but failed due to all lookaside 7862** memory already being in use. 7863** Only the high-water value is meaningful; 7864** the current value is always zero.)^ 7865** 7866** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> 7867** <dd>This parameter returns the approximate number of bytes of heap 7868** memory used by all pager caches associated with the database connection.)^ 7869** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. 7870** 7871** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]] 7872** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt> 7873** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a 7874** pager cache is shared between two or more connections the bytes of heap 7875** memory used by that pager cache is divided evenly between the attached 7876** connections.)^ In other words, if none of the pager caches associated 7877** with the database connection are shared, this request returns the same 7878** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are 7879** shared, the value returned by this call will be smaller than that returned 7880** by DBSTATUS_CACHE_USED. ^The highwater mark associated with 7881** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. 7882** 7883** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> 7884** <dd>This parameter returns the approximate number of bytes of heap 7885** memory used to store the schema for all databases associated 7886** with the connection - main, temp, and any [ATTACH]-ed databases.)^ 7887** ^The full amount of memory used by the schemas is reported, even if the 7888** schema memory is shared with other database connections due to 7889** [shared cache mode] being enabled. 7890** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. 7891** 7892** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> 7893** <dd>This parameter returns the approximate number of bytes of heap 7894** and lookaside memory used by all prepared statements associated with 7895** the database connection.)^ 7896** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. 7897** </dd> 7898** 7899** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> 7900** <dd>This parameter returns the number of pager cache hits that have 7901** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT 7902** is always 0. 7903** </dd> 7904** 7905** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> 7906** <dd>This parameter returns the number of pager cache misses that have 7907** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS 7908** is always 0. 7909** </dd> 7910** 7911** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt> 7912** <dd>This parameter returns the number of dirty cache entries that have 7913** been written to disk. Specifically, the number of pages written to the 7914** wal file in wal mode databases, or the number of pages written to the 7915** database file in rollback mode databases. Any pages written as part of 7916** transaction rollback or database recovery operations are not included. 7917** If an IO or other error occurs while writing a page to disk, the effect 7918** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The 7919** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. 7920** </dd> 7921** 7922** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt> 7923** <dd>This parameter returns the number of dirty cache entries that have 7924** been written to disk in the middle of a transaction due to the page 7925** cache overflowing. Transactions are more efficient if they are written 7926** to disk all at once. When pages spill mid-transaction, that introduces 7927** additional overhead. This parameter can be used help identify 7928** inefficiencies that can be resolved by increasing the cache size. 7929** </dd> 7930** 7931** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt> 7932** <dd>This parameter returns zero for the current value if and only if 7933** all foreign key constraints (deferred or immediate) have been 7934** resolved.)^ ^The highwater mark is always 0. 7935** </dd> 7936** </dl> 7937*/ 7938#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 7939#define SQLITE_DBSTATUS_CACHE_USED 1 7940#define SQLITE_DBSTATUS_SCHEMA_USED 2 7941#define SQLITE_DBSTATUS_STMT_USED 3 7942#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 7943#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 7944#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 7945#define SQLITE_DBSTATUS_CACHE_HIT 7 7946#define SQLITE_DBSTATUS_CACHE_MISS 8 7947#define SQLITE_DBSTATUS_CACHE_WRITE 9 7948#define SQLITE_DBSTATUS_DEFERRED_FKS 10 7949#define SQLITE_DBSTATUS_CACHE_USED_SHARED 11 7950#define SQLITE_DBSTATUS_CACHE_SPILL 12 7951#define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */ 7952 7953 7954/* 7955** CAPI3REF: Prepared Statement Status 7956** METHOD: sqlite3_stmt 7957** 7958** ^(Each prepared statement maintains various 7959** [SQLITE_STMTSTATUS counters] that measure the number 7960** of times it has performed specific operations.)^ These counters can 7961** be used to monitor the performance characteristics of the prepared 7962** statements. For example, if the number of table steps greatly exceeds 7963** the number of table searches or result rows, that would tend to indicate 7964** that the prepared statement is using a full table scan rather than 7965** an index. 7966** 7967** ^(This interface is used to retrieve and reset counter values from 7968** a [prepared statement]. The first argument is the prepared statement 7969** object to be interrogated. The second argument 7970** is an integer code for a specific [SQLITE_STMTSTATUS counter] 7971** to be interrogated.)^ 7972** ^The current value of the requested counter is returned. 7973** ^If the resetFlg is true, then the counter is reset to zero after this 7974** interface call returns. 7975** 7976** See also: [sqlite3_status()] and [sqlite3_db_status()]. 7977*/ 7978int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 7979 7980/* 7981** CAPI3REF: Status Parameters for prepared statements 7982** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} 7983** 7984** These preprocessor macros define integer codes that name counter 7985** values associated with the [sqlite3_stmt_status()] interface. 7986** The meanings of the various counters are as follows: 7987** 7988** <dl> 7989** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 7990** <dd>^This is the number of times that SQLite has stepped forward in 7991** a table as part of a full table scan. Large numbers for this counter 7992** may indicate opportunities for performance improvement through 7993** careful use of indices.</dd> 7994** 7995** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> 7996** <dd>^This is the number of sort operations that have occurred. 7997** A non-zero value in this counter may indicate an opportunity to 7998** improvement performance through careful use of indices.</dd> 7999** 8000** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> 8001** <dd>^This is the number of rows inserted into transient indices that 8002** were created automatically in order to help joins run faster. 8003** A non-zero value in this counter may indicate an opportunity to 8004** improvement performance by adding permanent indices that do not 8005** need to be reinitialized each time the statement is run.</dd> 8006** 8007** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt> 8008** <dd>^This is the number of virtual machine operations executed 8009** by the prepared statement if that number is less than or equal 8010** to 2147483647. The number of virtual machine operations can be 8011** used as a proxy for the total work done by the prepared statement. 8012** If the number of virtual machine operations exceeds 2147483647 8013** then the value returned by this statement status code is undefined. 8014** 8015** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt> 8016** <dd>^This is the number of times that the prepare statement has been 8017** automatically regenerated due to schema changes or changes to 8018** [bound parameters] that might affect the query plan. 8019** 8020** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt> 8021** <dd>^This is the number of times that the prepared statement has 8022** been run. A single "run" for the purposes of this counter is one 8023** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()]. 8024** The counter is incremented on the first [sqlite3_step()] call of each 8025** cycle. 8026** 8027** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt> 8028** <dd>^This is the approximate number of bytes of heap memory 8029** used to store the prepared statement. ^This value is not actually 8030** a counter, and so the resetFlg parameter to sqlite3_stmt_status() 8031** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED. 8032** </dd> 8033** </dl> 8034*/ 8035#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 8036#define SQLITE_STMTSTATUS_SORT 2 8037#define SQLITE_STMTSTATUS_AUTOINDEX 3 8038#define SQLITE_STMTSTATUS_VM_STEP 4 8039#define SQLITE_STMTSTATUS_REPREPARE 5 8040#define SQLITE_STMTSTATUS_RUN 6 8041#define SQLITE_STMTSTATUS_MEMUSED 99 8042 8043/* 8044** CAPI3REF: Custom Page Cache Object 8045** 8046** The sqlite3_pcache type is opaque. It is implemented by 8047** the pluggable module. The SQLite core has no knowledge of 8048** its size or internal structure and never deals with the 8049** sqlite3_pcache object except by holding and passing pointers 8050** to the object. 8051** 8052** See [sqlite3_pcache_methods2] for additional information. 8053*/ 8054typedef struct sqlite3_pcache sqlite3_pcache; 8055 8056/* 8057** CAPI3REF: Custom Page Cache Object 8058** 8059** The sqlite3_pcache_page object represents a single page in the 8060** page cache. The page cache will allocate instances of this 8061** object. Various methods of the page cache use pointers to instances 8062** of this object as parameters or as their return value. 8063** 8064** See [sqlite3_pcache_methods2] for additional information. 8065*/ 8066typedef struct sqlite3_pcache_page sqlite3_pcache_page; 8067struct sqlite3_pcache_page { 8068 void *pBuf; /* The content of the page */ 8069 void *pExtra; /* Extra information associated with the page */ 8070}; 8071 8072/* 8073** CAPI3REF: Application Defined Page Cache. 8074** KEYWORDS: {page cache} 8075** 8076** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can 8077** register an alternative page cache implementation by passing in an 8078** instance of the sqlite3_pcache_methods2 structure.)^ 8079** In many applications, most of the heap memory allocated by 8080** SQLite is used for the page cache. 8081** By implementing a 8082** custom page cache using this API, an application can better control 8083** the amount of memory consumed by SQLite, the way in which 8084** that memory is allocated and released, and the policies used to 8085** determine exactly which parts of a database file are cached and for 8086** how long. 8087** 8088** The alternative page cache mechanism is an 8089** extreme measure that is only needed by the most demanding applications. 8090** The built-in page cache is recommended for most uses. 8091** 8092** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an 8093** internal buffer by SQLite within the call to [sqlite3_config]. Hence 8094** the application may discard the parameter after the call to 8095** [sqlite3_config()] returns.)^ 8096** 8097** [[the xInit() page cache method]] 8098** ^(The xInit() method is called once for each effective 8099** call to [sqlite3_initialize()])^ 8100** (usually only once during the lifetime of the process). ^(The xInit() 8101** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ 8102** The intent of the xInit() method is to set up global data structures 8103** required by the custom page cache implementation. 8104** ^(If the xInit() method is NULL, then the 8105** built-in default page cache is used instead of the application defined 8106** page cache.)^ 8107** 8108** [[the xShutdown() page cache method]] 8109** ^The xShutdown() method is called by [sqlite3_shutdown()]. 8110** It can be used to clean up 8111** any outstanding resources before process shutdown, if required. 8112** ^The xShutdown() method may be NULL. 8113** 8114** ^SQLite automatically serializes calls to the xInit method, 8115** so the xInit method need not be threadsafe. ^The 8116** xShutdown method is only called from [sqlite3_shutdown()] so it does 8117** not need to be threadsafe either. All other methods must be threadsafe 8118** in multithreaded applications. 8119** 8120** ^SQLite will never invoke xInit() more than once without an intervening 8121** call to xShutdown(). 8122** 8123** [[the xCreate() page cache methods]] 8124** ^SQLite invokes the xCreate() method to construct a new cache instance. 8125** SQLite will typically create one cache instance for each open database file, 8126** though this is not guaranteed. ^The 8127** first parameter, szPage, is the size in bytes of the pages that must 8128** be allocated by the cache. ^szPage will always a power of two. ^The 8129** second parameter szExtra is a number of bytes of extra storage 8130** associated with each page cache entry. ^The szExtra parameter will 8131** a number less than 250. SQLite will use the 8132** extra szExtra bytes on each page to store metadata about the underlying 8133** database page on disk. The value passed into szExtra depends 8134** on the SQLite version, the target platform, and how SQLite was compiled. 8135** ^The third argument to xCreate(), bPurgeable, is true if the cache being 8136** created will be used to cache database pages of a file stored on disk, or 8137** false if it is used for an in-memory database. The cache implementation 8138** does not have to do anything special based with the value of bPurgeable; 8139** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will 8140** never invoke xUnpin() except to deliberately delete a page. 8141** ^In other words, calls to xUnpin() on a cache with bPurgeable set to 8142** false will always have the "discard" flag set to true. 8143** ^Hence, a cache created with bPurgeable false will 8144** never contain any unpinned pages. 8145** 8146** [[the xCachesize() page cache method]] 8147** ^(The xCachesize() method may be called at any time by SQLite to set the 8148** suggested maximum cache-size (number of pages stored by) the cache 8149** instance passed as the first argument. This is the value configured using 8150** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable 8151** parameter, the implementation is not required to do anything with this 8152** value; it is advisory only. 8153** 8154** [[the xPagecount() page cache methods]] 8155** The xPagecount() method must return the number of pages currently 8156** stored in the cache, both pinned and unpinned. 8157** 8158** [[the xFetch() page cache methods]] 8159** The xFetch() method locates a page in the cache and returns a pointer to 8160** an sqlite3_pcache_page object associated with that page, or a NULL pointer. 8161** The pBuf element of the returned sqlite3_pcache_page object will be a 8162** pointer to a buffer of szPage bytes used to store the content of a 8163** single database page. The pExtra element of sqlite3_pcache_page will be 8164** a pointer to the szExtra bytes of extra storage that SQLite has requested 8165** for each entry in the page cache. 8166** 8167** The page to be fetched is determined by the key. ^The minimum key value 8168** is 1. After it has been retrieved using xFetch, the page is considered 8169** to be "pinned". 8170** 8171** If the requested page is already in the page cache, then the page cache 8172** implementation must return a pointer to the page buffer with its content 8173** intact. If the requested page is not already in the cache, then the 8174** cache implementation should use the value of the createFlag 8175** parameter to help it determined what action to take: 8176** 8177** <table border=1 width=85% align=center> 8178** <tr><th> createFlag <th> Behavior when page is not already in cache 8179** <tr><td> 0 <td> Do not allocate a new page. Return NULL. 8180** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. 8181** Otherwise return NULL. 8182** <tr><td> 2 <td> Make every effort to allocate a new page. Only return 8183** NULL if allocating a new page is effectively impossible. 8184** </table> 8185** 8186** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite 8187** will only use a createFlag of 2 after a prior call with a createFlag of 1 8188** failed.)^ In between the xFetch() calls, SQLite may 8189** attempt to unpin one or more cache pages by spilling the content of 8190** pinned pages to disk and synching the operating system disk cache. 8191** 8192** [[the xUnpin() page cache method]] 8193** ^xUnpin() is called by SQLite with a pointer to a currently pinned page 8194** as its second argument. If the third parameter, discard, is non-zero, 8195** then the page must be evicted from the cache. 8196** ^If the discard parameter is 8197** zero, then the page may be discarded or retained at the discretion of 8198** page cache implementation. ^The page cache implementation 8199** may choose to evict unpinned pages at any time. 8200** 8201** The cache must not perform any reference counting. A single 8202** call to xUnpin() unpins the page regardless of the number of prior calls 8203** to xFetch(). 8204** 8205** [[the xRekey() page cache methods]] 8206** The xRekey() method is used to change the key value associated with the 8207** page passed as the second argument. If the cache 8208** previously contains an entry associated with newKey, it must be 8209** discarded. ^Any prior cache entry associated with newKey is guaranteed not 8210** to be pinned. 8211** 8212** When SQLite calls the xTruncate() method, the cache must discard all 8213** existing cache entries with page numbers (keys) greater than or equal 8214** to the value of the iLimit parameter passed to xTruncate(). If any 8215** of these pages are pinned, they are implicitly unpinned, meaning that 8216** they can be safely discarded. 8217** 8218** [[the xDestroy() page cache method]] 8219** ^The xDestroy() method is used to delete a cache allocated by xCreate(). 8220** All resources associated with the specified cache should be freed. ^After 8221** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 8222** handle invalid, and will not use it with any other sqlite3_pcache_methods2 8223** functions. 8224** 8225** [[the xShrink() page cache method]] 8226** ^SQLite invokes the xShrink() method when it wants the page cache to 8227** free up as much of heap memory as possible. The page cache implementation 8228** is not obligated to free any memory, but well-behaved implementations should 8229** do their best. 8230*/ 8231typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2; 8232struct sqlite3_pcache_methods2 { 8233 int iVersion; 8234 void *pArg; 8235 int (*xInit)(void*); 8236 void (*xShutdown)(void*); 8237 sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); 8238 void (*xCachesize)(sqlite3_pcache*, int nCachesize); 8239 int (*xPagecount)(sqlite3_pcache*); 8240 sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 8241 void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); 8242 void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, 8243 unsigned oldKey, unsigned newKey); 8244 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 8245 void (*xDestroy)(sqlite3_pcache*); 8246 void (*xShrink)(sqlite3_pcache*); 8247}; 8248 8249/* 8250** This is the obsolete pcache_methods object that has now been replaced 8251** by sqlite3_pcache_methods2. This object is not used by SQLite. It is 8252** retained in the header file for backwards compatibility only. 8253*/ 8254typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 8255struct sqlite3_pcache_methods { 8256 void *pArg; 8257 int (*xInit)(void*); 8258 void (*xShutdown)(void*); 8259 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 8260 void (*xCachesize)(sqlite3_pcache*, int nCachesize); 8261 int (*xPagecount)(sqlite3_pcache*); 8262 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 8263 void (*xUnpin)(sqlite3_pcache*, void*, int discard); 8264 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 8265 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 8266 void (*xDestroy)(sqlite3_pcache*); 8267}; 8268 8269 8270/* 8271** CAPI3REF: Online Backup Object 8272** 8273** The sqlite3_backup object records state information about an ongoing 8274** online backup operation. ^The sqlite3_backup object is created by 8275** a call to [sqlite3_backup_init()] and is destroyed by a call to 8276** [sqlite3_backup_finish()]. 8277** 8278** See Also: [Using the SQLite Online Backup API] 8279*/ 8280typedef struct sqlite3_backup sqlite3_backup; 8281 8282/* 8283** CAPI3REF: Online Backup API. 8284** 8285** The backup API copies the content of one database into another. 8286** It is useful either for creating backups of databases or 8287** for copying in-memory databases to or from persistent files. 8288** 8289** See Also: [Using the SQLite Online Backup API] 8290** 8291** ^SQLite holds a write transaction open on the destination database file 8292** for the duration of the backup operation. 8293** ^The source database is read-locked only while it is being read; 8294** it is not locked continuously for the entire backup operation. 8295** ^Thus, the backup may be performed on a live source database without 8296** preventing other database connections from 8297** reading or writing to the source database while the backup is underway. 8298** 8299** ^(To perform a backup operation: 8300** <ol> 8301** <li><b>sqlite3_backup_init()</b> is called once to initialize the 8302** backup, 8303** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 8304** the data between the two databases, and finally 8305** <li><b>sqlite3_backup_finish()</b> is called to release all resources 8306** associated with the backup operation. 8307** </ol>)^ 8308** There should be exactly one call to sqlite3_backup_finish() for each 8309** successful call to sqlite3_backup_init(). 8310** 8311** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> 8312** 8313** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the 8314** [database connection] associated with the destination database 8315** and the database name, respectively. 8316** ^The database name is "main" for the main database, "temp" for the 8317** temporary database, or the name specified after the AS keyword in 8318** an [ATTACH] statement for an attached database. 8319** ^The S and M arguments passed to 8320** sqlite3_backup_init(D,N,S,M) identify the [database connection] 8321** and database name of the source database, respectively. 8322** ^The source and destination [database connections] (parameters S and D) 8323** must be different or else sqlite3_backup_init(D,N,S,M) will fail with 8324** an error. 8325** 8326** ^A call to sqlite3_backup_init() will fail, returning NULL, if 8327** there is already a read or read-write transaction open on the 8328** destination database. 8329** 8330** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is 8331** returned and an error code and error message are stored in the 8332** destination [database connection] D. 8333** ^The error code and message for the failed call to sqlite3_backup_init() 8334** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or 8335** [sqlite3_errmsg16()] functions. 8336** ^A successful call to sqlite3_backup_init() returns a pointer to an 8337** [sqlite3_backup] object. 8338** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and 8339** sqlite3_backup_finish() functions to perform the specified backup 8340** operation. 8341** 8342** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> 8343** 8344** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 8345** the source and destination databases specified by [sqlite3_backup] object B. 8346** ^If N is negative, all remaining source pages are copied. 8347** ^If sqlite3_backup_step(B,N) successfully copies N pages and there 8348** are still more pages to be copied, then the function returns [SQLITE_OK]. 8349** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages 8350** from source to destination, then it returns [SQLITE_DONE]. 8351** ^If an error occurs while running sqlite3_backup_step(B,N), 8352** then an [error code] is returned. ^As well as [SQLITE_OK] and 8353** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], 8354** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an 8355** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. 8356** 8357** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if 8358** <ol> 8359** <li> the destination database was opened read-only, or 8360** <li> the destination database is using write-ahead-log journaling 8361** and the destination and source page sizes differ, or 8362** <li> the destination database is an in-memory database and the 8363** destination and source page sizes differ. 8364** </ol>)^ 8365** 8366** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then 8367** the [sqlite3_busy_handler | busy-handler function] 8368** is invoked (if one is specified). ^If the 8369** busy-handler returns non-zero before the lock is available, then 8370** [SQLITE_BUSY] is returned to the caller. ^In this case the call to 8371** sqlite3_backup_step() can be retried later. ^If the source 8372** [database connection] 8373** is being used to write to the source database when sqlite3_backup_step() 8374** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this 8375** case the call to sqlite3_backup_step() can be retried later on. ^(If 8376** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or 8377** [SQLITE_READONLY] is returned, then 8378** there is no point in retrying the call to sqlite3_backup_step(). These 8379** errors are considered fatal.)^ The application must accept 8380** that the backup operation has failed and pass the backup operation handle 8381** to the sqlite3_backup_finish() to release associated resources. 8382** 8383** ^The first call to sqlite3_backup_step() obtains an exclusive lock 8384** on the destination file. ^The exclusive lock is not released until either 8385** sqlite3_backup_finish() is called or the backup operation is complete 8386** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to 8387** sqlite3_backup_step() obtains a [shared lock] on the source database that 8388** lasts for the duration of the sqlite3_backup_step() call. 8389** ^Because the source database is not locked between calls to 8390** sqlite3_backup_step(), the source database may be modified mid-way 8391** through the backup process. ^If the source database is modified by an 8392** external process or via a database connection other than the one being 8393** used by the backup operation, then the backup will be automatically 8394** restarted by the next call to sqlite3_backup_step(). ^If the source 8395** database is modified by the using the same database connection as is used 8396** by the backup operation, then the backup database is automatically 8397** updated at the same time. 8398** 8399** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> 8400** 8401** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the 8402** application wishes to abandon the backup operation, the application 8403** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). 8404** ^The sqlite3_backup_finish() interfaces releases all 8405** resources associated with the [sqlite3_backup] object. 8406** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any 8407** active write-transaction on the destination database is rolled back. 8408** The [sqlite3_backup] object is invalid 8409** and may not be used following a call to sqlite3_backup_finish(). 8410** 8411** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no 8412** sqlite3_backup_step() errors occurred, regardless or whether or not 8413** sqlite3_backup_step() completed. 8414** ^If an out-of-memory condition or IO error occurred during any prior 8415** sqlite3_backup_step() call on the same [sqlite3_backup] object, then 8416** sqlite3_backup_finish() returns the corresponding [error code]. 8417** 8418** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() 8419** is not a permanent error and does not affect the return value of 8420** sqlite3_backup_finish(). 8421** 8422** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]] 8423** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> 8424** 8425** ^The sqlite3_backup_remaining() routine returns the number of pages still 8426** to be backed up at the conclusion of the most recent sqlite3_backup_step(). 8427** ^The sqlite3_backup_pagecount() routine returns the total number of pages 8428** in the source database at the conclusion of the most recent 8429** sqlite3_backup_step(). 8430** ^(The values returned by these functions are only updated by 8431** sqlite3_backup_step(). If the source database is modified in a way that 8432** changes the size of the source database or the number of pages remaining, 8433** those changes are not reflected in the output of sqlite3_backup_pagecount() 8434** and sqlite3_backup_remaining() until after the next 8435** sqlite3_backup_step().)^ 8436** 8437** <b>Concurrent Usage of Database Handles</b> 8438** 8439** ^The source [database connection] may be used by the application for other 8440** purposes while a backup operation is underway or being initialized. 8441** ^If SQLite is compiled and configured to support threadsafe database 8442** connections, then the source database connection may be used concurrently 8443** from within other threads. 8444** 8445** However, the application must guarantee that the destination 8446** [database connection] is not passed to any other API (by any thread) after 8447** sqlite3_backup_init() is called and before the corresponding call to 8448** sqlite3_backup_finish(). SQLite does not currently check to see 8449** if the application incorrectly accesses the destination [database connection] 8450** and so no error code is reported, but the operations may malfunction 8451** nevertheless. Use of the destination database connection while a 8452** backup is in progress might also also cause a mutex deadlock. 8453** 8454** If running in [shared cache mode], the application must 8455** guarantee that the shared cache used by the destination database 8456** is not accessed while the backup is running. In practice this means 8457** that the application must guarantee that the disk file being 8458** backed up to is not accessed by any connection within the process, 8459** not just the specific connection that was passed to sqlite3_backup_init(). 8460** 8461** The [sqlite3_backup] object itself is partially threadsafe. Multiple 8462** threads may safely make multiple concurrent calls to sqlite3_backup_step(). 8463** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() 8464** APIs are not strictly speaking threadsafe. If they are invoked at the 8465** same time as another thread is invoking sqlite3_backup_step() it is 8466** possible that they return invalid values. 8467*/ 8468sqlite3_backup *sqlite3_backup_init( 8469 sqlite3 *pDest, /* Destination database handle */ 8470 const char *zDestName, /* Destination database name */ 8471 sqlite3 *pSource, /* Source database handle */ 8472 const char *zSourceName /* Source database name */ 8473); 8474int sqlite3_backup_step(sqlite3_backup *p, int nPage); 8475int sqlite3_backup_finish(sqlite3_backup *p); 8476int sqlite3_backup_remaining(sqlite3_backup *p); 8477int sqlite3_backup_pagecount(sqlite3_backup *p); 8478 8479/* 8480** CAPI3REF: Unlock Notification 8481** METHOD: sqlite3 8482** 8483** ^When running in shared-cache mode, a database operation may fail with 8484** an [SQLITE_LOCKED] error if the required locks on the shared-cache or 8485** individual tables within the shared-cache cannot be obtained. See 8486** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 8487** ^This API may be used to register a callback that SQLite will invoke 8488** when the connection currently holding the required lock relinquishes it. 8489** ^This API is only available if the library was compiled with the 8490** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. 8491** 8492** See Also: [Using the SQLite Unlock Notification Feature]. 8493** 8494** ^Shared-cache locks are released when a database connection concludes 8495** its current transaction, either by committing it or rolling it back. 8496** 8497** ^When a connection (known as the blocked connection) fails to obtain a 8498** shared-cache lock and SQLITE_LOCKED is returned to the caller, the 8499** identity of the database connection (the blocking connection) that 8500** has locked the required resource is stored internally. ^After an 8501** application receives an SQLITE_LOCKED error, it may call the 8502** sqlite3_unlock_notify() method with the blocked connection handle as 8503** the first argument to register for a callback that will be invoked 8504** when the blocking connections current transaction is concluded. ^The 8505** callback is invoked from within the [sqlite3_step] or [sqlite3_close] 8506** call that concludes the blocking connection's transaction. 8507** 8508** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, 8509** there is a chance that the blocking connection will have already 8510** concluded its transaction by the time sqlite3_unlock_notify() is invoked. 8511** If this happens, then the specified callback is invoked immediately, 8512** from within the call to sqlite3_unlock_notify().)^ 8513** 8514** ^If the blocked connection is attempting to obtain a write-lock on a 8515** shared-cache table, and more than one other connection currently holds 8516** a read-lock on the same table, then SQLite arbitrarily selects one of 8517** the other connections to use as the blocking connection. 8518** 8519** ^(There may be at most one unlock-notify callback registered by a 8520** blocked connection. If sqlite3_unlock_notify() is called when the 8521** blocked connection already has a registered unlock-notify callback, 8522** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is 8523** called with a NULL pointer as its second argument, then any existing 8524** unlock-notify callback is canceled. ^The blocked connections 8525** unlock-notify callback may also be canceled by closing the blocked 8526** connection using [sqlite3_close()]. 8527** 8528** The unlock-notify callback is not reentrant. If an application invokes 8529** any sqlite3_xxx API functions from within an unlock-notify callback, a 8530** crash or deadlock may be the result. 8531** 8532** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always 8533** returns SQLITE_OK. 8534** 8535** <b>Callback Invocation Details</b> 8536** 8537** When an unlock-notify callback is registered, the application provides a 8538** single void* pointer that is passed to the callback when it is invoked. 8539** However, the signature of the callback function allows SQLite to pass 8540** it an array of void* context pointers. The first argument passed to 8541** an unlock-notify callback is a pointer to an array of void* pointers, 8542** and the second is the number of entries in the array. 8543** 8544** When a blocking connection's transaction is concluded, there may be 8545** more than one blocked connection that has registered for an unlock-notify 8546** callback. ^If two or more such blocked connections have specified the 8547** same callback function, then instead of invoking the callback function 8548** multiple times, it is invoked once with the set of void* context pointers 8549** specified by the blocked connections bundled together into an array. 8550** This gives the application an opportunity to prioritize any actions 8551** related to the set of unblocked database connections. 8552** 8553** <b>Deadlock Detection</b> 8554** 8555** Assuming that after registering for an unlock-notify callback a 8556** database waits for the callback to be issued before taking any further 8557** action (a reasonable assumption), then using this API may cause the 8558** application to deadlock. For example, if connection X is waiting for 8559** connection Y's transaction to be concluded, and similarly connection 8560** Y is waiting on connection X's transaction, then neither connection 8561** will proceed and the system may remain deadlocked indefinitely. 8562** 8563** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock 8564** detection. ^If a given call to sqlite3_unlock_notify() would put the 8565** system in a deadlocked state, then SQLITE_LOCKED is returned and no 8566** unlock-notify callback is registered. The system is said to be in 8567** a deadlocked state if connection A has registered for an unlock-notify 8568** callback on the conclusion of connection B's transaction, and connection 8569** B has itself registered for an unlock-notify callback when connection 8570** A's transaction is concluded. ^Indirect deadlock is also detected, so 8571** the system is also considered to be deadlocked if connection B has 8572** registered for an unlock-notify callback on the conclusion of connection 8573** C's transaction, where connection C is waiting on connection A. ^Any 8574** number of levels of indirection are allowed. 8575** 8576** <b>The "DROP TABLE" Exception</b> 8577** 8578** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 8579** always appropriate to call sqlite3_unlock_notify(). There is however, 8580** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, 8581** SQLite checks if there are any currently executing SELECT statements 8582** that belong to the same connection. If there are, SQLITE_LOCKED is 8583** returned. In this case there is no "blocking connection", so invoking 8584** sqlite3_unlock_notify() results in the unlock-notify callback being 8585** invoked immediately. If the application then re-attempts the "DROP TABLE" 8586** or "DROP INDEX" query, an infinite loop might be the result. 8587** 8588** One way around this problem is to check the extended error code returned 8589** by an sqlite3_step() call. ^(If there is a blocking connection, then the 8590** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in 8591** the special "DROP TABLE/INDEX" case, the extended error code is just 8592** SQLITE_LOCKED.)^ 8593*/ 8594int sqlite3_unlock_notify( 8595 sqlite3 *pBlocked, /* Waiting connection */ 8596 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 8597 void *pNotifyArg /* Argument to pass to xNotify */ 8598); 8599 8600 8601/* 8602** CAPI3REF: String Comparison 8603** 8604** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications 8605** and extensions to compare the contents of two buffers containing UTF-8 8606** strings in a case-independent fashion, using the same definition of "case 8607** independence" that SQLite uses internally when comparing identifiers. 8608*/ 8609int sqlite3_stricmp(const char *, const char *); 8610int sqlite3_strnicmp(const char *, const char *, int); 8611 8612/* 8613** CAPI3REF: String Globbing 8614* 8615** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if 8616** string X matches the [GLOB] pattern P. 8617** ^The definition of [GLOB] pattern matching used in 8618** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the 8619** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function 8620** is case sensitive. 8621** 8622** Note that this routine returns zero on a match and non-zero if the strings 8623** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. 8624** 8625** See also: [sqlite3_strlike()]. 8626*/ 8627int sqlite3_strglob(const char *zGlob, const char *zStr); 8628 8629/* 8630** CAPI3REF: String LIKE Matching 8631* 8632** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if 8633** string X matches the [LIKE] pattern P with escape character E. 8634** ^The definition of [LIKE] pattern matching used in 8635** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E" 8636** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without 8637** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0. 8638** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case 8639** insensitive - equivalent upper and lower case ASCII characters match 8640** one another. 8641** 8642** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though 8643** only ASCII characters are case folded. 8644** 8645** Note that this routine returns zero on a match and non-zero if the strings 8646** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. 8647** 8648** See also: [sqlite3_strglob()]. 8649*/ 8650int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc); 8651 8652/* 8653** CAPI3REF: Error Logging Interface 8654** 8655** ^The [sqlite3_log()] interface writes a message into the [error log] 8656** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. 8657** ^If logging is enabled, the zFormat string and subsequent arguments are 8658** used with [sqlite3_snprintf()] to generate the final output string. 8659** 8660** The sqlite3_log() interface is intended for use by extensions such as 8661** virtual tables, collating functions, and SQL functions. While there is 8662** nothing to prevent an application from calling sqlite3_log(), doing so 8663** is considered bad form. 8664** 8665** The zFormat string must not be NULL. 8666** 8667** To avoid deadlocks and other threading problems, the sqlite3_log() routine 8668** will not use dynamically allocated memory. The log message is stored in 8669** a fixed-length buffer on the stack. If the log message is longer than 8670** a few hundred characters, it will be truncated to the length of the 8671** buffer. 8672*/ 8673void sqlite3_log(int iErrCode, const char *zFormat, ...); 8674 8675/* 8676** CAPI3REF: Write-Ahead Log Commit Hook 8677** METHOD: sqlite3 8678** 8679** ^The [sqlite3_wal_hook()] function is used to register a callback that 8680** is invoked each time data is committed to a database in wal mode. 8681** 8682** ^(The callback is invoked by SQLite after the commit has taken place and 8683** the associated write-lock on the database released)^, so the implementation 8684** may read, write or [checkpoint] the database as required. 8685** 8686** ^The first parameter passed to the callback function when it is invoked 8687** is a copy of the third parameter passed to sqlite3_wal_hook() when 8688** registering the callback. ^The second is a copy of the database handle. 8689** ^The third parameter is the name of the database that was written to - 8690** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter 8691** is the number of pages currently in the write-ahead log file, 8692** including those that were just committed. 8693** 8694** The callback function should normally return [SQLITE_OK]. ^If an error 8695** code is returned, that error will propagate back up through the 8696** SQLite code base to cause the statement that provoked the callback 8697** to report an error, though the commit will have still occurred. If the 8698** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value 8699** that does not correspond to any valid SQLite error code, the results 8700** are undefined. 8701** 8702** A single database handle may have at most a single write-ahead log callback 8703** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any 8704** previously registered write-ahead log callback. ^Note that the 8705** [sqlite3_wal_autocheckpoint()] interface and the 8706** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will 8707** overwrite any prior [sqlite3_wal_hook()] settings. 8708*/ 8709void *sqlite3_wal_hook( 8710 sqlite3*, 8711 int(*)(void *,sqlite3*,const char*,int), 8712 void* 8713); 8714 8715/* 8716** CAPI3REF: Configure an auto-checkpoint 8717** METHOD: sqlite3 8718** 8719** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around 8720** [sqlite3_wal_hook()] that causes any database on [database connection] D 8721** to automatically [checkpoint] 8722** after committing a transaction if there are N or 8723** more frames in the [write-ahead log] file. ^Passing zero or 8724** a negative value as the nFrame parameter disables automatic 8725** checkpoints entirely. 8726** 8727** ^The callback registered by this function replaces any existing callback 8728** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback 8729** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism 8730** configured by this function. 8731** 8732** ^The [wal_autocheckpoint pragma] can be used to invoke this interface 8733** from SQL. 8734** 8735** ^Checkpoints initiated by this mechanism are 8736** [sqlite3_wal_checkpoint_v2|PASSIVE]. 8737** 8738** ^Every new [database connection] defaults to having the auto-checkpoint 8739** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] 8740** pages. The use of this interface 8741** is only necessary if the default setting is found to be suboptimal 8742** for a particular application. 8743*/ 8744int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); 8745 8746/* 8747** CAPI3REF: Checkpoint a database 8748** METHOD: sqlite3 8749** 8750** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to 8751** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^ 8752** 8753** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the 8754** [write-ahead log] for database X on [database connection] D to be 8755** transferred into the database file and for the write-ahead log to 8756** be reset. See the [checkpointing] documentation for addition 8757** information. 8758** 8759** This interface used to be the only way to cause a checkpoint to 8760** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()] 8761** interface was added. This interface is retained for backwards 8762** compatibility and as a convenience for applications that need to manually 8763** start a callback but which do not need the full power (and corresponding 8764** complication) of [sqlite3_wal_checkpoint_v2()]. 8765*/ 8766int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); 8767 8768/* 8769** CAPI3REF: Checkpoint a database 8770** METHOD: sqlite3 8771** 8772** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint 8773** operation on database X of [database connection] D in mode M. Status 8774** information is written back into integers pointed to by L and C.)^ 8775** ^(The M parameter must be a valid [checkpoint mode]:)^ 8776** 8777** <dl> 8778** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> 8779** ^Checkpoint as many frames as possible without waiting for any database 8780** readers or writers to finish, then sync the database file if all frames 8781** in the log were checkpointed. ^The [busy-handler callback] 8782** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode. 8783** ^On the other hand, passive mode might leave the checkpoint unfinished 8784** if there are concurrent readers or writers. 8785** 8786** <dt>SQLITE_CHECKPOINT_FULL<dd> 8787** ^This mode blocks (it invokes the 8788** [sqlite3_busy_handler|busy-handler callback]) until there is no 8789** database writer and all readers are reading from the most recent database 8790** snapshot. ^It then checkpoints all frames in the log file and syncs the 8791** database file. ^This mode blocks new database writers while it is pending, 8792** but new database readers are allowed to continue unimpeded. 8793** 8794** <dt>SQLITE_CHECKPOINT_RESTART<dd> 8795** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition 8796** that after checkpointing the log file it blocks (calls the 8797** [busy-handler callback]) 8798** until all readers are reading from the database file only. ^This ensures 8799** that the next writer will restart the log file from the beginning. 8800** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new 8801** database writer attempts while it is pending, but does not impede readers. 8802** 8803** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd> 8804** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the 8805** addition that it also truncates the log file to zero bytes just prior 8806** to a successful return. 8807** </dl> 8808** 8809** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in 8810** the log file or to -1 if the checkpoint could not run because 8811** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not 8812** NULL,then *pnCkpt is set to the total number of checkpointed frames in the 8813** log file (including any that were already checkpointed before the function 8814** was called) or to -1 if the checkpoint could not run due to an error or 8815** because the database is not in WAL mode. ^Note that upon successful 8816** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been 8817** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero. 8818** 8819** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If 8820** any other process is running a checkpoint operation at the same time, the 8821** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a 8822** busy-handler configured, it will not be invoked in this case. 8823** 8824** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the 8825** exclusive "writer" lock on the database file. ^If the writer lock cannot be 8826** obtained immediately, and a busy-handler is configured, it is invoked and 8827** the writer lock retried until either the busy-handler returns 0 or the lock 8828** is successfully obtained. ^The busy-handler is also invoked while waiting for 8829** database readers as described above. ^If the busy-handler returns 0 before 8830** the writer lock is obtained or while waiting for database readers, the 8831** checkpoint operation proceeds from that point in the same way as 8832** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible 8833** without blocking any further. ^SQLITE_BUSY is returned in this case. 8834** 8835** ^If parameter zDb is NULL or points to a zero length string, then the 8836** specified operation is attempted on all WAL databases [attached] to 8837** [database connection] db. In this case the 8838** values written to output parameters *pnLog and *pnCkpt are undefined. ^If 8839** an SQLITE_BUSY error is encountered when processing one or more of the 8840** attached WAL databases, the operation is still attempted on any remaining 8841** attached databases and SQLITE_BUSY is returned at the end. ^If any other 8842** error occurs while processing an attached database, processing is abandoned 8843** and the error code is returned to the caller immediately. ^If no error 8844** (SQLITE_BUSY or otherwise) is encountered while processing the attached 8845** databases, SQLITE_OK is returned. 8846** 8847** ^If database zDb is the name of an attached database that is not in WAL 8848** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If 8849** zDb is not NULL (or a zero length string) and is not the name of any 8850** attached database, SQLITE_ERROR is returned to the caller. 8851** 8852** ^Unless it returns SQLITE_MISUSE, 8853** the sqlite3_wal_checkpoint_v2() interface 8854** sets the error information that is queried by 8855** [sqlite3_errcode()] and [sqlite3_errmsg()]. 8856** 8857** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface 8858** from SQL. 8859*/ 8860int sqlite3_wal_checkpoint_v2( 8861 sqlite3 *db, /* Database handle */ 8862 const char *zDb, /* Name of attached database (or NULL) */ 8863 int eMode, /* SQLITE_CHECKPOINT_* value */ 8864 int *pnLog, /* OUT: Size of WAL log in frames */ 8865 int *pnCkpt /* OUT: Total number of frames checkpointed */ 8866); 8867 8868/* 8869** CAPI3REF: Checkpoint Mode Values 8870** KEYWORDS: {checkpoint mode} 8871** 8872** These constants define all valid values for the "checkpoint mode" passed 8873** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface. 8874** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the 8875** meaning of each of these checkpoint modes. 8876*/ 8877#define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */ 8878#define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */ 8879#define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */ 8880#define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */ 8881 8882/* 8883** CAPI3REF: Virtual Table Interface Configuration 8884** 8885** This function may be called by either the [xConnect] or [xCreate] method 8886** of a [virtual table] implementation to configure 8887** various facets of the virtual table interface. 8888** 8889** If this interface is invoked outside the context of an xConnect or 8890** xCreate virtual table method then the behavior is undefined. 8891** 8892** At present, there is only one option that may be configured using 8893** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options 8894** may be added in the future. 8895*/ 8896int sqlite3_vtab_config(sqlite3*, int op, ...); 8897 8898/* 8899** CAPI3REF: Virtual Table Configuration Options 8900** 8901** These macros define the various options to the 8902** [sqlite3_vtab_config()] interface that [virtual table] implementations 8903** can use to customize and optimize their behavior. 8904** 8905** <dl> 8906** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]] 8907** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt> 8908** <dd>Calls of the form 8909** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, 8910** where X is an integer. If X is zero, then the [virtual table] whose 8911** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not 8912** support constraints. In this configuration (which is the default) if 8913** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire 8914** statement is rolled back as if [ON CONFLICT | OR ABORT] had been 8915** specified as part of the users SQL statement, regardless of the actual 8916** ON CONFLICT mode specified. 8917** 8918** If X is non-zero, then the virtual table implementation guarantees 8919** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before 8920** any modifications to internal or persistent data structures have been made. 8921** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite 8922** is able to roll back a statement or database transaction, and abandon 8923** or continue processing the current SQL statement as appropriate. 8924** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns 8925** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode 8926** had been ABORT. 8927** 8928** Virtual table implementations that are required to handle OR REPLACE 8929** must do so within the [xUpdate] method. If a call to the 8930** [sqlite3_vtab_on_conflict()] function indicates that the current ON 8931** CONFLICT policy is REPLACE, the virtual table implementation should 8932** silently replace the appropriate rows within the xUpdate callback and 8933** return SQLITE_OK. Or, if this is not possible, it may return 8934** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT 8935** constraint handling. 8936** </dd> 8937** 8938** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt> 8939** <dd>Calls of the form 8940** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the 8941** the [xConnect] or [xCreate] methods of a [virtual table] implmentation 8942** identify that virtual table as being safe to use from within triggers 8943** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the 8944** virtual table can do no serious harm even if it is controlled by a 8945** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS 8946** flag unless absolutely necessary. 8947** </dd> 8948** 8949** [[SQLITE_VTAB_DIRECTONLY]]<dt>SQLITE_VTAB_DIRECTONLY</dt> 8950** <dd>Calls of the form 8951** [sqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the 8952** the [xConnect] or [xCreate] methods of a [virtual table] implmentation 8953** prohibits that virtual table from being used from within triggers and 8954** views. 8955** </dd> 8956** </dl> 8957*/ 8958#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 8959#define SQLITE_VTAB_INNOCUOUS 2 8960#define SQLITE_VTAB_DIRECTONLY 3 8961 8962/* 8963** CAPI3REF: Determine The Virtual Table Conflict Policy 8964** 8965** This function may only be called from within a call to the [xUpdate] method 8966** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The 8967** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], 8968** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode 8969** of the SQL statement that triggered the call to the [xUpdate] method of the 8970** [virtual table]. 8971*/ 8972int sqlite3_vtab_on_conflict(sqlite3 *); 8973 8974/* 8975** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE 8976** 8977** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn] 8978** method of a [virtual table], then it returns true if and only if the 8979** column is being fetched as part of an UPDATE operation during which the 8980** column value will not change. Applications might use this to substitute 8981** a return value that is less expensive to compute and that the corresponding 8982** [xUpdate] method understands as a "no-change" value. 8983** 8984** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that 8985** the column is not changed by the UPDATE statement, then the xColumn 8986** method can optionally return without setting a result, without calling 8987** any of the [sqlite3_result_int|sqlite3_result_xxxxx() interfaces]. 8988** In that case, [sqlite3_value_nochange(X)] will return true for the 8989** same column in the [xUpdate] method. 8990*/ 8991int sqlite3_vtab_nochange(sqlite3_context*); 8992 8993/* 8994** CAPI3REF: Determine The Collation For a Virtual Table Constraint 8995** 8996** This function may only be called from within a call to the [xBestIndex] 8997** method of a [virtual table]. 8998** 8999** The first argument must be the sqlite3_index_info object that is the 9000** first parameter to the xBestIndex() method. The second argument must be 9001** an index into the aConstraint[] array belonging to the sqlite3_index_info 9002** structure passed to xBestIndex. This function returns a pointer to a buffer 9003** containing the name of the collation sequence for the corresponding 9004** constraint. 9005*/ 9006SQLITE_EXPERIMENTAL const char *sqlite3_vtab_collation(sqlite3_index_info*,int); 9007 9008/* 9009** CAPI3REF: Conflict resolution modes 9010** KEYWORDS: {conflict resolution mode} 9011** 9012** These constants are returned by [sqlite3_vtab_on_conflict()] to 9013** inform a [virtual table] implementation what the [ON CONFLICT] mode 9014** is for the SQL statement being evaluated. 9015** 9016** Note that the [SQLITE_IGNORE] constant is also used as a potential 9017** return value from the [sqlite3_set_authorizer()] callback and that 9018** [SQLITE_ABORT] is also a [result code]. 9019*/ 9020#define SQLITE_ROLLBACK 1 9021/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ 9022#define SQLITE_FAIL 3 9023/* #define SQLITE_ABORT 4 // Also an error code */ 9024#define SQLITE_REPLACE 5 9025 9026/* 9027** CAPI3REF: Prepared Statement Scan Status Opcodes 9028** KEYWORDS: {scanstatus options} 9029** 9030** The following constants can be used for the T parameter to the 9031** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a 9032** different metric for sqlite3_stmt_scanstatus() to return. 9033** 9034** When the value returned to V is a string, space to hold that string is 9035** managed by the prepared statement S and will be automatically freed when 9036** S is finalized. 9037** 9038** <dl> 9039** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt> 9040** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be 9041** set to the total number of times that the X-th loop has run.</dd> 9042** 9043** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt> 9044** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be set 9045** to the total number of rows examined by all iterations of the X-th loop.</dd> 9046** 9047** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt> 9048** <dd>^The "double" variable pointed to by the V parameter will be set to the 9049** query planner's estimate for the average number of rows output from each 9050** iteration of the X-th loop. If the query planner's estimates was accurate, 9051** then this value will approximate the quotient NVISIT/NLOOP and the 9052** product of this value for all prior loops with the same SELECTID will 9053** be the NLOOP value for the current loop. 9054** 9055** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt> 9056** <dd>^The "const char *" variable pointed to by the V parameter will be set 9057** to a zero-terminated UTF-8 string containing the name of the index or table 9058** used for the X-th loop. 9059** 9060** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt> 9061** <dd>^The "const char *" variable pointed to by the V parameter will be set 9062** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] 9063** description for the X-th loop. 9064** 9065** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt> 9066** <dd>^The "int" variable pointed to by the V parameter will be set to the 9067** "select-id" for the X-th loop. The select-id identifies which query or 9068** subquery the loop is part of. The main query has a select-id of zero. 9069** The select-id is the same value as is output in the first column 9070** of an [EXPLAIN QUERY PLAN] query. 9071** </dl> 9072*/ 9073#define SQLITE_SCANSTAT_NLOOP 0 9074#define SQLITE_SCANSTAT_NVISIT 1 9075#define SQLITE_SCANSTAT_EST 2 9076#define SQLITE_SCANSTAT_NAME 3 9077#define SQLITE_SCANSTAT_EXPLAIN 4 9078#define SQLITE_SCANSTAT_SELECTID 5 9079 9080/* 9081** CAPI3REF: Prepared Statement Scan Status 9082** METHOD: sqlite3_stmt 9083** 9084** This interface returns information about the predicted and measured 9085** performance for pStmt. Advanced applications can use this 9086** interface to compare the predicted and the measured performance and 9087** issue warnings and/or rerun [ANALYZE] if discrepancies are found. 9088** 9089** Since this interface is expected to be rarely used, it is only 9090** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS] 9091** compile-time option. 9092** 9093** The "iScanStatusOp" parameter determines which status information to return. 9094** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior 9095** of this interface is undefined. 9096** ^The requested measurement is written into a variable pointed to by 9097** the "pOut" parameter. 9098** Parameter "idx" identifies the specific loop to retrieve statistics for. 9099** Loops are numbered starting from zero. ^If idx is out of range - less than 9100** zero or greater than or equal to the total number of loops used to implement 9101** the statement - a non-zero value is returned and the variable that pOut 9102** points to is unchanged. 9103** 9104** ^Statistics might not be available for all loops in all statements. ^In cases 9105** where there exist loops with no available statistics, this function behaves 9106** as if the loop did not exist - it returns non-zero and leave the variable 9107** that pOut points to unchanged. 9108** 9109** See also: [sqlite3_stmt_scanstatus_reset()] 9110*/ 9111int sqlite3_stmt_scanstatus( 9112 sqlite3_stmt *pStmt, /* Prepared statement for which info desired */ 9113 int idx, /* Index of loop to report on */ 9114 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */ 9115 void *pOut /* Result written here */ 9116); 9117 9118/* 9119** CAPI3REF: Zero Scan-Status Counters 9120** METHOD: sqlite3_stmt 9121** 9122** ^Zero all [sqlite3_stmt_scanstatus()] related event counters. 9123** 9124** This API is only available if the library is built with pre-processor 9125** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined. 9126*/ 9127void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*); 9128 9129/* 9130** CAPI3REF: Flush caches to disk mid-transaction 9131** 9132** ^If a write-transaction is open on [database connection] D when the 9133** [sqlite3_db_cacheflush(D)] interface invoked, any dirty 9134** pages in the pager-cache that are not currently in use are written out 9135** to disk. A dirty page may be in use if a database cursor created by an 9136** active SQL statement is reading from it, or if it is page 1 of a database 9137** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)] 9138** interface flushes caches for all schemas - "main", "temp", and 9139** any [attached] databases. 9140** 9141** ^If this function needs to obtain extra database locks before dirty pages 9142** can be flushed to disk, it does so. ^If those locks cannot be obtained 9143** immediately and there is a busy-handler callback configured, it is invoked 9144** in the usual manner. ^If the required lock still cannot be obtained, then 9145** the database is skipped and an attempt made to flush any dirty pages 9146** belonging to the next (if any) database. ^If any databases are skipped 9147** because locks cannot be obtained, but no other error occurs, this 9148** function returns SQLITE_BUSY. 9149** 9150** ^If any other error occurs while flushing dirty pages to disk (for 9151** example an IO error or out-of-memory condition), then processing is 9152** abandoned and an SQLite [error code] is returned to the caller immediately. 9153** 9154** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK. 9155** 9156** ^This function does not set the database handle error code or message 9157** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions. 9158*/ 9159int sqlite3_db_cacheflush(sqlite3*); 9160 9161/* 9162** CAPI3REF: The pre-update hook. 9163** 9164** ^These interfaces are only available if SQLite is compiled using the 9165** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option. 9166** 9167** ^The [sqlite3_preupdate_hook()] interface registers a callback function 9168** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation 9169** on a database table. 9170** ^At most one preupdate hook may be registered at a time on a single 9171** [database connection]; each call to [sqlite3_preupdate_hook()] overrides 9172** the previous setting. 9173** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()] 9174** with a NULL pointer as the second parameter. 9175** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as 9176** the first parameter to callbacks. 9177** 9178** ^The preupdate hook only fires for changes to real database tables; the 9179** preupdate hook is not invoked for changes to [virtual tables] or to 9180** system tables like sqlite_master or sqlite_stat1. 9181** 9182** ^The second parameter to the preupdate callback is a pointer to 9183** the [database connection] that registered the preupdate hook. 9184** ^The third parameter to the preupdate callback is one of the constants 9185** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the 9186** kind of update operation that is about to occur. 9187** ^(The fourth parameter to the preupdate callback is the name of the 9188** database within the database connection that is being modified. This 9189** will be "main" for the main database or "temp" for TEMP tables or 9190** the name given after the AS keyword in the [ATTACH] statement for attached 9191** databases.)^ 9192** ^The fifth parameter to the preupdate callback is the name of the 9193** table that is being modified. 9194** 9195** For an UPDATE or DELETE operation on a [rowid table], the sixth 9196** parameter passed to the preupdate callback is the initial [rowid] of the 9197** row being modified or deleted. For an INSERT operation on a rowid table, 9198** or any operation on a WITHOUT ROWID table, the value of the sixth 9199** parameter is undefined. For an INSERT or UPDATE on a rowid table the 9200** seventh parameter is the final rowid value of the row being inserted 9201** or updated. The value of the seventh parameter passed to the callback 9202** function is not defined for operations on WITHOUT ROWID tables, or for 9203** INSERT operations on rowid tables. 9204** 9205** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()], 9206** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces 9207** provide additional information about a preupdate event. These routines 9208** may only be called from within a preupdate callback. Invoking any of 9209** these routines from outside of a preupdate callback or with a 9210** [database connection] pointer that is different from the one supplied 9211** to the preupdate callback results in undefined and probably undesirable 9212** behavior. 9213** 9214** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns 9215** in the row that is being inserted, updated, or deleted. 9216** 9217** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to 9218** a [protected sqlite3_value] that contains the value of the Nth column of 9219** the table row before it is updated. The N parameter must be between 0 9220** and one less than the number of columns or the behavior will be 9221** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE 9222** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the 9223** behavior is undefined. The [sqlite3_value] that P points to 9224** will be destroyed when the preupdate callback returns. 9225** 9226** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to 9227** a [protected sqlite3_value] that contains the value of the Nth column of 9228** the table row after it is updated. The N parameter must be between 0 9229** and one less than the number of columns or the behavior will be 9230** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE 9231** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the 9232** behavior is undefined. The [sqlite3_value] that P points to 9233** will be destroyed when the preupdate callback returns. 9234** 9235** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate 9236** callback was invoked as a result of a direct insert, update, or delete 9237** operation; or 1 for inserts, updates, or deletes invoked by top-level 9238** triggers; or 2 for changes resulting from triggers called by top-level 9239** triggers; and so forth. 9240** 9241** See also: [sqlite3_update_hook()] 9242*/ 9243#if defined(SQLITE_ENABLE_PREUPDATE_HOOK) 9244void *sqlite3_preupdate_hook( 9245 sqlite3 *db, 9246 void(*xPreUpdate)( 9247 void *pCtx, /* Copy of third arg to preupdate_hook() */ 9248 sqlite3 *db, /* Database handle */ 9249 int op, /* SQLITE_UPDATE, DELETE or INSERT */ 9250 char const *zDb, /* Database name */ 9251 char const *zName, /* Table name */ 9252 sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */ 9253 sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */ 9254 ), 9255 void* 9256); 9257int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **); 9258int sqlite3_preupdate_count(sqlite3 *); 9259int sqlite3_preupdate_depth(sqlite3 *); 9260int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **); 9261#endif 9262 9263/* 9264** CAPI3REF: Low-level system error code 9265** 9266** ^Attempt to return the underlying operating system error code or error 9267** number that caused the most recent I/O error or failure to open a file. 9268** The return value is OS-dependent. For example, on unix systems, after 9269** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be 9270** called to get back the underlying "errno" that caused the problem, such 9271** as ENOSPC, EAUTH, EISDIR, and so forth. 9272*/ 9273int sqlite3_system_errno(sqlite3*); 9274 9275/* 9276** CAPI3REF: Database Snapshot 9277** KEYWORDS: {snapshot} {sqlite3_snapshot} 9278** 9279** An instance of the snapshot object records the state of a [WAL mode] 9280** database for some specific point in history. 9281** 9282** In [WAL mode], multiple [database connections] that are open on the 9283** same database file can each be reading a different historical version 9284** of the database file. When a [database connection] begins a read 9285** transaction, that connection sees an unchanging copy of the database 9286** as it existed for the point in time when the transaction first started. 9287** Subsequent changes to the database from other connections are not seen 9288** by the reader until a new read transaction is started. 9289** 9290** The sqlite3_snapshot object records state information about an historical 9291** version of the database file so that it is possible to later open a new read 9292** transaction that sees that historical version of the database rather than 9293** the most recent version. 9294*/ 9295typedef struct sqlite3_snapshot { 9296 unsigned char hidden[48]; 9297} sqlite3_snapshot; 9298 9299/* 9300** CAPI3REF: Record A Database Snapshot 9301** CONSTRUCTOR: sqlite3_snapshot 9302** 9303** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a 9304** new [sqlite3_snapshot] object that records the current state of 9305** schema S in database connection D. ^On success, the 9306** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly 9307** created [sqlite3_snapshot] object into *P and returns SQLITE_OK. 9308** If there is not already a read-transaction open on schema S when 9309** this function is called, one is opened automatically. 9310** 9311** The following must be true for this function to succeed. If any of 9312** the following statements are false when sqlite3_snapshot_get() is 9313** called, SQLITE_ERROR is returned. The final value of *P is undefined 9314** in this case. 9315** 9316** <ul> 9317** <li> The database handle must not be in [autocommit mode]. 9318** 9319** <li> Schema S of [database connection] D must be a [WAL mode] database. 9320** 9321** <li> There must not be a write transaction open on schema S of database 9322** connection D. 9323** 9324** <li> One or more transactions must have been written to the current wal 9325** file since it was created on disk (by any connection). This means 9326** that a snapshot cannot be taken on a wal mode database with no wal 9327** file immediately after it is first opened. At least one transaction 9328** must be written to it first. 9329** </ul> 9330** 9331** This function may also return SQLITE_NOMEM. If it is called with the 9332** database handle in autocommit mode but fails for some other reason, 9333** whether or not a read transaction is opened on schema S is undefined. 9334** 9335** The [sqlite3_snapshot] object returned from a successful call to 9336** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()] 9337** to avoid a memory leak. 9338** 9339** The [sqlite3_snapshot_get()] interface is only available when the 9340** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. 9341*/ 9342SQLITE_EXPERIMENTAL int sqlite3_snapshot_get( 9343 sqlite3 *db, 9344 const char *zSchema, 9345 sqlite3_snapshot **ppSnapshot 9346); 9347 9348/* 9349** CAPI3REF: Start a read transaction on an historical snapshot 9350** METHOD: sqlite3_snapshot 9351** 9352** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read 9353** transaction or upgrades an existing one for schema S of 9354** [database connection] D such that the read transaction refers to 9355** historical [snapshot] P, rather than the most recent change to the 9356** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK 9357** on success or an appropriate [error code] if it fails. 9358** 9359** ^In order to succeed, the database connection must not be in 9360** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there 9361** is already a read transaction open on schema S, then the database handle 9362** must have no active statements (SELECT statements that have been passed 9363** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()). 9364** SQLITE_ERROR is returned if either of these conditions is violated, or 9365** if schema S does not exist, or if the snapshot object is invalid. 9366** 9367** ^A call to sqlite3_snapshot_open() will fail to open if the specified 9368** snapshot has been overwritten by a [checkpoint]. In this case 9369** SQLITE_ERROR_SNAPSHOT is returned. 9370** 9371** If there is already a read transaction open when this function is 9372** invoked, then the same read transaction remains open (on the same 9373** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT 9374** is returned. If another error code - for example SQLITE_PROTOCOL or an 9375** SQLITE_IOERR error code - is returned, then the final state of the 9376** read transaction is undefined. If SQLITE_OK is returned, then the 9377** read transaction is now open on database snapshot P. 9378** 9379** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the 9380** database connection D does not know that the database file for 9381** schema S is in [WAL mode]. A database connection might not know 9382** that the database file is in [WAL mode] if there has been no prior 9383** I/O on that database connection, or if the database entered [WAL mode] 9384** after the most recent I/O on the database connection.)^ 9385** (Hint: Run "[PRAGMA application_id]" against a newly opened 9386** database connection in order to make it ready to use snapshots.) 9387** 9388** The [sqlite3_snapshot_open()] interface is only available when the 9389** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. 9390*/ 9391SQLITE_EXPERIMENTAL int sqlite3_snapshot_open( 9392 sqlite3 *db, 9393 const char *zSchema, 9394 sqlite3_snapshot *pSnapshot 9395); 9396 9397/* 9398** CAPI3REF: Destroy a snapshot 9399** DESTRUCTOR: sqlite3_snapshot 9400** 9401** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P. 9402** The application must eventually free every [sqlite3_snapshot] object 9403** using this routine to avoid a memory leak. 9404** 9405** The [sqlite3_snapshot_free()] interface is only available when the 9406** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. 9407*/ 9408SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*); 9409 9410/* 9411** CAPI3REF: Compare the ages of two snapshot handles. 9412** METHOD: sqlite3_snapshot 9413** 9414** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages 9415** of two valid snapshot handles. 9416** 9417** If the two snapshot handles are not associated with the same database 9418** file, the result of the comparison is undefined. 9419** 9420** Additionally, the result of the comparison is only valid if both of the 9421** snapshot handles were obtained by calling sqlite3_snapshot_get() since the 9422** last time the wal file was deleted. The wal file is deleted when the 9423** database is changed back to rollback mode or when the number of database 9424** clients drops to zero. If either snapshot handle was obtained before the 9425** wal file was last deleted, the value returned by this function 9426** is undefined. 9427** 9428** Otherwise, this API returns a negative value if P1 refers to an older 9429** snapshot than P2, zero if the two handles refer to the same database 9430** snapshot, and a positive value if P1 is a newer snapshot than P2. 9431** 9432** This interface is only available if SQLite is compiled with the 9433** [SQLITE_ENABLE_SNAPSHOT] option. 9434*/ 9435SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp( 9436 sqlite3_snapshot *p1, 9437 sqlite3_snapshot *p2 9438); 9439 9440/* 9441** CAPI3REF: Recover snapshots from a wal file 9442** METHOD: sqlite3_snapshot 9443** 9444** If a [WAL file] remains on disk after all database connections close 9445** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control] 9446** or because the last process to have the database opened exited without 9447** calling [sqlite3_close()]) and a new connection is subsequently opened 9448** on that database and [WAL file], the [sqlite3_snapshot_open()] interface 9449** will only be able to open the last transaction added to the WAL file 9450** even though the WAL file contains other valid transactions. 9451** 9452** This function attempts to scan the WAL file associated with database zDb 9453** of database handle db and make all valid snapshots available to 9454** sqlite3_snapshot_open(). It is an error if there is already a read 9455** transaction open on the database, or if the database is not a WAL mode 9456** database. 9457** 9458** SQLITE_OK is returned if successful, or an SQLite error code otherwise. 9459** 9460** This interface is only available if SQLite is compiled with the 9461** [SQLITE_ENABLE_SNAPSHOT] option. 9462*/ 9463SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb); 9464 9465/* 9466** CAPI3REF: Serialize a database 9467** 9468** The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory 9469** that is a serialization of the S database on [database connection] D. 9470** If P is not a NULL pointer, then the size of the database in bytes 9471** is written into *P. 9472** 9473** For an ordinary on-disk database file, the serialization is just a 9474** copy of the disk file. For an in-memory database or a "TEMP" database, 9475** the serialization is the same sequence of bytes which would be written 9476** to disk if that database where backed up to disk. 9477** 9478** The usual case is that sqlite3_serialize() copies the serialization of 9479** the database into memory obtained from [sqlite3_malloc64()] and returns 9480** a pointer to that memory. The caller is responsible for freeing the 9481** returned value to avoid a memory leak. However, if the F argument 9482** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations 9483** are made, and the sqlite3_serialize() function will return a pointer 9484** to the contiguous memory representation of the database that SQLite 9485** is currently using for that database, or NULL if the no such contiguous 9486** memory representation of the database exists. A contiguous memory 9487** representation of the database will usually only exist if there has 9488** been a prior call to [sqlite3_deserialize(D,S,...)] with the same 9489** values of D and S. 9490** The size of the database is written into *P even if the 9491** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy 9492** of the database exists. 9493** 9494** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the 9495** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory 9496** allocation error occurs. 9497** 9498** This interface is only available if SQLite is compiled with the 9499** [SQLITE_ENABLE_DESERIALIZE] option. 9500*/ 9501unsigned char *sqlite3_serialize( 9502 sqlite3 *db, /* The database connection */ 9503 const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */ 9504 sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */ 9505 unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */ 9506); 9507 9508/* 9509** CAPI3REF: Flags for sqlite3_serialize 9510** 9511** Zero or more of the following constants can be OR-ed together for 9512** the F argument to [sqlite3_serialize(D,S,P,F)]. 9513** 9514** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return 9515** a pointer to contiguous in-memory database that it is currently using, 9516** without making a copy of the database. If SQLite is not currently using 9517** a contiguous in-memory database, then this option causes 9518** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be 9519** using a contiguous in-memory database if it has been initialized by a 9520** prior call to [sqlite3_deserialize()]. 9521*/ 9522#define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */ 9523 9524/* 9525** CAPI3REF: Deserialize a database 9526** 9527** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the 9528** [database connection] D to disconnect from database S and then 9529** reopen S as an in-memory database based on the serialization contained 9530** in P. The serialized database P is N bytes in size. M is the size of 9531** the buffer P, which might be larger than N. If M is larger than N, and 9532** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is 9533** permitted to add content to the in-memory database as long as the total 9534** size does not exceed M bytes. 9535** 9536** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will 9537** invoke sqlite3_free() on the serialization buffer when the database 9538** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then 9539** SQLite will try to increase the buffer size using sqlite3_realloc64() 9540** if writes on the database cause it to grow larger than M bytes. 9541** 9542** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the 9543** database is currently in a read transaction or is involved in a backup 9544** operation. 9545** 9546** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the 9547** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then 9548** [sqlite3_free()] is invoked on argument P prior to returning. 9549** 9550** This interface is only available if SQLite is compiled with the 9551** [SQLITE_ENABLE_DESERIALIZE] option. 9552*/ 9553int sqlite3_deserialize( 9554 sqlite3 *db, /* The database connection */ 9555 const char *zSchema, /* Which DB to reopen with the deserialization */ 9556 unsigned char *pData, /* The serialized database content */ 9557 sqlite3_int64 szDb, /* Number bytes in the deserialization */ 9558 sqlite3_int64 szBuf, /* Total size of buffer pData[] */ 9559 unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */ 9560); 9561 9562/* 9563** CAPI3REF: Flags for sqlite3_deserialize() 9564** 9565** The following are allowed values for 6th argument (the F argument) to 9566** the [sqlite3_deserialize(D,S,P,N,M,F)] interface. 9567** 9568** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization 9569** in the P argument is held in memory obtained from [sqlite3_malloc64()] 9570** and that SQLite should take ownership of this memory and automatically 9571** free it when it has finished using it. Without this flag, the caller 9572** is responsible for freeing any dynamically allocated memory. 9573** 9574** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to 9575** grow the size of the database using calls to [sqlite3_realloc64()]. This 9576** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used. 9577** Without this flag, the deserialized database cannot increase in size beyond 9578** the number of bytes specified by the M parameter. 9579** 9580** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database 9581** should be treated as read-only. 9582*/ 9583#define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */ 9584#define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */ 9585#define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */ 9586 9587/* 9588** Undo the hack that converts floating point types to integer for 9589** builds on processors without floating point support. 9590*/ 9591#ifdef SQLITE_OMIT_FLOATING_POINT 9592# undef double 9593#endif 9594 9595#ifdef __cplusplus 9596} /* End of the 'extern "C"' block */ 9597#endif 9598#endif /* SQLITE3_H */ 9599