17790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 27790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2001 September 15 37790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The author disclaims copyright to this source code. In place of 57790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a legal notice, here is a blessing: 67790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 77790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** May you do good and not evil. 87790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** May you find forgiveness for yourself and forgive others. 97790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** May you share freely, never taking more than you give. 107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project************************************************************************* 127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This header file defines the interface that the SQLite library 137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** presents to client programs. If a C-function, structure, datatype, 147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or constant definition does not appear in this file, then it is 157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not a published API of SQLite, is subject to change without 167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** notice, and should not be referenced by programs that use SQLite. 177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Some of the definitions that are in this file are marked as 197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** "experimental". Experimental interfaces are normally new 20a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** features recently added to SQLite. We do not anticipate changes 21a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to experimental interfaces but reserve the right to make minor changes 22a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if experience from use "in the wild" suggest such changes are prudent. 237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The official C-language API documentation for SQLite is derived 257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from comments in this file. This file is the authoritative source 267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on how SQLite interfaces are suppose to operate. 277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The name of this file under configuration management is "sqlite.h.in". 297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The makefile makes some minor changes to this file (such as inserting 307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the version number) and changes its name to "sqlite3.h" as 317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** part of the build process. 327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifndef _SQLITE3_H_ 347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define _SQLITE3_H_ 357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#include <stdarg.h> /* Needed for the definition of va_list */ 367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Make sure we can call this stuff from C++. 397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef __cplusplus 417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectextern "C" { 427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Provide the ability to override linkage features of the interface. 477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifndef SQLITE_EXTERN 497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# define SQLITE_EXTERN extern 507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 51a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef SQLITE_API 52a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori# define SQLITE_API 53a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 543fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#ifndef SQLITE_CDECL 553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich# define SQLITE_CDECL 563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#endif 573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#ifndef SQLITE_STDCALL 583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich# define SQLITE_STDCALL 593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#endif 60a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 62a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These no-op macros are used in front of interfaces to mark those 63a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces as either deprecated or experimental. New applications 643fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** should not use deprecated interfaces - they are supported for backwards 65a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compatibility only. Application writers should be aware that 66a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** experimental interfaces are subject to change in point releases. 67a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 68a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These macros used to resolve to various kinds of compiler magic that 69a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** would generate warning messages when they were used. But that 70a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiler magic ended up generating such a flurry of bug reports 71a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that we have taken it all out and gone back to using simple 72a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** noop macros. 73a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 74a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_DEPRECATED 75a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_EXPERIMENTAL 76a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 77a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 78a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Ensure these symbols were not defined by some previous header file. 797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_VERSION 817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef SQLITE_VERSION 827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_VERSION_NUMBER 847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef SQLITE_VERSION_NUMBER 857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 88a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compile-Time Library Version Numbers 89a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 90a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header 91a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** evaluates to a string literal that is the SQLite version in the 92a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** format "X.Y.Z" where X is the major version number (always 3 for 93a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite3) and Y is the minor version number and Z is the release number.)^ 94a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer 95a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same 96a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** numbers used in [SQLITE_VERSION].)^ 97a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLITE_VERSION_NUMBER for any given release of SQLite will also 98a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be larger than the release from which it is derived. Either Y will 99a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be held constant and Z will be incremented or else Y will be incremented 100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and Z will be reset to zero. 101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Since version 3.6.18, SQLite source code has been stored in the 103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <a href="http://www.fossil-scm.org/">Fossil configuration management 104de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to 105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a string which identifies a particular check-in of SQLite 106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** within its configuration management system. ^The SQLITE_SOURCE_ID 107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string contains the date and time of the check-in (UTC) and an SHA1 108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** hash of the entire source tree. 109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_libversion()], 111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_libversion_number()], [sqlite3_sourceid()], 112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite_version()] and [sqlite_source_id()]. 1137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 114693f9c610b18f09ffe4aaa8f583362481c9e1532Nick Kralevich#define SQLITE_VERSION "3.8.10.2" 1153a6c79f802fabdb94367177310663397420e319fNick Kralevich#define SQLITE_VERSION_NUMBER 3008010 116693f9c610b18f09ffe4aaa8f583362481c9e1532Nick Kralevich#define SQLITE_SOURCE_ID "2015-05-20 18:17:19 2ef4f3a5b1d1d0c4338f8243d40a2452cc1f7fe4" 1177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 1187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-Time Library Version Numbers 12071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** KEYWORDS: sqlite3_version, sqlite3_sourceid 1217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These interfaces provide the same information as the [SQLITE_VERSION], 123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros 124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but are associated with the library instead of the header file. ^(Cautious 125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** programmers might include assert() statements in their application to 126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** verify that values returned by these interfaces match the macros in 127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the header, and thus insure that the application is 128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled with matching library and header files. 1297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <blockquote><pre> 131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); 132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); 133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); 134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre></blockquote>)^ 135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] 137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** macro. ^The sqlite3_libversion() function returns a pointer to the 138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the sqlite3_version[] string constant. The sqlite3_libversion() 139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is provided for use in DLLs since DLL users usually do not have 140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** direct access to string constants within the DLL. ^The 141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_libversion_number() function returns an integer equal to 14271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns 14371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** a pointer to a string constant whose value is the same as the 14471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_SOURCE_ID] C preprocessor macro. 145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite_version()] and [sqlite_source_id()]. 1477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_EXTERN const char sqlite3_version[]; 1493fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_libversion(void); 1503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_sourceid(void); 1513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_libversion_number(void); 1527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 1537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 15471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Run-Time Library Compilation Options Diagnostics 15571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 15671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The sqlite3_compileoption_used() function returns 0 or 1 15771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** indicating whether the specified option was defined at 15871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** compile time. ^The SQLITE_ prefix may be omitted from the 15971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** option name passed to sqlite3_compileoption_used(). 16071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 161de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_compileoption_get() function allows iterating 16271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** over the list of options that were defined at compile time by 16371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** returning the N-th compile time option string. ^If N is out of range, 16471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ 16571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** prefix is omitted from any strings returned by 16671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** sqlite3_compileoption_get(). 16771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 16871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^Support for the diagnostic functions sqlite3_compileoption_used() 169de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and sqlite3_compileoption_get() may be omitted by specifying the 17071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. 17171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 17271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** See also: SQL functions [sqlite_compileoption_used()] and 17371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite_compileoption_get()] and the [compile_options pragma]. 17471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 17571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 1763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_compileoption_used(const char *zOptName); 1773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_compileoption_get(int N); 17871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 17971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 18071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Test To See If The Library Is Threadsafe 182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_threadsafe() function returns zero if and only if 18490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLite was compiled with mutexing code omitted due to the 185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_THREADSAFE] compile-time option being set to 0. 1867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite can be compiled with or without mutexes. When 188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes 189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are enabled and SQLite is threadsafe. When the 190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_THREADSAFE] macro is 0, 1917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the mutexes are omitted. Without the mutexes, it is not safe 192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use SQLite concurrently from more than one thread. 1937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Enabling mutexes incurs a measurable performance penalty. 1957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** So if speed is of utmost importance, it makes sense to disable 1967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the mutexes. But for maximum safety, mutexes should be enabled. 197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default behavior is for mutexes to be enabled. 1987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This interface can be used by an application to make sure that the 2007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** version of SQLite that it is linking against was compiled with 201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the desired setting of the [SQLITE_THREADSAFE] macro. 202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This interface only reports on the compile-time mutex setting 204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with 205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but 206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be fully or partially disabled using a call to [sqlite3_config()] 207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], 2083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the 209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_threadsafe() function shows only the compile-time setting of 210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread safety, not any run-time changes to that setting made by 211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() 212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is unchanged by calls to sqlite3_config().)^ 213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See the [threading mode] documentation for additional information. 2157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_threadsafe(void); 2177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection Handle 2207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {database connection} {database connections} 2217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Each open SQLite database is represented by a pointer to an instance of 223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the opaque structure named "sqlite3". It is useful to think of an sqlite3 2247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 2268fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** and [sqlite3_close_v2()] are its destructors. There are many other 2278fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** interfaces (such as 228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_busy_timeout()] to name but three) that are methods on an 230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3 object. 2317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3 sqlite3; 2337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 235a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: 64-Bit Integer Types 2367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite_int64 sqlite_uint64 2377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Because there is no cross-platform way to specify 64-bit integer types 2397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite includes typedefs for 64-bit signed and unsigned integers. 2407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. 242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite_int64 and sqlite_uint64 types are supported for backwards 243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compatibility only. 2447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_int64 and sqlite_int64 types can store integer values 246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** between -9223372036854775808 and +9223372036854775807 inclusive. ^The 247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_uint64 and sqlite_uint64 types can store integer values 248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** between 0 and +18446744073709551615 inclusive. 2497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_INT64_TYPE 2517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef SQLITE_INT64_TYPE sqlite_int64; 2527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; 2537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#elif defined(_MSC_VER) || defined(__BORLANDC__) 2547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef __int64 sqlite_int64; 2557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef unsigned __int64 sqlite_uint64; 2567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#else 2577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef long long int sqlite_int64; 2587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef unsigned long long int sqlite_uint64; 2597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 2607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef sqlite_int64 sqlite3_int64; 2617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef sqlite_uint64 sqlite3_uint64; 2627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If compiling for a processor that lacks floating point support, 265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** substitute integer for floating-point. 2667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_OMIT_FLOATING_POINT 2687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# define double sqlite3_int64 2697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 2707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Closing A Database Connection 2733a6c79f802fabdb94367177310663397420e319fNick Kralevich** DESTRUCTOR: sqlite3 274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2758fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors 2768fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** for the [sqlite3] object. 2779bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if 2788fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the [sqlite3] object is successfully destroyed and all associated 2798fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** resources are deallocated. 2808fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 2818fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If the database connection is associated with unfinalized prepared 2828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** statements or unfinished sqlite3_backup objects then sqlite3_close() 2838fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** will leave the database connection open and return [SQLITE_BUSY]. 2848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If sqlite3_close_v2() is called with unfinalized prepared statements 2859bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** and/or unfinished sqlite3_backups, then the database connection becomes 2868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** an unusable "zombie" which will automatically be deallocated when the 2878fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** last prepared statement is finalized or the last sqlite3_backup is 2888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** finished. The sqlite3_close_v2() interface is intended for use with 2898fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** host languages that are garbage collected, and where the order in which 2908fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** destructors are called is arbitrary. 2918fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 2928fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** Applications should [sqlite3_finalize | finalize] all [prepared statements], 2938fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_blob_close | close] all [BLOB handles], and 2948fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated 2958fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** with the [sqlite3] object prior to attempting to close the object. ^If 2968fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sqlite3_close_v2() is called on a [database connection] that still has 2978fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** outstanding [prepared statements], [BLOB handles], and/or 2989bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation 2998fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** of resources is deferred until all [prepared statements], [BLOB handles], 3008fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** and [sqlite3_backup] objects are also destroyed. 3018fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 3028fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If an [sqlite3] object is destroyed while a transaction is open, 303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the transaction is automatically rolled back. 304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3058fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)] 3068fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** must be either a NULL 307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer or an [sqlite3] object pointer obtained 308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_open()], [sqlite3_open16()], or 309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open_v2()], and not previously closed. 3108fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer 3118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** argument is a harmless no-op. 3127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_close(sqlite3*); 3143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_close_v2(sqlite3*); 3157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 3167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The type for a callback function. 3187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This is legacy and deprecated. It is included for historical 3197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** compatibility and is not documented. 3207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef int (*sqlite3_callback)(void*,int,char**, char**); 3227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 3237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: One-Step Query Execution Interface 3253a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_exec() interface is a convenience wrapper around 328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], 329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that allows an application to run multiple statements of SQL 330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** without having to use a lot of C code. 331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, 333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** semicolon-separate SQL statements passed into its 2nd argument, 334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the context of the [database connection] passed in as its 1st 335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument. ^If the callback function of the 3rd argument to 336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec() is not NULL, then it is invoked for each result row 337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** coming out of the evaluated SQL statements. ^The 4th argument to 33890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_exec() is relayed through to the 1st argument of each 339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback invocation. ^If the callback pointer to sqlite3_exec() 340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is NULL, then no callback is ever invoked and result rows are 341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ignored. 342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs while evaluating the SQL statements passed into 344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec(), then execution of the current statement stops and 345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() 346a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not NULL then any error message is written into memory obtained 347a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_malloc()] and passed back through the 5th parameter. 348a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid memory leaks, the application should invoke [sqlite3_free()] 349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on error message strings returned through the 5th parameter of 350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_exec() after the error message string is no longer needed. 351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors 352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occur, then sqlite3_exec() sets the pointer in its 5th parameter to 353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL before returning. 354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() 356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine returns SQLITE_ABORT without invoking the callback again and 357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** without running any subsequent SQL statements. 358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The 2nd argument to the sqlite3_exec() callback function is the 360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of columns in the result. ^The 3rd argument to the sqlite3_exec() 361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback is an array of pointers to strings obtained as if from 362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_text()], one for each column. ^If an element of a 363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result row is NULL then the corresponding string pointer for the 364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the 365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec() callback is an array of pointers to strings where each 366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** entry represents the name of corresponding result column as obtained 367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_column_name()]. 368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer 370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to an empty string, or a pointer that contains only whitespace and/or 371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL comments, then no SQL statements are evaluated and the database 372a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not changed. 373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 374a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Restrictions: 3757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The application must insure that the 1st parameter to sqlite3_exec() 378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a valid and open [database connection]. 3798fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li> The application must not close the [database connection] specified by 380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. 381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The application must not modify the SQL statement text passed into 382a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. 383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul> 3847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_exec( 3867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, /* An open database */ 387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *sql, /* SQL to be evaluated */ 3887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*callback)(void*,int,char**,char**), /* Callback function */ 3897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *, /* 1st argument to callback */ 3907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char **errmsg /* Error msg written here */ 3917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 3937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Result Codes 3959bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** KEYWORDS: {result code definitions} 3967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Many SQLite functions return an integer result code from the set shown 39890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** here in order to indicate success or failure. 3997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New error codes may be added in future versions of SQLite. 401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4029bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** See also: [extended result code definitions] 4037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_OK 0 /* Successful result */ 4057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* beginning-of-error-codes */ 4067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ERROR 1 /* SQL error or missing database */ 4077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 4087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_PERM 3 /* Access permission denied */ 4097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ABORT 4 /* Callback routine requested an abort */ 4107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_BUSY 5 /* The database file is locked */ 4117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCKED 6 /* A table in the database is locked */ 4127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOMEM 7 /* A malloc() failed */ 4137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 4147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 4157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 4167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 41790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ 4187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FULL 13 /* Insertion failed because database is full */ 4197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 42071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ 4217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_EMPTY 16 /* Database is empty */ 4227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SCHEMA 17 /* The database schema changed */ 4237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 4247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 4257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MISMATCH 20 /* Data type mismatch */ 4267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MISUSE 21 /* Library used incorrectly */ 4277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 4287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_AUTH 23 /* Authorization denied */ 4297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FORMAT 24 /* Auxiliary database format error */ 4307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 4317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOTADB 26 /* File opened that is not a database file */ 4328fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */ 4338fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */ 4347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 4357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 4367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* end-of-error-codes */ 4377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 4387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Extended Result Codes 4409bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** KEYWORDS: {extended result code definitions} 4417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4429bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** In its default configuration, SQLite API routines return one of 30 integer 4439bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [result codes]. However, experience has shown that many of 444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** these result codes are too coarse-grained. They do not provide as 4457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** much information about problems as programmers might like. In an effort to 4467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** address this, newer versions of SQLite (version 3.3.8 and later) include 4477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** support for additional result codes that provide more detailed information 4489bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** about errors. These [extended result codes] are enabled or disabled 449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on a per database connection basis using the 4509bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [sqlite3_extended_result_codes()] API. Or, the extended code for 4519bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** the most recent error can be obtained using 4529bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [sqlite3_extended_errcode()]. 4537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 47171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) 47271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) 47371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) 47490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) 47590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) 4768fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8)) 4778fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8)) 4788fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8)) 4798fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8)) 48071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) 48171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) 4828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8)) 48371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) 4848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) 4858fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8)) 4868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8)) 48790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) 48890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) 48990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) 4908fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8)) 4918fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8)) 492c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) 4938fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8)) 4948fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8)) 4958fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8)) 4968fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8)) 4978fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8)) 4988fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8)) 4998fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8)) 5008fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8)) 5018fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8)) 5028fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8)) 5038fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8)) 5048fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8)) 5058fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8)) 5063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8)) 5077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 509a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Flags For File Open Operations 5107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These bit values are intended for use in the 5127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3rd parameter to the [sqlite3_open_v2()] interface and 51390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in the 4th parameter to the [sqlite3_vfs.xOpen] method. 5147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ 516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ 517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ 518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ 519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ 52071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ 52190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ 5228fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */ 523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ 524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ 525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ 526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ 527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ 528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ 529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ 530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ 531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ 532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ 533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ 534de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ 5357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 53690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* Reserved: 0x00F00000 */ 53790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 5387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Device Characteristics 5407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 541de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xDeviceCharacteristics method of the [sqlite3_io_methods] 5428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** object returns an integer which is a vector of these 5437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bit values expressing I/O characteristics of the mass storage 5447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** device that holds the file that the [sqlite3_io_methods] 5457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** refers to. 5467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_IOCAP_ATOMIC property means that all writes of 5487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 5497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mean that writes of blocks that are nnn bytes in size and 5507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are aligned to an address which is an integer multiple of 5517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 5527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that when data is appended to a file, the data is appended 5537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** first then the size of the file is extended, never the other 5547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 5557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is written to disk in the same order as calls 55690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that 55790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** after reboot following a crash or power loss, the only bytes in a 55890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file that were written at the application level might have changed 55990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** and that adjacent bytes, even bytes within the same sector are 5608fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 5611c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** flag indicate that a file cannot be deleted when open. The 5621c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on 5631c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** read-only media and cannot be changed even by processes with 5641c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** elevated privileges. 5657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 566176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC 0x00000001 567176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC512 0x00000002 568176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC1K 0x00000004 569176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC2K 0x00000008 570176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC4K 0x00000010 571176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC8K 0x00000020 572176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC16K 0x00000040 573176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC32K 0x00000080 574176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC64K 0x00000100 575176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 576176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 577176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 57890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 5791c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#define SQLITE_IOCAP_IMMUTABLE 0x00002000 5807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: File Locking Levels 5837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite uses one of these integer values as the second 5857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument to calls it makes to the xLock() and xUnlock() methods 5867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of an [sqlite3_io_methods] object. 5877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_NONE 0 5897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_SHARED 1 5907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_RESERVED 2 5917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_PENDING 3 5927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_EXCLUSIVE 4 5937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Synchronization Type Flags 5967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When SQLite invokes the xSync() method of an 5987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_io_methods] object it uses a combination of 5997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** these integer values as the second argument. 6007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 6027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sync operation only needs to flush data to mass storage. Inode 603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** information need not be flushed. If the lower four bits of the flag 604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. 605a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the lower four bits equal SQLITE_SYNC_FULL, that means 606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use Mac OS X style fullsync instead of fsync(). 60795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 60895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags 60995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL 61095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** settings. The [synchronous pragma] determines when calls to the 61195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** xSync VFS method occur and applies uniformly across all platforms. 61295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how 61395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** energetic or rigorous or forceful the sync operations are and 61495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** only make a difference on Mac OSX for the default SQLite code. 61595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** (Third-party VFS implementations might also make the distinction 61695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the 61795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** operating systems natively supported by SQLite, only Mac OSX 61895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** cares about the difference.) 6197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 6207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_NORMAL 0x00002 6217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_FULL 0x00003 6227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_DATAONLY 0x00010 6237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 6247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface Open File Handle 6267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An [sqlite3_file] object represents an open file in the 628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_vfs | OS interface layer]. Individual OS interface 629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementations will 6307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** want to subclass this object by appending additional fields 6317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for their own use. The pMethods entry is a pointer to an 6327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_io_methods] object that defines methods for performing 6337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** I/O operations on the open file. 6347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 6357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_file sqlite3_file; 6367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_file { 6377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 6387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 6397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 6407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface File Virtual Methods Object 642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 64390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Every file opened by the [sqlite3_vfs.xOpen] method populates an 644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file] object (or, more commonly, a subclass of the 645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file] object) with a pointer to an instance of this object. 646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object defines the methods used to perform various operations 647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** against the open file represented by the [sqlite3_file] object. 6487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 64990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element 650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to a non-NULL pointer, then the sqlite3_io_methods.xClose method 65190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The 65290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] 65390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element 65490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to NULL. 6557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 6577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] 659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** flag may be ORed in to indicate that only the data of the file 660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and not its inode needs to be synced. 661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The integer values to xLock() and xUnlock() are one of 6637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 6647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_NONE], 6657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_SHARED], 6667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_RESERVED], 6677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_PENDING], or 6687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_EXCLUSIVE]. 6697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xLock() increases the lock. xUnlock() decreases the lock. 671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xCheckReservedLock() method checks whether any database connection, 672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** either in this process or in some other process, is holding a RESERVED, 6737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** PENDING, or EXCLUSIVE lock on the file. It returns true 674a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if such a lock exists and false otherwise. 675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xFileControl() method is a generic interface that allows custom 6777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** VFS implementations to directly control an open file using the 678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file_control()] interface. The second "op" argument is an 679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** integer opcode. The third argument is a generic pointer intended to 680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** point to a structure that may contain arguments or space in which to 6817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** write return values. Potential uses for xFileControl() might be 6827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** functions to enable blocking locks with timeouts, to change the 6837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** locking strategy (for example to use dot-file locks), to inquire 6847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** about the status of a lock, or to break stale locks. The SQLite 685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** core reserves all opcodes less than 100 for its own use. 6869bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** A [file control opcodes | list of opcodes] less than 100 is available. 687a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Applications that define a custom xFileControl method should use opcodes 68890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** greater than 100 to avoid conflicts. VFS implementations should 68990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** return [SQLITE_NOTFOUND] for file control opcodes that they do not 69090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** recognize. 6917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xSectorSize() method returns the sector size of the 6937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** device that underlies the file. The sector size is the 6947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** minimum write that can be performed without disturbing 6957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** other bytes in the file. The xDeviceCharacteristics() 6967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method returns a bit vector describing behaviors of the 6977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** underlying device: 6987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 7007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC] 7017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC512] 7027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC1K] 7037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC2K] 7047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC4K] 7057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC8K] 7067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC16K] 7077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC32K] 7087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC64K] 7097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_SAFE_APPEND] 7107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_SEQUENTIAL] 7117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 7127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_IOCAP_ATOMIC property means that all writes of 7147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 7157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mean that writes of blocks that are nnn bytes in size and 7167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are aligned to an address which is an integer multiple of 7177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 7187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that when data is appended to a file, the data is appended 7197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** first then the size of the file is extended, never the other 7207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 7217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is written to disk in the same order as calls 7227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to xWrite(). 723a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill 725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the unread portions of the buffer with zeros. A VFS that 726a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** fails to zero-fill short reads might seem to work. However, 727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** failure to zero-fill short reads will eventually lead to 728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database corruption. 7297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 7307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_io_methods sqlite3_io_methods; 7317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_io_methods { 7327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iVersion; 7337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xClose)(sqlite3_file*); 7347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); 7357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 7367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 7377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSync)(sqlite3_file*, int flags); 7387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 7397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xLock)(sqlite3_file*, int); 7407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xUnlock)(sqlite3_file*, int); 741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 7427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFileControl)(sqlite3_file*, int op, void *pArg); 7437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSectorSize)(sqlite3_file*); 7447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDeviceCharacteristics)(sqlite3_file*); 74571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* Methods above are valid for version 1 */ 746de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); 74771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); 74871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori void (*xShmBarrier)(sqlite3_file*); 749de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int (*xShmUnmap)(sqlite3_file*, int deleteFlag); 75071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* Methods above are valid for version 2 */ 7518fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp); 7528fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p); 7538fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich /* Methods above are valid for version 3 */ 7547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Additional methods may be added in future releases */ 7557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 7567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 7577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Standard File Control Opcodes 7599bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** KEYWORDS: {file control opcodes} {file control opcode} 7607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These integer constants are opcodes for the xFileControl method 762a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 7637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface. 7647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <ul> 7663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li>[[SQLITE_FCNTL_LOCKSTATE]] 7677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 7687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** opcode causes the xFileControl method to write the current state of 7697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 7707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 7717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** into an integer that the pArg argument points to. This capability 7723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is used during testing and is only available when the SQLITE_TEST 7733fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** compile-time option is used. 7743fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 775c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_SIZE_HINT]] 77671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS 77771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** layer a hint of how large the database file will grow to be during the 77871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** current transaction. This hint is not guaranteed to be accurate but it 77971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is often close. The underlying VFS might choose to preallocate database 78071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** file space based on this hint in order to help writes to the database 78171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** file run faster. 782de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 783c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_CHUNK_SIZE]] 784de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS 785de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** extends and truncates the database file in chunks of a size specified 786de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** by the user. The fourth argument to [sqlite3_file_control()] should 787de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** point to an integer (type int) containing the new chunk-size to use 788de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** for the nominated database. Allocating database file space in large 789de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** chunks (say 1MB at a time), may reduce file-system fragmentation and 790de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** improve performance on some systems. 79190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 792c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_FILE_POINTER]] 79390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer 79490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to the [sqlite3_file] object associated with a particular database 79590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** connection. See the [sqlite3_file_control()] documentation for 79690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** additional information. 79790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 798c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_SYNC_OMITTED]] 7998fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** No longer in use. 8008fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 8018fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li>[[SQLITE_FCNTL_SYNC]] 8028fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and 8038fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sent to the VFS immediately before the xSync method is invoked on a 8048fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** database file descriptor. Or, if the xSync method is not invoked 8058fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** because the user has configured SQLite with 8068fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place 8078fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** of the xSync method. In most cases, the pointer argument passed with 8088fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** this file-control is NULL. However, if the database file is being synced 8098fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** as part of a multi-database commit, the argument points to a nul-terminated 8108fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** string containing the transactions master-journal file name. VFSes that 8118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** do not need this signal should silently ignore this opcode. Applications 8128fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** should not call [sqlite3_file_control()] with this opcode as doing so may 8138fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** disrupt the operation of the specialized VFSes that do require it. 8148fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 8158fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]] 8168fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite 8178fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** and sent to the VFS after a transaction has been committed immediately 8188fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** but before the database is unlocked. VFSes that do not need this signal 8198fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** should silently ignore this opcode. Applications should not call 8208fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_file_control()] with this opcode as doing so may disrupt the 8218fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** operation of the specialized VFSes that do require it. 82290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 823c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]] 82490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic 82590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** retry counts and intervals for certain disk I/O operations for the 82690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** windows [VFS] in order to provide robustness in the presence of 82790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** anti-virus programs. By default, the windows VFS will retry file read, 82890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file write, and file delete operations up to 10 times, with a delay 82990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of 25 milliseconds before the first retry and with the delay increasing 83090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by an additional 25 milliseconds with each subsequent retry. This 83190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** opcode allows these two values (10 retries and 25 milliseconds of delay) 83290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to be adjusted. The values are changed for all database connections 83390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** within the same process. The argument is a pointer to an array of two 83490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** integers where the first integer i the new retry count and the second 83590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** integer is the delay. If either integer is negative, then the setting 83690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is not changed but instead the prior value of that setting is written 83790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** into the array entry, allowing the current retry settings to be 83890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** interrogated. The zDbName parameter is ignored. 83990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 840c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_PERSIST_WAL]] 84190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the 8428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary 84390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** write ahead log and shared memory files used for transaction control 84490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are automatically deleted when the latest connection to the database 84590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** closes. Setting persistent WAL mode causes those files to persist after 84690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** close. Persisting the files is useful when other processes that do not 84790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** have write permission on the directory containing the database file want 84890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to read the database file, as the WAL and shared memory files must exist 84990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in order for the database to be readable. The fourth parameter to 85090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 85190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** That integer is 0 to disable persistent WAL mode or 1 to enable persistent 85290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** WAL mode. If the integer is -1, then it is overwritten with the current 85390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** WAL persistence setting. 85490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 855c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] 85690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the 85790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting 85890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the 85990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** xDeviceCharacteristics methods. The fourth parameter to 86090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 86190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage 86290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** mode. If the integer is -1, then it is overwritten with the current 86390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** zero-damage mode setting. 86490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 865c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_OVERWRITE]] 86690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening 86790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a write transaction to indicate that, unless it is rolled back for some 86890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** reason, the entire database file will be overwritten by the current 86990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** transaction. This is used by VACUUM operations. 87090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 871c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_VFSNAME]] 87290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of 87390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** all [VFSes] in the VFS stack. The names are of all VFS shims and the 87490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** final bottom-level VFS are written into memory obtained from 87590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_malloc()] and the result is stored in the char* variable 87690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that the fourth parameter of [sqlite3_file_control()] points to. 87790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The caller is responsible for freeing the memory when done. As with 87890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** all file-control actions, there is no guarantee that this will actually 87990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** do anything. Callers should initialize the char* variable to a NULL 88090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pointer in case this file-control is not implemented. This file-control 88190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is intended for diagnostic use only. 882c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** 883c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_PRAGMA]] 884c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] 885c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** file control is sent to the open [sqlite3_file] object corresponding 886c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** to the database file to which the pragma statement refers. ^The argument 887c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** to the [SQLITE_FCNTL_PRAGMA] file control is an array of 888c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** pointers to strings (char**) in which the second element of the array 889c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** is the name of the pragma and the third element is the argument to the 890c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** pragma or NULL if the pragma has no argument. ^The handler for an 891c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element 892c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** of the char** argument point to a string obtained from [sqlite3_mprintf()] 893c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** or the equivalent and that string will become the result of the pragma or 894c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** the error message if the pragma fails. ^If the 895c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal 896c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] 897c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** file control returns [SQLITE_OK], then the parser assumes that the 898c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** VFS has handled the PRAGMA itself and the parser generates a no-op 8993fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** prepared statement if result string is NULL, or that returns a copy 9003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of the result string if the string is non-NULL. 9013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the [SQLITE_FCNTL_PRAGMA] file control returns 902c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means 903c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** that the VFS encountered an error while handling the [PRAGMA] and the 904c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] 905c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** file control occurs at the beginning of pragma statement analysis and so 906c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** it is able to override built-in [PRAGMA] statements. 9078fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 9088fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li>[[SQLITE_FCNTL_BUSYHANDLER]] 9098fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The [SQLITE_FCNTL_BUSYHANDLER] 9108fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** file-control may be invoked by SQLite on the database file handle 9118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** shortly after it is opened in order to provide a custom VFS with access 9128fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to the connections busy-handler callback. The argument is of type (void **) 9138fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** - an array of two (void *) values. The first (void *) actually points 9148fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to a function of type (int (*)(void *)). In order to invoke the connections 9158fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** busy-handler, this function should be invoked with the second (void *) in 9168fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the array as the only argument. If it returns non-zero, then the operation 9178fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** should be retried. If it returns zero, the custom VFS should abandon the 9188fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** current operation. 9198fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 9208fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li>[[SQLITE_FCNTL_TEMPFILENAME]] 9218fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control 9228fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to have SQLite generate a 9238fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** temporary filename using the same algorithm that is followed to generate 9248fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** temporary filenames for TEMP tables and other internal uses. The 9258fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** argument should be a char** which will be filled with the filename 9268fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** written into memory obtained from [sqlite3_malloc()]. The caller should 9278fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** invoke [sqlite3_free()] on the result to avoid a memory leak. 9288fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 9298fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li>[[SQLITE_FCNTL_MMAP_SIZE]] 9308fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the 9318fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** maximum number of bytes that will be used for memory-mapped I/O. 9328fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The argument is a pointer to a value of type sqlite3_int64 that 9338fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** is an advisory maximum number of bytes in the file to memory map. The 9348fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** pointer is overwritten with the old value. The limit is not changed if 9358fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the value originally pointed to is negative, and so the current limit 9368fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** can be queried by passing in a pointer to a negative number. This 9378fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** file-control is used internally to implement [PRAGMA mmap_size]. 9388fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 9398fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li>[[SQLITE_FCNTL_TRACE]] 9408fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The [SQLITE_FCNTL_TRACE] file control provides advisory information 9418fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to the VFS about what the higher layers of the SQLite stack are doing. 9428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** This file control is used by some VFS activity tracing [shims]. 9438fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The argument is a zero-terminated string. Higher layers in the 9448fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQLite stack may generate instances of this file control if 9458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled. 9468fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 9478fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li>[[SQLITE_FCNTL_HAS_MOVED]] 9488fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a 9498fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** pointer to an integer and it writes a boolean into that integer depending 9508fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** on whether or not the file has been renamed, moved, or deleted since it 9518fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** was first opened. 9528fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 9531c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]] 9541c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This 9551c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** opcode causes the xFileControl method to swap the file handle with the one 9561c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** pointed to by the pArg argument. This capability is used during testing 9571c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** and only needs to be supported when SQLITE_TEST is defined. 9581c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** 9593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li>[[SQLITE_FCNTL_WAL_BLOCK]] 9603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might 9613fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** be advantageous to block on the next WAL lock if the lock is not immediately 9623fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** available. The WAL subsystem issues this signal during rare 9633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** circumstances in order to fix a problem with priority inversion. 9643fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Applications should <em>not</em> use this file-control. 9653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 966c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** </ul> 96790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 96890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_LOCKSTATE 1 9693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_FCNTL_GET_LOCKPROXYFILE 2 9703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_FCNTL_SET_LOCKPROXYFILE 3 9713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_FCNTL_LAST_ERRNO 4 97290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_SIZE_HINT 5 97390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_CHUNK_SIZE 6 97490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_FILE_POINTER 7 97590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_SYNC_OMITTED 8 97690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_WIN32_AV_RETRY 9 97790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_PERSIST_WAL 10 97890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_OVERWRITE 11 97990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_VFSNAME 12 98090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 981c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown#define SQLITE_FCNTL_PRAGMA 14 9828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_FCNTL_BUSYHANDLER 15 9838fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_FCNTL_TEMPFILENAME 16 9848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_FCNTL_MMAP_SIZE 18 9858fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_FCNTL_TRACE 19 9868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_FCNTL_HAS_MOVED 20 9878fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_FCNTL_SYNC 21 9888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_FCNTL_COMMIT_PHASETWO 22 9891c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#define SQLITE_FCNTL_WIN32_SET_HANDLE 23 9903fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_FCNTL_WAL_BLOCK 24 9913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich 9923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich/* deprecated names */ 9933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE 9943fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE 9953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO 9963fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich 9977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 9987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Handle 10007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 10017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The mutex module within SQLite defines [sqlite3_mutex] to be an 10027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** abstract type for a mutex object. The SQLite core never looks 10037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** at the internal representation of an [sqlite3_mutex]. It only 10047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** deals with pointers to the [sqlite3_mutex] object. 10057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 10067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Mutexes are created using [sqlite3_mutex_alloc()]. 10077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 10087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_mutex sqlite3_mutex; 10097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 10107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface Object 10127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of the sqlite3_vfs object defines the interface between 1014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the SQLite core and the underlying operating system. The "vfs" 101590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in the name of the object stands for "virtual file system". See 101690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the [VFS | VFS documentation] for further information. 10177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value of the iVersion field is initially 1 but may be larger in 1019a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** future versions of SQLite. Additional fields may be appended to this 1020a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object when the iVersion value is increased. Note that the structure 1021a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the sqlite3_vfs object changes in the transaction between 1022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not 1023a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** modified. 10247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 10257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The szOsFile field is the size of the subclassed [sqlite3_file] 10267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** structure used by this VFS. mxPathname is the maximum length of 10277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a pathname in this VFS. 10287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 10297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Registered sqlite3_vfs objects are kept on a linked list formed by 10307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pNext pointer. The [sqlite3_vfs_register()] 10317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_vfs_unregister()] interfaces manage this list 10327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in a thread-safe way. The [sqlite3_vfs_find()] interface 1033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** searches the list. Neither the application code nor the VFS 1034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation should use the pNext pointer. 10357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The pNext field is the only field in the sqlite3_vfs 10377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** structure that SQLite will ever modify. SQLite will only access 10387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or modify this field while holding a particular static mutex. 10397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The application should never modify anything within the sqlite3_vfs 10407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object once the object has been registered. 10417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 10427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The zName field holds the name of the VFS module. The name must 10437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be unique across all VFS modules. 10447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 104590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_vfs.xOpen]] 1046de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite guarantees that the zFilename parameter to xOpen 1047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is either a NULL pointer or string obtained 1048de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** from xFullPathname() with an optional suffix added. 1049de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If a suffix is added to the zFilename parameter, it will 1050de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** consist of a single "-" character followed by no more than 105190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 11 alphanumeric and/or "-" characters. 1052de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite further guarantees that 1053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the string will be valid and unchanged until xClose() is 1054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called. Because of the previous sentence, 1055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_file] can safely store a pointer to the 10567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** filename if it needs to remember the filename for some reason. 1057de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the zFilename parameter to xOpen is a NULL pointer then xOpen 1058de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** must invent its own temporary name for the file. ^Whenever the 1059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xFilename parameter is NULL it will also be the case that the 1060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 10617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The flags argument to xOpen() includes all bits set in 10637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 10647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or [sqlite3_open16()] is used, then flags includes at least 1065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 10667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If xOpen() opens a file read-only then it sets *pOutFlags to 1067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 1068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1069de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(SQLite will also add one of the following flags to the xOpen() 10707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** call, depending on the object being opened: 1071a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 10727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 10737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MAIN_DB] 10747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MAIN_JOURNAL] 10757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TEMP_DB] 10767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TEMP_JOURNAL] 10777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TRANSIENT_DB] 10787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_SUBJOURNAL] 10797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MASTER_JOURNAL] 1080de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_OPEN_WAL] 1081de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul>)^ 10827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 10837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The file I/O implementation can use the object type flags to 1084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** change the way it deals with files. For example, an application 10857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that does not care about crash recovery or rollback might make 10867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the open of a journal file a no-op. Writes to this journal would 1087a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also be no-ops, and any attempt to read the journal would return 1088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_IOERR. Or the implementation might recognize that a database 1089a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** file will be doing page-aligned sector reads and writes in a random 10907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** order and set up its I/O subsystem accordingly. 1091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite might also add one of the following flags to the xOpen method: 1093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 10947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 10957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_DELETEONCLOSE] 10967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_EXCLUSIVE] 10977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 1098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 1100de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] 1101de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will be set for TEMP databases and their journals, transient 1102de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** databases, and subjournals. 1103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1104de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction 1105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the [SQLITE_OPEN_CREATE] flag, which are both directly 1106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** analogous to the O_EXCL and O_CREAT flags of the POSIX open() 1107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 1108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_OPEN_CREATE, is used to indicate that file should always 1109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be created, and that it is an error if it already exists. 1110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is <i>not</i> used to indicate the file should be opened 1111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for exclusive access. 1112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1113de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^At least szOsFile bytes of memory are allocated by SQLite 1114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to hold the [sqlite3_file] structure passed as the third 1115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument to xOpen. The xOpen method does not have to 1116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocate the structure; it should just fill it in. Note that 1117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xOpen method must set the sqlite3_file.pMethods to either 1118a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a valid [sqlite3_io_methods] object or to NULL. xOpen must do 1119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this even if the open fails. SQLite expects that the sqlite3_file.pMethods 1120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** element will be valid after xOpen returns regardless of the success 1121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or failure of the xOpen call. 1122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 112390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_vfs.xAccess]] 1124de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 1125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 1126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 1127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to test whether a file is at least readable. The file can be a 11287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** directory. 1129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1130de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite will always allocate at least mxPathname+1 bytes for the 1131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** output buffer xFullPathname. The exact size of the output buffer 1132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is also passed as a parameter to both methods. If the output buffer 1133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 1134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handled as a fatal error by SQLite, vfs implementations should endeavor 1135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to prevent this by setting mxPathname to a sufficiently large value. 1136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1137ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() 1138ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** interfaces are not strictly a part of the filesystem, but they are 11397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** included in the VFS structure for completeness. 11407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xRandomness() function attempts to return nBytes bytes 11417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of good-quality randomness into zOut. The return value is 1142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the actual number of bytes of randomness obtained. 1143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xSleep() method causes the calling thread to sleep for at 1144de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** least the number of microseconds given. ^The xCurrentTime() 1145ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** method returns a Julian Day Number for the current date and time as 1146ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** a floating point value. 1147de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xCurrentTimeInt64() method returns, as an integer, the Julian 114890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Day Number multiplied by 86400000 (the number of milliseconds in 1149ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** a 24-hour day). 1150ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** ^SQLite will use the xCurrentTimeInt64() method to get the current 1151ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** date and time if that method is available (if iVersion is 2 or 1152ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** greater and the function pointer is not NULL) and will fall back 1153ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** to xCurrentTime() if xCurrentTimeInt64() is unavailable. 115490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 115590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces 115690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are not used by the SQLite core. These optional interfaces are provided 115790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by some VFSes to facilitate testing of the VFS code. By overriding 115890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** system calls with functions under its control, a test program can 115990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** simulate faults and error conditions that would otherwise be difficult 116090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or impossible to induce. The set of system calls that can be overridden 116190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** varies from one VFS to another, and from one version of the same VFS to the 116290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** next. Applications that use these interfaces must be prepared for any 116390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or all of these interfaces to be NULL or for their behavior to change 116490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** from one release to the next. Applications must not attempt to access 116590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** any of these methods if the iVersion of the VFS is less than 3. 11667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 11677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vfs sqlite3_vfs; 116890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Browntypedef void (*sqlite3_syscall_ptr)(void); 11697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vfs { 117090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int iVersion; /* Structure version number (currently 3) */ 11717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int szOsFile; /* Size of subclassed sqlite3_file */ 11727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int mxPathname; /* Maximum file pathname length */ 11737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vfs *pNext; /* Next registered VFS */ 11747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName; /* Name of this virtual file system */ 11757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pAppData; /* Pointer to application-specific data */ 11767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 11777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, int *pOutFlags); 11787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 1179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 11807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 11817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 11827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 1183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); 11847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xDlClose)(sqlite3_vfs*, void*); 11857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 11867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSleep)(sqlite3_vfs*, int microseconds); 11877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCurrentTime)(sqlite3_vfs*, double*); 1188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xGetLastError)(sqlite3_vfs*, int, char *); 118971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* 119071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** The methods above are in version 1 of the sqlite_vfs object 119171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** definition. Those that follow are added in version 2 or later 119271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori */ 119371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); 119471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* 119571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** The methods above are in versions 1 and 2 of the sqlite_vfs object. 119690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown ** Those below are for version 3 and greater. 119790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown */ 119890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); 119990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); 120090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); 120190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown /* 120290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown ** The methods above are in versions 1 through 3 of the sqlite_vfs object. 120371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** New fields may be appended in figure versions. The iVersion 120471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** value will increment whenever this happens. 120571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori */ 12067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 12077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 12087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Flags for the xAccess VFS method 1210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These integer constants can be used as the third parameter to 1212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xAccess method of an [sqlite3_vfs] object. They determine 1213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what kind of permissions the xAccess method is looking for. 1214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_EXISTS, the xAccess method 1215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** simply checks whether the file exists. 1216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_READWRITE, the xAccess method 1217de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** checks whether the named directory is both readable and writable 1218de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** (in other words, if files can be added, removed, and renamed within 1219de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the directory). 1220de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The SQLITE_ACCESS_READWRITE constant is currently used only by the 1221de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [temp_store_directory pragma], though this could change in a future 1222de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** release of SQLite. 1223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_READ, the xAccess method 1224de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** checks whether the file is readable. The SQLITE_ACCESS_READ constant is 1225de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** currently unused, though it might be used in a future release of 1226de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite. 12277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 12287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ACCESS_EXISTS 0 1229de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ 1230de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_ACCESS_READ 2 /* Unused */ 12317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 12327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 123371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Flags for the xShmLock VFS method 123471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 123571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** These integer constants define the various locking operations 123671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** allowed by the xShmLock method of [sqlite3_io_methods]. The 123771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** following are the only legal combinations of flags to the 123871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** xShmLock method: 123971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 124071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <ul> 124171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED 124271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE 124371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED 124471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE 124571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** </ul> 124671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 124771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as 12483fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** was given on the corresponding lock. 124971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 125071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The xShmLock method can transition between unlocked and SHARED or 125171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** between unlocked and EXCLUSIVE. It cannot transition between SHARED 125271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and EXCLUSIVE. 125371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 125471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_UNLOCK 1 125571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_LOCK 2 125671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_SHARED 4 125771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_EXCLUSIVE 8 125871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 125971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 126071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Maximum xShmLock index 126171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 126271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The xShmLock method on [sqlite3_io_methods] may use values 126371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** between 0 and this upper bound as its "offset" argument. 126471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The SQLite core will never attempt to acquire or release a 126571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** lock outside of this range 126671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 126771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_NLOCK 8 126871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 126971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 127071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 1271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Initialize The SQLite Library 1272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine initializes the 1274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite library. ^The sqlite3_shutdown() routine 1275a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** deallocates any resources that were allocated by sqlite3_initialize(). 1276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are designed to aid in process initialization and 1277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shutdown on embedded systems. Workstation applications using 1278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite normally do not need to invoke either of these routines. 1279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A call to sqlite3_initialize() is an "effective" call if it is 1281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first time sqlite3_initialize() is invoked during the lifetime of 1282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the process, or if it is the first time sqlite3_initialize() is invoked 1283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following a call to sqlite3_shutdown(). ^(Only an effective call 1284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_initialize() does any initialization. All other calls 1285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are harmless no-ops.)^ 1286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A call to sqlite3_shutdown() is an "effective" call if it is the first 1288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only 1289a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an effective call to sqlite3_shutdown() does any deinitialization. 1290a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ 1291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() 1293a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not. The sqlite3_shutdown() interface must only be called from a 1294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single thread. All open [database connections] must be closed and all 1295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** other SQLite resources must be deallocated prior to invoking 1296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_shutdown(). 1297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1298a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Among other things, ^sqlite3_initialize() will invoke 1299a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() 1300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will invoke sqlite3_os_end(). 1301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. 1303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If for some reason, sqlite3_initialize() is unable to initialize 1304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the library (perhaps it is unable to allocate a needed resource such 1305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as a mutex) it returns an [error code] other than [SQLITE_OK]. 1306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine is called internally by many other 1308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite interfaces so that an application usually does not need to 1309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 1310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calls sqlite3_initialize() so the SQLite library will be automatically 1311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** initialized when [sqlite3_open()] is called if it has not be initialized 1312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] 1313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compile-time option, then the automatic calls to sqlite3_initialize() 1314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are omitted and the application must call sqlite3_initialize() directly 1315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to using any other SQLite interface. For maximum portability, 1316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is recommended that applications always invoke sqlite3_initialize() 1317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** directly prior to using any other SQLite interface. Future releases 1318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of SQLite may require this. In other words, the behavior exhibited 1319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the 1320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** default behavior in some future release of SQLite. 1321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_os_init() routine does operating-system specific 1323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** initialization of the SQLite library. The sqlite3_os_end() 1324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine undoes the effect of sqlite3_os_init(). Typical tasks 1325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performed by these routines include allocation or deallocation 1326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of static resources, initialization of global variables, 1327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** setting up a default [sqlite3_vfs] module, or setting up 1328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a default configuration using [sqlite3_config()]. 1329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application should never invoke either sqlite3_os_init() 1331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or sqlite3_os_end() directly. The application should only invoke 1332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() 1333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is called automatically by sqlite3_initialize() and 1334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate 1335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementations for sqlite3_os_init() and sqlite3_os_end() 1336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are built into SQLite when it is compiled for Unix, Windows, or OS/2. 1337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When [custom builds | built for other platforms] 1338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (using the [SQLITE_OS_OTHER=1] compile-time 1339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** option) the application must supply a suitable implementation for 1340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_init() and sqlite3_os_end(). An application-supplied 1341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of sqlite3_os_init() or sqlite3_os_end() 1342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must return [SQLITE_OK] on success and some other [error code] upon 1343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** failure. 1344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 13453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_initialize(void); 13463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_shutdown(void); 13473fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_os_init(void); 13483fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_os_end(void); 1349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configuring The SQLite Library 1352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_config() interface is used to make global configuration 1354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changes to SQLite in order to tune SQLite to the specific needs of 1355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application. The default configuration is recommended for most 1356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** applications and so this routine is usually not necessary. It is 1357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** provided to support rare applications with unusual needs. 1358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_config() interface is not threadsafe. The application 1360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must insure that no other SQLite interfaces are invoked by other 1361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** threads while sqlite3_config() is running. Furthermore, sqlite3_config() 1362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may only be invoked prior to library initialization using 1363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 1364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_config() is called after [sqlite3_initialize()] and before 1365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. 1366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note, however, that ^sqlite3_config() can be called as part of the 1367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of an application-defined [sqlite3_os_init()]. 1368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument to sqlite3_config() is an integer 137090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [configuration option] that determines 1371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what property of SQLite is to be configured. Subsequent arguments 137290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** vary depending on the [configuration option] 1373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the first argument. 1374a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 1376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the option is unknown or SQLite is unable to set the option 1377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then this routine returns a non-zero [error code]. 1378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 13793fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_CDECL sqlite3_config(int, ...); 1380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1382a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configure database connections 13833a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 1384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_db_config() interface is used to make configuration 1386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changes to a [database connection]. The interface is similar to 1387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] except that the changes apply to a single 138890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [database connection] (specified in the first argument). 1389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second argument to sqlite3_db_config(D,V,...) is the 139190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code 139290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that indicates what aspect of the [database connection] is being configured. 139390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Subsequent arguments vary depending on the configuration verb. 1394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1395a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if 1396a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call is considered successful. 1397a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 13983fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_CDECL sqlite3_db_config(sqlite3*, int op, ...); 1399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocation Routines 1402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this object defines the interface between SQLite 1404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and low-level memory allocation routines. 1405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object is used in only one place in the SQLite interface. 1407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A pointer to an instance of this object is the argument to 1408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] when the configuration option is 1409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. 1410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** By creating an instance of this object 1411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) 1412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** during configuration, an application can specify an alternative 1413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation subsystem for SQLite to use for all of its 1414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** dynamic memory needs. 1415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that SQLite comes with several [built-in memory allocators] 1417a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are perfectly adequate for the overwhelming majority of applications 1418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and that this object is only useful to a tiny minority of applications 1419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with specialized memory allocation requirements. This object is 1420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also used during testing of SQLite in order to specify an alternative 1421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocator that simulates memory out-of-memory conditions in 1422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** order to verify that SQLite recovers gracefully from such 1423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** conditions. 1424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 142590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The xMalloc, xRealloc, and xFree methods must work like the 142690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** malloc(), realloc() and free() functions from the standard C library. 142790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite guarantees that the second argument to 1428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xRealloc is always a value returned by a prior call to xRoundup. 1429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xSize should return the allocated size of a memory allocation 1431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously obtained from xMalloc or xRealloc. The allocated size 1432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is always at least as big as the requested size but may be larger. 1433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xRoundup method returns what would be the allocated size of 1435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a memory allocation given a particular requested size. Most memory 1436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocators round up memory allocations at least to the next multiple 1437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of 8. Some allocators round up to a larger multiple or to a power of 2. 1438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every memory allocation request coming in through [sqlite3_malloc()] 1439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, 1440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that causes the corresponding memory allocation to fail. 1441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 14428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The xInit method initializes the memory allocator. For example, 1443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it might allocate any require mutexes or initialize internal data 1444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structures. The xShutdown method is invoked (indirectly) by 1445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_shutdown()] and should deallocate any resources acquired 1446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by xInit. The pAppData pointer is used as the only parameter to 1447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xInit and xShutdown. 1448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes 1450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xInit method, so the xInit method need not be threadsafe. The 1451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xShutdown method is only called from [sqlite3_shutdown()] so it does 1452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not need to be threadsafe either. For all other methods, SQLite 1453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the 1454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which 1455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is by default) and so the methods are automatically serialized. 1456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other 1457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** methods must be threadsafe or else make their own arrangements for 1458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** serialization. 1459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will never invoke xInit() more than once without an intervening 1461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xShutdown(). 1462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_mem_methods sqlite3_mem_methods; 1464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_mem_methods { 1465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xMalloc)(int); /* Memory allocation function */ 1466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xFree)(void*); /* Free a prior allocation */ 1467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xRealloc)(void*,int); /* Resize an allocation */ 1468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xSize)(void*); /* Return the size of an allocation */ 1469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xRoundup)(int); /* Round up request size to allocation size */ 1470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xInit)(void*); /* Initialize the memory allocator */ 1471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pAppData; /* Argument to xInit() and xShutdown() */ 1473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 1474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configuration Options 147790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {configuration option} 1478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer configuration options that 1480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be passed as the first argument to the [sqlite3_config()] interface. 1481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New configuration options may be added in future releases of SQLite. 1483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Existing configuration options might be discontinued. Applications 1484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should check the return code from [sqlite3_config()] to make sure that 1485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call worked. The [sqlite3_config()] interface will return a 1486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] if a discontinued or unsupported configuration option 1487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked. 1488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 149090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Single-thread. In other words, it disables 1493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all mutexing and puts SQLite into a mode where it can only be used 1494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a single thread. ^If SQLite is compiled with 1495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to change the [threading mode] from its default 1497a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of Single-thread and so [sqlite3_config()] will return 1498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD 1499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** configuration option.</dd> 1500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 150190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1502a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1503a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Multi-thread. In other words, it disables 1504a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutexing on [database connection] and [prepared statement] objects. 1505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application is responsible for serializing access to 1506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connections] and [prepared statements]. But other mutexes 1507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are enabled so that SQLite will be safe to use in a multi-threaded 1508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** environment as long as no two threads attempt to use the same 1509a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] at the same time. ^If SQLite is compiled with 1510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to set the Multi-thread [threading mode] and 1512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1513a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> 1514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 151590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt> 1516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Serialized. In other words, this option enables 1518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all mutexes including the recursive 1519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutexes on [database connection] and [prepared statement] objects. 1520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In this mode (which is the default when SQLite is compiled with 1521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to [database connections] and [prepared statements] so that the 1523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application is free to use the same [database connection] or the 1524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same [prepared statement] in different threads at the same time. 1525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If SQLite is compiled with 1526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to set the Serialized [threading mode] and 1528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_CONFIG_SERIALIZED configuration option.</dd> 1530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 153190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> 15323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is 15333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** a pointer to an instance of the [sqlite3_mem_methods] structure. 15343fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The argument specifies 1535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** alternative low-level memory allocation routines to be used in place of 1536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the memory allocation routines built into SQLite.)^ ^SQLite makes 1537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its own private copy of the content of the [sqlite3_mem_methods] structure 1538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before the [sqlite3_config()] call returns.</dd> 1539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 154090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> 15413fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which 15423fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is a pointer to an instance of the [sqlite3_mem_methods] structure. 15433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The [sqlite3_mem_methods] 1544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structure is filled with the currently defined memory allocation routines.)^ 1545a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This option can be used to overload the default memory allocation 1546a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines with a wrapper that simulations memory allocation failure or 1547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** tracks memory usage, for example. </dd> 1548a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 154990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> 15503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int, 15513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** interpreted as a boolean, which enables or disables the collection of 15523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** memory allocation statistics. ^(When memory allocation statistics are 15533fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** disabled, the following SQLite interfaces become non-operational: 1554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 1555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_memory_used()] 1556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_memory_highwater()] 1557de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [sqlite3_soft_heap_limit64()] 15583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> [sqlite3_status64()] 1559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 1560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Memory allocation statistics are enabled by default unless SQLite is 1561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory 1562a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation statistics are disabled by default. 1563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dd> 1564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 156590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> 15663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^The SQLITE_CONFIG_SCRATCH option specifies a static memory buffer 15673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** that SQLite can use for scratch memory. ^(There are three arguments 15683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to SQLITE_CONFIG_SCRATCH: A pointer an 8-byte 156990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** aligned memory buffer from which the scratch allocations will be 1570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** drawn, the size of each scratch allocation (sz), 15713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** and the maximum number of scratch allocations (N).)^ 1572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument must be a pointer to an 8-byte aligned buffer 1573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of at least sz*N bytes of memory. 15743fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^SQLite will not use more than one scratch buffers per thread. 15753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^SQLite will never request a scratch buffer that is more than 6 15763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** times the database page size. 15773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If SQLite needs needs additional 1578de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** scratch memory beyond what is provided by this configuration option, then 15793fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_malloc()] will be used to obtain the memory needed.<p> 15803fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^When the application provides any amount of scratch memory using 15813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** SQLITE_CONFIG_SCRATCH, SQLite avoids unnecessary large 15823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_malloc|heap allocations]. 15833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** This can help [Robson proof|prevent memory allocation failures] due to heap 15843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** fragmentation in low-memory embedded systems. 15853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** </dd> 1586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 158790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> 15883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a static memory buffer 15893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** that SQLite can use for the database page cache with the default page 15903fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** cache implementation. 1591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This configuration should not be used if an application-define page 15923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2] 15933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** configuration option. 15943fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to 15953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 8-byte aligned 1596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory, the size of each page buffer (sz), and the number of pages (N). 1597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sz argument should be the size of the largest database page 15983fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** (a power of two between 512 and 65536) plus some extra bytes for each 15993fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** page header. ^The number of extra bytes needed by the page header 16003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** can be determined using the [SQLITE_CONFIG_PCACHE_HDRSZ] option 16013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to [sqlite3_config()]. 16023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^It is harmless, apart from the wasted memory, 16033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** for the sz parameter to be larger than necessary. The first 16043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** argument should pointer to an 8-byte aligned block of memory that 16053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is at least sz*N bytes of memory, otherwise subsequent behavior is 16063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** undefined. 1607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will use the memory provided by the first argument to satisfy its 1608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory needs for the first N pages that it adds to cache. ^If additional 1609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page cache memory is needed beyond what is provided by this option, then 16103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** SQLite goes to [sqlite3_malloc()] for the additional storage space.</dd> 1611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 161290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> 16133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer 16143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** that SQLite will use for all of its dynamic memory allocation needs 16153fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** beyond those provided for by [SQLITE_CONFIG_SCRATCH] and 16163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [SQLITE_CONFIG_PAGECACHE]. 16173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled 16183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns 16193fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [SQLITE_ERROR] if invoked otherwise. 16203fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^There are three arguments to SQLITE_CONFIG_HEAP: 16213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** An 8-byte aligned pointer to the memory, 1622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of bytes in the memory buffer, and the minimum allocation size. 1623a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts 1624a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to using its default memory allocator (the system malloc() implementation), 1625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the 16263fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** memory pointer is not NULL then the alternative memory 1627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocator is engaged to handle all of SQLites memory allocation needs. 1628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first pointer (the memory pointer) must be aligned to an 8-byte 162990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** boundary or subsequent behavior of SQLite will be undefined. 163090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The minimum allocation size is capped at 2**12. Reasonable values 163190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for the minimum allocation size are 2**5 through 2**8.</dd> 1632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 163390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> 16343fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a 16353fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** pointer to an instance of the [sqlite3_mutex_methods] structure. 16363fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The argument specifies alternative low-level mutex routines to be used 16373fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of 16383fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the content of the [sqlite3_mutex_methods] structure before the call to 1639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] returns. ^If SQLite is compiled with 1640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the entire mutexing subsystem is omitted from the build and hence calls to 1642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will 1643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return [SQLITE_ERROR].</dd> 1644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 164590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> 16463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which 16473fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The 1648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_mutex_methods] 1649a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structure is filled with the currently defined mutex routines.)^ 1650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This option can be used to overload the default mutex allocation 1651a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines with a wrapper used to track mutex usage for performance 1652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** profiling or testing, for example. ^If SQLite is compiled with 1653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the entire mutexing subsystem is omitted from the build and hence calls to 1655a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will 1656a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return [SQLITE_ERROR].</dd> 1657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 165890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> 16593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine 16603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the default size of lookaside memory on each [database connection]. 16613fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The first argument is the 1662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** size of each lookaside buffer slot and the second is the number of 16633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE 16643fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] 16653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** option to [sqlite3_db_config()] can be used to change the lookaside 1666a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** configuration on individual connections.)^ </dd> 1667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 166890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> 16693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is 16703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** a pointer to an [sqlite3_pcache_methods2] object. This object specifies 16713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the interface to a custom page cache implementation.)^ 16723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd> 1673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 167490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> 16753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which 16763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of 16773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the current page cache implementation into that object.)^ </dd> 1678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 167990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> 16808fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite 16818fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** global [error log]. 16828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a 168371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function with a call signature of void(*)(void*,int,const char*), 168471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and a pointer to void. ^If the function pointer is not NULL, it is 168571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** invoked by [sqlite3_log()] to process each logging event. ^If the 168671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. 168771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is 168871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** passed through as the first parameter to the application-defined logger 168971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function whenever that function is invoked. ^The second parameter to 169071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** the logger function is a copy of the first parameter to the corresponding 169171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_log()] call and is intended to be a [result code] or an 169271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [extended result code]. ^The third parameter passed to the logger is 169371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** log message after formatting via [sqlite3_snprintf()]. 169471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The SQLite logging interface is not reentrant; the logger function 169571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** supplied by the application must not invoke any SQLite interface. 169671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** In a multi-threaded application, the application-defined logger 169771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function must be threadsafe. </dd> 169871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 169990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI 17003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int. 17013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** If non-zero, then URI handling is globally enabled. If the parameter is zero, 17023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** then URI handling is globally disabled.)^ ^If URI handling is globally 17033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()], 17043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_open16()] or 170590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** specified as part of [ATTACH] commands are interpreted as URIs, regardless 170690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of whether or not the [SQLITE_OPEN_URI] flag is set when the database 17078fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** connection is opened. ^If it is globally disabled, filenames are 170890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the 17098fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** database connection is opened. ^(By default, URI handling is globally 171090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** disabled. The default value may be changed by compiling with the 17118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLITE_USE_URI] symbol defined.)^ 17128fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 17138fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN 17143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer 17153fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** argument which is interpreted as a boolean in order to enable or disable 17163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the use of covering indices for full table scans in the query optimizer. 17173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The default setting is determined 17188fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on" 17198fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** if that compile-time option is omitted. 17208fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The ability to disable the use of covering indices for full table scans 17218fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** is because some incorrectly coded legacy applications might malfunction 17228fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** when the optimization is enabled. Providing the ability to 17238fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** disable the optimization allows the older, buggy application code to work 17248fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** without change even with newer versions of SQLite. 172590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 172690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] 17278fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE 172890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd> These options are obsolete and should not be used by new code. 172990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** They are retained for backwards compatibility but are now no-ops. 17308fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** </dd> 17318fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 17328fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [[SQLITE_CONFIG_SQLLOG]] 17338fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dt>SQLITE_CONFIG_SQLLOG 17348fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dd>This option is only available if sqlite is compiled with the 17358fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should 17368fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int). 17378fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The second should be of type (void*). The callback is invoked by the library 17388fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** in three separate circumstances, identified by the value passed as the 17398fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** fourth parameter. If the fourth parameter is 0, then the database connection 17408fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** passed as the second argument has just been opened. The third argument 17418fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** points to a buffer containing the name of the main database file. If the 17428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** fourth parameter is 1, then the SQL statement that the third parameter 17438fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** points to has just been executed. Or, if the fourth parameter is 2, then 17448fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the connection being passed as the second parameter is being closed. The 17458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** third parameter is passed NULL In this case. An example of using this 17468fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** configuration option can be seen in the "test_sqllog.c" source file in 17478fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the canonical SQLite source tree.</dd> 17488fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 17498fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [[SQLITE_CONFIG_MMAP_SIZE]] 17508fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dt>SQLITE_CONFIG_MMAP_SIZE 17518fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values 17528fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** that are the default mmap size limit (the default setting for 17538fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [PRAGMA mmap_size]) and the maximum allowed mmap size limit. 17548fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The default setting can be overridden by each database connection using 17558fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** either the [PRAGMA mmap_size] command, or by using the 17568fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size 17573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** will be silently truncated if necessary so that it does not exceed the 17583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** compile-time maximum mmap size set by the 17598fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^ 17608fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If either argument to this option is negative, then that argument is 17618fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** changed to its compile-time default. 17628fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 17638fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [[SQLITE_CONFIG_WIN32_HEAPSIZE]] 17648fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE 17653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is 17663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro 17673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value 17688fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** that specifies the maximum size of the created heap. 17693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 17703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_CONFIG_PCACHE_HDRSZ]] 17713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dt>SQLITE_CONFIG_PCACHE_HDRSZ 17723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which 17733fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is a pointer to an integer and writes into that integer the number of extra 17743fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE]. 17753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The amount of extra space required can change depending on the compiler, 17763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** target platform, and SQLite version. 17773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 17783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_CONFIG_PMASZ]] 17793fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dt>SQLITE_CONFIG_PMASZ 17803fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which 17813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded 17823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sorter to that integer. The default minimum PMA Size is set by the 17833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched 17843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to help with sort operations when multithreaded sorting 17853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is enabled (using the [PRAGMA threads] command) and the amount of content 17863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to be sorted exceeds the page size times the minimum of the 17873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [PRAGMA cache_size] setting and this value. 1788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 1789a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 1791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 1792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 1793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 1794a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 1795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ 1796a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 1797a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 1798a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 1799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 1800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 1801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 1802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 180390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_PCACHE 14 /* no-op */ 180490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ 1805aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ 180690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_URI 17 /* int */ 180790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ 180890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ 18098fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */ 18108fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */ 18118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */ 18128fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */ 18133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */ 18143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */ 1815a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 181771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Database Connection Configuration Options 18187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1819a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer configuration options that 1820a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be passed as the second argument to the [sqlite3_db_config()] interface. 18217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1822a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New configuration options may be added in future releases of SQLite. 1823a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Existing configuration options might be discontinued. Applications 1824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should check the return code from [sqlite3_db_config()] to make sure that 1825a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call worked. ^The [sqlite3_db_config()] interface will return a 1826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] if a discontinued or unsupported configuration option 1827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked. 1828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1829a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 1830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 1831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option takes three additional arguments that determine the 1832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [lookaside memory allocator] configuration for the [database connection]. 1833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument (the third parameter to [sqlite3_db_config()] is a 183490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pointer to a memory buffer to use for lookaside memory. 1835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb 1836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may be NULL in which case SQLite will allocate the 1837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the 1838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** size of each lookaside buffer slot. ^The third argument is the number of 1839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots. The size of the buffer in the first argument must be greater than 1840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or equal to the product of the second and third arguments. The buffer 1841a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be aligned to an 8-byte boundary. ^If the second argument to 1842a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally 1843de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** rounded down to the next smaller multiple of 8. ^(The lookaside memory 1844de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** configuration for a database connection can only be changed when that 1845de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** connection is not currently using lookaside memory, or in other words 1846de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** when the "current value" returned by 1847de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. 1848de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Any attempt to change the lookaside memory configuration when lookaside 1849de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** memory is in use leaves the configuration unchanged and returns 1850de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [SQLITE_BUSY].)^</dd> 18517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 185290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> 185390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd> ^This option is used to enable or disable the enforcement of 185490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [foreign key constraints]. There should be two additional arguments. 185590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The first argument is an integer which is 0 to disable FK enforcement, 185690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** positive to enable FK enforcement or negative to leave FK enforcement 185790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** unchanged. The second parameter is a pointer to an integer into which 185890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is written 0 or 1 to indicate whether FK enforcement is off or on 185990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** following this call. The second parameter may be a NULL pointer, in 186090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** which case the FK enforcement setting is not reported back. </dd> 186190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 186290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> 186390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. 186490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** There should be two additional arguments. 186590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The first argument is an integer which is 0 to disable triggers, 186690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** positive to enable triggers or negative to leave the setting unchanged. 186790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The second parameter is a pointer to an integer into which 186890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is written 0 or 1 to indicate whether triggers are disabled or enabled 186990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** following this call. The second parameter may be a NULL pointer, in 187090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** which case the trigger setting is not reported back. </dd> 187190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 1872a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 1873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 187490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 187590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ 187690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ 1877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1880a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Extended Result Codes 18813a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 18827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1883a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_extended_result_codes() routine enables or disables the 1884a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result codes] feature of SQLite. ^The extended result 1885a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** codes are disabled by default for historical compatibility. 18867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 18873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_extended_result_codes(sqlite3*, int onoff); 18887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 18897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1890a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Last Insert Rowid 18913a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 18927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18938fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables) 18948fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** has a unique 64-bit signed 1895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** integer key called the [ROWID | "rowid"]. ^The rowid is always available 18967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 1897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** names are not also used by explicitly declared columns. ^If 1898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the table has a column of type [INTEGER PRIMARY KEY] then that column 18997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is another alias for the rowid. 19007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19018fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the 19028fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** most recent successful [INSERT] into a rowid table or [virtual table] 19038fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** on database connection D. 19048fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^Inserts into [WITHOUT ROWID] tables are not recorded. 19058fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If no successful [INSERT]s into rowid tables 19068fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** have ever occurred on the database connection D, 19078fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** then sqlite3_last_insert_rowid(D) returns zero. 19087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 190990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(If an [INSERT] occurs within a trigger or within a [virtual table] 191090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** method, then this routine will return the [rowid] of the inserted 191190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** row as long as the trigger or virtual table method is running. 191290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** But once the trigger or virtual table method ends, the value returned 191390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by this routine reverts to what it was before the trigger or virtual 191490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** table method began.)^ 19157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1916a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An [INSERT] that fails due to a constraint violation is not a 1917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful [INSERT] and does not change the value returned by this 1918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 19197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and INSERT OR ABORT make no changes to the return value of this 1920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine when their insertion fails. ^(When INSERT OR REPLACE 19217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** encounters a constraint violation, it does not fail. The 19227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT continues to completion after deleting rows that caused 19237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the constraint problem so INSERT OR REPLACE will always change 1924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the return value of this interface.)^ 19257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1926a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the purposes of this routine, an [INSERT] is considered to 19277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be successful even if it is subsequently rolled back. 19287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This function is accessible to SQL statements via the 1930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [last_insert_rowid() SQL function]. 19317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1932a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread performs a new [INSERT] on the same 1933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection while the [sqlite3_last_insert_rowid()] 1934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is running and thus changes the last insert [rowid], 1935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the value returned by [sqlite3_last_insert_rowid()] is 1936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unpredictable and might not equal either the old or the new 1937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** last insert [rowid]. 19387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 19393fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_last_insert_rowid(sqlite3*); 19407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 19417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1942a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Count The Number Of Rows Modified 19433a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 19447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This function returns the number of rows modified, inserted or 19463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** deleted by the most recently completed INSERT, UPDATE or DELETE 19473fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** statement on the database connection specified by the only parameter. 19483fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Executing any other type of SQL statement does not modify the value 19493fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** returned by this function. 19503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 19513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are 19523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], 19533fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [foreign key actions] or [REPLACE] constraint resolution are not counted. 19543fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 19553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Changes to a view that are intercepted by 19563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value 19573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** returned by sqlite3_changes() immediately after an INSERT, UPDATE or 19583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** DELETE statement run on a view is always zero. Only changes made to real 19593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** tables are counted. 19603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 19613fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Things are more complicated if the sqlite3_changes() function is 19623fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** executed while a trigger program is running. This may happen if the 19633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** program uses the [changes() SQL function], or if some other callback 19643fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** function invokes sqlite3_changes() directly. Essentially: 19653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 19663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <ul> 19673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Before entering a trigger program the value returned by 19683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_changes() function is saved. After the trigger program 19693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** has finished, the original value is restored.)^ 19703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 19713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE 19723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** statement sets the value returned by sqlite3_changes() 19733fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** upon completion as normal. Of course, this value will not include 19743fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** any changes performed by sub-triggers, as the sqlite3_changes() 19753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** value will be saved and restored after each sub-trigger has run.)^ 19763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** </ul> 19773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 19783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This means that if the changes() SQL function (or similar) is used 19793fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** by the first INSERT, UPDATE or DELETE statement within a trigger, it 19803fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** returns the value as set when the calling statement began executing. 19813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If it is used by the second or subsequent such statement within a trigger 19823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** program, the value returned reflects the number of rows modified by the 19833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** previous INSERT, UPDATE or DELETE statement within the same trigger. 19847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1985a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_total_changes()] interface, the 1986a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [count_changes pragma], and the [changes() SQL function]. 19877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread makes changes on the same database connection 1989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** while [sqlite3_changes()] is running then the value returned 1990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is unpredictable and not meaningful. 1991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 19923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_changes(sqlite3*); 1993a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1995a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Total Number Of Rows Modified 19963a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 1997a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 19983fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This function returns the total number of rows inserted, modified or 19993fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed 20003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** since the database connection was opened, including those executed as 20013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** part of trigger programs. ^Executing any other type of SQL statement 20023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** does not affect the value returned by sqlite3_total_changes(). 20033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 20043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Changes made as part of [foreign key actions] are included in the 20053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** count, but those made as part of REPLACE constraint resolution are 20063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** not. ^Changes to a view that are intercepted by INSTEAD OF triggers 20073fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** are not counted. 20083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 2009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_changes()] interface, the 2010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [count_changes pragma], and the [total_changes() SQL function]. 2011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread makes changes on the same database connection 2013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** while [sqlite3_total_changes()] is running then the value 2014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned is unpredictable and not meaningful. 20157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 20163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_total_changes(sqlite3*); 20177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 20187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2019a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Interrupt A Long-Running Query 20203a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 20217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function causes any pending database operation to abort and 20237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return at its earliest opportunity. This routine is typically 20247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** called in response to a user action such as pressing "Cancel" 20257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or Ctrl-C where the user wants a long query operation to halt 20267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** immediately. 20277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is safe to call this routine from a thread different from the 20297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** thread that is currently running the database operation. But it 2030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not safe to call this routine with a [database connection] that 20317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is closed or might close before sqlite3_interrupt() returns. 20327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an SQL operation is very nearly finished at the time when 2034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_interrupt() is called, then it might not have an opportunity 2035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be interrupted and might continue to completion. 2036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 2038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 2039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is inside an explicit transaction, then the entire transaction 2040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be rolled back automatically. 2041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_interrupt(D) call is in effect until all currently running 2043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements on [database connection] D complete. ^Any new SQL statements 2044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the sqlite3_interrupt() call and before the 2045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** running statements reaches zero are interrupted as if they had been 2046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** running prior to the sqlite3_interrupt() call. ^New SQL statements 2047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the running statement count reaches zero are 2048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not effected by the sqlite3_interrupt(). 2049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to sqlite3_interrupt(D) that occurs when there are no running 2050a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements is a no-op and has no effect on SQL statements 2051a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the sqlite3_interrupt() call returns. 2052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the database connection closes while [sqlite3_interrupt()] 2054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is running then bad things will likely happen. 20557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 20563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_interrupt(sqlite3*); 20577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 20587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Determine If An SQL Statement Is Complete 20607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are useful during command-line input to determine if the 2062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** currently entered text seems to form a complete SQL statement or 20637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** if additional input is needed before sending the text into 2064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite for parsing. ^These routines return 1 if the input string 2065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** appears to be a complete SQL statement. ^A statement is judged to be 2066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** complete if it ends with a semicolon token and is not a prefix of a 2067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within 20687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** string literals or quoted identifier names or comments are not 20697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** independent tokens (they are part of the token in which they are 2070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** embedded) and thus do not count as a statement terminator. ^Whitespace 2071a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and comments that follow the final semicolon are ignored. 20727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return 0 if the statement is incomplete. ^If a 2074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation fails, then SQLITE_NOMEM is returned. 20757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines do not parse the SQL statements thus 2077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will not detect syntactically incorrect SQL. 20787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior 2080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked 2081a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** automatically by sqlite3_complete16(). If that initialization fails, 2082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the return value from sqlite3_complete16() will be non-zero 2083a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** regardless of whether or not the input SQL is complete.)^ 20847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2085a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The input to [sqlite3_complete()] must be a zero-terminated 2086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-8 string. 20877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The input to [sqlite3_complete16()] must be a zero-terminated 2089a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 string in native byte order. 20907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 20913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_complete(const char *sql); 20923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_complete16(const void *sql); 20937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 20947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2095a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors 20963fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** KEYWORDS: {busy-handler callback} {busy handler} 20973a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 2098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 20999bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X 21009bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** that might be invoked with argument P whenever 21019bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** an attempt is made to access a database table associated with 21029bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [database connection] D when another thread 21039bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** or process has the table locked. 21049bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** The sqlite3_busy_handler() interface is used to implement 21059bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout]. 21067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21079bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** ^If the busy callback is NULL, then [SQLITE_BUSY] 2108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned immediately upon encountering the lock. ^If the busy callback 2109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not NULL, then the callback might be invoked with two arguments. 2110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the busy handler is a copy of the void* pointer which 2112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is the third argument to sqlite3_busy_handler(). ^The second argument to 2113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the busy handler callback is the number of times that the busy handler has 21143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** been invoked previously for the same locking event. ^If the 21157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** busy callback returns 0, then no additional attempts are made to 21169bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** access the database and [SQLITE_BUSY] is returned 21179bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** to the application. 2118a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the callback returns non-zero, then another attempt 21199bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** is made to access the database and the cycle repeats. 21207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The presence of a busy handler does not guarantee that it will be invoked 2122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when there is lock contention. ^If SQLite determines that invoking the busy 2123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 21249bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** to the application instead of invoking the 21259bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** busy handler. 21267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Consider a scenario where one process is holding a read lock that 21277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** it is trying to promote to a reserved lock and 21287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a second process is holding a reserved lock that it is trying 21297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to promote to an exclusive lock. The first process cannot proceed 21307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** because it is blocked by the second and the second process cannot 21317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** proceed because it is blocked by the first. If both processes 21327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** invoke the busy handlers, neither will make any progress. Therefore, 21337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 21347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will induce the first process to release its read lock and allow 21357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the second process to proceed. 21367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default busy callback is NULL. 21387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There can only be a single busy handler defined for each 2140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection]. Setting a new busy handler clears any 2141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] 21429bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** or evaluating [PRAGMA busy_timeout=N] will change the 21439bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** busy handler and thus clear any previously set busy handler. 21447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The busy callback should not take any actions which modify the 21469bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** database connection that invoked the busy handler. In other words, 21479bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** the busy handler is not reentrant. Any such actions 2148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result in undefined behavior. 2149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A busy handler must not close the database connection 2151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [prepared statement] that invoked the busy handler. 21527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 21533fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); 21547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Set A Busy Timeout 21573a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 21587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2159a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 2160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for a specified amount of time when a table is locked. ^The handler 2161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will sleep multiple times until at least "ms" milliseconds of sleeping 2162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have accumulated. ^After at least "ms" milliseconds of sleeping, 2163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the handler returns 0 which causes [sqlite3_step()] to return 21649bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [SQLITE_BUSY]. 21657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling this routine with an argument less than or equal to zero 21677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** turns off all busy handlers. 21687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There can only be a single busy handler for a particular 21703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [database connection] at any given moment. If another busy handler 2171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was defined (using [sqlite3_busy_handler()]) prior to calling 2172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this routine, that other busy handler is cleared.)^ 21739bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** 21749bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** See also: [PRAGMA busy_timeout] 21757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 21763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_busy_timeout(sqlite3*, int ms); 21777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Convenience Routines For Running Queries 21803a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 21817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 218295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** This is a legacy interface that is preserved for backwards compatibility. 218395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** Use of this interface is not recommended. 218495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 21857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Definition: A <b>result table</b> is memory data structure created by the 21867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_get_table()] interface. A result table records the 21877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** complete query results from one or more queries. 21887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The table conceptually has a number of rows and columns. But 21907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** these numbers are not part of the result table itself. These 21917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** numbers are obtained separately. Let N be the number of rows 21927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and M be the number of columns. 21937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A result table is an array of pointers to zero-terminated UTF-8 strings. 2195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There are (N+1)*M elements in the array. The first M pointers point 2196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to zero-terminated strings that contain the names of the columns. 2197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The remaining entries all point to query results. NULL values result 2198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in NULL pointers. All other values are in their UTF-8 zero-terminated 2199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string representation as returned by [sqlite3_column_text()]. 22007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A result table might consist of one or more memory allocations. 22027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** It is not safe to pass a result table directly to [sqlite3_free()]. 22037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A result table should be deallocated using [sqlite3_free_table()]. 22047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 220595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^(As an example of the result table format, suppose a query result 22067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is as follows: 22077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 22097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Name | Age 22107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** ----------------------- 22117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Alice | 43 22127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Bob | 28 22137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Cindy | 21 22147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 22157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** There are two column (M==2) and three rows (N==3). Thus the 22177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** result table has 8 entries. Suppose the result table is stored 22187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in an array names azResult. Then azResult holds this content: 22197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 22217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[0] = "Name"; 22227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[1] = "Age"; 22237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[2] = "Alice"; 22247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[3] = "43"; 22257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[4] = "Bob"; 22267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[5] = "28"; 22277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[6] = "Cindy"; 22287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[7] = "21"; 222995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** </pre></blockquote>)^ 22307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_table() function evaluates one or more 22327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** semicolon-separated SQL statements in the zero-terminated UTF-8 2233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string of its 2nd parameter and returns a result table to the 22347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer given in its 3rd parameter. 22357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** After the application has finished with the result from sqlite3_get_table(), 223795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** it must pass the result table pointer to sqlite3_free_table() in order to 2238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** release the memory that was malloced. Because of the way the 22397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 2240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function must not try to call [sqlite3_free()] directly. Only 22417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_free_table()] is able to release the memory properly and safely. 22427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 224395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The sqlite3_get_table() interface is implemented as a wrapper around 22447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 22457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to any internal data structures of SQLite. It uses only the public 22467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface defined here. As a consequence, errors that occur in the 22477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** wrapper layer outside of the internal [sqlite3_exec()] call are not 22487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** reflected in subsequent calls to [sqlite3_errcode()] or 224995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** [sqlite3_errmsg()]. 2250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 22513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_get_table( 2252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *db, /* An open database */ 2253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zSql, /* SQL to be evaluated */ 2254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori char ***pazResult, /* Results of the query */ 2255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int *pnRow, /* Number of result rows written here */ 2256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int *pnColumn, /* Number of result columns written here */ 2257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori char **pzErrmsg /* Error msg written here */ 22587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 22593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_free_table(char **result); 22607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 22617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Formatted String Printing Functions 22637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are work-alikes of the "printf()" family of functions 22657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from the standard C library. 22663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** These routines understand most of the common K&R formatting options, 22673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** plus some additional non-standard formats, detailed below. 22683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Note that some of the more obscure formatting options from recent 22693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** C-library standards are omitted from this implementation. 22707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 22727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** results into memory obtained from [sqlite3_malloc()]. 22737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The strings returned by these two routines should be 2274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** released by [sqlite3_free()]. ^Both routines return a 22757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** NULL pointer if [sqlite3_malloc()] is unable to allocate enough 22767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** memory to hold the resulting string. 22777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 227890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from 22797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the standard C library. The result is written into the 22807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** buffer supplied as the second parameter whose size is given by 22817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the first parameter. Note that the order of the 2282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first two parameters is reversed from snprintf().)^ This is an 22837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** historical accident that cannot be fixed without breaking 2284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backwards compatibility. ^(Note also that sqlite3_snprintf() 22857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** returns a pointer to its buffer instead of the number of 2286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** characters actually written into the buffer.)^ We admit that 22877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number of characters written would be a more useful return 22887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value but we cannot change the implementation of sqlite3_snprintf() 22897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** now without breaking compatibility. 22907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^As long as the buffer size is greater than zero, sqlite3_snprintf() 2292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** guarantees that the buffer is always zero-terminated. ^The first 22937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** parameter "n" is the total size of the buffer, including space for 22947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the zero terminator. So the longest string that can be completely 22957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** written will be n-1 characters. 22967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 229790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). 229890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 22997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines all implement some additional formatting 23007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** options that are useful for constructing SQL statements. 2301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All of the usual printf() formatting options apply. In addition, there 23023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is are "%q", "%Q", "%w" and "%z" options. 23037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 230490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The %q option works like %s in that it substitutes a nul-terminated 23057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** string from the argument list. But %q also doubles every '\'' character. 2306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** %q is designed for use inside a string literal.)^ By doubling each '\'' 23077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** character it escapes that character and allows it to be inserted into 23087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the string. 23097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** For example, assume the string variable zText contains text as follows: 23117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 23137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zText = "It's a happy day!"; 23147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 23157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** One can use this text in an SQL statement as follows: 23177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 23197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); 23207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_exec(db, zSQL, 0, 0, 0); 23217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(zSQL); 23227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 23237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Because the %q format string is used, the '\'' character in zText 23257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is escaped and the SQL generated is as follows: 23267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 23287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT INTO table1 VALUES('It''s a happy day!') 23297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 23307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This is correct. Had we used %s instead of %q, the generated SQL 23327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** would have looked like this: 23337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 23357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT INTO table1 VALUES('It's a happy day!'); 23367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 23377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This second example is an SQL syntax error. As a general rule you should 2339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always use %q instead of %s when inserting text into a string literal. 23407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The %Q option works like %q except it also adds single quotes around 2342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the outside of the total string. Additionally, if the parameter in the 2343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument list is a NULL pointer, %Q substitutes the text "NULL" (without 2344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single quotes).)^ So, for example, one could say: 23457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 23477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); 23487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_exec(db, zSQL, 0, 0, 0); 23497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(zSQL); 23507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 23517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code above will render a correct SQL statement in the zSQL 23537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** variable even if the zText variable is a NULL pointer. 23547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(The "%w" formatting option is like "%q" except that it expects to 23563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** be contained within double-quotes instead of single quotes, and it 23573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** escapes the double-quote character instead of the single-quote 23583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** character.)^ The "%w" formatting option is intended for safely inserting 23593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** table and column names into a constructed SQL statement. 23603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 2361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The "%z" formatting option works like "%s" but with the 23627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** addition that after the string has been read and copied into 2363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the result, [sqlite3_free()] is called on the input string.)^ 23647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 23653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API char *SQLITE_CDECL sqlite3_mprintf(const char*,...); 23663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API char *SQLITE_STDCALL sqlite3_vmprintf(const char*, va_list); 23673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API char *SQLITE_CDECL sqlite3_snprintf(int,char*,const char*, ...); 23683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API char *SQLITE_STDCALL sqlite3_vsnprintf(int,char*,const char*, va_list); 23697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 23707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocation Subsystem 23727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLite core uses these three routines for all of its own 23747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** internal memory allocation needs. "Core" in the previous sentence 23757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** does not include operating-system specific VFS implementation. The 2376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Windows VFS uses native malloc() and free() for some operations. 23777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_malloc() routine returns a pointer to a block 23797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of memory at least N bytes in length, where N is the parameter. 2380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_malloc() is unable to obtain sufficient free 2381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory, it returns a NULL pointer. ^If the parameter N to 23827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 23837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a NULL pointer. 23847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_malloc64(N) routine works just like 23863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead 23873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of a signed 32-bit integer. 23883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 2389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling sqlite3_free() with a pointer previously returned 23907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 2391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that it might be reused. ^The sqlite3_free() routine is 23927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a no-op if is called with a NULL pointer. Passing a NULL pointer 23937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to sqlite3_free() is harmless. After being freed, memory 23947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** should neither be read nor written. Even reading previously freed 23957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** memory might result in a segmentation fault or other severe error. 23967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Memory corruption, a segmentation fault, or other severe error 23977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might result if sqlite3_free() is called with a non-NULL pointer that 2398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 23997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_realloc(X,N) interface attempts to resize a 24013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** prior memory allocation X to be at least N bytes. 24023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the X parameter to sqlite3_realloc(X,N) 24037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is a NULL pointer then its behavior is identical to calling 24043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_malloc(N). 24053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the N parameter to sqlite3_realloc(X,N) is zero or 24067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** negative then the behavior is exactly the same as calling 24073fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_free(X). 24083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation 24093fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of at least N bytes in size or NULL if insufficient memory is available. 2410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If M is the size of the prior allocation, then min(N,M) bytes 24117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the prior allocation are copied into the beginning of buffer returned 24123fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** by sqlite3_realloc(X,N) and the prior allocation is freed. 24133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the 24143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** prior allocation is not freed. 24153fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 24163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_realloc64(X,N) interfaces works the same as 24173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead 24183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of a 32-bit signed integer. 24193fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 24203fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If X is a memory allocation previously obtained from sqlite3_malloc(), 24213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then 24223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_msize(X) returns the size of that memory allocation in bytes. 24233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The value returned by sqlite3_msize(X) might be larger than the number 24243fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of bytes requested when X was allocated. ^If X is a NULL pointer then 24253fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_msize(X) returns zero. If X points to something that is not 24263fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the beginning of memory allocation, or if it points to a formerly 24273fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** valid memory allocation that has now been freed, then the behavior 24283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of sqlite3_msize(X) is undefined and possibly harmful. 24293fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 24303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(), 24313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_malloc64(), and sqlite3_realloc64() 2432de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is always aligned to at least an 8 byte boundary, or to a 2433de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time 2434de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** option is used. 24357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In SQLite version 3.5.0 and 3.5.1, it was possible to define 24377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in 24387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementation of these routines to be omitted. That capability 2439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is no longer provided. Only built-in memory allocators can be used. 24407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24418fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** Prior to SQLite version 3.7.10, the Windows OS interface layer called 24427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the system malloc() and free() directly when converting 24437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** filenames between the UTF-8 encoding used by SQLite 2444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and whatever filename encoding is used by the particular Windows 24458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** installation. Memory allocation errors were detected, but 24468fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** they were reported back as [SQLITE_CANTOPEN] or 24477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. 24487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 2450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be either NULL or else pointers obtained from a prior 2451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 2452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not yet been released. 24537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application must not read or write any part of 2455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a block of memory after it has been released using 2456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_free()] or [sqlite3_realloc()]. 24577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 24583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_malloc(int); 24593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_malloc64(sqlite3_uint64); 24603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_realloc(void*, int); 24613fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_realloc64(void*, sqlite3_uint64); 24623fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_free(void*); 24633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_uint64 SQLITE_STDCALL sqlite3_msize(void*); 24647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 24657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocator Statistics 24677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite provides these two interfaces for reporting on the status 24697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 2470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines, which form the built-in memory allocation subsystem. 2471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_memory_used()] routine returns the number of bytes 2473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of memory currently outstanding (malloced but not freed). 2474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_memory_highwater()] routine returns the maximum 2475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of [sqlite3_memory_used()] since the high-water mark 2476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was last reset. ^The values returned by [sqlite3_memory_used()] and 2477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_highwater()] include any overhead 2478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** added by SQLite in its implementation of [sqlite3_malloc()], 2479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but not overhead added by the any underlying system library 2480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines that [sqlite3_malloc()] may call. 2481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory high-water mark is reset to the current value of 2483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_used()] if and only if the parameter to 2484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_highwater()] is true. ^The value returned 2485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by [sqlite3_memory_highwater(1)] is the high-water mark 2486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to the reset. 24877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 24883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_memory_used(void); 24893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_memory_highwater(int resetFlag); 24907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 24917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Pseudo-Random Number Generator 24937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 2495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** select random [ROWID | ROWIDs] when inserting new records into a table that 2496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already uses the largest possible [ROWID]. The PRNG is also used for 24977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the build-in random() and randomblob() SQL functions. This interface allows 2498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** applications to access the same PRNG for other purposes. 24997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to this routine stores N bytes of randomness into buffer P. 25013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The P parameter can be a NULL pointer. 25027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25038fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If this routine has not been previously called or if the previous 25043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** call had N less than one or a NULL pointer for P, then the PRNG is 25053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** seeded using randomness obtained from the xRandomness method of 25063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the default [sqlite3_vfs] object. 25073fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the previous call to this routine had an N of 1 or more and a 25083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** non-NULL P then the pseudo-randomness is generated 25097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** internally and without recourse to the [sqlite3_vfs] xRandomness 25107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method. 25117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 25123fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_randomness(int N, void *P); 25137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 25147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compile-Time Authorization Callbacks 25163a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 25177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 251890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^This routine registers an authorizer callback with a particular 25197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [database connection], supplied in the first argument. 2520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The authorizer callback is invoked as SQL statements are being compiled 25217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 2522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various 25237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** points during the compilation process, as logic is being created 25247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to perform various actions, the authorizer callback is invoked to 2525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** see if those actions are allowed. ^The authorizer callback should 25267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 25277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** specific action but allow the SQL statement to continue to be 25287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 2529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rejected with an error. ^If the authorizer callback returns 25307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 2531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the [sqlite3_prepare_v2()] or equivalent call that triggered 25327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the authorizer will fail with an error message. 25337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the callback returns [SQLITE_OK], that means the operation 2535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** requested is ok. ^When the callback returns [SQLITE_DENY], the 25367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare_v2()] or equivalent call that triggered the 25377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** authorizer will fail with an error message explaining that 2538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** access is denied. 2539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first parameter to the authorizer callback is a copy of the third 2541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter to the sqlite3_set_authorizer() interface. ^The second parameter 2542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the callback is an integer [SQLITE_COPY | action code] that specifies 2543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the particular action to be authorized. ^The third through sixth parameters 2544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the callback are zero-terminated strings that contain additional 2545a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** details about the action to be authorized. 2546a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the action code is [SQLITE_READ] 25487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and the callback returns [SQLITE_IGNORE] then the 25497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [prepared statement] statement is constructed to substitute 25507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a NULL value in place of the table column that would have 25517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 25527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return can be used to deny an untrusted user access to individual 25537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** columns of a table. 2554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the action code is [SQLITE_DELETE] and the callback returns 2555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the 2556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [truncate optimization] is disabled and all rows are deleted individually. 25577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An authorizer is used when [sqlite3_prepare | preparing] 2559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements from an untrusted source, to ensure that the SQL statements 2560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** do not try to access data they are not allowed to see, or that they do not 2561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** try to execute malicious statements that damage the database. For 25627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** example, an application may allow a user to enter arbitrary 25637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQL queries for evaluation by a database. But the application does 25647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not want the user to be able to make arbitrary changes to the 25657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database. An authorizer could then be put in place while the 25667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** user-entered SQL is being [sqlite3_prepare | prepared] that 25677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** disallows everything except [SELECT] statements. 25687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Applications that need to process SQL from untrusted sources 25707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might also consider lowering resource limits using [sqlite3_limit()] 25717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and limiting database size using the [max_page_count] [PRAGMA] 25727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in addition to using an authorizer. 25737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Only a single authorizer can be in place on a database connection 25757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** at a time. Each call to sqlite3_set_authorizer overrides the 2576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previous call.)^ ^Disable the authorizer by installing a NULL callback. 25777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The authorizer is disabled by default. 25787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The authorizer callback must not do anything that will modify 2580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the authorizer callback. 2581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 25837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the 2585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement might be re-prepared during [sqlite3_step()] due to a 2586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** schema change. Hence, the application should ensure that the 2587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** correct authorizer callback remains in place during the [sqlite3_step()]. 25887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that the authorizer callback is invoked only during 2590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare()] or its variants. Authorization is not 2591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performed during statement evaluation in [sqlite3_step()], unless 2592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as stated in the previous paragraph, sqlite3_step() invokes 2593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_prepare_v2() to reprepare a statement after a schema change. 25947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 25953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_set_authorizer( 25967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 25977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 25987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pUserData 25997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 26007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 26017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Authorizer Return Codes 26037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 26047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [sqlite3_set_authorizer | authorizer callback function] must 26057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return either [SQLITE_OK] or one of these two constants in order 26067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to signal SQLite whether or not the action is permitted. See the 26077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_set_authorizer | authorizer documentation] for additional 26087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information. 260990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 26109bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** Note that SQLITE_IGNORE is also used as a [conflict resolution mode] 26119bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** returned from the [sqlite3_vtab_on_conflict()] interface. 26127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 26137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 26147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 26157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 26167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2617a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Authorizer Action Codes 26187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 26197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [sqlite3_set_authorizer()] interface registers a callback function 2620a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is invoked to authorize certain SQL statement actions. The 26217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter to the callback is an integer code that specifies 26227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** what action is being authorized. These are the integer action codes that 26237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the authorizer callback may be passed. 26247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These action code values signify what kind of operation is to be 26267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** authorized. The 3rd and 4th parameters to the authorization 26277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** callback function will be parameters or NULL depending on which of these 2628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** codes is used as the second parameter. ^(The 5th parameter to the 2629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** authorizer callback is the name of the database ("main", "temp", 2630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback 26317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is the name of the inner-most trigger or view that is responsible for 2632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the access attempt or NULL if this access attempt is directly from 26337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** top-level SQL code. 26347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 26357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/******************************************* 3rd ************ 4th ***********/ 26367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 26377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 26387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 26397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 26407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 26417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 26427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 26437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 26447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DELETE 9 /* Table Name NULL */ 26457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ 26467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ 26477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ 26487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ 26497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ 26507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ 26517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ 26527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_VIEW 17 /* View Name NULL */ 26537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INSERT 18 /* Table Name NULL */ 26547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ 26557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_READ 20 /* Table Name Column Name */ 26567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SELECT 21 /* NULL NULL */ 2657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TRANSACTION 22 /* Operation NULL */ 26587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UPDATE 23 /* Table Name Column Name */ 26597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ATTACH 24 /* Filename NULL */ 26607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DETACH 25 /* Database Name NULL */ 26617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 26627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_REINDEX 27 /* Index Name NULL */ 26637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ANALYZE 28 /* Table Name NULL */ 26647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 26657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 2666a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_FUNCTION 31 /* NULL Function Name */ 2667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 26687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_COPY 0 /* No longer used */ 26698fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_RECURSIVE 33 /* NULL NULL */ 26707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 26717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Tracing And Profiling Functions 26733a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 26747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 26757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines register callback functions that can be used for 26767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** tracing and profiling the execution of SQL statements. 26777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The callback function registered by sqlite3_trace() is invoked at 26797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** various times when an SQL statement is being run by [sqlite3_step()]. 2680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the 2681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statement text as the statement first begins executing. 2682a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Additional sqlite3_trace() callbacks might occur 2683a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as each triggered subprogram is entered. The callbacks for triggers 2684a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** contain a UTF-8 SQL comment that identifies the trigger.)^ 2685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 26868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit 26878fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the length of [bound parameter] expansion in the output of sqlite3_trace(). 26888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 2689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The callback function registered by sqlite3_profile() is invoked 2690a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as each SQL statement finishes. ^The profile callback contains 26917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the original statement text and an estimate of wall-clock time 2692de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of how long that statement took to run. ^The profile callback 2693de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** time is in units of nanoseconds, however the current implementation 2694de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is only capable of millisecond resolution so the six least significant 2695de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** digits in the time are meaningless. Future versions of SQLite 2696de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** might provide greater resolution on the profiler callback. The 2697de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** sqlite3_profile() function is considered experimental and is 2698de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** subject to change in future versions of SQLite. 26997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 27003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); 27013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_EXPERIMENTAL void *SQLITE_STDCALL sqlite3_profile(sqlite3*, 27027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 27037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Query Progress Callbacks 27063a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 27077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2708de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback 2709de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** function X to be invoked periodically during long running calls to 2710de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for 2711de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** database connection D. An example use for this 27127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface is to keep a GUI updated during a large query. 27137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2714de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The parameter P is passed through as the only parameter to the 27158fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** callback function X. ^The parameter N is the approximate number of 2716de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [virtual machine instructions] that are evaluated between successive 27178fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** invocations of the callback X. ^If N is less than one then the progress 27188fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** handler is disabled. 2719de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 2720de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Only a single progress handler may be defined at one time per 2721de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [database connection]; setting a new progress handler cancels the 2722de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** old one. ^Setting parameter X to NULL disables the progress handler. 2723de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The progress handler is also disabled by setting N to a value less 2724de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** than 1. 2725de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 2726a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the progress callback returns non-zero, the operation is 27277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interrupted. This feature can be used to implement a 2728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "Cancel" button on a GUI progress dialog box. 27297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2730de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The progress handler callback must not do anything that will modify 2731a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the progress handler. 2732a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 27347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 27363fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 27377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2739a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Opening A New Database Connection 27403a6c79f802fabdb94367177310663397420e319fNick Kralevich** CONSTRUCTOR: sqlite3 2741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 274290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^These routines open an SQLite database file as specified by the 2743a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** filename argument. ^The filename argument is interpreted as UTF-8 for 2744a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 2745a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** order for sqlite3_open16(). ^(A [database connection] handle is usually 2746a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned in *ppDb, even if an error occurs. The only exception is that 2747a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if SQLite is unable to allocate memory to hold the [sqlite3] object, 2748a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 2749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object.)^ ^(If the database is opened (and/or created) successfully, then 2750a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The 2751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 2752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an English language description of the error following a failure of any 2753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the sqlite3_open() routines. 2754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 27553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The default encoding will be UTF-8 for databases created using 27563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases 27573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** created using sqlite3_open16() will be UTF-16 in the native byte order. 27587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Whether or not an error occurs when it is opened, resources 2760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the [database connection] handle should be released by 2761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** passing it to [sqlite3_close()] when it is no longer required. 27627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_open_v2() interface works like sqlite3_open() 2764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** except that it accepts two additional parameters for additional control 2765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** over the new database connection. ^(The flags parameter to 2766a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open_v2() can take one of 2767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the following three values, optionally combined with the 2768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], 276990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ 27707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2771a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 2772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READONLY]</dt> 2773a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The database is opened in read-only mode. If the database does not 2774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already exist, an error is returned.</dd>)^ 2775a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> 2777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The database is opened for reading and writing if possible, or reading 2778a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** only if the file is write protected by the operating system. In either 2779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case the database must already exist, otherwise an error is returned.</dd>)^ 2780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 278290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>The database is opened for reading and writing, and is created if 2783a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it does not already exist. This is the behavior that is always used for 2784a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() and sqlite3_open16().</dd>)^ 2785a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 2786a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2787a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the 3rd parameter to sqlite3_open_v2() is not one of the 278890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** combinations shown above optionally combined with other 278990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] 2790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the behavior is undefined. 27917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 2793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** opens in the multi-thread [threading mode] as long as the single-thread 2794a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mode has not been set at compile-time or start-time. ^If the 2795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 2796a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the serialized [threading mode] unless single-thread was 2797a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously selected at compile-time or start-time. 2798a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be 2799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** eligible to use [shared cache mode], regardless of whether or not shared 2800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cache is enabled using [sqlite3_enable_shared_cache()]. ^The 2801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not 2802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** participate in [shared cache mode] even if it is enabled. 2803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 280490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The fourth parameter to sqlite3_open_v2() is the name of the 280590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vfs] object that defines the operating system interface that 280690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the new database connection should use. ^If the fourth parameter is 280790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a NULL pointer then the default [sqlite3_vfs] object is used. 280890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 2809a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the filename is ":memory:", then a private, temporary in-memory database 2810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is created for the connection. ^This in-memory database will vanish when 2811a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection is closed. Future versions of SQLite might 2812a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** make use of additional special filenames that begin with the ":" character. 2813a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is recommended that when a database filename actually does begin with 2814a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a ":" character you should prefix the filename with a pathname such as 2815a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "./" to avoid ambiguity. 2816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2817a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the filename is an empty string, then a private, temporary 2818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on-disk database will be created. ^This private database will be 28197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** automatically deleted as soon as the database connection is closed. 28207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 282190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3> 282290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 282390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If [URI filename] interpretation is enabled, and the filename argument 282490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** begins with "file:", then the filename is interpreted as a URI. ^URI 282590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is 282690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** set in the fourth argument to sqlite3_open_v2(), or if it has 282790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been enabled globally using the [SQLITE_CONFIG_URI] option with the 282890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. 282990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** As of SQLite version 3.7.7, URI filename interpretation is turned off 283090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by default, but future releases of SQLite might enable URI filename 283190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** interpretation by default. See "[URI filenames]" for additional 283290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** information. 283390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 283490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** URI filenames are parsed according to RFC 3986. ^If the URI contains an 283590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** authority, then it must be either an empty string or the string 283690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "localhost". ^If the authority is not an empty string or "localhost", an 283790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error is returned to the caller. ^The fragment component of a URI, if 283890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** present, is ignored. 283990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 284090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite uses the path component of the URI as the name of the disk file 284190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** which contains the database. ^If the path begins with a '/' character, 284290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** then it is interpreted as an absolute path. ^If the path does not begin 284390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** with a '/' (meaning that the authority section is omitted from the URI) 284490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** then the path is interpreted as a relative path. 28453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(On windows, the first component of an absolute path 28463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is a drive specification (e.g. "C:").)^ 284790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 284890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[core URI query parameters]] 284990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The query component of a URI may contain parameters that are interpreted 285090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** either by SQLite itself, or by a [VFS | custom VFS implementation]. 28513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** SQLite and its built-in [VFSes] interpret the 28523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** following query parameters: 285390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 285490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <ul> 285590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of 285690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a VFS object that provides the operating system interface that should 285790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** be used to access the database file on disk. ^If this option is set to 285890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an empty string the default VFS object is used. ^Specifying an unknown 285990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is 286090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** present, then the VFS specified by the option takes precedence over 286190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the value passed as the fourth parameter to sqlite3_open_v2(). 286290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 28638fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw", 28648fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** "rwc", or "memory". Attempting to set it to any other value is 28658fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** an error)^. 286690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If "ro" is specified, then the database is opened for read-only 286790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the 28688fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** third argument to sqlite3_open_v2(). ^If the mode option is set to 286990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "rw", then the database is opened for read-write (but not create) 287090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had 287190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been set. ^Value "rwc" is equivalent to setting both 28728fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is 28738fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** set to "memory" then a pure [in-memory database] that never reads 28748fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** or writes from disk is used. ^It is an error to specify a value for 28758fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the mode parameter that is less restrictive than that specified by 28768fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the flags passed in the third parameter to sqlite3_open_v2(). 287790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 287890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or 287990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "private". ^Setting it to "shared" is equivalent to setting the 288090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to 288190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_open_v2(). ^Setting the cache parameter to "private" is 288290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. 288390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If sqlite3_open_v2() is used and the "cache" parameter is present in 28848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** a URI filename, its value overrides any behavior requested by setting 288590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. 28861c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** 28873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> <b>psow</b>: ^The psow parameter indicates whether or not the 28881c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** [powersafe overwrite] property does or does not apply to the 28893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** storage media on which the database file resides. 28901c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** 28911c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter 28921c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** which if set disables file locking in rollback journal modes. This 28931c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** is useful for accessing a database on a filesystem that does not 28941c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** support locking. Caution: Database corruption might result if two 28951c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** or more processes write to the same database and any one of those 28961c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** processes uses nolock=1. 28971c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** 28981c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** <li> <b>immutable</b>: ^The immutable parameter is a boolean query 28991c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** parameter that indicates that the database file is stored on 29001c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** read-only media. ^When immutable is set, SQLite assumes that the 29011c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** database file cannot be changed, even by a process with higher 29021c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** privilege, and so the database is opened read-only and all locking 29031c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** and change detection is disabled. Caution: Setting the immutable 29041c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** property on a database file that does in fact change can result 29051c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** in incorrect query results and/or [SQLITE_CORRUPT] errors. 29061c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** See also: [SQLITE_IOCAP_IMMUTABLE]. 29071c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** 290890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </ul> 290990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 291090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^Specifying an unknown parameter in the query component of a URI is not an 291190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error. Future versions of SQLite might understand additional query 291290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameters. See "[query parameters with special meaning to SQLite]" for 291390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** additional information. 291490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 291590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[URI filename examples]] <h3>URI filename examples</h3> 291690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 291790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <table border="1" align=center cellpadding=5> 291890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><th> URI filenames <th> Results 291990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:data.db <td> 292090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Open the file "data.db" in the current directory. 292190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:/home/fred/data.db<br> 292290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file:///home/fred/data.db <br> 292390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file://localhost/home/fred/data.db <br> <td> 292490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Open the database file "/home/fred/data.db". 292590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file://darkstar/home/fred/data.db <td> 292690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** An error. "darkstar" is not a recognized authority. 292790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td style="white-space:nowrap"> 292890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db 292990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <td> Windows only: Open the file "data.db" on fred's desktop on drive 293090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** C:. Note that the %20 escaping in this example is not strictly 293190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** necessary - space characters can be used literally 293290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in URI filenames. 293390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:data.db?mode=ro&cache=private <td> 293490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Open file "data.db" in the current directory for read-only access. 293590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Regardless of whether or not shared-cache mode is enabled by 293690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** default, use a private cache. 29371c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td> 29381c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile" 29391c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** that uses dot-files in place of posix advisory locking. 294090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:data.db?mode=readonly <td> 294190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** An error. "readonly" is not a valid option for the "mode" parameter. 294290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </table> 294390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 294490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^URI hexadecimal escape sequences (%HH) are supported within the path and 294590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** query components of a URI. A hexadecimal escape sequence consists of a 294690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** percent sign - "%" - followed by exactly two hexadecimal digits 294790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** specifying an octet value. ^Before the path or query components of a 294890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** URI filename are interpreted, they are encoded using UTF-8 and all 294990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** hexadecimal escape sequences replaced by a single byte containing the 295090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** corresponding octet. If this process generates an invalid UTF-8 encoding, 295190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the results are undefined. 29527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Note to Windows users:</b> The encoding used for the filename argument 2954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 29557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** codepage is currently defined. Filenames containing international 29567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** characters must be converted to UTF-8 prior to passing them into 2957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() or sqlite3_open_v2(). 29588fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 29598fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <b>Note to Windows Runtime users:</b> The temporary directory must be set 29608fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various 29618fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** features that require the use of temporary files may fail. 29628fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 29638fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** See also: [sqlite3_temp_directory] 29647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 29653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_open( 29667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *filename, /* Database filename (UTF-8) */ 29677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb /* OUT: SQLite db handle */ 29687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 29693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_open16( 29707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *filename, /* Database filename (UTF-16) */ 29717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb /* OUT: SQLite db handle */ 29727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 29733fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_open_v2( 29747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *filename, /* Database filename (UTF-8) */ 29757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb, /* OUT: SQLite db handle */ 29767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, /* Flags */ 29777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zVfs /* Name of VFS module to use */ 29787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 29797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 29807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 298190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Obtain Values For URI Parameters 298290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 298390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** These are utility routines, useful to VFS implementations, that check 298490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to see if a database file was a URI that contained a specific query 298590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter, and if so obtains the value of that query parameter. 298690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 298790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If F is the database filename pointer passed into the xOpen() method of 298890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a VFS implementation when the flags parameter to xOpen() has one or 298990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and 299090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** P is the name of the query parameter, then 299190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_uri_parameter(F,P) returns the value of the P 299290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter if it exists or a NULL pointer if P does not appear as a 299390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** query parameter on F. If P is a query parameter of F 299490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** has no explicit value, then sqlite3_uri_parameter(F,P) returns 299590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a pointer to an empty string. 299690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 299790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean 299890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter and returns true (1) or false (0) according to the value 2999c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the 3000c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** value of query parameter P is one of "yes", "true", or "on" in any 3001c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** case or if the value begins with a non-zero number. The 3002c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of 3003c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** query parameter P is one of "no", "false", or "off" in any case or 3004c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** if the value begins with a numeric zero. If P is not a query 3005c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** parameter on F or if the value of P is does not match any of the 3006c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). 300790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 300890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a 300990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 64-bit signed integer and returns that integer, or D if P does not 301090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** exist. If the value of P is something other than an integer, then 301190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** zero is returned. 301290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 301390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and 301490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and 301590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is not a database file pathname pointer that SQLite passed into the xOpen 301690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** VFS method, then the behavior of this routine is undefined and probably 301790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** undesirable. 301890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 30193fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_uri_parameter(const char *zFilename, const char *zParam); 30203fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); 30213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_uri_int64(const char*, const char*, sqlite3_int64); 302290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 302390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 302490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 3025a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Error Codes And Messages 30263a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 3027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 30283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the most recent sqlite3_* API call associated with 30293fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [database connection] D failed, then the sqlite3_errcode(D) interface 30303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** returns the numeric [result code] or [extended result code] for that 30313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** API call. 30323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** If the most recent API call was successful, 30333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** then the return value from sqlite3_errcode() is undefined. 30343fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_extended_errcode() 3035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is the same except that it always returns the 3036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result code] even when extended result codes are 3037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** disabled. 3038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 3040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** text that describes the error, as either UTF-8 or UTF-16 respectively. 3041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Memory to hold the error message string is managed internally. 3042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application does not need to worry about freeing the result. 30437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** However, the error string might be overwritten or deallocated by 3044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subsequent calls to other SQLite interface functions.)^ 3045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 30468fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The sqlite3_errstr() interface returns the English-language text 30478fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** that describes the [result code], as UTF-8. 30488fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^(Memory to hold the error message string is managed internally 30498fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** and must not be freed by the application)^. 30508fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 3051a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When the serialized [threading mode] is in use, it might be the 3052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case that a second error occurs on a separate thread in between 3053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the time of the first error and the call to these interfaces. 3054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When that happens, the second error will be reported since these 3055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces always report the most recent result. To avoid 3056a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this, each thread can obtain exclusive use of the [database connection] D 3057a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 3058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 3059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all calls to the interfaces listed here are completed. 3060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If an interface fails with SQLITE_MISUSE, that means the interface 3062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was invoked incorrectly by the application. In that case, the 3063a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code and message may or may not be set. 30647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 30653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_errcode(sqlite3 *db); 30663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_extended_errcode(sqlite3 *db); 30673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_errmsg(sqlite3*); 30683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_errmsg16(sqlite3*); 30693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_errstr(int); 30707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 30717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 30723a6c79f802fabdb94367177310663397420e319fNick Kralevich** CAPI3REF: Prepared Statement Object 30737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {prepared statement} {prepared statements} 30747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30753a6c79f802fabdb94367177310663397420e319fNick Kralevich** An instance of this object represents a single SQL statement that 30763a6c79f802fabdb94367177310663397420e319fNick Kralevich** has been compiled into binary form and is ready to be evaluated. 3077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 30783a6c79f802fabdb94367177310663397420e319fNick Kralevich** Think of each SQL statement as a separate computer program. The 30793a6c79f802fabdb94367177310663397420e319fNick Kralevich** original SQL text is source code. A prepared statement object 30803a6c79f802fabdb94367177310663397420e319fNick Kralevich** is the compiled object code. All SQL must be converted into a 30813a6c79f802fabdb94367177310663397420e319fNick Kralevich** prepared statement before it can be run. 30823a6c79f802fabdb94367177310663397420e319fNick Kralevich** 30833a6c79f802fabdb94367177310663397420e319fNick Kralevich** The life-cycle of a prepared statement object usually goes like this: 30847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ol> 30863a6c79f802fabdb94367177310663397420e319fNick Kralevich** <li> Create the prepared statement object using [sqlite3_prepare_v2()]. 30873a6c79f802fabdb94367177310663397420e319fNick Kralevich** <li> Bind values to [parameters] using the sqlite3_bind_*() 3088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. 30897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Run the SQL by calling [sqlite3_step()] one or more times. 30903a6c79f802fabdb94367177310663397420e319fNick Kralevich** <li> Reset the prepared statement using [sqlite3_reset()] then go back 30917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to step 2. Do this zero or more times. 30927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Destroy the object using [sqlite3_finalize()]. 30937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ol> 30947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 30957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_stmt sqlite3_stmt; 30967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 30977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-time Limits 30993a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 31007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interface allows the size of various constructs to be limited 31027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on a connection by connection basis. The first parameter is the 31037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [database connection] whose limit is to be set or queried. The 31047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter is one of the [limit categories] that define a 31057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** class of constructs to be size limited. The third parameter is the 3106de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** new limit for that construct.)^ 3107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the new limit is a negative number, the limit is unchanged. 3109de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a 3110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [limits | hard upper bound] 3111de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** set at compile-time by a C preprocessor macro called 3112de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [limits | SQLITE_MAX_<i>NAME</i>]. 3113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (The "_LIMIT_" in the name is changed to "_MAX_".))^ 3114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Attempts to increase a limit above its hard upper bound are 3115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** silently truncated to the hard upper bound. 3116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3117de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Regardless of whether or not the limit was changed, the 3118de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_limit()] interface returns the prior value of the limit. 3119de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Hence, to find the current value of a limit without changing it, 3120de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** simply invoke this interface with the third parameter set to -1. 3121de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Run-time limits are intended for use in applications that manage 31237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** both their own internal database and also databases that are controlled 31247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by untrusted external sources. An example application might be a 3125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** web browser that has its own databases for storing history and 3126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** separate databases controlled by JavaScript applications downloaded 3127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** off the Internet. The internal databases can be given the 31287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** large, default limits. Databases managed by external sources can 31297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be given much smaller limits designed to prevent a denial of service 3130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** attack. Developers might also want to use the [sqlite3_set_authorizer()] 31317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface to further control untrusted SQL. The size of the database 31327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** created by an untrusted script can be contained using the 31337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [max_page_count] [PRAGMA]. 31347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New run-time limit categories may be added in future releases. 31367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 31373fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_limit(sqlite3*, int id, int newVal); 31387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 31397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-Time Limit Categories 3141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {limit category} {*limit categories} 3142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants define various performance limits 3144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be lowered at run-time using [sqlite3_limit()]. 3145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The synopsis of the meanings of the various limits is shown below. 3146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Additional information is available at [limits | Limits in SQLite]. 31477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 31487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dl> 314990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt> 3150de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ 31517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 315290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> 3153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ 31547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 315590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt> 31567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dd>The maximum number of columns in a table definition or in the 3157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result set of a [SELECT] or the maximum number of columns in an index 3158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or in an ORDER BY or GROUP BY clause.</dd>)^ 31597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 316090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 3161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum depth of the parse tree on any expression.</dd>)^ 31627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 316390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 3164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ 31657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 316690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> 31677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dd>The maximum number of instructions in a virtual machine program 3168de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** used to implement an SQL statement. This limit is not currently 3169de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** enforced, though that might be added in some future release of 3170de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite.</dd>)^ 31717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 317290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 3173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of arguments on a function.</dd>)^ 31747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 317590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt> 3176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of [ATTACH | attached databases].)^</dd> 31777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 317890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] 3179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 3180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum length of the pattern argument to the [LIKE] or 3181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [GLOB] operators.</dd>)^ 31827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 318390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_VARIABLE_NUMBER]] 3184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 3185de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <dd>The maximum index number of any [parameter] in an SQL statement.)^ 3186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 318790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> 3188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum depth of recursion for triggers.</dd>)^ 31893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 31903fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt> 31913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>The maximum number of auxiliary worker threads that a single 31923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [prepared statement] may start.</dd>)^ 31937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </dl> 31947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 31957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_LENGTH 0 31967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_SQL_LENGTH 1 31977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_COLUMN 2 31987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_EXPR_DEPTH 3 31997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_COMPOUND_SELECT 4 32007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_VDBE_OP 5 32017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_FUNCTION_ARG 6 32027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_ATTACHED 7 32037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 32047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_VARIABLE_NUMBER 9 3205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_LIMIT_TRIGGER_DEPTH 10 32063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_LIMIT_WORKER_THREADS 11 32077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compiling An SQL Statement 3210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {SQL statement compiler} 32113a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 32123a6c79f802fabdb94367177310663397420e319fNick Kralevich** CONSTRUCTOR: sqlite3_stmt 32137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** To execute an SQL query, it must first be compiled into a byte-code 3215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** program using one of these routines. 32167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument, "db", is a [database connection] obtained from a 3218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or 3219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open16()]. The database connection must not have been closed. 3220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second argument, "zSql", is the statement to be compiled, encoded 32227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() 3223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() 3224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** use UTF-16. 3225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 32263fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the nByte argument is negative, then zSql is read up to the 32273fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** first zero terminator. ^If nByte is positive, then it is the 32283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** number of bytes read from zSql. ^If nByte is zero, then no prepared 32293fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** statement is generated. 32303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** If the caller knows that the supplied string is nul-terminated, then 32313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** there is a small performance advantage to passing an nByte parameter that 32323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is the number of bytes in the input string <i>including</i> 32333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the nul-terminator. 3234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3235a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If pzTail is not NULL then *pzTail is made to point to the first byte 3236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** past the end of the first SQL statement in zSql. These routines only 3237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compile the first statement in zSql, so *pzTail is left pointing to 3238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what remains uncompiled. 3239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^*ppStmt is left pointing to a compiled [prepared statement] that can be 3241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set 3242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to NULL. ^If the input text contains no SQL (if the input is an empty 3243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string or a comment) then *ppStmt is set to NULL. 3244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The calling procedure is responsible for deleting the compiled 3245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statement using [sqlite3_finalize()] after it has finished with it. 3246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ppStmt may not be NULL. 3247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; 3249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** otherwise an [error code] is returned. 32507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are 32527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** recommended for all new programs. The two older interfaces are retained 32537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for backwards compatibility, but their use is discouraged. 3254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the "v2" interfaces, the prepared statement 3255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is returned (the [sqlite3_stmt] object) contains a copy of the 3256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** original SQL text. This causes the [sqlite3_step()] interface to 3257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** behave differently in three ways: 32587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ol> 32607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 3261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 32627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** always used to do, [sqlite3_step()] will automatically recompile the SQL 32638fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY] 32648fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** retries will occur before sqlite3_step() gives up and returns an error. 32657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </li> 32667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 3268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When an error occurs, [sqlite3_step()] will return one of the detailed 3269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error codes] or [extended error codes]. ^The legacy behavior was that 3270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 3271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the application would have to make a second call to [sqlite3_reset()] 3272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in order to find the underlying cause of the problem. With the "v2" prepare 3273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces, the underlying reason for the error is returned immediately. 32747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </li> 32757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> 3277de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the specific value bound to [parameter | host parameter] in the 3278de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** WHERE clause might influence the choice of query plan for a statement, 3279de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** then the statement will be automatically recompiled, as if there had been 3280de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** a schema change, on the first [sqlite3_step()] call following any change 3281de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the [sqlite3_bind_text | bindings] of that [parameter]. 3282de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The specific value of WHERE-clause [parameter] might influence the 3283de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** choice of query plan if the parameter is the left-hand side of a [LIKE] 3284de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** or [GLOB] operator or if the parameter is compared to an indexed column 328590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled. 3286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </li> 3287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ol> 32887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 32893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_prepare( 32907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 32917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zSql, /* SQL statement, UTF-8 encoded */ 32927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 32937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 32947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char **pzTail /* OUT: Pointer to unused portion of zSql */ 32957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 32963fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_prepare_v2( 32977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 32987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zSql, /* SQL statement, UTF-8 encoded */ 32997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 33007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 33017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char **pzTail /* OUT: Pointer to unused portion of zSql */ 33027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 33033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_prepare16( 33047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 33057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zSql, /* SQL statement, UTF-16 encoded */ 33067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 33077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 33087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void **pzTail /* OUT: Pointer to unused portion of zSql */ 33097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 33103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_prepare16_v2( 33117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 33127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zSql, /* SQL statement, UTF-16 encoded */ 33137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 33147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 33157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void **pzTail /* OUT: Pointer to unused portion of zSql */ 33167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 33177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 33187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Retrieving Statement SQL 33203a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 33217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface can be used to retrieve a saved copy of the original 3323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL text used to create a [prepared statement] if that statement was 3324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. 33257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 33263fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_sql(sqlite3_stmt *pStmt); 33277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 33287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 332995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** CAPI3REF: Determine If An SQL Statement Writes The Database 33303a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 333195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 333295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if 333390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** and only if the [prepared statement] X makes no direct changes to 333490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the content of the database file. 333590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 333690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Note that [application-defined SQL functions] or 333790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [virtual tables] might change the database indirectly as a side effect. 333890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(For example, if an application defines a function "eval()" that 333990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** calls [sqlite3_exec()], then the following SQL statement would 334090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** change the database file through side-effects: 334190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 334290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <blockquote><pre> 334390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SELECT eval('DELETE FROM t1') FROM t2; 334490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </pre></blockquote> 334590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 334690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** But because the [SELECT] statement does not change the database file 334790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** directly, sqlite3_stmt_readonly() would still return true.)^ 334890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 334990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], 335090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, 335190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** since the statements themselves do not actually modify the database but 335290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** rather they control the timing of when other statements modify the 335390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database. ^The [ATTACH] and [DETACH] statements also cause 335490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_stmt_readonly() to return true since, while those statements 335590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** change the configuration of a database connection, they do not make 335690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** changes to the content of the database files on disk. 335795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori*/ 33583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_stmt_readonly(sqlite3_stmt *pStmt); 335995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori 336095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori/* 336190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Determine If A Prepared Statement Has Been Reset 33623a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 336390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 336490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the 336590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [prepared statement] S has been stepped at least once using 336690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_step(S)] but has not run to completion and/or has not 336790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) 336890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** interface returns false if S is a NULL pointer. If S is not a 336990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** NULL pointer and is not a pointer to a valid [prepared statement] 337090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** object, then the behavior is undefined and probably undesirable. 337190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 337290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This interface can be used in combination [sqlite3_next_stmt()] 337390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to locate all prepared statements associated with a database 337490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** connection that are in need of being reset. This can be used, 337590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for example, in diagnostic routines to search for prepared 337690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** statements that are holding a transaction open. 337790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 33783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_stmt_busy(sqlite3_stmt*); 337990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 338090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 3381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Dynamically Typed Value Object 33827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 33837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite uses the sqlite3_value object to represent all values 3385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be stored in a database table. SQLite uses dynamic typing 3386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the values it stores. ^Values stored in sqlite3_value objects 3387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be integers, floating point values, strings, BLOBs, or NULL. 33887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An sqlite3_value object may be either "protected" or "unprotected". 33907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Some interfaces require a protected sqlite3_value. Other interfaces 33917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will accept either a protected or an unprotected sqlite3_value. 3392a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every interface that accepts sqlite3_value arguments specifies 33937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** whether or not it requires a protected sqlite3_value. 33947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The terms "protected" and "unprotected" refer to whether or not 339690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a mutex is held. An internal mutex is held for a protected 33977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value object but no mutex is held for an unprotected 33987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value object. If SQLite is compiled to be single-threaded 3399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 3400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or if SQLite is run in one of reduced mutex modes 3401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 3402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then there is no distinction between protected and unprotected 3403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_value objects and they can be used interchangeably. However, 3404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for maximum code portability it is recommended that applications 3405de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** still make the distinction between protected and unprotected 3406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_value objects even when not strictly required. 3407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value objects that are passed as parameters into the 3409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of [application-defined SQL functions] are protected. 3410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value object returned by 34117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_column_value()] is unprotected. 34127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Unprotected sqlite3_value objects may only be used with 3413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_result_value()] and [sqlite3_bind_value()]. 3414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_value_blob | sqlite3_value_type()] family of 3415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces require protected sqlite3_value objects. 34167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 34177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct Mem sqlite3_value; 34187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 34197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQL Function Context Object 34217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The context in which an SQL function executes is stored in an 3423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_context object. ^A pointer to an sqlite3_context object 3424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is always first parameter to [application-defined SQL functions]. 3425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application-defined SQL function implementation will pass this 3426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 3427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_aggregate_context()], [sqlite3_user_data()], 3428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 3429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and/or [sqlite3_set_auxdata()]. 34307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 34317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_context sqlite3_context; 34327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 34337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Binding Values To Prepared Statements 3435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {host parameter} {host parameters} {host parameter name} 3436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 34373a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 34387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, 3440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** literals may be replaced by a [parameter] that matches one of following 3441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** templates: 34427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 34447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> ? 34457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> ?NNN 34467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> :VVV 34477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> @VVV 34487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> $VVV 34497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 34507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In the templates above, NNN represents an integer literal, 3452de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and VVV represents an alphanumeric identifier.)^ ^The values of these 3453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters (also called "host parameter names" or "SQL parameters") 34547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be set using the sqlite3_bind_*() routines defined here. 34557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the sqlite3_bind_*() routines is always 3457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a pointer to the [sqlite3_stmt] object returned from 3458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()] or its variants. 3459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second argument is the index of the SQL parameter to be set. 3461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The leftmost SQL parameter has an index of 1. ^When the same named 3462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL parameter is used more than once, second and subsequent 3463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occurrences have the same index as the first occurrence. 3464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The index for named parameters can be looked up using the 3465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_bind_parameter_index()] API if desired. ^The index 34667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for "?NNN" parameters is the value of NNN. 3467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The NNN value must be between 1 and the [sqlite3_limit()] 3468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 34697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third argument is the value to bind to the parameter. 34718fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16() 34728fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter 34738fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** is ignored and the end result is the same as sqlite3_bind_null(). 34747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In those routines that have a fourth argument, its value is the 3476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of bytes in the parameter. To be clear: the value is the 3477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of <u>bytes</u> in the value, not the number of characters.)^ 34788fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16() 34798fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** is negative, then the length of the string is 3480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of bytes up to the first zero terminator. 34818fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** If the fourth parameter to sqlite3_bind_blob() is negative, then 34828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the behavior is undefined. 348390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If a non-negative fourth parameter is provided to sqlite3_bind_text() 34843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** or sqlite3_bind_text16() or sqlite3_bind_text64() then 34853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** that parameter must be the byte offset 348690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** where the NUL terminator would occur assuming the string were NUL 348790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** terminated. If any NUL characters occur at byte offsets less than 348890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the value of the fourth parameter then the resulting string value will 348990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** contain embedded NULs. The result of expressions involving strings 349090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** with embedded NULs is undefined. 34917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The fifth argument to the BLOB and string binding interfaces 34933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is a destructor used to dispose of the BLOB or 349495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** string after SQLite has finished with it. ^The destructor is called 34953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to dispose of the BLOB or string even if the call to bind API fails. 349695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^If the fifth argument is 34977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the special value [SQLITE_STATIC], then SQLite assumes that the 34987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is in static, unmanaged space and does not need to be freed. 3499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the fifth argument has the value [SQLITE_TRANSIENT], then 35007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite makes its own private copy of the data immediately, before 35017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the sqlite3_bind_*() routine returns. 35027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sixth argument to sqlite3_bind_text64() must be one of 35043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE] 35053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to specify the encoding of the text in the third parameter. If 35063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the sixth argument to sqlite3_bind_text64() is not one of the 35073fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** allowed values shown above, or if the text encoding is different 35083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** from the encoding specified by the sixth parameter, then the behavior 35093fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is undefined. 35103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 3511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 3512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is filled with zeroes. ^A zeroblob uses a fixed amount of memory 3513a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (just an integer to hold its size) while it is being processed. 3514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Zeroblobs are intended to serve as placeholders for BLOBs whose 3515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** content is later written using 3516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_blob_open | incremental BLOB I/O] routines. 3517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A negative value for the zeroblob results in a zero-length BLOB. 3518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer 3520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the [prepared statement] or with a prepared statement for which 3521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_step()] has been called more recently than [sqlite3_reset()], 3522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() 3523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine is passed a [prepared statement] that has been finalized, the 3524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result is undefined and probably harmful. 3525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Bindings are not cleared by the [sqlite3_reset()] routine. 3527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unbound parameters are interpreted as NULL. 3528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an 3530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error code] if anything goes wrong. 35313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB 35323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or 35333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [SQLITE_MAX_LENGTH]. 3534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_RANGE] is returned if the parameter 3535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. 35367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_parameter_count()], 3538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 3539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 35403fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 35413fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64, 35423fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich void(*)(void*)); 35433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_double(sqlite3_stmt*, int, double); 35443fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_int(sqlite3_stmt*, int, int); 35453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 35463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_null(sqlite3_stmt*, int); 35473fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*)); 35483fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 35493fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64, 35503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich void(*)(void*), unsigned char encoding); 35513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 35523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 3553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number Of SQL Parameters 35563a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 35577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine can be used to find the number of [SQL parameters] 3559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in a [prepared statement]. SQL parameters are tokens of the 35607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 3561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** placeholders for values that are [sqlite3_bind_blob | bound] 35627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to the parameters at a later time. 35637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine actually returns the index of the largest (rightmost) 3565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter. For all forms except ?NNN, this will correspond to the 3566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of unique parameters. If parameters of the ?NNN form are used, 3567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there may be gaps in the list.)^ 35687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 35707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_name()], and 35717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 35727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 35733fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_parameter_count(sqlite3_stmt*); 35747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 35757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Name Of A Host Parameter 35773a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 35787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_parameter_name(P,N) interface returns 3580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the name of the N-th [SQL parameter] in the [prepared statement] P. 3581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 35827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 35837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** respectively. 35847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In other words, the initial ":" or "$" or "@" or "?" 3585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is included as part of the name.)^ 3586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Parameters of the form "?" without a following integer have no name 3587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and are referred to as "nameless" or "anonymous parameters". 35887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first host parameter has an index of 1, not 0. 35907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the value N is out of range or if the N-th parameter is 3592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nameless, then NULL is returned. ^The returned string is 3593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always in UTF-8 encoding even if the named parameter was 35947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** originally specified as UTF-16 in [sqlite3_prepare16()] or 35957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare16_v2()]. 35967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 35987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_count()], and 35997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 36007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 36013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_bind_parameter_name(sqlite3_stmt*, int); 36027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 36037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Index Of A Parameter With A Given Name 36053a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 36067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Return the index of an SQL parameter given its name. ^The 36087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** index value returned is suitable for use as the second 3609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero 3610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned if no matching parameter is found. ^The parameter 36117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** name must be given in UTF-8 even if the original statement 36127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. 36137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 36147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 36157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_count()], and 36167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 36177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 36183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 36197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 36207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3621a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset All Bindings On A Prepared Statement 36223a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 36237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3624a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset 3625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 3626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Use this routine to reset all host parameters to NULL. 36277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 36283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_clear_bindings(sqlite3_stmt*); 36297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 36307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number Of Columns In A Result Set 36323a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 36337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Return the number of columns in the result set returned by the 3635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement]. ^This routine returns 0 if pStmt is an SQL 3636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement that does not return data (for example an [UPDATE]). 3637de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3638de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** See also: [sqlite3_data_count()] 36397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 36403fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_column_count(sqlite3_stmt *pStmt); 36417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 36427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Column Names In A Result Set 36443a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 36457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return the name assigned to a particular column 3647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the result set of a [SELECT] statement. ^The sqlite3_column_name() 3648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface returns a pointer to a zero-terminated UTF-8 string 36497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and sqlite3_column_name16() returns a pointer to a zero-terminated 3650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 string. ^The first parameter is the [prepared statement] 3651a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that implements the [SELECT] statement. ^The second parameter is the 3652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column number. ^The leftmost column is number 0. 36537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string pointer is valid until either the [prepared statement] 365590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is destroyed by [sqlite3_finalize()] or until the statement is automatically 365690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** reprepared by the first call to [sqlite3_step()] for a particular run 365790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or until the next call to 3658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_name() or sqlite3_column_name16() on the same column. 36597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_malloc() fails during the processing of either routine 36617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** (for example during a conversion from UTF-8 to UTF-16) then a 36627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** NULL pointer is returned. 36637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The name of a result column is the value of the "AS" clause for 36657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that column, if there is an AS clause. If there is no AS clause 36667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then the name of the column is unspecified and may change from 36677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** one release of SQLite to the next. 36687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 36693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_column_name(sqlite3_stmt*, int N); 36703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_column_name16(sqlite3_stmt*, int N); 36717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 36727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Source Of Data In A Query Result 36743a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 36757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines provide a means to determine the database, table, and 3677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** table column that is the origin of a particular result column in 3678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SELECT] statement. 3679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The name of the database or table or column can be returned as 3680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** either a UTF-8 or UTF-16 string. ^The _database_ routines return 36817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the database name, the _table_ routines return the table name, and 36827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the origin_ routines return the column name. 3683a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string is valid until the [prepared statement] is destroyed 368490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** using [sqlite3_finalize()] or until the statement is automatically 368590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** reprepared by the first call to [sqlite3_step()] for a particular run 368690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or until the same information is requested 36877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** again in a different encoding. 36887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The names returned are the original un-aliased names of the 36907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database, table, and column. 36917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to these interfaces is a [prepared statement]. 3693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These functions return information about the Nth result column returned by 36947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the statement, where N is the second function argument. 3695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The left-most column is column 0 for these routines. 36967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the Nth column returned by the statement is an expression or 3698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subquery and is not a column value, then all of these functions return 3699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL. ^These routine might also return NULL if a memory allocation error 3700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occurs. ^Otherwise, they return the name of the attached database, table, 3701a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or column that query result column was extracted from. 37027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^As with all other SQLite APIs, those whose names end with "16" return 3704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 encoded strings and the other functions return UTF-8. 37057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These APIs are only available if the library was compiled with the 3707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. 37087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 37097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If two or more threads call one or more of these routines against the same 37107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** prepared statement and column at the same time then the results are 37117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** undefined. 37127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3713a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If two or more threads call one or more 3714a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_database_name | column metadata interfaces] 3715a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the same [prepared statement] and result column 3716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** at the same time then the results are undefined. 3717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 37183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_column_database_name(sqlite3_stmt*,int); 37193fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_column_database_name16(sqlite3_stmt*,int); 37203fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_column_table_name(sqlite3_stmt*,int); 37213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_column_table_name16(sqlite3_stmt*,int); 37223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_column_origin_name(sqlite3_stmt*,int); 37233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_column_origin_name16(sqlite3_stmt*,int); 3724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3726a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Declared Datatype Of A Query Result 37273a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 3728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The first parameter is a [prepared statement]. 3730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If this statement is a [SELECT] statement and the Nth column of the 3731a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned result set of that [SELECT] is a table column (not an 37327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expression or subquery) then the declared type of the table 3733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column is returned.)^ ^If the Nth column of the result set is an 37347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expression or subquery, then a NULL pointer is returned. 3735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string is always UTF-8 encoded. 3736a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3737a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(For example, given the database schema: 37387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 37397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** CREATE TABLE t1(c1 VARIANT); 37407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the following statement to be compiled: 37427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 37437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SELECT c1 + 1, c1 FROM t1; 37447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3745a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this routine would return the string "VARIANT" for the second result 3746a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column (i==1), and a NULL pointer for the first result column (i==0).)^ 37477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3748a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite uses dynamic run-time typing. ^So just because a column 37497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is declared to contain a particular type does not mean that the 37507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** data stored in that column is of the declared type. SQLite is 3751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** strongly typed, but the typing is dynamic not static. ^Type 37527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is associated with individual values, not with the containers 37537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used to hold those values. 3754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 37553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_column_decltype(sqlite3_stmt*,int); 37563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_column_decltype16(sqlite3_stmt*,int); 3757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Evaluate An SQL Statement 37603a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 3761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3762a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** After a [prepared statement] has been prepared using either 3763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy 3764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 3765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be called one or more times to evaluate the statement. 37667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The details of the behavior of the sqlite3_step() interface depend 37687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on whether the statement was prepared using the newer "v2" interface 37697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy 37707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 37717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** new "v2" interface is recommended for new applications but the legacy 37727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface will continue to be supported. 37737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the legacy interface, the return value will be either [SQLITE_BUSY], 37757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 3776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^With the "v2" interface, any of the other [result codes] or 3777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result codes] might be returned as well. 37787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_BUSY] means that the database engine was unable to acquire the 3780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database locks it needs to do its job. ^If the statement is a [COMMIT] 37817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or occurs outside of an explicit transaction, then you can retry the 378290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** statement. If the statement is not a [COMMIT] and occurs within an 37837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** explicit transaction then you should rollback the transaction before 37847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** continuing. 37857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3786a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_DONE] means that the statement has finished executing 37877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** successfully. sqlite3_step() should not be called again on this virtual 37887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** machine without first calling [sqlite3_reset()] to reset the virtual 37897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** machine back to its initial state. 37907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] 3792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned each time a new row of data is ready for processing by the 3793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller. The values may be accessed using the [column access functions]. 37947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_step() is called again to retrieve the next row of data. 3795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3796a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_ERROR] means that a run-time error (such as a constraint 37977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** violation) has occurred. sqlite3_step() should not be called again on 37987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the VM. More information may be found by calling [sqlite3_errmsg()]. 3799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^With the legacy interface, a more specific error code (for example, 38007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 38017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be obtained by calling [sqlite3_reset()] on the 3802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement]. ^In the "v2" interface, 38037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the more specific error code is returned directly by sqlite3_step(). 38047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 38057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_MISUSE] means that the this routine was called inappropriately. 38067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Perhaps it was called on a [prepared statement] that has 3807a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already been [sqlite3_finalize | finalized] or on one that had 38087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 38097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be the case that the same database connection is being used by two or 38107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** more threads at the same moment in time. 38117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 381290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** For all versions of SQLite up to and including 3.6.23.1, a call to 381390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_reset()] was required after sqlite3_step() returned anything 381490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** other than [SQLITE_ROW] before any subsequent invocation of 381590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_step(). Failure to reset the prepared statement using 381690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from 381790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began 381890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** calling [sqlite3_reset()] automatically in this circumstance rather 381990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** than returning [SQLITE_MISUSE]. This is not considered a compatibility 382090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** break because any application that ever receives an SQLITE_MISUSE error 382190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option 382290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** can be used to restore the legacy behavior. 382371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 3824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 3825a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** API always returns a generic error code, [SQLITE_ERROR], following any 3826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 3827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 3828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** specific [error codes] that better describes the error. 38297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** We admit that this is a goofy design. The problem has been fixed 38307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the "v2" interface. If you prepare all of your SQL statements 38317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead 3832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 3833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the more specific [error codes] are returned directly 38347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_step(). The use of the "v2" interface is recommended. 38357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 38363fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_step(sqlite3_stmt*); 38377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number of columns in a result set 38403a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 38417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3842de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_data_count(P) interface returns the number of columns in the 3843de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** current row of the result set of [prepared statement] P. 3844de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If prepared statement P does not have results ready to return 3845de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of 3846de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** interfaces) then sqlite3_data_count(P) returns 0. 3847de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. 384890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_data_count(P) routine returns 0 if the previous call to 384990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P) 385090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** will return non-zero if previous call to [sqlite3_step](P) returned 385190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] 385290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** where it always returns zero since each step of that multi-step 385390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pragma returns 0 columns of data. 3854de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3855de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** See also: [sqlite3_column_count()] 38567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 38573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_data_count(sqlite3_stmt *pStmt); 38587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Fundamental Datatypes 38617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: SQLITE_TEXT 38627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3863a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Every value in SQLite has one of five fundamental datatypes: 38647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 38657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 38667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 64-bit signed integer 38677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 64-bit IEEE floating point number 38687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> string 38697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> BLOB 38707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> NULL 3871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 38727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 38737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constants are codes for each of those types. 38747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 38757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Note that the SQLITE_TEXT constant was also used in SQLite version 2 38767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for a completely different meaning. Software that links against both 3877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 38787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_TEXT. 38797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 38807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTEGER 1 38817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FLOAT 2 38827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_BLOB 4 38837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NULL 5 38847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_TEXT 38857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef SQLITE_TEXT 38867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#else 38877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# define SQLITE_TEXT 3 38887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 38897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE3_TEXT 3 38907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3892a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Result Values From A Query 3893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {column access functions} 38943a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 3895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3896a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines form the "result set" interface. 3897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return information about a single column of the current 3899a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result row of a query. ^In every case the first argument is a pointer 3900a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 3901a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was returned from [sqlite3_prepare_v2()] or one of its variants) 3902a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the second argument is the index of the column for which information 3903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should be returned. ^The leftmost column of the result set has the index 0. 3904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The number of columns in the result can be determined using 3905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_count()]. 3906a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3907a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the SQL statement does not currently point to a valid row, or if the 3908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column index is out of range, the result is undefined. 39097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines may only be called when the most recent call to 39107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_step()] has returned [SQLITE_ROW] and neither 3911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 39127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If any of these routines are called after [sqlite3_reset()] or 39137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_finalize()] or after [sqlite3_step()] has returned 39147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** something other than [SQLITE_ROW], the results are undefined. 39157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 39167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are called from a different thread while any of these routines 3917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are pending, then the results are undefined. 39187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3919a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_column_type() routine returns the 39207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_INTEGER | datatype code] for the initial data type 3921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the result column. ^The returned value is one of [SQLITE_INTEGER], 39227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value 39237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** returned by sqlite3_column_type() is only meaningful if no type 39247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** conversions have occurred as described below. After a type conversion, 39257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the value returned by sqlite3_column_type() is undefined. Future 39267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** versions of SQLite may change the behavior of sqlite3_column_type() 39277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** following a type conversion. 39287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 39307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** routine returns the number of bytes in that BLOB or string. 3931a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts 39327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the string to UTF-8 and then returns the number of bytes. 3933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a numeric value then sqlite3_column_bytes() uses 39347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 39357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number of bytes in that string. 3936de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is NULL, then sqlite3_column_bytes() returns zero. 3937de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3938de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() 3939de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** routine returns the number of bytes in that BLOB or string. 3940de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts 3941de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the string to UTF-16 and then returns the number of bytes. 3942de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is a numeric value then sqlite3_column_bytes16() uses 3943de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns 3944de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the number of bytes in that string. 3945de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. 3946de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3947de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The values returned by [sqlite3_column_bytes()] and 3948de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_column_bytes16()] do not include the zero terminators at the end 3949de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of the string. ^For clarity: the values returned by 3950de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of 39517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes in the string, not the number of characters. 39527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 395490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** even empty strings, are always zero-terminated. ^The return 3955de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. 39567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The object returned by [sqlite3_column_value()] is an 39587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [unprotected sqlite3_value] object. An unprotected sqlite3_value object 39597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. 39607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If the [unprotected sqlite3_value] object returned by 39617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_column_value()] is used in any other way, including calls 3962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 3963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_value_bytes()], then the behavior is undefined. 39647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines attempt to convert the value where appropriate. ^For 39667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** example, if the internal representation is FLOAT and a text result 3967a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is requested, [sqlite3_snprintf()] is used internally to perform the 3968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** conversion automatically. ^(The following table details the conversions 3969a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are applied: 39707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote> 39727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <table border="1"> 39737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 39747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> INTEGER <td> Result is 0 39767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> FLOAT <td> Result is 0.0 39778fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer 39788fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer 39797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 39807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 3981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 39828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER 39837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 39848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB 39858fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER 39868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL 39877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> TEXT <td> BLOB <td> No change 39888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER 39898fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL 39907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 39917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </table> 3992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </blockquote>)^ 39937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The table above makes reference to standard C library functions atoi() 39957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and atof(). SQLite does not really use these functions. It has its 3996a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** own equivalent internal routines. The atoi() and atof() names are 39977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used in the table for brevity and because they are familiar to most 39987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** C programmers. 39997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4000de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Note that when type conversions occur, pointers returned by prior 40017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 4002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() may be invalidated. 4003de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Type conversions and pointer invalidations might occur 40047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in the following cases: 40057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 40067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 4007a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is a BLOB and sqlite3_column_text() or 4008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() is called. A zero-terminator might 4009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** need to be added to the string.</li> 4010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 4011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() is called. The content must be converted 4012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to UTF-16.</li> 4013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 4014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text() is called. The content must be converted 4015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to UTF-8.</li> 4016de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul> 4017a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Conversions between UTF-16be and UTF-16le are always done in place and do 40197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not invalidate a prior pointer, though of course the content of the buffer 4020de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** that the prior pointer references will have been modified. Other kinds 4021a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of conversion are done in place when it is possible, but sometimes they 4022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are not possible and in those cases prior pointers are invalidated. 40237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4024de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The safest and easiest to remember policy is to invoke these routines 40257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in one of the following ways: 40267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 40287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 40297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 40307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 4031de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul> 40327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In other words, you should call sqlite3_column_text(), 4034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 4035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the desired format, then invoke sqlite3_column_bytes() or 4036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 4037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_column_text() or sqlite3_column_blob() with calls to 4038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 4039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with calls to sqlite3_column_bytes(). 40407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The pointers returned are valid until a type conversion occurs as 40427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 4043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_finalize()] is called. ^The memory space used to hold strings 4044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned 40458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 40467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_free()]. 40477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If a memory allocation error occurs during the evaluation of any 40497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of these routines, a default value is returned. The default value 40507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is either the integer 0, the floating point number 0.0, or a NULL 40517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer. Subsequent calls to [sqlite3_errcode()] will return 4052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_NOMEM].)^ 4053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 40543fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_column_blob(sqlite3_stmt*, int iCol); 40553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_column_bytes(sqlite3_stmt*, int iCol); 40563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 40573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API double SQLITE_STDCALL sqlite3_column_double(sqlite3_stmt*, int iCol); 40583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_column_int(sqlite3_stmt*, int iCol); 40593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_column_int64(sqlite3_stmt*, int iCol); 40603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const unsigned char *SQLITE_STDCALL sqlite3_column_text(sqlite3_stmt*, int iCol); 40613fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_column_text16(sqlite3_stmt*, int iCol); 40623fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_column_type(sqlite3_stmt*, int iCol); 40633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_value *SQLITE_STDCALL sqlite3_column_value(sqlite3_stmt*, int iCol); 4064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 4065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 4066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Destroy A Prepared Statement Object 40673a6c79f802fabdb94367177310663397420e319fNick Kralevich** DESTRUCTOR: sqlite3_stmt 40687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_finalize() function is called to delete a [prepared statement]. 407090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If the most recent evaluation of the statement encountered no errors 407195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** or if the statement is never been evaluated, then sqlite3_finalize() returns 407295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** SQLITE_OK. ^If the most recent evaluation of statement S failed, then 407395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_finalize(S) returns the appropriate [error code] or 407495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** [extended error code]. 407595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 407695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The sqlite3_finalize(S) routine can be called at any point during 407795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** the life cycle of [prepared statement] S: 407895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** before statement S is ever evaluated, after 407995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** one or more calls to [sqlite3_reset()], or after any call 408095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** to [sqlite3_step()] regardless of whether or not the statement has 408195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** completed execution. 408295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 408395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. 408495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 408595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The application must finalize every [prepared statement] in order to avoid 408695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** resource leaks. It is a grievous error for the application to try to use 408795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** a prepared statement after it has been finalized. Any use of a prepared 408895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** statement after it has been finalized can result in undefined and 408995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** undesirable behavior such as segfaults and heap corruption. 40907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 40913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_finalize(sqlite3_stmt *pStmt); 40927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset A Prepared Statement Object 40953a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 40967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_reset() function is called to reset a [prepared statement] 4098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object back to its initial state, ready to be re-executed. 4099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any SQL statement variables that had values bound to them using 41007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 41017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Use [sqlite3_clear_bindings()] to reset the bindings. 41027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S 4104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** back to the beginning of its program. 41057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the most recent call to [sqlite3_step(S)] for the 4107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 4108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or if [sqlite3_step(S)] has never before been called on S, 4109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then [sqlite3_reset(S)] returns [SQLITE_OK]. 41107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the most recent call to [sqlite3_step(S)] for the 4112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement] S indicated an error, then 4113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset(S)] returns an appropriate [error code]. 41147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_reset(S)] interface does not change the values 4116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 41177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 41183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_reset(sqlite3_stmt *pStmt); 41197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 41207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Create Or Redefine SQL Functions 4122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {function creation routines} 4123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {application-defined SQL function} 4124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {application-defined SQL functions} 41253a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 4126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4127de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^These functions (collectively known as "function creation routines") 4128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are used to add SQL functions or aggregates or to redefine the behavior 4129de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of existing SQL functions or aggregates. The only differences between 4130de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** these routines are the text encoding expected for 413190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the second parameter (the name of the function being created) 4132de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and the presence or absence of a destructor callback for 4133de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the application data pointer. 4134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first parameter is the [database connection] to which the SQL 4136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is to be added. ^If an application uses more than one database 4137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection then application-defined SQL functions must be added 4138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to each database connection separately. 4139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4140de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The second parameter is the name of the SQL function to be created or 4141de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 4142de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** representation, exclusive of the zero-terminator. ^Note that the name 4143de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. 4144de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Any attempt to create a function with a longer name 4145de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will result in [SQLITE_MISUSE] being returned. 4146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third parameter (nArg) 4148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is the number of arguments that the SQL function or 4149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate takes. ^If this parameter is -1, then the SQL function or 4150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate may take any number of arguments between 0 and the limit 4151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third 4152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter is less than -1 or greater than 127 then the behavior is 4153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** undefined. 41547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4155de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The fourth parameter, eTextRep, specifies what 41567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_UTF8 | text encoding] this SQL function prefers for 41578fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** its parameters. The application should set this parameter to 41588fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLITE_UTF16LE] if the function implementation invokes 41598fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the 41608fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** implementation invokes [sqlite3_value_text16be()] on an input, or 41618fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8] 41628fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** otherwise. ^The same SQL function may be registered multiple times using 41638fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** different preferred text encodings, with different implementations for 41648fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** each encoding. 4165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When multiple implementations of the same function are available, SQLite 41667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will pick the one that involves the least amount of data conversion. 41678fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 41688fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC] 41698fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to signal that the function will always return the same result given 41708fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the same inputs within a single SQL statement. Most SQL functions are 41718fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** deterministic. The built-in [random()] SQL function is an example of a 41728fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** function that is not deterministic. The SQLite query planner is able to 41738fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** perform additional optimizations on deterministic functions, so use 41748fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** of the [SQLITE_DETERMINISTIC] flag is recommended where possible. 41757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The fifth parameter is an arbitrary pointer. The implementation of the 4177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function can gain access to this pointer using [sqlite3_user_data()].)^ 41787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 417990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are 4180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointers to C-language functions that implement the SQL function or 4181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate. ^A scalar SQL function requires an implementation of the xFunc 4182de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** callback only; NULL pointers must be passed as the xStep and xFinal 4183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters. ^An aggregate SQL function requires an implementation of xStep 4184de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing 418590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQL function or aggregate, pass NULL pointers for all three function 4186de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** callbacks. 4187de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 418890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, 418995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** then it is destructor for the application data pointer. 419095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The destructor is invoked when the function is deleted, either by being 419195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** overloaded or when the database connection closes.)^ 419295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The destructor is also invoked if the call to 419395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_create_function_v2() fails. 419495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^When the destructor callback of the tenth parameter is invoked, it 419595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** is passed a single argument which is a copy of the application data 419695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** pointer which was the fifth parameter to sqlite3_create_function_v2(). 4197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is permitted to register multiple implementations of the same 41997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** functions with the same name but with either differing numbers of 4200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** arguments or differing preferred text encodings. ^SQLite will use 4201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the implementation that most closely matches the way in which the 4202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL function is used. ^A function implementation with a non-negative 4203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nArg parameter is a better match than a function implementation with 4204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a negative nArg. ^A function where the preferred text encoding 4205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** matches the database encoding is a better 4206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** match than a function where the encoding is different. 4207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A function where the encoding difference is between UTF16le and UTF16be 4208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a closer match than a function where the encoding difference is 4209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** between UTF8 and UTF16. 4210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Built-in functions may be overloaded by new application-defined functions. 4212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An application-defined function is permitted to call other 4214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite interfaces. However, such calls must not 4215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** close the database connection nor finalize or reset the prepared 4216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement in which the function is running. 4217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 42183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_function( 42197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, 42207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zFunctionName, 42217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nArg, 42227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 42237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pApp, 42247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 42257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xStep)(sqlite3_context*,int,sqlite3_value**), 42267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFinal)(sqlite3_context*) 42277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 42283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_function16( 42297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, 42307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zFunctionName, 42317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nArg, 42327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 42337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pApp, 42347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 42357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xStep)(sqlite3_context*,int,sqlite3_value**), 42367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFinal)(sqlite3_context*) 42377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 42383fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_function_v2( 4239de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori sqlite3 *db, 4240de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori const char *zFunctionName, 4241de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int nArg, 4242de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int eTextRep, 4243de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pApp, 4244de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 4245de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xStep)(sqlite3_context*,int,sqlite3_value**), 4246de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xFinal)(sqlite3_context*), 4247de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void(*xDestroy)(void*) 4248de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori); 42497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Text Encodings 42527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 42537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constant define integer codes that represent the various 42547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** text encodings supported by SQLite. 42557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 42563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */ 42573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */ 42583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */ 42597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16 4 /* Use native byte order */ 42608fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_ANY 5 /* Deprecated */ 42617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 42627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 42648fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** CAPI3REF: Function Flags 42658fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 42668fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** These constants may be ORed together with the 42678fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLITE_UTF8 | preferred text encoding] as the fourth argument 42688fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to [sqlite3_create_function()], [sqlite3_create_function16()], or 42698fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_create_function_v2()]. 42708fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich*/ 42718fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_DETERMINISTIC 0x800 42728fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich 42738fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich/* 4274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Deprecated Functions 4275a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** DEPRECATED 42767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These functions are [deprecated]. In order to maintain 4278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backwards compatibility with older code, these functions continue 4279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be supported. However, new applications should avoid 42803fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the use of these functions. To encourage programmers to avoid 42813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** these functions, we will not explain what they do. 42827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef SQLITE_OMIT_DEPRECATED 42843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_aggregate_count(sqlite3_context*); 42853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_expired(sqlite3_stmt*); 42863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 42873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_global_recover(void); 42883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_DEPRECATED void SQLITE_STDCALL sqlite3_thread_cleanup(void); 42893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int), 42908fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich void*,sqlite3_int64); 4291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 42927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Obtaining SQL Function Parameter Values 42953a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_value 42967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 42977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The C-language implementation of SQL functions and aggregates uses 42987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** this set of interface routines to access the parameter values on 42997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the function or aggregate. 43007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xFunc (for scalar functions) or xStep (for aggregates) parameters 43027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to [sqlite3_create_function()] and [sqlite3_create_function16()] 43037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** define callbacks that implement the SQL functions and aggregates. 430490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The 3rd parameter to these callbacks is an array of pointers to 43057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [protected sqlite3_value] objects. There is one [sqlite3_value] object for 43067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** each parameter to the SQL function. These routines are used to 43077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** extract values from the [sqlite3_value] objects. 43087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines work only with [protected sqlite3_value] objects. 43107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Any attempt to use these routines on an [unprotected sqlite3_value] 43117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object results in undefined behavior. 43127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines work just like the corresponding [column access functions] 43143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** except that these routines take a single [protected sqlite3_value] object 4315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 43167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value_text16() interface extracts a UTF-16 string 4318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the native byte-order of the host machine. ^The 43197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 4320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extract UTF-16 strings as big-endian and little-endian respectively. 43217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The sqlite3_value_numeric_type() interface attempts to apply 43237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** numeric affinity to the value. This means that an attempt is 43247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** made to convert the value to an integer or floating point. If 43257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** such a conversion is possible without loss of information (in other 4326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** words, if the value is a string that looks like a number) 4327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the conversion is performed. Otherwise no conversion occurs. 4328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ 43297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Please pay particular attention to the fact that the pointer returned 4331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_value_blob()], [sqlite3_value_text()], or 43327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_value_text16()] can be invalidated by a subsequent call to 43337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 4334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_value_text16()]. 43357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines must be called from the same thread as 43377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQL function that supplied the [sqlite3_value*] parameters. 4338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 43393fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_value_blob(sqlite3_value*); 43403fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_value_bytes(sqlite3_value*); 43413fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_value_bytes16(sqlite3_value*); 43423fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API double SQLITE_STDCALL sqlite3_value_double(sqlite3_value*); 43433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_value_int(sqlite3_value*); 43443fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_value_int64(sqlite3_value*); 43453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const unsigned char *SQLITE_STDCALL sqlite3_value_text(sqlite3_value*); 43463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_value_text16(sqlite3_value*); 43473fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_value_text16le(sqlite3_value*); 43483fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const void *SQLITE_STDCALL sqlite3_value_text16be(sqlite3_value*); 43493fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_value_type(sqlite3_value*); 43503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_value_numeric_type(sqlite3_value*); 4351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 4352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 4353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Obtain Aggregate Function Context 43543a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_context 4355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4356de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Implementations of aggregate SQL functions use this 4357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine to allocate memory for storing their state. 4358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first time the sqlite3_aggregate_context(C,N) routine is called 4360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for a particular aggregate function, SQLite 4361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocates N of memory, zeroes out that memory, and returns a pointer 4362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the new memory. ^On second and subsequent calls to 4363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_aggregate_context() for the same aggregate function instance, 4364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same buffer is returned. Sqlite3_aggregate_context() is normally 4365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called once for each invocation of the xStep callback and then one 4366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** last time when the xFinal callback is invoked. ^(When no rows match 4367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an aggregate query, the xStep() callback of the aggregate function 4368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation is never called and xFinal() is called exactly once. 4369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In those cases, sqlite3_aggregate_context() might be called for the 4370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first time from within xFinal().)^ 4371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 43728fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer 43738fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** when first called if N is less than or equal to zero or if a memory 43748fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** allocate error occurs. 4375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is 4377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** determined by the N parameter on first successful call. Changing the 4378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of N in subsequent call to sqlite3_aggregate_context() within 4379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same aggregate function instance will not resize the memory 43808fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** allocation.)^ Within the xFinal callback, it is customary to set 43818fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** N=0 in calls to sqlite3_aggregate_context(C,N) so that no 43828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** pointless memory allocations occur. 4383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite automatically frees the memory allocated by 4385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_aggregate_context() when the aggregate query concludes. 4386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first parameter must be a copy of the 4388a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_context | SQL function context] that is the first parameter 4389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the xStep or xFinal callback routine that implements the aggregate 43907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function. 43917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This routine must be called from the same thread in which 43937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the aggregate SQL function is running. 43947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 43953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_aggregate_context(sqlite3_context*, int nBytes); 43967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 43977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: User Data For Functions 43993a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_context 44007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_user_data() interface returns a copy of 44027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pointer that was the pUserData parameter (the 5th parameter) 4403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_create_function()] 44047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_create_function16()] routines that originally 4405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** registered the application defined function. 44067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 44077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This routine must be called from the same thread in which 44087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application-defined function is running. 44097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 44103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_user_data(sqlite3_context*); 44117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection For Functions 44143a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_context 44157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_context_db_handle() interface returns a copy of 44177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pointer to the [database connection] (the 1st parameter) 4418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_create_function()] 44197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_create_function16()] routines that originally 44207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** registered the application defined function. 44217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 44223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3 *SQLITE_STDCALL sqlite3_context_db_handle(sqlite3_context*); 44237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Function Auxiliary Data 44263a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_context 44277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 44288fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** These functions may be used by (non-aggregate) SQL functions to 4429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associate metadata with argument values. If the same value is passed to 44307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** multiple invocations of the same SQL function during query execution, under 44318fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** some circumstances the associated metadata may be preserved. An example 44328fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** of where this might be useful is in a regular-expression matching 44338fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** function. The compiled version of the regular expression can be stored as 44348fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** metadata associated with the pattern string. 44358fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** Then as long as the pattern string remains the same, 44368fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the compiled regular expression can be reused on multiple 44378fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** invocations of the same function. 44387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata 44407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** associated by the sqlite3_set_auxdata() function with the Nth argument 44418fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** value to the application-defined function. ^If there is no metadata 44428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** associated with the function argument, this sqlite3_get_auxdata() interface 44438fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** returns a NULL pointer. 44448fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 44458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th 44468fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** argument of the application-defined function. ^Subsequent 44478fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** calls to sqlite3_get_auxdata(C,N) return P from the most recent 44488fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or 44498fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** NULL if the metadata has been discarded. 44508fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL, 44518fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQLite will invoke the destructor function X with parameter P exactly 44528fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** once, when the metadata is discarded. 44538fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQLite is free to discard the metadata at any time, including: <ul> 44548fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li> when the corresponding function parameter changes, or 44558fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li> when [sqlite3_reset()] or [sqlite3_finalize()] is called for the 44568fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQL statement, or 44578fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li> when sqlite3_set_auxdata() is invoked again on the same parameter, or 44588fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <li> during the original sqlite3_set_auxdata() call when a memory 44598fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** allocation error occurs. </ul>)^ 44608fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 44618fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** Note the last bullet in particular. The destructor X in 44628fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the 44638fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata() 44648fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** should be called near the end of the function implementation and the 44658fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** function implementation should not make any use of P after 44668fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sqlite3_set_auxdata() has been called. 44677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In practice, metadata is preserved between function calls for 44698fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** function parameters that are compile-time constants, including literal 44708fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** values and [parameters] and expressions composed from the same.)^ 44717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 44727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines must be called from the same thread in which 44737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQL function is running. 44747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 44753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_get_auxdata(sqlite3_context*, int N); 44763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 44777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Constants Defining Special Destructor Behavior 44817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These are special values for the destructor that is passed in as the 4483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** final argument to routines like [sqlite3_result_blob()]. ^If the destructor 44847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument is SQLITE_STATIC, it means that the content pointer is constant 4485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and will never change. It does not need to be destroyed. ^The 44867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_TRANSIENT value means that the content will likely change in 44877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the near future and that SQLite should make its own private copy of 44887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the content before returning. 44897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 44907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The typedef is necessary to work around problems in certain 44918fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** C++ compilers. 44927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 44937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef void (*sqlite3_destructor_type)(void*); 44947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_STATIC ((sqlite3_destructor_type)0) 44957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 44967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Setting The Result Of An SQL Function 44993a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_context 45007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 45017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines are used by the xFunc or xFinal callbacks that 45027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implement SQL functions and aggregates. See 45037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_function()] and [sqlite3_create_function16()] 45047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for additional information. 45057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These functions work very much like the [parameter binding] family of 4507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions used to bind values to host parameters in prepared statements. 4508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Refer to the [SQL parameter] documentation for additional information. 45097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_blob() interface sets the result from 4511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an application-defined function to be the BLOB whose content is pointed 45127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to by the second parameter and which is N bytes long where N is the 4513a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** third parameter. 4514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_zeroblob() interfaces set the result of 4516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application-defined function to be a BLOB containing all zero 45177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes and N bytes in size, where N is the value of the 2nd parameter. 45187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_double() interface sets the result from 4520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an application-defined function to be a floating point value specified 45217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by its 2nd argument. 45227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error() and sqlite3_result_error16() functions 45247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cause the implemented SQL function to throw an exception. 4525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite uses the string pointed to by the 45267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 4527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as the text of an error message. ^SQLite interprets the error 4528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** message string from sqlite3_result_error() as UTF-8. ^SQLite 4529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interprets the string from sqlite3_result_error16() as UTF-16 in native 4530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** byte order. ^If the third parameter to sqlite3_result_error() 45317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_error16() is negative then SQLite takes as the error 45327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** message all text up through the first zero character. 4533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the third parameter to sqlite3_result_error() or 45347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_error16() is non-negative then SQLite takes that many 45357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes (not characters) from the 2nd parameter as the error message. 4536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error() and sqlite3_result_error16() 4537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines make a private copy of the error message text before 45387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they return. Hence, the calling function can deallocate or 45397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** modify the text after they return without harm. 4540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error_code() function changes the error code 4541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned by SQLite as a result of an error in a function. ^By default, 4542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() 45437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 45447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 45458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an 45468fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** error indicating that a string or BLOB is too long to represent. 4547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 45488fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an 45498fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** error indicating that a memory allocation failed. 45507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_int() interface sets the return value 45527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be the 32-bit signed integer 45537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value given in the 2nd argument. 4554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_int64() interface sets the return value 45557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be the 64-bit signed integer 45567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value given in the 2nd argument. 45577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_null() interface sets the return value 45597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be NULL. 45607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_text(), sqlite3_result_text16(), 45627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 45637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** set the return value of the application-defined function to be 45647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a text string which is represented as UTF-8, UTF-16 native byte order, 45657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** UTF-16 little endian, or UTF-16 big endian, respectively. 45663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_result_text64() interface sets the return value of an 45673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** application-defined function to be a text string in an encoding 45683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** specified by the fifth (and last) parameter, which must be one 45693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]. 4570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite takes the text result from the application from 45717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the 2nd parameter of the sqlite3_result_text* interfaces. 4572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 3rd parameter to the sqlite3_result_text* interfaces 4573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is negative, then SQLite takes result text from the 2nd parameter 45747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** through the first zero character. 4575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 3rd parameter to the sqlite3_result_text* interfaces 45767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is non-negative, then as many bytes (not characters) of the text 45777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointed to by the 2nd parameter are taken as the application-defined 457890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** function result. If the 3rd parameter is non-negative, then it 457990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** must be the byte offset into the string where the NUL terminator would 458090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** appear if the string where NUL terminated. If any NUL characters occur 458190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in the string at a byte offset that is less than the value of the 3rd 458290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter, then the resulting string will contain embedded NULs and the 458390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** result of expressions operating on strings with embedded NULs is undefined. 4584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces 45857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 4586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function as the destructor on the text or BLOB result when it has 45877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** finished using that result. 4588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces or to 4589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 4590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assumes that the text or BLOB result is in constant space and does not 4591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** copy the content of the parameter nor call a destructor on the content 4592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when it has finished using that result. 4593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces 45947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 45957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then SQLite makes a copy of the result into space obtained from 45967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from [sqlite3_malloc()] before it returns. 45977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_value() interface sets the result of 45997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application-defined function to be a copy the 4600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The 46017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 4602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** so that the [sqlite3_value] specified in the parameter may change or 46037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be deallocated after sqlite3_result_value() returns without harm. 4604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A [protected sqlite3_value] object may always be used where an 46057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [unprotected sqlite3_value] object is required, so either 46067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** kind of [sqlite3_value] object can be used with this interface. 46077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If these routines are called from within the different thread 4609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** than the one containing the application-defined function that received 46107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the [sqlite3_context] pointer, the results are undefined. 4611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 46123fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 46133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_blob64(sqlite3_context*,const void*, 46143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich sqlite3_uint64,void(*)(void*)); 46153fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_double(sqlite3_context*, double); 46163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_error(sqlite3_context*, const char*, int); 46173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_error16(sqlite3_context*, const void*, int); 46183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_error_toobig(sqlite3_context*); 46193fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_error_nomem(sqlite3_context*); 46203fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_error_code(sqlite3_context*, int); 46213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_int(sqlite3_context*, int); 46223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 46233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_null(sqlite3_context*); 46243fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 46253fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64, 46263fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich void(*)(void*), unsigned char encoding); 46273fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 46283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 46293fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 46303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_value(sqlite3_context*, sqlite3_value*); 46313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_result_zeroblob(sqlite3_context*, int n); 4632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 4633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 4634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Define New Collating Sequences 46353a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 46367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4637de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^These functions add, remove, or modify a [collation] associated 4638de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with the [database connection] specified as the first argument. 46397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4640de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The name of the collation is a UTF-8 string 46417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for sqlite3_create_collation() and sqlite3_create_collation_v2() 4642de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and a UTF-16 string in native byte order for sqlite3_create_collation16(). 4643de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Collation names that compare equal according to [sqlite3_strnicmp()] are 4644de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** considered to be the same name. 4645de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4646de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The third argument (eTextRep) must be one of the constants: 4647de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <ul> 4648de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF8], 4649de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16LE], 4650de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16BE], 4651de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16], or 4652de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16_ALIGNED]. 4653de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul>)^ 4654de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The eTextRep argument determines the encoding of strings passed 4655de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the collating function callback, xCallback. 4656de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep 4657de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** force strings to be UTF16 with native byte order. 4658de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin 4659de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** on an even byte address. 4660de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 466190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The fourth argument, pArg, is an application data pointer that is passed 4662de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** through as the first argument to the collating function callback. 4663de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4664de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The fifth argument, xCallback, is a pointer to the collating function. 4665de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Multiple collating functions can be registered using the same name but 4666de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with different eTextRep parameters and SQLite will use whichever 4667de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** function requires the least amount of data transformation. 4668de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the xCallback argument is NULL then the collating function is 4669de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** deleted. ^When all collating functions having the same name are deleted, 4670de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** that collation is no longer usable. 4671de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4672de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The collating function callback is invoked with a copy of the pArg 4673de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** application data pointer and with two strings in the encoding specified 4674de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** by the eTextRep argument. The collating function must return an 4675de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** integer that is negative, zero, or positive 4676de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** if the first string is less than, equal to, or greater than the second, 467790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** respectively. A collating function must always return the same answer 4678de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** given the same inputs. If two or more collating functions are registered 4679de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the same collation name (using different eTextRep values) then all 4680de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** must give an equivalent answer when invoked with equivalent strings. 4681de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The collating function must obey the following properties for all 4682de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** strings A, B, and C: 4683de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4684de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <ol> 4685de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A==B then B==A. 4686de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A==B and B==C then A==C. 4687de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A<B THEN B>A. 4688de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A<B and B<C then A<C. 4689de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ol> 4690de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4691de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If a collating function fails any of the above constraints and that 4692de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** collating function is registered and used, then the behavior of SQLite 4693de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is undefined. 4694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() 4696de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with the addition that the xDestroy callback is invoked on pArg when 4697de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the collating function is deleted. 4698de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Collating functions are deleted when they are overridden by later 4699de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** calls to the collation creation functions or when the 4700de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [database connection] is closed using [sqlite3_close()]. 47017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 470295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The xDestroy callback is <u>not</u> called if the 470395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_create_collation_v2() function fails. Applications that invoke 470495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should 470595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** check the return code and dispose of the application data pointer 470695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** themselves rather than expecting SQLite to deal with it for them. 470795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** This is different from every other SQLite interface. The inconsistency 470895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** is unfortunate but cannot be changed without breaking backwards 470995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** compatibility. 471095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 4711a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. 47127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 47133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_collation( 47147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 47157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, 47167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 4717de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pArg, 47187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*) 47197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 47203fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_collation_v2( 47217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 47227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, 47237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 4724de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pArg, 47257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*), 47267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xDestroy)(void*) 47277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 47283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_collation16( 47297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 4730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const void *zName, 47317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 4732de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pArg, 47337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*) 47347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 47357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 47367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4737a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Collation Needed Callbacks 47383a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 47397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4740a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^To avoid having to register all collation sequences before a database 47417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be used, a single callback function may be registered with the 4742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] to be invoked whenever an undefined collation 4743a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sequence is required. 47447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4745a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the function is registered using the sqlite3_collation_needed() API, 47467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then it is passed the names of undefined collation sequences as strings 4747a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, 4748a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the names are passed as UTF-16 in machine native byte order. 4749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to either function replaces the existing collation-needed callback. 47507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(When the callback is invoked, the first argument passed is a copy 47527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the second argument to sqlite3_collation_needed() or 47537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_collation_needed16(). The second argument is the database 4754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 4755a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 4756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sequence function required. The fourth parameter is the name of the 4757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** required collation sequence.)^ 47587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The callback function should register the desired collation using 47607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 47617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_collation_v2()]. 47627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 47633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_collation_needed( 47647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 47657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 47667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void*,sqlite3*,int eTextRep,const char*) 47677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 47683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_collation_needed16( 47697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 47707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 47717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void*,sqlite3*,int eTextRep,const void*) 47727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 47737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 477471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifdef SQLITE_HAS_CODEC 47757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 47767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Specify the key for an encrypted database. This routine should be 47777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** called right after sqlite3_open(). 47787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code to implement this API is not available in the public release 47807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of SQLite. 47817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 47823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_key( 47837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database to be rekeyed */ 47847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *pKey, int nKey /* The key */ 47857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 47863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_key_v2( 47878fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich sqlite3 *db, /* Database to be rekeyed */ 47888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich const char *zDbName, /* Name of the database */ 47898fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich const void *pKey, int nKey /* The key */ 47908fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich); 47917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 47927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 47937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Change the key on an open database. If the current database is not 47947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 47957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database is decrypted. 47967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code to implement this API is not available in the public release 47987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of SQLite. 47997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 48003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_rekey( 48017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database to be rekeyed */ 48027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *pKey, int nKey /* The new key */ 48037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 48043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_rekey_v2( 48058fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich sqlite3 *db, /* Database to be rekeyed */ 48068fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich const char *zDbName, /* Name of the database */ 48078fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich const void *pKey, int nKey /* The new key */ 48088fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich); 48097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 48107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 481171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** Specify the activation key for a SEE database. Unless 481271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** activated, none of the SEE routines will work. 481371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 48143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_activate_see( 481571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori const char *zPassPhrase /* Activation phrase */ 481671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 481771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 481871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 481971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifdef SQLITE_ENABLE_CEROD 482071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 482171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** Specify the activation key for a CEROD database. Unless 482271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** activated, none of the CEROD routines will work. 482371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 48243fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_activate_cerod( 482571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori const char *zPassPhrase /* Activation phrase */ 482671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 482771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 482871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 482971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 4830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Suspend Execution For A Short Time 48317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4832de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The sqlite3_sleep() function causes the current thread to suspend execution 48337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for at least a number of milliseconds specified in its parameter. 48347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4835de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the operating system does not support sleep requests with 4836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** millisecond time resolution, then the time will be rounded up to 4837de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the nearest second. The number of milliseconds of sleep actually 48387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** requested from the operating system is returned. 48397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite implements this interface by calling the xSleep() 4841de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** method of the default [sqlite3_vfs] object. If the xSleep() method 4842de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of the default VFS is not implemented correctly, or not implemented at 4843de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** all, then the behavior of sqlite3_sleep() may deviate from the description 4844de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** in the previous paragraphs. 48457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 48463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_sleep(int); 48477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 48487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4849a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Name Of The Folder Holding Temporary Files 4850a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4851a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If this global variable is made to point to a string which is 4852a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the name of a folder (a.k.a. directory), then all temporary files 4853a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** created by SQLite when using a built-in [sqlite3_vfs | VFS] 4854a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be placed in that directory.)^ ^If this variable 4855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a NULL pointer, then SQLite performs a search for an appropriate 4856a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** temporary file directory. 4857a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 48589bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** Applications are strongly discouraged from using this global variable. 48599bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** It is required to set a temporary folder on Windows Runtime (WinRT). 48609bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** But for all other platforms, it is highly recommended that applications 48619bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** neither read nor write this variable. This global variable is a relic 48629bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** that exists for backwards compatibility of legacy applications and should 48639bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** be avoided in new projects. 48649bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** 4865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is not safe to read or modify this variable in more than one 4866a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread at a time. It is not safe to read or modify this variable 4867a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if a [database connection] is being used at the same time in a separate 4868a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread. 4869a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is intended that this variable be set once 48707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as part of process initialization and before any SQLite interface 4871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines have been called and that this variable remain unchanged 4872a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thereafter. 4873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [temp_store_directory pragma] may modify this variable and cause 4875a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 4876a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [temp_store_directory pragma] always assumes that any string 4877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that this variable points to is held in memory obtained from 4878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_malloc] and the pragma may attempt to free that memory 4879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_free]. 4880a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Hence, if this variable is modified directly, either it should be 4881a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** made NULL or made to point to memory obtained from [sqlite3_malloc] 4882a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or else the use of the [temp_store_directory pragma] should be avoided. 48839bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** Except when requested by the [temp_store_directory pragma], SQLite 48849bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** does not free the memory that sqlite3_temp_directory points to. If 48859bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** the application wants that memory to be freed, it must do 48869bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** so itself, taking care to only do so after all [database connection] 48879bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** objects have been destroyed. 48888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 48898fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <b>Note to Windows Runtime users:</b> The temporary directory must be set 48908fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various 48918fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** features that require the use of temporary files may fail. Here is an 48928fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** example of how to do this using C++ with the Windows Runtime: 48938fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 48948fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <blockquote><pre> 48958fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** LPCWSTR zPath = Windows::Storage::ApplicationData::Current-> 48968fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** TemporaryFolder->Path->Data(); 48978fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** char zPathBuf[MAX_PATH + 1]; 48988fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** memset(zPathBuf, 0, sizeof(zPathBuf)); 48998fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf), 49008fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** NULL, NULL); 49018fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf); 49028fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** </pre></blockquote> 49037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; 49057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 49078fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** CAPI3REF: Name Of The Folder Holding Database Files 49088fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 49098fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^(If this global variable is made to point to a string which is 49108fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the name of a folder (a.k.a. directory), then all database files 49118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** specified with a relative pathname and created or accessed by 49128fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed 49138fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to be relative to that directory.)^ ^If this variable is a NULL 49148fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** pointer, then SQLite assumes that all database files specified 49158fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** with a relative pathname are relative to the current directory 49168fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** for the process. Only the windows VFS makes use of this global 49178fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** variable; it is ignored by the unix VFS. 49188fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 49198fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** Changing the value of this variable while a database connection is 49208fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** open can result in a corrupt database. 49218fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 49228fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** It is not safe to read or modify this variable in more than one 49238fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** thread at a time. It is not safe to read or modify this variable 49248fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** if a [database connection] is being used at the same time in a separate 49258fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** thread. 49268fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** It is intended that this variable be set once 49278fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** as part of process initialization and before any SQLite interface 49288fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** routines have been called and that this variable remain unchanged 49298fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** thereafter. 49308fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 49318fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The [data_store_directory pragma] may modify this variable and cause 49328fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 49338fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the [data_store_directory pragma] always assumes that any string 49348fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** that this variable points to is held in memory obtained from 49358fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_malloc] and the pragma may attempt to free that memory 49368fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** using [sqlite3_free]. 49378fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** Hence, if this variable is modified directly, either it should be 49388fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** made NULL or made to point to memory obtained from [sqlite3_malloc] 49398fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** or else the use of the [data_store_directory pragma] should be avoided. 49408fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich*/ 49418fecf56c625b5691ee3381e107ccbe1ff42398b1Nick KralevichSQLITE_API SQLITE_EXTERN char *sqlite3_data_directory; 49428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich 49438fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich/* 4944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Test For Auto-Commit Mode 4945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {autocommit mode} 49463a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 49477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4948a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_autocommit() interface returns non-zero or 49497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** zero if the given database connection is or is not in autocommit mode, 4950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** respectively. ^Autocommit mode is on by default. 4951a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Autocommit mode is disabled by a [BEGIN] statement. 4952a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 49537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 49547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If certain kinds of errors occur on a statement within a multi-statement 4955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 49567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 49577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** transaction might be rolled back automatically. The only way to 4958a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** find out whether SQLite automatically rolled back the transaction after 49597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an error is to use this function. 49607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4961a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If another thread changes the autocommit status of the database 4962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection while this routine is running, then the return value 4963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is undefined. 49647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 49653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_get_autocommit(sqlite3*); 49667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Find The Database Handle Of A Prepared Statement 49693a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 4970a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_db_handle interface returns the [database connection] handle 4972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to which a [prepared statement] belongs. ^The [database connection] 4973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned by sqlite3_db_handle is the same [database connection] 4974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was the first argument 4975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 4976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** create the statement in the first place. 4977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 49783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3 *SQLITE_STDCALL sqlite3_db_handle(sqlite3_stmt*); 4979a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 4980a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 498190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Return The Filename For A Database Connection 49823a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 498390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 498490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename 498590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** associated with database N of connection D. ^The main database file 498690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** has the name "main". If there is no attached database N on the database 498790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** connection D, or if database N is a temporary or in-memory database, then 498890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a NULL pointer is returned. 498990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 499090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The filename returned by this function is the output of the 499190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** xFullPathname method of the [VFS]. ^In other words, the filename 499290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** will be an absolute pathname, even if the filename used 499390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to open the database originally was a URI or relative pathname. 499490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 49953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API const char *SQLITE_STDCALL sqlite3_db_filename(sqlite3 *db, const char *zDbName); 499690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 499790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 4998c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** CAPI3REF: Determine if a database is read-only 49993a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 5000c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** 5001c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N 5002c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** of connection D is read-only, 0 if it is read/write, or -1 if N is not 5003c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** the name of a database on connection D. 5004c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown*/ 50053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_db_readonly(sqlite3 *db, const char *zDbName); 5006c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown 5007c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown/* 5008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Find the next prepared statement 50093a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 50107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface returns a pointer to the next [prepared statement] after 5012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pStmt associated with the [database connection] pDb. ^If pStmt is NULL 5013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then this interface returns a pointer to the first prepared statement 5014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the database connection pDb. ^If no prepared statement 5015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** satisfies the conditions of this routine, it returns NULL. 50167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5017a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [database connection] pointer D in a call to 5018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_next_stmt(D,S)] must refer to an open database 5019a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection and in particular must not be a NULL pointer. 50207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 50213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_stmt *SQLITE_STDCALL sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 50227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 50237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Commit And Rollback Notification Callbacks 50253a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 50267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_commit_hook() interface registers a callback 5028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function to be invoked whenever a transaction is [COMMIT | committed]. 5029a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to sqlite3_commit_hook() 50307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for the same database connection is overridden. 5031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_rollback_hook() interface registers a callback 5032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. 5033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to sqlite3_rollback_hook() 50347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for the same database connection is overridden. 5035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The pArg argument is passed through to the callback. 5036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the callback on a commit hook function returns non-zero, 5037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the commit is converted into a rollback. 5038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions 5040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return the P argument from the previous call of the same function 5041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the same [database connection] D, or NULL for 5042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first call for each function on D. 5043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 504490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The commit and rollback hook callbacks are not reentrant. 5045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The callback implementation must not do anything that will modify 5046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the callback. Any actions 5047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to modify the database connection must be deferred until after the 5048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** completion of the [sqlite3_step()] call that triggered the commit 5049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or rollback hook in the first place. 505090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Note that running any other SQL statements, including SELECT statements, 505190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify 505290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the database connections for the meaning of "modify" in this paragraph. 5053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Registering a NULL function disables the callback. 5055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5056a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When the commit hook callback routine returns zero, the [COMMIT] 5057a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation is allowed to continue normally. ^If the commit hook 5058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. 5059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The rollback hook is invoked on a rollback that results from a commit 5060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** hook returning non-zero, just as it would be with any other rollback. 5061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the purposes of this API, a transaction is said to have been 50637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** rolled back if an explicit "ROLLBACK" statement is executed, or 50647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an error or constraint causes an implicit rollback to occur. 5065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The rollback callback is not invoked if a transaction is 50667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** automatically rolled back because the database connection is closed. 50677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_update_hook()] interface. 50697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 50703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 50713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 50727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 50737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Data Change Notification Callbacks 50753a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 50767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_update_hook() interface registers a callback function 5078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the [database connection] identified by the first argument 50798fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to be invoked whenever a row is updated, inserted or deleted in 50808fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** a rowid table. 5081a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to this function 5082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the same database connection is overridden. 50837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second argument is a pointer to the function to invoke when a 50858fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** row is updated, inserted or deleted in a rowid table. 5086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the callback is a copy of the third argument 5087a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_update_hook(). 5088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 5089a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_UPDATE], depending on the operation that caused the callback 5090a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be invoked. 5091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth arguments to the callback contain pointers to the 5092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database and table name containing the affected row. 5093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The final callback parameter is the [rowid] of the row. 5094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the case of an update, this is the [rowid] after the update takes place. 5095a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5096a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The update hook is not invoked when internal system tables are 5097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** modified (i.e. sqlite_master and sqlite_sequence).)^ 50988fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified. 5099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the current implementation, the update hook 5101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not invoked when duplication rows are deleted because of an 5102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook 5103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoked when rows are deleted using the [truncate optimization]. 5104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The exceptions defined in this paragraph might change in a future 5105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** release of SQLite. 5106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The update hook implementation must not do anything that will modify 5108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the update hook. Any actions 5109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to modify the database connection must be deferred until after the 5110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** completion of the [sqlite3_step()] call that triggered the update hook. 5111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 5112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 5113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_update_hook(D,C,P) function 5115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns the P argument from the previous call 5116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the same [database connection] D, or NULL for 5117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first call on D. 5118a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] 5120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. 51217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 51223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_update_hook( 51237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 51247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void *,int ,char const *,char const *,sqlite3_int64), 51257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void* 51267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 51277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Shared Pager Cache 51307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine enables or disables the sharing of the database cache 5132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and schema data structures between [database connection | connections] 5133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the same database. Sharing is enabled if the argument is true 5134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and disabled if the argument is false.)^ 51357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Cache sharing is enabled and disabled for an entire process. 5137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, 5138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sharing was enabled or disabled for each thread separately. 51397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The cache sharing mode set by this interface effects all subsequent 51417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 51427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Existing database connections continue use the sharing mode 5143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was in effect at the time they were opened.)^ 51447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled 5146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successfully. An [error code] is returned otherwise.)^ 51477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Shared cache is disabled by default. But this might change in 51497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** future releases of SQLite. Applications that care about shared 51507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cache setting should set it explicitly. 51517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 51523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0 51533fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** and will always return SQLITE_MISUSE. On those systems, 51543fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** shared cache mode should be enabled per-database connection via 51553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE]. 51563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 51578fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** This interface is threadsafe on processors where writing a 51588fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 32-bit integer is atomic. 51598fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 5160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [SQLite Shared-Cache Mode] 51617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 51623fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_enable_shared_cache(int); 51637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Attempt To Free Heap Memory 5166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_release_memory() interface attempts to free N bytes 5168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of heap memory by deallocating non-essential memory allocations 5169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** held by the database library. Memory used to cache database 5170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pages to improve performance is an example of non-essential memory. 5171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^sqlite3_release_memory() returns the number of bytes actually freed, 5172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** which might be more or less than the amount requested. 5173de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_release_memory() routine is a no-op returning zero 5174de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. 517590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 517690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See also: [sqlite3_db_release_memory()] 51777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 51783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_release_memory(int); 51797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 518190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Free Memory Used By A Database Connection 51823a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 518390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 518490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap 518590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** memory as possible from database connection D. Unlike the 51868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_release_memory()] interface, this interface is in effect even 51878fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is 518890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** omitted. 518990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 519090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See also: [sqlite3_release_memory()] 519190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 51923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_db_release_memory(sqlite3*); 519390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 519490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 5195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Impose A Limit On Heap Size 51967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5197de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the 5198de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** soft limit on the amount of heap memory that may be allocated by SQLite. 5199de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite strives to keep heap memory utilization below the soft heap 5200de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** limit by reducing the number of pages held in the page cache 5201de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** as heap memory usages approaches the limit. 5202de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The soft heap limit is "soft" because even though SQLite strives to stay 5203de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** below the limit, it will exceed the limit rather than generate 5204de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** an [SQLITE_NOMEM] error. In other words, the soft heap limit 5205de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is advisory only. 52067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5207de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The return value from sqlite3_soft_heap_limit64() is the size of 520890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the soft heap limit prior to the call, or negative in the case of an 520990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error. ^If the argument N is negative 5210de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** then no change is made to the soft heap limit. Hence, the current 5211de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** size of the soft heap limit can be determined by invoking 5212de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** sqlite3_soft_heap_limit64() with a negative argument. 52137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5214de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the argument N is zero then the soft heap limit is disabled. 52157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5216de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The soft heap limit is not enforced in the current implementation 5217de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** if one or more of following conditions are true: 52187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5219de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <ul> 5220de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> The soft heap limit is set to zero. 5221de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> Memory accounting is disabled using a combination of the 5222de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and 5223de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. 522490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> An alternative page cache implementation is specified using 522590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...). 5226de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> The page cache allocates from its own memory pool supplied 5227de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than 5228de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** from the heap. 5229de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul>)^ 5230de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5231de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Beginning with SQLite version 3.7.3, the soft heap limit is enforced 5232de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] 5233de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], 5234de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the soft heap limit is enforced on every memory allocation. Without 5235de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced 5236de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** when memory is allocated by the page cache. Testing suggests that because 5237de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the page cache is the predominate memory user in SQLite, most 5238de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** applications will achieve adequate soft heap limit enforcement without 5239de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. 5240de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5241de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The circumstances under which SQLite will enforce the soft heap limit may 5242de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** changes in future releases of SQLite. 52437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 52443fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_soft_heap_limit64(sqlite3_int64 N); 5245de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 5246de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 5247de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** CAPI3REF: Deprecated Soft Heap Limit Interface 5248de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** DEPRECATED 5249de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5250de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** This is a deprecated version of the [sqlite3_soft_heap_limit64()] 5251de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** interface. This routine is provided for historical compatibility 5252de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** only. All new applications should use the 5253de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_soft_heap_limit64()] interface rather than this one. 5254de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 52553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_DEPRECATED void SQLITE_STDCALL sqlite3_soft_heap_limit(int N); 5256de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 52577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 52587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Extract Metadata About A Column Of A Table 52603a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 52617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 52623fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns 52633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** information about column C of table T in database D 52643fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** on [database connection] X.)^ ^The sqlite3_table_column_metadata() 52653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** interface returns SQLITE_OK and fills in the non-NULL pointers in 52663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the final five arguments with appropriate values if the specified 52673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** column exists. ^The sqlite3_table_column_metadata() interface returns 52683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** SQLITE_ERROR and if the specified column does not exist. 52693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the column-name parameter to sqlite3_table_column_metadata() is a 52703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** NULL pointer, then this routine simply checks for the existance of the 52713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it 52723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** does not. 52737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The column is identified by the second, third and fourth parameters to 52753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** this function. ^(The second parameter is either the name of the database 5276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (i.e. "main", "temp", or an attached database) containing the specified 52773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** table or NULL.)^ ^If it is NULL, then all attached databases are searched 5278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the table using the same algorithm used by the database engine to 52797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** resolve unqualified table references. 52807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth parameters to this function are the table and column 52823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** name of the desired column, respectively. 52837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Metadata is returned by writing to the memory locations passed as the 5th 5285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and subsequent parameters to this function. ^Any of these arguments may be 5286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL, in which case the corresponding element of metadata is omitted. 52877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<blockquote> 5289a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <table border="1"> 5290a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><th> Parameter <th> Output<br>Type <th> Description 52917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 5th <td> const char* <td> Data type 5293a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 6th <td> const char* <td> Name of default collation sequence 5294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 5295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 5296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] 5297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </table> 5298a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </blockquote>)^ 52997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory pointed to by the character pointers returned for the 53013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** declaration type and collation sequence is valid until the next 5302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to any SQLite API function. 53037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the specified table is actually a view, an [error code] is returned. 53057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 53063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the specified column is "rowid", "oid" or "_rowid_" and the table 53073fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is not a [WITHOUT ROWID] table and an 5308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output 5309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters are set for the explicitly declared column. ^(If there is no 53103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [INTEGER PRIMARY KEY] column, then the outputs 53113fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** for the [rowid] are set as follows: 53127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 53137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <pre> 53147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** data type: "INTEGER" 53157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** collation sequence: "BINARY" 53167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not null: 0 53177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** primary key: 1 53187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** auto increment: 0 5319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre>)^ 53207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 53213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This function causes all database schemas to be read from disk and 53223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** parsed, if that has not already been done, and returns an error if 53233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** any errors are encountered while loading the schema. 53247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 53253fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_table_column_metadata( 53267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Connection handle */ 53277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zDbName, /* Database name or NULL */ 53287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zTableName, /* Table name */ 53297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zColumnName, /* Column name */ 53307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char const **pzDataType, /* OUTPUT: Declared data type */ 53317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 53327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 53337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 53347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pAutoinc /* OUTPUT: True if column is auto-increment */ 53357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 53367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 53377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Load An Extension 53393a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 5340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface loads an SQLite extension library from the named file. 53427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_load_extension() interface attempts to load an 53448fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [SQLite extension] library contained in the file zFile. If 53458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the file cannot be loaded directly, attempts are made to load 53468fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** with various operating-system specific extensions added. 53478fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** So for example, if "samplelib" cannot be loaded, then names like 53488fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might 53498fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** be tried also. 53507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The entry point is zProc. 53528fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^(zProc may be 0, in which case SQLite will try to come up with an 53538fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** entry point name on its own. It first tries "sqlite3_extension_init". 53548fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** If that does not work, it constructs a name "sqlite3_X_init" where the 53558fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** X is consists of the lower-case equivalent of all ASCII alphabetic 53568fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** characters in the filename from the last "/" to the first following 53578fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** "." and omitting any initial "lib".)^ 5358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_load_extension() interface returns 5359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 5360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs and pzErrMsg is not 0, then the 5361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_load_extension()] interface shall attempt to 5362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** fill *pzErrMsg with error message text stored in memory 5363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** obtained from [sqlite3_malloc()]. The calling function 5364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should free this memory by calling [sqlite3_free()]. 53657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Extension loading must be enabled using 5367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_enable_load_extension()] prior to calling this API, 5368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** otherwise an error will be returned. 53697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [load_extension() SQL function]. 53717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 53723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_load_extension( 53737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Load the extension into this database connection */ 53747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zFile, /* Name of the shared library containing extension */ 53757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zProc, /* Entry point. Derived from zFile if 0 */ 53767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char **pzErrMsg /* Put error message here if not 0 */ 53777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 53787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 53797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Extension Loading 53813a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 53827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^So as not to open security holes in older applications that are 53848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** unprepared to deal with [extension loading], and as a means of disabling 53858fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [extension loading] while evaluating user-entered SQL, the following API 5386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 53877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 53888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^Extension loading is off by default. 5389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Call the sqlite3_enable_load_extension() routine with onoff==1 5390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to turn extension loading on and call it with onoff==0 to turn 5391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it back off again. 53927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 53933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_enable_load_extension(sqlite3 *db, int onoff); 53947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 53957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5396de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** CAPI3REF: Automatically Load Statically Linked Extensions 5397de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5398de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^This interface causes the xEntryPoint() function to be invoked for 5399de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** each new [database connection] that is created. The idea here is that 54008fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** xEntryPoint() is the entry point for a statically linked [SQLite extension] 5401de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** that is to be automatically loaded into all new database connections. 5402de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5403de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(Even though the function prototype shows that xEntryPoint() takes 5404de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** no arguments and returns void, SQLite invokes xEntryPoint() with three 5405de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** arguments and expects and integer result as if the signature of the 5406de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** entry point where as follows: 5407de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5408de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <blockquote><pre> 5409de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** int xEntryPoint( 5410de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** sqlite3 *db, 5411de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** const char **pzErrMsg, 5412de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** const struct sqlite3_api_routines *pThunk 5413de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ); 5414de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </pre></blockquote>)^ 54157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5416de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the xEntryPoint routine encounters an error, it should make *pzErrMsg 5417de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** point to an appropriate error message (obtained from [sqlite3_mprintf()]) 5418de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg 5419de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is NULL before calling the xEntryPoint(). ^SQLite will invoke 5420de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any 5421de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], 5422de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. 5423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5424de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Calling sqlite3_auto_extension(X) with an entry point X that is already 5425de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** on the list of automatic extensions is a harmless no-op. ^No entry point 5426de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will be called more than once for each database connection that is opened. 5427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 54288fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** See also: [sqlite3_reset_auto_extension()] 54298fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** and [sqlite3_cancel_auto_extension()] 54307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 54313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_auto_extension(void (*xEntryPoint)(void)); 54327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 54337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 54348fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** CAPI3REF: Cancel Automatic Extension Loading 54358fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 54368fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the 54378fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** initialization routine X that was registered using a prior call to 54388fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)] 54398fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** routine returns 1 if initialization routine X was successfully 54408fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** unregistered and it returns 0 if X was not on the list of initialization 54418fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** routines. 54428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich*/ 54433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_cancel_auto_extension(void (*xEntryPoint)(void)); 54448fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich 54458fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich/* 5446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset Automatic Extension Loading 54477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5448de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^This interface disables all automatic extensions previously 5449de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** registered using [sqlite3_auto_extension()]. 54507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 54513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_reset_auto_extension(void); 54527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 54537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 54547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The interface to the virtual-table mechanism is currently considered 54557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to be experimental. The interface might change in incompatible ways. 54567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If this is a problem for you, do not use the interface at this time. 54577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When the virtual-table mechanism stabilizes, we will declare the 54597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface fixed, support it indefinitely, and remove this comment. 54607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 54617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 54627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 54637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Structures used by the virtual table interface 54647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 54657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vtab sqlite3_vtab; 54667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_index_info sqlite3_index_info; 54677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 54687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_module sqlite3_module; 54697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 54707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Object 5472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: sqlite3_module {virtual table module} 5473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 547490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This structure, sometimes called a "virtual table module", 5475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** defines the implementation of a [virtual tables]. 5476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This structure consists mostly of methods for the module. 5477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A virtual table module is created by filling in a persistent 5479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of this structure and passing a pointer to that instance 5480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. 5481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The registration remains valid until it is replaced by a different 5482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** module or until the [database connection] closes. The content 5483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of this structure must not change while it is registered with 5484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any database connection. 54857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 54867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_module { 54877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iVersion; 54887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCreate)(sqlite3*, void *pAux, 54897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, const char *const*argv, 54907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab **ppVTab, char**); 54917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xConnect)(sqlite3*, void *pAux, 54927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, const char *const*argv, 54937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab **ppVTab, char**); 54947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); 54957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDisconnect)(sqlite3_vtab *pVTab); 54967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDestroy)(sqlite3_vtab *pVTab); 54977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); 54987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xClose)(sqlite3_vtab_cursor*); 54997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, 55007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, sqlite3_value **argv); 55017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xNext)(sqlite3_vtab_cursor*); 55027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xEof)(sqlite3_vtab_cursor*); 55037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); 55047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 55057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 55067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xBegin)(sqlite3_vtab *pVTab); 55077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSync)(sqlite3_vtab *pVTab); 55087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCommit)(sqlite3_vtab *pVTab); 55097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRollback)(sqlite3_vtab *pVTab); 55107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 55117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 55127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void **ppArg); 55137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 551490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown /* The methods above are in version 1 of the sqlite_module object. Those 551590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown ** below are for version 2 and greater. */ 551690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xSavepoint)(sqlite3_vtab *pVTab, int); 551790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xRelease)(sqlite3_vtab *pVTab, int); 551890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xRollbackTo)(sqlite3_vtab *pVTab, int); 55197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 55207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 55217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Indexing Information 55237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite3_index_info 55247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5525de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The sqlite3_index_info structure and its substructures is used as part 5526de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of the [virtual table] interface to 5527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pass information into and receive the reply from the [xBestIndex] 5528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** method of a [virtual table module]. The fields under **Inputs** are the 55297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** inputs to xBestIndex and are read-only. xBestIndex inserts its 55307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** results into the **Outputs** fields. 55317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The aConstraint[] array records WHERE clause constraints of the form: 55337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5534de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <blockquote>column OP expr</blockquote> 55357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is 5537de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** stored in aConstraint[].op using one of the 5538de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ 5539de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The index of the column is stored in 5540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the 55417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expr on the right-hand side can be evaluated (and thus the constraint 5542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is usable) and false if it cannot.)^ 55437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The optimizer automatically inverts terms of the form "expr OP column" 55457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and makes other simplifications to the WHERE clause in an attempt to 55467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** get as many WHERE clause terms into the form shown above as possible. 5547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The aConstraint[] array only reports WHERE clause terms that are 5548a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** relevant to the particular virtual table being queried. 55497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Information about the ORDER BY clause is stored in aOrderBy[]. 5551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each term of aOrderBy records a column of the ORDER BY clause. 55527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [xBestIndex] method must fill aConstraintUsage[] with information 5554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** about what parameters to pass to xFilter. ^If argvIndex>0 then 55557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the right-hand side of the corresponding aConstraint[] is evaluated 5556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit 55577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is true, then the constraint is assumed to be fully handled by the 5558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** virtual table and is not checked again by SQLite.)^ 55597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The idxNum and idxPtr values are recorded and passed into the 5561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [xFilter] method. 5562a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[sqlite3_free()] is used to free idxPtr if and only if 5563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** needToFreeIdxPtr is true. 55647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in 55667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the correct order to satisfy the ORDER BY clause so that no separate 55677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sorting step is required. 55687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 55698fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The estimatedCost value is an estimate of the cost of a particular 55708fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** strategy. A cost of N indicates that the cost of the strategy is similar 55718fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to a linear scan of an SQLite table with N rows. A cost of log(N) 55728fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** indicates that the expense of the operation is similar to that of a 55738fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** binary search on a unique indexed field of an SQLite table with N rows. 55748fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 55758fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The estimatedRows value is an estimate of the number of rows that 55768fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** will be returned by the strategy. 55778fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 55788fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info 55798fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** structure for SQLite version 3.8.2. If a virtual table extension is 55808fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** used with an SQLite version earlier than 3.8.2, the results of attempting 55818fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to read or write the estimatedRows field are undefined (but are likely 55828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to included crashing the application). The estimatedRows field should 55838fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** therefore only be used if [sqlite3_libversion_number()] returns a 55848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** value greater than or equal to 3008002. 55857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 55867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_index_info { 55877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Inputs */ 55887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nConstraint; /* Number of entries in aConstraint */ 55897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_constraint { 55907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iColumn; /* Column on left-hand side of constraint */ 55917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char op; /* Constraint operator */ 55927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char usable; /* True if this constraint is usable */ 55937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iTermOffset; /* Used internally - xBestIndex should ignore */ 55947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aConstraint; /* Table of WHERE clause constraints */ 55957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nOrderBy; /* Number of terms in the ORDER BY clause */ 55967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_orderby { 55977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iColumn; /* Column number */ 55987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char desc; /* True for DESC. False for ASC. */ 55997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aOrderBy; /* The ORDER BY clause */ 56007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Outputs */ 56017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_constraint_usage { 56027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argvIndex; /* if >0, constraint is part of argv to xFilter */ 56037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char omit; /* Do not code a test for this constraint */ 56047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aConstraintUsage; 56057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int idxNum; /* Number used to identify the index */ 56067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 56077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 56087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int orderByConsumed; /* True if output is already ordered */ 56098fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich double estimatedCost; /* Estimated cost of using this index */ 56108fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich /* Fields below are only available in SQLite 3.8.2 and later */ 56118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ 56127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 5613de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 5614de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 5615de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** CAPI3REF: Virtual Table Constraint Operator Codes 5616de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5617de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** These macros defined the allowed values for the 5618de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_index_info].aConstraint[].op field. Each value represents 5619de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** an operator that is part of a constraint term in the wHERE clause of 5620de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** a query that uses a [virtual table]. 5621de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 56227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_EQ 2 56237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_GT 4 56247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_LE 8 56257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_LT 16 56267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_GE 32 56277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_MATCH 64 56287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 56297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Register A Virtual Table Implementation 56313a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 5632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines are used to register a new [virtual table module] name. 5634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Module names must be registered before 5635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** creating a new [virtual table] using the module and before using a 5636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** preexisting [virtual table] for the module. 5637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The module name is registered on the [database connection] specified 5639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the first parameter. ^The name of the module is given by the 5640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** second parameter. ^The third parameter is a pointer to 5641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the implementation of the [virtual table module]. ^The fourth 5642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter is an arbitrary client data pointer that is passed through 5643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the [xCreate] and [xConnect] methods of the virtual table module 5644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when a new virtual table is be being created or reinitialized. 5645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_create_module_v2() interface has a fifth parameter which 5647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a pointer to a destructor for the pClientData. ^SQLite will 5648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoke the destructor function (if it is not NULL) when SQLite 564995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** no longer needs the pClientData pointer. ^The destructor will also 565095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** be invoked if the call to sqlite3_create_module_v2() fails. 565195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The sqlite3_create_module() 5652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is equivalent to sqlite3_create_module_v2() with a NULL 5653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** destructor. 56547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 56553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_module( 56567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* SQLite connection to register module with */ 56577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, /* Name of the module */ 5658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const sqlite3_module *p, /* Methods for the module */ 5659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pClientData /* Client data for xCreate/xConnect */ 56607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 56613fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_create_module_v2( 56627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* SQLite connection to register module with */ 56637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, /* Name of the module */ 5664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const sqlite3_module *p, /* Methods for the module */ 5665a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pClientData, /* Client data for xCreate/xConnect */ 56667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xDestroy)(void*) /* Module destructor function */ 56677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 56687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 56697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Instance Object 56717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite3_vtab 5672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every [virtual table module] implementation uses a subclass 5674a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of this object to describe a particular instance 5675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [virtual table]. Each subclass will 5676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be tailored to the specific needs of the module implementation. 5677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The purpose of this superclass is to define certain fields that are 5678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** common to all module implementations. 5679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Virtual tables methods can set an error message by assigning a 5681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 5682a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** take care that any prior string is freed by a call to [sqlite3_free()] 5683a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to assigning a new string to zErrMsg. ^After the error message 56847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is delivered up to the client application, the string will be automatically 5685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** freed by sqlite3_free() and the zErrMsg field will be zeroed. 56867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 56877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vtab { 56887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const sqlite3_module *pModule; /* The module for this virtual table */ 56893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich int nRef; /* Number of open cursors */ 56907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char *zErrMsg; /* Error message from sqlite3_mprintf() */ 56917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Virtual table implementations will typically add additional fields */ 56927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 56937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 56947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Cursor Object 5696a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} 56977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every [virtual table module] implementation uses a subclass of the 5699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following structure to describe cursors that point into the 5700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [virtual table] and are used 57017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to loop through the virtual table. Cursors are created using the 5702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed 5703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the [sqlite3_module.xClose | xClose] method. Cursors are used 5704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods 5705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the module. Each module implementation will define 57067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the content of a cursor structure to suit its own needs. 57077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This superclass exists in order to define fields of the cursor that 57097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are common to all implementations. 57107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 57117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vtab_cursor { 57127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 57137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Virtual table implementations will typically add additional fields */ 57147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 57157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 57167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Declare The Schema Of A Virtual Table 57187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5719a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [xCreate] and [xConnect] methods of a 5720a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [virtual table module] call this interface 57217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to declare the format (the names and datatypes of the columns) of 57227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the virtual tables they implement. 57237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 57243fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_declare_vtab(sqlite3*, const char *zSQL); 57257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 57267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Overload A Function For A Virtual Table 57283a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 57297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Virtual tables can provide alternative implementations of functions 5731a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using the [xFindFunction] method of the [virtual table module]. 5732a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** But global versions of those functions 5733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must exist in order to be overloaded.)^ 57347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This API makes sure a global version of a function with a particular 57367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** name and number of parameters exists. If no such function exists 5737a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before this API is called, a new function is created.)^ ^The implementation 57387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the new function always causes an exception to be thrown. So 57397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the new function is not good for anything by itself. Its only 5740a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purpose is to be a placeholder function that can be overloaded 5741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a [virtual table]. 57427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 57433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); 57447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 57457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 57467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The interface to the virtual-table mechanism defined above (back up 57477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to a comment remarkably similar to this one) is currently considered 57487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to be experimental. The interface might change in incompatible ways. 57497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If this is a problem for you, do not use the interface at this time. 57507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the virtual-table mechanism stabilizes, we will declare the 57527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface fixed, support it indefinitely, and remove this comment. 57537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 57547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 57557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: A Handle To An Open BLOB 5757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {BLOB handle} {BLOB handles} 57587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An instance of this object represents an open BLOB on which 5760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 5761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Objects of this type are created by [sqlite3_blob_open()] 5762a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and destroyed by [sqlite3_blob_close()]. 5763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 5764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be used to read or write small subsections of the BLOB. 5765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 57667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 57677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_blob sqlite3_blob; 57687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 57697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5770a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Open A BLOB For Incremental I/O 57713a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 57723a6c79f802fabdb94367177310663397420e319fNick Kralevich** CONSTRUCTOR: sqlite3_blob 57737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located 57757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in row iRow, column zColumn, table zTable in database zDb; 5776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in other words, the same BLOB that would be selected by: 57777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <pre> 5779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; 5780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre>)^ 57817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(Parameter zDb is not the filename that contains the database, but 57833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** rather the symbolic name of the database. For attached databases, this is 57843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the name that appears after the AS keyword in the [ATTACH] statement. 57853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** For the main database file, the database name is "main". For TEMP 57863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** tables, the database name is "temp".)^ 57873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 5788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the flags parameter is non-zero, then the BLOB is opened for read 57893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** and write access. ^If the flags parameter is zero, the BLOB is opened for 57903fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** read-only access. 57913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 57923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored 57933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** in *ppBlob. Otherwise an [error code] is returned and, unless the error 57943fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided 57953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the API is not misused, it is always safe to call [sqlite3_blob_close()] 57963fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** on *ppBlob after this function it returns. 57973fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 57983fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** This function fails with SQLITE_ERROR if any of the following are true: 57993fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <ul> 58003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Database zDb does not exist)^, 58013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Table zTable does not exist within database zDb)^, 58023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Table zTable is a WITHOUT ROWID table)^, 58033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Column zColumn does not exist)^, 58043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Row iRow is not present in the table)^, 58053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(The specified column of row iRow contains a value that is not 58063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** a TEXT or BLOB value)^, 58073fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE 58083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** constraint and the blob is being opened for read/write access)^, 58093fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> ^([foreign key constraints | Foreign key constraints] are enabled, 58103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** column zColumn is part of a [child key] definition and the blob is 58113fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** being opened for read/write access)^. 58123fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** </ul> 58133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 58143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Unless it returns SQLITE_MISUSE, this function sets the 58153fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [database connection] error code and message accessible via 58163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. 58173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 5818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5819a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If the row that a BLOB handle points to is modified by an 5820a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 5821a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the BLOB handle is marked as "expired". 5822a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This is true if any column of the row is changed, even a column 5823a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** other than the one the BLOB handle is open on.)^ 5824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 582590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. 5826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Changes written into a BLOB prior to the BLOB expiring are not 5827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rolled back by the expiration of the BLOB. Such changes will eventually 5828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** commit if the transaction continues to completion.)^ 5829a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Use the [sqlite3_blob_bytes()] interface to determine the size of 5831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the opened blob. ^The size of a blob may not be changed by this 5832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface. Use the [UPDATE] SQL command to change the size of a 5833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blob. 5834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces 58363fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** and the built-in [zeroblob] SQL function may be used to create a 58373fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** zero-filled blob to read or write using the incremental-blob interface. 5838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid a resource leak, every open [BLOB handle] should eventually 5840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be released by a call to [sqlite3_blob_close()]. 58417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 58423fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_blob_open( 58437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 58447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zDb, 58457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zTable, 58467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zColumn, 58477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_int64 iRow, 58487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, 58497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_blob **ppBlob 58507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 58517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 58527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 585395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** CAPI3REF: Move a BLOB Handle to a New Row 58543a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_blob 585595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 585695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^This function is used to move an existing blob handle so that it points 585795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** to a different row of the same database table. ^The new row is identified 585895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** by the rowid value passed as the second argument. Only the row can be 585995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** changed. ^The database, table and column on which the blob handle is open 586095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** remain the same. Moving an existing blob handle to a new row can be 586195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** faster than closing the existing handle and opening a new one. 586295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 586395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - 586495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** it must exist and there must be either a blob or text value stored in 586595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** the nominated column.)^ ^If the new row is not present in the table, or if 586695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** it does not contain a blob or text value, or if another error occurs, an 586795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** SQLite error code is returned and the blob handle is considered aborted. 586895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or 586995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** [sqlite3_blob_reopen()] on an aborted blob handle immediately return 587095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle 587195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** always returns zero. 587295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 587395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^This function sets the database handle error code and message. 587495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori*/ 58753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_EXPERIMENTAL int SQLITE_STDCALL sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); 587695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori 587795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori/* 5878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Close A BLOB Handle 58793a6c79f802fabdb94367177310663397420e319fNick Kralevich** DESTRUCTOR: sqlite3_blob 58807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 58813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed 58823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** unconditionally. Even if this routine returns an error code, the 58833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** handle is still closed.)^ 58847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 58853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If the blob handle being closed was opened for read-write access, and if 58863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the database is in auto-commit mode and there are no other open read-write 58873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** blob handles or active write statements, the current transaction is 58883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** committed. ^If an error occurs while committing the transaction, an error 58893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** code is returned and the transaction rolled back. 58907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 58913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Calling this function with an argument that is not a NULL pointer or an 58923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** open blob handle results in undefined behaviour. ^Calling this routine 58933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** with a null pointer (such as would be returned by a failed call to 58943fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function 58953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is passed a valid open blob handle, the values returned by the 58963fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning. 58977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 58983fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_blob_close(sqlite3_blob *); 58997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 59007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5901a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Return The Size Of An Open BLOB 59023a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_blob 59037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Returns the size in bytes of the BLOB accessible via the 5905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successfully opened [BLOB handle] in its only argument. ^The 5906a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** incremental blob I/O routines can only read or overwriting existing 5907a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blob content; they cannot change the size of a blob. 59087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 5910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 5911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 5912a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 59137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 59143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_blob_bytes(sqlite3_blob *); 59157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 59167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Read Data From A BLOB Incrementally 59183a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_blob 59197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This function is used to read data from an open [BLOB handle] into a 5921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller-supplied buffer. N bytes of data are copied into buffer Z 5922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from the open BLOB, starting at offset iOffset.)^ 59237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If offset iOffset is less than N bytes from the end of the BLOB, 5925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is 5926a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** less than zero, [SQLITE_ERROR] is returned and no data is read. 5927a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The size of the blob (and hence the maximum value of N+iOffset) 5928a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be determined using the [sqlite3_blob_bytes()] interface. 59297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An attempt to read from an expired [BLOB handle] fails with an 5931a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code of [SQLITE_ABORT]. 59327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(On success, sqlite3_blob_read() returns SQLITE_OK. 5934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise, an [error code] or an [extended error code] is returned.)^ 59357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 5937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 5938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 5939a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 59407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5941a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_blob_write()]. 59427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 59433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 59447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 59457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Write Data Into A BLOB Incrementally 59473a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_blob 59487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 59493fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(This function is used to write data into an open [BLOB handle] from a 59503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** caller-supplied buffer. N bytes of data are copied from the buffer Z 59513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** into the open BLOB, starting at offset iOffset.)^ 59523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 59533fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(On success, sqlite3_blob_write() returns SQLITE_OK. 59543fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Otherwise, an [error code] or an [extended error code] is returned.)^ 59553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Unless SQLITE_MISUSE is returned, this function sets the 59563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [database connection] error code and message accessible via 59573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions. 59587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5959a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [BLOB handle] passed as the first argument was not opened for 5960a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** writing (the flags parameter to [sqlite3_blob_open()] was zero), 5961a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this function returns [SQLITE_READONLY]. 59627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 59633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** This function may only modify the contents of the BLOB; it is 5964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not possible to increase the size of a BLOB using this API. 5965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If offset iOffset is less than N bytes from the end of the BLOB, 59663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [SQLITE_ERROR] is returned and no data is written. The size of the 59673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** BLOB (and hence the maximum value of N+iOffset) can be determined 59683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less 59693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** than zero [SQLITE_ERROR] is returned and no data is written. 59707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An attempt to write to an expired [BLOB handle] fails with an 5972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred 5973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before the [BLOB handle] expired are not rolled back by the 5974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** expiration of the handle, though of course those changes might 5975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have been overwritten by the statement that expired the BLOB handle 5976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or by other independent statements. 59777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 5979a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 5980a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 5981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 59827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5983a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_blob_read()]. 59847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 59853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); 59867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 59877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual File System Objects 59897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 59907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A virtual filesystem (VFS) is an [sqlite3_vfs] object 59917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that SQLite uses to interact 59927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the underlying operating system. Most SQLite builds come with a 59937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** single default VFS that is appropriate for the host computer. 59947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** New VFSes can be registered and existing VFSes can be unregistered. 59957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The following interfaces are provided. 59967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5997a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 5998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Names are case sensitive. 5999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Names are zero-terminated UTF-8 strings. 6000a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If there is no match, a NULL pointer is returned. 6001a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If zVfsName is NULL then the default VFS is returned. 6002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6003a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^New VFSes are registered with sqlite3_vfs_register(). 6004a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each new VFS becomes the default VFS if the makeDflt flag is set. 6005a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The same VFS can be registered multiple times without injury. 6006a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^To make an existing VFS into the default VFS, register it again 60077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the makeDflt flag set. If two different VFSes with the 60087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** same name are registered, the behavior is undefined. If a 60097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** VFS is registered with a name that is NULL or an empty string, 60107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then the behavior is undefined. 60117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. 6013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If the default VFS is unregistered, another VFS is chosen as 6014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the default. The choice for the new VFS is arbitrary.)^ 60157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 60163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_vfs *SQLITE_STDCALL sqlite3_vfs_find(const char *zVfsName); 60173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 60183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_vfs_unregister(sqlite3_vfs*); 60197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 60207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 6021a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutexes 60227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 60237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLite core uses these routines for thread 6024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** synchronization. Though they are intended for internal 60257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use by SQLite, code that links against SQLite is 60267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** permitted to use any of these routines. 60277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLite source code contains multiple implementations 60297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of these mutex routines. An appropriate implementation 60303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is selected automatically at compile-time. The following 60317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementations are available in the SQLite core: 60327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 60337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 603490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> SQLITE_MUTEX_PTHREADS 60357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_W32 60367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_NOOP 60373fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** </ul> 60387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 60393fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The SQLITE_MUTEX_NOOP implementation is a set of routines 6040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that does no real locking and is appropriate for use in 60413fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** a single-threaded application. The SQLITE_MUTEX_PTHREADS and 60428fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix 60438fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** and Windows. 6044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 60453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 60467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 6047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation is included with the library. In this case the 6048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application must supply a custom mutex implementation using the 6049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 6050a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before calling sqlite3_initialize() or any other public sqlite3_ 60513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** function that calls sqlite3_initialize(). 6052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_alloc() routine allocates a new 60543fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc() 60553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** routine returns NULL if it is unable to allocate the requested 60563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** mutex. The argument to sqlite3_mutex_alloc() must one of these 60573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** integer constants: 60587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 60597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 60607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_FAST 60617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_RECURSIVE 60627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MASTER 60637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MEM 60649bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** <li> SQLITE_MUTEX_STATIC_OPEN 60657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_PRNG 60667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_LRU 60679bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** <li> SQLITE_MUTEX_STATIC_PMEM 60689bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** <li> SQLITE_MUTEX_STATIC_APP1 60699bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** <li> SQLITE_MUTEX_STATIC_APP2 60703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <li> SQLITE_MUTEX_STATIC_APP3 60713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** </ul> 60727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) 6074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cause sqlite3_mutex_alloc() to create 6075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 6076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is used but not necessarily so when SQLITE_MUTEX_FAST is used. 60777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The mutex implementation does not need to make a distinction 60787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 60793fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** not want to. SQLite will only request a recursive mutex in 60803fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** cases where it really needs one. If a faster non-recursive mutex 60817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementation is available on the host platform, the mutex subsystem 60827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might return such a mutex in response to SQLITE_MUTEX_FAST. 60837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other 6085a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return 60863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** a pointer to a static preexisting mutex. ^Nine static mutexes are 60877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used by the current version of SQLite. Future versions of SQLite 60887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may add additional static mutexes. Static mutexes are for internal 60897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use by SQLite only. Applications that use SQLite mutexes should 60907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 60917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_MUTEX_RECURSIVE. 60927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 60947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 60953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** returns a different mutex on every call. ^For the static 60967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mutex types, the same mutex is returned on every call that has 6097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same type number. 60987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_free() routine deallocates a previously 61003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** allocated dynamic mutex. Attempting to deallocate a static 61013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** mutex results in undefined behavior. 61027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 6104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to enter a mutex. ^If another thread is already within the mutex, 61057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 6106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] 6107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** upon successful entry. ^(Mutexes created using 61087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 61093fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** In such cases, the 61107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mutex must be exited an equal number of times before another thread 61113fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** can enter.)^ If the same thread tries to enter any mutex other 61123fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined. 61137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Some systems (for example, Windows 95) do not support the operation 6115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 61163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** will always return SQLITE_BUSY. The SQLite core only ever uses 61173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_mutex_try() as an optimization so this is acceptable 61183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** behavior.)^ 61197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_leave() routine exits a mutex that was 61213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** previously entered by the same thread. The behavior 61227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is undefined if the mutex is not currently entered by the 61233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** calling thread or is not currently allocated. 6124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 6126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_mutex_leave() is a NULL pointer, then all three routines 6127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** behave as no-ops. 61287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 61297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 61307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 61313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_mutex *SQLITE_STDCALL sqlite3_mutex_alloc(int); 61323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_mutex_free(sqlite3_mutex*); 61333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_mutex_enter(sqlite3_mutex*); 61343fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_mutex_try(sqlite3_mutex*); 61353fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_STDCALL sqlite3_mutex_leave(sqlite3_mutex*); 61367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 61377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 6138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Methods Object 6139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this structure defines the low-level routines 6141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** used to allocate and use mutexes. 6142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Usually, the default mutex implementations provided by SQLite are 61443fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sufficient, however the application has the option of substituting a custom 6145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation for specialized deployments or systems for which SQLite 61463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** does not provide a suitable implementation. In this case, the application 6147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** creates and populates an instance of this structure to pass 6148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 6149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Additionally, an instance of this structure can be used as an 6150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** output variable when querying the system for the current mutex 6151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 6152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xMutexInit method defined by this structure is invoked as 6154a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** part of system initialization by the sqlite3_initialize() function. 6155de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xMutexInit routine is called by SQLite exactly once for each 6156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** effective call to [sqlite3_initialize()]. 6157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xMutexEnd method defined by this structure is invoked as 6159a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** part of system shutdown by the sqlite3_shutdown() function. The 6160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of this method is expected to release all outstanding 6161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resources obtained by the mutex methods implementation, especially 6162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** those obtained by the xMutexInit method. ^The xMutexEnd() 6163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is invoked exactly once for each call to [sqlite3_shutdown()]. 6164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The remaining seven methods defined by this structure (xMutexAlloc, 6166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 6167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexNotheld) implement the following interfaces (respectively): 6168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 6170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_alloc()] </li> 6171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_free()] </li> 6172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_enter()] </li> 6173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_try()] </li> 6174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_leave()] </li> 6175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_held()] </li> 6176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_notheld()] </li> 6177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 6178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The only difference is that the public sqlite3_XXX functions enumerated 6180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** above silently ignore any invocations that pass a NULL pointer instead 6181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of a valid mutex handle. The implementations of the methods defined 6182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by this structure are not required to handle this case, the results 6183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of passing a NULL pointer instead of a valid mutex handle are undefined 6184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (i.e. it is acceptable to provide an implementation that segfaults if 6185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is passed a NULL pointer). 6186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 61873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The xMutexInit() method must be threadsafe. It must be harmless to 6188de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** invoke xMutexInit() multiple times within the same process and without 6189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** intervening calls to xMutexEnd(). Second and subsequent calls to 6190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexInit() must be no-ops. 6191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 61923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] 61933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** and its associates). Similarly, xMutexAlloc() must not use SQLite memory 6194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation for a static mutex. ^However xMutexAlloc() may use SQLite 6195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation for a fast or recursive mutex. 6196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is 6198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called, but only if the prior call to xMutexInit returned SQLITE_OK. 6199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If xMutexInit fails in any way, it is expected to clean up after itself 6200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to returning. 6201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 6203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_mutex_methods { 6204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexInit)(void); 6205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexEnd)(void); 6206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3_mutex *(*xMutexAlloc)(int); 6207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexFree)(sqlite3_mutex *); 6208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexEnter)(sqlite3_mutex *); 6209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexTry)(sqlite3_mutex *); 6210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexLeave)(sqlite3_mutex *); 6211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexHeld)(sqlite3_mutex *); 6212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexNotheld)(sqlite3_mutex *); 6213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 6214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Verification Routines 62177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 62187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 62193fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** are intended for use inside assert() statements. The SQLite core 62207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** never uses these routines except inside an assert() and applications 62213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** are advised to follow the lead of the core. The SQLite core only 62227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** provides implementations for these routines when it is compiled 62233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** with the SQLITE_DEBUG flag. External mutex implementations 62247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are only required to provide these routines if SQLITE_DEBUG is 62257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** defined and if NDEBUG is not defined. 62267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 62273fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** These routines should return true if the mutex in their argument 6228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is held or not held, respectively, by the calling thread. 62297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 62303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The implementation is not required to provide versions of these 6231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines that actually work. If the implementation does not provide working 6232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** versions of these routines, it should at least provide stubs that always 6233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return true so that one does not get spurious assertion failures. 62347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 62353fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** If the argument to sqlite3_mutex_held() is a NULL pointer then 6236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the routine should return 1. This seems counter-intuitive since 623790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** clearly the mutex cannot be held if it does not exist. But 62387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the reason the mutex does not exist is because the build is not 62397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** using mutexes. And we do not want the assert() containing the 62407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** call to sqlite3_mutex_held() to fail, so a non-zero return is 62413fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the appropriate thing to do. The sqlite3_mutex_notheld() 62427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface should also return 1 when given a NULL pointer. 62437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 6244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef NDEBUG 62453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_mutex_held(sqlite3_mutex*); 62463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_mutex_notheld(sqlite3_mutex*); 6247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 62487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 62497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 6250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Types 6251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_mutex_alloc()] interface takes a single argument 6253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** which is one of these integer constants. 62547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The set of static mutexes may change from one SQLite release to the 6256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** next. Applications that override the built-in mutex logic must be 6257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prepared to accommodate additional static mutexes. 62587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 62597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_FAST 0 62607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_RECURSIVE 1 62617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_MASTER 2 62627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 6263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 6264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 62657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ 62667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 626790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ 626890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ 62699bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */ 62709bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */ 62719bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */ 62727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 62737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 6274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Retrieve the mutex for a database connection 62753a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 62767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface returns a pointer the [sqlite3_mutex] object that 6278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** serializes access to the [database connection] given in the argument 6279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the [threading mode] is Serialized. 6280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [threading mode] is Single-thread or Multi-thread then this 6281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine returns a NULL pointer. 6282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 62833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_mutex *SQLITE_STDCALL sqlite3_db_mutex(sqlite3*); 6284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Low-Level Control Of Database Files 62873a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 6288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6289a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_file_control()] interface makes a direct call to the 62907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** xFileControl method for the [sqlite3_io_methods] object associated 6291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with a particular database identified by the second argument. ^The 629295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** name of the database is "main" for the main database or "temp" for the 6293a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** TEMP database, or the name that appears after the AS keyword for 6294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** databases that are added using the [ATTACH] SQL command. 6295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A NULL pointer can be used in place of "main" to refer to the 6296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** main database file. 6297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth parameters to this routine 62987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are passed directly through to the second and third parameters of 6299a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xFileControl method. ^The return value of the xFileControl 63007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method becomes the return value of this routine. 63017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 630295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes 630395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** a pointer to the underlying [sqlite3_file] object to be written into 630495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER 630595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** case is a short-circuit path which does not actually invoke the 630695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** underlying sqlite3_io_methods.xFileControl method. 630795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 6308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the second parameter (zDbName) does not match the name of any 6309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** open database file, then SQLITE_ERROR is returned. ^This error 63107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** code is not remembered and will not be recalled by [sqlite3_errcode()] 6311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_errmsg()]. The underlying xFileControl method might 6312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also return SQLITE_ERROR. There is no way to distinguish between 63137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an incorrect zDbName and an SQLITE_ERROR return from the underlying 6314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xFileControl method. 63157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 63167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [SQLITE_FCNTL_LOCKSTATE] 63177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 63183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); 63197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 63207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 6321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Testing Interface 63227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_test_control() interface is used to read out internal 63247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** state of SQLite and to inject faults into SQLite for testing 6325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purposes. ^The first parameter is an operation code that determines 63267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number, meaning, and operation of all subsequent parameters. 63277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 63287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This interface is not for use by applications. It exists solely 63297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for verifying the correct operation of the SQLite library. Depending 63307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on how the SQLite library is compiled, this interface might not exist. 63317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 63327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The details of the operation codes, their meanings, the parameters 63337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they take, and what they do are all subject to change without notice. 63347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Unlike most of the SQLite API, this function is not guaranteed to 63357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** operate consistently from one release to the next. 63367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 63373fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_CDECL sqlite3_test_control(int op, ...); 63387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 63397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 6340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Testing Interface Operation Codes 63417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 63427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constants are the valid operation code parameters used 63437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as the first argument to [sqlite3_test_control()]. 63447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These parameters and their meanings are subject to change 63467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** without notice. These values are for testing purposes only. 63477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Applications should not use any of these parameters or the 63487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_test_control()] interface. 63497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 6350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_FIRST 5 63517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_SAVE 5 63527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_RESTORE 6 63537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_RESET 7 63547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_BITVEC_TEST 8 6355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_FAULT_INSTALL 9 6356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 6357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_PENDING_BYTE 11 6358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ASSERT 12 6359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ALWAYS 13 6360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_RESERVE 14 6361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 6362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ISKEYWORD 16 636390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 636490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 63653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */ 63668fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_TESTCTRL_NEVER_CORRUPT 20 63678fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_TESTCTRL_VDBE_COVERAGE 21 63681c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#define SQLITE_TESTCTRL_BYTEORDER 22 63699bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown#define SQLITE_TESTCTRL_ISINIT 23 63703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_TESTCTRL_SORTER_MMAP 24 63713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_TESTCTRL_IMPOSTER 25 63723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_TESTCTRL_LAST 25 6373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6374a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQLite Runtime Status 6376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 63773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^These interfaces are used to retrieve runtime status information 6378de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** about the performance of SQLite, and optionally to reset various 6379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** highwater marks. ^The first argument is an integer code for 6380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the specific parameter to measure. ^(Recognized integer codes 638190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are of the form [status parameters | SQLITE_STATUS_...].)^ 6382a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the parameter is returned into *pCurrent. 6383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The highest recorded value is returned in *pHighwater. ^If the 6384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resetFlag is true, then the highest record value is reset after 6385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater is written. ^(Some parameters do not record the highest 6386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value. For those parameters 6387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nothing is written into *pHighwater and the resetFlag is ignored.)^ 6388a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Other parameters record only the highwater mark and not the current 6389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value. For these latter parameters nothing is written into *pCurrent.)^ 6390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 63913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_status() and sqlite3_status64() routines return 63923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** SQLITE_OK on success and a non-zero [error code] on failure. 6393a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 63943fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** If either the current value or the highwater mark is too large to 63953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** be represented by a 32-bit integer, then the values returned by 63963fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_status() are undefined. 6397a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_db_status()] 6399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 64003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 64013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_status64( 64023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich int op, 64033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich sqlite3_int64 *pCurrent, 64043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich sqlite3_int64 *pHighwater, 64053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich int resetFlag 64063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich); 6407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters 641190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {status parameters} 6412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These integer constants designate various run-time status parameters 6414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be returned by [sqlite3_status()]. 6415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 641790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> 6418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter is the current amount of memory checked out 6419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_malloc()], either directly or indirectly. The 6420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** figure includes calls made to [sqlite3_malloc()] by the application 6421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and internal memory usage by the SQLite library. Scratch memory 6422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache 6423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 6424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this parameter. The amount returned is the sum of the allocation 6425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ 6426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 642790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> 6428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 6429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 6430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** internal equivalents). Only the value returned in the 6431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 6432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 6433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 643490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> 643590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter records the number of separate memory allocations 643690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** currently checked out.</dd>)^ 6437de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 643890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> 6439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of pages used out of the 6440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [pagecache memory allocator] that was configured using 6441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_PAGECACHE]. The 6442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value returned is in pages, not in bytes.</dd>)^ 6443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 644490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] 6445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 6446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of bytes of page cache 6447de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] 6448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** buffer and where forced to overflow to [sqlite3_malloc()]. The 6449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned value includes allocations that overflowed because they 6450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** where too large (they were larger than the "sz" parameter to 6451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 6452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** no space was left in the page cache.</dd>)^ 6453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 645490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 6455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 6456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [pagecache memory allocator]. Only the value returned in the 6457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 6458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 6459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 646090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> 6461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of allocations used out of the 6462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [scratch memory allocator] configured using 6463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not 6464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in bytes. Since a single thread may only have one scratch allocation 6465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** outstanding at time, this parameter also reports the number of threads 6466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using scratch memory at the same time.</dd>)^ 6467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 646890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 6469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of bytes of scratch memory 6470de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] 6471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** buffer and where forced to overflow to [sqlite3_malloc()]. The values 6472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned include overflows because the requested allocation was too 6473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** larger (that is, because the requested allocation was larger than the 6474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer 6475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots were available. 6476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dd>)^ 6477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 647890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 6479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 6480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [scratch memory allocator]. Only the value returned in the 6481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 6482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 6483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 648490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> 6485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the deepest parser stack. It is only 6486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ 6487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 6488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New status parameters may be added from time to time. 6490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_MEMORY_USED 0 6492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_USED 1 6493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 6494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_USED 3 6495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 6496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_MALLOC_SIZE 5 6497a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PARSER_STACK 6 6498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_SIZE 7 6499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_SIZE 8 6500de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_STATUS_MALLOC_COUNT 9 6501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6502a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6503a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection Status 65043a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 6505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface is used to retrieve runtime status information 6507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** about a single [database connection]. ^The first argument is the 6508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection object to be interrogated. ^The second argument 650971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is an integer constant, taken from the set of 651090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_DBSTATUS options], that 6511de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** determines the parameter to interrogate. The set of 651290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_DBSTATUS options] is likely 651371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to grow in future releases of SQLite. 6514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the requested parameter is written into *pCur 6516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the highest instantaneous value is written into *pHiwtr. ^If 6517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the resetFlg is true, then the highest instantaneous value is 6518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** reset back down to the current value. 6519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6520de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a 6521de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** non-zero [error code] on failure. 6522de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 6523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 6524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 65253fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 6526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters for database connections 652990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {SQLITE_DBSTATUS options} 6530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer "verbs" that can be passed as 6532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the second argument to the [sqlite3_db_status()] interface. 6533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New verbs may be added in future releases of SQLite. Existing verbs 6535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** might be discontinued. Applications should check the return code from 6536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_db_status()] to make sure that the call worked. 6537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_db_status()] interface will return a non-zero error code 6538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if a discontinued or unsupported verb is invoked. 6539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 654190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 6542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of lookaside memory slots currently 6543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** checked out.</dd>)^ 654471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 654590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> 654690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number malloc attempts that were 654790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** satisfied using lookaside memory. Only the high-water value is meaningful; 654890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the current value is always zero.)^ 654990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 655090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] 655190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> 655290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number malloc attempts that might have 655390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been satisfied using lookaside memory but failed due to the amount of 655490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** memory requested being larger than the lookaside slot size. 655590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Only the high-water value is meaningful; 655690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the current value is always zero.)^ 655790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 655890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] 655990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> 656090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number malloc attempts that might have 656190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been satisfied using lookaside memory but failed due to all lookaside 656290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** memory already being in use. 656390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Only the high-water value is meaningful; 656490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the current value is always zero.)^ 656590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 656690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> 65673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>This parameter returns the approximate number of bytes of heap 6568de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** memory used by all pager caches associated with the database connection.)^ 656971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. 6570de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 657190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> 65723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>This parameter returns the approximate number of bytes of heap 6573de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** memory used to store the schema for all databases associated 6574de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with the connection - main, temp, and any [ATTACH]-ed databases.)^ 6575de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The full amount of memory used by the schemas is reported, even if the 6576de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** schema memory is shared with other database connections due to 6577de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [shared cache mode] being enabled. 6578de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. 6579de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 658090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> 65813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>This parameter returns the approximate number of bytes of heap 6582de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and lookaside memory used by all prepared statements associated with 6583de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the database connection.)^ 6584de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. 6585de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </dd> 658690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 658790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> 658890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number of pager cache hits that have 658990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT 659090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is always 0. 659190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dd> 659290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 659390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> 659490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number of pager cache misses that have 659590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS 659690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is always 0. 659790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dd> 65988fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 65998fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt> 66008fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dd>This parameter returns the number of dirty cache entries that have 66018fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** been written to disk. Specifically, the number of pages written to the 66028fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** wal file in wal mode databases, or the number of pages written to the 66038fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** database file in rollback mode databases. Any pages written as part of 66048fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** transaction rollback or database recovery operations are not included. 66058fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** If an IO or other error occurs while writing a page to disk, the effect 66068fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The 66078fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. 66088fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** </dd> 66098fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 66108fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt> 66118fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dd>This parameter returns zero for the current value if and only if 66128fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** all foreign key constraints (deferred or immediate) have been 66138fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** resolved.)^ ^The highwater mark is always 0. 66148fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** </dd> 6615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 6616a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 661790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 661890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_CACHE_USED 1 661990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_SCHEMA_USED 2 662090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_STMT_USED 3 662190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 662290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 662390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 662490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_CACHE_HIT 7 662590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_CACHE_MISS 8 66268fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_DBSTATUS_CACHE_WRITE 9 66278fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_DBSTATUS_DEFERRED_FKS 10 66288fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_DBSTATUS_MAX 10 /* Largest defined DBSTATUS */ 6629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Prepared Statement Status 66333a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 6634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Each prepared statement maintains various 663690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_STMTSTATUS counters] that measure the number 6637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of times it has performed specific operations.)^ These counters can 6638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be used to monitor the performance characteristics of the prepared 6639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statements. For example, if the number of table steps greatly exceeds 6640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of table searches or result rows, that would tend to indicate 6641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the prepared statement is using a full table scan rather than 6642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an index. 6643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interface is used to retrieve and reset counter values from 6645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a [prepared statement]. The first argument is the prepared statement 6646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object to be interrogated. The second argument 664790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is an integer code for a specific [SQLITE_STMTSTATUS counter] 6648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be interrogated.)^ 6649a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the requested counter is returned. 6650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the resetFlg is true, then the counter is reset to zero after this 6651a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface call returns. 6652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_status()] and [sqlite3_db_status()]. 6654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 66553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 6656a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters for prepared statements 665990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} 6660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These preprocessor macros define integer codes that name counter 6662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** values associated with the [sqlite3_stmt_status()] interface. 6663a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The meanings of the various counters are as follows: 6664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6665a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 666690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 6667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>^This is the number of times that SQLite has stepped forward in 6668a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a table as part of a full table scan. Large numbers for this counter 6669a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may indicate opportunities for performance improvement through 6670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** careful use of indices.</dd> 6671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 667290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> 6673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>^This is the number of sort operations that have occurred. 6674a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A non-zero value in this counter may indicate an opportunity to 6675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** improvement performance through careful use of indices.</dd> 6676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 667790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> 667871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dd>^This is the number of rows inserted into transient indices that 667971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** were created automatically in order to help joins run faster. 668071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** A non-zero value in this counter may indicate an opportunity to 668171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** improvement performance by adding permanent indices that do not 668271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** need to be reinitialized each time the statement is run.</dd> 66838fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 66848fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt> 66858fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <dd>^This is the number of virtual machine operations executed 66868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** by the prepared statement if that number is less than or equal 66878fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** to 2147483647. The number of virtual machine operations can be 66888fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** used as a proxy for the total work done by the prepared statement. 66898fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** If the number of virtual machine operations exceeds 2147483647 66908fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** then the value returned by this statement status code is undefined. 66918fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** </dd> 6692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 6693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 6695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STMTSTATUS_SORT 2 669671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_STMTSTATUS_AUTOINDEX 3 66978fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#define SQLITE_STMTSTATUS_VM_STEP 4 6698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Custom Page Cache Object 6701a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_pcache type is opaque. It is implemented by 6703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the pluggable module. The SQLite core has no knowledge of 6704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its size or internal structure and never deals with the 6705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_pcache object except by holding and passing pointers 6706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the object. 6707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 670890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See [sqlite3_pcache_methods2] for additional information. 6709a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6710a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_pcache sqlite3_pcache; 6711a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6712a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 671390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Custom Page Cache Object 671490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 671590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The sqlite3_pcache_page object represents a single page in the 671690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** page cache. The page cache will allocate instances of this 671790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** object. Various methods of the page cache use pointers to instances 671890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of this object as parameters or as their return value. 671990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 672090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See [sqlite3_pcache_methods2] for additional information. 672190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 672290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Browntypedef struct sqlite3_pcache_page sqlite3_pcache_page; 672390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brownstruct sqlite3_pcache_page { 672490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void *pBuf; /* The content of the page */ 672590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void *pExtra; /* Extra information associated with the page */ 672690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown}; 672790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 672890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 6729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Application Defined Page Cache. 6730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {page cache} 6731a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 673290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can 6733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** register an alternative page cache implementation by passing in an 673490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** instance of the sqlite3_pcache_methods2 structure.)^ 6735de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** In many applications, most of the heap memory allocated by 6736de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite is used for the page cache. 6737de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** By implementing a 6738de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** custom page cache using this API, an application can better control 6739de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the amount of memory consumed by SQLite, the way in which 6740a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that memory is allocated and released, and the policies used to 6741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** determine exactly which parts of a database file are cached and for 6742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** how long. 6743a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6744de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The alternative page cache mechanism is an 6745de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** extreme measure that is only needed by the most demanding applications. 6746de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The built-in page cache is recommended for most uses. 6747de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 674890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an 6749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** internal buffer by SQLite within the call to [sqlite3_config]. Hence 6750a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application may discard the parameter after the call to 6751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] returns.)^ 6752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 675390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xInit() page cache method]] 6754de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The xInit() method is called once for each effective 6755de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** call to [sqlite3_initialize()])^ 6756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (usually only once during the lifetime of the process). ^(The xInit() 675790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ 6758de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The intent of the xInit() method is to set up global data structures 6759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** required by the custom page cache implementation. 6760de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(If the xInit() method is NULL, then the 6761de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** built-in default page cache is used instead of the application defined 6762de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** page cache.)^ 6763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 676490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xShutdown() page cache method]] 6765de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xShutdown() method is called by [sqlite3_shutdown()]. 6766de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** It can be used to clean up 6767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any outstanding resources before process shutdown, if required. 6768de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xShutdown() method may be NULL. 6769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6770de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite automatically serializes calls to the xInit method, 6771de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** so the xInit method need not be threadsafe. ^The 6772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xShutdown method is only called from [sqlite3_shutdown()] so it does 6773a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not need to be threadsafe either. All other methods must be threadsafe 6774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in multithreaded applications. 6775a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will never invoke xInit() more than once without an intervening 6777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xShutdown(). 6778a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 677990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xCreate() page cache methods]] 6780de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite invokes the xCreate() method to construct a new cache instance. 6781de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite will typically create one cache instance for each open database file, 6782a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** though this is not guaranteed. ^The 6783a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first parameter, szPage, is the size in bytes of the pages that must 678490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** be allocated by the cache. ^szPage will always a power of two. ^The 678590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** second parameter szExtra is a number of bytes of extra storage 678690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** associated with each page cache entry. ^The szExtra parameter will 678790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a number less than 250. SQLite will use the 678890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** extra szExtra bytes on each page to store metadata about the underlying 678990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database page on disk. The value passed into szExtra depends 6790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the SQLite version, the target platform, and how SQLite was compiled. 679190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The third argument to xCreate(), bPurgeable, is true if the cache being 679290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** created will be used to cache database pages of a file stored on disk, or 6793de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** false if it is used for an in-memory database. The cache implementation 6794a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** does not have to do anything special based with the value of bPurgeable; 6795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will 6796a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never invoke xUnpin() except to deliberately delete a page. 6797de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^In other words, calls to xUnpin() on a cache with bPurgeable set to 6798de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** false will always have the "discard" flag set to true. 6799de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Hence, a cache created with bPurgeable false will 6800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never contain any unpinned pages. 6801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 680290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xCachesize() page cache method]] 6803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The xCachesize() method may be called at any time by SQLite to set the 6804a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** suggested maximum cache-size (number of pages stored by) the cache 6805a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance passed as the first argument. This is the value configured using 6806de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable 6807a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter, the implementation is not required to do anything with this 6808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value; it is advisory only. 6809a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 681090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xPagecount() page cache methods]] 6811de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xPagecount() method must return the number of pages currently 6812de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** stored in the cache, both pinned and unpinned. 6813a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 681490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xFetch() page cache methods]] 6815de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xFetch() method locates a page in the cache and returns a pointer to 681690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an sqlite3_pcache_page object associated with that page, or a NULL pointer. 681790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The pBuf element of the returned sqlite3_pcache_page object will be a 681890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pointer to a buffer of szPage bytes used to store the content of a 681990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** single database page. The pExtra element of sqlite3_pcache_page will be 682090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a pointer to the szExtra bytes of extra storage that SQLite has requested 682190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for each entry in the page cache. 682290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 682390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The page to be fetched is determined by the key. ^The minimum key value 682490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is 1. After it has been retrieved using xFetch, the page is considered 682590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to be "pinned". 6826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6827de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the requested page is already in the page cache, then the page cache 6828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation must return a pointer to the page buffer with its content 6829de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** intact. If the requested page is not already in the cache, then the 683090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** cache implementation should use the value of the createFlag 6831de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** parameter to help it determined what action to take: 6832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <table border=1 width=85% align=center> 68348fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** <tr><th> createFlag <th> Behavior when page is not already in cache 6835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 0 <td> Do not allocate a new page. Return NULL. 6836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. 6837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise return NULL. 6838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 2 <td> Make every effort to allocate a new page. Only return 6839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL if allocating a new page is effectively impossible. 6840de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </table> 6841a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6842de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite 6843de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will only use a createFlag of 2 after a prior call with a createFlag of 1 6844de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** failed.)^ In between the to xFetch() calls, SQLite may 6845a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** attempt to unpin one or more cache pages by spilling the content of 6846de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** pinned pages to disk and synching the operating system disk cache. 6847a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 684890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xUnpin() page cache method]] 6849a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^xUnpin() is called by SQLite with a pointer to a currently pinned page 6850de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** as its second argument. If the third parameter, discard, is non-zero, 6851de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** then the page must be evicted from the cache. 6852de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the discard parameter is 6853de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** zero, then the page may be discarded or retained at the discretion of 6854de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** page cache implementation. ^The page cache implementation 6855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may choose to evict unpinned pages at any time. 6856a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6857de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The cache must not perform any reference counting. A single 6858a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xUnpin() unpins the page regardless of the number of prior calls 6859de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to xFetch(). 6860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 686190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xRekey() page cache methods]] 6862de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xRekey() method is used to change the key value associated with the 6863de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** page passed as the second argument. If the cache 6864de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** previously contains an entry associated with newKey, it must be 6865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** discarded. ^Any prior cache entry associated with newKey is guaranteed not 6866a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be pinned. 6867a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6868de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** When SQLite calls the xTruncate() method, the cache must discard all 6869a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** existing cache entries with page numbers (keys) greater than or equal 6870de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the value of the iLimit parameter passed to xTruncate(). If any 6871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of these pages are pinned, they are implicitly unpinned, meaning that 6872a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** they can be safely discarded. 6873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 687490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xDestroy() page cache method]] 6875a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xDestroy() method is used to delete a cache allocated by xCreate(). 6876a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All resources associated with the specified cache should be freed. ^After 6877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 687890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** handle invalid, and will not use it with any other sqlite3_pcache_methods2 6879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions. 688090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 688190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xShrink() page cache method]] 688290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite invokes the xShrink() method when it wants the page cache to 688390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** free up as much of heap memory as possible. The page cache implementation 688490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is not obligated to free any memory, but well-behaved implementations should 688590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** do their best. 688690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 688790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Browntypedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2; 688890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brownstruct sqlite3_pcache_methods2 { 688990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int iVersion; 689090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void *pArg; 689190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xInit)(void*); 689290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xShutdown)(void*); 689390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); 689490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xCachesize)(sqlite3_pcache*, int nCachesize); 689590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xPagecount)(sqlite3_pcache*); 689690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 689790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); 689890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, 689990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown unsigned oldKey, unsigned newKey); 690090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 690190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xDestroy)(sqlite3_pcache*); 690290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xShrink)(sqlite3_pcache*); 690390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown}; 690490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 690590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 690690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This is the obsolete pcache_methods object that has now been replaced 690790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by sqlite3_pcache_methods2. This object is not used by SQLite. It is 690890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** retained in the header file for backwards compatibility only. 6909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 6911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_pcache_methods { 6912a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pArg; 6913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xInit)(void*); 6914a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xShutdown)(void*); 6915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 6916a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xCachesize)(sqlite3_pcache*, int nCachesize); 6917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xPagecount)(sqlite3_pcache*); 6918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 6919a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xUnpin)(sqlite3_pcache*, void*, int discard); 6920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 6921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 6922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xDestroy)(sqlite3_pcache*); 6923a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 6924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 692590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 6926a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6927a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Online Backup Object 6928a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_backup object records state information about an ongoing 6930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** online backup operation. ^The sqlite3_backup object is created by 6931a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a call to [sqlite3_backup_init()] and is destroyed by a call to 6932a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_backup_finish()]. 6933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Online Backup API] 6935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_backup sqlite3_backup; 6937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6939a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Online Backup API. 6940a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6941a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The backup API copies the content of one database into another. 6942a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is useful either for creating backups of databases or 6943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for copying in-memory databases to or from persistent files. 6944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Online Backup API] 6946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 694790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite holds a write transaction open on the destination database file 694890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for the duration of the backup operation. 694990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The source database is read-locked only while it is being read; 695090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** it is not locked continuously for the entire backup operation. 695190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^Thus, the backup may be performed on a live source database without 695290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** preventing other database connections from 6953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** reading or writing to the source database while the backup is underway. 6954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(To perform a backup operation: 6956a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ol> 6957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_init()</b> is called once to initialize the 6958a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backup, 6959a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 6960a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the data between the two databases, and finally 6961a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_finish()</b> is called to release all resources 6962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the backup operation. 6963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ol>)^ 6964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There should be exactly one call to sqlite3_backup_finish() for each 6965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful call to sqlite3_backup_init(). 6966a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 696790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> 6968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6969a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the 6970a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] associated with the destination database 6971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the database name, respectively. 6972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The database name is "main" for the main database, "temp" for the 6973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** temporary database, or the name specified after the AS keyword in 6974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an [ATTACH] statement for an attached database. 6975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The S and M arguments passed to 6976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_init(D,N,S,M) identify the [database connection] 6977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and database name of the source database, respectively. 6978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The source and destination [database connections] (parameters S and D) 697990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** must be different or else sqlite3_backup_init(D,N,S,M) will fail with 6980a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an error. 6981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 69823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^A call to sqlite3_backup_init() will fail, returning SQLITE_ERROR, if 69833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** there is already a read or read-write transaction open on the 69843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** destination database. 69853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 6986a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is 698790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** returned and an error code and error message are stored in the 6988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** destination [database connection] D. 6989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The error code and message for the failed call to sqlite3_backup_init() 6990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or 6991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_errmsg16()] functions. 6992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A successful call to sqlite3_backup_init() returns a pointer to an 6993a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_backup] object. 6994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and 6995a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() functions to perform the specified backup 6996a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation. 6997a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 699890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> 6999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7000a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 7001a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the source and destination databases specified by [sqlite3_backup] object B. 7002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If N is negative, all remaining source pages are copied. 7003a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step(B,N) successfully copies N pages and there 700490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are still more pages to be copied, then the function returns [SQLITE_OK]. 7005a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages 7006a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from source to destination, then it returns [SQLITE_DONE]. 7007a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs while running sqlite3_backup_step(B,N), 7008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then an [error code] is returned. ^As well as [SQLITE_OK] and 7009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], 7010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an 7011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. 7012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 701371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if 701471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <ol> 701571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> the destination database was opened read-only, or 701671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> the destination database is using write-ahead-log journaling 701771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and the destination and source page sizes differ, or 701890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> the destination database is an in-memory database and the 701971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** destination and source page sizes differ. 702071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** </ol>)^ 7021a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then 7023a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_busy_handler | busy-handler function] 7024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked (if one is specified). ^If the 7025a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** busy-handler returns non-zero before the lock is available, then 7026a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_BUSY] is returned to the caller. ^In this case the call to 7027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() can be retried later. ^If the source 7028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] 7029a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is being used to write to the source database when sqlite3_backup_step() 7030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this 7031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case the call to sqlite3_backup_step() can be retried later on. ^(If 7032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or 7033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_READONLY] is returned, then 7034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there is no point in retrying the call to sqlite3_backup_step(). These 7035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** errors are considered fatal.)^ The application must accept 7036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the backup operation has failed and pass the backup operation handle 7037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the sqlite3_backup_finish() to release associated resources. 7038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first call to sqlite3_backup_step() obtains an exclusive lock 7040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the destination file. ^The exclusive lock is not released until either 7041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() is called or the backup operation is complete 7042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to 7043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() obtains a [shared lock] on the source database that 7044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** lasts for the duration of the sqlite3_backup_step() call. 7045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Because the source database is not locked between calls to 7046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step(), the source database may be modified mid-way 7047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** through the backup process. ^If the source database is modified by an 7048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** external process or via a database connection other than the one being 7049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** used by the backup operation, then the backup will be automatically 7050a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** restarted by the next call to sqlite3_backup_step(). ^If the source 7051a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database is modified by the using the same database connection as is used 7052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the backup operation, then the backup database is automatically 7053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** updated at the same time. 7054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 705590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> 7056a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7057a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the 7058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application wishes to abandon the backup operation, the application 7059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). 7060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_backup_finish() interfaces releases all 7061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resources associated with the [sqlite3_backup] object. 7062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any 7063a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** active write-transaction on the destination database is rolled back. 7064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_backup] object is invalid 7065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and may not be used following a call to sqlite3_backup_finish(). 7066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no 7068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() errors occurred, regardless or whether or not 7069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() completed. 7070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an out-of-memory condition or IO error occurred during any prior 7071a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() call on the same [sqlite3_backup] object, then 7072a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() returns the corresponding [error code]. 7073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() 7075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not a permanent error and does not affect the return value of 7076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish(). 7077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 70783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]] 707990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> 7080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 70813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_backup_remaining() routine returns the number of pages still 70823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to be backed up at the conclusion of the most recent sqlite3_backup_step(). 70833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The sqlite3_backup_pagecount() routine returns the total number of pages 70843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** in the source database at the conclusion of the most recent 70853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_backup_step(). 70863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(The values returned by these functions are only updated by 70873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_backup_step(). If the source database is modified in a way that 70883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** changes the size of the source database or the number of pages remaining, 70893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** those changes are not reflected in the output of sqlite3_backup_pagecount() 70903fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** and sqlite3_backup_remaining() until after the next 70913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sqlite3_backup_step().)^ 7092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Concurrent Usage of Database Handles</b> 7094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7095a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The source [database connection] may be used by the application for other 7096a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purposes while a backup operation is underway or being initialized. 7097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If SQLite is compiled and configured to support threadsafe database 7098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connections, then the source database connection may be used concurrently 7099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from within other threads. 7100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the application must guarantee that the destination 7102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] is not passed to any other API (by any thread) after 7103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_init() is called and before the corresponding call to 7104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish(). SQLite does not currently check to see 7105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if the application incorrectly accesses the destination [database connection] 7106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and so no error code is reported, but the operations may malfunction 7107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nevertheless. Use of the destination database connection while a 7108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backup is in progress might also also cause a mutex deadlock. 7109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If running in [shared cache mode], the application must 7111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** guarantee that the shared cache used by the destination database 7112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not accessed while the backup is running. In practice this means 7113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the application must guarantee that the disk file being 7114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backed up to is not accessed by any connection within the process, 7115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not just the specific connection that was passed to sqlite3_backup_init(). 7116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_backup] object itself is partially threadsafe. Multiple 7118a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** threads may safely make multiple concurrent calls to sqlite3_backup_step(). 7119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() 7120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** APIs are not strictly speaking threadsafe. If they are invoked at the 7121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same time as another thread is invoking sqlite3_backup_step() it is 7122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** possible that they return invalid values. 7123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 71243fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API sqlite3_backup *SQLITE_STDCALL sqlite3_backup_init( 7125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pDest, /* Destination database handle */ 7126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zDestName, /* Destination database name */ 7127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pSource, /* Source database handle */ 7128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zSourceName /* Source database name */ 7129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori); 71303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_backup_step(sqlite3_backup *p, int nPage); 71313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_backup_finish(sqlite3_backup *p); 71323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_backup_remaining(sqlite3_backup *p); 71333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_backup_pagecount(sqlite3_backup *p); 7134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 7135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 7136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Unlock Notification 71373a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 7138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When running in shared-cache mode, a database operation may fail with 7140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an [SQLITE_LOCKED] error if the required locks on the shared-cache or 7141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** individual tables within the shared-cache cannot be obtained. See 7142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 7143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API may be used to register a callback that SQLite will invoke 7144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the connection currently holding the required lock relinquishes it. 7145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API is only available if the library was compiled with the 7146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. 7147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Unlock Notification Feature]. 7149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Shared-cache locks are released when a database connection concludes 7151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its current transaction, either by committing it or rolling it back. 7152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When a connection (known as the blocked connection) fails to obtain a 7154a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shared-cache lock and SQLITE_LOCKED is returned to the caller, the 7155a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** identity of the database connection (the blocking connection) that 7156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** has locked the required resource is stored internally. ^After an 7157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application receives an SQLITE_LOCKED error, it may call the 7158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_unlock_notify() method with the blocked connection handle as 7159a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first argument to register for a callback that will be invoked 7160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the blocking connections current transaction is concluded. ^The 7161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback is invoked from within the [sqlite3_step] or [sqlite3_close] 7162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call that concludes the blocking connections transaction. 7163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, 7165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there is a chance that the blocking connection will have already 7166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** concluded its transaction by the time sqlite3_unlock_notify() is invoked. 7167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If this happens, then the specified callback is invoked immediately, 7168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from within the call to sqlite3_unlock_notify().)^ 7169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the blocked connection is attempting to obtain a write-lock on a 7171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shared-cache table, and more than one other connection currently holds 7172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a read-lock on the same table, then SQLite arbitrarily selects one of 7173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the other connections to use as the blocking connection. 7174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There may be at most one unlock-notify callback registered by a 7176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blocked connection. If sqlite3_unlock_notify() is called when the 7177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blocked connection already has a registered unlock-notify callback, 7178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is 7179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called with a NULL pointer as its second argument, then any existing 7180de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** unlock-notify callback is canceled. ^The blocked connections 7181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unlock-notify callback may also be canceled by closing the blocked 7182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection using [sqlite3_close()]. 7183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The unlock-notify callback is not reentrant. If an application invokes 7185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any sqlite3_xxx API functions from within an unlock-notify callback, a 7186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** crash or deadlock may be the result. 7187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always 7189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns SQLITE_OK. 7190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Callback Invocation Details</b> 7192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When an unlock-notify callback is registered, the application provides a 7194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single void* pointer that is passed to the callback when it is invoked. 7195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the signature of the callback function allows SQLite to pass 7196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it an array of void* context pointers. The first argument passed to 7197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an unlock-notify callback is a pointer to an array of void* pointers, 7198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the second is the number of entries in the array. 7199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When a blocking connections transaction is concluded, there may be 7201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** more than one blocked connection that has registered for an unlock-notify 7202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback. ^If two or more such blocked connections have specified the 7203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same callback function, then instead of invoking the callback function 7204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** multiple times, it is invoked once with the set of void* context pointers 7205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** specified by the blocked connections bundled together into an array. 7206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This gives the application an opportunity to prioritize any actions 7207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** related to the set of unblocked database connections. 7208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Deadlock Detection</b> 7210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Assuming that after registering for an unlock-notify callback a 7212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database waits for the callback to be issued before taking any further 7213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** action (a reasonable assumption), then using this API may cause the 7214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application to deadlock. For example, if connection X is waiting for 7215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection Y's transaction to be concluded, and similarly connection 7216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Y is waiting on connection X's transaction, then neither connection 7217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will proceed and the system may remain deadlocked indefinitely. 7218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock 7220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** detection. ^If a given call to sqlite3_unlock_notify() would put the 7221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** system in a deadlocked state, then SQLITE_LOCKED is returned and no 7222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unlock-notify callback is registered. The system is said to be in 7223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a deadlocked state if connection A has registered for an unlock-notify 7224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback on the conclusion of connection B's transaction, and connection 7225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** B has itself registered for an unlock-notify callback when connection 7226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A's transaction is concluded. ^Indirect deadlock is also detected, so 7227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the system is also considered to be deadlocked if connection B has 7228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** registered for an unlock-notify callback on the conclusion of connection 7229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** C's transaction, where connection C is waiting on connection A. ^Any 7230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of levels of indirection are allowed. 7231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>The "DROP TABLE" Exception</b> 7233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 7235a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always appropriate to call sqlite3_unlock_notify(). There is however, 7236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, 7237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite checks if there are any currently executing SELECT statements 7238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that belong to the same connection. If there are, SQLITE_LOCKED is 7239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned. In this case there is no "blocking connection", so invoking 7240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_unlock_notify() results in the unlock-notify callback being 7241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoked immediately. If the application then re-attempts the "DROP TABLE" 7242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or "DROP INDEX" query, an infinite loop might be the result. 7243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** One way around this problem is to check the extended error code returned 7245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by an sqlite3_step() call. ^(If there is a blocking connection, then the 7246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in 7247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the special "DROP TABLE/INDEX" case, the extended error code is just 7248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_LOCKED.)^ 7249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 72503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_unlock_notify( 7251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pBlocked, /* Waiting connection */ 7252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 7253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pNotifyArg /* Argument to pass to xNotify */ 7254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori); 7255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 7256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 7257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 7258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: String Comparison 7259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7260c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications 7261c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** and extensions to compare the contents of two buffers containing UTF-8 7262c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** strings in a case-independent fashion, using the same definition of "case 7263c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** independence" that SQLite uses internally when comparing identifiers. 7264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 72653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_stricmp(const char *, const char *); 72663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_strnicmp(const char *, const char *, int); 72677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 7268aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori/* 72698fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** CAPI3REF: String Globbing 72708fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich* 72718fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The [sqlite3_strglob(P,X)] interface returns zero if string X matches 72728fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the glob pattern P, and it returns non-zero if string X does not match 72738fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** the glob pattern P. ^The definition of glob pattern matching used in 72748fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the 72758fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** SQL dialect used by SQLite. ^The sqlite3_strglob(P,X) function is case 72768fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** sensitive. 72778fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** 72788fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** Note that this routine returns zero on a match and non-zero if the strings 72798fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()]. 72808fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich*/ 72813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_strglob(const char *zGlob, const char *zStr); 72828fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich 72838fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich/* 7284aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** CAPI3REF: Error Logging Interface 7285aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** 72868fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich** ^The [sqlite3_log()] interface writes a message into the [error log] 728771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. 728871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^If logging is enabled, the zFormat string and subsequent arguments are 728971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** used with [sqlite3_snprintf()] to generate the final output string. 7290aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** 7291aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** The sqlite3_log() interface is intended for use by extensions such as 7292aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** virtual tables, collating functions, and SQL functions. While there is 7293aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** nothing to prevent an application from calling sqlite3_log(), doing so 7294aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** is considered bad form. 7295ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** 729671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The zFormat string must not be NULL. 729771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 7298ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** To avoid deadlocks and other threading problems, the sqlite3_log() routine 7299ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** will not use dynamically allocated memory. The log message is stored in 7300ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** a fixed-length buffer on the stack. If the log message is longer than 7301ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** a few hundred characters, it will be truncated to the length of the 7302ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** buffer. 7303aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori*/ 73043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void SQLITE_CDECL sqlite3_log(int iErrCode, const char *zFormat, ...); 7305ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori 73067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 730771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Write-Ahead Log Commit Hook 73083a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 730971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 731071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_hook()] function is used to register a callback that 73113fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is invoked each time data is committed to a database in wal mode. 731271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 73133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(The callback is invoked by SQLite after the commit has taken place and 73143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the associated write-lock on the database released)^, so the implementation 731571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** may read, write or [checkpoint] the database as required. 731671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 731771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The first parameter passed to the callback function when it is invoked 731871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is a copy of the third parameter passed to sqlite3_wal_hook() when 731971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registering the callback. ^The second is a copy of the database handle. 732071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The third parameter is the name of the database that was written to - 732171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter 732271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is the number of pages currently in the write-ahead log file, 732371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** including those that were just committed. 732471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 732571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The callback function should normally return [SQLITE_OK]. ^If an error 732671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** code is returned, that error will propagate back up through the 732771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** SQLite code base to cause the statement that provoked the callback 732871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to report an error, though the commit will have still occurred. If the 732971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value 733071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** that does not correspond to any valid SQLite error code, the results 733171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** are undefined. 733271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 733371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** A single database handle may have at most a single write-ahead log callback 733471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any 733571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** previously registered write-ahead log callback. ^Note that the 733671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_wal_autocheckpoint()] interface and the 733771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will 733871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** those overwrite any prior [sqlite3_wal_hook()] settings. 733971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 73403fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API void *SQLITE_STDCALL sqlite3_wal_hook( 734171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori sqlite3*, 734271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int(*)(void *,sqlite3*,const char*,int), 734371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori void* 734471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 734571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 734671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 734771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Configure an auto-checkpoint 73483a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 734971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 735071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around 735171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_wal_hook()] that causes any database on [database connection] D 735271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to automatically [checkpoint] 735371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** after committing a transaction if there are N or 735471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** more frames in the [write-ahead log] file. ^Passing zero or 735571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** a negative value as the nFrame parameter disables automatic 735671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** checkpoints entirely. 735771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 735871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The callback registered by this function replaces any existing callback 735971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback 736071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism 736171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** configured by this function. 73627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 736371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [wal_autocheckpoint pragma] can be used to invoke this interface 736471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** from SQL. 736571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 73669bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** ^Checkpoints initiated by this mechanism are 73679bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [sqlite3_wal_checkpoint_v2|PASSIVE]. 73689bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** 736971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^Every new [database connection] defaults to having the auto-checkpoint 737090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] 737190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pages. The use of this interface 737271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is only necessary if the default setting is found to be suboptimal 737371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** for a particular application. 73747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 73753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_wal_autocheckpoint(sqlite3 *db, int N); 737671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 737771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 737871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Checkpoint a database 73793a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 738071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 73813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to 73823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^ 738371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 73843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the 73853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [write-ahead log] for database X on [database connection] D to be 73863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** transferred into the database file and for the write-ahead log to 73873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** be reset. See the [checkpointing] documentation for addition 73883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** information. 738990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 73903fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** This interface used to be the only way to cause a checkpoint to 73913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()] 73923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** interface was added. This interface is retained for backwards 73933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** compatibility and as a convenience for applications that need to manually 73943fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** start a callback but which do not need the full power (and corresponding 73953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** complication) of [sqlite3_wal_checkpoint_v2()]. 739671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 73973fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); 739871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 73997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 740090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Checkpoint a database 74013a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3 740290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 74033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint 74043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** operation on database X of [database connection] D in mode M. Status 74053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** information is written back into integers pointed to by L and C.)^ 74063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^(The M parameter must be a valid [checkpoint mode]:)^ 740790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 740890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dl> 740990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> 74103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Checkpoint as many frames as possible without waiting for any database 74113fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** readers or writers to finish, then sync the database file if all frames 74123fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** in the log were checkpointed. ^The [busy-handler callback] 74133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode. 74143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^On the other hand, passive mode might leave the checkpoint unfinished 74153fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** if there are concurrent readers or writers. 741690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 741790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_CHECKPOINT_FULL<dd> 74183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This mode blocks (it invokes the 74199bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** [sqlite3_busy_handler|busy-handler callback]) until there is no 742090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database writer and all readers are reading from the most recent database 74213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** snapshot. ^It then checkpoints all frames in the log file and syncs the 74223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** database file. ^This mode blocks new database writers while it is pending, 74233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** but new database readers are allowed to continue unimpeded. 742490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 742590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_CHECKPOINT_RESTART<dd> 74263fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition 74273fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** that after checkpointing the log file it blocks (calls the 74283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [busy-handler callback]) 74293fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** until all readers are reading from the database file only. ^This ensures 74303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** that the next writer will restart the log file from the beginning. 74313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new 74323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** database writer attempts while it is pending, but does not impede readers. 74333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 74343fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd> 74353fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the 74363fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** addition that it also truncates the log file to zero bytes just prior 74373fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to a successful return. 743890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dl> 743990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 74403fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in 74413fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the log file or to -1 if the checkpoint could not run because 74423fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not 74433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** NULL,then *pnCkpt is set to the total number of checkpointed frames in the 74443fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** log file (including any that were already checkpointed before the function 74453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** was called) or to -1 if the checkpoint could not run due to an error or 74463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** because the database is not in WAL mode. ^Note that upon successful 74473fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been 74483fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero. 74493fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 74503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If 745190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** any other process is running a checkpoint operation at the same time, the 74523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a 745390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** busy-handler configured, it will not be invoked in this case. 745490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 74553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the 74563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** exclusive "writer" lock on the database file. ^If the writer lock cannot be 74573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** obtained immediately, and a busy-handler is configured, it is invoked and 74583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the writer lock retried until either the busy-handler returns 0 or the lock 74593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** is successfully obtained. ^The busy-handler is also invoked while waiting for 74603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** database readers as described above. ^If the busy-handler returns 0 before 746190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the writer lock is obtained or while waiting for database readers, the 746290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** checkpoint operation proceeds from that point in the same way as 746390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible 74643fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** without blocking any further. ^SQLITE_BUSY is returned in this case. 746590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 74663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If parameter zDb is NULL or points to a zero length string, then the 74673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** specified operation is attempted on all WAL databases [attached] to 74683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [database connection] db. In this case the 74693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** values written to output parameters *pnLog and *pnCkpt are undefined. ^If 747090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an SQLITE_BUSY error is encountered when processing one or more of the 747190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** attached WAL databases, the operation is still attempted on any remaining 74723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** attached databases and SQLITE_BUSY is returned at the end. ^If any other 747390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error occurs while processing an attached database, processing is abandoned 74743fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** and the error code is returned to the caller immediately. ^If no error 747590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** (SQLITE_BUSY or otherwise) is encountered while processing the attached 747690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** databases, SQLITE_OK is returned. 747790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 74783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^If database zDb is the name of an attached database that is not in WAL 74793fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If 748090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** zDb is not NULL (or a zero length string) and is not the name of any 748190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** attached database, SQLITE_ERROR is returned to the caller. 74823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 74833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Unless it returns SQLITE_MISUSE, 74843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the sqlite3_wal_checkpoint_v2() interface 74853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** sets the error information that is queried by 74863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_errcode()] and [sqlite3_errmsg()]. 74873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 74883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface 74893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** from SQL. 749090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 74913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_wal_checkpoint_v2( 749290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3 *db, /* Database handle */ 749390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown const char *zDb, /* Name of attached database (or NULL) */ 749490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int eMode, /* SQLITE_CHECKPOINT_* value */ 749590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int *pnLog, /* OUT: Size of WAL log in frames */ 749690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int *pnCkpt /* OUT: Total number of frames checkpointed */ 749790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown); 749890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 749990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 75003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** CAPI3REF: Checkpoint Mode Values 75013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** KEYWORDS: {checkpoint mode} 750290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 75033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** These constants define all valid values for the "checkpoint mode" passed 75043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface. 75053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the 75063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** meaning of each of these checkpoint modes. 750790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 75083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */ 75093fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */ 75103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */ 75113fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */ 751290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 751390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 751490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Virtual Table Interface Configuration 751590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 751690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This function may be called by either the [xConnect] or [xCreate] method 751790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of a [virtual table] implementation to configure 751890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** various facets of the virtual table interface. 751990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 752090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If this interface is invoked outside the context of an xConnect or 752190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** xCreate virtual table method then the behavior is undefined. 752290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 752390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** At present, there is only one option that may be configured using 752490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options 752590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** may be added in the future. 752690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 75273fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_CDECL sqlite3_vtab_config(sqlite3*, int op, ...); 752890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 752990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 753090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Virtual Table Configuration Options 753190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 753290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** These macros define the various options to the 753390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vtab_config()] interface that [virtual table] implementations 753490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** can use to customize and optimize their behavior. 753590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 753690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dl> 753790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT 753890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>Calls of the form 753990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, 754090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** where X is an integer. If X is zero, then the [virtual table] whose 754190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not 754290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** support constraints. In this configuration (which is the default) if 754390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire 754490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** statement is rolled back as if [ON CONFLICT | OR ABORT] had been 754590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** specified as part of the users SQL statement, regardless of the actual 754690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ON CONFLICT mode specified. 754790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 754890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If X is non-zero, then the virtual table implementation guarantees 754990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before 755090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** any modifications to internal or persistent data structures have been made. 755190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite 755290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is able to roll back a statement or database transaction, and abandon 755390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or continue processing the current SQL statement as appropriate. 755490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns 755590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode 755690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** had been ABORT. 755790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 755890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Virtual table implementations that are required to handle OR REPLACE 755990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** must do so within the [xUpdate] method. If a call to the 756090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vtab_on_conflict()] function indicates that the current ON 756190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CONFLICT policy is REPLACE, the virtual table implementation should 756290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** silently replace the appropriate rows within the xUpdate callback and 756390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** return SQLITE_OK. Or, if this is not possible, it may return 756490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT 756590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** constraint handling. 756690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dl> 756790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 756890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 756990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 757090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 757190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Determine The Virtual Table Conflict Policy 757290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 757390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This function may only be called from within a call to the [xUpdate] method 757490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The 757590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], 757690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode 757790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of the SQL statement that triggered the call to the [xUpdate] method of the 757890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [virtual table]. 757990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 75803fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_vtab_on_conflict(sqlite3 *); 758190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 758290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 758390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Conflict resolution modes 75849bee60b0fc0b60d4ae9e7533e0e6b7beca5f37fcJeff Brown** KEYWORDS: {conflict resolution mode} 758590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 758690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** These constants are returned by [sqlite3_vtab_on_conflict()] to 758790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** inform a [virtual table] implementation what the [ON CONFLICT] mode 758890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is for the SQL statement being evaluated. 758990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 759090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Note that the [SQLITE_IGNORE] constant is also used as a potential 759190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** return value from the [sqlite3_set_authorizer()] callback and that 759290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_ABORT] is also a [result code]. 759390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 759490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_ROLLBACK 1 759590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ 759690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FAIL 3 759790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* #define SQLITE_ABORT 4 // Also an error code */ 759890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_REPLACE 5 759990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 76003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich/* 76013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** CAPI3REF: Prepared Statement Scan Status Opcodes 76023fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** KEYWORDS: {scanstatus options} 76033fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76043fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The following constants can be used for the T parameter to the 76053fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a 76063fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** different metric for sqlite3_stmt_scanstatus() to return. 76073fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76083fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** When the value returned to V is a string, space to hold that string is 76093fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** managed by the prepared statement S and will be automatically freed when 76103fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** S is finalized. 76113fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76123fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dl> 76133fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt> 76143fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be 76153fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** set to the total number of times that the X-th loop has run.</dd> 76163fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76173fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt> 76183fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set 76193fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to the total number of rows examined by all iterations of the X-th loop.</dd> 76203fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76213fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt> 76223fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The "double" variable pointed to by the T parameter will be set to the 76233fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** query planner's estimate for the average number of rows output from each 76243fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** iteration of the X-th loop. If the query planner's estimates was accurate, 76253fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** then this value will approximate the quotient NVISIT/NLOOP and the 76263fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** product of this value for all prior loops with the same SELECTID will 76273fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** be the NLOOP value for the current loop. 76283fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76293fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt> 76303fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The "const char *" variable pointed to by the T parameter will be set 76313fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to a zero-terminated UTF-8 string containing the name of the index or table 76323fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** used for the X-th loop. 76333fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76343fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt> 76353fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The "const char *" variable pointed to by the T parameter will be set 76363fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] 76373fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** description for the X-th loop. 76383fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76393fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt> 76403fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** <dd>^The "int" variable pointed to by the T parameter will be set to the 76413fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** "select-id" for the X-th loop. The select-id identifies which query or 76423fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** subquery the loop is part of. The main query has a select-id of zero. 76433fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The select-id is the same value as is output in the first column 76443fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of an [EXPLAIN QUERY PLAN] query. 76453fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** </dl> 76463fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich*/ 76473fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_SCANSTAT_NLOOP 0 76483fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_SCANSTAT_NVISIT 1 76493fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_SCANSTAT_EST 2 76503fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_SCANSTAT_NAME 3 76513fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_SCANSTAT_EXPLAIN 4 76523fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich#define SQLITE_SCANSTAT_SELECTID 5 76533fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich 76543fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich/* 76553fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** CAPI3REF: Prepared Statement Scan Status 76563a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 76573fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76583fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** This interface returns information about the predicted and measured 76593fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** performance for pStmt. Advanced applications can use this 76603fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** interface to compare the predicted and the measured performance and 76613fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** issue warnings and/or rerun [ANALYZE] if discrepancies are found. 76623fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76633fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Since this interface is expected to be rarely used, it is only 76643fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS] 76653fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** compile-time option. 76663fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76673fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The "iScanStatusOp" parameter determines which status information to return. 76683fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior 76693fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** of this interface is undefined. 76703fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^The requested measurement is written into a variable pointed to by 76713fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the "pOut" parameter. 76723fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Parameter "idx" identifies the specific loop to retrieve statistics for. 76733fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** Loops are numbered starting from zero. ^If idx is out of range - less than 76743fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** zero or greater than or equal to the total number of loops used to implement 76753fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** the statement - a non-zero value is returned and the variable that pOut 76763fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** points to is unchanged. 76773fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76783fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Statistics might not be available for all loops in all statements. ^In cases 76793fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** where there exist loops with no available statistics, this function behaves 76803fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** as if the loop did not exist - it returns non-zero and leave the variable 76813fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** that pOut points to unchanged. 76823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76833fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** See also: [sqlite3_stmt_scanstatus_reset()] 76843fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich*/ 76853fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_EXPERIMENTAL int SQLITE_STDCALL sqlite3_stmt_scanstatus( 76863fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich sqlite3_stmt *pStmt, /* Prepared statement for which info desired */ 76873fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich int idx, /* Index of loop to report on */ 76883fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */ 76893fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich void *pOut /* Result written here */ 76903fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich); 76913fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich 76923fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich/* 76933fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** CAPI3REF: Zero Scan-Status Counters 76943a6c79f802fabdb94367177310663397420e319fNick Kralevich** METHOD: sqlite3_stmt 76953fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76963fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** ^Zero all [sqlite3_stmt_scanstatus()] related event counters. 76973fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** 76983fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** This API is only available if the library is built with pre-processor 76993fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined. 77003fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick Kralevich*/ 77013fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API SQLITE_EXPERIMENTAL void SQLITE_STDCALL sqlite3_stmt_scanstatus_reset(sqlite3_stmt*); 770290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 770390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 770490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 77057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Undo the hack that converts floating point types to integer for 77067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** builds on processors without floating point support. 77077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 77087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_OMIT_FLOATING_POINT 77097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef double 77107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 77117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 77127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef __cplusplus 77137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project} /* End of the 'extern "C"' block */ 77147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 77158fecf56c625b5691ee3381e107ccbe1ff42398b1Nick Kralevich#endif /* _SQLITE3_H_ */ 7716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 7717de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 7718de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 2010 August 30 7719de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 7720de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The author disclaims copyright to this source code. In place of 7721de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** a legal notice, here is a blessing: 7722de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 7723de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** May you do good and not evil. 7724de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** May you find forgiveness for yourself and forgive others. 7725de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** May you share freely, never taking more than you give. 7726de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 7727de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori************************************************************************* 7728de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 7729de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7730de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#ifndef _SQLITE3RTREE_H_ 7731de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define _SQLITE3RTREE_H_ 7732de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7733de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7734de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#ifdef __cplusplus 7735de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Noriextern "C" { 7736de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#endif 7737de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7738de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Noritypedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; 77391c7cea379348522163370244e8fbbff8a136b7faNick Kralevichtypedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info; 77401c7cea379348522163370244e8fbbff8a136b7faNick Kralevich 77411c7cea379348522163370244e8fbbff8a136b7faNick Kralevich/* The double-precision datatype used by RTree depends on the 77421c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** SQLITE_RTREE_INT_ONLY compile-time option. 77431c7cea379348522163370244e8fbbff8a136b7faNick Kralevich*/ 77441c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#ifdef SQLITE_RTREE_INT_ONLY 77451c7cea379348522163370244e8fbbff8a136b7faNick Kralevich typedef sqlite3_int64 sqlite3_rtree_dbl; 77461c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#else 77471c7cea379348522163370244e8fbbff8a136b7faNick Kralevich typedef double sqlite3_rtree_dbl; 77481c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#endif 7749de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7750de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 7751de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Register a geometry callback named zGeom that can be used as part of an 7752de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** R-Tree geometry query as follows: 7753de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 7754de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...) 7755de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 77563fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_rtree_geometry_callback( 7757de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori sqlite3 *db, 7758de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori const char *zGeom, 77591c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*), 7760de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pContext 7761de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori); 7762de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7763de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7764de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 7765de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** A pointer to a structure of the following type is passed as the first 7766de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** argument to callbacks registered using rtree_geometry_callback(). 7767de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 7768de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Noristruct sqlite3_rtree_geometry { 7769de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pContext; /* Copy of pContext passed to s_r_g_c() */ 7770de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int nParam; /* Size of array aParam[] */ 77711c7cea379348522163370244e8fbbff8a136b7faNick Kralevich sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */ 7772de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pUser; /* Callback implementation user data */ 7773de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ 7774de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori}; 7775de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 77761c7cea379348522163370244e8fbbff8a136b7faNick Kralevich/* 77771c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** Register a 2nd-generation geometry callback named zScore that can be 77781c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** used as part of an R-Tree geometry query as follows: 77791c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** 77801c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...) 77811c7cea379348522163370244e8fbbff8a136b7faNick Kralevich*/ 77823fcd43a0f1ef02756029e12af3cb9ba9faa13364Nick KralevichSQLITE_API int SQLITE_STDCALL sqlite3_rtree_query_callback( 77831c7cea379348522163370244e8fbbff8a136b7faNick Kralevich sqlite3 *db, 77841c7cea379348522163370244e8fbbff8a136b7faNick Kralevich const char *zQueryFunc, 77851c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int (*xQueryFunc)(sqlite3_rtree_query_info*), 77861c7cea379348522163370244e8fbbff8a136b7faNick Kralevich void *pContext, 77871c7cea379348522163370244e8fbbff8a136b7faNick Kralevich void (*xDestructor)(void*) 77881c7cea379348522163370244e8fbbff8a136b7faNick Kralevich); 77891c7cea379348522163370244e8fbbff8a136b7faNick Kralevich 77901c7cea379348522163370244e8fbbff8a136b7faNick Kralevich 77911c7cea379348522163370244e8fbbff8a136b7faNick Kralevich/* 77921c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** A pointer to a structure of the following type is passed as the 77931c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** argument to scored geometry callback registered using 77941c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** sqlite3_rtree_query_callback(). 77951c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** 77961c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** Note that the first 5 fields of this structure are identical to 77971c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** sqlite3_rtree_geometry. This structure is a subclass of 77981c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** sqlite3_rtree_geometry. 77991c7cea379348522163370244e8fbbff8a136b7faNick Kralevich*/ 78001c7cea379348522163370244e8fbbff8a136b7faNick Kralevichstruct sqlite3_rtree_query_info { 78011c7cea379348522163370244e8fbbff8a136b7faNick Kralevich void *pContext; /* pContext from when function registered */ 78021c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int nParam; /* Number of function parameters */ 78031c7cea379348522163370244e8fbbff8a136b7faNick Kralevich sqlite3_rtree_dbl *aParam; /* value of function parameters */ 78041c7cea379348522163370244e8fbbff8a136b7faNick Kralevich void *pUser; /* callback can use this, if desired */ 78051c7cea379348522163370244e8fbbff8a136b7faNick Kralevich void (*xDelUser)(void*); /* function to free pUser */ 78061c7cea379348522163370244e8fbbff8a136b7faNick Kralevich sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */ 78071c7cea379348522163370244e8fbbff8a136b7faNick Kralevich unsigned int *anQueue; /* Number of pending entries in the queue */ 78081c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int nCoord; /* Number of coordinates */ 78091c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int iLevel; /* Level of current node or entry */ 78101c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int mxLevel; /* The largest iLevel value in the tree */ 78111c7cea379348522163370244e8fbbff8a136b7faNick Kralevich sqlite3_int64 iRowid; /* Rowid for current entry */ 78121c7cea379348522163370244e8fbbff8a136b7faNick Kralevich sqlite3_rtree_dbl rParentScore; /* Score of parent node */ 78131c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int eParentWithin; /* Visibility of parent node */ 78141c7cea379348522163370244e8fbbff8a136b7faNick Kralevich int eWithin; /* OUT: Visiblity */ 78151c7cea379348522163370244e8fbbff8a136b7faNick Kralevich sqlite3_rtree_dbl rScore; /* OUT: Write the score here */ 78161c7cea379348522163370244e8fbbff8a136b7faNick Kralevich}; 78171c7cea379348522163370244e8fbbff8a136b7faNick Kralevich 78181c7cea379348522163370244e8fbbff8a136b7faNick Kralevich/* 78191c7cea379348522163370244e8fbbff8a136b7faNick Kralevich** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin. 78201c7cea379348522163370244e8fbbff8a136b7faNick Kralevich*/ 78211c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#define NOT_WITHIN 0 /* Object completely outside of query region */ 78221c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#define PARTLY_WITHIN 1 /* Object partially overlaps query region */ 78231c7cea379348522163370244e8fbbff8a136b7faNick Kralevich#define FULLY_WITHIN 2 /* Object fully contained within query region */ 78241c7cea379348522163370244e8fbbff8a136b7faNick Kralevich 7825de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7826de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#ifdef __cplusplus 7827de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori} /* end of the 'extern "C"' block */ 7828de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#endif 7829de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7830de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#endif /* ifndef _SQLITE3RTREE_H_ */ 7831de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7832