sqlite3.h revision 6ca1d4f32da73eda41ba4925e98de4411cbe75d3
1/* 2** 2001 September 15 3** 4** The author disclaims copyright to this source code. In place of 5** a legal notice, here is a blessing: 6** 7** May you do good and not evil. 8** May you find forgiveness for yourself and forgive others. 9** May you share freely, never taking more than you give. 10** 11************************************************************************* 12** This header file defines the interface that the SQLite library 13** presents to client programs. If a C-function, structure, datatype, 14** or constant definition does not appear in this file, then it is 15** not a published API of SQLite, is subject to change without 16** notice, and should not be referenced by programs that use SQLite. 17** 18** Some of the definitions that are in this file are marked as 19** "experimental". Experimental interfaces are normally new 20** features recently added to SQLite. We do not anticipate changes 21** to experimental interfaces but reserve to make minor changes if 22** 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 suppose to operate. 27** 28** The name of this file under configuration management is "sqlite.h.in". 29** The makefile makes some minor changes to this file (such as inserting 30** the version number) and changes its name to "sqlite3.h" as 31** part of the build process. 32** 33** @(#) $Id: sqlite.h.in,v 1.398 2008/09/10 13:09:24 drh Exp $ 34*/ 35#ifndef _SQLITE3_H_ 36#define _SQLITE3_H_ 37#include <stdarg.h> /* Needed for the definition of va_list */ 38 39/* 40** Make sure we can call this stuff from C++. 41*/ 42#ifdef __cplusplus 43extern "C" { 44#endif 45 46 47/* 48** Add the ability to override 'extern' 49*/ 50#ifndef SQLITE_EXTERN 51# define SQLITE_EXTERN extern 52#endif 53 54/* 55** Add the ability to mark interfaces as deprecated. 56*/ 57#if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)) 58 /* GCC added the deprecated attribute in version 3.1 */ 59 #define SQLITE_DEPRECATED __attribute__ ((deprecated)) 60#elif defined(_MSC_VER) && (_MSC_VER>1200) 61 #define SQLITE_DEPRECATED __declspec(deprecated) 62#else 63 #define SQLITE_DEPRECATED 64#endif 65 66/* 67** Add the ability to mark interfaces as experimental. 68*/ 69#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) 70 /* I can confirm that it does not work on version 4.1.0... */ 71 /* First appears in GCC docs for version 4.3.0 */ 72 #define SQLITE_EXPERIMENTAL __attribute__ ((warning ("is experimental"))) 73#elif defined(_MSC_VER) && (_MSC_VER>1200) 74 #define SQLITE_EXPERIMENTAL __declspec(deprecated("was declared experimental")) 75#else 76 #define SQLITE_EXPERIMENTAL 77#endif 78 79/* 80** Ensure these symbols were not defined by some previous header file. 81*/ 82#ifdef SQLITE_VERSION 83# undef SQLITE_VERSION 84#endif 85#ifdef SQLITE_VERSION_NUMBER 86# undef SQLITE_VERSION_NUMBER 87#endif 88 89/* 90** CAPI3REF: Compile-Time Library Version Numbers {H10010} <S60100> 91** 92** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in 93** the sqlite3.h file specify the version of SQLite with which 94** that header file is associated. 95** 96** The "version" of SQLite is a string of the form "X.Y.Z". 97** The phrase "alpha" or "beta" might be appended after the Z. 98** The X value is major version number always 3 in SQLite3. 99** The X value only changes when backwards compatibility is 100** broken and we intend to never break backwards compatibility. 101** The Y value is the minor version number and only changes when 102** there are major feature enhancements that are forwards compatible 103** but not backwards compatible. 104** The Z value is the release number and is incremented with 105** each release but resets back to 0 whenever Y is incremented. 106** 107** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()]. 108** 109** INVARIANTS: 110** 111** {H10011} The SQLITE_VERSION #define in the sqlite3.h header file shall 112** evaluate to a string literal that is the SQLite version 113** with which the header file is associated. 114** 115** {H10014} The SQLITE_VERSION_NUMBER #define shall resolve to an integer 116** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z 117** are the major version, minor version, and release number. 118*/ 119#define SQLITE_VERSION "3.6.3" 120#define SQLITE_VERSION_NUMBER 3006003 121 122/* 123** CAPI3REF: Run-Time Library Version Numbers {H10020} <S60100> 124** KEYWORDS: sqlite3_version 125** 126** These features provide the same information as the [SQLITE_VERSION] 127** and [SQLITE_VERSION_NUMBER] #defines in the header, but are associated 128** with the library instead of the header file. Cautious programmers might 129** include a check in their application to verify that 130** sqlite3_libversion_number() always returns the value 131** [SQLITE_VERSION_NUMBER]. 132** 133** The sqlite3_libversion() function returns the same information as is 134** in the sqlite3_version[] string constant. The function is provided 135** for use in DLLs since DLL users usually do not have direct access to string 136** constants within the DLL. 137** 138** INVARIANTS: 139** 140** {H10021} The [sqlite3_libversion_number()] interface shall return 141** an integer equal to [SQLITE_VERSION_NUMBER]. 142** 143** {H10022} The [sqlite3_version] string constant shall contain 144** the text of the [SQLITE_VERSION] string. 145** 146** {H10023} The [sqlite3_libversion()] function shall return 147** a pointer to the [sqlite3_version] string constant. 148*/ 149SQLITE_EXTERN const char sqlite3_version[]; 150const char *sqlite3_libversion(void); 151int sqlite3_libversion_number(void); 152 153/* 154** CAPI3REF: Test To See If The Library Is Threadsafe {H10100} <S60100> 155** 156** SQLite can be compiled with or without mutexes. When 157** the [SQLITE_THREADSAFE] C preprocessor macro 1 or 2, mutexes 158** are enabled and SQLite is threadsafe. When the 159** [SQLITE_THREADSAFE] macro is 0, 160** the mutexes are omitted. Without the mutexes, it is not safe 161** to use SQLite concurrently from more than one thread. 162** 163** Enabling mutexes incurs a measurable performance penalty. 164** So if speed is of utmost importance, it makes sense to disable 165** the mutexes. But for maximum safety, mutexes should be enabled. 166** The default behavior is for mutexes to be enabled. 167** 168** This interface can be used by a program to make sure that the 169** version of SQLite that it is linking against was compiled with 170** the desired setting of the [SQLITE_THREADSAFE] macro. 171** 172** This interface only reports on the compile-time mutex setting 173** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with 174** SQLITE_THREADSAFE=1 then mutexes are enabled by default but 175** can be fully or partially disabled using a call to [sqlite3_config()] 176** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], 177** or [SQLITE_CONFIG_MUTEX]. The return value of this function shows 178** only the default compile-time setting, not any run-time changes 179** to that setting. 180** 181** See the [threading mode] documentation for additional information. 182** 183** INVARIANTS: 184** 185** {H10101} The [sqlite3_threadsafe()] function shall return nonzero if 186** and only if 187** SQLite was compiled with the its mutexes enabled by default. 188** 189** {H10102} The value returned by the [sqlite3_threadsafe()] function 190** shall not change when mutex setting are modified at 191** runtime using the [sqlite3_config()] interface and 192** especially the [SQLITE_CONFIG_SINGLETHREAD], 193** [SQLITE_CONFIG_MULTITHREAD], [SQLITE_CONFIG_SERIALIZED], 194** and [SQLITE_CONFIG_MUTEX] verbs. 195*/ 196int sqlite3_threadsafe(void); 197 198/* 199** CAPI3REF: Database Connection Handle {H12000} <S40200> 200** KEYWORDS: {database connection} {database connections} 201** 202** Each open SQLite database is represented by a pointer to an instance of 203** the opaque structure named "sqlite3". It is useful to think of an sqlite3 204** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 205** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 206** is its destructor. There are many other interfaces (such as 207** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 208** [sqlite3_busy_timeout()] to name but three) that are methods on an 209** sqlite3 object. 210*/ 211typedef struct sqlite3 sqlite3; 212 213/* 214** CAPI3REF: 64-Bit Integer Types {H10200} <S10110> 215** KEYWORDS: sqlite_int64 sqlite_uint64 216** 217** Because there is no cross-platform way to specify 64-bit integer types 218** SQLite includes typedefs for 64-bit signed and unsigned integers. 219** 220** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. 221** The sqlite_int64 and sqlite_uint64 types are supported for backwards 222** compatibility only. 223** 224** INVARIANTS: 225** 226** {H10201} The [sqlite_int64] and [sqlite3_int64] type shall specify 227** a 64-bit signed integer. 228** 229** {H10202} The [sqlite_uint64] and [sqlite3_uint64] type shall specify 230** a 64-bit unsigned integer. 231*/ 232#ifdef SQLITE_INT64_TYPE 233 typedef SQLITE_INT64_TYPE sqlite_int64; 234 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; 235#elif defined(_MSC_VER) || defined(__BORLANDC__) 236 typedef __int64 sqlite_int64; 237 typedef unsigned __int64 sqlite_uint64; 238#else 239 typedef long long int sqlite_int64; 240 typedef unsigned long long int sqlite_uint64; 241#endif 242typedef sqlite_int64 sqlite3_int64; 243typedef sqlite_uint64 sqlite3_uint64; 244 245/* 246** If compiling for a processor that lacks floating point support, 247** substitute integer for floating-point. 248*/ 249#ifdef SQLITE_OMIT_FLOATING_POINT 250# define double sqlite3_int64 251#endif 252 253/* 254** CAPI3REF: Closing A Database Connection {H12010} <S30100><S40200> 255** 256** This routine is the destructor for the [sqlite3] object. 257** 258** Applications should [sqlite3_finalize | finalize] all [prepared statements] 259** and [sqlite3_blob_close | close] all [BLOB handles] associated with 260** the [sqlite3] object prior to attempting to close the object. 261** The [sqlite3_next_stmt()] interface can be used to locate all 262** [prepared statements] associated with a [database connection] if desired. 263** Typical code might look like this: 264** 265** <blockquote><pre> 266** sqlite3_stmt *pStmt; 267** while( (pStmt = sqlite3_next_stmt(db, 0))!=0 ){ 268** sqlite3_finalize(pStmt); 269** } 270** </pre></blockquote> 271** 272** If [sqlite3_close()] is invoked while a transaction is open, 273** the transaction is automatically rolled back. 274** 275** INVARIANTS: 276** 277** {H12011} A successful call to [sqlite3_close(C)] shall destroy the 278** [database connection] object C. 279** 280** {H12012} A successful call to [sqlite3_close(C)] shall return SQLITE_OK. 281** 282** {H12013} A successful call to [sqlite3_close(C)] shall release all 283** memory and system resources associated with [database connection] 284** C. 285** 286** {H12014} A call to [sqlite3_close(C)] on a [database connection] C that 287** has one or more open [prepared statements] shall fail with 288** an [SQLITE_BUSY] error code. 289** 290** {H12015} A call to [sqlite3_close(C)] where C is a NULL pointer shall 291** return SQLITE_OK. 292** 293** {H12019} When [sqlite3_close(C)] is invoked on a [database connection] C 294** that has a pending transaction, the transaction shall be 295** rolled back. 296** 297** ASSUMPTIONS: 298** 299** {A12016} The C parameter to [sqlite3_close(C)] must be either a NULL 300** pointer or an [sqlite3] object pointer obtained 301** from [sqlite3_open()], [sqlite3_open16()], or 302** [sqlite3_open_v2()], and not previously closed. 303*/ 304int sqlite3_close(sqlite3 *); 305 306/* 307** The type for a callback function. 308** This is legacy and deprecated. It is included for historical 309** compatibility and is not documented. 310*/ 311typedef int (*sqlite3_callback)(void*,int,char**, char**); 312 313/* 314** CAPI3REF: One-Step Query Execution Interface {H12100} <S10000> 315** 316** The sqlite3_exec() interface is a convenient way of running one or more 317** SQL statements without having to write a lot of C code. The UTF-8 encoded 318** SQL statements are passed in as the second parameter to sqlite3_exec(). 319** The statements are evaluated one by one until either an error or 320** an interrupt is encountered, or until they are all done. The 3rd parameter 321** is an optional callback that is invoked once for each row of any query 322** results produced by the SQL statements. The 5th parameter tells where 323** to write any error messages. 324** 325** The error message passed back through the 5th parameter is held 326** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak, 327** the calling application should call [sqlite3_free()] on any error 328** message returned through the 5th parameter when it has finished using 329** the error message. 330** 331** If the SQL statement in the 2nd parameter is NULL or an empty string 332** or a string containing only whitespace and comments, then no SQL 333** statements are evaluated and the database is not changed. 334** 335** The sqlite3_exec() interface is implemented in terms of 336** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. 337** The sqlite3_exec() routine does nothing to the database that cannot be done 338** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. 339** 340** INVARIANTS: 341** 342** {H12101} A successful invocation of [sqlite3_exec(D,S,C,A,E)] 343** shall sequentially evaluate all of the UTF-8 encoded, 344** semicolon-separated SQL statements in the zero-terminated 345** string S within the context of the [database connection] D. 346** 347** {H12102} If the S parameter to [sqlite3_exec(D,S,C,A,E)] is NULL then 348** the actions of the interface shall be the same as if the 349** S parameter were an empty string. 350** 351** {H12104} The return value of [sqlite3_exec()] shall be [SQLITE_OK] if all 352** SQL statements run successfully and to completion. 353** 354** {H12105} The return value of [sqlite3_exec()] shall be an appropriate 355** non-zero [error code] if any SQL statement fails. 356** 357** {H12107} If one or more of the SQL statements handed to [sqlite3_exec()] 358** return results and the 3rd parameter is not NULL, then 359** the callback function specified by the 3rd parameter shall be 360** invoked once for each row of result. 361** 362** {H12110} If the callback returns a non-zero value then [sqlite3_exec()] 363** shall abort the SQL statement it is currently evaluating, 364** skip all subsequent SQL statements, and return [SQLITE_ABORT]. 365** 366** {H12113} The [sqlite3_exec()] routine shall pass its 4th parameter through 367** as the 1st parameter of the callback. 368** 369** {H12116} The [sqlite3_exec()] routine shall set the 2nd parameter of its 370** callback to be the number of columns in the current row of 371** result. 372** 373** {H12119} The [sqlite3_exec()] routine shall set the 3rd parameter of its 374** callback to be an array of pointers to strings holding the 375** values for each column in the current result set row as 376** obtained from [sqlite3_column_text()]. 377** 378** {H12122} The [sqlite3_exec()] routine shall set the 4th parameter of its 379** callback to be an array of pointers to strings holding the 380** names of result columns as obtained from [sqlite3_column_name()]. 381** 382** {H12125} If the 3rd parameter to [sqlite3_exec()] is NULL then 383** [sqlite3_exec()] shall silently discard query results. 384** 385** {H12131} If an error occurs while parsing or evaluating any of the SQL 386** statements in the S parameter of [sqlite3_exec(D,S,C,A,E)] and if 387** the E parameter is not NULL, then [sqlite3_exec()] shall store 388** in *E an appropriate error message written into memory obtained 389** from [sqlite3_malloc()]. 390** 391** {H12134} The [sqlite3_exec(D,S,C,A,E)] routine shall set the value of 392** *E to NULL if E is not NULL and there are no errors. 393** 394** {H12137} The [sqlite3_exec(D,S,C,A,E)] function shall set the [error code] 395** and message accessible via [sqlite3_errcode()], 396** [sqlite3_errmsg()], and [sqlite3_errmsg16()]. 397** 398** {H12138} If the S parameter to [sqlite3_exec(D,S,C,A,E)] is NULL or an 399** empty string or contains nothing other than whitespace, comments, 400** and/or semicolons, then results of [sqlite3_errcode()], 401** [sqlite3_errmsg()], and [sqlite3_errmsg16()] 402** shall reset to indicate no errors. 403** 404** ASSUMPTIONS: 405** 406** {A12141} The first parameter to [sqlite3_exec()] must be an valid and open 407** [database connection]. 408** 409** {A12142} The database connection must not be closed while 410** [sqlite3_exec()] is running. 411** 412** {A12143} The calling function should use [sqlite3_free()] to free 413** the memory that *errmsg is left pointing at once the error 414** message is no longer needed. 415** 416** {A12145} The SQL statement text in the 2nd parameter to [sqlite3_exec()] 417** must remain unchanged while [sqlite3_exec()] is running. 418*/ 419int sqlite3_exec( 420 sqlite3*, /* An open database */ 421 const char *sql, /* SQL to be evaluated */ 422 int (*callback)(void*,int,char**,char**), /* Callback function */ 423 void *, /* 1st argument to callback */ 424 char **errmsg /* Error msg written here */ 425); 426 427/* 428** CAPI3REF: Result Codes {H10210} <S10700> 429** KEYWORDS: SQLITE_OK {error code} {error codes} 430** KEYWORDS: {result code} {result codes} 431** 432** Many SQLite functions return an integer result code from the set shown 433** here in order to indicates success or failure. 434** 435** New error codes may be added in future versions of SQLite. 436** 437** See also: [SQLITE_IOERR_READ | extended result codes] 438*/ 439#define SQLITE_OK 0 /* Successful result */ 440/* beginning-of-error-codes */ 441#define SQLITE_ERROR 1 /* SQL error or missing database */ 442#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 443#define SQLITE_PERM 3 /* Access permission denied */ 444#define SQLITE_ABORT 4 /* Callback routine requested an abort */ 445#define SQLITE_BUSY 5 /* The database file is locked */ 446#define SQLITE_LOCKED 6 /* A table in the database is locked */ 447#define SQLITE_NOMEM 7 /* A malloc() failed */ 448#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 449#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 450#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 451#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 452#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */ 453#define SQLITE_FULL 13 /* Insertion failed because database is full */ 454#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 455#define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */ 456#define SQLITE_EMPTY 16 /* Database is empty */ 457#define SQLITE_SCHEMA 17 /* The database schema changed */ 458#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 459#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 460#define SQLITE_MISMATCH 20 /* Data type mismatch */ 461#define SQLITE_MISUSE 21 /* Library used incorrectly */ 462#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 463#define SQLITE_AUTH 23 /* Authorization denied */ 464#define SQLITE_FORMAT 24 /* Auxiliary database format error */ 465#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 466#define SQLITE_NOTADB 26 /* File opened that is not a database file */ 467#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 468#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 469/* end-of-error-codes */ 470 471/* 472** CAPI3REF: Extended Result Codes {H10220} <S10700> 473** KEYWORDS: {extended error code} {extended error codes} 474** KEYWORDS: {extended result code} {extended result codes} 475** 476** In its default configuration, SQLite API routines return one of 26 integer 477** [SQLITE_OK | result codes]. However, experience has shown that many of 478** these result codes are too coarse-grained. They do not provide as 479** much information about problems as programmers might like. In an effort to 480** address this, newer versions of SQLite (version 3.3.8 and later) include 481** support for additional result codes that provide more detailed information 482** about errors. The extended result codes are enabled or disabled 483** on a per database connection basis using the 484** [sqlite3_extended_result_codes()] API. 485** 486** Some of the available extended result codes are listed here. 487** One may expect the number of extended result codes will be expand 488** over time. Software that uses extended result codes should expect 489** to see new result codes in future releases of SQLite. 490** 491** The SQLITE_OK result code will never be extended. It will always 492** be exactly zero. 493** 494** INVARIANTS: 495** 496** {H10223} The symbolic name for an extended result code shall contains 497** a related primary result code as a prefix. 498** 499** {H10224} Primary result code names shall contain a single "_" character. 500** 501** {H10225} Extended result code names shall contain two or more "_" characters. 502** 503** {H10226} The numeric value of an extended result code shall contain the 504** numeric value of its corresponding primary result code in 505** its least significant 8 bits. 506*/ 507#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 508#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 509#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 510#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 511#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 512#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 513#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 514#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 515#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 516#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 517#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 518#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 519#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 520#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 521#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 522 523/* 524** CAPI3REF: Flags For File Open Operations {H10230} <H11120> <H12700> 525** 526** These bit values are intended for use in the 527** 3rd parameter to the [sqlite3_open_v2()] interface and 528** in the 4th parameter to the xOpen method of the 529** [sqlite3_vfs] object. 530*/ 531#define SQLITE_OPEN_READONLY 0x00000001 532#define SQLITE_OPEN_READWRITE 0x00000002 533#define SQLITE_OPEN_CREATE 0x00000004 534#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 535#define SQLITE_OPEN_EXCLUSIVE 0x00000010 536#define SQLITE_OPEN_MAIN_DB 0x00000100 537#define SQLITE_OPEN_TEMP_DB 0x00000200 538#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 539#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 540#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 541#define SQLITE_OPEN_SUBJOURNAL 0x00002000 542#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 543#define SQLITE_OPEN_NOMUTEX 0x00008000 544#define SQLITE_OPEN_FULLMUTEX 0x00010000 545 546/* 547** CAPI3REF: Device Characteristics {H10240} <H11120> 548** 549** The xDeviceCapabilities method of the [sqlite3_io_methods] 550** object returns an integer which is a vector of the these 551** bit values expressing I/O characteristics of the mass storage 552** device that holds the file that the [sqlite3_io_methods] 553** refers to. 554** 555** The SQLITE_IOCAP_ATOMIC property means that all writes of 556** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 557** mean that writes of blocks that are nnn bytes in size and 558** are aligned to an address which is an integer multiple of 559** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 560** that when data is appended to a file, the data is appended 561** first then the size of the file is extended, never the other 562** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 563** information is written to disk in the same order as calls 564** to xWrite(). 565*/ 566#define SQLITE_IOCAP_ATOMIC 0x00000001 567#define SQLITE_IOCAP_ATOMIC512 0x00000002 568#define SQLITE_IOCAP_ATOMIC1K 0x00000004 569#define SQLITE_IOCAP_ATOMIC2K 0x00000008 570#define SQLITE_IOCAP_ATOMIC4K 0x00000010 571#define SQLITE_IOCAP_ATOMIC8K 0x00000020 572#define SQLITE_IOCAP_ATOMIC16K 0x00000040 573#define SQLITE_IOCAP_ATOMIC32K 0x00000080 574#define SQLITE_IOCAP_ATOMIC64K 0x00000100 575#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 576#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 577 578/* 579** CAPI3REF: File Locking Levels {H10250} <H11120> <H11310> 580** 581** SQLite uses one of these integer values as the second 582** argument to calls it makes to the xLock() and xUnlock() methods 583** of an [sqlite3_io_methods] object. 584*/ 585#define SQLITE_LOCK_NONE 0 586#define SQLITE_LOCK_SHARED 1 587#define SQLITE_LOCK_RESERVED 2 588#define SQLITE_LOCK_PENDING 3 589#define SQLITE_LOCK_EXCLUSIVE 4 590 591/* 592** CAPI3REF: Synchronization Type Flags {H10260} <H11120> 593** 594** When SQLite invokes the xSync() method of an 595** [sqlite3_io_methods] object it uses a combination of 596** these integer values as the second argument. 597** 598** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 599** sync operation only needs to flush data to mass storage. Inode 600** information need not be flushed. The SQLITE_SYNC_NORMAL flag means 601** to use normal fsync() semantics. The SQLITE_SYNC_FULL flag means 602** to use Mac OS-X style fullsync instead of fsync(). 603*/ 604#define SQLITE_SYNC_NORMAL 0x00002 605#define SQLITE_SYNC_FULL 0x00003 606#define SQLITE_SYNC_DATAONLY 0x00010 607 608/* 609** CAPI3REF: OS Interface Open File Handle {H11110} <S20110> 610** 611** An [sqlite3_file] object represents an open file in the OS 612** interface layer. Individual OS interface implementations will 613** want to subclass this object by appending additional fields 614** for their own use. The pMethods entry is a pointer to an 615** [sqlite3_io_methods] object that defines methods for performing 616** I/O operations on the open file. 617*/ 618typedef struct sqlite3_file sqlite3_file; 619struct sqlite3_file { 620 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 621}; 622 623/* 624** CAPI3REF: OS Interface File Virtual Methods Object {H11120} <S20110> 625** 626** Every file opened by the [sqlite3_vfs] xOpen method populates an 627** [sqlite3_file] object (or, more commonly, a subclass of the 628** [sqlite3_file] object) with a pointer to an instance of this object. 629** This object defines the methods used to perform various operations 630** against the open file represented by the [sqlite3_file] object. 631** 632** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 633** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 634** The second choice is a Mac OS-X style fullsync. The [SQLITE_SYNC_DATAONLY] 635** flag may be ORed in to indicate that only the data of the file 636** and not its inode needs to be synced. 637** 638** The integer values to xLock() and xUnlock() are one of 639** <ul> 640** <li> [SQLITE_LOCK_NONE], 641** <li> [SQLITE_LOCK_SHARED], 642** <li> [SQLITE_LOCK_RESERVED], 643** <li> [SQLITE_LOCK_PENDING], or 644** <li> [SQLITE_LOCK_EXCLUSIVE]. 645** </ul> 646** xLock() increases the lock. xUnlock() decreases the lock. 647** The xCheckReservedLock() method checks whether any database connection, 648** either in this process or in some other process, is holding a RESERVED, 649** PENDING, or EXCLUSIVE lock on the file. It returns true 650** if such a lock exists and false otherwise. 651** 652** The xFileControl() method is a generic interface that allows custom 653** VFS implementations to directly control an open file using the 654** [sqlite3_file_control()] interface. The second "op" argument is an 655** integer opcode. The third argument is a generic pointer intended to 656** point to a structure that may contain arguments or space in which to 657** write return values. Potential uses for xFileControl() might be 658** functions to enable blocking locks with timeouts, to change the 659** locking strategy (for example to use dot-file locks), to inquire 660** about the status of a lock, or to break stale locks. The SQLite 661** core reserves all opcodes less than 100 for its own use. 662** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. 663** Applications that define a custom xFileControl method should use opcodes 664** greater than 100 to avoid conflicts. 665** 666** The xSectorSize() method returns the sector size of the 667** device that underlies the file. The sector size is the 668** minimum write that can be performed without disturbing 669** other bytes in the file. The xDeviceCharacteristics() 670** method returns a bit vector describing behaviors of the 671** underlying device: 672** 673** <ul> 674** <li> [SQLITE_IOCAP_ATOMIC] 675** <li> [SQLITE_IOCAP_ATOMIC512] 676** <li> [SQLITE_IOCAP_ATOMIC1K] 677** <li> [SQLITE_IOCAP_ATOMIC2K] 678** <li> [SQLITE_IOCAP_ATOMIC4K] 679** <li> [SQLITE_IOCAP_ATOMIC8K] 680** <li> [SQLITE_IOCAP_ATOMIC16K] 681** <li> [SQLITE_IOCAP_ATOMIC32K] 682** <li> [SQLITE_IOCAP_ATOMIC64K] 683** <li> [SQLITE_IOCAP_SAFE_APPEND] 684** <li> [SQLITE_IOCAP_SEQUENTIAL] 685** </ul> 686** 687** The SQLITE_IOCAP_ATOMIC property means that all writes of 688** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 689** mean that writes of blocks that are nnn bytes in size and 690** are aligned to an address which is an integer multiple of 691** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 692** that when data is appended to a file, the data is appended 693** first then the size of the file is extended, never the other 694** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 695** information is written to disk in the same order as calls 696** to xWrite(). 697*/ 698typedef struct sqlite3_io_methods sqlite3_io_methods; 699struct sqlite3_io_methods { 700 int iVersion; 701 int (*xClose)(sqlite3_file*); 702 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); 703 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 704 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 705 int (*xSync)(sqlite3_file*, int flags); 706 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 707 int (*xLock)(sqlite3_file*, int); 708 int (*xUnlock)(sqlite3_file*, int); 709 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 710 int (*xFileControl)(sqlite3_file*, int op, void *pArg); 711 int (*xSectorSize)(sqlite3_file*); 712 int (*xDeviceCharacteristics)(sqlite3_file*); 713 /* Additional methods may be added in future releases */ 714}; 715 716/* 717** CAPI3REF: Standard File Control Opcodes {H11310} <S30800> 718** 719** These integer constants are opcodes for the xFileControl method 720** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 721** interface. 722** 723** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 724** opcode causes the xFileControl method to write the current state of 725** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 726** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 727** into an integer that the pArg argument points to. This capability 728** is used during testing and only needs to be supported when SQLITE_TEST 729** is defined. 730*/ 731#define SQLITE_FCNTL_LOCKSTATE 1 732 733/* 734** CAPI3REF: Mutex Handle {H17110} <S20130> 735** 736** The mutex module within SQLite defines [sqlite3_mutex] to be an 737** abstract type for a mutex object. The SQLite core never looks 738** at the internal representation of an [sqlite3_mutex]. It only 739** deals with pointers to the [sqlite3_mutex] object. 740** 741** Mutexes are created using [sqlite3_mutex_alloc()]. 742*/ 743typedef struct sqlite3_mutex sqlite3_mutex; 744 745/* 746** CAPI3REF: OS Interface Object {H11140} <S20100> 747** 748** An instance of the sqlite3_vfs object defines the interface between 749** the SQLite core and the underlying operating system. The "vfs" 750** in the name of the object stands for "virtual file system". 751** 752** The value of the iVersion field is initially 1 but may be larger in 753** future versions of SQLite. Additional fields may be appended to this 754** object when the iVersion value is increased. Note that the structure 755** of the sqlite3_vfs object changes in the transaction between 756** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not 757** modified. 758** 759** The szOsFile field is the size of the subclassed [sqlite3_file] 760** structure used by this VFS. mxPathname is the maximum length of 761** a pathname in this VFS. 762** 763** Registered sqlite3_vfs objects are kept on a linked list formed by 764** the pNext pointer. The [sqlite3_vfs_register()] 765** and [sqlite3_vfs_unregister()] interfaces manage this list 766** in a thread-safe way. The [sqlite3_vfs_find()] interface 767** searches the list. Neither the application code nor the VFS 768** implementation should use the pNext pointer. 769** 770** The pNext field is the only field in the sqlite3_vfs 771** structure that SQLite will ever modify. SQLite will only access 772** or modify this field while holding a particular static mutex. 773** The application should never modify anything within the sqlite3_vfs 774** object once the object has been registered. 775** 776** The zName field holds the name of the VFS module. The name must 777** be unique across all VFS modules. 778** 779** {H11141} SQLite will guarantee that the zFilename parameter to xOpen 780** is either a NULL pointer or string obtained 781** from xFullPathname(). SQLite further guarantees that 782** the string will be valid and unchanged until xClose() is 783** called. {END} Because of the previous sentense, 784** the [sqlite3_file] can safely store a pointer to the 785** filename if it needs to remember the filename for some reason. 786** If the zFilename parameter is xOpen is a NULL pointer then xOpen 787** must invite its own temporary name for the file. Whenever the 788** xFilename parameter is NULL it will also be the case that the 789** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 790** 791** {H11142} The flags argument to xOpen() includes all bits set in 792** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 793** or [sqlite3_open16()] is used, then flags includes at least 794** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. {END} 795** If xOpen() opens a file read-only then it sets *pOutFlags to 796** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 797** 798** {H11143} SQLite will also add one of the following flags to the xOpen() 799** call, depending on the object being opened: 800** 801** <ul> 802** <li> [SQLITE_OPEN_MAIN_DB] 803** <li> [SQLITE_OPEN_MAIN_JOURNAL] 804** <li> [SQLITE_OPEN_TEMP_DB] 805** <li> [SQLITE_OPEN_TEMP_JOURNAL] 806** <li> [SQLITE_OPEN_TRANSIENT_DB] 807** <li> [SQLITE_OPEN_SUBJOURNAL] 808** <li> [SQLITE_OPEN_MASTER_JOURNAL] 809** </ul> {END} 810** 811** The file I/O implementation can use the object type flags to 812** change the way it deals with files. For example, an application 813** that does not care about crash recovery or rollback might make 814** the open of a journal file a no-op. Writes to this journal would 815** also be no-ops, and any attempt to read the journal would return 816** SQLITE_IOERR. Or the implementation might recognize that a database 817** file will be doing page-aligned sector reads and writes in a random 818** order and set up its I/O subsystem accordingly. 819** 820** SQLite might also add one of the following flags to the xOpen method: 821** 822** <ul> 823** <li> [SQLITE_OPEN_DELETEONCLOSE] 824** <li> [SQLITE_OPEN_EXCLUSIVE] 825** </ul> 826** 827** {H11145} The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 828** deleted when it is closed. {H11146} The [SQLITE_OPEN_DELETEONCLOSE] 829** will be set for TEMP databases, journals and for subjournals. 830** 831** {H11147} The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened 832** for exclusive access. This flag is set for all files except 833** for the main database file. 834** 835** {H11148} At least szOsFile bytes of memory are allocated by SQLite 836** to hold the [sqlite3_file] structure passed as the third 837** argument to xOpen. {END} The xOpen method does not have to 838** allocate the structure; it should just fill it in. 839** 840** {H11149} The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 841** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 842** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 843** to test whether a file is at least readable. {END} The file can be a 844** directory. 845** 846** {H11150} SQLite will always allocate at least mxPathname+1 bytes for the 847** output buffer xFullPathname. {H11151} The exact size of the output buffer 848** is also passed as a parameter to both methods. {END} If the output buffer 849** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 850** handled as a fatal error by SQLite, vfs implementations should endeavor 851** to prevent this by setting mxPathname to a sufficiently large value. 852** 853** The xRandomness(), xSleep(), and xCurrentTime() interfaces 854** are not strictly a part of the filesystem, but they are 855** included in the VFS structure for completeness. 856** The xRandomness() function attempts to return nBytes bytes 857** of good-quality randomness into zOut. The return value is 858** the actual number of bytes of randomness obtained. 859** The xSleep() method causes the calling thread to sleep for at 860** least the number of microseconds given. The xCurrentTime() 861** method returns a Julian Day Number for the current date and time. 862*/ 863typedef struct sqlite3_vfs sqlite3_vfs; 864struct sqlite3_vfs { 865 int iVersion; /* Structure version number */ 866 int szOsFile; /* Size of subclassed sqlite3_file */ 867 int mxPathname; /* Maximum file pathname length */ 868 sqlite3_vfs *pNext; /* Next registered VFS */ 869 const char *zName; /* Name of this virtual file system */ 870 void *pAppData; /* Pointer to application-specific data */ 871 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 872 int flags, int *pOutFlags); 873 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 874 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 875 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 876 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 877 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 878 void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol); 879 void (*xDlClose)(sqlite3_vfs*, void*); 880 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 881 int (*xSleep)(sqlite3_vfs*, int microseconds); 882 int (*xCurrentTime)(sqlite3_vfs*, double*); 883 int (*xGetLastError)(sqlite3_vfs*, int, char *); 884 /* New fields may be appended in figure versions. The iVersion 885 ** value will increment whenever this happens. */ 886}; 887 888/* 889** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140> 890** 891** {H11191} These integer constants can be used as the third parameter to 892** the xAccess method of an [sqlite3_vfs] object. {END} They determine 893** what kind of permissions the xAccess method is looking for. 894** {H11192} With SQLITE_ACCESS_EXISTS, the xAccess method 895** simply checks whether the file exists. 896** {H11193} With SQLITE_ACCESS_READWRITE, the xAccess method 897** checks whether the file is both readable and writable. 898** {H11194} With SQLITE_ACCESS_READ, the xAccess method 899** checks whether the file is readable. 900*/ 901#define SQLITE_ACCESS_EXISTS 0 902#define SQLITE_ACCESS_READWRITE 1 903#define SQLITE_ACCESS_READ 2 904 905/* 906** CAPI3REF: Initialize The SQLite Library {H10130} <S20000><S30100> 907** 908** The sqlite3_initialize() routine initializes the 909** SQLite library. The sqlite3_shutdown() routine 910** deallocates any resources that were allocated by sqlite3_initialize(). 911** 912** A call to sqlite3_initialize() is an "effective" call if it is 913** the first time sqlite3_initialize() is invoked during the lifetime of 914** the process, or if it is the first time sqlite3_initialize() is invoked 915** following a call to sqlite3_shutdown(). Only an effective call 916** of sqlite3_initialize() does any initialization. All other calls 917** are harmless no-ops. 918** 919** Among other things, sqlite3_initialize() shall invoke 920** sqlite3_os_init(). Similarly, sqlite3_shutdown() 921** shall invoke sqlite3_os_end(). 922** 923** The sqlite3_initialize() routine returns SQLITE_OK on success. 924** If for some reason, sqlite3_initialize() is unable to initialize 925** the library (perhaps it is unable to allocate a needed resource such 926** as a mutex) it returns an [error code] other than SQLITE_OK. 927** 928** The sqlite3_initialize() routine is called internally by many other 929** SQLite interfaces so that an application usually does not need to 930** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 931** calls sqlite3_initialize() so the SQLite library will be automatically 932** initialized when [sqlite3_open()] is called if it has not be initialized 933** already. However, if SQLite is compiled with the SQLITE_OMIT_AUTOINIT 934** compile-time option, then the automatic calls to sqlite3_initialize() 935** are omitted and the application must call sqlite3_initialize() directly 936** prior to using any other SQLite interface. For maximum portability, 937** it is recommended that applications always invoke sqlite3_initialize() 938** directly prior to using any other SQLite interface. Future releases 939** of SQLite may require this. In other words, the behavior exhibited 940** when SQLite is compiled with SQLITE_OMIT_AUTOINIT might become the 941** default behavior in some future release of SQLite. 942** 943** The sqlite3_os_init() routine does operating-system specific 944** initialization of the SQLite library. The sqlite3_os_end() 945** routine undoes the effect of sqlite3_os_init(). Typical tasks 946** performed by these routines include allocation or deallocation 947** of static resources, initialization of global variables, 948** setting up a default [sqlite3_vfs] module, or setting up 949** a default configuration using [sqlite3_config()]. 950** 951** The application should never invoke either sqlite3_os_init() 952** or sqlite3_os_end() directly. The application should only invoke 953** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() 954** interface is called automatically by sqlite3_initialize() and 955** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate 956** implementations for sqlite3_os_init() and sqlite3_os_end() 957** are built into SQLite when it is compiled for unix, windows, or os/2. 958** When built for other platforms (using the SQLITE_OS_OTHER=1 compile-time 959** option) the application must supply a suitable implementation for 960** sqlite3_os_init() and sqlite3_os_end(). An application-supplied 961** implementation of sqlite3_os_init() or sqlite3_os_end() 962** must return SQLITE_OK on success and some other [error code] upon 963** failure. 964*/ 965int sqlite3_initialize(void); 966int sqlite3_shutdown(void); 967int sqlite3_os_init(void); 968int sqlite3_os_end(void); 969 970/* 971** CAPI3REF: Configuring The SQLite Library {H10145} <S20000><S30200> 972** EXPERIMENTAL 973** 974** The sqlite3_config() interface is used to make global configuration 975** changes to SQLite in order to tune SQLite to the specific needs of 976** the application. The default configuration is recommended for most 977** applications and so this routine is usually not necessary. It is 978** provided to support rare applications with unusual needs. 979** 980** The sqlite3_config() interface is not threadsafe. The application 981** must insure that no other SQLite interfaces are invoked by other 982** threads while sqlite3_config() is running. Furthermore, sqlite3_config() 983** may only be invoked prior to library initialization using 984** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 985** Note, however, that sqlite3_config() can be called as part of the 986** implementation of an application-defined [sqlite3_os_init()]. 987** 988** The first argument to sqlite3_config() is an integer 989** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines 990** what property of SQLite is to be configured. Subsequent arguments 991** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] 992** in the first argument. 993** 994** When a configuration option is set, sqlite3_config() returns SQLITE_OK. 995** If the option is unknown or SQLite is unable to set the option 996** then this routine returns a non-zero [error code]. 997*/ 998SQLITE_EXPERIMENTAL int sqlite3_config(int, ...); 999 1000/* 1001** CAPI3REF: Configure database connections {H10180} <S20000> 1002** EXPERIMENTAL 1003** 1004** The sqlite3_db_config() interface is used to make configuration 1005** changes to a [database connection]. The interface is similar to 1006** [sqlite3_config()] except that the changes apply to a single 1007** [database connection] (specified in the first argument). The 1008** sqlite3_db_config() interface can only be used immediately after 1009** the database connection is created using [sqlite3_open()], 1010** [sqlite3_open16()], or [sqlite3_open_v2()]. 1011** 1012** The second argument to sqlite3_db_config(D,V,...) is the 1013** configuration verb - an integer code that indicates what 1014** aspect of the [database connection] is being configured. 1015** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE]. 1016** New verbs are likely to be added in future releases of SQLite. 1017** Additional arguments depend on the verb. 1018*/ 1019SQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...); 1020 1021/* 1022** CAPI3REF: Memory Allocation Routines {H10155} <S20120> 1023** EXPERIMENTAL 1024** 1025** An instance of this object defines the interface between SQLite 1026** and low-level memory allocation routines. 1027** 1028** This object is used in only one place in the SQLite interface. 1029** A pointer to an instance of this object is the argument to 1030** [sqlite3_config()] when the configuration option is 1031** [SQLITE_CONFIG_MALLOC]. By creating an instance of this object 1032** and passing it to [sqlite3_config()] during configuration, an 1033** application can specify an alternative memory allocation subsystem 1034** for SQLite to use for all of its dynamic memory needs. 1035** 1036** Note that SQLite comes with a built-in memory allocator that is 1037** perfectly adequate for the overwhelming majority of applications 1038** and that this object is only useful to a tiny minority of applications 1039** with specialized memory allocation requirements. This object is 1040** also used during testing of SQLite in order to specify an alternative 1041** memory allocator that simulates memory out-of-memory conditions in 1042** order to verify that SQLite recovers gracefully from such 1043** conditions. 1044** 1045** The xMalloc, xFree, and xRealloc methods must work like the 1046** malloc(), free(), and realloc() functions from the standard library. 1047** 1048** xSize should return the allocated size of a memory allocation 1049** previously obtained from xMalloc or xRealloc. The allocated size 1050** is always at least as big as the requested size but may be larger. 1051** 1052** The xRoundup method returns what would be the allocated size of 1053** a memory allocation given a particular requested size. Most memory 1054** allocators round up memory allocations at least to the next multiple 1055** of 8. Some allocators round up to a larger multiple or to a power of 2. 1056** 1057** The xInit method initializes the memory allocator. (For example, 1058** it might allocate any require mutexes or initialize internal data 1059** structures. The xShutdown method is invoked (indirectly) by 1060** [sqlite3_shutdown()] and should deallocate any resources acquired 1061** by xInit. The pAppData pointer is used as the only parameter to 1062** xInit and xShutdown. 1063*/ 1064typedef struct sqlite3_mem_methods sqlite3_mem_methods; 1065struct sqlite3_mem_methods { 1066 void *(*xMalloc)(int); /* Memory allocation function */ 1067 void (*xFree)(void*); /* Free a prior allocation */ 1068 void *(*xRealloc)(void*,int); /* Resize an allocation */ 1069 int (*xSize)(void*); /* Return the size of an allocation */ 1070 int (*xRoundup)(int); /* Round up request size to allocation size */ 1071 int (*xInit)(void*); /* Initialize the memory allocator */ 1072 void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1073 void *pAppData; /* Argument to xInit() and xShutdown() */ 1074}; 1075 1076/* 1077** CAPI3REF: Configuration Options {H10160} <S20000> 1078** EXPERIMENTAL 1079** 1080** These constants are the available integer configuration options that 1081** can be passed as the first argument to the [sqlite3_config()] interface. 1082** 1083** New configuration options may be added in future releases of SQLite. 1084** Existing configuration options might be discontinued. Applications 1085** should check the return code from [sqlite3_config()] to make sure that 1086** the call worked. The [sqlite3_config()] interface will return a 1087** non-zero [error code] if a discontinued or unsupported configuration option 1088** is invoked. 1089** 1090** <dl> 1091** <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1092** <dd>There are no arguments to this option. This option disables 1093** all mutexing and puts SQLite into a mode where it can only be used 1094** by a single thread.</dd> 1095** 1096** <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1097** <dd>There are no arguments to this option. This option disables 1098** mutexing on [database connection] and [prepared statement] objects. 1099** The application is responsible for serializing access to 1100** [database connections] and [prepared statements]. But other mutexes 1101** are enabled so that SQLite will be safe to use in a multi-threaded 1102** environment as long as no two threads attempt to use the same 1103** [database connection] at the same time. See the [threading mode] 1104** documentation for additional information.</dd> 1105** 1106** <dt>SQLITE_CONFIG_SERIALIZED</dt> 1107** <dd>There are no arguments to this option. This option enables 1108** all mutexes including the recursive 1109** mutexes on [database connection] and [prepared statement] objects. 1110** In this mode (which is the default when SQLite is compiled with 1111** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1112** to [database connections] and [prepared statements] so that the 1113** application is free to use the same [database connection] or the 1114** same [prepared statement] in different threads at the same time. 1115** See the [threading mode] documentation for additional information.</dd> 1116** 1117** <dt>SQLITE_CONFIG_MALLOC</dt> 1118** <dd>This option takes a single argument which is a pointer to an 1119** instance of the [sqlite3_mem_methods] structure. The argument specifies 1120** alternative low-level memory allocation routines to be used in place of 1121** the memory allocation routines built into SQLite.</dd> 1122** 1123** <dt>SQLITE_CONFIG_GETMALLOC</dt> 1124** <dd>This option takes a single argument which is a pointer to an 1125** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] 1126** structure is filled with the currently defined memory allocation routines. 1127** This option can be used to overload the default memory allocation 1128** routines with a wrapper that simulations memory allocation failure or 1129** tracks memory usage, for example.</dd> 1130** 1131** <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1132** <dd>This option takes single argument of type int, interpreted as a 1133** boolean, which enables or disables the collection of memory allocation 1134** statistics. When disabled, the following SQLite interfaces become 1135** non-operational: 1136** <ul> 1137** <li> [sqlite3_memory_used()] 1138** <li> [sqlite3_memory_highwater()] 1139** <li> [sqlite3_soft_heap_limit()] 1140** <li> [sqlite3_status()] 1141** </ul> 1142** </dd> 1143** 1144** <dt>SQLITE_CONFIG_SCRATCH</dt> 1145** <dd>This option specifies a static memory buffer that SQLite can use for 1146** scratch memory. There are three arguments: A pointer to the memory, the 1147** size of each scratch buffer (sz), and the number of buffers (N). The sz 1148** argument must be a multiple of 16. The sz parameter should be a few bytes 1149** larger than the actual scratch space required due internal overhead. 1150** The first 1151** argument should point to an allocation of at least sz*N bytes of memory. 1152** SQLite will use no more than one scratch buffer at once per thread, so 1153** N should be set to the expected maximum number of threads. The sz 1154** parameter should be 6 times the size of the largest database page size. 1155** Scratch buffers are used as part of the btree balance operation. If 1156** The btree balancer needs additional memory beyond what is provided by 1157** scratch buffers or if no scratch buffer space is specified, then SQLite 1158** goes to [sqlite3_malloc()] to obtain the memory it needs.</dd> 1159** 1160** <dt>SQLITE_CONFIG_PAGECACHE</dt> 1161** <dd>This option specifies a static memory buffer that SQLite can use for 1162** the database page cache. There are three arguments: A pointer to the 1163** memory, the size of each page buffer (sz), and the number of pages (N). 1164** The sz argument must be a power of two between 512 and 32768. The first 1165** argument should point to an allocation of at least sz*N bytes of memory. 1166** SQLite will use the memory provided by the first argument to satisfy its 1167** memory needs for the first N pages that it adds to cache. If additional 1168** page cache memory is needed beyond what is provided by this option, then 1169** SQLite goes to [sqlite3_malloc()] for the additional storage space. 1170** The implementation might use one or more of the N buffers to hold 1171** memory accounting information. </dd> 1172** 1173** <dt>SQLITE_CONFIG_HEAP</dt> 1174** <dd>This option specifies a static memory buffer that SQLite will use 1175** for all of its dynamic memory allocation needs beyond those provided 1176** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. 1177** There are three arguments: A pointer to the memory, the number of 1178** bytes in the memory buffer, and the minimum allocation size. If 1179** the first pointer (the memory pointer) is NULL, then SQLite reverts 1180** to using its default memory allocator (the system malloc() implementation), 1181** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the 1182** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or 1183** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory 1184** allocator is engaged to handle all of SQLites memory allocation needs.</dd> 1185** 1186** <dt>SQLITE_CONFIG_MUTEX</dt> 1187** <dd>This option takes a single argument which is a pointer to an 1188** instance of the [sqlite3_mutex_methods] structure. The argument specifies 1189** alternative low-level mutex routines to be used in place 1190** the mutex routines built into SQLite.</dd> 1191** 1192** <dt>SQLITE_CONFIG_GETMUTEX</dt> 1193** <dd>This option takes a single argument which is a pointer to an 1194** instance of the [sqlite3_mutex_methods] structure. The 1195** [sqlite3_mutex_methods] 1196** structure is filled with the currently defined mutex routines. 1197** This option can be used to overload the default mutex allocation 1198** routines with a wrapper used to track mutex usage for performance 1199** profiling or testing, for example.</dd> 1200** 1201** <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1202** <dd>This option takes two arguments that determine the default 1203** memory allcation lookaside optimization. The first argument is the 1204** size of each lookaside buffer slot and the second is the number of 1205** slots allocated to each database connection.</dd> 1206** 1207** </dl> 1208*/ 1209#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 1210#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 1211#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 1212#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 1213#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 1214#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ 1215#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 1216#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 1217#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 1218#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 1219#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 1220#define SQLITE_CONFIG_CHUNKALLOC 12 /* int threshold */ 1221#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 1222 1223/* 1224** CAPI3REF: Configuration Options {H10170} <S20000> 1225** EXPERIMENTAL 1226** 1227** These constants are the available integer configuration options that 1228** can be passed as the second argument to the [sqlite3_db_config()] interface. 1229** 1230** New configuration options may be added in future releases of SQLite. 1231** Existing configuration options might be discontinued. Applications 1232** should check the return code from [sqlite3_db_config()] to make sure that 1233** the call worked. The [sqlite3_db_config()] interface will return a 1234** non-zero [error code] if a discontinued or unsupported configuration option 1235** is invoked. 1236** 1237** <dl> 1238** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 1239** <dd>This option takes three additional arguments that determine the 1240** [lookaside memory allocator] configuration for the [database connection]. 1241** The first argument (the third parameter to [sqlite3_db_config()] is a 1242** pointer to a memory buffer to use for lookaside memory. The first 1243** argument may be NULL in which case SQLite will allocate the lookaside 1244** buffer itself using [sqlite3_malloc()]. The second argument is the 1245** size of each lookaside buffer slot and the third argument is the number of 1246** slots. The size of the buffer in the first argument must be greater than 1247** or equal to the product of the second and third arguments.</dd> 1248** 1249** </dl> 1250*/ 1251#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 1252 1253 1254/* 1255** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} <S10700> 1256** 1257** The sqlite3_extended_result_codes() routine enables or disables the 1258** [extended result codes] feature of SQLite. The extended result 1259** codes are disabled by default for historical compatibility considerations. 1260** 1261** INVARIANTS: 1262** 1263** {H12201} Each new [database connection] shall have the 1264** [extended result codes] feature disabled by default. 1265** 1266** {H12202} The [sqlite3_extended_result_codes(D,F)] interface shall enable 1267** [extended result codes] for the [database connection] D 1268** if the F parameter is true, or disable them if F is false. 1269*/ 1270int sqlite3_extended_result_codes(sqlite3*, int onoff); 1271 1272/* 1273** CAPI3REF: Last Insert Rowid {H12220} <S10700> 1274** 1275** Each entry in an SQLite table has a unique 64-bit signed 1276** integer key called the "rowid". The rowid is always available 1277** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 1278** names are not also used by explicitly declared columns. If 1279** the table has a column of type INTEGER PRIMARY KEY then that column 1280** is another alias for the rowid. 1281** 1282** This routine returns the rowid of the most recent 1283** successful INSERT into the database from the [database connection] 1284** in the first argument. If no successful INSERTs 1285** have ever occurred on that database connection, zero is returned. 1286** 1287** If an INSERT occurs within a trigger, then the rowid of the inserted 1288** row is returned by this routine as long as the trigger is running. 1289** But once the trigger terminates, the value returned by this routine 1290** reverts to the last value inserted before the trigger fired. 1291** 1292** An INSERT that fails due to a constraint violation is not a 1293** successful INSERT and does not change the value returned by this 1294** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 1295** and INSERT OR ABORT make no changes to the return value of this 1296** routine when their insertion fails. When INSERT OR REPLACE 1297** encounters a constraint violation, it does not fail. The 1298** INSERT continues to completion after deleting rows that caused 1299** the constraint problem so INSERT OR REPLACE will always change 1300** the return value of this interface. 1301** 1302** For the purposes of this routine, an INSERT is considered to 1303** be successful even if it is subsequently rolled back. 1304** 1305** INVARIANTS: 1306** 1307** {H12221} The [sqlite3_last_insert_rowid()] function returns the rowid 1308** of the most recent successful INSERT performed on the same 1309** [database connection] and within the same or higher level 1310** trigger context, or zero if there have been no qualifying inserts. 1311** 1312** {H12223} The [sqlite3_last_insert_rowid()] function returns the 1313** same value when called from the same trigger context 1314** immediately before and after a ROLLBACK. 1315** 1316** ASSUMPTIONS: 1317** 1318** {A12232} If a separate thread performs a new INSERT on the same 1319** database connection while the [sqlite3_last_insert_rowid()] 1320** function is running and thus changes the last insert rowid, 1321** then the value returned by [sqlite3_last_insert_rowid()] is 1322** unpredictable and might not equal either the old or the new 1323** last insert rowid. 1324*/ 1325sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); 1326 1327/* 1328** CAPI3REF: Count The Number Of Rows Modified {H12240} <S10600> 1329** 1330** This function returns the number of database rows that were changed 1331** or inserted or deleted by the most recently completed SQL statement 1332** on the [database connection] specified by the first parameter. 1333** Only changes that are directly specified by the INSERT, UPDATE, 1334** or DELETE statement are counted. Auxiliary changes caused by 1335** triggers are not counted. Use the [sqlite3_total_changes()] function 1336** to find the total number of changes including changes caused by triggers. 1337** 1338** A "row change" is a change to a single row of a single table 1339** caused by an INSERT, DELETE, or UPDATE statement. Rows that 1340** are changed as side effects of REPLACE constraint resolution, 1341** rollback, ABORT processing, DROP TABLE, or by any other 1342** mechanisms do not count as direct row changes. 1343** 1344** A "trigger context" is a scope of execution that begins and 1345** ends with the script of a trigger. Most SQL statements are 1346** evaluated outside of any trigger. This is the "top level" 1347** trigger context. If a trigger fires from the top level, a 1348** new trigger context is entered for the duration of that one 1349** trigger. Subtriggers create subcontexts for their duration. 1350** 1351** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does 1352** not create a new trigger context. 1353** 1354** This function returns the number of direct row changes in the 1355** most recent INSERT, UPDATE, or DELETE statement within the same 1356** trigger context. 1357** 1358** Thus, when called from the top level, this function returns the 1359** number of changes in the most recent INSERT, UPDATE, or DELETE 1360** that also occurred at the top level. Within the body of a trigger, 1361** the sqlite3_changes() interface can be called to find the number of 1362** changes in the most recently completed INSERT, UPDATE, or DELETE 1363** statement within the body of the same trigger. 1364** However, the number returned does not include changes 1365** caused by subtriggers since those have their own context. 1366** 1367** SQLite implements the command "DELETE FROM table" without a WHERE clause 1368** by dropping and recreating the table. (This is much faster than going 1369** through and deleting individual elements from the table.) Because of this 1370** optimization, the deletions in "DELETE FROM table" are not row changes and 1371** will not be counted by the sqlite3_changes() or [sqlite3_total_changes()] 1372** functions, regardless of the number of elements that were originally 1373** in the table. To get an accurate count of the number of rows deleted, use 1374** "DELETE FROM table WHERE 1" instead. 1375** 1376** INVARIANTS: 1377** 1378** {H12241} The [sqlite3_changes()] function shall return the number of 1379** row changes caused by the most recent INSERT, UPDATE, 1380** or DELETE statement on the same database connection and 1381** within the same or higher trigger context, or zero if there have 1382** not been any qualifying row changes. 1383** 1384** {H12243} Statements of the form "DELETE FROM tablename" with no 1385** WHERE clause shall cause subsequent calls to 1386** [sqlite3_changes()] to return zero, regardless of the 1387** number of rows originally in the table. 1388** 1389** ASSUMPTIONS: 1390** 1391** {A12252} If a separate thread makes changes on the same database connection 1392** while [sqlite3_changes()] is running then the value returned 1393** is unpredictable and not meaningful. 1394*/ 1395int sqlite3_changes(sqlite3*); 1396 1397/* 1398** CAPI3REF: Total Number Of Rows Modified {H12260} <S10600> 1399** 1400** This function returns the number of row changes caused by INSERT, 1401** UPDATE or DELETE statements since the [database connection] was opened. 1402** The count includes all changes from all trigger contexts. However, 1403** the count does not include changes used to implement REPLACE constraints, 1404** do rollbacks or ABORT processing, or DROP table processing. 1405** The changes are counted as soon as the statement that makes them is 1406** completed (when the statement handle is passed to [sqlite3_reset()] or 1407** [sqlite3_finalize()]). 1408** 1409** SQLite implements the command "DELETE FROM table" without a WHERE clause 1410** by dropping and recreating the table. (This is much faster than going 1411** through and deleting individual elements from the table.) Because of this 1412** optimization, the deletions in "DELETE FROM table" are not row changes and 1413** will not be counted by the sqlite3_changes() or [sqlite3_total_changes()] 1414** functions, regardless of the number of elements that were originally 1415** in the table. To get an accurate count of the number of rows deleted, use 1416** "DELETE FROM table WHERE 1" instead. 1417** 1418** See also the [sqlite3_changes()] interface. 1419** 1420** INVARIANTS: 1421** 1422** {H12261} The [sqlite3_total_changes()] returns the total number 1423** of row changes caused by INSERT, UPDATE, and/or DELETE 1424** statements on the same [database connection], in any 1425** trigger context, since the database connection was created. 1426** 1427** {H12263} Statements of the form "DELETE FROM tablename" with no 1428** WHERE clause shall not change the value returned 1429** by [sqlite3_total_changes()]. 1430** 1431** ASSUMPTIONS: 1432** 1433** {A12264} If a separate thread makes changes on the same database connection 1434** while [sqlite3_total_changes()] is running then the value 1435** returned is unpredictable and not meaningful. 1436*/ 1437int sqlite3_total_changes(sqlite3*); 1438 1439/* 1440** CAPI3REF: Interrupt A Long-Running Query {H12270} <S30500> 1441** 1442** This function causes any pending database operation to abort and 1443** return at its earliest opportunity. This routine is typically 1444** called in response to a user action such as pressing "Cancel" 1445** or Ctrl-C where the user wants a long query operation to halt 1446** immediately. 1447** 1448** It is safe to call this routine from a thread different from the 1449** thread that is currently running the database operation. But it 1450** is not safe to call this routine with a [database connection] that 1451** is closed or might close before sqlite3_interrupt() returns. 1452** 1453** If an SQL operation is very nearly finished at the time when 1454** sqlite3_interrupt() is called, then it might not have an opportunity 1455** to be interrupted and might continue to completion. 1456** 1457** An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 1458** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 1459** that is inside an explicit transaction, then the entire transaction 1460** will be rolled back automatically. 1461** 1462** A call to sqlite3_interrupt() has no effect on SQL statements 1463** that are started after sqlite3_interrupt() returns. 1464** 1465** INVARIANTS: 1466** 1467** {H12271} The [sqlite3_interrupt()] interface will force all running 1468** SQL statements associated with the same database connection 1469** to halt after processing at most one additional row of data. 1470** 1471** {H12272} Any SQL statement that is interrupted by [sqlite3_interrupt()] 1472** will return [SQLITE_INTERRUPT]. 1473** 1474** ASSUMPTIONS: 1475** 1476** {A12279} If the database connection closes while [sqlite3_interrupt()] 1477** is running then bad things will likely happen. 1478*/ 1479void sqlite3_interrupt(sqlite3*); 1480 1481/* 1482** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} <S70200> 1483** 1484** These routines are useful for command-line input to determine if the 1485** currently entered text seems to form complete a SQL statement or 1486** if additional input is needed before sending the text into 1487** SQLite for parsing. These routines return true if the input string 1488** appears to be a complete SQL statement. A statement is judged to be 1489** complete if it ends with a semicolon token and is not a fragment of a 1490** CREATE TRIGGER statement. Semicolons that are embedded within 1491** string literals or quoted identifier names or comments are not 1492** independent tokens (they are part of the token in which they are 1493** embedded) and thus do not count as a statement terminator. 1494** 1495** These routines do not parse the SQL statements thus 1496** will not detect syntactically incorrect SQL. 1497** 1498** INVARIANTS: 1499** 1500** {H10511} A successful evaluation of [sqlite3_complete()] or 1501** [sqlite3_complete16()] functions shall 1502** return a numeric 1 if and only if the last non-whitespace 1503** token in their input is a semicolon that is not in between 1504** the BEGIN and END of a CREATE TRIGGER statement. 1505** 1506** {H10512} If a memory allocation error occurs during an invocation 1507** of [sqlite3_complete()] or [sqlite3_complete16()] then the 1508** routine shall return [SQLITE_NOMEM]. 1509** 1510** ASSUMPTIONS: 1511** 1512** {A10512} The input to [sqlite3_complete()] must be a zero-terminated 1513** UTF-8 string. 1514** 1515** {A10513} The input to [sqlite3_complete16()] must be a zero-terminated 1516** UTF-16 string in native byte order. 1517*/ 1518int sqlite3_complete(const char *sql); 1519int sqlite3_complete16(const void *sql); 1520 1521/* 1522** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} <S40400> 1523** 1524** This routine sets a callback function that might be invoked whenever 1525** an attempt is made to open a database table that another thread 1526** or process has locked. 1527** 1528** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] 1529** is returned immediately upon encountering the lock. If the busy callback 1530** is not NULL, then the callback will be invoked with two arguments. 1531** 1532** The first argument to the handler is a copy of the void* pointer which 1533** is the third argument to sqlite3_busy_handler(). The second argument to 1534** the handler callback is the number of times that the busy handler has 1535** been invoked for this locking event. If the 1536** busy callback returns 0, then no additional attempts are made to 1537** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. 1538** If the callback returns non-zero, then another attempt 1539** is made to open the database for reading and the cycle repeats. 1540** 1541** The presence of a busy handler does not guarantee that it will be invoked 1542** when there is lock contention. If SQLite determines that invoking the busy 1543** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 1544** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. 1545** Consider a scenario where one process is holding a read lock that 1546** it is trying to promote to a reserved lock and 1547** a second process is holding a reserved lock that it is trying 1548** to promote to an exclusive lock. The first process cannot proceed 1549** because it is blocked by the second and the second process cannot 1550** proceed because it is blocked by the first. If both processes 1551** invoke the busy handlers, neither will make any progress. Therefore, 1552** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 1553** will induce the first process to release its read lock and allow 1554** the second process to proceed. 1555** 1556** The default busy callback is NULL. 1557** 1558** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] 1559** when SQLite is in the middle of a large transaction where all the 1560** changes will not fit into the in-memory cache. SQLite will 1561** already hold a RESERVED lock on the database file, but it needs 1562** to promote this lock to EXCLUSIVE so that it can spill cache 1563** pages into the database file without harm to concurrent 1564** readers. If it is unable to promote the lock, then the in-memory 1565** cache will be left in an inconsistent state and so the error 1566** code is promoted from the relatively benign [SQLITE_BUSY] to 1567** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion 1568** forces an automatic rollback of the changes. See the 1569** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> 1570** CorruptionFollowingBusyError</a> wiki page for a discussion of why 1571** this is important. 1572** 1573** There can only be a single busy handler defined for each 1574** [database connection]. Setting a new busy handler clears any 1575** previously set handler. Note that calling [sqlite3_busy_timeout()] 1576** will also set or clear the busy handler. 1577** 1578** The busy callback should not take any actions which modify the 1579** database connection that invoked the busy handler. Any such actions 1580** result in undefined behavior. 1581** 1582** INVARIANTS: 1583** 1584** {H12311} The [sqlite3_busy_handler(D,C,A)] function shall replace 1585** busy callback in the [database connection] D with a new 1586** a new busy handler C and application data pointer A. 1587** 1588** {H12312} Newly created [database connections] shall have a busy 1589** handler of NULL. 1590** 1591** {H12314} When two or more [database connections] share a 1592** [sqlite3_enable_shared_cache | common cache], 1593** the busy handler for the database connection currently using 1594** the cache shall be invoked when the cache encounters a lock. 1595** 1596** {H12316} If a busy handler callback returns zero, then the SQLite interface 1597** that provoked the locking event shall return [SQLITE_BUSY]. 1598** 1599** {H12318} SQLite shall invokes the busy handler with two arguments which 1600** are a copy of the pointer supplied by the 3rd parameter to 1601** [sqlite3_busy_handler()] and a count of the number of prior 1602** invocations of the busy handler for the same locking event. 1603** 1604** ASSUMPTIONS: 1605** 1606** {A12319} A busy handler must not close the database connection 1607** or [prepared statement] that invoked the busy handler. 1608*/ 1609int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); 1610 1611/* 1612** CAPI3REF: Set A Busy Timeout {H12340} <S40410> 1613** 1614** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 1615** for a specified amount of time when a table is locked. The handler 1616** will sleep multiple times until at least "ms" milliseconds of sleeping 1617** have accumulated. {H12343} After "ms" milliseconds of sleeping, 1618** the handler returns 0 which causes [sqlite3_step()] to return 1619** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. 1620** 1621** Calling this routine with an argument less than or equal to zero 1622** turns off all busy handlers. 1623** 1624** There can only be a single busy handler for a particular 1625** [database connection] any any given moment. If another busy handler 1626** was defined (using [sqlite3_busy_handler()]) prior to calling 1627** this routine, that other busy handler is cleared. 1628** 1629** INVARIANTS: 1630** 1631** {H12341} The [sqlite3_busy_timeout()] function shall override any prior 1632** [sqlite3_busy_timeout()] or [sqlite3_busy_handler()] setting 1633** on the same [database connection]. 1634** 1635** {H12343} If the 2nd parameter to [sqlite3_busy_timeout()] is less than 1636** or equal to zero, then the busy handler shall be cleared so that 1637** all subsequent locking events immediately return [SQLITE_BUSY]. 1638** 1639** {H12344} If the 2nd parameter to [sqlite3_busy_timeout()] is a positive 1640** number N, then a busy handler shall be set that repeatedly calls 1641** the xSleep() method in the [sqlite3_vfs | VFS interface] until 1642** either the lock clears or until the cumulative sleep time 1643** reported back by xSleep() exceeds N milliseconds. 1644*/ 1645int sqlite3_busy_timeout(sqlite3*, int ms); 1646 1647/* 1648** CAPI3REF: Convenience Routines For Running Queries {H12370} <S10000> 1649** 1650** Definition: A <b>result table</b> is memory data structure created by the 1651** [sqlite3_get_table()] interface. A result table records the 1652** complete query results from one or more queries. 1653** 1654** The table conceptually has a number of rows and columns. But 1655** these numbers are not part of the result table itself. These 1656** numbers are obtained separately. Let N be the number of rows 1657** and M be the number of columns. 1658** 1659** A result table is an array of pointers to zero-terminated UTF-8 strings. 1660** There are (N+1)*M elements in the array. The first M pointers point 1661** to zero-terminated strings that contain the names of the columns. 1662** The remaining entries all point to query results. NULL values result 1663** in NULL pointers. All other values are in their UTF-8 zero-terminated 1664** string representation as returned by [sqlite3_column_text()]. 1665** 1666** A result table might consist of one or more memory allocations. 1667** It is not safe to pass a result table directly to [sqlite3_free()]. 1668** A result table should be deallocated using [sqlite3_free_table()]. 1669** 1670** As an example of the result table format, suppose a query result 1671** is as follows: 1672** 1673** <blockquote><pre> 1674** Name | Age 1675** ----------------------- 1676** Alice | 43 1677** Bob | 28 1678** Cindy | 21 1679** </pre></blockquote> 1680** 1681** There are two column (M==2) and three rows (N==3). Thus the 1682** result table has 8 entries. Suppose the result table is stored 1683** in an array names azResult. Then azResult holds this content: 1684** 1685** <blockquote><pre> 1686** azResult[0] = "Name"; 1687** azResult[1] = "Age"; 1688** azResult[2] = "Alice"; 1689** azResult[3] = "43"; 1690** azResult[4] = "Bob"; 1691** azResult[5] = "28"; 1692** azResult[6] = "Cindy"; 1693** azResult[7] = "21"; 1694** </pre></blockquote> 1695** 1696** The sqlite3_get_table() function evaluates one or more 1697** semicolon-separated SQL statements in the zero-terminated UTF-8 1698** string of its 2nd parameter. It returns a result table to the 1699** pointer given in its 3rd parameter. 1700** 1701** After the calling function has finished using the result, it should 1702** pass the pointer to the result table to sqlite3_free_table() in order to 1703** release the memory that was malloced. Because of the way the 1704** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 1705** function must not try to call [sqlite3_free()] directly. Only 1706** [sqlite3_free_table()] is able to release the memory properly and safely. 1707** 1708** The sqlite3_get_table() interface is implemented as a wrapper around 1709** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 1710** to any internal data structures of SQLite. It uses only the public 1711** interface defined here. As a consequence, errors that occur in the 1712** wrapper layer outside of the internal [sqlite3_exec()] call are not 1713** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()]. 1714** 1715** INVARIANTS: 1716** 1717** {H12371} If a [sqlite3_get_table()] fails a memory allocation, then 1718** it shall free the result table under construction, abort the 1719** query in process, skip any subsequent queries, set the 1720** *pazResult output pointer to NULL and return [SQLITE_NOMEM]. 1721** 1722** {H12373} If the pnColumn parameter to [sqlite3_get_table()] is not NULL 1723** then a successful invocation of [sqlite3_get_table()] shall 1724** write the number of columns in the 1725** result set of the query into *pnColumn. 1726** 1727** {H12374} If the pnRow parameter to [sqlite3_get_table()] is not NULL 1728** then a successful invocation of [sqlite3_get_table()] shall 1729** writes the number of rows in the 1730** result set of the query into *pnRow. 1731** 1732** {H12376} A successful invocation of [sqlite3_get_table()] that computes 1733** N rows of result with C columns per row shall make *pazResult 1734** point to an array of pointers to (N+1)*C strings where the first 1735** C strings are column names as obtained from 1736** [sqlite3_column_name()] and the rest are column result values 1737** obtained from [sqlite3_column_text()]. 1738** 1739** {H12379} The values in the pazResult array returned by [sqlite3_get_table()] 1740** shall remain valid until cleared by [sqlite3_free_table()]. 1741** 1742** {H12382} When an error occurs during evaluation of [sqlite3_get_table()] 1743** the function shall set *pazResult to NULL, write an error message 1744** into memory obtained from [sqlite3_malloc()], make 1745** **pzErrmsg point to that error message, and return a 1746** appropriate [error code]. 1747*/ 1748int sqlite3_get_table( 1749 sqlite3 *db, /* An open database */ 1750 const char *zSql, /* SQL to be evaluated */ 1751 char ***pazResult, /* Results of the query */ 1752 int *pnRow, /* Number of result rows written here */ 1753 int *pnColumn, /* Number of result columns written here */ 1754 char **pzErrmsg /* Error msg written here */ 1755); 1756void sqlite3_free_table(char **result); 1757 1758/* 1759** CAPI3REF: Formatted String Printing Functions {H17400} <S70000><S20000> 1760** 1761** These routines are workalikes of the "printf()" family of functions 1762** from the standard C library. 1763** 1764** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 1765** results into memory obtained from [sqlite3_malloc()]. 1766** The strings returned by these two routines should be 1767** released by [sqlite3_free()]. Both routines return a 1768** NULL pointer if [sqlite3_malloc()] is unable to allocate enough 1769** memory to hold the resulting string. 1770** 1771** In sqlite3_snprintf() routine is similar to "snprintf()" from 1772** the standard C library. The result is written into the 1773** buffer supplied as the second parameter whose size is given by 1774** the first parameter. Note that the order of the 1775** first two parameters is reversed from snprintf(). This is an 1776** historical accident that cannot be fixed without breaking 1777** backwards compatibility. Note also that sqlite3_snprintf() 1778** returns a pointer to its buffer instead of the number of 1779** characters actually written into the buffer. We admit that 1780** the number of characters written would be a more useful return 1781** value but we cannot change the implementation of sqlite3_snprintf() 1782** now without breaking compatibility. 1783** 1784** As long as the buffer size is greater than zero, sqlite3_snprintf() 1785** guarantees that the buffer is always zero-terminated. The first 1786** parameter "n" is the total size of the buffer, including space for 1787** the zero terminator. So the longest string that can be completely 1788** written will be n-1 characters. 1789** 1790** These routines all implement some additional formatting 1791** options that are useful for constructing SQL statements. 1792** All of the usual printf() formatting options apply. In addition, there 1793** is are "%q", "%Q", and "%z" options. 1794** 1795** The %q option works like %s in that it substitutes a null-terminated 1796** string from the argument list. But %q also doubles every '\'' character. 1797** %q is designed for use inside a string literal. By doubling each '\'' 1798** character it escapes that character and allows it to be inserted into 1799** the string. 1800** 1801** For example, assume the string variable zText contains text as follows: 1802** 1803** <blockquote><pre> 1804** char *zText = "It's a happy day!"; 1805** </pre></blockquote> 1806** 1807** One can use this text in an SQL statement as follows: 1808** 1809** <blockquote><pre> 1810** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); 1811** sqlite3_exec(db, zSQL, 0, 0, 0); 1812** sqlite3_free(zSQL); 1813** </pre></blockquote> 1814** 1815** Because the %q format string is used, the '\'' character in zText 1816** is escaped and the SQL generated is as follows: 1817** 1818** <blockquote><pre> 1819** INSERT INTO table1 VALUES('It''s a happy day!') 1820** </pre></blockquote> 1821** 1822** This is correct. Had we used %s instead of %q, the generated SQL 1823** would have looked like this: 1824** 1825** <blockquote><pre> 1826** INSERT INTO table1 VALUES('It's a happy day!'); 1827** </pre></blockquote> 1828** 1829** This second example is an SQL syntax error. As a general rule you should 1830** always use %q instead of %s when inserting text into a string literal. 1831** 1832** The %Q option works like %q except it also adds single quotes around 1833** the outside of the total string. Additionally, if the parameter in the 1834** argument list is a NULL pointer, %Q substitutes the text "NULL" (without 1835** single quotes) in place of the %Q option. So, for example, one could say: 1836** 1837** <blockquote><pre> 1838** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); 1839** sqlite3_exec(db, zSQL, 0, 0, 0); 1840** sqlite3_free(zSQL); 1841** </pre></blockquote> 1842** 1843** The code above will render a correct SQL statement in the zSQL 1844** variable even if the zText variable is a NULL pointer. 1845** 1846** The "%z" formatting option works exactly like "%s" with the 1847** addition that after the string has been read and copied into 1848** the result, [sqlite3_free()] is called on the input string. {END} 1849** 1850** INVARIANTS: 1851** 1852** {H17403} The [sqlite3_mprintf()] and [sqlite3_vmprintf()] interfaces 1853** return either pointers to zero-terminated UTF-8 strings held in 1854** memory obtained from [sqlite3_malloc()] or NULL pointers if 1855** a call to [sqlite3_malloc()] fails. 1856** 1857** {H17406} The [sqlite3_snprintf()] interface writes a zero-terminated 1858** UTF-8 string into the buffer pointed to by the second parameter 1859** provided that the first parameter is greater than zero. 1860** 1861** {H17407} The [sqlite3_snprintf()] interface does not write slots of 1862** its output buffer (the second parameter) outside the range 1863** of 0 through N-1 (where N is the first parameter) 1864** regardless of the length of the string 1865** requested by the format specification. 1866*/ 1867char *sqlite3_mprintf(const char*,...); 1868char *sqlite3_vmprintf(const char*, va_list); 1869char *sqlite3_snprintf(int,char*,const char*, ...); 1870 1871/* 1872** CAPI3REF: Memory Allocation Subsystem {H17300} <S20000> 1873** 1874** The SQLite core uses these three routines for all of its own 1875** internal memory allocation needs. "Core" in the previous sentence 1876** does not include operating-system specific VFS implementation. The 1877** Windows VFS uses native malloc() and free() for some operations. 1878** 1879** The sqlite3_malloc() routine returns a pointer to a block 1880** of memory at least N bytes in length, where N is the parameter. 1881** If sqlite3_malloc() is unable to obtain sufficient free 1882** memory, it returns a NULL pointer. If the parameter N to 1883** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 1884** a NULL pointer. 1885** 1886** Calling sqlite3_free() with a pointer previously returned 1887** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 1888** that it might be reused. The sqlite3_free() routine is 1889** a no-op if is called with a NULL pointer. Passing a NULL pointer 1890** to sqlite3_free() is harmless. After being freed, memory 1891** should neither be read nor written. Even reading previously freed 1892** memory might result in a segmentation fault or other severe error. 1893** Memory corruption, a segmentation fault, or other severe error 1894** might result if sqlite3_free() is called with a non-NULL pointer that 1895** was not obtained from sqlite3_malloc() or sqlite3_free(). 1896** 1897** The sqlite3_realloc() interface attempts to resize a 1898** prior memory allocation to be at least N bytes, where N is the 1899** second parameter. The memory allocation to be resized is the first 1900** parameter. If the first parameter to sqlite3_realloc() 1901** is a NULL pointer then its behavior is identical to calling 1902** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). 1903** If the second parameter to sqlite3_realloc() is zero or 1904** negative then the behavior is exactly the same as calling 1905** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). 1906** sqlite3_realloc() returns a pointer to a memory allocation 1907** of at least N bytes in size or NULL if sufficient memory is unavailable. 1908** If M is the size of the prior allocation, then min(N,M) bytes 1909** of the prior allocation are copied into the beginning of buffer returned 1910** by sqlite3_realloc() and the prior allocation is freed. 1911** If sqlite3_realloc() returns NULL, then the prior allocation 1912** is not freed. 1913** 1914** The memory returned by sqlite3_malloc() and sqlite3_realloc() 1915** is always aligned to at least an 8 byte boundary. {END} 1916** 1917** The default implementation of the memory allocation subsystem uses 1918** the malloc(), realloc() and free() provided by the standard C library. 1919** {H17382} However, if SQLite is compiled with the 1920** SQLITE_MEMORY_SIZE=<i>NNN</i> C preprocessor macro (where <i>NNN</i> 1921** is an integer), then SQLite create a static array of at least 1922** <i>NNN</i> bytes in size and uses that array for all of its dynamic 1923** memory allocation needs. {END} Additional memory allocator options 1924** may be added in future releases. 1925** 1926** In SQLite version 3.5.0 and 3.5.1, it was possible to define 1927** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in 1928** implementation of these routines to be omitted. That capability 1929** is no longer provided. Only built-in memory allocators can be used. 1930** 1931** The Windows OS interface layer calls 1932** the system malloc() and free() directly when converting 1933** filenames between the UTF-8 encoding used by SQLite 1934** and whatever filename encoding is used by the particular Windows 1935** installation. Memory allocation errors are detected, but 1936** they are reported back as [SQLITE_CANTOPEN] or 1937** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. 1938** 1939** INVARIANTS: 1940** 1941** {H17303} The [sqlite3_malloc(N)] interface returns either a pointer to 1942** a newly checked-out block of at least N bytes of memory 1943** that is 8-byte aligned, or it returns NULL if it is unable 1944** to fulfill the request. 1945** 1946** {H17304} The [sqlite3_malloc(N)] interface returns a NULL pointer if 1947** N is less than or equal to zero. 1948** 1949** {H17305} The [sqlite3_free(P)] interface releases memory previously 1950** returned from [sqlite3_malloc()] or [sqlite3_realloc()], 1951** making it available for reuse. 1952** 1953** {H17306} A call to [sqlite3_free(NULL)] is a harmless no-op. 1954** 1955** {H17310} A call to [sqlite3_realloc(0,N)] is equivalent to a call 1956** to [sqlite3_malloc(N)]. 1957** 1958** {H17312} A call to [sqlite3_realloc(P,0)] is equivalent to a call 1959** to [sqlite3_free(P)]. 1960** 1961** {H17315} The SQLite core uses [sqlite3_malloc()], [sqlite3_realloc()], 1962** and [sqlite3_free()] for all of its memory allocation and 1963** deallocation needs. 1964** 1965** {H17318} The [sqlite3_realloc(P,N)] interface returns either a pointer 1966** to a block of checked-out memory of at least N bytes in size 1967** that is 8-byte aligned, or a NULL pointer. 1968** 1969** {H17321} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first 1970** copies the first K bytes of content from P into the newly 1971** allocated block, where K is the lesser of N and the size of 1972** the buffer P. 1973** 1974** {H17322} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first 1975** releases the buffer P. 1976** 1977** {H17323} When [sqlite3_realloc(P,N)] returns NULL, the buffer P is 1978** not modified or released. 1979** 1980** ASSUMPTIONS: 1981** 1982** {A17350} The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 1983** must be either NULL or else pointers obtained from a prior 1984** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 1985** not yet been released. 1986** 1987** {A17351} The application must not read or write any part of 1988** a block of memory after it has been released using 1989** [sqlite3_free()] or [sqlite3_realloc()]. 1990*/ 1991void *sqlite3_malloc(int); 1992void *sqlite3_realloc(void*, int); 1993void sqlite3_free(void*); 1994 1995/* 1996** CAPI3REF: Memory Allocator Statistics {H17370} <S30210> 1997** 1998** SQLite provides these two interfaces for reporting on the status 1999** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 2000** routines, which form the built-in memory allocation subsystem. 2001** 2002** INVARIANTS: 2003** 2004** {H17371} The [sqlite3_memory_used()] routine returns the number of bytes 2005** of memory currently outstanding (malloced but not freed). 2006** 2007** {H17373} The [sqlite3_memory_highwater()] routine returns the maximum 2008** value of [sqlite3_memory_used()] since the high-water mark 2009** was last reset. 2010** 2011** {H17374} The values returned by [sqlite3_memory_used()] and 2012** [sqlite3_memory_highwater()] include any overhead 2013** added by SQLite in its implementation of [sqlite3_malloc()], 2014** but not overhead added by the any underlying system library 2015** routines that [sqlite3_malloc()] may call. 2016** 2017** {H17375} The memory high-water mark is reset to the current value of 2018** [sqlite3_memory_used()] if and only if the parameter to 2019** [sqlite3_memory_highwater()] is true. The value returned 2020** by [sqlite3_memory_highwater(1)] is the high-water mark 2021** prior to the reset. 2022*/ 2023sqlite3_int64 sqlite3_memory_used(void); 2024sqlite3_int64 sqlite3_memory_highwater(int resetFlag); 2025 2026/* 2027** CAPI3REF: Pseudo-Random Number Generator {H17390} <S20000> 2028** 2029** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 2030** select random ROWIDs when inserting new records into a table that 2031** already uses the largest possible ROWID. The PRNG is also used for 2032** the build-in random() and randomblob() SQL functions. This interface allows 2033** applications to access the same PRNG for other purposes. 2034** 2035** A call to this routine stores N bytes of randomness into buffer P. 2036** 2037** The first time this routine is invoked (either internally or by 2038** the application) the PRNG is seeded using randomness obtained 2039** from the xRandomness method of the default [sqlite3_vfs] object. 2040** On all subsequent invocations, the pseudo-randomness is generated 2041** internally and without recourse to the [sqlite3_vfs] xRandomness 2042** method. 2043** 2044** INVARIANTS: 2045** 2046** {H17392} The [sqlite3_randomness(N,P)] interface writes N bytes of 2047** high-quality pseudo-randomness into buffer P. 2048*/ 2049void sqlite3_randomness(int N, void *P); 2050 2051/* 2052** CAPI3REF: Compile-Time Authorization Callbacks {H12500} <S70100> 2053** 2054** This routine registers a authorizer callback with a particular 2055** [database connection], supplied in the first argument. 2056** The authorizer callback is invoked as SQL statements are being compiled 2057** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 2058** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various 2059** points during the compilation process, as logic is being created 2060** to perform various actions, the authorizer callback is invoked to 2061** see if those actions are allowed. The authorizer callback should 2062** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 2063** specific action but allow the SQL statement to continue to be 2064** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 2065** rejected with an error. If the authorizer callback returns 2066** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 2067** then the [sqlite3_prepare_v2()] or equivalent call that triggered 2068** the authorizer will fail with an error message. 2069** 2070** When the callback returns [SQLITE_OK], that means the operation 2071** requested is ok. When the callback returns [SQLITE_DENY], the 2072** [sqlite3_prepare_v2()] or equivalent call that triggered the 2073** authorizer will fail with an error message explaining that 2074** access is denied. If the authorizer code is [SQLITE_READ] 2075** and the callback returns [SQLITE_IGNORE] then the 2076** [prepared statement] statement is constructed to substitute 2077** a NULL value in place of the table column that would have 2078** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 2079** return can be used to deny an untrusted user access to individual 2080** columns of a table. 2081** 2082** The first parameter to the authorizer callback is a copy of the third 2083** parameter to the sqlite3_set_authorizer() interface. The second parameter 2084** to the callback is an integer [SQLITE_COPY | action code] that specifies 2085** the particular action to be authorized. The third through sixth parameters 2086** to the callback are zero-terminated strings that contain additional 2087** details about the action to be authorized. 2088** 2089** An authorizer is used when [sqlite3_prepare | preparing] 2090** SQL statements from an untrusted source, to ensure that the SQL statements 2091** do not try to access data they are not allowed to see, or that they do not 2092** try to execute malicious statements that damage the database. For 2093** example, an application may allow a user to enter arbitrary 2094** SQL queries for evaluation by a database. But the application does 2095** not want the user to be able to make arbitrary changes to the 2096** database. An authorizer could then be put in place while the 2097** user-entered SQL is being [sqlite3_prepare | prepared] that 2098** disallows everything except [SELECT] statements. 2099** 2100** Applications that need to process SQL from untrusted sources 2101** might also consider lowering resource limits using [sqlite3_limit()] 2102** and limiting database size using the [max_page_count] [PRAGMA] 2103** in addition to using an authorizer. 2104** 2105** Only a single authorizer can be in place on a database connection 2106** at a time. Each call to sqlite3_set_authorizer overrides the 2107** previous call. Disable the authorizer by installing a NULL callback. 2108** The authorizer is disabled by default. 2109** 2110** The authorizer callback must not do anything that will modify 2111** the database connection that invoked the authorizer callback. 2112** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2113** database connections for the meaning of "modify" in this paragraph. 2114** 2115** When [sqlite3_prepare_v2()] is used to prepare a statement, the 2116** statement might be reprepared during [sqlite3_step()] due to a 2117** schema change. Hence, the application should ensure that the 2118** correct authorizer callback remains in place during the [sqlite3_step()]. 2119** 2120** Note that the authorizer callback is invoked only during 2121** [sqlite3_prepare()] or its variants. Authorization is not 2122** performed during statement evaluation in [sqlite3_step()]. 2123** 2124** INVARIANTS: 2125** 2126** {H12501} The [sqlite3_set_authorizer(D,...)] interface registers a 2127** authorizer callback with database connection D. 2128** 2129** {H12502} The authorizer callback is invoked as SQL statements are 2130** being parseed and compiled. 2131** 2132** {H12503} If the authorizer callback returns any value other than 2133** [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY], then 2134** the application interface call that caused 2135** the authorizer callback to run shall fail with an 2136** [SQLITE_ERROR] error code and an appropriate error message. 2137** 2138** {H12504} When the authorizer callback returns [SQLITE_OK], the operation 2139** described is processed normally. 2140** 2141** {H12505} When the authorizer callback returns [SQLITE_DENY], the 2142** application interface call that caused the 2143** authorizer callback to run shall fail 2144** with an [SQLITE_ERROR] error code and an error message 2145** explaining that access is denied. 2146** 2147** {H12506} If the authorizer code (the 2nd parameter to the authorizer 2148** callback) is [SQLITE_READ] and the authorizer callback returns 2149** [SQLITE_IGNORE], then the prepared statement is constructed to 2150** insert a NULL value in place of the table column that would have 2151** been read if [SQLITE_OK] had been returned. 2152** 2153** {H12507} If the authorizer code (the 2nd parameter to the authorizer 2154** callback) is anything other than [SQLITE_READ], then 2155** a return of [SQLITE_IGNORE] has the same effect as [SQLITE_DENY]. 2156** 2157** {H12510} The first parameter to the authorizer callback is a copy of 2158** the third parameter to the [sqlite3_set_authorizer()] interface. 2159** 2160** {H12511} The second parameter to the callback is an integer 2161** [SQLITE_COPY | action code] that specifies the particular action 2162** to be authorized. 2163** 2164** {H12512} The third through sixth parameters to the callback are 2165** zero-terminated strings that contain 2166** additional details about the action to be authorized. 2167** 2168** {H12520} Each call to [sqlite3_set_authorizer()] overrides 2169** any previously installed authorizer. 2170** 2171** {H12521} A NULL authorizer means that no authorization 2172** callback is invoked. 2173** 2174** {H12522} The default authorizer is NULL. 2175*/ 2176int sqlite3_set_authorizer( 2177 sqlite3*, 2178 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 2179 void *pUserData 2180); 2181 2182/* 2183** CAPI3REF: Authorizer Return Codes {H12590} <H12500> 2184** 2185** The [sqlite3_set_authorizer | authorizer callback function] must 2186** return either [SQLITE_OK] or one of these two constants in order 2187** to signal SQLite whether or not the action is permitted. See the 2188** [sqlite3_set_authorizer | authorizer documentation] for additional 2189** information. 2190*/ 2191#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 2192#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 2193 2194/* 2195** CAPI3REF: Authorizer Action Codes {H12550} <H12500> 2196** 2197** The [sqlite3_set_authorizer()] interface registers a callback function 2198** that is invoked to authorize certain SQL statement actions. The 2199** second parameter to the callback is an integer code that specifies 2200** what action is being authorized. These are the integer action codes that 2201** the authorizer callback may be passed. 2202** 2203** These action code values signify what kind of operation is to be 2204** authorized. The 3rd and 4th parameters to the authorization 2205** callback function will be parameters or NULL depending on which of these 2206** codes is used as the second parameter. The 5th parameter to the 2207** authorizer callback is the name of the database ("main", "temp", 2208** etc.) if applicable. The 6th parameter to the authorizer callback 2209** is the name of the inner-most trigger or view that is responsible for 2210** the access attempt or NULL if this access attempt is directly from 2211** top-level SQL code. 2212** 2213** INVARIANTS: 2214** 2215** {H12551} The second parameter to an 2216** [sqlite3_set_authorizer | authorizer callback] shall be an integer 2217** [SQLITE_COPY | authorizer code] that specifies what action 2218** is being authorized. 2219** 2220** {H12552} The 3rd and 4th parameters to the 2221** [sqlite3_set_authorizer | authorization callback] 2222** shall be parameters or NULL depending on which 2223** [SQLITE_COPY | authorizer code] is used as the second parameter. 2224** 2225** {H12553} The 5th parameter to the 2226** [sqlite3_set_authorizer | authorizer callback] shall be the name 2227** of the database (example: "main", "temp", etc.) if applicable. 2228** 2229** {H12554} The 6th parameter to the 2230** [sqlite3_set_authorizer | authorizer callback] shall be the name 2231** of the inner-most trigger or view that is responsible for 2232** the access attempt or NULL if this access attempt is directly from 2233** top-level SQL code. 2234*/ 2235/******************************************* 3rd ************ 4th ***********/ 2236#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 2237#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 2238#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 2239#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 2240#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 2241#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 2242#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 2243#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 2244#define SQLITE_DELETE 9 /* Table Name NULL */ 2245#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ 2246#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ 2247#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ 2248#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ 2249#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ 2250#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ 2251#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ 2252#define SQLITE_DROP_VIEW 17 /* View Name NULL */ 2253#define SQLITE_INSERT 18 /* Table Name NULL */ 2254#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ 2255#define SQLITE_READ 20 /* Table Name Column Name */ 2256#define SQLITE_SELECT 21 /* NULL NULL */ 2257#define SQLITE_TRANSACTION 22 /* NULL NULL */ 2258#define SQLITE_UPDATE 23 /* Table Name Column Name */ 2259#define SQLITE_ATTACH 24 /* Filename NULL */ 2260#define SQLITE_DETACH 25 /* Database Name NULL */ 2261#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 2262#define SQLITE_REINDEX 27 /* Index Name NULL */ 2263#define SQLITE_ANALYZE 28 /* Table Name NULL */ 2264#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 2265#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 2266#define SQLITE_FUNCTION 31 /* Function Name NULL */ 2267#define SQLITE_COPY 0 /* No longer used */ 2268 2269/* 2270** CAPI3REF: Tracing And Profiling Functions {H12280} <S60400> 2271** EXPERIMENTAL 2272** 2273** These routines register callback functions that can be used for 2274** tracing and profiling the execution of SQL statements. 2275** 2276** The callback function registered by sqlite3_trace() is invoked at 2277** various times when an SQL statement is being run by [sqlite3_step()]. 2278** The callback returns a UTF-8 rendering of the SQL statement text 2279** as the statement first begins executing. Additional callbacks occur 2280** as each triggered subprogram is entered. The callbacks for triggers 2281** contain a UTF-8 SQL comment that identifies the trigger. 2282** 2283** The callback function registered by sqlite3_profile() is invoked 2284** as each SQL statement finishes. The profile callback contains 2285** the original statement text and an estimate of wall-clock time 2286** of how long that statement took to run. 2287** 2288** INVARIANTS: 2289** 2290** {H12281} The callback function registered by [sqlite3_trace()] 2291** shall be invoked 2292** whenever an SQL statement first begins to execute and 2293** whenever a trigger subprogram first begins to run. 2294** 2295** {H12282} Each call to [sqlite3_trace()] shall override the previously 2296** registered trace callback. 2297** 2298** {H12283} A NULL trace callback shall disable tracing. 2299** 2300** {H12284} The first argument to the trace callback shall be a copy of 2301** the pointer which was the 3rd argument to [sqlite3_trace()]. 2302** 2303** {H12285} The second argument to the trace callback is a 2304** zero-terminated UTF-8 string containing the original text 2305** of the SQL statement as it was passed into [sqlite3_prepare_v2()] 2306** or the equivalent, or an SQL comment indicating the beginning 2307** of a trigger subprogram. 2308** 2309** {H12287} The callback function registered by [sqlite3_profile()] is invoked 2310** as each SQL statement finishes. 2311** 2312** {H12288} The first parameter to the profile callback is a copy of 2313** the 3rd parameter to [sqlite3_profile()]. 2314** 2315** {H12289} The second parameter to the profile callback is a 2316** zero-terminated UTF-8 string that contains the complete text of 2317** the SQL statement as it was processed by [sqlite3_prepare_v2()] 2318** or the equivalent. 2319** 2320** {H12290} The third parameter to the profile callback is an estimate 2321** of the number of nanoseconds of wall-clock time required to 2322** run the SQL statement from start to finish. 2323*/ 2324SQLITE_EXPERIMENTAL void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); 2325SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, 2326 void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 2327 2328/* 2329** CAPI3REF: Query Progress Callbacks {H12910} <S60400> 2330** 2331** This routine configures a callback function - the 2332** progress callback - that is invoked periodically during long 2333** running calls to [sqlite3_exec()], [sqlite3_step()] and 2334** [sqlite3_get_table()]. An example use for this 2335** interface is to keep a GUI updated during a large query. 2336** 2337** If the progress callback returns non-zero, the operation is 2338** interrupted. This feature can be used to implement a 2339** "Cancel" button on a GUI progress dialog box. 2340** 2341** The progress handler must not do anything that will modify 2342** the database connection that invoked the progress handler. 2343** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2344** database connections for the meaning of "modify" in this paragraph. 2345** 2346** INVARIANTS: 2347** 2348** {H12911} The callback function registered by sqlite3_progress_handler() 2349** is invoked periodically during long running calls to 2350** [sqlite3_step()]. 2351** 2352** {H12912} The progress callback is invoked once for every N virtual 2353** machine opcodes, where N is the second argument to 2354** the [sqlite3_progress_handler()] call that registered 2355** the callback. If N is less than 1, sqlite3_progress_handler() 2356** acts as if a NULL progress handler had been specified. 2357** 2358** {H12913} The progress callback itself is identified by the third 2359** argument to sqlite3_progress_handler(). 2360** 2361** {H12914} The fourth argument to sqlite3_progress_handler() is a 2362** void pointer passed to the progress callback 2363** function each time it is invoked. 2364** 2365** {H12915} If a call to [sqlite3_step()] results in fewer than N opcodes 2366** being executed, then the progress callback is never invoked. 2367** 2368** {H12916} Every call to [sqlite3_progress_handler()] 2369** overwrites any previously registered progress handler. 2370** 2371** {H12917} If the progress handler callback is NULL then no progress 2372** handler is invoked. 2373** 2374** {H12918} If the progress callback returns a result other than 0, then 2375** the behavior is a if [sqlite3_interrupt()] had been called. 2376** <S30500> 2377*/ 2378void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 2379 2380/* 2381** CAPI3REF: Opening A New Database Connection {H12700} <S40200> 2382** 2383** These routines open an SQLite database file whose name is given by the 2384** filename argument. The filename argument is interpreted as UTF-8 for 2385** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 2386** order for sqlite3_open16(). A [database connection] handle is usually 2387** returned in *ppDb, even if an error occurs. The only exception is that 2388** if SQLite is unable to allocate memory to hold the [sqlite3] object, 2389** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 2390** object. If the database is opened (and/or created) successfully, then 2391** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The 2392** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 2393** an English language description of the error. 2394** 2395** The default encoding for the database will be UTF-8 if 2396** sqlite3_open() or sqlite3_open_v2() is called and 2397** UTF-16 in the native byte order if sqlite3_open16() is used. 2398** 2399** Whether or not an error occurs when it is opened, resources 2400** associated with the [database connection] handle should be released by 2401** passing it to [sqlite3_close()] when it is no longer required. 2402** 2403** The sqlite3_open_v2() interface works like sqlite3_open() 2404** except that it accepts two additional parameters for additional control 2405** over the new database connection. The flags parameter can take one of 2406** the following three values, optionally combined with the 2407** [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags: 2408** 2409** <dl> 2410** <dt>[SQLITE_OPEN_READONLY]</dt> 2411** <dd>The database is opened in read-only mode. If the database does not 2412** already exist, an error is returned.</dd> 2413** 2414** <dt>[SQLITE_OPEN_READWRITE]</dt> 2415** <dd>The database is opened for reading and writing if possible, or reading 2416** only if the file is write protected by the operating system. In either 2417** case the database must already exist, otherwise an error is returned.</dd> 2418** 2419** <dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 2420** <dd>The database is opened for reading and writing, and is creates it if 2421** it does not already exist. This is the behavior that is always used for 2422** sqlite3_open() and sqlite3_open16().</dd> 2423** </dl> 2424** 2425** If the 3rd parameter to sqlite3_open_v2() is not one of the 2426** combinations shown above or one of the combinations shown above combined 2427** with the [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags, 2428** then the behavior is undefined. 2429** 2430** If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 2431** opens in the multi-thread [threading mode] as long as the single-thread 2432** mode has not been set at compile-time or start-time. If the 2433** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 2434** in the serialized [threading mode] unless single-thread was 2435** previously selected at compile-time or start-time. 2436** 2437** If the filename is ":memory:", then a private, temporary in-memory database 2438** is created for the connection. This in-memory database will vanish when 2439** the database connection is closed. Future versions of SQLite might 2440** make use of additional special filenames that begin with the ":" character. 2441** It is recommended that when a database filename actually does begin with 2442** a ":" character you should prefix the filename with a pathname such as 2443** "./" to avoid ambiguity. 2444** 2445** If the filename is an empty string, then a private, temporary 2446** on-disk database will be created. This private database will be 2447** automatically deleted as soon as the database connection is closed. 2448** 2449** The fourth parameter to sqlite3_open_v2() is the name of the 2450** [sqlite3_vfs] object that defines the operating system interface that 2451** the new database connection should use. If the fourth parameter is 2452** a NULL pointer then the default [sqlite3_vfs] object is used. 2453** 2454** <b>Note to Windows users:</b> The encoding used for the filename argument 2455** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 2456** codepage is currently defined. Filenames containing international 2457** characters must be converted to UTF-8 prior to passing them into 2458** sqlite3_open() or sqlite3_open_v2(). 2459** 2460** INVARIANTS: 2461** 2462** {H12701} The [sqlite3_open()], [sqlite3_open16()], and 2463** [sqlite3_open_v2()] interfaces create a new 2464** [database connection] associated with 2465** the database file given in their first parameter. 2466** 2467** {H12702} The filename argument is interpreted as UTF-8 2468** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16 2469** in the native byte order for [sqlite3_open16()]. 2470** 2471** {H12703} A successful invocation of [sqlite3_open()], [sqlite3_open16()], 2472** or [sqlite3_open_v2()] writes a pointer to a new 2473** [database connection] into *ppDb. 2474** 2475** {H12704} The [sqlite3_open()], [sqlite3_open16()], and 2476** [sqlite3_open_v2()] interfaces return [SQLITE_OK] upon success, 2477** or an appropriate [error code] on failure. 2478** 2479** {H12706} The default text encoding for a new database created using 2480** [sqlite3_open()] or [sqlite3_open_v2()] will be UTF-8. 2481** 2482** {H12707} The default text encoding for a new database created using 2483** [sqlite3_open16()] will be UTF-16. 2484** 2485** {H12709} The [sqlite3_open(F,D)] interface is equivalent to 2486** [sqlite3_open_v2(F,D,G,0)] where the G parameter is 2487** [SQLITE_OPEN_READWRITE]|[SQLITE_OPEN_CREATE]. 2488** 2489** {H12711} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the 2490** bit value [SQLITE_OPEN_READONLY] then the database is opened 2491** for reading only. 2492** 2493** {H12712} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the 2494** bit value [SQLITE_OPEN_READWRITE] then the database is opened 2495** reading and writing if possible, or for reading only if the 2496** file is write protected by the operating system. 2497** 2498** {H12713} If the G parameter to [sqlite3_open_v2(F,D,G,V)] omits the 2499** bit value [SQLITE_OPEN_CREATE] and the database does not 2500** previously exist, an error is returned. 2501** 2502** {H12714} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the 2503** bit value [SQLITE_OPEN_CREATE] and the database does not 2504** previously exist, then an attempt is made to create and 2505** initialize the database. 2506** 2507** {H12717} If the filename argument to [sqlite3_open()], [sqlite3_open16()], 2508** or [sqlite3_open_v2()] is ":memory:", then an private, 2509** ephemeral, in-memory database is created for the connection. 2510** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required 2511** in sqlite3_open_v2()?</todo> 2512** 2513** {H12719} If the filename is NULL or an empty string, then a private, 2514** ephemeral on-disk database will be created. 2515** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required 2516** in sqlite3_open_v2()?</todo> 2517** 2518** {H12721} The [database connection] created by [sqlite3_open_v2(F,D,G,V)] 2519** will use the [sqlite3_vfs] object identified by the V parameter, 2520** or the default [sqlite3_vfs] object if V is a NULL pointer. 2521** 2522** {H12723} Two [database connections] will share a common cache if both were 2523** opened with the same VFS while [shared cache mode] was enabled and 2524** if both filenames compare equal using memcmp() after having been 2525** processed by the [sqlite3_vfs | xFullPathname] method of the VFS. 2526*/ 2527int sqlite3_open( 2528 const char *filename, /* Database filename (UTF-8) */ 2529 sqlite3 **ppDb /* OUT: SQLite db handle */ 2530); 2531int sqlite3_open16( 2532 const void *filename, /* Database filename (UTF-16) */ 2533 sqlite3 **ppDb /* OUT: SQLite db handle */ 2534); 2535int sqlite3_open_v2( 2536 const char *filename, /* Database filename (UTF-8) */ 2537 sqlite3 **ppDb, /* OUT: SQLite db handle */ 2538 int flags, /* Flags */ 2539 const char *zVfs /* Name of VFS module to use */ 2540); 2541 2542/* 2543** CAPI3REF: Error Codes And Messages {H12800} <S60200> 2544** 2545** The sqlite3_errcode() interface returns the numeric [result code] or 2546** [extended result code] for the most recent failed sqlite3_* API call 2547** associated with a [database connection]. If a prior API call failed 2548** but the most recent API call succeeded, the return value from 2549** sqlite3_errcode() is undefined. 2550** 2551** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 2552** text that describes the error, as either UTF-8 or UTF-16 respectively. 2553** Memory to hold the error message string is managed internally. 2554** The application does not need to worry about freeing the result. 2555** However, the error string might be overwritten or deallocated by 2556** subsequent calls to other SQLite interface functions. 2557** 2558** If an interface fails with SQLITE_MISUSE, that means the interface 2559** was invoked incorrectly by the application. In that case, the 2560** error code and message may or may not be set. 2561** 2562** INVARIANTS: 2563** 2564** {H12801} The [sqlite3_errcode(D)] interface returns the numeric 2565** [result code] or [extended result code] for the most recently 2566** failed interface call associated with the [database connection] D. 2567** 2568** {H12803} The [sqlite3_errmsg(D)] and [sqlite3_errmsg16(D)] 2569** interfaces return English-language text that describes 2570** the error in the mostly recently failed interface call, 2571** encoded as either UTF-8 or UTF-16 respectively. 2572** 2573** {H12807} The strings returned by [sqlite3_errmsg()] and [sqlite3_errmsg16()] 2574** are valid until the next SQLite interface call. 2575** 2576** {H12808} Calls to API routines that do not return an error code 2577** (example: [sqlite3_data_count()]) do not 2578** change the error code or message returned by 2579** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()]. 2580** 2581** {H12809} Interfaces that are not associated with a specific 2582** [database connection] (examples: 2583** [sqlite3_mprintf()] or [sqlite3_enable_shared_cache()] 2584** do not change the values returned by 2585** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()]. 2586*/ 2587int sqlite3_errcode(sqlite3 *db); 2588const char *sqlite3_errmsg(sqlite3*); 2589const void *sqlite3_errmsg16(sqlite3*); 2590 2591/* 2592** CAPI3REF: SQL Statement Object {H13000} <H13010> 2593** KEYWORDS: {prepared statement} {prepared statements} 2594** 2595** An instance of this object represents a single SQL statement. 2596** This object is variously known as a "prepared statement" or a 2597** "compiled SQL statement" or simply as a "statement". 2598** 2599** The life of a statement object goes something like this: 2600** 2601** <ol> 2602** <li> Create the object using [sqlite3_prepare_v2()] or a related 2603** function. 2604** <li> Bind values to [host parameters] using the sqlite3_bind_*() 2605** interfaces. 2606** <li> Run the SQL by calling [sqlite3_step()] one or more times. 2607** <li> Reset the statement using [sqlite3_reset()] then go back 2608** to step 2. Do this zero or more times. 2609** <li> Destroy the object using [sqlite3_finalize()]. 2610** </ol> 2611** 2612** Refer to documentation on individual methods above for additional 2613** information. 2614*/ 2615typedef struct sqlite3_stmt sqlite3_stmt; 2616 2617/* 2618** CAPI3REF: Run-time Limits {H12760} <S20600> 2619** 2620** This interface allows the size of various constructs to be limited 2621** on a connection by connection basis. The first parameter is the 2622** [database connection] whose limit is to be set or queried. The 2623** second parameter is one of the [limit categories] that define a 2624** class of constructs to be size limited. The third parameter is the 2625** new limit for that construct. The function returns the old limit. 2626** 2627** If the new limit is a negative number, the limit is unchanged. 2628** For the limit category of SQLITE_LIMIT_XYZ there is a hard upper 2629** bound set by a compile-time C preprocessor macro named SQLITE_MAX_XYZ. 2630** (The "_LIMIT_" in the name is changed to "_MAX_".) 2631** Attempts to increase a limit above its hard upper bound are 2632** silently truncated to the hard upper limit. 2633** 2634** Run time limits are intended for use in applications that manage 2635** both their own internal database and also databases that are controlled 2636** by untrusted external sources. An example application might be a 2637** webbrowser that has its own databases for storing history and 2638** separate databases controlled by JavaScript applications downloaded 2639** off the Internet. The internal databases can be given the 2640** large, default limits. Databases managed by external sources can 2641** be given much smaller limits designed to prevent a denial of service 2642** attack. Developers might also want to use the [sqlite3_set_authorizer()] 2643** interface to further control untrusted SQL. The size of the database 2644** created by an untrusted script can be contained using the 2645** [max_page_count] [PRAGMA]. 2646** 2647** New run-time limit categories may be added in future releases. 2648** 2649** INVARIANTS: 2650** 2651** {H12762} A successful call to [sqlite3_limit(D,C,V)] where V is 2652** positive changes the limit on the size of construct C in the 2653** [database connection] D to the lesser of V and the hard upper 2654** bound on the size of C that is set at compile-time. 2655** 2656** {H12766} A successful call to [sqlite3_limit(D,C,V)] where V is negative 2657** leaves the state of the [database connection] D unchanged. 2658** 2659** {H12769} A successful call to [sqlite3_limit(D,C,V)] returns the 2660** value of the limit on the size of construct C in the 2661** [database connection] D as it was prior to the call. 2662*/ 2663int sqlite3_limit(sqlite3*, int id, int newVal); 2664 2665/* 2666** CAPI3REF: Run-Time Limit Categories {H12790} <H12760> 2667** KEYWORDS: {limit category} {limit categories} 2668** 2669** These constants define various aspects of a [database connection] 2670** that can be limited in size by calls to [sqlite3_limit()]. 2671** The meanings of the various limits are as follows: 2672** 2673** <dl> 2674** <dt>SQLITE_LIMIT_LENGTH</dt> 2675** <dd>The maximum size of any string or BLOB or table row.<dd> 2676** 2677** <dt>SQLITE_LIMIT_SQL_LENGTH</dt> 2678** <dd>The maximum length of an SQL statement.</dd> 2679** 2680** <dt>SQLITE_LIMIT_COLUMN</dt> 2681** <dd>The maximum number of columns in a table definition or in the 2682** result set of a SELECT or the maximum number of columns in an index 2683** or in an ORDER BY or GROUP BY clause.</dd> 2684** 2685** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 2686** <dd>The maximum depth of the parse tree on any expression.</dd> 2687** 2688** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 2689** <dd>The maximum number of terms in a compound SELECT statement.</dd> 2690** 2691** <dt>SQLITE_LIMIT_VDBE_OP</dt> 2692** <dd>The maximum number of instructions in a virtual machine program 2693** used to implement an SQL statement.</dd> 2694** 2695** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 2696** <dd>The maximum number of arguments on a function.</dd> 2697** 2698** <dt>SQLITE_LIMIT_ATTACHED</dt> 2699** <dd>The maximum number of attached databases.</dd> 2700** 2701** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 2702** <dd>The maximum length of the pattern argument to the LIKE or 2703** GLOB operators.</dd> 2704** 2705** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 2706** <dd>The maximum number of variables in an SQL statement that can 2707** be bound.</dd> 2708** </dl> 2709*/ 2710#define SQLITE_LIMIT_LENGTH 0 2711#define SQLITE_LIMIT_SQL_LENGTH 1 2712#define SQLITE_LIMIT_COLUMN 2 2713#define SQLITE_LIMIT_EXPR_DEPTH 3 2714#define SQLITE_LIMIT_COMPOUND_SELECT 4 2715#define SQLITE_LIMIT_VDBE_OP 5 2716#define SQLITE_LIMIT_FUNCTION_ARG 6 2717#define SQLITE_LIMIT_ATTACHED 7 2718#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 2719#define SQLITE_LIMIT_VARIABLE_NUMBER 9 2720 2721/* 2722** CAPI3REF: Compiling An SQL Statement {H13010} <S10000> 2723** KEYWORDS: {SQL statement compiler} 2724** 2725** To execute an SQL query, it must first be compiled into a byte-code 2726** program using one of these routines. 2727** 2728** The first argument, "db", is a [database connection] obtained from a 2729** prior call to [sqlite3_open()], [sqlite3_open_v2()] or [sqlite3_open16()]. 2730** 2731** The second argument, "zSql", is the statement to be compiled, encoded 2732** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() 2733** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() 2734** use UTF-16. 2735** 2736** If the nByte argument is less than zero, then zSql is read up to the 2737** first zero terminator. If nByte is non-negative, then it is the maximum 2738** number of bytes read from zSql. When nByte is non-negative, the 2739** zSql string ends at either the first '\000' or '\u0000' character or 2740** the nByte-th byte, whichever comes first. If the caller knows 2741** that the supplied string is nul-terminated, then there is a small 2742** performance advantage to be gained by passing an nByte parameter that 2743** is equal to the number of bytes in the input string <i>including</i> 2744** the nul-terminator bytes. 2745** 2746** *pzTail is made to point to the first byte past the end of the 2747** first SQL statement in zSql. These routines only compile the first 2748** statement in zSql, so *pzTail is left pointing to what remains 2749** uncompiled. 2750** 2751** *ppStmt is left pointing to a compiled [prepared statement] that can be 2752** executed using [sqlite3_step()]. If there is an error, *ppStmt is set 2753** to NULL. If the input text contains no SQL (if the input is an empty 2754** string or a comment) then *ppStmt is set to NULL. 2755** {A13018} The calling procedure is responsible for deleting the compiled 2756** SQL statement using [sqlite3_finalize()] after it has finished with it. 2757** 2758** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned. 2759** 2760** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are 2761** recommended for all new programs. The two older interfaces are retained 2762** for backwards compatibility, but their use is discouraged. 2763** In the "v2" interfaces, the prepared statement 2764** that is returned (the [sqlite3_stmt] object) contains a copy of the 2765** original SQL text. This causes the [sqlite3_step()] interface to 2766** behave a differently in two ways: 2767** 2768** <ol> 2769** <li> 2770** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 2771** always used to do, [sqlite3_step()] will automatically recompile the SQL 2772** statement and try to run it again. If the schema has changed in 2773** a way that makes the statement no longer valid, [sqlite3_step()] will still 2774** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is 2775** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the 2776** error go away. Note: use [sqlite3_errmsg()] to find the text 2777** of the parsing error that results in an [SQLITE_SCHEMA] return. 2778** </li> 2779** 2780** <li> 2781** When an error occurs, [sqlite3_step()] will return one of the detailed 2782** [error codes] or [extended error codes]. The legacy behavior was that 2783** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 2784** and you would have to make a second call to [sqlite3_reset()] in order 2785** to find the underlying cause of the problem. With the "v2" prepare 2786** interfaces, the underlying reason for the error is returned immediately. 2787** </li> 2788** </ol> 2789** 2790** INVARIANTS: 2791** 2792** {H13011} The [sqlite3_prepare(db,zSql,...)] and 2793** [sqlite3_prepare_v2(db,zSql,...)] interfaces interpret the 2794** text in their zSql parameter as UTF-8. 2795** 2796** {H13012} The [sqlite3_prepare16(db,zSql,...)] and 2797** [sqlite3_prepare16_v2(db,zSql,...)] interfaces interpret the 2798** text in their zSql parameter as UTF-16 in the native byte order. 2799** 2800** {H13013} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)] 2801** and its variants is less than zero, the SQL text is 2802** read from zSql is read up to the first zero terminator. 2803** 2804** {H13014} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)] 2805** and its variants is non-negative, then at most nBytes bytes of 2806** SQL text is read from zSql. 2807** 2808** {H13015} In [sqlite3_prepare_v2(db,zSql,N,P,pzTail)] and its variants 2809** if the zSql input text contains more than one SQL statement 2810** and pzTail is not NULL, then *pzTail is made to point to the 2811** first byte past the end of the first SQL statement in zSql. 2812** <todo>What does *pzTail point to if there is one statement?</todo> 2813** 2814** {H13016} A successful call to [sqlite3_prepare_v2(db,zSql,N,ppStmt,...)] 2815** or one of its variants writes into *ppStmt a pointer to a new 2816** [prepared statement] or a pointer to NULL if zSql contains 2817** nothing other than whitespace or comments. 2818** 2819** {H13019} The [sqlite3_prepare_v2()] interface and its variants return 2820** [SQLITE_OK] or an appropriate [error code] upon failure. 2821** 2822** {H13021} Before [sqlite3_prepare(db,zSql,nByte,ppStmt,pzTail)] or its 2823** variants returns an error (any value other than [SQLITE_OK]), 2824** they first set *ppStmt to NULL. 2825*/ 2826int sqlite3_prepare( 2827 sqlite3 *db, /* Database handle */ 2828 const char *zSql, /* SQL statement, UTF-8 encoded */ 2829 int nByte, /* Maximum length of zSql in bytes. */ 2830 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2831 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 2832); 2833int sqlite3_prepare_v2( 2834 sqlite3 *db, /* Database handle */ 2835 const char *zSql, /* SQL statement, UTF-8 encoded */ 2836 int nByte, /* Maximum length of zSql in bytes. */ 2837 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2838 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 2839); 2840int sqlite3_prepare16( 2841 sqlite3 *db, /* Database handle */ 2842 const void *zSql, /* SQL statement, UTF-16 encoded */ 2843 int nByte, /* Maximum length of zSql in bytes. */ 2844 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2845 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 2846); 2847int sqlite3_prepare16_v2( 2848 sqlite3 *db, /* Database handle */ 2849 const void *zSql, /* SQL statement, UTF-16 encoded */ 2850 int nByte, /* Maximum length of zSql in bytes. */ 2851 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2852 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 2853); 2854 2855/* 2856** CAPIREF: Retrieving Statement SQL {H13100} <H13000> 2857** 2858** This interface can be used to retrieve a saved copy of the original 2859** SQL text used to create a [prepared statement] if that statement was 2860** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. 2861** 2862** INVARIANTS: 2863** 2864** {H13101} If the [prepared statement] passed as the argument to 2865** [sqlite3_sql()] was compiled using either [sqlite3_prepare_v2()] or 2866** [sqlite3_prepare16_v2()], then [sqlite3_sql()] returns 2867** a pointer to a zero-terminated string containing a UTF-8 rendering 2868** of the original SQL statement. 2869** 2870** {H13102} If the [prepared statement] passed as the argument to 2871** [sqlite3_sql()] was compiled using either [sqlite3_prepare()] or 2872** [sqlite3_prepare16()], then [sqlite3_sql()] returns a NULL pointer. 2873** 2874** {H13103} The string returned by [sqlite3_sql(S)] is valid until the 2875** [prepared statement] S is deleted using [sqlite3_finalize(S)]. 2876*/ 2877const char *sqlite3_sql(sqlite3_stmt *pStmt); 2878 2879/* 2880** CAPI3REF: Dynamically Typed Value Object {H15000} <S20200> 2881** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 2882** 2883** SQLite uses the sqlite3_value object to represent all values 2884** that can be stored in a database table. SQLite uses dynamic typing 2885** for the values it stores. Values stored in sqlite3_value objects 2886** can be integers, floating point values, strings, BLOBs, or NULL. 2887** 2888** An sqlite3_value object may be either "protected" or "unprotected". 2889** Some interfaces require a protected sqlite3_value. Other interfaces 2890** will accept either a protected or an unprotected sqlite3_value. 2891** Every interface that accepts sqlite3_value arguments specifies 2892** whether or not it requires a protected sqlite3_value. 2893** 2894** The terms "protected" and "unprotected" refer to whether or not 2895** a mutex is held. A internal mutex is held for a protected 2896** sqlite3_value object but no mutex is held for an unprotected 2897** sqlite3_value object. If SQLite is compiled to be single-threaded 2898** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 2899** or if SQLite is run in one of reduced mutex modes 2900** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 2901** then there is no distinction between protected and unprotected 2902** sqlite3_value objects and they can be used interchangeably. However, 2903** for maximum code portability it is recommended that applications 2904** still make the distinction between between protected and unprotected 2905** sqlite3_value objects even when not strictly required. 2906** 2907** The sqlite3_value objects that are passed as parameters into the 2908** implementation of [application-defined SQL functions] are protected. 2909** The sqlite3_value object returned by 2910** [sqlite3_column_value()] is unprotected. 2911** Unprotected sqlite3_value objects may only be used with 2912** [sqlite3_result_value()] and [sqlite3_bind_value()]. 2913** The [sqlite3_value_blob | sqlite3_value_type()] family of 2914** interfaces require protected sqlite3_value objects. 2915*/ 2916typedef struct Mem sqlite3_value; 2917 2918/* 2919** CAPI3REF: SQL Function Context Object {H16001} <S20200> 2920** 2921** The context in which an SQL function executes is stored in an 2922** sqlite3_context object. A pointer to an sqlite3_context object 2923** is always first parameter to [application-defined SQL functions]. 2924** The application-defined SQL function implementation will pass this 2925** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 2926** [sqlite3_aggregate_context()], [sqlite3_user_data()], 2927** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 2928** and/or [sqlite3_set_auxdata()]. 2929*/ 2930typedef struct sqlite3_context sqlite3_context; 2931 2932/* 2933** CAPI3REF: Binding Values To Prepared Statements {H13500} <S70300> 2934** KEYWORDS: {host parameter} {host parameters} {host parameter name} 2935** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 2936** 2937** In the SQL strings input to [sqlite3_prepare_v2()] and its variants, 2938** literals may be replaced by a parameter in one of these forms: 2939** 2940** <ul> 2941** <li> ? 2942** <li> ?NNN 2943** <li> :VVV 2944** <li> @VVV 2945** <li> $VVV 2946** </ul> 2947** 2948** In the parameter forms shown above NNN is an integer literal, 2949** and VVV is an alpha-numeric parameter name. The values of these 2950** parameters (also called "host parameter names" or "SQL parameters") 2951** can be set using the sqlite3_bind_*() routines defined here. 2952** 2953** The first argument to the sqlite3_bind_*() routines is always 2954** a pointer to the [sqlite3_stmt] object returned from 2955** [sqlite3_prepare_v2()] or its variants. 2956** 2957** The second argument is the index of the SQL parameter to be set. 2958** The leftmost SQL parameter has an index of 1. When the same named 2959** SQL parameter is used more than once, second and subsequent 2960** occurrences have the same index as the first occurrence. 2961** The index for named parameters can be looked up using the 2962** [sqlite3_bind_parameter_index()] API if desired. The index 2963** for "?NNN" parameters is the value of NNN. 2964** The NNN value must be between 1 and the [sqlite3_limit()] 2965** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 2966** 2967** The third argument is the value to bind to the parameter. 2968** 2969** In those routines that have a fourth argument, its value is the 2970** number of bytes in the parameter. To be clear: the value is the 2971** number of <u>bytes</u> in the value, not the number of characters. 2972** If the fourth parameter is negative, the length of the string is 2973** the number of bytes up to the first zero terminator. 2974** 2975** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and 2976** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or 2977** string after SQLite has finished with it. If the fifth argument is 2978** the special value [SQLITE_STATIC], then SQLite assumes that the 2979** information is in static, unmanaged space and does not need to be freed. 2980** If the fifth argument has the value [SQLITE_TRANSIENT], then 2981** SQLite makes its own private copy of the data immediately, before 2982** the sqlite3_bind_*() routine returns. 2983** 2984** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 2985** is filled with zeroes. A zeroblob uses a fixed amount of memory 2986** (just an integer to hold its size) while it is being processed. 2987** Zeroblobs are intended to serve as placeholders for BLOBs whose 2988** content is later written using 2989** [sqlite3_blob_open | incremental BLOB I/O] routines. 2990** A negative value for the zeroblob results in a zero-length BLOB. 2991** 2992** The sqlite3_bind_*() routines must be called after 2993** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and 2994** before [sqlite3_step()]. 2995** Bindings are not cleared by the [sqlite3_reset()] routine. 2996** Unbound parameters are interpreted as NULL. 2997** 2998** These routines return [SQLITE_OK] on success or an error code if 2999** anything goes wrong. [SQLITE_RANGE] is returned if the parameter 3000** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails. 3001** [SQLITE_MISUSE] might be returned if these routines are called on a 3002** virtual machine that is the wrong state or which has already been finalized. 3003** Detection of misuse is unreliable. Applications should not depend 3004** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a 3005** a logic error in the application. Future versions of SQLite might 3006** panic rather than return SQLITE_MISUSE. 3007** 3008** See also: [sqlite3_bind_parameter_count()], 3009** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 3010** 3011** INVARIANTS: 3012** 3013** {H13506} The [SQL statement compiler] recognizes tokens of the forms 3014** "?", "?NNN", "$VVV", ":VVV", and "@VVV" as SQL parameters, 3015** where NNN is any sequence of one or more digits 3016** and where VVV is any sequence of one or more alphanumeric 3017** characters or "::" optionally followed by a string containing 3018** no spaces and contained within parentheses. 3019** 3020** {H13509} The initial value of an SQL parameter is NULL. 3021** 3022** {H13512} The index of an "?" SQL parameter is one larger than the 3023** largest index of SQL parameter to the left, or 1 if 3024** the "?" is the leftmost SQL parameter. 3025** 3026** {H13515} The index of an "?NNN" SQL parameter is the integer NNN. 3027** 3028** {H13518} The index of an ":VVV", "$VVV", or "@VVV" SQL parameter is 3029** the same as the index of leftmost occurrences of the same 3030** parameter, or one more than the largest index over all 3031** parameters to the left if this is the first occurrence 3032** of this parameter, or 1 if this is the leftmost parameter. 3033** 3034** {H13521} The [SQL statement compiler] fails with an [SQLITE_RANGE] 3035** error if the index of an SQL parameter is less than 1 3036** or greater than the compile-time SQLITE_MAX_VARIABLE_NUMBER 3037** parameter. 3038** 3039** {H13524} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,V,...)] 3040** associate the value V with all SQL parameters having an 3041** index of N in the [prepared statement] S. 3042** 3043** {H13527} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,...)] 3044** override prior calls with the same values of S and N. 3045** 3046** {H13530} Bindings established by [sqlite3_bind_text | sqlite3_bind(S,...)] 3047** persist across calls to [sqlite3_reset(S)]. 3048** 3049** {H13533} In calls to [sqlite3_bind_blob(S,N,V,L,D)], 3050** [sqlite3_bind_text(S,N,V,L,D)], or 3051** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds the first L 3052** bytes of the BLOB or string pointed to by V, when L 3053** is non-negative. 3054** 3055** {H13536} In calls to [sqlite3_bind_text(S,N,V,L,D)] or 3056** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds characters 3057** from V through the first zero character when L is negative. 3058** 3059** {H13539} In calls to [sqlite3_bind_blob(S,N,V,L,D)], 3060** [sqlite3_bind_text(S,N,V,L,D)], or 3061** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special 3062** constant [SQLITE_STATIC], SQLite assumes that the value V 3063** is held in static unmanaged space that will not change 3064** during the lifetime of the binding. 3065** 3066** {H13542} In calls to [sqlite3_bind_blob(S,N,V,L,D)], 3067** [sqlite3_bind_text(S,N,V,L,D)], or 3068** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special 3069** constant [SQLITE_TRANSIENT], the routine makes a 3070** private copy of the value V before it returns. 3071** 3072** {H13545} In calls to [sqlite3_bind_blob(S,N,V,L,D)], 3073** [sqlite3_bind_text(S,N,V,L,D)], or 3074** [sqlite3_bind_text16(S,N,V,L,D)] when D is a pointer to 3075** a function, SQLite invokes that function to destroy the 3076** value V after it has finished using the value V. 3077** 3078** {H13548} In calls to [sqlite3_bind_zeroblob(S,N,V,L)] the value bound 3079** is a BLOB of L bytes, or a zero-length BLOB if L is negative. 3080** 3081** {H13551} In calls to [sqlite3_bind_value(S,N,V)] the V argument may 3082** be either a [protected sqlite3_value] object or an 3083** [unprotected sqlite3_value] object. 3084*/ 3085int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 3086int sqlite3_bind_double(sqlite3_stmt*, int, double); 3087int sqlite3_bind_int(sqlite3_stmt*, int, int); 3088int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 3089int sqlite3_bind_null(sqlite3_stmt*, int); 3090int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); 3091int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 3092int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 3093int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 3094 3095/* 3096** CAPI3REF: Number Of SQL Parameters {H13600} <S70300> 3097** 3098** This routine can be used to find the number of [SQL parameters] 3099** in a [prepared statement]. SQL parameters are tokens of the 3100** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 3101** placeholders for values that are [sqlite3_bind_blob | bound] 3102** to the parameters at a later time. 3103** 3104** This routine actually returns the index of the largest (rightmost) 3105** parameter. For all forms except ?NNN, this will correspond to the 3106** number of unique parameters. If parameters of the ?NNN are used, 3107** there may be gaps in the list. 3108** 3109** See also: [sqlite3_bind_blob|sqlite3_bind()], 3110** [sqlite3_bind_parameter_name()], and 3111** [sqlite3_bind_parameter_index()]. 3112** 3113** INVARIANTS: 3114** 3115** {H13601} The [sqlite3_bind_parameter_count(S)] interface returns 3116** the largest index of all SQL parameters in the 3117** [prepared statement] S, or 0 if S contains no SQL parameters. 3118*/ 3119int sqlite3_bind_parameter_count(sqlite3_stmt*); 3120 3121/* 3122** CAPI3REF: Name Of A Host Parameter {H13620} <S70300> 3123** 3124** This routine returns a pointer to the name of the n-th 3125** [SQL parameter] in a [prepared statement]. 3126** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 3127** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 3128** respectively. 3129** In other words, the initial ":" or "$" or "@" or "?" 3130** is included as part of the name. 3131** Parameters of the form "?" without a following integer have no name 3132** and are also referred to as "anonymous parameters". 3133** 3134** The first host parameter has an index of 1, not 0. 3135** 3136** If the value n is out of range or if the n-th parameter is 3137** nameless, then NULL is returned. The returned string is 3138** always in UTF-8 encoding even if the named parameter was 3139** originally specified as UTF-16 in [sqlite3_prepare16()] or 3140** [sqlite3_prepare16_v2()]. 3141** 3142** See also: [sqlite3_bind_blob|sqlite3_bind()], 3143** [sqlite3_bind_parameter_count()], and 3144** [sqlite3_bind_parameter_index()]. 3145** 3146** INVARIANTS: 3147** 3148** {H13621} The [sqlite3_bind_parameter_name(S,N)] interface returns 3149** a UTF-8 rendering of the name of the SQL parameter in 3150** the [prepared statement] S having index N, or 3151** NULL if there is no SQL parameter with index N or if the 3152** parameter with index N is an anonymous parameter "?". 3153*/ 3154const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); 3155 3156/* 3157** CAPI3REF: Index Of A Parameter With A Given Name {H13640} <S70300> 3158** 3159** Return the index of an SQL parameter given its name. The 3160** index value returned is suitable for use as the second 3161** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero 3162** is returned if no matching parameter is found. The parameter 3163** name must be given in UTF-8 even if the original statement 3164** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. 3165** 3166** See also: [sqlite3_bind_blob|sqlite3_bind()], 3167** [sqlite3_bind_parameter_count()], and 3168** [sqlite3_bind_parameter_index()]. 3169** 3170** INVARIANTS: 3171** 3172** {H13641} The [sqlite3_bind_parameter_index(S,N)] interface returns 3173** the index of SQL parameter in the [prepared statement] 3174** S whose name matches the UTF-8 string N, or 0 if there is 3175** no match. 3176*/ 3177int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 3178 3179/* 3180** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} <S70300> 3181** 3182** Contrary to the intuition of many, [sqlite3_reset()] does not reset 3183** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 3184** Use this routine to reset all host parameters to NULL. 3185** 3186** INVARIANTS: 3187** 3188** {H13661} The [sqlite3_clear_bindings(S)] interface resets all SQL 3189** parameter bindings in the [prepared statement] S back to NULL. 3190*/ 3191int sqlite3_clear_bindings(sqlite3_stmt*); 3192 3193/* 3194** CAPI3REF: Number Of Columns In A Result Set {H13710} <S10700> 3195** 3196** Return the number of columns in the result set returned by the 3197** [prepared statement]. This routine returns 0 if pStmt is an SQL 3198** statement that does not return data (for example an [UPDATE]). 3199** 3200** INVARIANTS: 3201** 3202** {H13711} The [sqlite3_column_count(S)] interface returns the number of 3203** columns in the result set generated by the [prepared statement] S, 3204** or 0 if S does not generate a result set. 3205*/ 3206int sqlite3_column_count(sqlite3_stmt *pStmt); 3207 3208/* 3209** CAPI3REF: Column Names In A Result Set {H13720} <S10700> 3210** 3211** These routines return the name assigned to a particular column 3212** in the result set of a [SELECT] statement. The sqlite3_column_name() 3213** interface returns a pointer to a zero-terminated UTF-8 string 3214** and sqlite3_column_name16() returns a pointer to a zero-terminated 3215** UTF-16 string. The first parameter is the [prepared statement] 3216** that implements the [SELECT] statement. The second parameter is the 3217** column number. The leftmost column is number 0. 3218** 3219** The returned string pointer is valid until either the [prepared statement] 3220** is destroyed by [sqlite3_finalize()] or until the next call to 3221** sqlite3_column_name() or sqlite3_column_name16() on the same column. 3222** 3223** If sqlite3_malloc() fails during the processing of either routine 3224** (for example during a conversion from UTF-8 to UTF-16) then a 3225** NULL pointer is returned. 3226** 3227** The name of a result column is the value of the "AS" clause for 3228** that column, if there is an AS clause. If there is no AS clause 3229** then the name of the column is unspecified and may change from 3230** one release of SQLite to the next. 3231** 3232** INVARIANTS: 3233** 3234** {H13721} A successful invocation of the [sqlite3_column_name(S,N)] 3235** interface returns the name of the Nth column (where 0 is 3236** the leftmost column) for the result set of the 3237** [prepared statement] S as a zero-terminated UTF-8 string. 3238** 3239** {H13723} A successful invocation of the [sqlite3_column_name16(S,N)] 3240** interface returns the name of the Nth column (where 0 is 3241** the leftmost column) for the result set of the 3242** [prepared statement] S as a zero-terminated UTF-16 string 3243** in the native byte order. 3244** 3245** {H13724} The [sqlite3_column_name()] and [sqlite3_column_name16()] 3246** interfaces return a NULL pointer if they are unable to 3247** allocate memory to hold their normal return strings. 3248** 3249** {H13725} If the N parameter to [sqlite3_column_name(S,N)] or 3250** [sqlite3_column_name16(S,N)] is out of range, then the 3251** interfaces return a NULL pointer. 3252** 3253** {H13726} The strings returned by [sqlite3_column_name(S,N)] and 3254** [sqlite3_column_name16(S,N)] are valid until the next 3255** call to either routine with the same S and N parameters 3256** or until [sqlite3_finalize(S)] is called. 3257** 3258** {H13727} When a result column of a [SELECT] statement contains 3259** an AS clause, the name of that column is the identifier 3260** to the right of the AS keyword. 3261*/ 3262const char *sqlite3_column_name(sqlite3_stmt*, int N); 3263const void *sqlite3_column_name16(sqlite3_stmt*, int N); 3264 3265/* 3266** CAPI3REF: Source Of Data In A Query Result {H13740} <S10700> 3267** 3268** These routines provide a means to determine what column of what 3269** table in which database a result of a [SELECT] statement comes from. 3270** The name of the database or table or column can be returned as 3271** either a UTF-8 or UTF-16 string. The _database_ routines return 3272** the database name, the _table_ routines return the table name, and 3273** the origin_ routines return the column name. 3274** The returned string is valid until the [prepared statement] is destroyed 3275** using [sqlite3_finalize()] or until the same information is requested 3276** again in a different encoding. 3277** 3278** The names returned are the original un-aliased names of the 3279** database, table, and column. 3280** 3281** The first argument to the following calls is a [prepared statement]. 3282** These functions return information about the Nth column returned by 3283** the statement, where N is the second function argument. 3284** 3285** If the Nth column returned by the statement is an expression or 3286** subquery and is not a column value, then all of these functions return 3287** NULL. These routine might also return NULL if a memory allocation error 3288** occurs. Otherwise, they return the name of the attached database, table 3289** and column that query result column was extracted from. 3290** 3291** As with all other SQLite APIs, those postfixed with "16" return 3292** UTF-16 encoded strings, the other functions return UTF-8. {END} 3293** 3294** These APIs are only available if the library was compiled with the 3295** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 3296** 3297** {A13751} 3298** If two or more threads call one or more of these routines against the same 3299** prepared statement and column at the same time then the results are 3300** undefined. 3301** 3302** INVARIANTS: 3303** 3304** {H13741} The [sqlite3_column_database_name(S,N)] interface returns either 3305** the UTF-8 zero-terminated name of the database from which the 3306** Nth result column of the [prepared statement] S is extracted, 3307** or NULL if the Nth column of S is a general expression 3308** or if unable to allocate memory to store the name. 3309** 3310** {H13742} The [sqlite3_column_database_name16(S,N)] interface returns either 3311** the UTF-16 native byte order zero-terminated name of the database 3312** from which the Nth result column of the [prepared statement] S is 3313** extracted, or NULL if the Nth column of S is a general expression 3314** or if unable to allocate memory to store the name. 3315** 3316** {H13743} The [sqlite3_column_table_name(S,N)] interface returns either 3317** the UTF-8 zero-terminated name of the table from which the 3318** Nth result column of the [prepared statement] S is extracted, 3319** or NULL if the Nth column of S is a general expression 3320** or if unable to allocate memory to store the name. 3321** 3322** {H13744} The [sqlite3_column_table_name16(S,N)] interface returns either 3323** the UTF-16 native byte order zero-terminated name of the table 3324** from which the Nth result column of the [prepared statement] S is 3325** extracted, or NULL if the Nth column of S is a general expression 3326** or if unable to allocate memory to store the name. 3327** 3328** {H13745} The [sqlite3_column_origin_name(S,N)] interface returns either 3329** the UTF-8 zero-terminated name of the table column from which the 3330** Nth result column of the [prepared statement] S is extracted, 3331** or NULL if the Nth column of S is a general expression 3332** or if unable to allocate memory to store the name. 3333** 3334** {H13746} The [sqlite3_column_origin_name16(S,N)] interface returns either 3335** the UTF-16 native byte order zero-terminated name of the table 3336** column from which the Nth result column of the 3337** [prepared statement] S is extracted, or NULL if the Nth column 3338** of S is a general expression or if unable to allocate memory 3339** to store the name. 3340** 3341** {H13748} The return values from 3342** [sqlite3_column_database_name | column metadata interfaces] 3343** are valid for the lifetime of the [prepared statement] 3344** or until the encoding is changed by another metadata 3345** interface call for the same prepared statement and column. 3346** 3347** ASSUMPTIONS: 3348** 3349** {A13751} If two or more threads call one or more 3350** [sqlite3_column_database_name | column metadata interfaces] 3351** for the same [prepared statement] and result column 3352** at the same time then the results are undefined. 3353*/ 3354const char *sqlite3_column_database_name(sqlite3_stmt*,int); 3355const void *sqlite3_column_database_name16(sqlite3_stmt*,int); 3356const char *sqlite3_column_table_name(sqlite3_stmt*,int); 3357const void *sqlite3_column_table_name16(sqlite3_stmt*,int); 3358const char *sqlite3_column_origin_name(sqlite3_stmt*,int); 3359const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); 3360 3361/* 3362** CAPI3REF: Declared Datatype Of A Query Result {H13760} <S10700> 3363** 3364** The first parameter is a [prepared statement]. 3365** If this statement is a [SELECT] statement and the Nth column of the 3366** returned result set of that [SELECT] is a table column (not an 3367** expression or subquery) then the declared type of the table 3368** column is returned. If the Nth column of the result set is an 3369** expression or subquery, then a NULL pointer is returned. 3370** The returned string is always UTF-8 encoded. {END} 3371** 3372** For example, given the database schema: 3373** 3374** CREATE TABLE t1(c1 VARIANT); 3375** 3376** and the following statement to be compiled: 3377** 3378** SELECT c1 + 1, c1 FROM t1; 3379** 3380** this routine would return the string "VARIANT" for the second result 3381** column (i==1), and a NULL pointer for the first result column (i==0). 3382** 3383** SQLite uses dynamic run-time typing. So just because a column 3384** is declared to contain a particular type does not mean that the 3385** data stored in that column is of the declared type. SQLite is 3386** strongly typed, but the typing is dynamic not static. Type 3387** is associated with individual values, not with the containers 3388** used to hold those values. 3389** 3390** INVARIANTS: 3391** 3392** {H13761} A successful call to [sqlite3_column_decltype(S,N)] returns a 3393** zero-terminated UTF-8 string containing the declared datatype 3394** of the table column that appears as the Nth column (numbered 3395** from 0) of the result set to the [prepared statement] S. 3396** 3397** {H13762} A successful call to [sqlite3_column_decltype16(S,N)] 3398** returns a zero-terminated UTF-16 native byte order string 3399** containing the declared datatype of the table column that appears 3400** as the Nth column (numbered from 0) of the result set to the 3401** [prepared statement] S. 3402** 3403** {H13763} If N is less than 0 or N is greater than or equal to 3404** the number of columns in the [prepared statement] S, 3405** or if the Nth column of S is an expression or subquery rather 3406** than a table column, or if a memory allocation failure 3407** occurs during encoding conversions, then 3408** calls to [sqlite3_column_decltype(S,N)] or 3409** [sqlite3_column_decltype16(S,N)] return NULL. 3410*/ 3411const char *sqlite3_column_decltype(sqlite3_stmt*,int); 3412const void *sqlite3_column_decltype16(sqlite3_stmt*,int); 3413 3414/* 3415** CAPI3REF: Evaluate An SQL Statement {H13200} <S10000> 3416** 3417** After a [prepared statement] has been prepared using either 3418** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy 3419** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 3420** must be called one or more times to evaluate the statement. 3421** 3422** The details of the behavior of the sqlite3_step() interface depend 3423** on whether the statement was prepared using the newer "v2" interface 3424** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy 3425** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 3426** new "v2" interface is recommended for new applications but the legacy 3427** interface will continue to be supported. 3428** 3429** In the legacy interface, the return value will be either [SQLITE_BUSY], 3430** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 3431** With the "v2" interface, any of the other [result codes] or 3432** [extended result codes] might be returned as well. 3433** 3434** [SQLITE_BUSY] means that the database engine was unable to acquire the 3435** database locks it needs to do its job. If the statement is a [COMMIT] 3436** or occurs outside of an explicit transaction, then you can retry the 3437** statement. If the statement is not a [COMMIT] and occurs within a 3438** explicit transaction then you should rollback the transaction before 3439** continuing. 3440** 3441** [SQLITE_DONE] means that the statement has finished executing 3442** successfully. sqlite3_step() should not be called again on this virtual 3443** machine without first calling [sqlite3_reset()] to reset the virtual 3444** machine back to its initial state. 3445** 3446** If the SQL statement being executed returns any data, then [SQLITE_ROW] 3447** is returned each time a new row of data is ready for processing by the 3448** caller. The values may be accessed using the [column access functions]. 3449** sqlite3_step() is called again to retrieve the next row of data. 3450** 3451** [SQLITE_ERROR] means that a run-time error (such as a constraint 3452** violation) has occurred. sqlite3_step() should not be called again on 3453** the VM. More information may be found by calling [sqlite3_errmsg()]. 3454** With the legacy interface, a more specific error code (for example, 3455** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 3456** can be obtained by calling [sqlite3_reset()] on the 3457** [prepared statement]. In the "v2" interface, 3458** the more specific error code is returned directly by sqlite3_step(). 3459** 3460** [SQLITE_MISUSE] means that the this routine was called inappropriately. 3461** Perhaps it was called on a [prepared statement] that has 3462** already been [sqlite3_finalize | finalized] or on one that had 3463** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 3464** be the case that the same database connection is being used by two or 3465** more threads at the same moment in time. 3466** 3467** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 3468** API always returns a generic error code, [SQLITE_ERROR], following any 3469** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 3470** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 3471** specific [error codes] that better describes the error. 3472** We admit that this is a goofy design. The problem has been fixed 3473** with the "v2" interface. If you prepare all of your SQL statements 3474** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead 3475** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 3476** then the more specific [error codes] are returned directly 3477** by sqlite3_step(). The use of the "v2" interface is recommended. 3478** 3479** INVARIANTS: 3480** 3481** {H13202} If the [prepared statement] S is ready to be run, then 3482** [sqlite3_step(S)] advances that prepared statement until 3483** completion or until it is ready to return another row of the 3484** result set, or until an [sqlite3_interrupt | interrupt] 3485** or a run-time error occurs. 3486** 3487** {H15304} When a call to [sqlite3_step(S)] causes the [prepared statement] 3488** S to run to completion, the function returns [SQLITE_DONE]. 3489** 3490** {H15306} When a call to [sqlite3_step(S)] stops because it is ready to 3491** return another row of the result set, it returns [SQLITE_ROW]. 3492** 3493** {H15308} If a call to [sqlite3_step(S)] encounters an 3494** [sqlite3_interrupt | interrupt] or a run-time error, 3495** it returns an appropriate error code that is not one of 3496** [SQLITE_OK], [SQLITE_ROW], or [SQLITE_DONE]. 3497** 3498** {H15310} If an [sqlite3_interrupt | interrupt] or a run-time error 3499** occurs during a call to [sqlite3_step(S)] 3500** for a [prepared statement] S created using 3501** legacy interfaces [sqlite3_prepare()] or 3502** [sqlite3_prepare16()], then the function returns either 3503** [SQLITE_ERROR], [SQLITE_BUSY], or [SQLITE_MISUSE]. 3504*/ 3505int sqlite3_step(sqlite3_stmt*); 3506 3507/* 3508** CAPI3REF: Number of columns in a result set {H13770} <S10700> 3509** 3510** Returns the number of values in the current row of the result set. 3511** 3512** INVARIANTS: 3513** 3514** {H13771} After a call to [sqlite3_step(S)] that returns [SQLITE_ROW], 3515** the [sqlite3_data_count(S)] routine will return the same value 3516** as the [sqlite3_column_count(S)] function. 3517** 3518** {H13772} After [sqlite3_step(S)] has returned any value other than 3519** [SQLITE_ROW] or before [sqlite3_step(S)] has been called on the 3520** [prepared statement] for the first time since it was 3521** [sqlite3_prepare | prepared] or [sqlite3_reset | reset], 3522** the [sqlite3_data_count(S)] routine returns zero. 3523*/ 3524int sqlite3_data_count(sqlite3_stmt *pStmt); 3525 3526/* 3527** CAPI3REF: Fundamental Datatypes {H10265} <S10110><S10120> 3528** KEYWORDS: SQLITE_TEXT 3529** 3530** {H10266} Every value in SQLite has one of five fundamental datatypes: 3531** 3532** <ul> 3533** <li> 64-bit signed integer 3534** <li> 64-bit IEEE floating point number 3535** <li> string 3536** <li> BLOB 3537** <li> NULL 3538** </ul> {END} 3539** 3540** These constants are codes for each of those types. 3541** 3542** Note that the SQLITE_TEXT constant was also used in SQLite version 2 3543** for a completely different meaning. Software that links against both 3544** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 3545** SQLITE_TEXT. 3546*/ 3547#define SQLITE_INTEGER 1 3548#define SQLITE_FLOAT 2 3549#define SQLITE_BLOB 4 3550#define SQLITE_NULL 5 3551#ifdef SQLITE_TEXT 3552# undef SQLITE_TEXT 3553#else 3554# define SQLITE_TEXT 3 3555#endif 3556#define SQLITE3_TEXT 3 3557 3558/* 3559** CAPI3REF: Result Values From A Query {H13800} <S10700> 3560** KEYWORDS: {column access functions} 3561** 3562** These routines form the "result set query" interface. 3563** 3564** These routines return information about a single column of the current 3565** result row of a query. In every case the first argument is a pointer 3566** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 3567** that was returned from [sqlite3_prepare_v2()] or one of its variants) 3568** and the second argument is the index of the column for which information 3569** should be returned. The leftmost column of the result set has the index 0. 3570** 3571** If the SQL statement does not currently point to a valid row, or if the 3572** column index is out of range, the result is undefined. 3573** These routines may only be called when the most recent call to 3574** [sqlite3_step()] has returned [SQLITE_ROW] and neither 3575** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 3576** If any of these routines are called after [sqlite3_reset()] or 3577** [sqlite3_finalize()] or after [sqlite3_step()] has returned 3578** something other than [SQLITE_ROW], the results are undefined. 3579** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 3580** are called from a different thread while any of these routines 3581** are pending, then the results are undefined. 3582** 3583** The sqlite3_column_type() routine returns the 3584** [SQLITE_INTEGER | datatype code] for the initial data type 3585** of the result column. The returned value is one of [SQLITE_INTEGER], 3586** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value 3587** returned by sqlite3_column_type() is only meaningful if no type 3588** conversions have occurred as described below. After a type conversion, 3589** the value returned by sqlite3_column_type() is undefined. Future 3590** versions of SQLite may change the behavior of sqlite3_column_type() 3591** following a type conversion. 3592** 3593** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 3594** routine returns the number of bytes in that BLOB or string. 3595** If the result is a UTF-16 string, then sqlite3_column_bytes() converts 3596** the string to UTF-8 and then returns the number of bytes. 3597** If the result is a numeric value then sqlite3_column_bytes() uses 3598** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 3599** the number of bytes in that string. 3600** The value returned does not include the zero terminator at the end 3601** of the string. For clarity: the value returned is the number of 3602** bytes in the string, not the number of characters. 3603** 3604** Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 3605** even empty strings, are always zero terminated. The return 3606** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary 3607** pointer, possibly even a NULL pointer. 3608** 3609** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes() 3610** but leaves the result in UTF-16 in native byte order instead of UTF-8. 3611** The zero terminator is not included in this count. 3612** 3613** The object returned by [sqlite3_column_value()] is an 3614** [unprotected sqlite3_value] object. An unprotected sqlite3_value object 3615** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. 3616** If the [unprotected sqlite3_value] object returned by 3617** [sqlite3_column_value()] is used in any other way, including calls 3618** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 3619** or [sqlite3_value_bytes()], then the behavior is undefined. 3620** 3621** These routines attempt to convert the value where appropriate. For 3622** example, if the internal representation is FLOAT and a text result 3623** is requested, [sqlite3_snprintf()] is used internally to perform the 3624** conversion automatically. The following table details the conversions 3625** that are applied: 3626** 3627** <blockquote> 3628** <table border="1"> 3629** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 3630** 3631** <tr><td> NULL <td> INTEGER <td> Result is 0 3632** <tr><td> NULL <td> FLOAT <td> Result is 0.0 3633** <tr><td> NULL <td> TEXT <td> Result is NULL pointer 3634** <tr><td> NULL <td> BLOB <td> Result is NULL pointer 3635** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 3636** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 3637** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 3638** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer 3639** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 3640** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT 3641** <tr><td> TEXT <td> INTEGER <td> Use atoi() 3642** <tr><td> TEXT <td> FLOAT <td> Use atof() 3643** <tr><td> TEXT <td> BLOB <td> No change 3644** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() 3645** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() 3646** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 3647** </table> 3648** </blockquote> 3649** 3650** The table above makes reference to standard C library functions atoi() 3651** and atof(). SQLite does not really use these functions. It has its 3652** own equivalent internal routines. The atoi() and atof() names are 3653** used in the table for brevity and because they are familiar to most 3654** C programmers. 3655** 3656** Note that when type conversions occur, pointers returned by prior 3657** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 3658** sqlite3_column_text16() may be invalidated. 3659** Type conversions and pointer invalidations might occur 3660** in the following cases: 3661** 3662** <ul> 3663** <li> The initial content is a BLOB and sqlite3_column_text() or 3664** sqlite3_column_text16() is called. A zero-terminator might 3665** need to be added to the string.</li> 3666** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 3667** sqlite3_column_text16() is called. The content must be converted 3668** to UTF-16.</li> 3669** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 3670** sqlite3_column_text() is called. The content must be converted 3671** to UTF-8.</li> 3672** </ul> 3673** 3674** Conversions between UTF-16be and UTF-16le are always done in place and do 3675** not invalidate a prior pointer, though of course the content of the buffer 3676** that the prior pointer points to will have been modified. Other kinds 3677** of conversion are done in place when it is possible, but sometimes they 3678** are not possible and in those cases prior pointers are invalidated. 3679** 3680** The safest and easiest to remember policy is to invoke these routines 3681** in one of the following ways: 3682** 3683** <ul> 3684** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 3685** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 3686** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 3687** </ul> 3688** 3689** In other words, you should call sqlite3_column_text(), 3690** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 3691** into the desired format, then invoke sqlite3_column_bytes() or 3692** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 3693** to sqlite3_column_text() or sqlite3_column_blob() with calls to 3694** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 3695** with calls to sqlite3_column_bytes(). 3696** 3697** The pointers returned are valid until a type conversion occurs as 3698** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 3699** [sqlite3_finalize()] is called. The memory space used to hold strings 3700** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned 3701** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 3702** [sqlite3_free()]. 3703** 3704** If a memory allocation error occurs during the evaluation of any 3705** of these routines, a default value is returned. The default value 3706** is either the integer 0, the floating point number 0.0, or a NULL 3707** pointer. Subsequent calls to [sqlite3_errcode()] will return 3708** [SQLITE_NOMEM]. 3709** 3710** INVARIANTS: 3711** 3712** {H13803} The [sqlite3_column_blob(S,N)] interface converts the 3713** Nth column in the current row of the result set for 3714** the [prepared statement] S into a BLOB and then returns a 3715** pointer to the converted value. 3716** 3717** {H13806} The [sqlite3_column_bytes(S,N)] interface returns the 3718** number of bytes in the BLOB or string (exclusive of the 3719** zero terminator on the string) that was returned by the 3720** most recent call to [sqlite3_column_blob(S,N)] or 3721** [sqlite3_column_text(S,N)]. 3722** 3723** {H13809} The [sqlite3_column_bytes16(S,N)] interface returns the 3724** number of bytes in the string (exclusive of the 3725** zero terminator on the string) that was returned by the 3726** most recent call to [sqlite3_column_text16(S,N)]. 3727** 3728** {H13812} The [sqlite3_column_double(S,N)] interface converts the 3729** Nth column in the current row of the result set for the 3730** [prepared statement] S into a floating point value and 3731** returns a copy of that value. 3732** 3733** {H13815} The [sqlite3_column_int(S,N)] interface converts the 3734** Nth column in the current row of the result set for the 3735** [prepared statement] S into a 64-bit signed integer and 3736** returns the lower 32 bits of that integer. 3737** 3738** {H13818} The [sqlite3_column_int64(S,N)] interface converts the 3739** Nth column in the current row of the result set for the 3740** [prepared statement] S into a 64-bit signed integer and 3741** returns a copy of that integer. 3742** 3743** {H13821} The [sqlite3_column_text(S,N)] interface converts the 3744** Nth column in the current row of the result set for 3745** the [prepared statement] S into a zero-terminated UTF-8 3746** string and returns a pointer to that string. 3747** 3748** {H13824} The [sqlite3_column_text16(S,N)] interface converts the 3749** Nth column in the current row of the result set for the 3750** [prepared statement] S into a zero-terminated 2-byte 3751** aligned UTF-16 native byte order string and returns 3752** a pointer to that string. 3753** 3754** {H13827} The [sqlite3_column_type(S,N)] interface returns 3755** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT], 3756** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for 3757** the Nth column in the current row of the result set for 3758** the [prepared statement] S. 3759** 3760** {H13830} The [sqlite3_column_value(S,N)] interface returns a 3761** pointer to an [unprotected sqlite3_value] object for the 3762** Nth column in the current row of the result set for 3763** the [prepared statement] S. 3764*/ 3765const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 3766int sqlite3_column_bytes(sqlite3_stmt*, int iCol); 3767int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 3768double sqlite3_column_double(sqlite3_stmt*, int iCol); 3769int sqlite3_column_int(sqlite3_stmt*, int iCol); 3770sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 3771const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 3772const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 3773int sqlite3_column_type(sqlite3_stmt*, int iCol); 3774sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 3775 3776/* 3777** CAPI3REF: Destroy A Prepared Statement Object {H13300} <S70300><S30100> 3778** 3779** The sqlite3_finalize() function is called to delete a [prepared statement]. 3780** If the statement was executed successfully or not executed at all, then 3781** SQLITE_OK is returned. If execution of the statement failed then an 3782** [error code] or [extended error code] is returned. 3783** 3784** This routine can be called at any point during the execution of the 3785** [prepared statement]. If the virtual machine has not 3786** completed execution when this routine is called, that is like 3787** encountering an error or an [sqlite3_interrupt | interrupt]. 3788** Incomplete updates may be rolled back and transactions canceled, 3789** depending on the circumstances, and the 3790** [error code] returned will be [SQLITE_ABORT]. 3791** 3792** INVARIANTS: 3793** 3794** {H11302} The [sqlite3_finalize(S)] interface destroys the 3795** [prepared statement] S and releases all 3796** memory and file resources held by that object. 3797** 3798** {H11304} If the most recent call to [sqlite3_step(S)] for the 3799** [prepared statement] S returned an error, 3800** then [sqlite3_finalize(S)] returns that same error. 3801*/ 3802int sqlite3_finalize(sqlite3_stmt *pStmt); 3803 3804/* 3805** CAPI3REF: Reset A Prepared Statement Object {H13330} <S70300> 3806** 3807** The sqlite3_reset() function is called to reset a [prepared statement] 3808** object back to its initial state, ready to be re-executed. 3809** Any SQL statement variables that had values bound to them using 3810** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 3811** Use [sqlite3_clear_bindings()] to reset the bindings. 3812** 3813** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S 3814** back to the beginning of its program. 3815** 3816** {H11334} If the most recent call to [sqlite3_step(S)] for the 3817** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 3818** or if [sqlite3_step(S)] has never before been called on S, 3819** then [sqlite3_reset(S)] returns [SQLITE_OK]. 3820** 3821** {H11336} If the most recent call to [sqlite3_step(S)] for the 3822** [prepared statement] S indicated an error, then 3823** [sqlite3_reset(S)] returns an appropriate [error code]. 3824** 3825** {H11338} The [sqlite3_reset(S)] interface does not change the values 3826** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 3827*/ 3828int sqlite3_reset(sqlite3_stmt *pStmt); 3829 3830/* 3831** CAPI3REF: Create Or Redefine SQL Functions {H16100} <S20200> 3832** KEYWORDS: {function creation routines} 3833** KEYWORDS: {application-defined SQL function} 3834** KEYWORDS: {application-defined SQL functions} 3835** 3836** These two functions (collectively known as "function creation routines") 3837** are used to add SQL functions or aggregates or to redefine the behavior 3838** of existing SQL functions or aggregates. The only difference between the 3839** two is that the second parameter, the name of the (scalar) function or 3840** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16 3841** for sqlite3_create_function16(). 3842** 3843** The first parameter is the [database connection] to which the SQL 3844** function is to be added. If a single program uses more than one database 3845** connection internally, then SQL functions must be added individually to 3846** each database connection. 3847** 3848** The second parameter is the name of the SQL function to be created or 3849** redefined. The length of the name is limited to 255 bytes, exclusive of 3850** the zero-terminator. Note that the name length limit is in bytes, not 3851** characters. Any attempt to create a function with a longer name 3852** will result in [SQLITE_ERROR] being returned. 3853** 3854** The third parameter (nArg) 3855** is the number of arguments that the SQL function or 3856** aggregate takes. If this parameter is negative, then the SQL function or 3857** aggregate may take any number of arguments. 3858** 3859** The fourth parameter, eTextRep, specifies what 3860** [SQLITE_UTF8 | text encoding] this SQL function prefers for 3861** its parameters. Any SQL function implementation should be able to work 3862** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be 3863** more efficient with one encoding than another. It is allowed to 3864** invoke sqlite3_create_function() or sqlite3_create_function16() multiple 3865** times with the same function but with different values of eTextRep. 3866** When multiple implementations of the same function are available, SQLite 3867** will pick the one that involves the least amount of data conversion. 3868** If there is only a single implementation which does not care what text 3869** encoding is used, then the fourth argument should be [SQLITE_ANY]. 3870** 3871** The fifth parameter is an arbitrary pointer. The implementation of the 3872** function can gain access to this pointer using [sqlite3_user_data()]. 3873** 3874** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are 3875** pointers to C-language functions that implement the SQL function or 3876** aggregate. A scalar SQL function requires an implementation of the xFunc 3877** callback only, NULL pointers should be passed as the xStep and xFinal 3878** parameters. An aggregate SQL function requires an implementation of xStep 3879** and xFinal and NULL should be passed for xFunc. To delete an existing 3880** SQL function or aggregate, pass NULL for all three function callbacks. 3881** 3882** It is permitted to register multiple implementations of the same 3883** functions with the same name but with either differing numbers of 3884** arguments or differing preferred text encodings. SQLite will use 3885** the implementation most closely matches the way in which the 3886** SQL function is used. A function implementation with a non-negative 3887** nArg parameter is a better match than a function implementation with 3888** a negative nArg. A function where the preferred text encoding 3889** matches the database encoding is a better 3890** match than a function where the encoding is different. 3891** A function where the encoding difference is between UTF16le and UTF16be 3892** is a closer match than a function where the encoding difference is 3893** between UTF8 and UTF16. 3894** 3895** Built-in functions may be overloaded by new application-defined functions. 3896** The first application-defined function with a given name overrides all 3897** built-in functions in the same [database connection] with the same name. 3898** Subsequent application-defined functions of the same name only override 3899** prior application-defined functions that are an exact match for the 3900** number of parameters and preferred encoding. 3901** 3902** An application-defined function is permitted to call other 3903** SQLite interfaces. However, such calls must not 3904** close the database connection nor finalize or reset the prepared 3905** statement in which the function is running. 3906** 3907** INVARIANTS: 3908** 3909** {H16103} The [sqlite3_create_function16(D,X,...)] interface shall behave 3910** as [sqlite3_create_function(D,X,...)] in every way except that it 3911** interprets the X argument as zero-terminated UTF-16 3912** native byte order instead of as zero-terminated UTF-8. 3913** 3914** {H16106} A successful invocation of the 3915** [sqlite3_create_function(D,X,N,E,...)] interface shall register 3916** or replaces callback functions in the [database connection] D 3917** used to implement the SQL function named X with N parameters 3918** and having a preferred text encoding of E. 3919** 3920** {H16109} A successful call to [sqlite3_create_function(D,X,N,E,P,F,S,L)] 3921** shall replace the P, F, S, and L values from any prior calls with 3922** the same D, X, N, and E values. 3923** 3924** {H16112} The [sqlite3_create_function(D,X,...)] interface shall fail 3925** if the SQL function name X is 3926** longer than 255 bytes exclusive of the zero terminator. 3927** 3928** {H16118} The [sqlite3_create_function(D,X,N,E,P,F,S,L)] interface 3929** shall fail unless either F is NULL and S and L are non-NULL or 3930*** F is non-NULL and S and L are NULL. 3931** 3932** {H16121} The [sqlite3_create_function(D,...)] interface shall fails with an 3933** error code of [SQLITE_BUSY] if there exist [prepared statements] 3934** associated with the [database connection] D. 3935** 3936** {H16124} The [sqlite3_create_function(D,X,N,...)] interface shall fail with 3937** an error code of [SQLITE_ERROR] if parameter N is less 3938** than -1 or greater than 127. 3939** 3940** {H16127} When N is non-negative, the [sqlite3_create_function(D,X,N,...)] 3941** interface shall register callbacks to be invoked for the 3942** SQL function 3943** named X when the number of arguments to the SQL function is 3944** exactly N. 3945** 3946** {H16130} When N is -1, the [sqlite3_create_function(D,X,N,...)] 3947** interface shall register callbacks to be invoked for the SQL 3948** function named X with any number of arguments. 3949** 3950** {H16133} When calls to [sqlite3_create_function(D,X,N,...)] 3951** specify multiple implementations of the same function X 3952** and when one implementation has N>=0 and the other has N=(-1) 3953** the implementation with a non-zero N shall be preferred. 3954** 3955** {H16136} When calls to [sqlite3_create_function(D,X,N,E,...)] 3956** specify multiple implementations of the same function X with 3957** the same number of arguments N but with different 3958** encodings E, then the implementation where E matches the 3959** database encoding shall preferred. 3960** 3961** {H16139} For an aggregate SQL function created using 3962** [sqlite3_create_function(D,X,N,E,P,0,S,L)] the finalizer 3963** function L shall always be invoked exactly once if the 3964** step function S is called one or more times. 3965** 3966** {H16142} When SQLite invokes either the xFunc or xStep function of 3967** an application-defined SQL function or aggregate created 3968** by [sqlite3_create_function()] or [sqlite3_create_function16()], 3969** then the array of [sqlite3_value] objects passed as the 3970** third parameter shall be [protected sqlite3_value] objects. 3971*/ 3972int sqlite3_create_function( 3973 sqlite3 *db, 3974 const char *zFunctionName, 3975 int nArg, 3976 int eTextRep, 3977 void *pApp, 3978 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 3979 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 3980 void (*xFinal)(sqlite3_context*) 3981); 3982int sqlite3_create_function16( 3983 sqlite3 *db, 3984 const void *zFunctionName, 3985 int nArg, 3986 int eTextRep, 3987 void *pApp, 3988 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 3989 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 3990 void (*xFinal)(sqlite3_context*) 3991); 3992 3993/* 3994** CAPI3REF: Text Encodings {H10267} <S50200> <H16100> 3995** 3996** These constant define integer codes that represent the various 3997** text encodings supported by SQLite. 3998*/ 3999#define SQLITE_UTF8 1 4000#define SQLITE_UTF16LE 2 4001#define SQLITE_UTF16BE 3 4002#define SQLITE_UTF16 4 /* Use native byte order */ 4003#define SQLITE_ANY 5 /* sqlite3_create_function only */ 4004#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 4005 4006/* 4007** CAPI3REF: Deprecated Functions 4008** DEPRECATED 4009** 4010** These functions are [deprecated]. In order to maintain 4011** backwards compatibility with older code, these functions continue 4012** to be supported. However, new applications should avoid 4013** the use of these functions. To help encourage people to avoid 4014** using these functions, we are not going to tell you want they do. 4015*/ 4016SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 4017SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 4018SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 4019SQLITE_DEPRECATED int sqlite3_global_recover(void); 4020SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 4021SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); 4022 4023/* 4024** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} <S20200> 4025** 4026** The C-language implementation of SQL functions and aggregates uses 4027** this set of interface routines to access the parameter values on 4028** the function or aggregate. 4029** 4030** The xFunc (for scalar functions) or xStep (for aggregates) parameters 4031** to [sqlite3_create_function()] and [sqlite3_create_function16()] 4032** define callbacks that implement the SQL functions and aggregates. 4033** The 4th parameter to these callbacks is an array of pointers to 4034** [protected sqlite3_value] objects. There is one [sqlite3_value] object for 4035** each parameter to the SQL function. These routines are used to 4036** extract values from the [sqlite3_value] objects. 4037** 4038** These routines work only with [protected sqlite3_value] objects. 4039** Any attempt to use these routines on an [unprotected sqlite3_value] 4040** object results in undefined behavior. 4041** 4042** These routines work just like the corresponding [column access functions] 4043** except that these routines take a single [protected sqlite3_value] object 4044** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 4045** 4046** The sqlite3_value_text16() interface extracts a UTF-16 string 4047** in the native byte-order of the host machine. The 4048** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 4049** extract UTF-16 strings as big-endian and little-endian respectively. 4050** 4051** The sqlite3_value_numeric_type() interface attempts to apply 4052** numeric affinity to the value. This means that an attempt is 4053** made to convert the value to an integer or floating point. If 4054** such a conversion is possible without loss of information (in other 4055** words, if the value is a string that looks like a number) 4056** then the conversion is performed. Otherwise no conversion occurs. 4057** The [SQLITE_INTEGER | datatype] after conversion is returned. 4058** 4059** Please pay particular attention to the fact that the pointer returned 4060** from [sqlite3_value_blob()], [sqlite3_value_text()], or 4061** [sqlite3_value_text16()] can be invalidated by a subsequent call to 4062** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 4063** or [sqlite3_value_text16()]. 4064** 4065** These routines must be called from the same thread as 4066** the SQL function that supplied the [sqlite3_value*] parameters. 4067** 4068** INVARIANTS: 4069** 4070** {H15103} The [sqlite3_value_blob(V)] interface converts the 4071** [protected sqlite3_value] object V into a BLOB and then 4072** returns a pointer to the converted value. 4073** 4074** {H15106} The [sqlite3_value_bytes(V)] interface returns the 4075** number of bytes in the BLOB or string (exclusive of the 4076** zero terminator on the string) that was returned by the 4077** most recent call to [sqlite3_value_blob(V)] or 4078** [sqlite3_value_text(V)]. 4079** 4080** {H15109} The [sqlite3_value_bytes16(V)] interface returns the 4081** number of bytes in the string (exclusive of the 4082** zero terminator on the string) that was returned by the 4083** most recent call to [sqlite3_value_text16(V)], 4084** [sqlite3_value_text16be(V)], or [sqlite3_value_text16le(V)]. 4085** 4086** {H15112} The [sqlite3_value_double(V)] interface converts the 4087** [protected sqlite3_value] object V into a floating point value and 4088** returns a copy of that value. 4089** 4090** {H15115} The [sqlite3_value_int(V)] interface converts the 4091** [protected sqlite3_value] object V into a 64-bit signed integer and 4092** returns the lower 32 bits of that integer. 4093** 4094** {H15118} The [sqlite3_value_int64(V)] interface converts the 4095** [protected sqlite3_value] object V into a 64-bit signed integer and 4096** returns a copy of that integer. 4097** 4098** {H15121} The [sqlite3_value_text(V)] interface converts the 4099** [protected sqlite3_value] object V into a zero-terminated UTF-8 4100** string and returns a pointer to that string. 4101** 4102** {H15124} The [sqlite3_value_text16(V)] interface converts the 4103** [protected sqlite3_value] object V into a zero-terminated 2-byte 4104** aligned UTF-16 native byte order 4105** string and returns a pointer to that string. 4106** 4107** {H15127} The [sqlite3_value_text16be(V)] interface converts the 4108** [protected sqlite3_value] object V into a zero-terminated 2-byte 4109** aligned UTF-16 big-endian 4110** string and returns a pointer to that string. 4111** 4112** {H15130} The [sqlite3_value_text16le(V)] interface converts the 4113** [protected sqlite3_value] object V into a zero-terminated 2-byte 4114** aligned UTF-16 little-endian 4115** string and returns a pointer to that string. 4116** 4117** {H15133} The [sqlite3_value_type(V)] interface returns 4118** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT], 4119** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for 4120** the [sqlite3_value] object V. 4121** 4122** {H15136} The [sqlite3_value_numeric_type(V)] interface converts 4123** the [protected sqlite3_value] object V into either an integer or 4124** a floating point value if it can do so without loss of 4125** information, and returns one of [SQLITE_NULL], 4126** [SQLITE_INTEGER], [SQLITE_FLOAT], [SQLITE_TEXT], or 4127** [SQLITE_BLOB] as appropriate for the 4128** [protected sqlite3_value] object V after the conversion attempt. 4129*/ 4130const void *sqlite3_value_blob(sqlite3_value*); 4131int sqlite3_value_bytes(sqlite3_value*); 4132int sqlite3_value_bytes16(sqlite3_value*); 4133double sqlite3_value_double(sqlite3_value*); 4134int sqlite3_value_int(sqlite3_value*); 4135sqlite3_int64 sqlite3_value_int64(sqlite3_value*); 4136const unsigned char *sqlite3_value_text(sqlite3_value*); 4137const void *sqlite3_value_text16(sqlite3_value*); 4138const void *sqlite3_value_text16le(sqlite3_value*); 4139const void *sqlite3_value_text16be(sqlite3_value*); 4140int sqlite3_value_type(sqlite3_value*); 4141int sqlite3_value_numeric_type(sqlite3_value*); 4142 4143/* 4144** CAPI3REF: Obtain Aggregate Function Context {H16210} <S20200> 4145** 4146** The implementation of aggregate SQL functions use this routine to allocate 4147** a structure for storing their state. 4148** 4149** The first time the sqlite3_aggregate_context() routine is called for a 4150** particular aggregate, SQLite allocates nBytes of memory, zeroes out that 4151** memory, and returns a pointer to it. On second and subsequent calls to 4152** sqlite3_aggregate_context() for the same aggregate function index, 4153** the same buffer is returned. The implementation of the aggregate can use 4154** the returned buffer to accumulate data. 4155** 4156** SQLite automatically frees the allocated buffer when the aggregate 4157** query concludes. 4158** 4159** The first parameter should be a copy of the 4160** [sqlite3_context | SQL function context] that is the first parameter 4161** to the callback routine that implements the aggregate function. 4162** 4163** This routine must be called from the same thread in which 4164** the aggregate SQL function is running. 4165** 4166** INVARIANTS: 4167** 4168** {H16211} The first invocation of [sqlite3_aggregate_context(C,N)] for 4169** a particular instance of an aggregate function (for a particular 4170** context C) causes SQLite to allocate N bytes of memory, 4171** zero that memory, and return a pointer to the allocated memory. 4172** 4173** {H16213} If a memory allocation error occurs during 4174** [sqlite3_aggregate_context(C,N)] then the function returns 0. 4175** 4176** {H16215} Second and subsequent invocations of 4177** [sqlite3_aggregate_context(C,N)] for the same context pointer C 4178** ignore the N parameter and return a pointer to the same 4179** block of memory returned by the first invocation. 4180** 4181** {H16217} The memory allocated by [sqlite3_aggregate_context(C,N)] is 4182** automatically freed on the next call to [sqlite3_reset()] 4183** or [sqlite3_finalize()] for the [prepared statement] containing 4184** the aggregate function associated with context C. 4185*/ 4186void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); 4187 4188/* 4189** CAPI3REF: User Data For Functions {H16240} <S20200> 4190** 4191** The sqlite3_user_data() interface returns a copy of 4192** the pointer that was the pUserData parameter (the 5th parameter) 4193** of the [sqlite3_create_function()] 4194** and [sqlite3_create_function16()] routines that originally 4195** registered the application defined function. {END} 4196** 4197** This routine must be called from the same thread in which 4198** the application-defined function is running. 4199** 4200** INVARIANTS: 4201** 4202** {H16243} The [sqlite3_user_data(C)] interface returns a copy of the 4203** P pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)] 4204** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that 4205** registered the SQL function associated with [sqlite3_context] C. 4206*/ 4207void *sqlite3_user_data(sqlite3_context*); 4208 4209/* 4210** CAPI3REF: Database Connection For Functions {H16250} <S60600><S20200> 4211** 4212** The sqlite3_context_db_handle() interface returns a copy of 4213** the pointer to the [database connection] (the 1st parameter) 4214** of the [sqlite3_create_function()] 4215** and [sqlite3_create_function16()] routines that originally 4216** registered the application defined function. 4217** 4218** INVARIANTS: 4219** 4220** {H16253} The [sqlite3_context_db_handle(C)] interface returns a copy of the 4221** D pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)] 4222** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that 4223** registered the SQL function associated with [sqlite3_context] C. 4224*/ 4225sqlite3 *sqlite3_context_db_handle(sqlite3_context*); 4226 4227/* 4228** CAPI3REF: Function Auxiliary Data {H16270} <S20200> 4229** 4230** The following two functions may be used by scalar SQL functions to 4231** associate metadata with argument values. If the same value is passed to 4232** multiple invocations of the same SQL function during query execution, under 4233** some circumstances the associated metadata may be preserved. This may 4234** be used, for example, to add a regular-expression matching scalar 4235** function. The compiled version of the regular expression is stored as 4236** metadata associated with the SQL value passed as the regular expression 4237** pattern. The compiled regular expression can be reused on multiple 4238** invocations of the same function so that the original pattern string 4239** does not need to be recompiled on each invocation. 4240** 4241** The sqlite3_get_auxdata() interface returns a pointer to the metadata 4242** associated by the sqlite3_set_auxdata() function with the Nth argument 4243** value to the application-defined function. If no metadata has been ever 4244** been set for the Nth argument of the function, or if the corresponding 4245** function parameter has changed since the meta-data was set, 4246** then sqlite3_get_auxdata() returns a NULL pointer. 4247** 4248** The sqlite3_set_auxdata() interface saves the metadata 4249** pointed to by its 3rd parameter as the metadata for the N-th 4250** argument of the application-defined function. Subsequent 4251** calls to sqlite3_get_auxdata() might return this data, if it has 4252** not been destroyed. 4253** If it is not NULL, SQLite will invoke the destructor 4254** function given by the 4th parameter to sqlite3_set_auxdata() on 4255** the metadata when the corresponding function parameter changes 4256** or when the SQL statement completes, whichever comes first. 4257** 4258** SQLite is free to call the destructor and drop metadata on any 4259** parameter of any function at any time. The only guarantee is that 4260** the destructor will be called before the metadata is dropped. 4261** 4262** In practice, metadata is preserved between function calls for 4263** expressions that are constant at compile time. This includes literal 4264** values and SQL variables. 4265** 4266** These routines must be called from the same thread in which 4267** the SQL function is running. 4268** 4269** INVARIANTS: 4270** 4271** {H16272} The [sqlite3_get_auxdata(C,N)] interface returns a pointer 4272** to metadata associated with the Nth parameter of the SQL function 4273** whose context is C, or NULL if there is no metadata associated 4274** with that parameter. 4275** 4276** {H16274} The [sqlite3_set_auxdata(C,N,P,D)] interface assigns a metadata 4277** pointer P to the Nth parameter of the SQL function with context C. 4278** 4279** {H16276} SQLite will invoke the destructor D with a single argument 4280** which is the metadata pointer P following a call to 4281** [sqlite3_set_auxdata(C,N,P,D)] when SQLite ceases to hold 4282** the metadata. 4283** 4284** {H16277} SQLite ceases to hold metadata for an SQL function parameter 4285** when the value of that parameter changes. 4286** 4287** {H16278} When [sqlite3_set_auxdata(C,N,P,D)] is invoked, the destructor 4288** is called for any prior metadata associated with the same function 4289** context C and parameter N. 4290** 4291** {H16279} SQLite will call destructors for any metadata it is holding 4292** in a particular [prepared statement] S when either 4293** [sqlite3_reset(S)] or [sqlite3_finalize(S)] is called. 4294*/ 4295void *sqlite3_get_auxdata(sqlite3_context*, int N); 4296void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 4297 4298 4299/* 4300** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} <S30100> 4301** 4302** These are special values for the destructor that is passed in as the 4303** final argument to routines like [sqlite3_result_blob()]. If the destructor 4304** argument is SQLITE_STATIC, it means that the content pointer is constant 4305** and will never change. It does not need to be destroyed. The 4306** SQLITE_TRANSIENT value means that the content will likely change in 4307** the near future and that SQLite should make its own private copy of 4308** the content before returning. 4309** 4310** The typedef is necessary to work around problems in certain 4311** C++ compilers. See ticket #2191. 4312*/ 4313typedef void (*sqlite3_destructor_type)(void*); 4314#define SQLITE_STATIC ((sqlite3_destructor_type)0) 4315#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 4316 4317/* 4318** CAPI3REF: Setting The Result Of An SQL Function {H16400} <S20200> 4319** 4320** These routines are used by the xFunc or xFinal callbacks that 4321** implement SQL functions and aggregates. See 4322** [sqlite3_create_function()] and [sqlite3_create_function16()] 4323** for additional information. 4324** 4325** These functions work very much like the [parameter binding] family of 4326** functions used to bind values to host parameters in prepared statements. 4327** Refer to the [SQL parameter] documentation for additional information. 4328** 4329** The sqlite3_result_blob() interface sets the result from 4330** an application-defined function to be the BLOB whose content is pointed 4331** to by the second parameter and which is N bytes long where N is the 4332** third parameter. 4333** 4334** The sqlite3_result_zeroblob() interfaces set the result of 4335** the application-defined function to be a BLOB containing all zero 4336** bytes and N bytes in size, where N is the value of the 2nd parameter. 4337** 4338** The sqlite3_result_double() interface sets the result from 4339** an application-defined function to be a floating point value specified 4340** by its 2nd argument. 4341** 4342** The sqlite3_result_error() and sqlite3_result_error16() functions 4343** cause the implemented SQL function to throw an exception. 4344** SQLite uses the string pointed to by the 4345** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 4346** as the text of an error message. SQLite interprets the error 4347** message string from sqlite3_result_error() as UTF-8. SQLite 4348** interprets the string from sqlite3_result_error16() as UTF-16 in native 4349** byte order. If the third parameter to sqlite3_result_error() 4350** or sqlite3_result_error16() is negative then SQLite takes as the error 4351** message all text up through the first zero character. 4352** If the third parameter to sqlite3_result_error() or 4353** sqlite3_result_error16() is non-negative then SQLite takes that many 4354** bytes (not characters) from the 2nd parameter as the error message. 4355** The sqlite3_result_error() and sqlite3_result_error16() 4356** routines make a private copy of the error message text before 4357** they return. Hence, the calling function can deallocate or 4358** modify the text after they return without harm. 4359** The sqlite3_result_error_code() function changes the error code 4360** returned by SQLite as a result of an error in a function. By default, 4361** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error() 4362** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 4363** 4364** The sqlite3_result_toobig() interface causes SQLite to throw an error 4365** indicating that a string or BLOB is to long to represent. 4366** 4367** The sqlite3_result_nomem() interface causes SQLite to throw an error 4368** indicating that a memory allocation failed. 4369** 4370** The sqlite3_result_int() interface sets the return value 4371** of the application-defined function to be the 32-bit signed integer 4372** value given in the 2nd argument. 4373** The sqlite3_result_int64() interface sets the return value 4374** of the application-defined function to be the 64-bit signed integer 4375** value given in the 2nd argument. 4376** 4377** The sqlite3_result_null() interface sets the return value 4378** of the application-defined function to be NULL. 4379** 4380** The sqlite3_result_text(), sqlite3_result_text16(), 4381** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 4382** set the return value of the application-defined function to be 4383** a text string which is represented as UTF-8, UTF-16 native byte order, 4384** UTF-16 little endian, or UTF-16 big endian, respectively. 4385** SQLite takes the text result from the application from 4386** the 2nd parameter of the sqlite3_result_text* interfaces. 4387** If the 3rd parameter to the sqlite3_result_text* interfaces 4388** is negative, then SQLite takes result text from the 2nd parameter 4389** through the first zero character. 4390** If the 3rd parameter to the sqlite3_result_text* interfaces 4391** is non-negative, then as many bytes (not characters) of the text 4392** pointed to by the 2nd parameter are taken as the application-defined 4393** function result. 4394** If the 4th parameter to the sqlite3_result_text* interfaces 4395** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 4396** function as the destructor on the text or BLOB result when it has 4397** finished using that result. 4398** If the 4th parameter to the sqlite3_result_text* interfaces or 4399** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 4400** assumes that the text or BLOB result is in constant space and does not 4401** copy the it or call a destructor when it has finished using that result. 4402** If the 4th parameter to the sqlite3_result_text* interfaces 4403** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 4404** then SQLite makes a copy of the result into space obtained from 4405** from [sqlite3_malloc()] before it returns. 4406** 4407** The sqlite3_result_value() interface sets the result of 4408** the application-defined function to be a copy the 4409** [unprotected sqlite3_value] object specified by the 2nd parameter. The 4410** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 4411** so that the [sqlite3_value] specified in the parameter may change or 4412** be deallocated after sqlite3_result_value() returns without harm. 4413** A [protected sqlite3_value] object may always be used where an 4414** [unprotected sqlite3_value] object is required, so either 4415** kind of [sqlite3_value] object can be used with this interface. 4416** 4417** If these routines are called from within the different thread 4418** than the one containing the application-defined function that received 4419** the [sqlite3_context] pointer, the results are undefined. 4420** 4421** INVARIANTS: 4422** 4423** {H16403} The default return value from any SQL function is NULL. 4424** 4425** {H16406} The [sqlite3_result_blob(C,V,N,D)] interface changes the 4426** return value of function C to be a BLOB that is N bytes 4427** in length and with content pointed to by V. 4428** 4429** {H16409} The [sqlite3_result_double(C,V)] interface changes the 4430** return value of function C to be the floating point value V. 4431** 4432** {H16412} The [sqlite3_result_error(C,V,N)] interface changes the return 4433** value of function C to be an exception with error code 4434** [SQLITE_ERROR] and a UTF-8 error message copied from V up to the 4435** first zero byte or until N bytes are read if N is positive. 4436** 4437** {H16415} The [sqlite3_result_error16(C,V,N)] interface changes the return 4438** value of function C to be an exception with error code 4439** [SQLITE_ERROR] and a UTF-16 native byte order error message 4440** copied from V up to the first zero terminator or until N bytes 4441** are read if N is positive. 4442** 4443** {H16418} The [sqlite3_result_error_toobig(C)] interface changes the return 4444** value of the function C to be an exception with error code 4445** [SQLITE_TOOBIG] and an appropriate error message. 4446** 4447** {H16421} The [sqlite3_result_error_nomem(C)] interface changes the return 4448** value of the function C to be an exception with error code 4449** [SQLITE_NOMEM] and an appropriate error message. 4450** 4451** {H16424} The [sqlite3_result_error_code(C,E)] interface changes the return 4452** value of the function C to be an exception with error code E. 4453** The error message text is unchanged. 4454** 4455** {H16427} The [sqlite3_result_int(C,V)] interface changes the 4456** return value of function C to be the 32-bit integer value V. 4457** 4458** {H16430} The [sqlite3_result_int64(C,V)] interface changes the 4459** return value of function C to be the 64-bit integer value V. 4460** 4461** {H16433} The [sqlite3_result_null(C)] interface changes the 4462** return value of function C to be NULL. 4463** 4464** {H16436} The [sqlite3_result_text(C,V,N,D)] interface changes the 4465** return value of function C to be the UTF-8 string 4466** V up to the first zero if N is negative 4467** or the first N bytes of V if N is non-negative. 4468** 4469** {H16439} The [sqlite3_result_text16(C,V,N,D)] interface changes the 4470** return value of function C to be the UTF-16 native byte order 4471** string V up to the first zero if N is negative 4472** or the first N bytes of V if N is non-negative. 4473** 4474** {H16442} The [sqlite3_result_text16be(C,V,N,D)] interface changes the 4475** return value of function C to be the UTF-16 big-endian 4476** string V up to the first zero if N is negative 4477** or the first N bytes or V if N is non-negative. 4478** 4479** {H16445} The [sqlite3_result_text16le(C,V,N,D)] interface changes the 4480** return value of function C to be the UTF-16 little-endian 4481** string V up to the first zero if N is negative 4482** or the first N bytes of V if N is non-negative. 4483** 4484** {H16448} The [sqlite3_result_value(C,V)] interface changes the 4485** return value of function C to be the [unprotected sqlite3_value] 4486** object V. 4487** 4488** {H16451} The [sqlite3_result_zeroblob(C,N)] interface changes the 4489** return value of function C to be an N-byte BLOB of all zeros. 4490** 4491** {H16454} The [sqlite3_result_error()] and [sqlite3_result_error16()] 4492** interfaces make a copy of their error message strings before 4493** returning. 4494** 4495** {H16457} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], 4496** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], 4497** [sqlite3_result_text16be(C,V,N,D)], or 4498** [sqlite3_result_text16le(C,V,N,D)] is the constant [SQLITE_STATIC] 4499** then no destructor is ever called on the pointer V and SQLite 4500** assumes that V is immutable. 4501** 4502** {H16460} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], 4503** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], 4504** [sqlite3_result_text16be(C,V,N,D)], or 4505** [sqlite3_result_text16le(C,V,N,D)] is the constant 4506** [SQLITE_TRANSIENT] then the interfaces makes a copy of the 4507** content of V and retains the copy. 4508** 4509** {H16463} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], 4510** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], 4511** [sqlite3_result_text16be(C,V,N,D)], or 4512** [sqlite3_result_text16le(C,V,N,D)] is some value other than 4513** the constants [SQLITE_STATIC] and [SQLITE_TRANSIENT] then 4514** SQLite will invoke the destructor D with V as its only argument 4515** when it has finished with the V value. 4516*/ 4517void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 4518void sqlite3_result_double(sqlite3_context*, double); 4519void sqlite3_result_error(sqlite3_context*, const char*, int); 4520void sqlite3_result_error16(sqlite3_context*, const void*, int); 4521void sqlite3_result_error_toobig(sqlite3_context*); 4522void sqlite3_result_error_nomem(sqlite3_context*); 4523void sqlite3_result_error_code(sqlite3_context*, int); 4524void sqlite3_result_int(sqlite3_context*, int); 4525void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 4526void sqlite3_result_null(sqlite3_context*); 4527void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 4528void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 4529void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 4530void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 4531void sqlite3_result_value(sqlite3_context*, sqlite3_value*); 4532void sqlite3_result_zeroblob(sqlite3_context*, int n); 4533 4534/* 4535** CAPI3REF: Define New Collating Sequences {H16600} <S20300> 4536** 4537** These functions are used to add new collation sequences to the 4538** [database connection] specified as the first argument. 4539** 4540** The name of the new collation sequence is specified as a UTF-8 string 4541** for sqlite3_create_collation() and sqlite3_create_collation_v2() 4542** and a UTF-16 string for sqlite3_create_collation16(). In all cases 4543** the name is passed as the second function argument. 4544** 4545** The third argument may be one of the constants [SQLITE_UTF8], 4546** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied 4547** routine expects to be passed pointers to strings encoded using UTF-8, 4548** UTF-16 little-endian, or UTF-16 big-endian, respectively. The 4549** third argument might also be [SQLITE_UTF16_ALIGNED] to indicate that 4550** the routine expects pointers to 16-bit word aligned strings 4551** of UTF-16 in the native byte order of the host computer. 4552** 4553** A pointer to the user supplied routine must be passed as the fifth 4554** argument. If it is NULL, this is the same as deleting the collation 4555** sequence (so that SQLite cannot call it anymore). 4556** Each time the application supplied function is invoked, it is passed 4557** as its first parameter a copy of the void* passed as the fourth argument 4558** to sqlite3_create_collation() or sqlite3_create_collation16(). 4559** 4560** The remaining arguments to the application-supplied routine are two strings, 4561** each represented by a (length, data) pair and encoded in the encoding 4562** that was passed as the third argument when the collation sequence was 4563** registered. {END} The application defined collation routine should 4564** return negative, zero or positive if the first string is less than, 4565** equal to, or greater than the second string. i.e. (STRING1 - STRING2). 4566** 4567** The sqlite3_create_collation_v2() works like sqlite3_create_collation() 4568** except that it takes an extra argument which is a destructor for 4569** the collation. The destructor is called when the collation is 4570** destroyed and is passed a copy of the fourth parameter void* pointer 4571** of the sqlite3_create_collation_v2(). 4572** Collations are destroyed when they are overridden by later calls to the 4573** collation creation functions or when the [database connection] is closed 4574** using [sqlite3_close()]. 4575** 4576** INVARIANTS: 4577** 4578** {H16603} A successful call to the 4579** [sqlite3_create_collation_v2(B,X,E,P,F,D)] interface 4580** registers function F as the comparison function used to 4581** implement collation X on the [database connection] B for 4582** databases having encoding E. 4583** 4584** {H16604} SQLite understands the X parameter to 4585** [sqlite3_create_collation_v2(B,X,E,P,F,D)] as a zero-terminated 4586** UTF-8 string in which case is ignored for ASCII characters and 4587** is significant for non-ASCII characters. 4588** 4589** {H16606} Successive calls to [sqlite3_create_collation_v2(B,X,E,P,F,D)] 4590** with the same values for B, X, and E, override prior values 4591** of P, F, and D. 4592** 4593** {H16609} If the destructor D in [sqlite3_create_collation_v2(B,X,E,P,F,D)] 4594** is not NULL then it is called with argument P when the 4595** collating function is dropped by SQLite. 4596** 4597** {H16612} A collating function is dropped when it is overloaded. 4598** 4599** {H16615} A collating function is dropped when the database connection 4600** is closed using [sqlite3_close()]. 4601** 4602** {H16618} The pointer P in [sqlite3_create_collation_v2(B,X,E,P,F,D)] 4603** is passed through as the first parameter to the comparison 4604** function F for all subsequent invocations of F. 4605** 4606** {H16621} A call to [sqlite3_create_collation(B,X,E,P,F)] is exactly 4607** the same as a call to [sqlite3_create_collation_v2()] with 4608** the same parameters and a NULL destructor. 4609** 4610** {H16624} Following a [sqlite3_create_collation_v2(B,X,E,P,F,D)], 4611** SQLite uses the comparison function F for all text comparison 4612** operations on the [database connection] B on text values that 4613** use the collating sequence named X. 4614** 4615** {H16627} The [sqlite3_create_collation16(B,X,E,P,F)] works the same 4616** as [sqlite3_create_collation(B,X,E,P,F)] except that the 4617** collation name X is understood as UTF-16 in native byte order 4618** instead of UTF-8. 4619** 4620** {H16630} When multiple comparison functions are available for the same 4621** collating sequence, SQLite chooses the one whose text encoding 4622** requires the least amount of conversion from the default 4623** text encoding of the database. 4624*/ 4625int sqlite3_create_collation( 4626 sqlite3*, 4627 const char *zName, 4628 int eTextRep, 4629 void*, 4630 int(*xCompare)(void*,int,const void*,int,const void*) 4631); 4632int sqlite3_create_collation_v2( 4633 sqlite3*, 4634 const char *zName, 4635 int eTextRep, 4636 void*, 4637 int(*xCompare)(void*,int,const void*,int,const void*), 4638 void(*xDestroy)(void*) 4639); 4640int sqlite3_create_collation16( 4641 sqlite3*, 4642 const void *zName, 4643 int eTextRep, 4644 void*, 4645 int(*xCompare)(void*,int,const void*,int,const void*) 4646); 4647 4648/* 4649** CAPI3REF: Collation Needed Callbacks {H16700} <S20300> 4650** 4651** To avoid having to register all collation sequences before a database 4652** can be used, a single callback function may be registered with the 4653** [database connection] to be called whenever an undefined collation 4654** sequence is required. 4655** 4656** If the function is registered using the sqlite3_collation_needed() API, 4657** then it is passed the names of undefined collation sequences as strings 4658** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used, 4659** the names are passed as UTF-16 in machine native byte order. 4660** A call to either function replaces any existing callback. 4661** 4662** When the callback is invoked, the first argument passed is a copy 4663** of the second argument to sqlite3_collation_needed() or 4664** sqlite3_collation_needed16(). The second argument is the database 4665** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 4666** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 4667** sequence function required. The fourth parameter is the name of the 4668** required collation sequence. 4669** 4670** The callback function should register the desired collation using 4671** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 4672** [sqlite3_create_collation_v2()]. 4673** 4674** INVARIANTS: 4675** 4676** {H16702} A successful call to [sqlite3_collation_needed(D,P,F)] 4677** or [sqlite3_collation_needed16(D,P,F)] causes 4678** the [database connection] D to invoke callback F with first 4679** parameter P whenever it needs a comparison function for a 4680** collating sequence that it does not know about. 4681** 4682** {H16704} Each successful call to [sqlite3_collation_needed()] or 4683** [sqlite3_collation_needed16()] overrides the callback registered 4684** on the same [database connection] by prior calls to either 4685** interface. 4686** 4687** {H16706} The name of the requested collating function passed in the 4688** 4th parameter to the callback is in UTF-8 if the callback 4689** was registered using [sqlite3_collation_needed()] and 4690** is in UTF-16 native byte order if the callback was 4691** registered using [sqlite3_collation_needed16()]. 4692*/ 4693int sqlite3_collation_needed( 4694 sqlite3*, 4695 void*, 4696 void(*)(void*,sqlite3*,int eTextRep,const char*) 4697); 4698int sqlite3_collation_needed16( 4699 sqlite3*, 4700 void*, 4701 void(*)(void*,sqlite3*,int eTextRep,const void*) 4702); 4703 4704/* 4705** Specify the key for an encrypted database. This routine should be 4706** called right after sqlite3_open(). 4707** 4708** The code to implement this API is not available in the public release 4709** of SQLite. 4710*/ 4711int sqlite3_key( 4712 sqlite3 *db, /* Database to be rekeyed */ 4713 const void *pKey, int nKey /* The key */ 4714); 4715 4716/* 4717** Change the key on an open database. If the current database is not 4718** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 4719** database is decrypted. 4720** 4721** The code to implement this API is not available in the public release 4722** of SQLite. 4723*/ 4724int sqlite3_rekey( 4725 sqlite3 *db, /* Database to be rekeyed */ 4726 const void *pKey, int nKey /* The new key */ 4727); 4728 4729/* 4730** CAPI3REF: Suspend Execution For A Short Time {H10530} <S40410> 4731** 4732** The sqlite3_sleep() function causes the current thread to suspend execution 4733** for at least a number of milliseconds specified in its parameter. 4734** 4735** If the operating system does not support sleep requests with 4736** millisecond time resolution, then the time will be rounded up to 4737** the nearest second. The number of milliseconds of sleep actually 4738** requested from the operating system is returned. 4739** 4740** SQLite implements this interface by calling the xSleep() 4741** method of the default [sqlite3_vfs] object. 4742** 4743** INVARIANTS: 4744** 4745** {H10533} The [sqlite3_sleep(M)] interface invokes the xSleep 4746** method of the default [sqlite3_vfs|VFS] in order to 4747** suspend execution of the current thread for at least 4748** M milliseconds. 4749** 4750** {H10536} The [sqlite3_sleep(M)] interface returns the number of 4751** milliseconds of sleep actually requested of the operating 4752** system, which might be larger than the parameter M. 4753*/ 4754int sqlite3_sleep(int); 4755 4756/* 4757** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} <S20000> 4758** 4759** If this global variable is made to point to a string which is 4760** the name of a folder (a.k.a. directory), then all temporary files 4761** created by SQLite will be placed in that directory. If this variable 4762** is a NULL pointer, then SQLite performs a search for an appropriate 4763** temporary file directory. 4764** 4765** It is not safe to modify this variable once a [database connection] 4766** has been opened. It is intended that this variable be set once 4767** as part of process initialization and before any SQLite interface 4768** routines have been call and remain unchanged thereafter. 4769*/ 4770SQLITE_EXTERN char *sqlite3_temp_directory; 4771 4772/* 4773** CAPI3REF: Test For Auto-Commit Mode {H12930} <S60200> 4774** KEYWORDS: {autocommit mode} 4775** 4776** The sqlite3_get_autocommit() interface returns non-zero or 4777** zero if the given database connection is or is not in autocommit mode, 4778** respectively. Autocommit mode is on by default. 4779** Autocommit mode is disabled by a [BEGIN] statement. 4780** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 4781** 4782** If certain kinds of errors occur on a statement within a multi-statement 4783** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 4784** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 4785** transaction might be rolled back automatically. The only way to 4786** find out whether SQLite automatically rolled back the transaction after 4787** an error is to use this function. 4788** 4789** INVARIANTS: 4790** 4791** {H12931} The [sqlite3_get_autocommit(D)] interface returns non-zero or 4792** zero if the [database connection] D is or is not in autocommit 4793** mode, respectively. 4794** 4795** {H12932} Autocommit mode is on by default. 4796** 4797** {H12933} Autocommit mode is disabled by a successful [BEGIN] statement. 4798** 4799** {H12934} Autocommit mode is enabled by a successful [COMMIT] or [ROLLBACK] 4800** statement. 4801** 4802** ASSUMPTIONS: 4803** 4804** {A12936} If another thread changes the autocommit status of the database 4805** connection while this routine is running, then the return value 4806** is undefined. 4807*/ 4808int sqlite3_get_autocommit(sqlite3*); 4809 4810/* 4811** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} <S60600> 4812** 4813** The sqlite3_db_handle interface returns the [database connection] handle 4814** to which a [prepared statement] belongs. The database handle returned by 4815** sqlite3_db_handle is the same database handle that was the first argument 4816** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 4817** create the statement in the first place. 4818** 4819** INVARIANTS: 4820** 4821** {H13123} The [sqlite3_db_handle(S)] interface returns a pointer 4822** to the [database connection] associated with the 4823** [prepared statement] S. 4824*/ 4825sqlite3 *sqlite3_db_handle(sqlite3_stmt*); 4826 4827/* 4828** CAPI3REF: Find the next prepared statement {H13140} <S60600> 4829** 4830** This interface returns a pointer to the next [prepared statement] after 4831** pStmt associated with the [database connection] pDb. If pStmt is NULL 4832** then this interface returns a pointer to the first prepared statement 4833** associated with the database connection pDb. If no prepared statement 4834** satisfies the conditions of this routine, it returns NULL. 4835** 4836** INVARIANTS: 4837** 4838** {H13143} If D is a [database connection] that holds one or more 4839** unfinalized [prepared statements] and S is a NULL pointer, 4840** then [sqlite3_next_stmt(D, S)] routine shall return a pointer 4841** to one of the prepared statements associated with D. 4842** 4843** {H13146} If D is a [database connection] that holds no unfinalized 4844** [prepared statements] and S is a NULL pointer, then 4845** [sqlite3_next_stmt(D, S)] routine shall return a NULL pointer. 4846** 4847** {H13149} If S is a [prepared statement] in the [database connection] D 4848** and S is not the last prepared statement in D, then 4849** [sqlite3_next_stmt(D, S)] routine shall return a pointer 4850** to the next prepared statement in D after S. 4851** 4852** {H13152} If S is the last [prepared statement] in the 4853** [database connection] D then the [sqlite3_next_stmt(D, S)] 4854** routine shall return a NULL pointer. 4855** 4856** ASSUMPTIONS: 4857** 4858** {A13154} The [database connection] pointer D in a call to 4859** [sqlite3_next_stmt(D,S)] must refer to an open database 4860** connection and in particular must not be a NULL pointer. 4861*/ 4862sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 4863 4864/* 4865** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} <S60400> 4866** 4867** The sqlite3_commit_hook() interface registers a callback 4868** function to be invoked whenever a transaction is committed. 4869** Any callback set by a previous call to sqlite3_commit_hook() 4870** for the same database connection is overridden. 4871** The sqlite3_rollback_hook() interface registers a callback 4872** function to be invoked whenever a transaction is committed. 4873** Any callback set by a previous call to sqlite3_commit_hook() 4874** for the same database connection is overridden. 4875** The pArg argument is passed through to the callback. 4876** If the callback on a commit hook function returns non-zero, 4877** then the commit is converted into a rollback. 4878** 4879** If another function was previously registered, its 4880** pArg value is returned. Otherwise NULL is returned. 4881** 4882** The callback implementation must not do anything that will modify 4883** the database connection that invoked the callback. Any actions 4884** to modify the database connection must be deferred until after the 4885** completion of the [sqlite3_step()] call that triggered the commit 4886** or rollback hook in the first place. 4887** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 4888** database connections for the meaning of "modify" in this paragraph. 4889** 4890** Registering a NULL function disables the callback. 4891** 4892** For the purposes of this API, a transaction is said to have been 4893** rolled back if an explicit "ROLLBACK" statement is executed, or 4894** an error or constraint causes an implicit rollback to occur. 4895** The rollback callback is not invoked if a transaction is 4896** automatically rolled back because the database connection is closed. 4897** The rollback callback is not invoked if a transaction is 4898** rolled back because a commit callback returned non-zero. 4899** <todo> Check on this </todo> 4900** 4901** INVARIANTS: 4902** 4903** {H12951} The [sqlite3_commit_hook(D,F,P)] interface registers the 4904** callback function F to be invoked with argument P whenever 4905** a transaction commits on the [database connection] D. 4906** 4907** {H12952} The [sqlite3_commit_hook(D,F,P)] interface returns the P argument 4908** from the previous call with the same [database connection] D, 4909** or NULL on the first call for a particular database connection D. 4910** 4911** {H12953} Each call to [sqlite3_commit_hook()] overwrites the callback 4912** registered by prior calls. 4913** 4914** {H12954} If the F argument to [sqlite3_commit_hook(D,F,P)] is NULL 4915** then the commit hook callback is canceled and no callback 4916** is invoked when a transaction commits. 4917** 4918** {H12955} If the commit callback returns non-zero then the commit is 4919** converted into a rollback. 4920** 4921** {H12961} The [sqlite3_rollback_hook(D,F,P)] interface registers the 4922** callback function F to be invoked with argument P whenever 4923** a transaction rolls back on the [database connection] D. 4924** 4925** {H12962} The [sqlite3_rollback_hook(D,F,P)] interface returns the P 4926** argument from the previous call with the same 4927** [database connection] D, or NULL on the first call 4928** for a particular database connection D. 4929** 4930** {H12963} Each call to [sqlite3_rollback_hook()] overwrites the callback 4931** registered by prior calls. 4932** 4933** {H12964} If the F argument to [sqlite3_rollback_hook(D,F,P)] is NULL 4934** then the rollback hook callback is canceled and no callback 4935** is invoked when a transaction rolls back. 4936*/ 4937void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 4938void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 4939 4940/* 4941** CAPI3REF: Data Change Notification Callbacks {H12970} <S60400> 4942** 4943** The sqlite3_update_hook() interface registers a callback function 4944** with the [database connection] identified by the first argument 4945** to be invoked whenever a row is updated, inserted or deleted. 4946** Any callback set by a previous call to this function 4947** for the same database connection is overridden. 4948** 4949** The second argument is a pointer to the function to invoke when a 4950** row is updated, inserted or deleted. 4951** The first argument to the callback is a copy of the third argument 4952** to sqlite3_update_hook(). 4953** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 4954** or [SQLITE_UPDATE], depending on the operation that caused the callback 4955** to be invoked. 4956** The third and fourth arguments to the callback contain pointers to the 4957** database and table name containing the affected row. 4958** The final callback parameter is the rowid of the row. In the case of 4959** an update, this is the rowid after the update takes place. 4960** 4961** The update hook is not invoked when internal system tables are 4962** modified (i.e. sqlite_master and sqlite_sequence). 4963** 4964** The update hook implementation must not do anything that will modify 4965** the database connection that invoked the update hook. Any actions 4966** to modify the database connection must be deferred until after the 4967** completion of the [sqlite3_step()] call that triggered the update hook. 4968** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 4969** database connections for the meaning of "modify" in this paragraph. 4970** 4971** If another function was previously registered, its pArg value 4972** is returned. Otherwise NULL is returned. 4973** 4974** INVARIANTS: 4975** 4976** {H12971} The [sqlite3_update_hook(D,F,P)] interface causes the callback 4977** function F to be invoked with first parameter P whenever 4978** a table row is modified, inserted, or deleted on 4979** the [database connection] D. 4980** 4981** {H12973} The [sqlite3_update_hook(D,F,P)] interface returns the value 4982** of P for the previous call on the same [database connection] D, 4983** or NULL for the first call. 4984** 4985** {H12975} If the update hook callback F in [sqlite3_update_hook(D,F,P)] 4986** is NULL then the no update callbacks are made. 4987** 4988** {H12977} Each call to [sqlite3_update_hook(D,F,P)] overrides prior calls 4989** to the same interface on the same [database connection] D. 4990** 4991** {H12979} The update hook callback is not invoked when internal system 4992** tables such as sqlite_master and sqlite_sequence are modified. 4993** 4994** {H12981} The second parameter to the update callback 4995** is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], 4996** depending on the operation that caused the callback to be invoked. 4997** 4998** {H12983} The third and fourth arguments to the callback contain pointers 4999** to zero-terminated UTF-8 strings which are the names of the 5000** database and table that is being updated. 5001 5002** {H12985} The final callback parameter is the rowid of the row after 5003** the change occurs. 5004*/ 5005void *sqlite3_update_hook( 5006 sqlite3*, 5007 void(*)(void *,int ,char const *,char const *,sqlite3_int64), 5008 void* 5009); 5010 5011/* 5012** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} <S30900> 5013** KEYWORDS: {shared cache} {shared cache mode} 5014** 5015** This routine enables or disables the sharing of the database cache 5016** and schema data structures between [database connection | connections] 5017** to the same database. Sharing is enabled if the argument is true 5018** and disabled if the argument is false. 5019** 5020** Cache sharing is enabled and disabled for an entire process. {END} 5021** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, 5022** sharing was enabled or disabled for each thread separately. 5023** 5024** The cache sharing mode set by this interface effects all subsequent 5025** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 5026** Existing database connections continue use the sharing mode 5027** that was in effect at the time they were opened. 5028** 5029** Virtual tables cannot be used with a shared cache. When shared 5030** cache is enabled, the [sqlite3_create_module()] API used to register 5031** virtual tables will always return an error. 5032** 5033** This routine returns [SQLITE_OK] if shared cache was enabled or disabled 5034** successfully. An [error code] is returned otherwise. 5035** 5036** Shared cache is disabled by default. But this might change in 5037** future releases of SQLite. Applications that care about shared 5038** cache setting should set it explicitly. 5039** 5040** INVARIANTS: 5041** 5042** {H10331} A successful invocation of [sqlite3_enable_shared_cache(B)] 5043** will enable or disable shared cache mode for any subsequently 5044** created [database connection] in the same process. 5045** 5046** {H10336} When shared cache is enabled, the [sqlite3_create_module()] 5047** interface will always return an error. 5048** 5049** {H10337} The [sqlite3_enable_shared_cache(B)] interface returns 5050** [SQLITE_OK] if shared cache was enabled or disabled successfully. 5051** 5052** {H10339} Shared cache is disabled by default. 5053*/ 5054int sqlite3_enable_shared_cache(int); 5055 5056/* 5057** CAPI3REF: Attempt To Free Heap Memory {H17340} <S30220> 5058** 5059** The sqlite3_release_memory() interface attempts to free N bytes 5060** of heap memory by deallocating non-essential memory allocations 5061** held by the database library. {END} Memory used to cache database 5062** pages to improve performance is an example of non-essential memory. 5063** sqlite3_release_memory() returns the number of bytes actually freed, 5064** which might be more or less than the amount requested. 5065** 5066** INVARIANTS: 5067** 5068** {H17341} The [sqlite3_release_memory(N)] interface attempts to 5069** free N bytes of heap memory by deallocating non-essential 5070** memory allocations held by the database library. 5071** 5072** {H16342} The [sqlite3_release_memory(N)] returns the number 5073** of bytes actually freed, which might be more or less 5074** than the amount requested. 5075*/ 5076int sqlite3_release_memory(int); 5077 5078/* 5079** CAPI3REF: Impose A Limit On Heap Size {H17350} <S30220> 5080** 5081** The sqlite3_soft_heap_limit() interface places a "soft" limit 5082** on the amount of heap memory that may be allocated by SQLite. 5083** If an internal allocation is requested that would exceed the 5084** soft heap limit, [sqlite3_release_memory()] is invoked one or 5085** more times to free up some space before the allocation is performed. 5086** 5087** The limit is called "soft", because if [sqlite3_release_memory()] 5088** cannot free sufficient memory to prevent the limit from being exceeded, 5089** the memory is allocated anyway and the current operation proceeds. 5090** 5091** A negative or zero value for N means that there is no soft heap limit and 5092** [sqlite3_release_memory()] will only be called when memory is exhausted. 5093** The default value for the soft heap limit is zero. 5094** 5095** SQLite makes a best effort to honor the soft heap limit. 5096** But if the soft heap limit cannot be honored, execution will 5097** continue without error or notification. This is why the limit is 5098** called a "soft" limit. It is advisory only. 5099** 5100** Prior to SQLite version 3.5.0, this routine only constrained the memory 5101** allocated by a single thread - the same thread in which this routine 5102** runs. Beginning with SQLite version 3.5.0, the soft heap limit is 5103** applied to all threads. The value specified for the soft heap limit 5104** is an upper bound on the total memory allocation for all threads. In 5105** version 3.5.0 there is no mechanism for limiting the heap usage for 5106** individual threads. 5107** 5108** INVARIANTS: 5109** 5110** {H16351} The [sqlite3_soft_heap_limit(N)] interface places a soft limit 5111** of N bytes on the amount of heap memory that may be allocated 5112** using [sqlite3_malloc()] or [sqlite3_realloc()] at any point 5113** in time. 5114** 5115** {H16352} If a call to [sqlite3_malloc()] or [sqlite3_realloc()] would 5116** cause the total amount of allocated memory to exceed the 5117** soft heap limit, then [sqlite3_release_memory()] is invoked 5118** in an attempt to reduce the memory usage prior to proceeding 5119** with the memory allocation attempt. 5120** 5121** {H16353} Calls to [sqlite3_malloc()] or [sqlite3_realloc()] that trigger 5122** attempts to reduce memory usage through the soft heap limit 5123** mechanism continue even if the attempt to reduce memory 5124** usage is unsuccessful. 5125** 5126** {H16354} A negative or zero value for N in a call to 5127** [sqlite3_soft_heap_limit(N)] means that there is no soft 5128** heap limit and [sqlite3_release_memory()] will only be 5129** called when memory is completely exhausted. 5130** 5131** {H16355} The default value for the soft heap limit is zero. 5132** 5133** {H16358} Each call to [sqlite3_soft_heap_limit(N)] overrides the 5134** values set by all prior calls. 5135*/ 5136void sqlite3_soft_heap_limit(int); 5137 5138/* 5139** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} <S60300> 5140** 5141** This routine returns metadata about a specific column of a specific 5142** database table accessible using the [database connection] handle 5143** passed as the first function argument. 5144** 5145** The column is identified by the second, third and fourth parameters to 5146** this function. The second parameter is either the name of the database 5147** (i.e. "main", "temp" or an attached database) containing the specified 5148** table or NULL. If it is NULL, then all attached databases are searched 5149** for the table using the same algorithm used by the database engine to 5150** resolve unqualified table references. 5151** 5152** The third and fourth parameters to this function are the table and column 5153** name of the desired column, respectively. Neither of these parameters 5154** may be NULL. 5155** 5156** Metadata is returned by writing to the memory locations passed as the 5th 5157** and subsequent parameters to this function. Any of these arguments may be 5158** NULL, in which case the corresponding element of metadata is omitted. 5159** 5160** <blockquote> 5161** <table border="1"> 5162** <tr><th> Parameter <th> Output<br>Type <th> Description 5163** 5164** <tr><td> 5th <td> const char* <td> Data type 5165** <tr><td> 6th <td> const char* <td> Name of default collation sequence 5166** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 5167** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 5168** <tr><td> 9th <td> int <td> True if column is AUTOINCREMENT 5169** </table> 5170** </blockquote> 5171** 5172** The memory pointed to by the character pointers returned for the 5173** declaration type and collation sequence is valid only until the next 5174** call to any SQLite API function. 5175** 5176** If the specified table is actually a view, an [error code] is returned. 5177** 5178** If the specified column is "rowid", "oid" or "_rowid_" and an 5179** INTEGER PRIMARY KEY column has been explicitly declared, then the output 5180** parameters are set for the explicitly declared column. If there is no 5181** explicitly declared INTEGER PRIMARY KEY column, then the output 5182** parameters are set as follows: 5183** 5184** <pre> 5185** data type: "INTEGER" 5186** collation sequence: "BINARY" 5187** not null: 0 5188** primary key: 1 5189** auto increment: 0 5190** </pre> 5191** 5192** This function may load one or more schemas from database files. If an 5193** error occurs during this process, or if the requested table or column 5194** cannot be found, an [error code] is returned and an error message left 5195** in the [database connection] (to be retrieved using sqlite3_errmsg()). 5196** 5197** This API is only available if the library was compiled with the 5198** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 5199*/ 5200int sqlite3_table_column_metadata( 5201 sqlite3 *db, /* Connection handle */ 5202 const char *zDbName, /* Database name or NULL */ 5203 const char *zTableName, /* Table name */ 5204 const char *zColumnName, /* Column name */ 5205 char const **pzDataType, /* OUTPUT: Declared data type */ 5206 char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 5207 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 5208 int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 5209 int *pAutoinc /* OUTPUT: True if column is auto-increment */ 5210); 5211 5212/* 5213** CAPI3REF: Load An Extension {H12600} <S20500> 5214** 5215** This interface loads an SQLite extension library from the named file. 5216** 5217** {H12601} The sqlite3_load_extension() interface attempts to load an 5218** SQLite extension library contained in the file zFile. 5219** 5220** {H12602} The entry point is zProc. 5221** 5222** {H12603} zProc may be 0, in which case the name of the entry point 5223** defaults to "sqlite3_extension_init". 5224** 5225** {H12604} The sqlite3_load_extension() interface shall return 5226** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 5227** 5228** {H12605} If an error occurs and pzErrMsg is not 0, then the 5229** [sqlite3_load_extension()] interface shall attempt to 5230** fill *pzErrMsg with error message text stored in memory 5231** obtained from [sqlite3_malloc()]. {END} The calling function 5232** should free this memory by calling [sqlite3_free()]. 5233** 5234** {H12606} Extension loading must be enabled using 5235** [sqlite3_enable_load_extension()] prior to calling this API, 5236** otherwise an error will be returned. 5237*/ 5238int sqlite3_load_extension( 5239 sqlite3 *db, /* Load the extension into this database connection */ 5240 const char *zFile, /* Name of the shared library containing extension */ 5241 const char *zProc, /* Entry point. Derived from zFile if 0 */ 5242 char **pzErrMsg /* Put error message here if not 0 */ 5243); 5244 5245/* 5246** CAPI3REF: Enable Or Disable Extension Loading {H12620} <S20500> 5247** 5248** So as not to open security holes in older applications that are 5249** unprepared to deal with extension loading, and as a means of disabling 5250** extension loading while evaluating user-entered SQL, the following API 5251** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 5252** 5253** Extension loading is off by default. See ticket #1863. 5254** 5255** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1 5256** to turn extension loading on and call it with onoff==0 to turn 5257** it back off again. 5258** 5259** {H12622} Extension loading is off by default. 5260*/ 5261int sqlite3_enable_load_extension(sqlite3 *db, int onoff); 5262 5263/* 5264** CAPI3REF: Automatically Load An Extensions {H12640} <S20500> 5265** 5266** This API can be invoked at program startup in order to register 5267** one or more statically linked extensions that will be available 5268** to all new [database connections]. {END} 5269** 5270** This routine stores a pointer to the extension in an array that is 5271** obtained from [sqlite3_malloc()]. If you run a memory leak checker 5272** on your program and it reports a leak because of this array, invoke 5273** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory. 5274** 5275** {H12641} This function registers an extension entry point that is 5276** automatically invoked whenever a new [database connection] 5277** is opened using [sqlite3_open()], [sqlite3_open16()], 5278** or [sqlite3_open_v2()]. 5279** 5280** {H12642} Duplicate extensions are detected so calling this routine 5281** multiple times with the same extension is harmless. 5282** 5283** {H12643} This routine stores a pointer to the extension in an array 5284** that is obtained from [sqlite3_malloc()]. 5285** 5286** {H12644} Automatic extensions apply across all threads. 5287*/ 5288int sqlite3_auto_extension(void *xEntryPoint); 5289 5290/* 5291** CAPI3REF: Reset Automatic Extension Loading {H12660} <S20500> 5292** 5293** This function disables all previously registered automatic 5294** extensions. {END} It undoes the effect of all prior 5295** [sqlite3_auto_extension()] calls. 5296** 5297** {H12661} This function disables all previously registered 5298** automatic extensions. 5299** 5300** {H12662} This function disables automatic extensions in all threads. 5301*/ 5302void sqlite3_reset_auto_extension(void); 5303 5304/* 5305****** EXPERIMENTAL - subject to change without notice ************** 5306** 5307** The interface to the virtual-table mechanism is currently considered 5308** to be experimental. The interface might change in incompatible ways. 5309** If this is a problem for you, do not use the interface at this time. 5310** 5311** When the virtual-table mechanism stabilizes, we will declare the 5312** interface fixed, support it indefinitely, and remove this comment. 5313*/ 5314 5315/* 5316** Structures used by the virtual table interface 5317*/ 5318typedef struct sqlite3_vtab sqlite3_vtab; 5319typedef struct sqlite3_index_info sqlite3_index_info; 5320typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 5321typedef struct sqlite3_module sqlite3_module; 5322 5323/* 5324** CAPI3REF: Virtual Table Object {H18000} <S20400> 5325** KEYWORDS: sqlite3_module 5326** EXPERIMENTAL 5327** 5328** A module is a class of virtual tables. Each module is defined 5329** by an instance of the following structure. This structure consists 5330** mostly of methods for the module. 5331** 5332** This interface is experimental and is subject to change or 5333** removal in future releases of SQLite. 5334*/ 5335struct sqlite3_module { 5336 int iVersion; 5337 int (*xCreate)(sqlite3*, void *pAux, 5338 int argc, const char *const*argv, 5339 sqlite3_vtab **ppVTab, char**); 5340 int (*xConnect)(sqlite3*, void *pAux, 5341 int argc, const char *const*argv, 5342 sqlite3_vtab **ppVTab, char**); 5343 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); 5344 int (*xDisconnect)(sqlite3_vtab *pVTab); 5345 int (*xDestroy)(sqlite3_vtab *pVTab); 5346 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); 5347 int (*xClose)(sqlite3_vtab_cursor*); 5348 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, 5349 int argc, sqlite3_value **argv); 5350 int (*xNext)(sqlite3_vtab_cursor*); 5351 int (*xEof)(sqlite3_vtab_cursor*); 5352 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); 5353 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 5354 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 5355 int (*xBegin)(sqlite3_vtab *pVTab); 5356 int (*xSync)(sqlite3_vtab *pVTab); 5357 int (*xCommit)(sqlite3_vtab *pVTab); 5358 int (*xRollback)(sqlite3_vtab *pVTab); 5359 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 5360 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 5361 void **ppArg); 5362 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 5363}; 5364 5365/* 5366** CAPI3REF: Virtual Table Indexing Information {H18100} <S20400> 5367** KEYWORDS: sqlite3_index_info 5368** EXPERIMENTAL 5369** 5370** The sqlite3_index_info structure and its substructures is used to 5371** pass information into and receive the reply from the xBestIndex 5372** method of an sqlite3_module. The fields under **Inputs** are the 5373** inputs to xBestIndex and are read-only. xBestIndex inserts its 5374** results into the **Outputs** fields. 5375** 5376** The aConstraint[] array records WHERE clause constraints of the form: 5377** 5378** <pre>column OP expr</pre> 5379** 5380** where OP is =, <, <=, >, or >=. The particular operator is 5381** stored in aConstraint[].op. The index of the column is stored in 5382** aConstraint[].iColumn. aConstraint[].usable is TRUE if the 5383** expr on the right-hand side can be evaluated (and thus the constraint 5384** is usable) and false if it cannot. 5385** 5386** The optimizer automatically inverts terms of the form "expr OP column" 5387** and makes other simplifications to the WHERE clause in an attempt to 5388** get as many WHERE clause terms into the form shown above as possible. 5389** The aConstraint[] array only reports WHERE clause terms in the correct 5390** form that refer to the particular virtual table being queried. 5391** 5392** Information about the ORDER BY clause is stored in aOrderBy[]. 5393** Each term of aOrderBy records a column of the ORDER BY clause. 5394** 5395** The xBestIndex method must fill aConstraintUsage[] with information 5396** about what parameters to pass to xFilter. If argvIndex>0 then 5397** the right-hand side of the corresponding aConstraint[] is evaluated 5398** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit 5399** is true, then the constraint is assumed to be fully handled by the 5400** virtual table and is not checked again by SQLite. 5401** 5402** The idxNum and idxPtr values are recorded and passed into xFilter. 5403** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true. 5404** 5405** The orderByConsumed means that output from xFilter will occur in 5406** the correct order to satisfy the ORDER BY clause so that no separate 5407** sorting step is required. 5408** 5409** The estimatedCost value is an estimate of the cost of doing the 5410** particular lookup. A full scan of a table with N entries should have 5411** a cost of N. A binary search of a table of N entries should have a 5412** cost of approximately log(N). 5413** 5414** This interface is experimental and is subject to change or 5415** removal in future releases of SQLite. 5416*/ 5417struct sqlite3_index_info { 5418 /* Inputs */ 5419 int nConstraint; /* Number of entries in aConstraint */ 5420 struct sqlite3_index_constraint { 5421 int iColumn; /* Column on left-hand side of constraint */ 5422 unsigned char op; /* Constraint operator */ 5423 unsigned char usable; /* True if this constraint is usable */ 5424 int iTermOffset; /* Used internally - xBestIndex should ignore */ 5425 } *aConstraint; /* Table of WHERE clause constraints */ 5426 int nOrderBy; /* Number of terms in the ORDER BY clause */ 5427 struct sqlite3_index_orderby { 5428 int iColumn; /* Column number */ 5429 unsigned char desc; /* True for DESC. False for ASC. */ 5430 } *aOrderBy; /* The ORDER BY clause */ 5431 /* Outputs */ 5432 struct sqlite3_index_constraint_usage { 5433 int argvIndex; /* if >0, constraint is part of argv to xFilter */ 5434 unsigned char omit; /* Do not code a test for this constraint */ 5435 } *aConstraintUsage; 5436 int idxNum; /* Number used to identify the index */ 5437 char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 5438 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 5439 int orderByConsumed; /* True if output is already ordered */ 5440 double estimatedCost; /* Estimated cost of using this index */ 5441}; 5442#define SQLITE_INDEX_CONSTRAINT_EQ 2 5443#define SQLITE_INDEX_CONSTRAINT_GT 4 5444#define SQLITE_INDEX_CONSTRAINT_LE 8 5445#define SQLITE_INDEX_CONSTRAINT_LT 16 5446#define SQLITE_INDEX_CONSTRAINT_GE 32 5447#define SQLITE_INDEX_CONSTRAINT_MATCH 64 5448 5449/* 5450** CAPI3REF: Register A Virtual Table Implementation {H18200} <S20400> 5451** EXPERIMENTAL 5452** 5453** This routine is used to register a new module name with a 5454** [database connection]. Module names must be registered before 5455** creating new virtual tables on the module, or before using 5456** preexisting virtual tables of the module. 5457** 5458** This interface is experimental and is subject to change or 5459** removal in future releases of SQLite. 5460*/ 5461SQLITE_EXPERIMENTAL int sqlite3_create_module( 5462 sqlite3 *db, /* SQLite connection to register module with */ 5463 const char *zName, /* Name of the module */ 5464 const sqlite3_module *, /* Methods for the module */ 5465 void * /* Client data for xCreate/xConnect */ 5466); 5467 5468/* 5469** CAPI3REF: Register A Virtual Table Implementation {H18210} <S20400> 5470** EXPERIMENTAL 5471** 5472** This routine is identical to the [sqlite3_create_module()] method above, 5473** except that it allows a destructor function to be specified. It is 5474** even more experimental than the rest of the virtual tables API. 5475*/ 5476SQLITE_EXPERIMENTAL int sqlite3_create_module_v2( 5477 sqlite3 *db, /* SQLite connection to register module with */ 5478 const char *zName, /* Name of the module */ 5479 const sqlite3_module *, /* Methods for the module */ 5480 void *, /* Client data for xCreate/xConnect */ 5481 void(*xDestroy)(void*) /* Module destructor function */ 5482); 5483 5484/* 5485** CAPI3REF: Virtual Table Instance Object {H18010} <S20400> 5486** KEYWORDS: sqlite3_vtab 5487** EXPERIMENTAL 5488** 5489** Every module implementation uses a subclass of the following structure 5490** to describe a particular instance of the module. Each subclass will 5491** be tailored to the specific needs of the module implementation. 5492** The purpose of this superclass is to define certain fields that are 5493** common to all module implementations. 5494** 5495** Virtual tables methods can set an error message by assigning a 5496** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 5497** take care that any prior string is freed by a call to [sqlite3_free()] 5498** prior to assigning a new string to zErrMsg. After the error message 5499** is delivered up to the client application, the string will be automatically 5500** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note 5501** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field 5502** since virtual tables are commonly implemented in loadable extensions which 5503** do not have access to sqlite3MPrintf() or sqlite3Free(). 5504** 5505** This interface is experimental and is subject to change or 5506** removal in future releases of SQLite. 5507*/ 5508struct sqlite3_vtab { 5509 const sqlite3_module *pModule; /* The module for this virtual table */ 5510 int nRef; /* Used internally */ 5511 char *zErrMsg; /* Error message from sqlite3_mprintf() */ 5512 /* Virtual table implementations will typically add additional fields */ 5513}; 5514 5515/* 5516** CAPI3REF: Virtual Table Cursor Object {H18020} <S20400> 5517** KEYWORDS: sqlite3_vtab_cursor 5518** EXPERIMENTAL 5519** 5520** Every module implementation uses a subclass of the following structure 5521** to describe cursors that point into the virtual table and are used 5522** to loop through the virtual table. Cursors are created using the 5523** xOpen method of the module. Each module implementation will define 5524** the content of a cursor structure to suit its own needs. 5525** 5526** This superclass exists in order to define fields of the cursor that 5527** are common to all implementations. 5528** 5529** This interface is experimental and is subject to change or 5530** removal in future releases of SQLite. 5531*/ 5532struct sqlite3_vtab_cursor { 5533 sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 5534 /* Virtual table implementations will typically add additional fields */ 5535}; 5536 5537/* 5538** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} <S20400> 5539** EXPERIMENTAL 5540** 5541** The xCreate and xConnect methods of a module use the following API 5542** to declare the format (the names and datatypes of the columns) of 5543** the virtual tables they implement. 5544** 5545** This interface is experimental and is subject to change or 5546** removal in future releases of SQLite. 5547*/ 5548SQLITE_EXPERIMENTAL int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable); 5549 5550/* 5551** CAPI3REF: Overload A Function For A Virtual Table {H18300} <S20400> 5552** EXPERIMENTAL 5553** 5554** Virtual tables can provide alternative implementations of functions 5555** using the xFindFunction method. But global versions of those functions 5556** must exist in order to be overloaded. 5557** 5558** This API makes sure a global version of a function with a particular 5559** name and number of parameters exists. If no such function exists 5560** before this API is called, a new function is created. The implementation 5561** of the new function always causes an exception to be thrown. So 5562** the new function is not good for anything by itself. Its only 5563** purpose is to be a placeholder function that can be overloaded 5564** by virtual tables. 5565** 5566** This API should be considered part of the virtual table interface, 5567** which is experimental and subject to change. 5568*/ 5569SQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); 5570 5571/* 5572** The interface to the virtual-table mechanism defined above (back up 5573** to a comment remarkably similar to this one) is currently considered 5574** to be experimental. The interface might change in incompatible ways. 5575** If this is a problem for you, do not use the interface at this time. 5576** 5577** When the virtual-table mechanism stabilizes, we will declare the 5578** interface fixed, support it indefinitely, and remove this comment. 5579** 5580****** EXPERIMENTAL - subject to change without notice ************** 5581*/ 5582 5583/* 5584** CAPI3REF: A Handle To An Open BLOB {H17800} <S30230> 5585** KEYWORDS: {BLOB handle} {BLOB handles} 5586** 5587** An instance of this object represents an open BLOB on which 5588** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 5589** Objects of this type are created by [sqlite3_blob_open()] 5590** and destroyed by [sqlite3_blob_close()]. 5591** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 5592** can be used to read or write small subsections of the BLOB. 5593** The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 5594*/ 5595typedef struct sqlite3_blob sqlite3_blob; 5596 5597/* 5598** CAPI3REF: Open A BLOB For Incremental I/O {H17810} <S30230> 5599** 5600** This interfaces opens a [BLOB handle | handle] to the BLOB located 5601** in row iRow, column zColumn, table zTable in database zDb; 5602** in other words, the same BLOB that would be selected by: 5603** 5604** <pre> 5605** SELECT zColumn FROM zDb.zTable WHERE rowid = iRow; 5606** </pre> {END} 5607** 5608** If the flags parameter is non-zero, the the BLOB is opened for read 5609** and write access. If it is zero, the BLOB is opened for read access. 5610** 5611** Note that the database name is not the filename that contains 5612** the database but rather the symbolic name of the database that 5613** is assigned when the database is connected using [ATTACH]. 5614** For the main database file, the database name is "main". 5615** For TEMP tables, the database name is "temp". 5616** 5617** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written 5618** to *ppBlob. Otherwise an [error code] is returned and any value written 5619** to *ppBlob should not be used by the caller. 5620** This function sets the [database connection] error code and message 5621** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()]. 5622** 5623** If the row that a BLOB handle points to is modified by an 5624** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 5625** then the BLOB handle is marked as "expired". 5626** This is true if any column of the row is changed, even a column 5627** other than the one the BLOB handle is open on. 5628** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 5629** a expired BLOB handle fail with an return code of [SQLITE_ABORT]. 5630** Changes written into a BLOB prior to the BLOB expiring are not 5631** rollback by the expiration of the BLOB. Such changes will eventually 5632** commit if the transaction continues to completion. 5633** 5634** INVARIANTS: 5635** 5636** {H17813} A successful invocation of the [sqlite3_blob_open(D,B,T,C,R,F,P)] 5637** interface shall open an [sqlite3_blob] object P on the BLOB 5638** in column C of the table T in the database B on 5639** the [database connection] D. 5640** 5641** {H17814} A successful invocation of [sqlite3_blob_open(D,...)] shall start 5642** a new transaction on the [database connection] D if that 5643** connection is not already in a transaction. 5644** 5645** {H17816} The [sqlite3_blob_open(D,B,T,C,R,F,P)] interface shall open 5646** the BLOB for read and write access if and only if the F 5647** parameter is non-zero. 5648** 5649** {H17819} The [sqlite3_blob_open()] interface shall return [SQLITE_OK] on 5650** success and an appropriate [error code] on failure. 5651** 5652** {H17821} If an error occurs during evaluation of [sqlite3_blob_open(D,...)] 5653** then subsequent calls to [sqlite3_errcode(D)], 5654** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] shall return 5655** information appropriate for that error. 5656** 5657** {H17824} If any column in the row that a [sqlite3_blob] has open is 5658** changed by a separate [UPDATE] or [DELETE] statement or by 5659** an [ON CONFLICT] side effect, then the [sqlite3_blob] shall 5660** be marked as invalid. 5661*/ 5662int sqlite3_blob_open( 5663 sqlite3*, 5664 const char *zDb, 5665 const char *zTable, 5666 const char *zColumn, 5667 sqlite3_int64 iRow, 5668 int flags, 5669 sqlite3_blob **ppBlob 5670); 5671 5672/* 5673** CAPI3REF: Close A BLOB Handle {H17830} <S30230> 5674** 5675** Closes an open [BLOB handle]. 5676** 5677** Closing a BLOB shall cause the current transaction to commit 5678** if there are no other BLOBs, no pending prepared statements, and the 5679** database connection is in [autocommit mode]. 5680** If any writes were made to the BLOB, they might be held in cache 5681** until the close operation if they will fit. {END} 5682** 5683** Closing the BLOB often forces the changes 5684** out to disk and so if any I/O errors occur, they will likely occur 5685** at the time when the BLOB is closed. {H17833} Any errors that occur during 5686** closing are reported as a non-zero return value. 5687** 5688** The BLOB is closed unconditionally. Even if this routine returns 5689** an error code, the BLOB is still closed. 5690** 5691** INVARIANTS: 5692** 5693** {H17833} The [sqlite3_blob_close(P)] interface closes an [sqlite3_blob] 5694** object P previously opened using [sqlite3_blob_open()]. 5695** 5696** {H17836} Closing an [sqlite3_blob] object using 5697** [sqlite3_blob_close()] shall cause the current transaction to 5698** commit if there are no other open [sqlite3_blob] objects 5699** or [prepared statements] on the same [database connection] and 5700** the database connection is in [autocommit mode]. 5701** 5702** {H17839} The [sqlite3_blob_close(P)] interfaces shall close the 5703** [sqlite3_blob] object P unconditionally, even if 5704** [sqlite3_blob_close(P)] returns something other than [SQLITE_OK]. 5705*/ 5706int sqlite3_blob_close(sqlite3_blob *); 5707 5708/* 5709** CAPI3REF: Return The Size Of An Open BLOB {H17840} <S30230> 5710** 5711** Returns the size in bytes of the BLOB accessible via the open 5712** []BLOB handle] in its only argument. 5713** 5714** INVARIANTS: 5715** 5716** {H17843} The [sqlite3_blob_bytes(P)] interface returns the size 5717** in bytes of the BLOB that the [sqlite3_blob] object P 5718** refers to. 5719*/ 5720int sqlite3_blob_bytes(sqlite3_blob *); 5721 5722/* 5723** CAPI3REF: Read Data From A BLOB Incrementally {H17850} <S30230> 5724** 5725** This function is used to read data from an open [BLOB handle] into a 5726** caller-supplied buffer. N bytes of data are copied into buffer Z 5727** from the open BLOB, starting at offset iOffset. 5728** 5729** If offset iOffset is less than N bytes from the end of the BLOB, 5730** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is 5731** less than zero, [SQLITE_ERROR] is returned and no data is read. 5732** 5733** An attempt to read from an expired [BLOB handle] fails with an 5734** error code of [SQLITE_ABORT]. 5735** 5736** On success, SQLITE_OK is returned. 5737** Otherwise, an [error code] or an [extended error code] is returned. 5738** 5739** INVARIANTS: 5740** 5741** {H17853} A successful invocation of [sqlite3_blob_read(P,Z,N,X)] 5742** shall reads N bytes of data out of the BLOB referenced by 5743** [BLOB handle] P beginning at offset X and store those bytes 5744** into buffer Z. 5745** 5746** {H17856} In [sqlite3_blob_read(P,Z,N,X)] if the size of the BLOB 5747** is less than N+X bytes, then the function shall leave the 5748** Z buffer unchanged and return [SQLITE_ERROR]. 5749** 5750** {H17859} In [sqlite3_blob_read(P,Z,N,X)] if X or N is less than zero 5751** then the function shall leave the Z buffer unchanged 5752** and return [SQLITE_ERROR]. 5753** 5754** {H17862} The [sqlite3_blob_read(P,Z,N,X)] interface shall return [SQLITE_OK] 5755** if N bytes are successfully read into buffer Z. 5756** 5757** {H17863} If the [BLOB handle] P is expired and X and N are within bounds 5758** then [sqlite3_blob_read(P,Z,N,X)] shall leave the Z buffer 5759** unchanged and return [SQLITE_ABORT]. 5760** 5761** {H17865} If the requested read could not be completed, 5762** the [sqlite3_blob_read(P,Z,N,X)] interface shall return an 5763** appropriate [error code] or [extended error code]. 5764** 5765** {H17868} If an error occurs during evaluation of [sqlite3_blob_read(P,...)] 5766** then subsequent calls to [sqlite3_errcode(D)], 5767** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] shall return 5768** information appropriate for that error, where D is the 5769** [database connection] that was used to open the [BLOB handle] P. 5770*/ 5771int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 5772 5773/* 5774** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} <S30230> 5775** 5776** This function is used to write data into an open [BLOB handle] from a 5777** caller-supplied buffer. N bytes of data are copied from the buffer Z 5778** into the open BLOB, starting at offset iOffset. 5779** 5780** If the [BLOB handle] passed as the first argument was not opened for 5781** writing (the flags parameter to [sqlite3_blob_open()] was zero), 5782** this function returns [SQLITE_READONLY]. 5783** 5784** This function may only modify the contents of the BLOB; it is 5785** not possible to increase the size of a BLOB using this API. 5786** If offset iOffset is less than N bytes from the end of the BLOB, 5787** [SQLITE_ERROR] is returned and no data is written. If N is 5788** less than zero [SQLITE_ERROR] is returned and no data is written. 5789** 5790** An attempt to write to an expired [BLOB handle] fails with an 5791** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred 5792** before the [BLOB handle] expired are not rolled back by the 5793** expiration of the handle, though of course those changes might 5794** have been overwritten by the statement that expired the BLOB handle 5795** or by other independent statements. 5796** 5797** On success, SQLITE_OK is returned. 5798** Otherwise, an [error code] or an [extended error code] is returned. 5799** 5800** INVARIANTS: 5801** 5802** {H17873} A successful invocation of [sqlite3_blob_write(P,Z,N,X)] 5803** shall write N bytes of data from buffer Z into the BLOB 5804** referenced by [BLOB handle] P beginning at offset X into 5805** the BLOB. 5806** 5807** {H17874} In the absence of other overridding changes, the changes 5808** written to a BLOB by [sqlite3_blob_write()] shall 5809** remain in effect after the associated [BLOB handle] expires. 5810** 5811** {H17875} If the [BLOB handle] P was opened for reading only then 5812** an invocation of [sqlite3_blob_write(P,Z,N,X)] shall leave 5813** the referenced BLOB unchanged and return [SQLITE_READONLY]. 5814** 5815** {H17876} If the size of the BLOB referenced by [BLOB handle] P is 5816** less than N+X bytes then [sqlite3_blob_write(P,Z,N,X)] shall 5817** leave the BLOB unchanged and return [SQLITE_ERROR]. 5818** 5819** {H17877} If the [BLOB handle] P is expired and X and N are within bounds 5820** then [sqlite3_blob_read(P,Z,N,X)] shall leave the BLOB 5821** unchanged and return [SQLITE_ABORT]. 5822** 5823** {H17879} If X or N are less than zero then [sqlite3_blob_write(P,Z,N,X)] 5824** shall leave the BLOB referenced by [BLOB handle] P unchanged 5825** and return [SQLITE_ERROR]. 5826** 5827** {H17882} The [sqlite3_blob_write(P,Z,N,X)] interface shall return 5828** [SQLITE_OK] if N bytes where successfully written into the BLOB. 5829** 5830** {H17885} If the requested write could not be completed, 5831** the [sqlite3_blob_write(P,Z,N,X)] interface shall return an 5832** appropriate [error code] or [extended error code]. 5833** 5834** {H17888} If an error occurs during evaluation of [sqlite3_blob_write(D,...)] 5835** then subsequent calls to [sqlite3_errcode(D)], 5836** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] shall return 5837** information appropriate for that error. 5838*/ 5839int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); 5840 5841/* 5842** CAPI3REF: Virtual File System Objects {H11200} <S20100> 5843** 5844** A virtual filesystem (VFS) is an [sqlite3_vfs] object 5845** that SQLite uses to interact 5846** with the underlying operating system. Most SQLite builds come with a 5847** single default VFS that is appropriate for the host computer. 5848** New VFSes can be registered and existing VFSes can be unregistered. 5849** The following interfaces are provided. 5850** 5851** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 5852** Names are case sensitive. 5853** Names are zero-terminated UTF-8 strings. 5854** If there is no match, a NULL pointer is returned. 5855** If zVfsName is NULL then the default VFS is returned. 5856** 5857** New VFSes are registered with sqlite3_vfs_register(). 5858** Each new VFS becomes the default VFS if the makeDflt flag is set. 5859** The same VFS can be registered multiple times without injury. 5860** To make an existing VFS into the default VFS, register it again 5861** with the makeDflt flag set. If two different VFSes with the 5862** same name are registered, the behavior is undefined. If a 5863** VFS is registered with a name that is NULL or an empty string, 5864** then the behavior is undefined. 5865** 5866** Unregister a VFS with the sqlite3_vfs_unregister() interface. 5867** If the default VFS is unregistered, another VFS is chosen as 5868** the default. The choice for the new VFS is arbitrary. 5869** 5870** INVARIANTS: 5871** 5872** {H11203} The [sqlite3_vfs_find(N)] interface returns a pointer to the 5873** registered [sqlite3_vfs] object whose name exactly matches 5874** the zero-terminated UTF-8 string N, or it returns NULL if 5875** there is no match. 5876** 5877** {H11206} If the N parameter to [sqlite3_vfs_find(N)] is NULL then 5878** the function returns a pointer to the default [sqlite3_vfs] 5879** object if there is one, or NULL if there is no default 5880** [sqlite3_vfs] object. 5881** 5882** {H11209} The [sqlite3_vfs_register(P,F)] interface registers the 5883** well-formed [sqlite3_vfs] object P using the name given 5884** by the zName field of the object. 5885** 5886** {H11212} Using the [sqlite3_vfs_register(P,F)] interface to register 5887** the same [sqlite3_vfs] object multiple times is a harmless no-op. 5888** 5889** {H11215} The [sqlite3_vfs_register(P,F)] interface makes the [sqlite3_vfs] 5890** object P the default [sqlite3_vfs] object if F is non-zero. 5891** 5892** {H11218} The [sqlite3_vfs_unregister(P)] interface unregisters the 5893** [sqlite3_vfs] object P so that it is no longer returned by 5894** subsequent calls to [sqlite3_vfs_find()]. 5895*/ 5896sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); 5897int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 5898int sqlite3_vfs_unregister(sqlite3_vfs*); 5899 5900/* 5901** CAPI3REF: Mutexes {H17000} <S20000> 5902** 5903** The SQLite core uses these routines for thread 5904** synchronization. Though they are intended for internal 5905** use by SQLite, code that links against SQLite is 5906** permitted to use any of these routines. 5907** 5908** The SQLite source code contains multiple implementations 5909** of these mutex routines. An appropriate implementation 5910** is selected automatically at compile-time. The following 5911** implementations are available in the SQLite core: 5912** 5913** <ul> 5914** <li> SQLITE_MUTEX_OS2 5915** <li> SQLITE_MUTEX_PTHREAD 5916** <li> SQLITE_MUTEX_W32 5917** <li> SQLITE_MUTEX_NOOP 5918** </ul> 5919** 5920** The SQLITE_MUTEX_NOOP implementation is a set of routines 5921** that does no real locking and is appropriate for use in 5922** a single-threaded application. The SQLITE_MUTEX_OS2, 5923** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations 5924** are appropriate for use on OS/2, Unix, and Windows. 5925** 5926** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 5927** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 5928** implementation is included with the library. In this case the 5929** application must supply a custom mutex implementation using the 5930** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 5931** before calling sqlite3_initialize() or any other public sqlite3_ 5932** function that calls sqlite3_initialize(). 5933** 5934** {H17011} The sqlite3_mutex_alloc() routine allocates a new 5935** mutex and returns a pointer to it. {H17012} If it returns NULL 5936** that means that a mutex could not be allocated. {H17013} SQLite 5937** will unwind its stack and return an error. {H17014} The argument 5938** to sqlite3_mutex_alloc() is one of these integer constants: 5939** 5940** <ul> 5941** <li> SQLITE_MUTEX_FAST 5942** <li> SQLITE_MUTEX_RECURSIVE 5943** <li> SQLITE_MUTEX_STATIC_MASTER 5944** <li> SQLITE_MUTEX_STATIC_MEM 5945** <li> SQLITE_MUTEX_STATIC_MEM2 5946** <li> SQLITE_MUTEX_STATIC_PRNG 5947** <li> SQLITE_MUTEX_STATIC_LRU 5948** <li> SQLITE_MUTEX_STATIC_LRU2 5949** </ul> 5950** 5951** {H17015} The first two constants cause sqlite3_mutex_alloc() to create 5952** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 5953** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END} 5954** The mutex implementation does not need to make a distinction 5955** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 5956** not want to. {H17016} But SQLite will only request a recursive mutex in 5957** cases where it really needs one. {END} If a faster non-recursive mutex 5958** implementation is available on the host platform, the mutex subsystem 5959** might return such a mutex in response to SQLITE_MUTEX_FAST. 5960** 5961** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return 5962** a pointer to a static preexisting mutex. {END} Four static mutexes are 5963** used by the current version of SQLite. Future versions of SQLite 5964** may add additional static mutexes. Static mutexes are for internal 5965** use by SQLite only. Applications that use SQLite mutexes should 5966** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 5967** SQLITE_MUTEX_RECURSIVE. 5968** 5969** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 5970** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 5971** returns a different mutex on every call. {H17034} But for the static 5972** mutex types, the same mutex is returned on every call that has 5973** the same type number. 5974** 5975** {H17019} The sqlite3_mutex_free() routine deallocates a previously 5976** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every 5977** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in 5978** use when they are deallocated. {A17022} Attempting to deallocate a static 5979** mutex results in undefined behavior. {H17023} SQLite never deallocates 5980** a static mutex. {END} 5981** 5982** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 5983** to enter a mutex. {H17024} If another thread is already within the mutex, 5984** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 5985** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK] 5986** upon successful entry. {H17026} Mutexes created using 5987** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 5988** {H17027} In such cases the, 5989** mutex must be exited an equal number of times before another thread 5990** can enter. {A17028} If the same thread tries to enter any other 5991** kind of mutex more than once, the behavior is undefined. 5992** {H17029} SQLite will never exhibit 5993** such behavior in its own use of mutexes. 5994** 5995** Some systems (for example, Windows 95) do not support the operation 5996** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 5997** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses 5998** sqlite3_mutex_try() as an optimization so this is acceptable behavior. 5999** 6000** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was 6001** previously entered by the same thread. {A17032} The behavior 6002** is undefined if the mutex is not currently entered by the 6003** calling thread or is not currently allocated. {H17033} SQLite will 6004** never do either. {END} 6005** 6006** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 6007** sqlite3_mutex_leave() is a NULL pointer, then all three routines 6008** behave as no-ops. 6009** 6010** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 6011*/ 6012sqlite3_mutex *sqlite3_mutex_alloc(int); 6013void sqlite3_mutex_free(sqlite3_mutex*); 6014void sqlite3_mutex_enter(sqlite3_mutex*); 6015int sqlite3_mutex_try(sqlite3_mutex*); 6016void sqlite3_mutex_leave(sqlite3_mutex*); 6017 6018/* 6019** CAPI3REF: Mutex Methods Object {H17120} <S20130> 6020** EXPERIMENTAL 6021** 6022** An instance of this structure defines the low-level routines 6023** used to allocate and use mutexes. 6024** 6025** Usually, the default mutex implementations provided by SQLite are 6026** sufficient, however the user has the option of substituting a custom 6027** implementation for specialized deployments or systems for which SQLite 6028** does not provide a suitable implementation. In this case, the user 6029** creates and populates an instance of this structure to pass 6030** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 6031** Additionally, an instance of this structure can be used as an 6032** output variable when querying the system for the current mutex 6033** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 6034** 6035** The xMutexInit method defined by this structure is invoked as 6036** part of system initialization by the sqlite3_initialize() function. 6037** {H17001} The xMutexInit routine shall be called by SQLite once for each 6038** effective call to [sqlite3_initialize()]. 6039** 6040** The xMutexEnd method defined by this structure is invoked as 6041** part of system shutdown by the sqlite3_shutdown() function. The 6042** implementation of this method is expected to release all outstanding 6043** resources obtained by the mutex methods implementation, especially 6044** those obtained by the xMutexInit method. {H17003} The xMutexEnd() 6045** interface shall be invoked once for each call to [sqlite3_shutdown()]. 6046** 6047** The remaining seven methods defined by this structure (xMutexAlloc, 6048** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 6049** xMutexNotheld) implement the following interfaces (respectively): 6050** 6051** <ul> 6052** <li> [sqlite3_mutex_alloc()] </li> 6053** <li> [sqlite3_mutex_free()] </li> 6054** <li> [sqlite3_mutex_enter()] </li> 6055** <li> [sqlite3_mutex_try()] </li> 6056** <li> [sqlite3_mutex_leave()] </li> 6057** <li> [sqlite3_mutex_held()] </li> 6058** <li> [sqlite3_mutex_notheld()] </li> 6059** </ul> 6060** 6061** The only difference is that the public sqlite3_XXX functions enumerated 6062** above silently ignore any invocations that pass a NULL pointer instead 6063** of a valid mutex handle. The implementations of the methods defined 6064** by this structure are not required to handle this case, the results 6065** of passing a NULL pointer instead of a valid mutex handle are undefined 6066** (i.e. it is acceptable to provide an implementation that segfaults if 6067** it is passed a NULL pointer). 6068*/ 6069typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 6070struct sqlite3_mutex_methods { 6071 int (*xMutexInit)(void); 6072 int (*xMutexEnd)(void); 6073 sqlite3_mutex *(*xMutexAlloc)(int); 6074 void (*xMutexFree)(sqlite3_mutex *); 6075 void (*xMutexEnter)(sqlite3_mutex *); 6076 int (*xMutexTry)(sqlite3_mutex *); 6077 void (*xMutexLeave)(sqlite3_mutex *); 6078 int (*xMutexHeld)(sqlite3_mutex *); 6079 int (*xMutexNotheld)(sqlite3_mutex *); 6080}; 6081 6082/* 6083** CAPI3REF: Mutex Verification Routines {H17080} <S20130> <S30800> 6084** 6085** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 6086** are intended for use inside assert() statements. {H17081} The SQLite core 6087** never uses these routines except inside an assert() and applications 6088** are advised to follow the lead of the core. {H17082} The core only 6089** provides implementations for these routines when it is compiled 6090** with the SQLITE_DEBUG flag. {A17087} External mutex implementations 6091** are only required to provide these routines if SQLITE_DEBUG is 6092** defined and if NDEBUG is not defined. 6093** 6094** {H17083} These routines should return true if the mutex in their argument 6095** is held or not held, respectively, by the calling thread. 6096** 6097** {X17084} The implementation is not required to provided versions of these 6098** routines that actually work. If the implementation does not provide working 6099** versions of these routines, it should at least provide stubs that always 6100** return true so that one does not get spurious assertion failures. 6101** 6102** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then 6103** the routine should return 1. {END} This seems counter-intuitive since 6104** clearly the mutex cannot be held if it does not exist. But the 6105** the reason the mutex does not exist is because the build is not 6106** using mutexes. And we do not want the assert() containing the 6107** call to sqlite3_mutex_held() to fail, so a non-zero return is 6108** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld() 6109** interface should also return 1 when given a NULL pointer. 6110*/ 6111int sqlite3_mutex_held(sqlite3_mutex*); 6112int sqlite3_mutex_notheld(sqlite3_mutex*); 6113 6114/* 6115** CAPI3REF: Mutex Types {H17001} <H17000> 6116** 6117** The [sqlite3_mutex_alloc()] interface takes a single argument 6118** which is one of these integer constants. 6119** 6120** The set of static mutexes may change from one SQLite release to the 6121** next. Applications that override the built-in mutex logic must be 6122** prepared to accommodate additional static mutexes. 6123*/ 6124#define SQLITE_MUTEX_FAST 0 6125#define SQLITE_MUTEX_RECURSIVE 1 6126#define SQLITE_MUTEX_STATIC_MASTER 2 6127#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 6128#define SQLITE_MUTEX_STATIC_MEM2 4 /* sqlite3_release_memory() */ 6129#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ 6130#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 6131#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */ 6132 6133/* 6134** CAPI3REF: Low-Level Control Of Database Files {H11300} <S30800> 6135** 6136** {H11301} The [sqlite3_file_control()] interface makes a direct call to the 6137** xFileControl method for the [sqlite3_io_methods] object associated 6138** with a particular database identified by the second argument. {H11302} The 6139** name of the database is the name assigned to the database by the 6140** <a href="lang_attach.html">ATTACH</a> SQL command that opened the 6141** database. {H11303} To control the main database file, use the name "main" 6142** or a NULL pointer. {H11304} The third and fourth parameters to this routine 6143** are passed directly through to the second and third parameters of 6144** the xFileControl method. {H11305} The return value of the xFileControl 6145** method becomes the return value of this routine. 6146** 6147** {H11306} If the second parameter (zDbName) does not match the name of any 6148** open database file, then SQLITE_ERROR is returned. {H11307} This error 6149** code is not remembered and will not be recalled by [sqlite3_errcode()] 6150** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might 6151** also return SQLITE_ERROR. {A11309} There is no way to distinguish between 6152** an incorrect zDbName and an SQLITE_ERROR return from the underlying 6153** xFileControl method. {END} 6154** 6155** See also: [SQLITE_FCNTL_LOCKSTATE] 6156*/ 6157int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); 6158 6159/* 6160** CAPI3REF: Testing Interface {H11400} <S30800> 6161** 6162** The sqlite3_test_control() interface is used to read out internal 6163** state of SQLite and to inject faults into SQLite for testing 6164** purposes. The first parameter is an operation code that determines 6165** the number, meaning, and operation of all subsequent parameters. 6166** 6167** This interface is not for use by applications. It exists solely 6168** for verifying the correct operation of the SQLite library. Depending 6169** on how the SQLite library is compiled, this interface might not exist. 6170** 6171** The details of the operation codes, their meanings, the parameters 6172** they take, and what they do are all subject to change without notice. 6173** Unlike most of the SQLite API, this function is not guaranteed to 6174** operate consistently from one release to the next. 6175*/ 6176int sqlite3_test_control(int op, ...); 6177 6178/* 6179** CAPI3REF: Testing Interface Operation Codes {H11410} <H11400> 6180** 6181** These constants are the valid operation code parameters used 6182** as the first argument to [sqlite3_test_control()]. 6183** 6184** These parameters and their meanings are subject to change 6185** without notice. These values are for testing purposes only. 6186** Applications should not use any of these parameters or the 6187** [sqlite3_test_control()] interface. 6188*/ 6189#define SQLITE_TESTCTRL_PRNG_SAVE 5 6190#define SQLITE_TESTCTRL_PRNG_RESTORE 6 6191#define SQLITE_TESTCTRL_PRNG_RESET 7 6192#define SQLITE_TESTCTRL_BITVEC_TEST 8 6193#define SQLITE_TESTCTRL_FAULT_INSTALL 9 6194#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 6195 6196/* 6197** CAPI3REF: SQLite Runtime Status {H17200} <S60200> 6198** EXPERIMENTAL 6199** 6200** This interface is used to retrieve runtime status information 6201** about the preformance of SQLite, and optionally to reset various 6202** highwater marks. The first argument is an integer code for 6203** the specific parameter to measure. Recognized integer codes 6204** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...]. 6205** The current value of the parameter is returned into *pCurrent. 6206** The highest recorded value is returned in *pHighwater. If the 6207** resetFlag is true, then the highest record value is reset after 6208** *pHighwater is written. Some parameters do not record the highest 6209** value. For those parameters 6210** nothing is written into *pHighwater and the resetFlag is ignored. 6211** Other parameters record only the highwater mark and not the current 6212** value. For these latter parameters nothing is written into *pCurrent. 6213** 6214** This routine returns SQLITE_OK on success and a non-zero 6215** [error code] on failure. 6216** 6217** This routine is threadsafe but is not atomic. This routine can 6218** called while other threads are running the same or different SQLite 6219** interfaces. However the values returned in *pCurrent and 6220** *pHighwater reflect the status of SQLite at different points in time 6221** and it is possible that another thread might change the parameter 6222** in between the times when *pCurrent and *pHighwater are written. 6223** 6224** See also: [sqlite3_db_status()] 6225*/ 6226SQLITE_EXPERIMENTAL int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 6227 6228/* 6229** CAPI3REF: Database Connection Status {H17201} <S60200> 6230** EXPERIMENTAL 6231** 6232** This interface is used to retrieve runtime status information 6233** about a single [database connection]. The first argument is the 6234** database connection object to be interrogated. The second argument 6235** is the parameter to interrogate. Currently, the only allowed value 6236** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED]. 6237** Additional options will likely appear in future releases of SQLite. 6238** 6239** The current value of the request parameter is written into *pCur 6240** and the highest instantaneous value is written into *pHiwtr. If 6241** the resetFlg is true, then the highest instantaneous value is 6242** reset back down to the current value. 6243** 6244** See also: [sqlite3_status()]. 6245*/ 6246SQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 6247 6248 6249int sqlite3_wsd_init(int N, int J); 6250void *sqlite3_wsd_find(void *K, int L); 6251 6252/* 6253** CAPI3REF: Status Parameters {H17250} <H17200> 6254** EXPERIMENTAL 6255** 6256** These integer constants designate various run-time status parameters 6257** that can be returned by [sqlite3_status()]. 6258** 6259** <dl> 6260** <dt>SQLITE_STATUS_MEMORY_USED</dt> 6261** <dd>This parameter is the current amount of memory checked out 6262** using [sqlite3_malloc()], either directly or indirectly. The 6263** figure includes calls made to [sqlite3_malloc()] by the application 6264** and internal memory usage by the SQLite library. Scratch memory 6265** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache 6266** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 6267** this parameter. The amount returned is the sum of the allocation 6268** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd> 6269** 6270** <dt>SQLITE_STATUS_MALLOC_SIZE</dt> 6271** <dd>This parameter records the largest memory allocation request 6272** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 6273** internal equivalents). Only the value returned in the 6274** *pHighwater parameter to [sqlite3_status()] is of interest. 6275** The value written into the *pCurrent parameter is undefined.</dd> 6276** 6277** <dt>SQLITE_STATUS_PAGECACHE_USED</dt> 6278** <dd>This parameter returns the number of pages used out of the 6279** [pagecache memory allocator] that was configured using 6280** [SQLITE_CONFIG_PAGECACHE]. The 6281** value returned is in pages, not in bytes.</dd> 6282** 6283** <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 6284** <dd>This parameter returns the number of bytes of page cache 6285** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE] 6286** buffer and where forced to overflow to [sqlite3_malloc()]. The 6287** returned value includes allocations that overflowed because they 6288** where too large (they were larger than the "sz" parameter to 6289** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 6290** no space was left in the page cache.</dd> 6291** 6292** <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 6293** <dd>This parameter records the largest memory allocation request 6294** handed to [pagecache memory allocator]. Only the value returned in the 6295** *pHighwater parameter to [sqlite3_status()] is of interest. 6296** The value written into the *pCurrent parameter is undefined.</dd> 6297** 6298** <dt>SQLITE_STATUS_SCRATCH_USED</dt> 6299** <dd>This parameter returns the number of allocations used out of the 6300** [scratch memory allocator] configured using 6301** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not 6302** in bytes. Since a single thread may only have one scratch allocation 6303** outstanding at time, this parameter also reports the number of threads 6304** using scratch memory at the same time.</dd> 6305** 6306** <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 6307** <dd>This parameter returns the number of bytes of scratch memory 6308** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH] 6309** buffer and where forced to overflow to [sqlite3_malloc()]. The values 6310** returned include overflows because the requested allocation was too 6311** larger (that is, because the requested allocation was larger than the 6312** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer 6313** slots were available. 6314** </dd> 6315** 6316** <dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 6317** <dd>This parameter records the largest memory allocation request 6318** handed to [scratch memory allocator]. Only the value returned in the 6319** *pHighwater parameter to [sqlite3_status()] is of interest. 6320** The value written into the *pCurrent parameter is undefined.</dd> 6321** 6322** <dt>SQLITE_STATUS_PARSER_STACK</dt> 6323** <dd>This parameter records the deepest parser stack. It is only 6324** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd> 6325** </dl> 6326** 6327** New status parameters may be added from time to time. 6328*/ 6329#define SQLITE_STATUS_MEMORY_USED 0 6330#define SQLITE_STATUS_PAGECACHE_USED 1 6331#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 6332#define SQLITE_STATUS_SCRATCH_USED 3 6333#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 6334#define SQLITE_STATUS_MALLOC_SIZE 5 6335#define SQLITE_STATUS_PARSER_STACK 6 6336#define SQLITE_STATUS_PAGECACHE_SIZE 7 6337#define SQLITE_STATUS_SCRATCH_SIZE 8 6338 6339/* 6340** CAPI3REF: Status Parameters for database connections {H17275} <H17200> 6341** EXPERIMENTAL 6342** 6343** Status verbs for [sqlite3_db_status()]. 6344** 6345** <dl> 6346** <dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 6347** <dd>This parameter returns the number of lookaside memory slots currently 6348** checked out.</dd> 6349** </dl> 6350*/ 6351#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 6352 6353/* 6354** Undo the hack that converts floating point types to integer for 6355** builds on processors without floating point support. 6356*/ 6357#ifdef SQLITE_OMIT_FLOATING_POINT 6358# undef double 6359#endif 6360 6361#ifdef __cplusplus 6362} /* End of the 'extern "C"' block */ 6363#endif 6364#endif 6365